vlcbdefs.hpp

Go to the documentation of this file.

/* DO NOT EDIT THIS FILE.
 * This file is automatically generated by ./generate_cpp.sh from vlcb-defs.csv
 */
#ifndef __VLCBDEFS
#define __VLCBDEFS
 
#ifdef __cplusplus
extern "C" {
#endif
 
//    Copyright (C) Sven Rosvall (sven@rosvall.ie)
//    This file is part of VLCB-Arduino project on https://github.com/SvenRosvall/VLCB-Arduino
//    Licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
//    The full licence can be found at: http://creativecommons.org/licenses/by-nc-sa/4.0/
enum VlcbManufacturer : unsigned char
{
  // Manufacturer definitions
  // Where the manufacturer already has an NMRA code, this is used
  // 
  MANU_DEV = 13, // For new manufacturer development - who don't have a manufacturer id yet
  MANU_MERG = 165, // https://www.merg.co.uk
  MANU_SPROG = 44, // https://www.sprog-dcc.co.uk/
  MANU_ROCRAIL = 70, // http://www.rocrail.net
  MANU_SPECTRUM = 80, // http://animatedmodeler.com  (Spectrum Engineering)
  MANU_SYSPIXIE = 249, // Konrad Orlowski
  MANU_RME = 248, // http://rmeuk.com  (Railway Modelling Experts Limited)
};
 
enum VlcbMergModuleTypes : unsigned char
{
  // 
  // MODULE TYPES
  // 
  // Please note that the existence of a module type id does not necessarily mean that firmware has been implemented
  // 
  // MERG Module types
  // 
  MTYP_SLIM = 0, // default for SLiM nodes
  MTYP_CANACC4 = 1, // Solenoid point driver
  MTYP_CANACC5 = 2, // Motorised point driver
  MTYP_CANACC8 = 3, // 8 digital outputs
  MTYP_CANACE3 = 4, // Control panel switch/button encoder
  MTYP_CANACE8C = 5, // 8 digital inputs
  MTYP_CANLED = 6, // 64 led driver
  MTYP_CANLED64 = 7, // 64 led driver (multi leds per event)
  MTYP_CANACC4_2 = 8, // 12v version of CANACC4
  MTYP_CANCAB = 9, // CANCAB hand throttle
  MTYP_CANCMD = 10, // CANCMD command station
  MTYP_CANSERVO = 11, // 8 servo driver (on canacc8 or similar hardware)
  MTYP_CANBC = 12, // BC1a command station
  MTYP_CANRPI = 13, // RPI and RFID interface
  MTYP_CANTTCA = 14, // Turntable controller (turntable end)
  MTYP_CANTTCB = 15, // Turntable controller (control panel end)
  MTYP_CANHS = 16, // Handset controller for old BC1a type handsets
  MTYP_CANTOTI = 17, // Track occupancy detector
  MTYP_CAN8I8O = 18, // 8 inputs 8 outputs
  MTYP_CANSERVO8C = 19, // Canservo with servo position feedback
  MTYP_CANRFID = 20, // RFID input
  MTYP_CANTC4 = 21,
  MTYP_CANACE16C = 22, // 16 inputs
  MTYP_CANIO8 = 23, // 8 way I/O
  MTYP_CANSNDX = 24, // ??
  MTYP_CANEther = 25, // Ethernet interface
  MTYP_CANSIG64 = 26, // Multiple aspect signalling for CANLED module
  MTYP_CANSIG8 = 27, // Multiple aspect signalling for CANACC8 module
  MTYP_CANCOND8C = 28, // Conditional event generation
  MTYP_CANPAN = 29, // Control panel 32/32
  MTYP_CANACE3C = 30, // Newer version of CANACE3 firmware
  MTYP_CANPanel = 31, // Control panel 64/64
  MTYP_CANMIO = 32, // Multiple I/O – Universal CANMIO firmware
  MTYP_CANACE8MIO = 33, // Multiple IO module 16 inputs emulating CANACE8C on CANMIO hardware
  MTYP_CANSOL = 34, // Solenoid driver module
  MTYP_CANBIP = 35, // Universal CANBIP firmware - Bipolar IO module with additional 8 I/O pins (CANMIO family)
  MTYP_CANCDU = 36, // Solenoid driver module with additional 6 I/O pins (CANMIO family)
  MTYP_CANACC4CDU = 37, // CANACC4 firmware ported to CANCDU
  MTYP_CANWiBase = 38, // CAN to MiWi base station
  MTYP_WiCAB = 39, // Wireless cab using MiWi protocol
  MTYP_CANWiFi = 40, // CAN to WiFi connection with Withrottle to CBUS protocol conversion
  MTYP_CANFTT = 41, // Turntable controller configured using FLiM
  MTYP_CANHNDST = 42, // Handset (alternative to CANCAB)
  MTYP_CANTCHNDST = 43, // Touchscreen handset
  MTYP_CANRFID8 = 44, // multi-channel RFID reader
  MTYP_CANmchRFID = 45, // either a 2ch or 8ch RFID reader
  MTYP_CANPiWi = 46, // a Raspberry Pi based module for WiFi
  MTYP_CAN4DC = 47, // DC train controller
  MTYP_CANELEV = 48, // Nelevator controller
  MTYP_CANSCAN = 49, // 128 switch inputs
  MTYP_CANMIO_SVO = 50, // 16MHz 25k80 version of CANSERVO8c on CANMIO hardware
  MTYP_CANMIO_INP = 51, // 16MHz 25k80 version of CANACE8MIO on CANMIO hardware
  MTYP_CANMIO_OUT = 52, // 16MHz 25k80 version of CANACC8 on CANMIO hardware
  MTYP_CANBIP_OUT = 53, // 16MHz 25k80 version of CANACC5 on CANBIP hardware
  MTYP_CANASTOP = 54, // DCC stop generator
  MTYP_CANCSB = 55, // CANCMD with on board 3A booster
  MTYP_CANMAG = 56, // Magnet on Track detector
  MTYP_CANACE16CMIO = 57, // 16 input equivaent to CANACE8C
  MTYP_CANPiNODE = 58, // CBUS module based on Raspberry Pi
  MTYP_CANDISP = 59, // 25K80 version of CANLED64 (IHart and MB)
  MTYP_CANCOMPUTE = 60, // Compute Event processing engine
  MTYP_CANRC522 = 61, // Read/Write from/to RC522 RFID tags
  MTYP_CANINP = 62, // 8 inputs module (2g version of CANACE8c) (Pete Brownlow)
  MTYP_CANOUT = 63, // 8 outputs module (2g version of CANACC8) (Pete Brownlow)
  MTYP_CANXIO = 64, // Extended CANMIO (24 I/O ports) (Pete Brownlow)
  MTYP_CANCABDC = 65, // DC cab
  MTYP_CANRCOM = 66, // DC Railcom detector/reader
  MTYP_CANMP3 = 67, // MP3 sound player in response to events (eg: station announcements) (Duncan Greenwood)
  MTYP_CANXMAS = 68, // Addressed RGB LED driver (Duncan Greenwood)
  MTYP_CANSVOSET = 69, // Servo setting box (Duncan Greenwood)
  MTYP_CANCMDDC = 70, // DC Command station
  MTYP_CANTEXT = 71, // Text message display
  MTYP_CANASIGNAL = 72, // Signal controller
  MTYP_CANSLIDER = 73, // DCC cab with slider control (Dave Radcliffe)
  MTYP_CANDCATC = 74, // DC ATC module (Dave Harris)
  MTYP_CANGATE = 75, // Logic module using and/or gates (Phil Silver)
  MTYP_CANSINP = 76, // Q series PIC input module (Ian Hart)
  MTYP_CANSOUT = 77, // Q series PIC input module (Ian Hart)
  MTYP_CANSBIP = 78, // Q series PIC input module (Ian Hart)
  MTYP_CANBUFFER = 79, // Message buffer (Phil Silver)
  MTYP_CANLEVER = 80, // Lever frame module (Tim Coombs)
  MTYP_CANSHIELD = 81, // Kit 110 Arduino shield test firmware
  MTYP_CAN4IN4OUT = 82, // 4 inputs 4 outputs (Arduino module)
  MTYP_CANCMDB = 83, // CANCMD with built in booster (Simon West)
  MTYP_CANPIXEL = 84, // neopixel driver (Jon Denham)
  MTYP_CANCABPE = 85, // Cab2 with pot or encoder (Simon West hardware, Jon Denham new C firmware)
  MTYP_CANSMARTTD = 86, // Smart train detector (Michael Smith)
  MTYP_CANARGB = 87, // Addressable LEDs (Ian Hogg)
  MTYP_CANCDU_U = 88, // CANCDU (universal) 
  MTYP_VLCB = 0xFC, // VLCB modules use the same manufacturer IDs as CBUS modules.
  // 
  // At the time of writing the list of defined MERG module types is maintained by Pete Brownlow software@upsys.co.uk
  // Please liaise with Pete before adding new module types, 
  // and/or create your own GitHub branch, add your proposed new module type(s) and then create a Pull Request
  // 
  MTYP_CAN_SW = 0xFF, // Software nodes
  MTYP_EMPTY = 0xFE, // Empty module, bootloader only
  MTYP_CANUSB = 0xFD, // USB interface
  MTYP_CANDEV = 0xFC, // Module type for use by developers when developing something new
};
 
enum VlcbSprogModuleTypes : unsigned char
{
  // 
  // Sprog Module types
  // 
  MTYP_CANPiSPRG3 = 1, // Pi-SPROG 3 programmer/command station
  MTYP_CANSPROG3P = 2, // SPROG 3 Plus programmer/command station
  MTYP_CANSPROG = 3, // CAN SPROG programmer/command station
  MTYP_CANSBOOST = 4, // System Booster
  MTYP_CANPiSPRGP = 5, // Pi-SPROG 3 Plus programmer/command station
  MTYP_CANSOLNOID  = 8, // 8-channel (4-pairs) Solenoid I/O module
  MTYP_CANSERVOIO = 50, // 8-channel Servo I/O module
  MTYP_CANISB = 100, // CAN ISB Isolated CAN USB Interface
  MTYP_CANSOLIO  = 101, // 8-channel (4-pairs) Solenoid I/O module
};
 
enum VlcbRocRailModuleTypes : unsigned char
{
  // 
  // Rocrail Module types
  // 
  MTYP_CANGC1 = 1, // RS232 PC interface
  MTYP_CANGC2 = 2, // 16 I/O
  MTYP_CANGC3 = 3, // Command station (derived from cancmd)
  MTYP_CANGC4 = 4, // 8 channel RFID reader
  MTYP_CANGC5 = 5, // Cab for fixed panels (derived from cancab)
  MTYP_CANGC6 = 6, // 4 channel servo controller
  MTYP_CANGC7 = 7, // Fast clock module
  MTYP_CANGC1e = 11, // CAN<->Ethernet interface
};
 
enum VlcbSpectrumModuleTypes : unsigned char
{
  // 
  // Spectrum Engineering Animated Modeller module types
  // 
  MTYP_AMCTRLR = 1, // Animation controller (firmware derived from cancmd)
  MTYP_DUALCAB = 2, // Dual cab based on cancab
};
 
enum VlcbSysPixieModuleTypes : unsigned char
{
  // 
  // SysPixie Module types (Konrad Orlowski)
  // 
  MTYP_CANPMSense = 1, // Motorised point motor driver with current sense
};
 
enum VlcbOpCodes : unsigned char
{
  // 
  // 
  // VLCB opcodes list
  // 
  // Packets with no data bytes
  // 
  OPC_ACK = 0x00, // General ack
  OPC_NAK = 0x01, // General nak
  OPC_HLT = 0x02, // Bus Halt
  OPC_BON = 0x03, // Bus on
  OPC_TOF = 0x04, // Track off
  OPC_TON = 0x05, // Track on
  OPC_ESTOP = 0x06, // Track stopped
  OPC_ARST = 0x07, // System reset
  OPC_RTOF = 0x08, // Request track off
  OPC_RTON = 0x09, // Request track on
  OPC_RESTP = 0x0a, // Request emergency stop all
  OPC_RSTAT = 0x0c, // Request node status
  OPC_QNN = 0x0d, // Query nodes
  // 
  OPC_RQNP = 0x10, // Read node parameters
  OPC_RQMN = 0x11, // Request name of module type
  // 
  // Packets with 1 data byte
  // 
  OPC_KLOC = 0x21, // Release engine by handle
  OPC_QLOC = 0x22, // Query engine by handle
  OPC_DKEEP = 0x23, // Keep alive for cab
  // 
  OPC_DBG1 = 0x30, // Debug message with 1 status byte
  OPC_EXTC = 0x3F, // Extended opcode
  // 
  // Packets with 2 data bytes
  // 
  OPC_RLOC = 0x40, // Request session for loco
  OPC_QCON = 0x41, // Query consist
  OPC_SNN = 0x42, // Set node number
  OPC_ALOC = 0X43, // Allocate loco (used to allocate to a shuttle in cancmd)
  // 
  OPC_STMOD = 0x44, // Set Throttle mode
  OPC_PCON = 0x45, // Consist loco
  OPC_KCON = 0x46, // De-consist loco
  OPC_DSPD = 0x47, // Loco speed/dir
  OPC_DFLG = 0x48, // Set engine flags
  OPC_DFNON = 0x49, // Loco function on
  OPC_DFNOF = 0x4A, // Loco function off
  OPC_SSTAT = 0x4C, // Service mode status
  OPC_NNRSM = 0x4F, // Reset to manufacturer's defaults
  // 
  OPC_RQNN = 0x50, // Request Node number in setup mode
  OPC_NNREL = 0x51, // Node number release
  OPC_NNACK = 0x52, // Node number acknowledge
  OPC_NNLRN = 0x53, // Set learn mode
  OPC_NNULN = 0x54, // Release learn mode
  OPC_NNCLR = 0x55, // Clear all events
  OPC_NNEVN = 0x56, // Read available event slots
  OPC_NERD = 0x57, // Read all stored events
  OPC_RQEVN = 0x58, // Read number of stored events
  OPC_WRACK = 0x59, // Write acknowledge
  OPC_RQDAT = 0x5A, // Request node data event
  OPC_RQDDS = 0x5B, // Request short data frame
  OPC_BOOT = 0x5C, // Put node into boot mode
  OPC_ENUM = 0x5D, // Force can_id self enumeration
  OPC_NNRST = 0x5E, // Reset node (as in restart)
  OPC_EXTC1 = 0x5F, // Extended opcode with 1 data byte
  // 
  // Packets with 3 data bytes
  // 
  OPC_DFUN = 0x60, // Set engine functions
  OPC_GLOC = 0x61, // Get loco (with support for steal/share)
  OPC_ERR = 0x63, // Command station error
  OPC_CMDERR = 0x6F, // Errors from nodes during config
  // 
  OPC_EVNLF = 0x70, // Event slots left response
  OPC_NVRD = 0x71, // Request read of node variable
  OPC_NENRD = 0x72, // Request read stored event by index
  OPC_RQNPN = 0x73, // Request read module parameters
  OPC_NUMEV = 0x74, // Number of events stored response
  OPC_CANID = 0x75, // Set canid
  OPC_MODE = 0x76, // Set mode
  OPC_RQSD = 0x78, // Request service discovery
  OPC_EXTC2 = 0x7F, // Extended opcode with 2 data bytes
  // 
  // Packets with 4 data bytes
  // 
  OPC_RDCC3 = 0x80, // 3 byte DCC packet
  OPC_WCVO = 0x82, // Write CV byte Ops mode by handle
  OPC_WCVB = 0x83, // Write CV bit Ops mode by handle
  OPC_QCVS = 0x84, // Read CV
  OPC_PCVS = 0x85, // Report CV
  OPC_RDGN = 0x87, // Request diagnostics
  OPC_NVSETRD = 0x8E, // Set NV with Read
  // 
  OPC_ACON = 0x90, // on event
  OPC_ACOF = 0x91, // off event
  OPC_AREQ = 0x92, // Accessory Request event
  OPC_ARON = 0x93, // Accessory response event on
  OPC_AROF = 0x94, // Accessory response event off
  OPC_EVULN = 0x95, // Unlearn event
  OPC_NVSET = 0x96, // Set a node variable
  OPC_NVANS = 0x97, // Node variable value response
  OPC_ASON = 0x98, // Short event on
  OPC_ASOF = 0x99, // Short event off
  OPC_ASRQ = 0x9A, // Short Request event
  OPC_PARAN = 0x9B, // Single node parameter response
  OPC_REVAL = 0x9C, // Request read of event variable
  OPC_ARSON = 0x9D, // Accessory short response on event
  OPC_ARSOF = 0x9E, // Accessory short response off event
  OPC_EXTC3 = 0x9F, // Extended opcode with 3 data bytes
  // 
  // Packets with 5 data bytes
  // 
  OPC_RDCC4 = 0xA0, // 4 byte DCC packet
  OPC_WCVS = 0xA2, // Write CV service mode
  OPC_HEARTB = 0xAB, // Heartbeat
  OPC_SD = 0xAC, // Service discovery response
  OPC_GRSP = 0xAF, // General response
  // 
  OPC_ACON1 = 0xB0, // On event with one data byte
  OPC_ACOF1 = 0xB1, // Off event with one data byte
  OPC_REQEV = 0xB2, // Read event variable in learn mode
  OPC_ARON1 = 0xB3, // Accessory on response (1 data byte)
  OPC_AROF1 = 0xB4, // Accessory off response (1 data byte)
  OPC_NEVAL = 0xB5, // Event variable by index read response
  OPC_PNN = 0xB6, // Response to QNN
  OPC_ASON1 = 0xB8, // Accessory short on with 1 data byte
  OPC_ASOF1 = 0xB9, // Accessory short off with 1 data byte
  OPC_ARSON1 = 0xBD, // Short response event on with one data byte
  OPC_ARSOF1 = 0xBE, // Short response event off with one data byte
  OPC_EXTC4 = 0xBF, // Extended opcode with 4 data bytes
  // 
  // Packets with 6 data bytes
  // 
  OPC_RDCC5 = 0xC0, // 5 byte DCC packet
  OPC_WCVOA = 0xC1, // Write CV ops mode by address
  OPC_CABDAT = 0xC2, // Cab data (cab signalling)
  OPC_DGN = 0xC7, // Diagnostics
  OPC_FCLK = 0xCF, // Fast clock
  // 
  OPC_ACON2 = 0xD0, // On event with two data bytes
  OPC_ACOF2 = 0xD1, // Off event with two data bytes
  OPC_EVLRN = 0xd2, // Teach event
  OPC_EVANS = 0xd3, // Event variable read response in learn mode
  OPC_ARON2 = 0xD4, // Accessory on response
  OPC_AROF2 = 0xD5, // Accessory off response
  OPC_ASON2 = 0xD8, // Accessory short on with 2 data bytes
  OPC_ASOF2 = 0xD9, // Accessory short off with 2 data bytes
  OPC_ARSON2 = 0xDD, // Short response event on with two data bytes
  OPC_ARSOF2 = 0xDE, // Short response event off with two data bytes
  OPC_EXTC5 = 0xDF, // Extended opcode with 5 data bytes
  // 
  // Packets with 7 data bytes
  // 
  OPC_RDCC6 = 0xE0, // 6 byte DCC packets
  OPC_PLOC = 0xE1, // Loco session report
  OPC_NAME = 0xE2, // Module name response
  OPC_STAT = 0xE3, // Command station status report
  OPC_ENACK = 0xE6, // Event Acknowledge
  OPC_ESD = 0xE7, // Extended service discovery
  OPC_DTXC = 0xE9, // Long message packet
  OPC_PARAMS = 0xEF, // Node parameters response
  // 
  OPC_ACON3 = 0xF0, // On event with 3 data bytes
  OPC_ACOF3 = 0xF1, // Off event with 3 data bytes
  OPC_ENRSP = 0xF2, // Read node events response
  OPC_ARON3 = 0xF3, // Accessory on response
  OPC_AROF3 = 0xF4, // Accessory off response
  OPC_EVLRNI = 0xF5, // Teach event using event indexing
  OPC_ACDAT = 0xF6, // Accessory data event: 5 bytes of node data (eg: RFID)
  OPC_ARDAT = 0xF7, // Accessory data response
  OPC_ASON3 = 0xF8, // Accessory short on with 3 data bytes
  OPC_ASOF3 = 0xF9, // Accessory short off with 3 data bytes
  OPC_DDES = 0xFA, // Short data frame aka device data event (device id plus 5 data bytes)
  OPC_DDRS = 0xFB, // Short data frame response aka device data response
  OPC_DDWS = 0xFC, // Device Data Write Short
  OPC_ARSON3 = 0xFD, // Short response event on with 3 data bytes
  OPC_ARSOF3 = 0xFE, // Short response event off with 3 data bytes
  OPC_EXTC6 = 0xFF, // Extended opcode with 6 data byes
  // 
  // Opcodes that are proposed and/or agreed but not yet in the current published specification
  // 
  OPC_VCVS = 0xA4, // Verify CV service mode - used for CV read hints
};
 
enum VlcbStmodModes : unsigned char
{
  // 
  // 
  // Modes for STMOD
  // 
  TMOD_SPD_MASK = 3,
  TMOD_SPD_128 = 0,
  TMOD_SPD_14 = 1,
  TMOD_SPD_28I = 2,
  TMOD_SPD_28 = 3,
};
 
enum VlcbErrs : unsigned char
{
  // 
  // Error codes for OPC_ERR
  // 
  ERR_LOCO_STACK_FULL = 1,
  ERR_LOCO_ADDR_TAKEN = 2,
  ERR_SESSION_NOT_PRESENT = 3,
  ERR_CONSIST_EMPTY = 4,
  ERR_LOCO_NOT_FOUND = 5,
  ERR_CMD_RX_BUF_OFLOW = 6,
  ERR_INVALID_REQUEST = 7,
  ERR_SESSION_CANCELLED = 8,
};
 
enum VlcbSStats : unsigned char
{
  // 
  // Status codes for OPC_SSTAT
  // 
  SSTAT_NO_ACK = 1,
  SSTAT_OVLD = 2,
  SSTAT_WR_ACK = 3,
  SSTAT_BUSY = 4,
  SSTAT_CV_ERROR = 5,
};
 
enum VlcbCmdErrs : unsigned char
{
  // 
  // Error codes for OPC_CMDERR
  // 
  CMDERR_INV_CMD = 1, // Invalid command
  CMDERR_NOT_LRN = 2, // Not in learn mode
  CMDERR_NOT_SETUP = 3, // Not in setup mode
  CMDERR_TOO_MANY_EVENTS = 4, // Too many events
  CMDERR_NO_EV = 5, // No EV
  CMDERR_INV_EV_IDX = 6, // Invalid EV index
  CMDERR_INVALID_EVENT = 7, // Invalid event
  CMDERR_INV_EN_IDX = 8, // now reserved
  CMDERR_INV_PARAM_IDX = 9, // Invalid param index
  CMDERR_INV_NV_IDX = 10, // Invalid NV index
  CMDERR_INV_EV_VALUE = 11, // Invalid EV value
  CMDERR_INV_NV_VALUE = 12, // Invalid NV value
  // 
  // Additional error codes proposed and/or agreed but not yet in the current published specification
  // 
  CMDERR_LRN_OTHER = 13, // Sent when module in learn mode sees NNLRN for different module (also exits learn mode) 
  // 
};
 
enum VlcbGrspCodes : unsigned char
{
  // 
  // GRSP codes
  // 
  GRSP_OK = 0, // Success
  GRSP_UNKNOWN_NVM_TYPE = 254, // Unknown non volatile memory type
  GRSP_INVALID_DIAGNOSTIC = 253, // Invalid diagnostic
  GRSP_INVALID_SERVICE = 252, // Invalid service
  GRSP_INVALID_COMMAND_PARAMETER = 251, // Invalid parameter in command
  GRSP_INVALID_MODE = 250, // Invalid Mode
};
 
enum VlcbCabSigAspect0 : unsigned char
{
  // 
  // Sub opcodes for OPC_CABDAT
  // 
  CDAT_CABSIG = 1,
};
 
enum VlcbCabSigAspect1 : unsigned char
{
  // 
  // Aspect codes for CDAT_CABSIG
  // 
  // First aspect byte
  // 
  SASP_DANGER = 0,
  SASP_CAUTION = 1,
  SASP_PRELIM_CAUTION = 2,
  SASP_PROCEED = 3,
  SASP_CALLON = 4, // Set bit 2 for call-on - main aspect will usually be at danger
  SASP_THEATRE = 8, // Set bit 3 to 0 for upper nibble is feather lcoation, set 1 for upper nibble is theatre code
};
 
enum VlcbCabSigAspect2 : unsigned char
{
  // 
  // Aspect codes for CDAT_CABSIG
  // 
  // Second Aspect byte
  // 
  SASP_LIT = 0, // Set bit 0 to indicate lit
  SASP_LUNAR = 1, // Set bit 1 for lunar indication
  // 
  // Remaining bits in second aspect byte yet to be defined - can be used for other signalling systems
};
 
enum VlcbServiceTypes : unsigned char
{
  // 
  // VLCB Service Types
  // 
  SERVICE_ID_NONE = 0, // Not a real service. Will not be shown in list of services requested by RQSD.
  SERVICE_ID_MNS = 1, // The minimum node service. All modules must implement this.
  SERVICE_ID_NV = 2, // The NV service.
  SERVICE_ID_CAN = 3, // CAN service. Deals with CANID enumeration.
  SERVICE_ID_OLD_TEACH = 4, // Old (CBUS) event teaching service.
  SERVICE_ID_PRODUCER = 5, // Event producer service.
  SERVICE_ID_CONSUMER = 6, // Event comsumer service.
  SERVICE_ID_TEACH = 7, // New event teaching service.
  SERVICE_ID_CONSUME_OWN_EVENTS = 8, // Consume own events service.
  SERVICE_ID_EVENTACK = 9, // Event acknowledge service. Useful for debugging event configuration.
  SERVICE_ID_BOOT = 10, // FCU/PIC bootloader service.
  SERVICE_ID_STREAMING = 17, // Streaming (Long Messages) service.
  // Use IDs 240 and higher for services in development that do not yet have a service specification.
};
 
enum VlcbParams : unsigned char
{
  // 
  // 
  // Parameter index numbers (readable by OPC_RQNPN, returned in OPC_PARAN)
  // Index numbers count from 1, subtract 1 for offset into parameter block
  // Note that RQNPN with index 0 returns the parameter count
  // 
  PAR_NUM = 0, // Number of parameters
  PAR_MANU = 1, // Manufacturer id
  PAR_MINVER = 2, // Minor version letter
  PAR_MTYP = 3, // Module type code
  PAR_EVTNUM = 4, // Number of events supported
  PAR_EVNUM = 5, // Event variables per event
  PAR_NVNUM = 6, // Number of Node variables
  PAR_MAJVER = 7, // Major version number
  PAR_FLAGS = 8, // Node flags
  PAR_CPUID = 9, // Processor type
  PAR_BUSTYPE = 10, // Bus type
  PAR_LOAD = 11, // load address, 4 bytes
  PAR_CPUMID = 15, // CPU manufacturer's id as read from the chip config space, 4 bytes (note - read from cpu at runtime, so not included in checksum)
  PAR_CPUMAN = 19, // CPU manufacturer code
  PAR_BETA = 20, // Beta revision (numeric), or 0 if release
};
 
enum VlcbParamOffsetsPic : unsigned char
{
  // 
  // Offsets to other values stored at the top of the parameter block.
  // These are not returned by opcode PARAN, but are present in the hex
  // file for FCU.
  // 
  PAR_COUNT = 0x18, // Number of parameters implemented
  PAR_NAME = 0x1A, // 4 byte Address of Module type name, up to 8 characters null terminated
  PAR_CKSUM = 0x1E, // Checksum word at end of parameters
};
 
enum VlcbParamFlags : unsigned char
{
  // 
  // Flags in PAR_FLAGS
  // 
  PF_NOEVENTS = 0, // Module doesn't support events
  PF_CONSUMER = 1, // Module is a consumer of events
  PF_PRODUCER = 2, // Module is a producer of events
  PF_COMBI = 3, // Module is both a consumer and producer of events
  PF_FLiM = 4, // Module is in FLiM (CBUS)
  PF_NORMAL = 4, // Module is in Normal mode (VLCB)
  PF_BOOT = 8, // Module supports the FCU bootloader protocol
  PF_COE = 16, // Module can consume its own events
  PF_LRN = 32, // Module is in learn mode
  PF_VLCB = 64, // Module is VLCB compatible
  PF_SD = 64, // Module supports Service Discovery (Deprecated in favour of PF_VLCB.)
};
 
enum VlcbModeParams : unsigned char
{
  // 
  // Parameters to the MODE op-code
  // 
  // Exclusive modes
  MODE_UNINITIALISED = 0xFF, // Uninitialised / factory settings
  MODE_SETUP = 0, // Set up mode
  MODE_NORMAL = 1, // Normal operation mode
  // Event Teaching Service modes
  MODE_LEARN_ON = 0x08, // Turn on learn mode
  MODE_LEARN_OFF = 0x09, // Turn off learn mode
  // Event Acknowledgment Service modes
  MODE_EVENT_ACK_ON = 0x0A, // Turn on event acknowledgements
  MODE_EVENT_ACK_OFF = 0x0B, // Turn off event acknowledgements
  // Minimum Node Service modes
  MODE_HEARTBEAT_ON = 0x0C, // Turn on heartbeat
  MODE_HEARTBEAT_OFF = 0x0D, // Turn off heartbeat
  // Boot modes
  MODE_BOOT = 0x0E, // PIC Boot loader mode
  // FCU Compatability
  MODE_FCUCOMPAT_ON = 0x10, // Turn on FCU compatibility
  MODE_FCUCOMPAT_OFF = 0x11, // Turn off FCU compatibility
};
 
enum VlcbBusTypes : unsigned char
{
  // 
  // BUS type that module is connected to
  // 
  PB_CAN = 1,
  PB_ETH = 2,
  PB_MIWI = 3,
  PB_USB = 4,
};
 
enum VlcbProcessorManufacturers : unsigned char
{
  // 
  // Processor manufacturer codes
  // 
  CPUM_MICROCHIP = 1,
  CPUM_ATMEL = 2,
  CPUM_ARM = 3,
};
 
enum VlcbMicrochipProcessors : unsigned char
{
  // 
  // Microchip Processor type codes (identifies to FCU for bootload compatibility)
  // 
  P18F2480 = 1,
  P18F4480 = 2,
  P18F2580 = 3,
  P18F4580 = 4,
  P18F2585 = 5,
  P18F4585 = 6,
  P18F2680 = 7,
  P18F4680 = 8,
  P18F2682 = 9,
  P18F4682 = 10,
  P18F2685 = 11,
  P18F4685 = 12,
  // 
  P18F25K80 = 13,
  P18F45K80 = 14,
  P18F26K80 = 15,
  P18F46K80 = 16,
  P18F65K80 = 17,
  P18F66K80 = 18,
  P18F25K83 = 19,
  P18F26K83 = 20,
  P18F27Q84 = 21,
  P18F47Q84 = 22,
  P18F27Q83 = 23,
  P18F14K22 = 25,
  // 
  P32MX534F064 = 30,
  P32MX564F064 = 31,
  P32MX564F128 = 32,
  P32MX575F256 = 33,
  P32MX575F512 = 34,
  P32MX764F128 = 35,
  P32MX775F256 = 36,
  P32MX775F512 = 37,
  P32MX795F512 = 38,
};
 
enum VlcbArmProcessors : unsigned char
{
  // 
  // ARM Processor type codes (identifies to FCU for bootload compatibility)
  // 
  ARM1176JZF_S = 1, // As used in Raspberry Pi
  ARMCortex_A7 = 2, // As Used in Raspberry Pi 2
  ARMCortex_A53 = 3, // As used in Raspberry Pi 3
};
 
enum VlcbCanHardware : unsigned char
{
  // 
  // CAN engine type codes
  // 
  CAN_HW_NOT_SPECIFIED = 0x00, // Not set
  CAN_HW_PIC_ECAN = 0x01, // MICROCHIP PIC ECAN
  CAN_HW_PIC_CAN_2_0 = 0x02, // MICROCHIP PIC CAN 2.0
  CAN_HW_PIC_CAN_FD = 0x03, // MICROCHIP PIC CAN FD
  CAN_HW_MCP2515 = 0x04, // MICROCHIP 2515
  CAN_HW_MCP2518 = 0x05, // MICROCHIP 2518
  CAN_HW_ESP32_TWAI = 0x06, // ESP32 Two Wire Automotive Interface
  CAN_HW_SAM3X8E = 0x07, // Atmel Cortex M3
  CAN_HW_RP2040_PIO = 0x08, // RP2040 using PIO
  CAN_HW_SERIAL = 0x09, // Serial using GridConnect
};
 
enum VlcbProducerEvUsage : unsigned char
{
  // 
  // Producer service EV usage
  // 
  PRODUCER_EV_NOT_SPECIFIED = 0x00, // Not specified
  PRODUCER_EV_HAPPENING = 0x01, // Happenings
  PRODUCER_EV_SLOTS = 0x02, // Slots
};
 
enum VlcbConsumerEvUsage : unsigned char
{
  // 
  // Consumer service EV usage
  // 
  CONSUMER_EV_NOT_SPECIFIED = 0x00, // Not specified
  CONSUMER_EV_ACTIONS = 0x01, // Actions
  CONSUMER_EV_SLOTS = 0x02, // Slots
};
 
enum VlcbBootloaderType : unsigned char
{
  // 
  // Boot service reports of the module bootloader type
  // 
  BL_TYPE_Unknown = 0, // Unknown or not specified
  BL_TYPE_MikeBolton = 1, // Original bootloader from Mike Bolton, Roger Healey, Pete Brownlow and others written in PIC assembler
  BL_TYPE_KonradOrlowski = 2, //  Konrad (syspixie) bootloader written in XC8
  BL_TYPE_IanHogg = 3, //  Ian Hogg bootloader written in XC8
};
 
enum VlcbCANID : unsigned char
{
  // 
  // CANIDs allocated as fixed values
  // Note that all new modules, or new firmware for existing modules, should obtain a CANID using self enumeration and implement
  // automatic CANID conflict resolution, so that eventually we can remove the need for fixed CANIDs
  // 
  CANID_CANCMD = 0x72, // (114) Fixed CANID for CANCMD or CANCSB
  CANID_CANUSB = 0x7C, // (124) Fixed CANID for CANUSB, although in current firmware it may just use the CANID from the sending software
  CANID_FCU = 0x7D, // (125) Default CANID used by FCU. Can be changed in settings. Note some interface modules may substitute their own CANID.
  CANID_JMRI = 0x7E, // (126) Default CANID used by JMRI. Can be changed in connection preferences. Note some interface modules may substitute their own CANID.
  CANID_CANEther = 0x7F, // (127) Default fixed CANID for CANEther (can be changed by modifying NV2). Note CANEther inserts its own CANID on all packets transmitted on CAN
};
 
#ifdef __cplusplus
}
#endif
 
#endif // __VLCBDEFS