ALPAKA/TACOS
1
0
Fork 0
mirror of https://git.intern.spaceteamaachen.de/ALPAKA/TACOS.git synced 2025-08-06 09:37:34 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated statemachine documentation to reference existing documentation

Browse Source
This commit is contained in:
dario
2024-12-01 15:11:42 +01:00
parent e89b21ddcc
commit 36c160e8e3
2 changed files with 9 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
include/sta/README.md
View File

@@ -15,7 +15,7 @@ Retrieves the current state of the TACOS state machine.
void requestState(uint32_t from, uint32_t to, uint32_t lockout = 0, bool publish = true)
```
Requests a state transition. Invalid state transitions will be dismissed. First come, first serve.
Requests a state transition. Invalid state transitions will be dismissed. First come, first serve. Can be blocked by the lockout timer.
- **Parameters**:
- `from`: The starting state for the transition.
@@ -27,7 +27,7 @@ Requests a state transition. Invalid state transitions will be dismissed. First
void forceState(uint32_t from, uint32_t to, uint32_t lockout = 0, bool publish = true)
```
Forces a state transition. Will be ignored if already in the given state. Triggers instantly.
Forces a state transition. Will be ignored if already in the given state. Triggers instantly. Ignores the lockout timer.
- **Parameters**:
- `from`: The starting state for the transition.
@@ -41,7 +41,7 @@ Forces a state transition. Will be ignored if already in the given state. Trigge
void setStateTimed(uint32_t from, uint32_t to, uint32_t millis, uint32_t lockout = 0, bool publish = false)
```
Requests a state transition after a specified time.
Requests a state transition after a specified time. Equivalent to calling `requestState` after a specified time.
- **Parameters**:
- `from`: The starting state.
@@ -49,6 +49,9 @@ Requests a state transition after a specified time.
- `millis`: The wait time in milliseconds before requesting the transition.
- `lockout`: (Optional) A timer for blocking subsequent transitions.
> [!IMPORTANT]
> If there is already a timed transition scheduled, calling `setStateTimed` will overwrite this request.
---
```cpp