vlcb_defs.h

Go to the documentation of this file.

#pragma once
 
#include <stdint.h>
typedef uint8_t VlcbRocRailModuleType;
enum VlcbRocRailModuleType {
 
  VLCB_ROCRAIL_MODULE_CANGC1 = 1,
 
  VLCB_ROCRAIL_MODULE_CANGC2 = 2,
 
  VLCB_ROCRAIL_MODULE_CANGC3 = 3,
 
  VLCB_ROCRAIL_MODULE_CANGC4 = 4,
 
  VLCB_ROCRAIL_MODULE_CANGC5 = 5,
 
  VLCB_ROCRAIL_MODULE_CANGC6 = 6,
 
  VLCB_ROCRAIL_MODULE_CANGC7 = 7,
 
  VLCB_ROCRAIL_MODULE_CANGC1E = 11,
 
};
typedef uint8_t VlcbSpectrumModuleType;
enum VlcbSpectrumModuleType {
 
  VLCB_SPECTRUM_MODULE_AMCTRLR = 1,
 
  VLCB_SPECTRUM_MODULE_DUALCAB = 2,
 
};
typedef uint8_t VlcbSprogModuleType;
enum VlcbSprogModuleType {
 
  VLCB_SPROG_MODULE_CANPI_SPRG3 = 1,
 
  VLCB_SPROG_MODULE_CANSPROG3P = 2,
 
  VLCB_SPROG_MODULE_CANSPROG = 3,
 
  VLCB_SPROG_MODULE_CANSBOOST = 4,
 
  VLCB_SPROG_MODULE_CANPI_SPRGP = 5,
 
  VLCB_SPROG_MODULE_CANSOLNOID = 8,
 
  VLCB_SPROG_MODULE_CANSERVOIO = 50,
 
  VLCB_SPROG_MODULE_CANISB = 100,
 
  VLCB_SPROG_MODULE_CANSOLIO = 101,
 
};
typedef uint8_t VlcbDccServiceModeStatus;
enum VlcbDccServiceModeStatus {
 
  VLCB_DCC_SVC_MODE_STAT_NO_ACK = 1,
 
  VLCB_DCC_SVC_MODE_STAT_OVLD = 2,
 
  VLCB_DCC_SVC_MODE_STAT_WRITE_ACK = 3,
 
  VLCB_DCC_SVC_MODE_STAT_BUSY = 4,
 
  VLCB_DCC_SVC_MODE_STAT_CV_ERROR = 5,
 
};
typedef uint8_t VlcbDccThrottleSpeedMode;
enum VlcbDccThrottleSpeedMode {
 
  VLCB_DCC_THROTTLE_MODE_STEP128 = 0,
 
  VLCB_DCC_THROTTLE_MODE_STEP14 = 1,
 
  VLCB_DCC_THROTTLE_MODE_STEP28INTERLEAVED = 2,
 
  VLCB_DCC_THROTTLE_MODE_STEP28 = 3,
 
};
typedef uint8_t VlcbSysPixieModuleType;
enum VlcbSysPixieModuleType {
 
  VLCB_SYSPIXIE_MODULE_CANPMSENSE = 1,
 
};
typedef uint8_t VlcbGenericResponseStatus;
enum VlcbGenericResponseStatus {
 
  VLCB_GENERIC_RESPONSE_STAT_OK = 0,
 
  VLCB_GENERIC_RESPONSE_INVALID_COMMAND = 1,
 
  VLCB_GENERIC_RESPONSE_NOT_IN_LEARN_MODE = 2,
 
  VLCB_GENERIC_RESPONSE_NOT_IN_SETUP_MODE = 3,
 
  VLCB_GENERIC_RESPONSE_TOO_MANY_EVENTS = 4,
 
  VLCB_GENERIC_RESPONSE_NO_EV = 5,
 
  VLCB_GENERIC_RESPONSE_INVALID_EV_INDEX = 6,
 
  VLCB_GENERIC_RESPONSE_INVALID_EVENT = 7,
 
  VLCB_GENERIC_RESPONSE_INVALID_PARAM_INDEX = 9,
 
  VLCB_GENERIC_RESPONSE_INVALID_NV_INDEX = 10,
 
  VLCB_GENERIC_RESPONSE_INVALID_EV_VALUE = 11,
 
  VLCB_GENERIC_RESPONSE_INVALID_NV_VALUE = 12,
 
  VLCB_GENERIC_RESPONSE_ANOTHER_MODULE_IS_IN_LEARN_MODE = 13,
 
  VLCB_GENERIC_RESPONSE_STAT_UNKNOWN_NVM_TYPE = 254,
 
  VLCB_GENERIC_RESPONSE_STAT_INVALID_DIAGNOSTIC = 253,
 
  VLCB_GENERIC_RESPONSE_STAT_INVALID_SERVICE = 252,
 
  VLCB_GENERIC_RESPONSE_STAT_INVALID_COMMAND_PARAMETER = 251,
 
  VLCB_GENERIC_RESPONSE_STAT_INVALID_MODE = 250,
 
};
typedef uint8_t VlcbModuleMode;
enum VlcbModuleMode {
 
  VLCB_MODULE_MODE_UNINITIALIZED = 255,
 
  VLCB_MODULE_MODE_IN_SETUP = 0,
 
  VLCB_MODULE_MODE_NORMAL = 1,
 
  VLCB_MODULE_MODE_ENABLE_LEARN_MODE = 8,
 
  VLCB_MODULE_MODE_DISABLE_LEARN_MODE = 9,
 
  VLCB_MODULE_MODE_ENABLE_EVENT_ACK = 10,
 
  VLCB_MODULE_MODE_DISABLE_EVENT_ACK = 11,
 
  VLCB_MODULE_MODE_ENABLE_HEARTBEAT = 12,
 
  VLCB_MODULE_MODE_DISABLE_HEARTBEAT = 13,
 
  VLCB_MODULE_MODE_BOOTLOADER = 14,
 
};
typedef uint8_t VlcbServiceType;
enum VlcbServiceType {
 
  VLCB_SVC_TYPE_INTERNAL = 0,
 
  VLCB_SVC_TYPE_MINIMUM_NODE_SERVICE = 1,
 
  VLCB_SVC_TYPE_NODE_VARIABLE = 2,
 
  VLCB_SVC_TYPE_CAN_BUS = 3,
 
  VLCB_SVC_TYPE_LEGACY_EVENT_TEACHING = 4,
 
  VLCB_SVC_TYPE_EVENT_PRODUCER = 5,
 
  VLCB_SVC_TYPE_EVENT_CONSUMER = 6,
 
  VLCB_SVC_TYPE_EVENT_TEACHING = 7,
 
  VLCB_SVC_TYPE_CONSUME_OWN_EVENTS = 8,
 
  VLCB_SVC_TYPE_EVENT_ACKNOWLEDGE = 9,
 
  VLCB_SVC_TYPE_BOOTLOADER = 10,
 
  VLCB_SVC_TYPE_STREAMING = 17,
 
};
typedef uint8_t VlcbOpCode;
enum VlcbOpCode {
 
  VLCB_OPC_GENERAL_ACK = 0,
 
  VLCB_OPC_GENERAL_NACK = 1,
 
  VLCB_OPC_BUS_HALT = 2,
 
  VLCB_OPC_BUS_RESUME = 3,
 
  VLCB_OPC_DCC_TRACK_POWERED_OFF = 4,
 
  VLCB_OPC_DCC_TRACK_POWERED_ON = 5,
 
  VLCB_OPC_DCC_EMERGENCY_STOP_ENGAGED = 6,
 
  VLCB_OPC_RESTART_ALL_NODES = 7,
 
  VLCB_OPC_DCC_TRACK_POWER_OFF = 8,
 
  VLCB_OPC_DCC_TRACK_POWER_ON = 9,
 
  VLCB_OPC_DCC_EMERGENCY_STOP = 10,
 
  VLCB_OPC_DCC_QUERY_COMMAND_STATION_STATUS = 12,
 
  VLCB_OPC_QUERY_MODULE_INFO = 13,
 
  VLCB_OPC_QUERY_MODULE_PARAMETERS = 16,
 
  VLCB_OPC_QUERY_MODULE_NAME = 17,
 
  VLCB_OPC_DCC_RELEASE_SESSION = 33,
 
  VLCB_OPC_DCC_QUERY_LOCO_STATUS = 34,
 
  VLCB_OPC_DCC_SESSION_KEEP_ALIVE = 35,
 
  VLCB_OPC_DEBUG_MSG1 = 48,
 
  VLCB_OPC_EXT_OP_CODE = 63,
 
  VLCB_OPC_DCC_REQUEST_NEW_SESSION = 64,
 
  VLCB_OPC_DCC_QUERY_CONSIST = 65,
 
  VLCB_OPC_SET_NODE_NUMBER = 66,
 
  VLCB_OPC_DCC_ALLOCATE_LOCO_TO_ACTIVITY = 67,
 
  VLCB_OPC_DCC_SET_THROTTLE_MODE = 68,
 
  VLCB_OPC_DCC_CONSIST_ADD_LOCO = 69,
 
  VLCB_OPC_DCC_CONSIST_REMOVE_LOCO = 70,
 
  VLCB_OPC_DCC_SET_LOCO_THROTTLE = 71,
 
  VLCB_OPC_DCC_SET_LOCO_FLAGS = 72,
 
  VLCB_OPC_DCC_LOCO_FUNCTION_ON = 73,
 
  VLCB_OPC_DCC_LOCO_FUNCTION_OFF = 74,
 
  VLCB_OPC_DCC_SERVICE_MODE_STATUS = 76,
 
  VLCB_OPC_RESET_MODULE_TO_FACTORY = 79,
 
  VLCB_OPC_REQUEST_NEW_NODE_NUMBER = 80,
 
  VLCB_OPC_NODE_NUMBER_RELEASED = 81,
 
  VLCB_OPC_NODE_NUMBER_ACK = 82,
 
  VLCB_OPC_PUT_NODE_INTO_LEARN_MODE = 83,
 
  VLCB_OPC_RELEASE_NODE_FROM_LEARN_MODE = 84,
 
  VLCB_OPC_FORGET_ALL_LEARNED_EVENTS = 85,
 
  VLCB_OPC_QUERY_AVAILABLE_EVENT_SLOTS = 86,
 
  VLCB_OPC_QUERY_ALL_LEARNED_EVENTS = 87,
 
  VLCB_OPC_QUERY_LEARNED_EVENT_COUNT = 88,
 
  VLCB_OPC_WRITE_ACK = 89,
 
  VLCB_OPC_QUERY_NODE_DATA = 90,
 
  VLCB_OPC_REQUEST_DEVICE_DATA_SHORT_MODE = 91,
 
  VLCB_OPC_REBOOT_INTO_BOOTLOADER = 92,
 
  VLCB_OPC_FORCE_CAN_ENUMERATION = 93,
 
  VLCB_OPC_RESTART_NODE = 94,
 
  VLCB_OPC_EXT_OP_CODE1 = 95,
 
  VLCB_OPC_DCC_SET_LOCO_FUNCTIONS = 96,
 
  VLCB_OPC_DCC_QUERY_LOCO_SESSION = 97,
 
  VLCB_OPC_DCC_COMMAND_STATION_ERROR = 99,
 
  VLCB_OPC_COMMAND_ERROR = 111,
 
  VLCB_OPC_AVAILABLE_EVENT_SLOTS = 112,
 
  VLCB_OPC_QUERY_NODE_VARIABLE = 113,
 
  VLCB_OPC_QUERY_LEARNED_EVENT_BY_INDEX = 114,
 
  VLCB_OPC_QUERY_NODE_PARAMETER_BY_INDEX = 115,
 
  VLCB_OPC_LEARNED_EVENT_COUNT = 116,
 
  VLCB_OPC_SET_NODE_CAN_ID = 117,
 
  VLCB_OPC_CHANGE_MODULE_MODE = 118,
 
  VLCB_OPC_QUERY_SERVICE_DISCOVERY = 120,
 
  VLCB_OPC_EXT_OP_CODE2 = 127,
 
  VLCB_OPC_DCC_SEND_RAW_PACKET3 = 128,
 
  VLCB_OPC_DCC_WRITE_CV_BYTE_IN_OPS_MODE = 130,
 
  VLCB_OPC_DC_WRITE_CV_BIT_IN_OPS_MODE = 131,
 
  VLCB_OPC_DCC_READ_CV = 132,
 
  VLCB_OPC_DCC_CV_VALUE = 133,
 
  VLCB_OPC_QUERY_DIAGNOSTIC_DATA = 135,
 
  VLCB_OPC_SET_NODE_VARIABLE = 142,
 
  VLCB_OPC_LONG_EVENT_ACCESSORY_ON = 144,
 
  VLCB_OPC_LONG_EVENT_ACCESSORY_OFF = 145,
 
  VLCB_OPC_QUERY_LONG_EVENT_ACCESSORY_STATE = 146,
 
  VLCB_OPC_LONG_EVENT_ACCESSORY_STATE_ON = 147,
 
  VLCB_OPC_LONG_EVENT_ACCESSORY_STATE_OFF = 148,
 
  VLCB_OPC_FORGET_LEARNED_EVENT = 149,
 
  VLCB_OPC_LEGACY_SET_NODE_VARIABLE = 150,
 
  VLCB_OPC_NODE_VARIABLE_VALUE = 151,
 
  VLCB_OPC_SHORT_EVENT_ACCESSORY_ON = 152,
 
  VLCB_OPC_SHORT_EVENT_ACCESSORY_OFF = 153,
 
  VLCB_OPC_QUERY_SHORT_EVENT_ACCESSORY_STATE = 154,
 
  VLCB_OPC_NODE_PARAMETER_VALUE = 155,
 
  VLCB_OPC_QUERY_EVENT_VARIABLE = 156,
 
  VLCB_OPC_SHORT_EVENT_ACCESSORY_STATE_ON = 157,
 
  VLCB_OPC_SHORT_EVENT_ACCESSORY_STATE_OFF = 158,
 
  VLCB_OPC_EXT_OP_CODE3 = 159,
 
  VLCB_OPC_DCC_SEND_RAW_PACKET4 = 160,
 
  VLCB_OPC_DCC_WRITE_CV_IN_SERVICE_MODE = 162,
 
  VLCB_OPC_HEARTBEAT = 171,
 
  VLCB_OPC_SERVICE_DISCOVERY_RESPONSE = 172,
 
  VLCB_OPC_GENERIC_RESPONSE = 175,
 
  VLCB_OPC_LONG_EVENT_ACCESSORY_ON1 = 176,
 
  VLCB_OPC_LONG_EVENT_ACCESSORY_OFF1 = 177,
 
  VLCB_OPC_QUERY_EVENT_VARIABLE_BY_IDEX = 178,
 
  VLCB_OPC_LONG_EVENT_ACCESSORY_STATE_ON1 = 179,
 
  VLCB_OPC_LONG_EVENT_ACCESSORY_STATE_OFF1 = 180,
 
  VLCB_OPC_EVENT_VARIABLE_VALUE = 181,
 
  VLCB_OPC_NODE_INFO = 182,
 
  VLCB_OPC_SHORT_EVENT_ACCESSORY_ON1 = 184,
 
  VLCB_OPC_SHORT_EVENT_ACCESSORY_OFF1 = 185,
 
  VLCB_OPC_SHORT_EVENT_ACCESSORY_STATE_ON1 = 189,
 
  VLCB_OPC_SHORT_EVENT_ACCESSORY_STATE_OFF1 = 190,
 
  VLCB_OPC_EXT_OP_CODE4 = 191,
 
  VLCB_OPC_DCC_SEND_RAW_PACKET5 = 192,
 
  VLCB_OPC_DCC_WRITE_CV_BYTE_IN_OPS_MODE_BY_ADDRESS = 193,
 
  VLCB_OPC_DCC_SEND_DATA_TO_CAB = 194,
 
  VLCB_OPC_DIAGNOSTIC_DATA = 199,
 
  VLCB_OPC_FAST_CLOCK = 207,
 
  VLCB_OPC_LONG_EVENT_ACCESSORY_ON2 = 208,
 
  VLCB_OPC_LONG_EVENT_ACCESSORY_OFF2 = 209,
 
  VLCB_OPC_TEACH_EVENT = 210,
 
  VLCB_OPC_EVENT_VARIABLE_VALUE_IN_LEARN_MODE = 211,
 
  VLCB_OPC_LONG_EVENT_ACCESSORY_STATE_ON2 = 212,
 
  VLCB_OPC_LONG_EVENT_ACCESSORY_STATE_OFF2 = 213,
 
  VLCB_OPC_SHORT_EVENT_ACCESSORY_ON2 = 216,
 
  VLCB_OPC_SHORT_EVENT_ACCESSORY_OFF2 = 217,
 
  VLCB_OPC_SHORT_EVENT_ACCESSORY_STATE_ON2 = 221,
 
  VLCB_OPC_SHORT_EVENT_ACCESSORY_STATE_OFF2 = 222,
 
  VLCB_OPC_EXT_OP_CODE5 = 223,
 
  VLCB_OPC_DCC_SEND_RAW_PACKET6 = 224,
 
  VLCB_OPC_DCC_LOCO_REPORT = 225,
 
  VLCB_OPC_MODULE_NAME = 226,
 
  VLCB_OPC_DCC_COMMAND_STATION_STATUS = 227,
 
  VLCB_OPC_EVENT_ACK = 230,
 
  VLCB_OPC_EXTENDED_SERVICE_DISCOVERY_RESPONSE = 231,
 
  VLCB_OPC_STREAM_PACKET = 233,
 
  VLCB_OPC_NODE_PARAMETERS_REPORT = 239,
 
  VLCB_OPC_LONG_EVENT_ACCESSORY_ON3 = 240,
 
  VLCB_OPC_LONG_EVENT_ACCESSORY_OFF3 = 241,
 
  VLCB_OPC_LEARNED_EVENT_RESPONSE = 242,
 
  VLCB_OPC_LONG_EVENT_ACCESSORY_STATE_ON3 = 243,
 
  VLCB_OPC_LONG_EVENT_ACCESSORY_STATE_OFF3 = 244,
 
  VLCB_OPC_TEACH_EVENT_BY_INDEX = 245,
 
  VLCB_OPC_DATA_EVENT_ACCESSORY = 246,
 
  VLCB_OPC_NODE_DATA_EVENT_RESPONSE = 247,
 
  VLCB_OPC_SHORT_EVENT_ACCESSORY_ON3 = 248,
 
  VLCB_OPC_SHORT_EVENT_ACCESSORY_OFF3 = 249,
 
  VLCB_OPC_DEVICE_DATA_EVENT_SHORT_MODE = 250,
 
  VLCB_OPC_DEVICE_DATA_RESPONSE_SHORT_MODE = 251,
 
  VLCB_OPC_WRITE_DATA = 252,
 
  VLCB_OPC_SHORT_EVENT_ACCESSORY_STATE_ON3 = 253,
 
  VLCB_OPC_SHORT_EVENT_ACCESSORY_STATE_OFF3 = 254,
 
  VLCB_OPC_EXT_OP_CODE6 = 255,
 
};