VLCB SDK
An opinionated SDK for VLCB protocol
Loading...
Searching...
No Matches
dcc.h File Reference
#include <stdint.h>
Include dependency graph for common/inc/vlcb/common/dcc.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs

typedef uint8_t VlcbDccSessionNr
 
typedef uint16_t VlcbDccDecoderAddr
 
typedef uint8_t VlcbDccConsistId
 
typedef uint8_t VlcbDccLocoState
 
typedef uint8_t VlcbDccLocoFunctionRange
 
typedef uint8_t VlcbDccSessionQueryMode
 
typedef uint8_t VlcbDccError
 

Enumerations

enum  VlcbDccLocoState { VLCB_DCC_LOCO_STATE_ACTIVE = 0 , VLCB_DCC_LOCO_STATE_CONSISTED = 1 , VLCB_DCC_LOCO_STATE_CONSIST_MASTER = 2 , VLCB_DCC_LOCO_STATE_INACTIVE = 4 }
 
enum  VlcbDccLocoFunctionRange {
  VLCB_DCC_LOCO_FUNC_RANGE_F0_F4 = 1 , VLCB_DCC_LOCLO_FUNC_RANGE_F5_F8 = 2 , VLCB_DCC_LOCLO_FUNC_RANGE_F9_F12 = 3 , VLCB_DCC_LOCLO_FUNC_RANGE_F13_F20 = 4 ,
  VLCB_DCC_LOCLO_FUNC_RANGE_F21_F28 = 5
}
 
enum  VlcbDccSessionQueryMode { VLCB_DCC_SESSION_QUERY_MODE_DEFAULT = 0x00 , VLCB_DCC_SESSION_QUERY_MODE_STEAL = 0x01 , VLCB_DCC_SESSION_QUERY_MODE_SHARE = 0x02 }
 
enum  VlcbDccError {
  VLCB_DCC_ERR_LOCO_STACK_IS_FULL = 1 , VLCB_DCC_ERR_LOCO_ADDRESS_IS_TAKEN = 2 , VLCB_DCC_ERR_SESSION_IS_NOT_PRESENT = 3 , VLCB_DCC_ERR_EMPTY_CONSIST = 4 ,
  VLCB_DCC_ERR_LOCO_WAS_NOT_FOUND = 5 , VLCB_DCC_ERR_RX_BUFFER_OVERFLOW = 6 , VLCB_DCC_ERR_INVALID_REQUEST = 7 , VLCB_DCC_ERR_SESSION_WAS_CANCELLED = 8
}
 

Typedef Documentation

◆ VlcbDccConsistId

typedef uint8_t VlcbDccConsistId

Definition at line 7 of file common/inc/vlcb/common/dcc.h.

◆ VlcbDccDecoderAddr

typedef uint16_t VlcbDccDecoderAddr

Definition at line 6 of file common/inc/vlcb/common/dcc.h.

◆ VlcbDccError

typedef uint8_t VlcbDccError

Error codes for ERR message

Definition at line 36 of file common/inc/vlcb/common/dcc.h.

◆ VlcbDccLocoFunctionRange

typedef uint8_t VlcbDccLocoFunctionRange

Definition at line 17 of file common/inc/vlcb/common/dcc.h.

◆ VlcbDccLocoState

typedef uint8_t VlcbDccLocoState

Definition at line 9 of file common/inc/vlcb/common/dcc.h.

◆ VlcbDccSessionNr

typedef uint8_t VlcbDccSessionNr

Definition at line 5 of file common/inc/vlcb/common/dcc.h.

◆ VlcbDccSessionQueryMode

typedef uint8_t VlcbDccSessionQueryMode

Definition at line 26 of file common/inc/vlcb/common/dcc.h.

Enumeration Type Documentation

◆ VlcbDccError

Enumerator
VLCB_DCC_ERR_LOCO_STACK_IS_FULL 
VLCB_DCC_ERR_LOCO_ADDRESS_IS_TAKEN 
VLCB_DCC_ERR_SESSION_IS_NOT_PRESENT 
VLCB_DCC_ERR_EMPTY_CONSIST 
VLCB_DCC_ERR_LOCO_WAS_NOT_FOUND 
VLCB_DCC_ERR_RX_BUFFER_OVERFLOW 
VLCB_DCC_ERR_INVALID_REQUEST 
VLCB_DCC_ERR_SESSION_WAS_CANCELLED 

Definition at line 37 of file common/inc/vlcb/common/dcc.h.

◆ VlcbDccLocoFunctionRange

Enumerator
VLCB_DCC_LOCO_FUNC_RANGE_F0_F4 
VLCB_DCC_LOCLO_FUNC_RANGE_F5_F8 
VLCB_DCC_LOCLO_FUNC_RANGE_F9_F12 
VLCB_DCC_LOCLO_FUNC_RANGE_F13_F20 
VLCB_DCC_LOCLO_FUNC_RANGE_F21_F28 

Definition at line 18 of file common/inc/vlcb/common/dcc.h.

◆ VlcbDccLocoState

Enumerator
VLCB_DCC_LOCO_STATE_ACTIVE 
VLCB_DCC_LOCO_STATE_CONSISTED 
VLCB_DCC_LOCO_STATE_CONSIST_MASTER 
VLCB_DCC_LOCO_STATE_INACTIVE 

Definition at line 10 of file common/inc/vlcb/common/dcc.h.

◆ VlcbDccSessionQueryMode

Enumerator
VLCB_DCC_SESSION_QUERY_MODE_DEFAULT 
VLCB_DCC_SESSION_QUERY_MODE_STEAL 
VLCB_DCC_SESSION_QUERY_MODE_SHARE 

Definition at line 27 of file common/inc/vlcb/common/dcc.h.