REDAC Blocks and Configurations
===============================

This page describes all available hardware entities and their possible configurations.

The firmware on the hybrid controller accepts various JSON message structures
as part of the :class:`pyanabrid.redac.protocol.messages.SetConfigRequest` message, which are documented below.
Alternatively, you can find the full JSON schema for the configuration parameters
:download:`here <../../extern/firmware/lib/block/schema.json>`.

Base Elements and Computations
------------------------------

All function blocks in the REDAC are made up of elements,
with each implementing one computation from the following list.
The list of elements contained on a function block together with the attributes of the computation define
which configuration parameters need to be sent to configure a function block (see below).

Please remember that in the REDAC, all summation is done implicitly by the :class:`pyanabrid.redac.blocks.IBlock`.

.. automodule:: pyanabrid.redac.computations
   :members: Integration, ScalarMultiplication, Multiplication

Function Blocks
---------------

The following function blocks are available.

.. MIntBlock

.. autoclass:: pyanabrid.redac.blocks.MIntBlock()

    .. autoattribute:: pyanabrid.redac.blocks.MIntBlock.elements
       :annotation:

The configuration can be set with a :class:`pyanabrid.redac.protocol.messages.SetConfigRequest` message
with :attr:`pyanabrid.redac.protocol.messages.SetConfigRequest.config` (or the respective sub-dictionary)
confirming to the following JSON schema.

.. jsonschema:: ../../extern/firmware/lib/block/schema.json#/MIntBlock

.. UBlock

.. autoclass:: pyanabrid.redac.blocks.UBlock()
   :members:

The configuration can be set with a :class:`pyanabrid.redac.protocol.messages.SetConfigRequest` message
with :attr:`pyanabrid.redac.protocol.messages.SetConfigRequest.config` (or the respective sub-dictionary)
confirming to the following JSON schema.

.. jsonschema:: ../../extern/firmware/lib/block/schema.json#/UBlock

.. CBlock

.. autoclass:: pyanabrid.redac.blocks.CBlock()
   :members: elements

The configuration can be set with a :class:`pyanabrid.redac.protocol.messages.SetConfigRequest` message
with :attr:`pyanabrid.redac.protocol.messages.SetConfigRequest.config` (or the respective sub-dictionary)
confirming to the following JSON schema.

.. jsonschema:: ../../extern/firmware/lib/block/schema.json#/CBlock

.. IBlock

.. autoclass:: pyanabrid.redac.blocks.IBlock()
   :members:

The configuration can be set with a :class:`pyanabrid.redac.protocol.messages.SetConfigRequest` message
with :attr:`pyanabrid.redac.protocol.messages.SetConfigRequest.config` (or the respective sub-dictionary)
confirming to the following JSON schema.

.. jsonschema:: ../../extern/firmware/lib/block/schema.json#/IBlock
.. this line is needed, since jsonschema is confused otherwise :)