aghaf_dokline_enums.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
AGHAF_DoKLine_MSG_FLAGS
#define	AGHAF_DoKLine_MSG_EVENT_DATA    (1 << 0)
	by this flag More...
#define	AGHAF_DoKLine_MSG_INIT_SEQ    (1 << 1)
	Send the initialization sequence.

Enumerations
enum	AGHAF_DoKLine_ChannelDirection { AGHAF_DoKLine_CHANNEL_DIR_RX = (1U << 0) , AGHAF_DoKLine_CHANNEL_DIR_TX = (1U << 1) , AGHAF_DoKLine_CHANNEL_DIR_2WAY }
	Possible directions for DoKLine channels. More...
enum	AGHAF_DoKLine_ChannelLengthByte { AGHAF_DoKLine_CHANNEL_LENGTH_BYTE_AUTO , AGHAF_DoKLine_CHANNEL_LENGTH_BYTE_ALWAYS , AGHAF_DoKLine_CHANNEL_LENGTH_BYTE_NONE }
	Additional length byte configuration. More...
enum	AGHAF_DoKLine_ChannelMode { AGHAF_DoKLine_CHANNEL_MODE_DEFAULT , AGHAF_DoKLine_CHANNEL_MODE_NOCS , AGHAF_DoKLine_CHANNEL_MODE_RAW }
	Possible mode for DoKLine channels. More...
enum	AGHAF_DoKLine_ChannelParam {   AGHAF_DoKLine_CHANNEL_PARAM_DIRECTION = 0 , AGHAF_DoKLine_CHANNEL_PARAM_MODE , AGHAF_DoKLine_CHANNEL_LENGTH_BYTE , AGHAF_DoKLine_CHANNEL_PARAM_REQ_FMT_BYTE ,   AGHAF_DoKLine_CHANNEL_PARAM_REQ_TGT_ADDR , AGHAF_DoKLine_CHANNEL_PARAM_REQ_SRC_ADDR , AGHAF_DoKLine_CHANNEL_PARAM_RSP_FMT_BYTE , AGHAF_DoKLine_CHANNEL_PARAM_RSP_TGT_ADDR ,   AGHAF_DoKLine_CHANNEL_PARAM_RSP_SRC_ADDR , AGHAF_DoKLine_CHANNEL_PARAM_CS_NOCHECK , AGHAF_DoKLine_CHANNEL_PARAM_PAD_VALUE , AGHAF_DoKLine_CHANNEL_PARAM_PAD_LENGTH ,   AGHAF_DoKLine_CHANNEL_PARAM_CONCATENATION }
	List of parameters used to configure a DoKLine channel. More...
enum	AGHAF_DoKLine_Error { AGHAF_DOKLINE_ERROR_BADLEN = 0 , AGHAF_DOKLINE_ERROR_BADCS }
	List of possible errors in DoKLine. More...

Macro Definition Documentation

AGHAF_DoKLine_MSG_EVENT_DATA

#define AGHAF_DoKLine_MSG_EVENT_DATA    (1 << 0)

by this flag

Report Tx data in DoKLineEventMessage / dataLen is not affected

Examples

DoKLine/main.cpp.

Enumeration Type Documentation

AGHAF_DoKLine_ChannelDirection

enum AGHAF_DoKLine_ChannelDirection

Possible directions for DoKLine channels.

Enumerator
AGHAF_DoKLine_CHANNEL_DIR_RX	Rx only channel.
AGHAF_DoKLine_CHANNEL_DIR_TX	Tx only channel.
AGHAF_DoKLine_CHANNEL_DIR_2WAY	2-way channel

AGHAF_DoKLine_ChannelLengthByte

enum AGHAF_DoKLine_ChannelLengthByte

Additional length byte configuration.

Enumerator
AGHAF_DoKLine_CHANNEL_LENGTH_BYTE_AUTO	Uses additional length byte if size to transmit is greater than 63 bytes
AGHAF_DoKLine_CHANNEL_LENGTH_BYTE_ALWAYS	Always use additional length byte
AGHAF_DoKLine_CHANNEL_LENGTH_BYTE_NONE	Never use additional length byte. If size to transmit is greater than 63 bytes, message is rejected.

AGHAF_DoKLine_ChannelMode

enum AGHAF_DoKLine_ChannelMode

Possible mode for DoKLine channels.

Enumerator
AGHAF_DoKLine_CHANNEL_MODE_DEFAULT	Transmitter: Appends the header and checksum to the message to be sent Reveiver: Removes and validate the header and checksum of the received message
AGHAF_DoKLine_CHANNEL_MODE_NOCS	Transmitter: Appends the header but doesn't appends checksum to the message to be sent Reveiver: Removes and validates the header but doesn't remove nor validate the checksum of the received message.
AGHAF_DoKLine_CHANNEL_MODE_RAW	Transmitter: Send the message unchanged. Reveiver: Doesn't change received message.

AGHAF_DoKLine_ChannelParam

enum AGHAF_DoKLine_ChannelParam

List of parameters used to configure a DoKLine channel.

Enumerator
AGHAF_DoKLine_CHANNEL_PARAM_DIRECTION	Set channel direction. When functional addressing mode is used, you can't use 2-way channel. Use AGHAF_DoKLine_ChannelDirection Default: AGHAF_DoKLine_CHANNEL_DIR_2WAY
AGHAF_DoKLine_CHANNEL_PARAM_MODE	Set channel mode. Use AGHAF_DoKLine_ChannelMode Default: AGHAF_DoKLine_CHANNEL_MODE_DEFAULT
AGHAF_DoKLine_CHANNEL_LENGTH_BYTE	Additional length byte. Use AGHAF_DoKLine_ChannelLengthByte Default: AGHAF_DoKLine_CHANNEL_LENGTH_BYTE_AUTO
AGHAF_DoKLine_CHANNEL_PARAM_REQ_FMT_BYTE	Request first header byte value (without length if applicable). Range: [0x00, 0xFF] Default: 0x80
AGHAF_DoKLine_CHANNEL_PARAM_REQ_TGT_ADDR	Request target addressing information (used for message header construction). Range: [0x00, 0xFF] Default: 0x10
AGHAF_DoKLine_CHANNEL_PARAM_REQ_SRC_ADDR	Request source addressing information (used for message header construction). Range: [0x00, 0xFF] Default: 0xF1
AGHAF_DoKLine_CHANNEL_PARAM_RSP_FMT_BYTE	Response first header byte value (without length if applicable). If format, target and source are set to 0xFF it acts as an accept all filter. Range: [0x00, 0xFF] Default: 0x80
AGHAF_DoKLine_CHANNEL_PARAM_RSP_TGT_ADDR	Response target addressing information (used for response filtering). If format, target and source are set to 0xFF, it acts as an accept all filter. Range: [0x00, 0xFF] Default: 0xF1
AGHAF_DoKLine_CHANNEL_PARAM_RSP_SRC_ADDR	Response source addressing information (used for response filtering). If format, target and source are set to 0xFF it acts as an accept all filter. Range: [0x00, 0xFF] Default: 0x10
AGHAF_DoKLine_CHANNEL_PARAM_CS_NOCHECK	If enable, never check checksum of response when AGHAF_DoKLine_CHANNEL_PARAM_MODE is set to AGHAF_DoKLine_CHANNEL_MODE_DEFAULT. Range: [0, 1] Default: 0 (disabled)
AGHAF_DoKLine_CHANNEL_PARAM_PAD_VALUE	Padding value. Range: [0x00, 0xFF] Default: 0xFF
AGHAF_DoKLine_CHANNEL_PARAM_PAD_LENGTH	Length to pad the data portion of the message. Max: 255 Default: 0 (disabled)
AGHAF_DoKLine_CHANNEL_PARAM_CONCATENATION	Manage multiple responses detection from a single ECU. When enabled, waits for the receive timeout before determining that all responses have been received. It use the first data byte of message to detetect a segmented response, and construct a single ECU response. Max: 125000 ms Default: 0 (disabled)

AGHAF_DoKLine_Error

enum AGHAF_DoKLine_Error

List of possible errors in DoKLine.

Enumerator
AGHAF_DOKLINE_ERROR_BADLEN	Incorrect response data length.
AGHAF_DOKLINE_ERROR_BADCS	Bad checksum.