fsfw/fsfw
fsfw/fsfw
10
3
Fork 6
Code Issues 31 Pull Requests 4 Releases 10 Wiki Activity

Some DHB docs #551

Merged
mohr merged 7 commits from eive/fsfw:mueller/dhb-docs into development 2022-02-14 16:35:11 +01:00
Conversation 0 Commits 7 Files Changed 4 +7 -3
2 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit cdf2a90f90 - Show all commits

8
docs/devicehandlers.rst
View File

@ -1,7 +1,10 @@
.. _dhb-prim-doc:
Device Handlers Device Handlers
================== ==================
Device handler components rerpresent, control and monitor equipment, for example sensors or actuators of a spacecraft or the payload. Device handler components represent, control and monitor equipment, for example sensors or actuators
of a spacecraft or the payload.
Most device handlers have the same common functionality or Most device handlers have the same common functionality or
requirements, which are fulfilled by implementing an certain interface: requirements, which are fulfilled by implementing an certain interface:
@ -17,7 +20,7 @@ requirements, which are fulfilled by implementing an certain interface:
- The handler has modes. For example there are the core modes `MODE_ON`, `MODE_OFF` - The handler has modes. For example there are the core modes `MODE_ON`, `MODE_OFF`
and `MODE_NORMAL` provided by the FSFW. `MODE_ON` means that a device is physically powered and `MODE_NORMAL` provided by the FSFW. `MODE_ON` means that a device is physically powered
but that it is not periodically polling data from the but that it is not periodically polling data from the
physical device, `MODE_NORMAL` means that it is able to do that: :cpp:class`HasModesIF` physical device, `MODE_NORMAL` means that it is able to do that: :cpp:class:`HasModesIF`
The device handler base therefore provides abstractions for a lot of common The device handler base therefore provides abstractions for a lot of common
functionality, which can potentially avoid high amounts or logic and code duplication. functionality, which can potentially avoid high amounts or logic and code duplication.
@ -60,6 +63,7 @@ functions implemented:
and the respective source file with sensible default return values: and the respective source file with sensible default return values:
.. code-block:: cpp .. code-block:: cpp
#include "TestDeviceHandler.h" #include "TestDeviceHandler.h"
TestDeviceHandler::TestDeviceHandler(object_id_t objectId, object_id_t comIF, CookieIF* cookie) TestDeviceHandler::TestDeviceHandler(object_id_t objectId, object_id_t comIF, CookieIF* cookie)

2
docs/highlevel.rst
View File

@ -118,7 +118,7 @@ The DH has mechanisms to monitor the communication with the physical device whic
for FDIR reaction. Device Handlers can be created by implementing ``DeviceHandlerBase``. for FDIR reaction. Device Handlers can be created by implementing ``DeviceHandlerBase``.
A standard FDIR component for the DH will be created automatically but can A standard FDIR component for the DH will be created automatically but can
be overwritten by the user. More information on DeviceHandlers can be found in the be overwritten by the user. More information on DeviceHandlers can be found in the
related [documentation section](doc/README-devicehandlers.md#top). related :ref:`documentation section <dhb-prim-doc>`.
Modes and Health Modes and Health
-------------------- --------------------