File syn_cia303.h¶

FileList > proto > syn_cia303.h

CANopen CiA 303-3 Indicator & Status LED Specification implementation. More...

#include "../common/syn_defs.h"
#include "../output/syn_led.h"

Classes¶

Type	Name
struct	SYN_CiA303_Indicator CiA 303-3 Status Indicator Handle.

Public Types¶

Type	Name
enum	SYN_CiA303_ErrState CiA 303-3 Red ERROR LED indicator states.
enum	SYN_CiA303_RunState CiA 303-3 Green RUN LED indicator states.

Public Functions¶

Type	Name
void	syn_cia303_init (SYN_CiA303_Indicator * ind, SYN_LED * run_led, SYN_LED * err_led) Initialize CiA 303-3 Indicator controller.
void	syn_cia303_set_error_state (SYN_CiA303_Indicator * ind, SYN_CiA303_ErrState err_state) Update Red ERROR LED state.
void	syn_cia303_set_nmt_state (SYN_CiA303_Indicator * ind, uint8_t nmt_state) Update RUN LED state according to CANopen NMT state.
void	syn_cia303_step (SYN_CiA303_Indicator * ind) Step indicator LEDs (call periodically or from main loop).

Detailed Description¶

Provides standard CiA 303-3 Green "RUN" and Red "ERROR" LED indicator patterns for CANopen node status visualization, fully integrated with SyntropicOS's syn_led controller and syn_canopen_mgr NMT engine.

Public Types Documentation¶

enum SYN_CiA303_ErrState¶

CiA 303-3 Red ERROR LED indicator states.

enum SYN_CiA303_ErrState {
    SYN_CIA303_ERR_OFF = 0,
    SYN_CIA303_ERR_SINGLE_FLASH = 1,
    SYN_CIA303_ERR_DOUBLE_FLASH = 2,
    SYN_CIA303_ERR_TRIPLE_FLASH = 3,
    SYN_CIA303_ERR_SOLID_ON = 4
};

enum SYN_CiA303_RunState¶

CiA 303-3 Green RUN LED indicator states.

enum SYN_CiA303_RunState {
    SYN_CIA303_RUN_OFF = 0,
    SYN_CIA303_RUN_SINGLE_FLASH = 1,
    SYN_CIA303_RUN_BLINKING = 2,
    SYN_CIA303_RUN_SOLID_ON = 3
};

Public Functions Documentation¶

function syn_cia303_init¶

Initialize CiA 303-3 Indicator controller.

void syn_cia303_init (
    SYN_CiA303_Indicator * ind,
    SYN_LED * run_led,
    SYN_LED * err_led
)

Parameters:

ind Indicator instance.
run_led Green RUN LED instance (initialized).
err_led Red ERROR LED instance (initialized).

function syn_cia303_set_error_state¶

Update Red ERROR LED state.

void syn_cia303_set_error_state (
    SYN_CiA303_Indicator * ind,
    SYN_CiA303_ErrState err_state
)

Parameters:

ind Indicator instance.
err_state CiA 303-3 Error state enum.

function syn_cia303_set_nmt_state¶

Update RUN LED state according to CANopen NMT state.

void syn_cia303_set_nmt_state (
    SYN_CiA303_Indicator * ind,
    uint8_t nmt_state
)

Parameters:

ind Indicator instance.
nmt_state CANopen NMT state byte (e.g. Pre-Op, Op, Stopped).

function syn_cia303_step¶

Step indicator LEDs (call periodically or from main loop).

void syn_cia303_step (
    SYN_CiA303_Indicator * ind
)

Parameters:

ind Indicator instance.

The documentation for this class was generated from the following file src/syntropic/proto/syn_cia303.h