help/html/openlcb__node_8h_source.html

// This is a guard condition so that contents of this file are not included

// more than once.

#ifndef __OPENLCB_OPENLCB_NODE__

#define __OPENLCB_OPENLCB_NODE__


#include <stdbool.h>

#include <stdint.h>


#include "openlcb_types.h"


typedef struct

{


    void (*on_100ms_timer_tick)(void);


} interface_openlcb_node_t;


#ifdef __cplusplus

extern "C" {

#endif /* __cplusplus */


    extern void OpenLcbNode_initialize(const interface_openlcb_node_t *interface);


    extern openlcb_node_t *OpenLcbNode_allocate(uint64_t node_id, const node_parameters_t *node_parameters);


    extern openlcb_node_t *OpenLcbNode_get_first(uint8_t key);


    extern openlcb_node_t *OpenLcbNode_get_next(uint8_t key);


    extern bool OpenLcbNode_is_last(uint8_t key);


    extern openlcb_node_t *OpenLcbNode_find_by_alias(uint16_t alias);


    extern openlcb_node_t *OpenLcbNode_find_by_node_id(uint64_t node_id);


    extern void OpenLcbNode_reset_state(void);


    extern uint16_t OpenLcbNode_get_count(void);


    extern void OpenLcbNode_100ms_timer_tick(uint8_t current_tick);


#ifdef __cplusplus

}

#endif /* __cplusplus */


#endif /* __OPENLCB_OPENLCB_NODE__ */

OpenLcbNode_find_by_alias
openlcb_node_t * OpenLcbNode_find_by_alias(uint16_t alias)
Finds a node by its 12-bit CAN alias.
Definition openlcb_node.c:380

OpenLcbNode_allocate
openlcb_node_t * OpenLcbNode_allocate(uint64_t node_id, const node_parameters_t *node_parameters)
Allocates a new node with the given ID and configuration.
Definition openlcb_node.c:338

OpenLcbNode_is_last
bool OpenLcbNode_is_last(uint8_t key)
Returns true if the current enumeration position is the last node.
Definition openlcb_node.c:249

OpenLcbNode_find_by_node_id
openlcb_node_t * OpenLcbNode_find_by_node_id(uint64_t node_id)
Finds a node by its 64-bit OpenLCB node ID.
Definition openlcb_node.c:409

OpenLcbNode_get_count
uint16_t OpenLcbNode_get_count(void)
Returns the number of allocated nodes.
Definition openlcb_node.c:479

OpenLcbNode_get_next
openlcb_node_t * OpenLcbNode_get_next(uint8_t key)
Returns the next allocated node for the given enumerator key.
Definition openlcb_node.c:215

OpenLcbNode_reset_state
void OpenLcbNode_reset_state(void)
Resets all allocated nodes to their initial login state.
Definition openlcb_node.c:462

OpenLcbNode_initialize
void OpenLcbNode_initialize(const interface_openlcb_node_t *interface)
Initializes the node management module.
Definition openlcb_node.c:146

OpenLcbNode_get_first
openlcb_node_t * OpenLcbNode_get_first(uint8_t key)
Returns the first allocated node for enumeration.
Definition openlcb_node.c:181

OpenLcbNode_100ms_timer_tick
void OpenLcbNode_100ms_timer_tick(uint8_t current_tick)
100ms timer tick handler — gates the application callback.
Definition openlcb_node.c:437

openlcb_types.h
Core type definitions, structures, and configuration constants for the OpenLCB library.

interface_openlcb_node_t
Dependency injection interface for the OpenLCB Node module.
Definition openlcb_node.h:56

node_parameters_TAG
Complete node configuration parameters (typically const/flash).
Definition openlcb_types.h:562

openlcb_node_TAG
OpenLCB virtual node.
Definition openlcb_types.h:679