API List
This chapter lists the APIs provided by this product and describes the conditions under which each API can be called.
API Overview
| API | Function |
|---|---|
| MPXGetAPIVersion | Retrieve the API version |
| MPXOpen | Detect MicroPeckerX units |
| MPXClose | Release detected MicroPeckerX units |
| MPXSetLED | Control the LEDs |
| MPXGetStatus | Retrieve MicroPeckerX status |
| MPXMonitorStart | Start monitoring |
| MPXMonitorStop | Stop monitoring |
| MPXGetTimeStamp | Retrieve a timestamp |
| MPXSetGetLogMode | Configure the log acquisition method |
| MPXSetLogCallBack | Configure the callback function for log acquisition |
| MPXGetLog | Retrieve log data (buffer pointer) |
| MPXGetLogEx | Retrieve log data (store in a structure array) |
| MPXSetCANParam | Configure communication parameters |
| MPXSetSlot | Configure slot information before monitoring |
| MPXChangeSlot | Configure slot information while monitoring |
| MPXSendSlot | Request slot transmission |
| MPXDirectSend | Send a frame |
| MPXSetLogRequestCallBack | Configure the callback for log replay data requests |
| MPXSetLogReplayData | Send log replay data |
| MPXSetBurstLog | Configure frames for burst transfer mode (single frame) |
| MPXSetLogReplayTrigger | Configure triggers for sending log replay data |
| MPXLogReplayStart | Start transmission in log replay or burst transfer mode |
| MPXLogReplayStop | Stop transmission in log replay or burst transfer mode |
API Call Conditions
Each API can be called only when the MicroPeckerX unit is in one of the states marked with ○ in the table below.
Behavior is undefined if an API is called in other states.
| API | Status | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Not detected | Detected (status: MPX_STATUS_***) | |||||||||
| RUN | PARAM | SYNC | NONE | MON | SIM | LOG | BUR_LOG | BUR | ||
| MPXGetAPIVersion | ○ | ○ | - | - | - | - | - | - | - | - |
| MPXOpen | ○ | - | - | - | - | - | - | - | - | - |
| MPXClose | - | ○ | - | - | - | - | - | - | - | - |
| MPXSetLED | - | ○ | ○ | - | - | - | - | - | - | - |
| MPXGetStatus | - | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ |
| MPXMonitorStart | - | - | ○ | - | - | - | - | - | - | - |
| MPXMonitorStop | - | - | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ |
| MPXGetTimeStamp | - | - | - | - | ○ | ○ | ○ | ○ | ○ | ○ |
| MPXSetGetLogMode | - | ○ | ○ | - | - | - | - | - | - | - |
| MPXSetLogCallBack | - | ○ | ○ | - | - | - | - | - | - | - |
| MPXGetLog | - | - | - | - | ○ | ○ | ○ | ○ | ○ | ○ |
| MPXGetLogEx | - | - | - | - | ○ | ○ | ○ | ○ | ○ | ○ |
| MPXSetCANParam | - | ○ | - | - | - | - | - | - | - | - |
| MPXSetSlot | - | ○ | ○ | - | - | - | - | - | - | - |
| MPXChangeSlot | - | - | - | - | - | - | ○ | - | - | - |
| MPXSendSlot | - | - | - | - | - | - | ○ | - | - | - |
| MPXDirectSend | - | - | - | - | - | - | ○ | - | - | - |
| MPXSetLogRequestCallBack | - | ○ | ○ | - | - | - | - | - | - | - |
| MPXSetLogReplayData | - | - | - | - | - | - | ○ | - | - | - |
| MPXSetBurstLog | - | ○ | ○ | - | - | - | - | - | - | - |
| MPXSetLogReplayTrigger | - | ○ | ○ | - | - | - | - | - | - | - |
| MPXLogReplayStart | - | - | - | - | - | - | ○ | ○ | ○ | ○ |
| MPXLogReplayStop | - | - | - | - | - | - | ○ | ○ | ○ | ○ |