Stima V4 Slave RAIN  4.2
SupervisorTask Class Reference

SUPERVISOR TASK cpp_freertos class. More...

#include <supervisor_task.h>

Inheritance diagram for SupervisorTask:

Public Member Functions

 SupervisorTask (const char *taskName, uint16_t stackSize, uint8_t priority, SupervisorParam_t SupervisorParam)
 Construct the Supervisor Task::SupervisorTask object. More...
 

Protected Member Functions

virtual void Run ()
 RUN Task. More...
 

Private Types

enum  SupervisorState_t { SUPERVISOR_STATE_CREATE , SUPERVISOR_STATE_INIT , SUPERVISOR_STATE_CHECK_OPERATION , SUPERVISOR_STATE_END }
 Enum for state switch of running method. More...
 

Private Member Functions

void TaskWatchDog (uint32_t millis_standby)
 local watchDog and Sleep flag Task (optional) More...
 
void TaskState (uint8_t state_position, uint8_t state_subposition, task_flag state_operation)
 local suspend flag and positor running state Task (optional) More...
 
void printConfiguration ()
 Print configuratione. More...
 
void loadConfiguration ()
 Load configuration from Register. More...
 
void saveConfiguration (bool is_default)
 Save/Init configuration base Register Class. More...
 

Private Attributes

STM32RTC & rtc = STM32RTC::getInstance()
 
SupervisorState_t state
 
SupervisorParam_t param
 

Detailed Description

SUPERVISOR TASK cpp_freertos class.

Definition at line 75 of file supervisor_task.h.

Member Enumeration Documentation

◆ SupervisorState_t

Enum for state switch of running method.

Enumerator
SUPERVISOR_STATE_CREATE 
SUPERVISOR_STATE_INIT 
SUPERVISOR_STATE_CHECK_OPERATION 
SUPERVISOR_STATE_END 

Definition at line 78 of file supervisor_task.h.

Constructor & Destructor Documentation

◆ SupervisorTask()

SupervisorTask::SupervisorTask ( const char *  taskName,
uint16_t  stackSize,
uint8_t  priority,
SupervisorParam_t  supervisorParam 
)

Construct the Supervisor Task::SupervisorTask object.

Parameters
taskNamename of the task
stackSizesize of the stack
prioritypriority of the task
supervisorParamparameters for the task

Definition at line 43 of file supervisor_task.cpp.

Member Function Documentation

◆ loadConfiguration()

void SupervisorTask::loadConfiguration ( void  )
private

Load configuration from Register.

Definition at line 231 of file supervisor_task.cpp.

◆ printConfiguration()

void SupervisorTask::printConfiguration ( void  )
private

Print configuratione.

Definition at line 454 of file supervisor_task.cpp.

◆ Run()

void SupervisorTask::Run ( )
protectedvirtual

RUN Task.

Definition at line 111 of file supervisor_task.cpp.

◆ saveConfiguration()

void SupervisorTask::saveConfiguration ( bool  is_default)
private

Save/Init configuration base Register Class.

Parameters
is_defaulttrue if is need to prepare config default value

Definition at line 362 of file supervisor_task.cpp.

◆ TaskState()

void SupervisorTask::TaskState ( uint8_t  state_position,
uint8_t  state_subposition,
task_flag  state_operation 
)
private

local suspend flag and positor running state Task (optional)

Parameters
state_positionSw_Position (Local STATE)
state_subpositionSw_SubPosition (Optional Local SUB_STATE Position Monitor)
state_operationoperative mode flag status for this task

Definition at line 96 of file supervisor_task.cpp.

◆ TaskWatchDog()

void SupervisorTask::TaskWatchDog ( uint32_t  millis_standby)
private

local watchDog and Sleep flag Task (optional)

Parameters
millis_standbytime in ms to perfor check of WDT. If longer than WDT Reset, WDT is temporanly suspend

Definition at line 71 of file supervisor_task.cpp.

Member Data Documentation

◆ param

SupervisorParam_t SupervisorTask::param
private

Definition at line 106 of file supervisor_task.h.

◆ rtc

STM32RTC& SupervisorTask::rtc = STM32RTC::getInstance()
private

Definition at line 103 of file supervisor_task.h.

◆ state

SupervisorState_t SupervisorTask::state
private

Definition at line 105 of file supervisor_task.h.


The documentation for this class was generated from the following files: