Skip to main content
Version: 3.00

API List (Common)

For CAN-specific APIs, see CAN/CAN FD > API List. For LIN-specific APIs, see LIN > API List.

This page describes the list of common APIs available in this product and the callable conditions for each API.

Quick Guide by Task​

TaskAPIs to review firstRelated pages
Initialization and connectionMPXGetAPIVersion, MPXOpen, MPXCloseCommon API by Task
Runtime status controlMPXGetStatus, MPXMonitorStart, MPXMonitorStopCommon First (Minimum Flow)
Log acquisitionMPXSetGetLogMode, MPXSetLogCallBack, MPXGetLogStructure Definitions (Common), Constant Definitions (Common)

API List​

API NameFunctionTypical use case
MPXGetAPIVersionAcquire API versionCheck version before connection
MPXOpenDetect MicroPeckerX devicesEnumerate devices during initialization
MPXCloseRelease MicroPeckerX detectionApplication shutdown handling
MPXSetLEDControl LEDsVisualize connection state
MPXGetStatusAcquire MicroPeckerX statusCheck state before transition
MPXMonitorStartStart monitoringStart monitoring/simulation
MPXMonitorStopStop monitoringStop monitoring/simulation
MPXGetTimeStampAcquire timestampAcquire time reference for logs
MPXSetLogCallBackConfigure log callback functionEvent-driven log acquisition
MPXSetGetLogModeConfigure log acquisition methodSwitch API/callback mode
MPXGetLogAcquire log information (buffer pointer)Polling-based log acquisition

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
MPXGetAPIVersion○○
MPXOpen○
MPXClose○
MPXSetLED○○
MPXGetStatus○○○○○○
MPXMonitorStart○
MPXMonitorStop○○○○○
MPXGetTimeStamp○○○
MPXSetGetLogMode○○
MPXSetLogCallBack○○
MPXGetLog○○○