Constant Definitions (define)

This section describes the constant definitions used by this product.

Definition List

Definition	Constant Name
API Return Codes	E_*
LED Settings	MPX_LED_*
MicroPeckerX Status	MPX_STATUS_*
Sync Mode	MPX_SYNC_*
Log Acquisition Mode	MPX_GETLOGMODE_*
Log Type	MPX_LOG_TYPE_*
Log Direction	MPX_LOG_DIR_*
Error Flag	CAN_ERRFLG_*
Error Information	CAN_ERR_*
Buffer Overrun Flag	MPX_LOG_BUFOVER_*
Termination Resistor	MPX_CAN_TERMINATE_*
Operation Mode	MPX_MODE_*
Arbitration Baud Rate	MPX_CAN_PARAM_ABR_*
Data Baud Rate	MPX_CAN_PARAM_DBR_*
Sample Point	MPX_CAN_PARAM_SP_*
Protocol	MPX_CAN_PROTOCOL_*
Bit Rate Switch	MPX_CAN_BRS_*
Error Behavior	MPX_CAN_ERR_BEHAVIOR_*
One-shot Transmission Enable/Disable	MPX_CAN_ONESHOT_*
Frame Type	MPX_CAN_FRAME_TYPE_*
Slot Enable/Disable	MPX_CAN_SLOT_*
Final Frame Flag	MPX_CAN_LOG_*
ID Format	MPX_CAN_IDE_*
Remote Transmission Request	MPX_CAN_RTR_*
Trigger Type	MPX_CAN_SIM_TRIGGER_*
Increment Setting	MPX_CAN_SIM_INC_*
Slot Update Request	MPX_CAN_SLOT_REQ_*
FD Format	MPX_CAN_FDF_*
Log Size for Callback Mode	MPX_GETLOG_CALLBACK_*
Log Size for GetLog API Mode	MPX_GETLOG_*
Log Size for Log Replay	MPX_CAN_SIM_REPLAY_*

Definition Details

API Return Codes

Constant Name	Meaning
E_OK	Normal completion
E_PARAM	Parameter error
E_DEVICE	Device not detected
E_COMM	USB communication error
E_TGT	Target error
E_TRG_BUSY	Trigger setting failed
E_DCT_FULL	Direct transmission FIFO full
E_LOG_OVER	Log replay data count overflow
E_STATUS	Status error
E_TIMEOUT	USB communication timeout
E_OTHER	Unknown error

LED Settings

Constant Name	Meaning
MPX_LED_OFF	LED off
MPX_LED_ON	LED on or blinking

MicroPeckerX Status

Constant Name	Meaning
MPX_STATUS_RUN	APP running state
MPX_STATUS_PARAM	Waiting for parameter settings
MPX_STATUS_SYNC	Waiting for synchronization
MPX_STATUS_NONE	Invalid state
MPX_STATUS_MON	Monitor state
MPX_STATUS_SIM	Simulation mode state
MPX_STATUS_LOG	Log replay mode state
MPX_STATUS_BUR	Burst mode (single frame) state
MPX_STATUS_BUR_LOG	Burst mode (log replay) state
MPX_STATUS_E_CAN	CAN transition error state
MPX_STATUS_UNKNOWN	Unknown state

For the MicroPeckerX status transition diagram, see ***.

Sync Mode

Constant Name	Meaning
MPX_SYNC_MASTER	Master mode
MPX_SYNC_SLAVE	Slave mode

Log Acquisition Mode

Constant Name	Meaning
MPX_GETLOGMODE_CALLBACK	Callback function mode
MPX_GETLOGMODE_GETLOGAPI	Log acquisition API mode

Log Type

Constant Name	Meaning	Notes
MPX_LOG_TYPE_CAN	CAN
MPX_LOG_TYPE_CANFD	CAN-FD (bit rate switch enabled)
MPX_LOG_TYPE_CANFD_NOBRS	CAN-FD (bit rate switch disabled)
MPX_LOG_TYPE_EMPTY	Timestamp only	Occurs only when log acquisition mode is MPX_GETLOG_CALLBACK (callback function mode).

Log Direction

Constant Name	Meaning
MPX_LOG_DIR_RX	Receive log
MPX_LOG_DIR_TX	Transmit log

Error Flag

Constant Name	Meaning
CAN_ERRFLG_FALSE	No error
CAN_ERRFLG_TRUE	Error present

Error Information

Constant Name	Meaning
CAN_ERR_NONE	No error
CAN_ERR_BUS	Bus error
CAN_ERR_WARN	Error warning
CAN_ERR_PASV	Error passive
CAN_ERR_BUSOFF	Bus-off start
CAN_ERR_BUSWAKE	Bus-off recovery
CAN_ERR_OVERLOAD	Overload
CAN_ERR_BUSLOCK	Channel bus lock
CAN_ERR_ARBLOST	Arbitration lost
CAN_ERR_STAFF	Stuff error
CAN_ERR_FORM	Form error
CAN_ERR_ACK	ACK error
CAN_ERR_CRC	CRC error
CAN_ERR_RECESSIVE	Recessive bit error
CAN_ERR_DOMINANT	Dominant bit error
CAN_ERR_DELIMITER	ACK delimiter error

Buffer Overrun Flag

Constant Name	Meaning
MPX_LOG_BUFOVER_FALSE	Buffer overrun not occurred
MPX_LOG_BUFOVER_TRUE	Buffer overrun occurred

Termination Resistor

Constant Name	Meaning
MPX_CAN_TERMINATE_DISABLE	No termination resistor
MPX_CAN_TERMINATE_ENABLE	Termination resistor enabled

Operation Mode

Constant Name	Meaning
MPX_MODE_LISTEN	Monitor mode (no ACK)
MPX_MODE_MONITOR	Monitor mode (with ACK)
MPX_MODE_CAN_SIM	Simulation mode
MPX_MODE_CAN_LOGREPLAY	Log replay mode
MPX_MODE_CAN_BURST_FRM	Burst transfer mode (single frame)
MPX_MODE_CAN_BURST_LOG	Burst transfer mode (log replay)
MPX_MODE_NONE	No operation

Arbitration Baud Rate

Constant Name	Meaning
MPX_CAN_PARAM_ABR_1M	1 Mbps
MPX_CAN_PARAM_ABR_500K	500 kbps
MPX_CAN_PARAM_ABR_250K	250 kbps
MPX_CAN_PARAM_ABR_125K	125 kbps

Data Baud Rate

Constant Name	Meaning
MPX_CAN_PARAM_DBR_5M	5 Mbps
MPX_CAN_PARAM_DBR_4M	4 Mbps
MPX_CAN_PARAM_DBR_2M	2 Mbps
MPX_CAN_PARAM_DBR_1M	1 Mbps
MPX_CAN_PARAM_DBR_500K	500 kbps

Sample Point

Constant Name	Meaning
MPX_CAN_PARAM_SP_60P	60%
MPX_CAN_PARAM_SP_65P	65%
MPX_CAN_PARAM_SP_70P	70%
MPX_CAN_PARAM_SP_75P	75%
MPX_CAN_PARAM_SP_80P	80%
MPX_CAN_PARAM_SP_85P	85%

Available sample points vary depending on the combination of arbitration baud rate and data baud rate (see Baud Rate and Sample Point).

Protocol

Constant Name	Meaning
MPX_CAN_PROTOCOL_CAN	CAN
MPX_CAN_PROTOCOL_CANFD	CAN FD

Bit Rate Switch

Constant Name	Meaning
MPX_CAN_BRS_DISABLE	Bit rate switch disabled
MPX_CAN_BRS_ENABLE	Bit rate switch enabled

Error Behavior

Constant Name	Meaning
MPX_CAN_ERR_BEHAVIOR_ACTIVE	Error active
MPX_CAN_ERR_BEHAVIOR_PASSIVE	Error passive

One-shot Transmission Enable/Disable

Constant Name	Meaning
MPX_CAN_ONESHOT_DISABLE	One-shot transmission disabled
MPX_CAN_ONESHOT_ENABLE	One-shot transmission enabled

Frame Type

Constant Name	Meaning
MPX_CAN_FRAME_TYPE_PERIODIC	Periodic transmission
MPX_CAN_FRAME_TYPE_PERIODIC_TRIGGER	Start periodic transmission by event
MPX_CAN_FRAME_TYPE_EVENT	Event transmission
MPX_CAN_FRAME_TYPE_EVENTPERIODIC	Event periodic transmission

Slot Enable/Disable

Constant Name	Meaning
MPX_CAN_SLOT_DISABLE	Slot disabled
MPX_CAN_SLOT_ENABLE	Slot enabled

Final Frame Flag

Constant Name	Meaning
MPX_CAN_LOG_NOTLAST	Not the final frame of log replay
MPX_CAN_LOG_LAST	Final frame of log replay

ID Format

Constant Name	Meaning
MPX_CAN_IDE_STD	Standard ID
MPX_CAN_IDE_EXT	Extended ID

Remote Transmission Request

Constant Name	Meaning
MPX_CAN_RTR_DATA	Data frame
MPX_CAN_RTR_REMOTE	Remote frame

Trigger Type

Constant Name	Meaning
MPX_CAN_SIM_TRIGGER_USER	User-specified
MPX_CAN_SIM_TRIGGER_CAN	Receive specified CAN ID
MPX_CAN_SIM_TRIGGER_CANFD	Receive specified CAN FD ID

Increment Setting

Constant Name	Meaning
MPX_CAN_SIM_INC_FALSE	No increment
MPX_CAN_SIM_INC_TRUE	Increment enabled

Slot Update Request

Constant Name	Meaning
MPX_CAN_SLOT_REQ_NONE	No transmit trigger, no data rewrite
MPX_CAN_SLOT_REQ_DATA	No transmit trigger, with data rewrite
MPX_CAN_SLOT_REQ_TRG	With transmit trigger, no data rewrite
MPX_CAN_SLOT_REQ_DATA_TRG	With transmit trigger, with data rewrite

FD Format

Constant Name	Meaning
MPX_CAN_FDF_OFF	CAN format
MPX_CAN_FDF_ON	CAN FD format

Log Size for Callback Mode

Constant Name	Meaning
MPX_GETLOG_CALLBACK_HEADERSIZE	Header size (excluding data field)

Log Size for GetLog API Mode

Constant Name	Meaning
MPX_GETLOG_SIZE	Log size

Log Size for Log Replay

Constant Name	Meaning
MPX_CAN_SIM_REPLAY_HEADERSIZE	Header size (excluding data field)

Supplemental Information

Baud Rate and Sample Point

Available sample points vary depending on the combination of arbitration baud rate and data baud rate.

Baud Rate		Arbitration Sample Point						Data Sample Point
Arbitration	Data	60%	65%	70%	75%	80%	85%	60%	65%	70%	75%	80%	85%
125kbps	500kbps	○	○	○	○	○	○	○	○	○	○	○	○
	1Mbps	-	-	-	-	○	○	○	○	○	○	○	○
	2Mbps	-	-	-	-	○	○	○	-	○	-	○	-
250kbps	500kbps	○	○	○	○	○	○	○	○	○	○	○	○
	1Mbps	○	○	○	○	○	○	○	○	○	○	○	○
	2Mbps	○	○	○	○	○	○	○	-	○	-	○	-
	4Mbps	-	-	-	-	○	○	○	-	○	-	○	-
	5Mbps	-	-	-	-	○	○	-	-	-	○	-	-
500kbps	500kbps	○	○	○	○	○	○	○	○	○	○	○	○
	1Mbps	○	○	○	○	○	○	○	○	○	○	○	○
	2Mbps	○	○	○	○	○	○	○	-	○	-	○	-
	4Mbps	○	○	○	○	○	○	○	-	○	-	○	-
	5Mbps	○	○	○	○	○	○	-	-	-	○	-	-
1Mbps	500kbps	○	-	○	-	○	-	○	○	○	○	○	○
	1Mbps	○	○	○	○	○	○	○	○	○	○	○	○
	2Mbps	○	○	○	○	○	○	○	-	○	-	○	-
	4Mbps	○	○	○	○	○	○	○	-	○	-	○	-
	5Mbps	○	○	○	○	○	○	-	-	-	○	-	-

A combination of arbitration baud rate 125kbps and data baud rate 4Mbps or 5Mbps cannot be configured.

Definition List​

Definition Details​

API Return Codes​

LED Settings​

MicroPeckerX Status​

Sync Mode​

Log Acquisition Mode​

Log Type​

Log Direction​

Error Flag​

Error Information​

Buffer Overrun Flag​

Termination Resistor​

Operation Mode​

Arbitration Baud Rate​

Data Baud Rate​

Sample Point​

Protocol​

Bit Rate Switch​

Error Behavior​

One-shot Transmission Enable/Disable​

Frame Type​

Slot Enable/Disable​

Final Frame Flag​

ID Format​

Remote Transmission Request​

Trigger Type​

Increment Setting​

Slot Update Request​

FD Format​

Log Size for Callback Mode​

Log Size for GetLog API Mode​

Log Size for Log Replay​

Supplemental Information​

Baud Rate and Sample Point​