protocol_train_handler.h

Go to the documentation of this file.

 
#ifndef __OPENLCB_PROTOCOL_TRAIN_HANDLER__
#define __OPENLCB_PROTOCOL_TRAIN_HANDLER__
 
#include <stdbool.h>
#include <stdint.h>
 
#include "openlcb_types.h"
 
    typedef struct {
 
        // ---- Train-node side: notifiers (fire after state updated) ----
 
        void (*on_speed_changed)(openlcb_node_t *openlcb_node, uint16_t speed_float16);
 
        void (*on_function_changed)(openlcb_node_t *openlcb_node, uint32_t fn_address, uint16_t fn_value);
 
        void (*on_emergency_entered)(openlcb_node_t *openlcb_node, train_emergency_type_enum emergency_type);
 
        void (*on_emergency_exited)(openlcb_node_t *openlcb_node, train_emergency_type_enum emergency_type);
 
        void (*on_controller_assigned)(openlcb_node_t *openlcb_node, node_id_t controller_node_id);
 
        void (*on_controller_released)(openlcb_node_t *openlcb_node);
 
        void (*on_listener_changed)(openlcb_node_t *openlcb_node);
 
        void (*on_heartbeat_timeout)(openlcb_node_t *openlcb_node);
 
        // ---- Train-node side: decision callbacks ----
 
        bool (*on_controller_assign_request)(openlcb_node_t *openlcb_node, node_id_t current_controller, node_id_t requesting_controller);
 
        bool (*on_controller_changed_request)(openlcb_node_t *openlcb_node, node_id_t new_controller);
 
        // ---- Throttle side: notifiers (receiving replies from train) ----
 
        void (*on_query_speeds_reply)(openlcb_node_t *openlcb_node, uint16_t set_speed, uint8_t status, uint16_t commanded_speed, uint16_t actual_speed);
 
        void (*on_query_function_reply)(openlcb_node_t *openlcb_node, uint32_t fn_address, uint16_t fn_value);
 
        void (*on_controller_assign_reply)(openlcb_node_t *openlcb_node, uint8_t result, node_id_t current_controller);
 
        void (*on_controller_query_reply)(openlcb_node_t *openlcb_node, uint8_t flags, node_id_t controller_node_id);
 
        void (*on_controller_changed_notify_reply)(openlcb_node_t *openlcb_node, uint8_t result);
 
        void (*on_listener_attach_reply)(openlcb_node_t *openlcb_node, node_id_t node_id, uint8_t result);
 
        void (*on_listener_detach_reply)(openlcb_node_t *openlcb_node, node_id_t node_id, uint8_t result);
 
        void (*on_listener_query_reply)(openlcb_node_t *openlcb_node, uint8_t count, uint8_t index, uint8_t flags, node_id_t node_id);
 
        void (*on_reserve_reply)(openlcb_node_t *openlcb_node, uint8_t result);
 
        void (*on_heartbeat_request)(openlcb_node_t *openlcb_node, uint32_t timeout_seconds);
 
    } interface_protocol_train_handler_t;
 
#ifdef __cplusplus
extern "C" {
#endif
 
    extern void ProtocolTrainHandler_initialize(const interface_protocol_train_handler_t *interface);
 
    extern void ProtocolTrainHandler_handle_train_command(openlcb_statemachine_info_t *statemachine_info);
 
    extern void ProtocolTrainHandler_handle_train_reply(openlcb_statemachine_info_t *statemachine_info);
 
    extern void ProtocolTrainHandler_handle_emergency_event(
            openlcb_statemachine_info_t *statemachine_info, event_id_t event_id);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* __OPENLCB_PROTOCOL_TRAIN_HANDLER__ */