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​

Task	APIs to review first	Related pages
Initialization and connection	MPXGetAPIVersion, MPXOpen, MPXClose	Common API by Task
Runtime status control	MPXGetStatus, MPXMonitorStart, MPXMonitorStop	Common First (Minimum Flow)
Log acquisition	MPXSetGetLogMode, MPXSetLogCallBack, MPXGetLog	Structure Definitions (Common), Constant Definitions (Common)

API List​

API Name	Function	Typical use case
MPXGetAPIVersion	Acquire API version	Check version before connection
MPXOpen	Detect MicroPeckerX devices	Enumerate devices during initialization
MPXClose	Release MicroPeckerX detection	Application shutdown handling
MPXSetLED	Control LEDs	Visualize connection state
MPXGetStatus	Acquire MicroPeckerX status	Check state before transition
MPXMonitorStart	Start monitoring	Start monitoring/simulation
MPXMonitorStop	Stop monitoring	Stop monitoring/simulation
MPXGetTimeStamp	Acquire timestamp	Acquire time reference for logs
MPXSetLogCallBack	Configure log callback function	Event-driven log acquisition
MPXSetGetLogMode	Configure log acquisition method	Switch API/callback mode
MPXGetLog	Acquire 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.

API	Status
	Not Recognized	Recognized (Status: MPX_STATUS_***)
		RUN	PARAM	SYNC	NONE	MON	SIM
MPXGetAPIVersion	○	○
MPXOpen	○
MPXClose		○
MPXSetLED		○	○
MPXGetStatus		○	○	○	○	○	○
MPXMonitorStart			○
MPXMonitorStop			○	○	○	○	○
MPXGetTimeStamp					○	○	○
MPXSetGetLogMode		○	○
MPXSetLogCallBack		○	○
MPXGetLog					○	○	○