API Reference

This page is a single entry point to generated API content from Python docstrings/autodoc and C++ Doxygen output.

Python API

Use the Python module and symbol indices to browse all exposed Python API objects documented by Sphinx:

• Module Index

• Index

Primary Python API sections:

• Python API
  • pyrogue
  • pyrogue.interfaces
  • pyrogue.interfaces.stream
  • pyrogue.protocols.epicsV4
  • pyrogue.utilities.fileio
  • pyrogue.utilities.prbs

C++ API

Use the section class indexes for curated C++ APIs, grouped by namespace.

rogue::hardware

• AXI Hardware Interface Class Descriptions

• Hardware Interface Class Descriptions

rogue::interfaces

• Memory Interface Class Descriptions

• Stream Interface Class Descriptions

rogue::protocols

• Batcher Protocol Class Descriptions

• Packetizer Protocol Class Descriptions

• RSSI Protocol Class Descriptions

• SRP Protocol Class Descriptions

• UDP Protocol Class Descriptions

• Xilinx Protocol Class Descriptions

rogue::utilities

• Compression Classes

• File Operation Classes

• PRBS Utilities