help/html/protocol__snip_8h_source.html

#ifndef __OPENLCB_PROTOCOL_SNIP__

#define    __OPENLCB_PROTOCOL_SNIP__


#include <stdbool.h>

#include <stdint.h>


#include "openlcb_types.h"


typedef struct {


   uint16_t(*config_memory_read)(openlcb_node_t *openlcb_node, uint32_t address, uint16_t count, configuration_memory_buffer_t* buffer);


} interface_openlcb_protocol_snip_t;


#ifdef    __cplusplus

extern "C" {

#endif /* __cplusplus */


    extern void ProtocolSnip_initialize(const interface_openlcb_protocol_snip_t *interface_openlcb_protocol_snip);


    extern void ProtocolSnip_handle_simple_node_info_request(openlcb_statemachine_info_t *statemachine_info);


    extern void ProtocolSnip_handle_simple_node_info_reply(openlcb_statemachine_info_t *statemachine_info);


    // ---- Individual SNIP field loaders (used internally to build the reply) ----

    //

    // All share the same signature:

    //   (node, outgoing_msg, payload_offset, max_bytes) → bytes_written


    extern uint16_t ProtocolSnip_load_manufacturer_version_id(openlcb_node_t* openlcb_node, openlcb_msg_t* outgoing_msg, uint16_t offset, uint16_t requested_bytes);


    extern uint16_t ProtocolSnip_load_name(openlcb_node_t* openlcb_node, openlcb_msg_t* outgoing_msg, uint16_t offset, uint16_t requested_bytes);


    extern uint16_t ProtocolSnip_load_model(openlcb_node_t* openlcb_node, openlcb_msg_t* outgoing_msg, uint16_t offset, uint16_t requested_bytes);


    extern uint16_t ProtocolSnip_load_hardware_version(openlcb_node_t* openlcb_node, openlcb_msg_t* outgoing_msg, uint16_t offset, uint16_t requested_bytes);


    extern uint16_t ProtocolSnip_load_software_version(openlcb_node_t* openlcb_node, openlcb_msg_t* outgoing_msg, uint16_t offset, uint16_t requested_bytes);


    extern uint16_t ProtocolSnip_load_user_version_id(openlcb_node_t* openlcb_node, openlcb_msg_t* outgoing_msg, uint16_t offset, uint16_t requested_bytes);


    extern uint16_t ProtocolSnip_load_user_name(openlcb_node_t* openlcb_node, openlcb_msg_t* outgoing_msg, uint16_t offset, uint16_t requested_bytes);


    extern uint16_t ProtocolSnip_load_user_description(openlcb_node_t* openlcb_node, openlcb_msg_t* outgoing_msg, uint16_t offset, uint16_t requested_bytes);


    extern bool ProtocolSnip_validate_snip_reply(openlcb_msg_t* snip_reply_msg);


#ifdef    __cplusplus

}

#endif /* __cplusplus */


#endif    /* __OPENLCB_PROTOCOL_SNIP__ */

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

configuration_memory_buffer_t
uint8_t configuration_memory_buffer_t[LEN_DATAGRAM_MAX_PAYLOAD]
Configuration memory read/write operation buffer (64 bytes).
Definition openlcb_types.h:365

ProtocolSnip_load_name
uint16_t ProtocolSnip_load_name(openlcb_node_t *openlcb_node, openlcb_msg_t *outgoing_msg, uint16_t offset, uint16_t requested_bytes)
Copies manufacturer name string (null-terminated).
Definition protocol_snip.c:164

ProtocolSnip_load_manufacturer_version_id
uint16_t ProtocolSnip_load_manufacturer_version_id(openlcb_node_t *openlcb_node, openlcb_msg_t *outgoing_msg, uint16_t offset, uint16_t requested_bytes)
Copies manufacturer version ID byte (1 byte).
Definition protocol_snip.c:151

ProtocolSnip_initialize
void ProtocolSnip_initialize(const interface_openlcb_protocol_snip_t *interface_openlcb_protocol_snip)
Stores the callback interface. Call once at startup.
Definition protocol_snip.c:70

ProtocolSnip_handle_simple_node_info_request
void ProtocolSnip_handle_simple_node_info_request(openlcb_statemachine_info_t *statemachine_info)
Builds a SNIP reply (MTI 0x0A08) from node params + config memory.
Definition protocol_snip.c:314

ProtocolSnip_load_user_description
uint16_t ProtocolSnip_load_user_description(openlcb_node_t *openlcb_node, openlcb_msg_t *outgoing_msg, uint16_t offset, uint16_t requested_bytes)
Reads user description from config memory (null-terminated, max 64 bytes).
Definition protocol_snip.c:274

ProtocolSnip_load_user_version_id
uint16_t ProtocolSnip_load_user_version_id(openlcb_node_t *openlcb_node, openlcb_msg_t *outgoing_msg, uint16_t offset, uint16_t requested_bytes)
Copies user version ID byte (1 byte).
Definition protocol_snip.c:200

ProtocolSnip_handle_simple_node_info_reply
void ProtocolSnip_handle_simple_node_info_reply(openlcb_statemachine_info_t *statemachine_info)
Handles an incoming SNIP reply (MTI 0x0A08). No automatic response.
Definition protocol_snip.c:378

ProtocolSnip_load_software_version
uint16_t ProtocolSnip_load_software_version(openlcb_node_t *openlcb_node, openlcb_msg_t *outgoing_msg, uint16_t offset, uint16_t requested_bytes)
Copies software version string (null-terminated).
Definition protocol_snip.c:191

ProtocolSnip_load_model
uint16_t ProtocolSnip_load_model(openlcb_node_t *openlcb_node, openlcb_msg_t *outgoing_msg, uint16_t offset, uint16_t requested_bytes)
Copies model string (null-terminated).
Definition protocol_snip.c:173

ProtocolSnip_load_hardware_version
uint16_t ProtocolSnip_load_hardware_version(openlcb_node_t *openlcb_node, openlcb_msg_t *outgoing_msg, uint16_t offset, uint16_t requested_bytes)
Copies hardware version string (null-terminated).
Definition protocol_snip.c:182

ProtocolSnip_validate_snip_reply
bool ProtocolSnip_validate_snip_reply(openlcb_msg_t *snip_reply_msg)
Validates a SNIP reply: correct MTI, valid length, exactly 6 null terminators.
Definition protocol_snip.c:398

ProtocolSnip_load_user_name
uint16_t ProtocolSnip_load_user_name(openlcb_node_t *openlcb_node, openlcb_msg_t *outgoing_msg, uint16_t offset, uint16_t requested_bytes)
Reads user name from config memory (null-terminated, max 63 bytes).
Definition protocol_snip.c:229

interface_openlcb_protocol_snip_t
Callback interface for SNIP. config_memory_read is REQUIRED.
Definition protocol_snip.h:48

openlcb_msg_t
Core OpenLCB message structure.
Definition openlcb_types.h:480

openlcb_node_TAG
OpenLCB virtual node.
Definition openlcb_types.h:679

openlcb_statemachine_info_t
Complete context passed to protocol handler functions.
Definition openlcb_types.h:743