Constant Definitions (Common)
This section describes common constant definitions used by this product.
Main APIs
Definition List
Definition Details (Common)
API Return Values
| Constant Name | Value | Description |
|---|
| E_OK | 0 (0x0) | Success |
| E_PARAM | 1 (0x1) | Parameter error |
| E_DEVICE | 2 (0x2) | Device not detected |
| E_COMM | 3 (0x3) | USB communication error |
| E_TGT | 4 (0x4) | Target error |
| E_TRG_BUSY | 11 (0xB) | Trigger configuration failed |
| E_DCT_FULL | 12 (0xC) | Direct transmit FIFO full |
| E_STATUS | 105 (0x69) | Status error |
| E_TIMEOUT | 202 (0xCA) | USB communication timeout |
| E_OTHER | 255 (0xFF) | Other |
LED Settings
| Constant Name | Value | Description |
|---|
| MPX_LED_OFF | 0 (0x0) | LED off |
| MPX_LED_ON | 1 (0x1) | LED on or blinking |
MicroPeckerX Status
| Constant Name | Value | Description |
|---|
| MPX_STATUS_RUN | 17 (0x11) | APP running state |
| MPX_STATUS_PARAM | 18 (0x12) | Waiting for parameter setup |
| MPX_STATUS_SYNC | 19 (0x13) | Waiting for synchronization |
| MPX_STATUS_NONE | 32 (0x20) | Invalid state |
| MPX_STATUS_MON | 33 (0x21) | Monitor state |
| MPX_STATUS_SIM | 34 (0x22) | Simulation mode state |
| MPX_STATUS_E_CAN | 241 (0xF1) | CAN transition error state |
| MPX_STATUS_UNKNOWN | 255 (0xFF) | Unknown state |
Sync Mode
| Constant Name | Value | Description |
|---|
| MPX_SYNC_MASTER | 0 (0x0) | Sync master mode |
| MPX_SYNC_SLAVE | 1 (0x1) | Sync slave mode |
Log Acquisition Mode
| Constant Name | Value | Description |
|---|
| MPX_GETLOGMODE_CALLBACK | 0 (0x0) | Callback function mode |
| MPX_GETLOGMODE_GETLOGAPI | 1 (0x1) | Log acquisition API mode |
Log Size for Callback Mode
| Constant Name | Value | Description |
|---|
| MPX_GETLOG_CALLBACK_HEADERSIZE | 12 (0xC) | Callback log header size (excluding data section) |
| MPX_GETLOG_CALLBACK_HEADERSIZE_ERROR | 10 (0xA) | Callback log header size (error log) |
Log Size for GetLog API Mode
| Constant Name | Value | Description |
|---|
| MPX_GETLOG_SIZE | 84 (0x54) | Log size for log acquisition API |
Log Type
| Constant Name | Value | Description | Notes |
|---|
| MPX_LOG_TYPE_CAN | 1 (0x1) | CAN | |
| MPX_LOG_TYPE_CANFD | 2 (0x2) | CAN FD (bit rate switch enabled) | |
| MPX_LOG_TYPE_CANFD_NOBRS | 3 (0x3) | CAN FD (bit rate switch disabled) | |
| MPX_LOG_TYPE_LIN | 4 (0x4) | LIN | |
| MPX_LOG_TYPE_EMPTY | 63 (0x3F) | Timestamp only | Occurs only when log acquisition mode is MPX_GETLOG_CALLBACK (callback function mode). |
Log Direction
| Constant Name | Value | Description |
|---|
| MPX_LOG_DIR_RX | 0 (0x0) | Receive log |
| MPX_LOG_DIR_TX | 1 (0x1) | Transmit log |
Buffer Overrun Presence
| Constant Name | Value | Description |
|---|
| MPX_LOG_BUFOVER_FALSE | 0 (0x0) | Buffer overrun did not occur |
| MPX_LOG_BUFOVER_TRUE | 1 (0x1) | Buffer overrun occurred |
Internal Ch
| Constant Name | Value | Description |
|---|
| MPX_INNERCH_LIN | 1 (0x1) | Internal Ch for LIN |