ALPAKA/TACOS
1
0
Fork 0
mirror of https://git.intern.spaceteamaachen.de/ALPAKA/TACOS.git synced 2025-06-10 16:45:59 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Added API group

Browse Source
This commit is contained in:
@CarlWachter 2024-01-06 13:02:18 +01:00
parent 2494b4f0c1
commit 759495f2ce
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
include/sta/tacos.hpp
View File

@ -15,6 +15,12 @@
#include <initializer_list> #include <initializer_list>
#include <type_traits> #include <type_traits>
/**
* @defgroup tacos_api TACOS API
* @brief Functions and classes that are used to interact with TACOS.
*
* @details This module contains all functions and classes that are used to interact with TACOS. It is the only module that should be used in user code.
*/
namespace sta namespace sta
{ {
@ -24,6 +30,8 @@ namespace sta
* @brief Get the current state of the TACOS statemachine. * @brief Get the current state of the TACOS statemachine.
* *
* @return uint16_t Returns the state. * @return uint16_t Returns the state.
*
* @ingroup tacos_api
*/ */
uint16_t getState(); uint16_t getState();
@ -33,6 +41,8 @@ namespace sta
* @param from The start we want to transition from. * @param from The start we want to transition from.
* @param to The state we want to transition to. * @param to The state we want to transition to.
* @param lockout An optional timer blocking state transition for a given time. * @param lockout An optional timer blocking state transition for a given time.
*
* @ingroup tacos_api
*/ */
void setState(uint32_t from, uint32_t to, uint32_t lockout = 0); void setState(uint32_t from, uint32_t to, uint32_t lockout = 0);
@ -43,6 +53,8 @@ namespace sta
* @param to The state we want to transition to. * @param to The state we want to transition to.
* @param millis The time to wait until the transition is requested. * @param millis The time to wait until the transition is requested.
* @param lockout An optional timer blocking state transition for a given time. Will be active after this transition was executed. * @param lockout An optional timer blocking state transition for a given time. Will be active after this transition was executed.
*
* @ingroup tacos_api
*/ */
void setStateTimed(uint32_t from, uint32_t to, uint32_t millis, uint32_t lockout = 0); void setStateTimed(uint32_t from, uint32_t to, uint32_t millis, uint32_t lockout = 0);
@ -52,6 +64,8 @@ namespace sta
* @tparam T The class of the thread to be created. A subclass of TacosThread. * @tparam T The class of the thread to be created. A subclass of TacosThread.
* @param states A list of states in which the thread should run. * @param states A list of states in which the thread should run.
* @param args The constructor arguments for the provided class. * @param args The constructor arguments for the provided class.
*
* @ingroup tacos_api
*/ */
template<typename T, typename ... Args> template<typename T, typename ... Args>
void addThread(std::list<uint16_t> states, Args ... args) void addThread(std::list<uint16_t> states, Args ... args)