REDAC Firmware Manual
=====================

This documentation covers the C++ firmware for the hybrid controller (microcontroller on CTRL-block) of the
*Reconfigurable Discrete Analog Computer*, in short `REDAC <https://redac.anabrid.com>`_
as well as of its little brother `LUCIDAC <https://anabrid.com/lucidac>`_,
made by `anabrid GmbH <https://anabrid.com>`_.

:Version of this document: |release|
:Build time: |today|
:Copyright: © 2025 anabrid GmbH, Open Sourced as GPL and BSD, see :ref:`licensing`

The most up to date version of this document can be read online as 
`web pages <https://anabrid.dev/docs/lucidac-firmware/sphinx/dirhtml/>`_ or 
`printable PDF <https://anabrid.dev/docs/lucidac-firmware/sphinx/lucidac-firmware-manual.pdf>`_.
This documentation is generated with *Doxygen* and *Sphinx*. You are currently viewing the
main entry page of the documentation. In the Doxygen part of the documentation you
can browse the actual code
`by namespace <https://anabrid.dev/docs/lucidac-firmware/doxygen/namespaces.html>`_,
`by class name <https://anabrid.dev/docs/lucidac-firmware/doxygen/annotated.html>`_ or
`by file/folder <https://anabrid.dev/docs/lucidac-firmware/doxygen/files.html>`_.

.. toctree::
   :maxdepth: 2
   :caption: Developer Guide
   
   texts/intro.rst
   texts/usb.rst
   texts/flashing.rst
   texts/building.rst
   texts/feature-flags.rst
   texts/testing.rst
   texts/debugging.rst

.. toctree::
   :maxdepth: 2
   :caption: Architecture
   
   texts/architecture.rst
   texts/entities.rst
   texts/protocol.rst
   texts/calibration.rst

.. toctree::
   :maxdepth: 2
   :caption: Standalone Usage
   
   texts/networking.rst
   texts/permanent_settings.rst
   texts/security.rst

.. toctree::
   :maxdepth: 2
   :caption: Firmware API

   lib-communication.rst
   lib-computation.rst
   lib-controller.rst
   lib-hal-lucidac.rst
   lib-platform-lucidac.rst

.. toctree::
   :maxdepth: 2
   :caption: Colophon
   
   texts/style-guide.rst
   texts/docs.rst
   texts/wording.rst
   texts/licensing.rst