OpenLcbCLib 1.0 Alpha
OpenSource C Library to create OpenLcb/Lcc Nodes
Loading...
Searching...
No Matches
Node Enumeration Key Management

User keys (0-3) and internal keys (4-6) for independent node enumeration. More...

Macros

#define MAX_INTERNAL_ENUM_KEYS_VALUES   4
 Maximum number of enumeration keys available for user/application.
 
#define MAX_USER_ENUM_KEYS_VALUES   4
 Maximum number of internal system enumeration keys.
 
#define USER_ENUM_KEYS_VALUES_1   0
 User enumeration key 1.
 
#define USER_ENUM_KEYS_VALUES_2   1
 User enumeration key 2.
 
#define USER_ENUM_KEYS_VALUES_3   2
 User enumeration key 3.
 
#define USER_ENUM_KEYS_VALUES_4   3
 User enumeration key 4.
 
#define MAX_NODE_ENUM_KEY_VALUES   (MAX_USER_ENUM_KEYS_VALUES + MAX_INTERNAL_ENUM_KEYS_VALUES)
 Total number of enumeration keys (user + internal)
 
#define OPENLCB_MAIN_STATMACHINE_NODE_ENUMERATOR_INDEX   MAX_USER_ENUM_KEYS_VALUES
 Enumeration key used by main OpenLCB state machine.
 
#define OPENLCB_LOGIN_STATMACHINE_NODE_ENUMERATOR_INDEX   (MAX_USER_ENUM_KEYS_VALUES + 1)
 Enumeration key used by login state machine.
 
#define CAN_STATEMACHINE_NODE_ENUMRATOR_KEY   (MAX_USER_ENUM_KEYS_VALUES + 2)
 Enumeration key used by CAN state machine.
 
#define DATAGRAM_TIMEOUT_ENUM_KEY   (MAX_USER_ENUM_KEYS_VALUES + 3)
 Enumeration key used by datagram timeout scanner.
 

Detailed Description

User keys (0-3) and internal keys (4-6) for independent node enumeration.

Macro Definition Documentation

◆ MAX_INTERNAL_ENUM_KEYS_VALUES

#define MAX_INTERNAL_ENUM_KEYS_VALUES   4

Maximum number of enumeration keys available for user/application.

◆ MAX_USER_ENUM_KEYS_VALUES

#define MAX_USER_ENUM_KEYS_VALUES   4

Maximum number of internal system enumeration keys.

◆ USER_ENUM_KEYS_VALUES_1

#define USER_ENUM_KEYS_VALUES_1   0

User enumeration key 1.

◆ USER_ENUM_KEYS_VALUES_2

#define USER_ENUM_KEYS_VALUES_2   1

User enumeration key 2.

◆ USER_ENUM_KEYS_VALUES_3

#define USER_ENUM_KEYS_VALUES_3   2

User enumeration key 3.

◆ USER_ENUM_KEYS_VALUES_4

#define USER_ENUM_KEYS_VALUES_4   3

User enumeration key 4.

◆ MAX_NODE_ENUM_KEY_VALUES

#define MAX_NODE_ENUM_KEY_VALUES   (MAX_USER_ENUM_KEYS_VALUES + MAX_INTERNAL_ENUM_KEYS_VALUES)

Total number of enumeration keys (user + internal)

◆ OPENLCB_MAIN_STATMACHINE_NODE_ENUMERATOR_INDEX

#define OPENLCB_MAIN_STATMACHINE_NODE_ENUMERATOR_INDEX   MAX_USER_ENUM_KEYS_VALUES

Enumeration key used by main OpenLCB state machine.

◆ OPENLCB_LOGIN_STATMACHINE_NODE_ENUMERATOR_INDEX

#define OPENLCB_LOGIN_STATMACHINE_NODE_ENUMERATOR_INDEX   (MAX_USER_ENUM_KEYS_VALUES + 1)

Enumeration key used by login state machine.

◆ CAN_STATEMACHINE_NODE_ENUMRATOR_KEY

#define CAN_STATEMACHINE_NODE_ENUMRATOR_KEY   (MAX_USER_ENUM_KEYS_VALUES + 2)

Enumeration key used by CAN state machine.

◆ DATAGRAM_TIMEOUT_ENUM_KEY

#define DATAGRAM_TIMEOUT_ENUM_KEY   (MAX_USER_ENUM_KEYS_VALUES + 3)

Enumeration key used by datagram timeout scanner.


Copyright (c) 2026 Jim Kueneman all rights reserved. See the License