=====================================================================
SKA-Low Signal Processing System Tile Processing Module API |release|
=====================================================================

This project contains the Tile Processing Module (TPM) API for the Signal Processing 
System of the SKA-Low telescope.

This API exposes Tile class which can be used to monitor and control the TPMs from 
Python. This is a dependency of the following other projects:

* `SKA-Low MCCS SPSHW <https://gitlab.com/ska-telescope/mccs/ska-low-mccs-spshw>`_
* `SKA-Low SPS Test Suite <https://gitlab.com/ska-telescope/ska-low-sps-testsuite>`_

Overview
--------

There are five main sections that comprise the TPM API:

    * :doc:`base`
    * :doc:`boards`
    * :doc:`protocols`
    * :doc:`plugins`
    * :doc:`tile`

The TPM API base, boards and protocols were formerly a Python package called 
:code:`PyFABIL: Python FPGA Board Interfacing Layer` that was designed to allow
communication with a range of radioastronomy FPGA boards. This provides a software
representation of an FPGA board that includes:

    * The network protocol to communicate with the board.
    * A memory map that tells the software what registers and memory areas are exposed
      by the board.
    * Information on additional memory-mapped devices on the board (such as SPI
      devices).

For the TPM, a board and protocol definition are combined with plugins to build a
software representation of the Tile Processing Module. Each plugin is associated with a
specific hardware component or firmware feature as shown below:

.. image:: overview.png

.. toctree::
   :hidden:
   
   base
 
.. toctree::
   :hidden:

   boards

.. toctree::
   :hidden:

   protocols

.. toctree::
   :hidden:

   plugins

.. toctree::
   :hidden:

   tile

.. toctree::
   :hidden:

   tile_health

.. toctree::
   :hidden:

   tests/index

.. toctree::
   :maxdepth: -1
   :hidden:

   generated/CHANGELOG.md