KSat/fsfw
15
4
Fork 0
forked from fsfw/fsfw
Code Issues Pull Requests Releases Wiki Activity

updated readme

Browse Source
This commit is contained in:
Robin Müller 2021-03-04 18:12:34 +01:00
parent 6df1abf570
commit 69b428222a
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/README-localpools.md
View File

@ -15,11 +15,7 @@ The two former tasks are related to the external interface using telemetry and t
while the later two are related to data consumers like controllers only acting on data change while the later two are related to data consumers like controllers only acting on data change
detected by the data creator instead of checking the data manually each cycle. Two important detected by the data creator instead of checking the data manually each cycle. Two important
framework classes `DeviceHandlerBase` and `ExtendedControllerBase` already perform the two steps framework classes `DeviceHandlerBase` and `ExtendedControllerBase` already perform the two steps
shown above so the steps required are altered slightly. The following diagram shows the shown above so the steps required are altered slightly.
high-level architecture of the local data pools.
<img align="center" src="./images/PoolArchitecture.png" width="50%">
### Storing and Accessing pool data ### Storing and Accessing pool data
@ -31,7 +27,10 @@ on a `read` call. Changed variables can then be written to the local pool with a
The `read` and `commit` calls are thread-safe and can be called concurrently from data creators The `read` and `commit` calls are thread-safe and can be called concurrently from data creators
and data consumers. Generally, a user will create a dataset class which in turn groups all and data consumers. Generally, a user will create a dataset class which in turn groups all
cohesive pool variables. These sets simply iterator over the list of variables and call the cohesive pool variables. These sets simply iterator over the list of variables and call the
`read` and `commit` functions of each variable. `read` and `commit` functions of each variable. The following diagram shows the
high-level architecture of the local data pools.
<img align="center" src="./images/PoolArchitecture.png" width="50%"> <br>
An example is shown for using the local data pools with a Gyroscope. An example is shown for using the local data pools with a Gyroscope.
For example, the following code shows an implementation to access data from a Gyroscope taken For example, the following code shows an implementation to access data from a Gyroscope taken