APIs description

Doxygen complete API documentation

Doxygen documentation Link to doxygen API documentation

Available classes

GENERAL_CONFIG

struct GENERAL_CONFIG

Configuration parameters for the application.

PIN_CONFIG

struct PIN_CONFIG

Configuration for pin assignments.

SENSOR_UNIT_CONFIG

class SENSOR_UNIT_CONFIG

This class represents the configuration for a sensor.

Public Functions

inline SENSOR_UNIT_CONFIG(bool enable, uint32_t period)

Constructs a new SENSOR_UNIT_CONFIG object with the specified enable and period values.

Parameters:

  • enable – Whether the sensor unit task is enabled or not.

  • period – The period of the sensor unit task in milliseconds.

inline bool setRatio(uint32_t taskPeriod)

Sets the ratio of the current loop necessary to require sensor parsing.

Parameters:

taskPeriod – The period of the current loop in milliseconds.

Returns:

True if the ratio was set successfully, false otherwise.

inline void setPeriod(uint32_t newPeriod)

Sets the period of the sensor unit task.

Parameters:

newPeriod – The new period of the sensor unit task in milliseconds.

inline bool checkRatio()

Checks if the sensor has to be parsed in the current loop.

Returns:

True if the sensor has to be parsed, false otherwise.

inline void resetRatioCounter()

Resets the task ticks counter.

TASKS_UNIT_CONFIG

struct TASKS_UNIT_CONFIG

Structure representing the configuration of a task.

Public Functions

inline TASKS_UNIT_CONFIG(bool enable, UBaseType_t priority, uint32_t stackSize, uint32_t period, BaseType_t coreID, TaskHandle_t *TaskHandle)

Constructor for the TASKS_UNIT_CONFIG structure.

Parameters:

  • enable – Flag indicating whether the task is enabled or not.

  • priority – Priority of the task.

  • stackSize – Size of the task’s stack.

  • period – Period of the task in milliseconds.

  • coreID – ID of the core on which the task should run.

  • TaskHandle – Pointer to the task handle.

Public Members

bool enable = true

Flag indicating whether the task is enabled or not.

UBaseType_t priority = 0

Priority of the task.

uint32_t stackSize = 2048

Size of the task’s stack.

uint32_t period = 2U

Period of the task in milliseconds.

BaseType_t coreID = 0

ID of the core on which the task should run.

TaskHandle_t *TaskHandle = NULL

Pointer to the task handle.