.. _api_python:

Python API
==========

Canonical generated Python API reference pages, grouped by package.

pyrogue
-------

.. toctree::
   :maxdepth: 1


   basecommand
   basevariable
   bool
   bytecount
   datareceiver
   datawriter
   device
   double
   fixed
   float
   int
   linkvariable
   localblock
   localvariable
   model
   node
   pollqueue
   process
   remotecommand
   remotevariable
   reversebits
   root
   runcontrol
   string
   twoscomplement
   ufixed
   uint
   wordcount

pyrogue.interfaces
------------------

.. toctree::
   :maxdepth: 1


   interfaces_oscommandmemoryslave
   interfaces_simpleclient
   interfaces_virtualclient
   interfaces_zmqserver

pyrogue.interfaces.stream
-------------------------

.. toctree::
   :maxdepth: 1


   interfaces_stream_variable

pyrogue.protocols.epicsV4
-------------------------

.. toctree::
   :maxdepth: 1


   protocols_epicsv4_epicspvholder
   protocols_epicsv4_epicspvserver

pyrogue.utilities.fileio
------------------------

.. toctree::
   :maxdepth: 1


   utilities_fileio_filereader
   utilities_fileio_rogueheader
   utilities_fileio_streamreader
   utilities_fileio_streamwriter

pyrogue.utilities.prbs
----------------------

.. toctree::
   :maxdepth: 1


   utilities_prbs_prbspair
   utilities_prbs_prbsrx
   utilities_prbs_prbstx