API List
This section describes the list of APIs available in this product and the conditions under which each API can be called.
API List
| API Name | Function |
|---|---|
| MPXGetAPIVersion | Get API version |
| MPXOpen | Detect MicroPeckerX |
| MPXClose | Release MicroPeckerX detection |
| MPXSetLED | LED control |
| MPXGetStatus | Get MicroPeckerX status |
| MPXMonitorStart | Start monitoring |
| MPXMonitorStop | Stop monitoring |
| MPXGetTimeStamp | Get timestamp |
| MPXSetGetLogMode | Set log acquisition method |
| MPXSetLogCallBack | Set callback function for log acquisition |
| MPXGetLog | Get log information (buffer pointer) |
| MPXGetLogEx | Get log information (store in structure array) |
| MPXSetCANParam | Set communication parameters |
| MPXSetSlot | Configure slot information before monitoring |
| MPXChangeSlot | Configure slot information during monitoring |
| MPXSendSlot | Request slot transmission |
| MPXDirectSend | Transmit frame |
| MPXSetLogRequestCallBack | Set callback function for log replay data requests |
| MPXSetLogReplayData | Send log replay data |
| MPXSetBurstLog | Configure frame information for burst transfer mode (single frame) |
| MPXSetLogReplayTrigger | Set trigger conditions for starting transmission of log replay data |
| MPXLogReplayStart | Start transmission in log replay mode or burst transfer mode |
| MPXLogReplayStop | Stop transmission in log replay mode or burst transfer mode |
API Callable Conditions
Each API can be called when the recognition state or status of the MicroPeckerX unit is marked with "○" in the table below.
Operation is not guaranteed if called in any other state.
| API | Status | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Not Recognized | Recognized (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 | - | - | - | - | - | - | ○ | ○ | ○ | ○ |