API List (CAN)
For common APIs, see Common > API List.
This page describes the list of CAN APIs available in this product and the callable conditions for each API.
Quick Guide by Task
| Task | APIs to review first | Related pages |
|---|---|---|
| Configure communication parameters | MPXCANSetParam | CAN API Mapping, Constant Definitions (CAN) |
| Use slot transmission | MPXCANSetSlot, MPXCANChangeSlot, MPXCANSendSlot | Structure Definitions (CAN) |
| Log acquisition / analysis | MPXCANGetLogEx | API Details (Common), CAN Monitor Sample |
| Direct transmission | MPXCANDirectSend | CAN Simulation Sample |
API List
| API Name | Function | Typical use case |
|---|---|---|
| MPXCANSetParam | Configure CAN communication parameters | Configure prerequisites before starting monitoring/simulation |
| MPXCANGetLogEx | Acquire CAN log information (store in structure array) | Periodic monitoring-log acquisition |
| MPXCANSetSlot | Configure CAN slot information | Initial setup for periodic/event transmission scenarios |
| MPXCANChangeSlot | Change CAN slot information | Modify transmission conditions during operation |
| MPXCANSendSlot | Issue CAN slot transmission request | Immediate request for event transmission |
| MPXCANDirectSend | Transmit CAN frame | Single-shot transmission independent of slots |
API Callable Conditions
Each API can be called only when the recognition status or device status is marked with ○ in the table below.
Operation is not guaranteed in other states.
| API | Status | ||||||
|---|---|---|---|---|---|---|---|
| Not Recognized | Recognized (Status: MPX_STATUS_***) | ||||||
| RUN | PARAM | SYNC | NONE | MON | SIM | ||
| MPXCANSetParam | ○ | ||||||
| MPXCANGetLogEx | ○ | ○ | ○ | ||||
| MPXCANSetSlot | ○ | ○ | |||||
| MPXCANChangeSlot | ○ | ||||||
| MPXCANSendSlot | ○ | ||||||
| MPXCANDirectSend | ○ | ||||||