controller.h File Reference

System orchestration layer. More...

#include "esp_err.h"

Include dependency graph for controller.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations
enum	controller_state_t {   CONTROLLER_STATE_UNINITIALIZED , CONTROLLER_STATE_INIT , CONTROLLER_STATE_RUNNING , CONTROLLER_STATE_FAULT ,   CONTROLLER_STATE_STOPPING }
	System states structure. More...

Functions
void	controller_run (void)
	Start controller.
controller_state_t	controller_get_state (void)
	Get current controller state.
void	controller_request_stop (void)
	Stop controller.

Detailed Description

System orchestration layer.

Author

Abanoub Salah

• Responsibilities
  • Trigger system initialization/deinitialization
  • Trigger tasks start/stop

Enumeration Type Documentation

controller_state_t

enum controller_state_t

System states structure.

Enumerator
CONTROLLER_STATE_UNINITIALIZED	Uninitialized: Unknown state
CONTROLLER_STATE_INIT	Transitioning: Setting up hardware/drivers
CONTROLLER_STATE_RUNNING	Nominal: System operational
CONTROLLER_STATE_FAULT	Critical error encountered
CONTROLLER_STATE_STOPPING	Safe shutdown/reboot process

Function Documentation

controller_get_state()

controller_state_t controller_get_state

(

void

)

Get current controller state.

Returns

Controller state

< State lock wait timeout in micro seconds

Here is the caller graph for this function:

controller_request_stop()

void controller_request_stop

(

void

)

Stop controller.

Request deinitialize and stopping of different system components

Here is the call graph for this function:

controller_run()

void controller_run

(

void

)

Start controller.

Initialize, setup and start different system components

< Yield time of control loop in micro seconds

Here is the call graph for this function:

Here is the caller graph for this function: