Skip to main content
Version: 4.00

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​

TaskAPIs to review firstRelated pages
Configure communication parametersMPXCANSetParamCAN API Mapping, Constant Definitions (CAN)
Use slot transmissionMPXCANSetSlot, MPXCANChangeSlot, MPXCANSendSlotStructure Definitions (CAN)
Log acquisition / analysisMPXCANGetLogExAPI Details (Common), CAN Monitor Sample
Direct transmissionMPXCANDirectSendCAN Simulation Sample

API List​

API NameFunctionTypical use case
MPXCANSetParamConfigure CAN communication parametersConfigure prerequisites before starting monitoring/simulation
MPXCANGetLogExAcquire CAN log information (store in structure array)Periodic monitoring-log acquisition
MPXCANSetSlotConfigure CAN slot informationInitial setup for periodic/event transmission scenarios
MPXCANChangeSlotChange CAN slot informationModify transmission conditions during operation
MPXCANSendSlotIssue CAN slot transmission requestImmediate request for event transmission
MPXCANDirectSendTransmit CAN frameSingle-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.

APIStatus
Not RecognizedRecognized (Status: MPX_STATUS_***)
RUNPARAMSYNCNONEMONSIM
MPXCANSetParam○
MPXCANGetLogEx○○○
MPXCANSetSlot○○
MPXCANChangeSlot○
MPXCANSendSlot○
MPXCANDirectSend○