:py:mod:`rig.machine_control`: Machine Control APIs
===================================================

Rig provides various high-level APIs for communicating with and controlling
SpiNNaker machines. New users are encouraged to start by working through the
:ref:`introductory tutorials <control-tutorials>`:

:py:mod:`~rig.machine_control.MachineController`: SpiNNaker Control API
-----------------------------------------------------------------------

.. autoclass:: rig.machine_control.MachineController
    :members:
    :special-members:

.. autoclass:: rig.machine_control.machine_controller.MemoryIO
    :inherited-members:

.. automodule:: rig.machine_control.machine_controller
    :members: SystemInfo, ChipInfo, CoreInfo, ProcessorStatus, IPTag, RouterDiagnostics, SpiNNakerBootError, SpiNNakerMemoryError, SpiNNakerRouterError, SpiNNakerLoadingError, TruncationWarning
    :special-members:

.. automodule:: rig.machine_control.utils
    :members: sdram_alloc_for_vertices

:py:mod:`~rig.machine_control.BMPController`: BMP Control API
-------------------------------------------------------------

.. autoclass:: rig.machine_control.BMPController
    :members:
    :special-members:

.. automodule:: rig.machine_control.bmp_controller
    :members: BMPInfo, ADCInfo
    :special-members:

:py:mod:`~rig.machine_control.boot`: Low-level Machine Booting API
------------------------------------------------------------------

.. automodule:: rig.machine_control.boot
    :members:
    :special-members:
    :exclude-members: boot_packet, BootCommand

.. autofunction:: rig.machine_control.unbooted_ping.listen


:py:mod:`~rig.machine_control.packets`: Raw SDP/SCP Packet Packing/Unpacking
----------------------------------------------------------------------------

.. automodule:: rig.machine_control.packets
    :members:
    :special-members:


:py:mod:`~rig.machine_control.scp_connection`: High-performance SCP protocol implementation
-------------------------------------------------------------------------------------------

This module presents a high-performance implementation of the SCP protocol
which is used to communicate with SC&MP.

.. automodule:: rig.machine_control.scp_connection
    :members:
    :special-members:


:py:mod:`~rig.machine_control.struct_file`: SC&MP Struct File Reading
---------------------------------------------------------------------

.. automodule:: rig.machine_control.struct_file
    :members:
    :special-members:

:py:mod:`~rig.machine_control.consts`: Machine and Protocol Constants
---------------------------------------------------------------------

.. automodule:: rig.machine_control.consts
    :members:
    :special-members: