CANpie FD
CAN programming interface environment - Version 3.08
All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Friends Macros Modules Pages
Enumerations
QCan Namespace Reference

Enumerations

enum  CAN_Bitrate_e {
  eCAN_BITRATE_NONE = -1,
  eCAN_BITRATE_10K = 0,
  eCAN_BITRATE_20K = 1,
  eCAN_BITRATE_50K = 2,
  eCAN_BITRATE_100K = 3,
  eCAN_BITRATE_125K = 4,
  eCAN_BITRATE_250K = 5,
  eCAN_BITRATE_500K = 6,
  eCAN_BITRATE_800K = 7,
  eCAN_BITRATE_1M = 8,
  eCAN_BITRATE_2M = 10,
  eCAN_BITRATE_4M = 11,
  eCAN_BITRATE_5M = 12,
  eCAN_BITRATE_AUTO = 9,
  eCAN_BITRATE_MAX = 9999
}
 
enum  CAN_Channel_e {
  eCAN_CHANNEL_NONE = 0,
  eCAN_CHANNEL_1,
  eCAN_CHANNEL_2,
  eCAN_CHANNEL_3,
  eCAN_CHANNEL_4,
  eCAN_CHANNEL_5,
  eCAN_CHANNEL_6,
  eCAN_CHANNEL_7,
  eCAN_CHANNEL_8
}
 
enum  CAN_Mode_e {
  eCAN_MODE_INIT = 0 ,
  eCAN_MODE_OPERATION = 1 ,
  eCAN_MODE_LISTEN_ONLY = 2,
  eCAN_MODE_SLEEP = 3,
  eCAN_MODE_SELF_TEST = 4
}
 
enum  CAN_State_e {
  eCAN_STATE_STOPPED = 0,
  eCAN_STATE_SLEEPING,
  eCAN_STATE_BUS_ACTIVE,
  eCAN_STATE_BUS_WARN,
  eCAN_STATE_BUS_PASSIVE,
  eCAN_STATE_BUS_OFF
}
 
enum  LogLevel_e {
  eLOG_LEVEL_OFF = 0,
  eLOG_LEVEL_FATAL,
  eLOG_LEVEL_ERROR,
  eLOG_LEVEL_WARN,
  eLOG_LEVEL_INFO,
  eLOG_LEVEL_DEBUG,
  eLOG_LEVEL_TRACE,
  eLOG_LEVEL_ALL
}
 

Detailed Description

QCan namespace

Enumeration Type Documentation

◆ CAN_Bitrate_e

The enumeration CAN_Bitrate_e defines commonly used bit-rates. The pre-defined value range is limited to a value of eCAN_BITRATE_MAX.

Enumerator
eCAN_BITRATE_NONE 

No bit-rate defined

eCAN_BITRATE_10K 

bit-rate 10 kBit/s

eCAN_BITRATE_20K 

bit-rate 20 kBit/s

eCAN_BITRATE_50K 

bit-rate 50 kBit/s

eCAN_BITRATE_100K 

bit-rate 100 kBit/s

eCAN_BITRATE_125K 

bit-rate 125 kBit/s

eCAN_BITRATE_250K 

bit-rate 250 kBit/s

eCAN_BITRATE_500K 

bit-rate 500 kBit/s

eCAN_BITRATE_800K 

bit-rate 800 kBit/s

eCAN_BITRATE_1M 

bit-rate 1 MBit/s

eCAN_BITRATE_2M 

bit-rate 2 MBit/s (ISO CAN FD, data phase)

eCAN_BITRATE_4M 

bit-rate 4 MBit/s (ISO CAN FD, data phase)

eCAN_BITRATE_5M 

bit-rate 5 MBit/s (ISO CAN FD, data phase)

eCAN_BITRATE_AUTO 

Use automatic bit-rate detection

eCAN_BITRATE_MAX 

Pre-defined bit-rate maximum

◆ CAN_Channel_e

The enumeration CAN_Channel_e defines up to 8 CAN channels.

Enumerator
eCAN_CHANNEL_NONE 

CAN interface invalid

eCAN_CHANNEL_1 

CAN interface 1

eCAN_CHANNEL_2 

CAN interface 2

eCAN_CHANNEL_3 

CAN interface 3

eCAN_CHANNEL_4 

CAN interface 4

eCAN_CHANNEL_5 

CAN interface 5

eCAN_CHANNEL_6 

CAN interface 6

eCAN_CHANNEL_7 

CAN interface 7

eCAN_CHANNEL_8 

CAN interface 8

◆ CAN_Mode_e

The enumeration CAN_Mode_e defines possible modes of the CAN protocol engine.

Enumerator
eCAN_MODE_INIT 

Set controller into 'Initialization' mode

eCAN_MODE_OPERATION 

Set controller into Operation' mode

eCAN_MODE_LISTEN_ONLY 

Set controller into 'Listen-only' mode

eCAN_MODE_SLEEP 

Set controller into 'Sleep' (power-down) mode

eCAN_MODE_SELF_TEST 

Set controller into 'Self-test' mode

◆ CAN_State_e

The enumeration CAN_State_e defines possible states of the CAN protocol engine.

Enumerator
eCAN_STATE_STOPPED 

CAN controller is in stopped mode

eCAN_STATE_SLEEPING 

CAN controller is in Sleep mode

eCAN_STATE_BUS_ACTIVE 

CAN controller is error active

eCAN_STATE_BUS_WARN 

CAN controller is active, warning level is reached

eCAN_STATE_BUS_PASSIVE 

CAN controller is error passive

eCAN_STATE_BUS_OFF 

CAN controller went into Bus Off

◆ LogLevel_e

Loglevel based on Apache Log4J framework.

Enumerator
eLOG_LEVEL_OFF 

Logging is deactivated

eLOG_LEVEL_FATAL 

Critical error, program abort

eLOG_LEVEL_ERROR 

Error (exception was caught, processing continued alternatively)

eLOG_LEVEL_WARN 

Occurrence of an unexpected situation. Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".

eLOG_LEVEL_INFO 

Interesting runtime events (startup/shutdown)

eLOG_LEVEL_DEBUG 

general debugging (finding errors)

eLOG_LEVEL_TRACE 

more detailed debugging, comments

eLOG_LEVEL_ALL 

All messages are logged