API List (LIN)
For common APIs, see Common > API List.
This page describes the list of LIN APIs available in this product and the callable conditions for each API.
Quick Guide by Task
| Task | APIs to review first | Related pages |
|---|---|---|
| Configure communication parameters | MPXLINSetParam | LIN API Mapping, Constant Definitions (LIN) |
| Master simulation | MPXLINSetMasterSim, MPXLINSetMasterSchedule, MPXLINChangeMasterSchedule | Structure Definitions (LIN), LIN Master Sample |
| Slave simulation | MPXLINSetSlaveSim, MPXLINSetSlaveItem, MPXLINChangeSlaveItem | LIN Slave Sample |
| Log acquisition / analysis | MPXLINGetLogEx | API Details (Common), LIN Monitor Sample |
API List
| API Name | Function | Typical use case |
|---|---|---|
| MPXLINSetParam | Configure LIN communication parameters | Configure prerequisites before starting monitor/master/slave mode |
| MPXLINGetLogEx | Acquire LIN log information (store in structure array) | Periodic LIN log acquisition |
| MPXLINSetStatus | Configure LIN status | Control Run/Sleep state |
| MPXLINSetMasterSim | Configure LIN master simulation | Initial setup of schedule contents |
| MPXLINSetMasterItem | Configure LIN master simulation item | Toggle item enable/disable |
| MPXLINChangeMasterItem | Change LIN master simulation item | Dynamically update item contents |
| MPXLINSetMasterSchedule | Configure LIN master schedule | Enable schedule / set OneTime |
| MPXLINChangeMasterSchedule | Change LIN master schedule | Switch active schedule |
| MPXLINPauseMasterSchedule | Pause LIN master schedule | Pause/resume operation |
| MPXLINMasterInterrupt | Perform LIN interrupt transmission | Immediate interrupt transmission from master |
| MPXLINSetSlaveSim | Configure LIN slave simulation | Initial setup of response definitions |
| MPXLINSetSlaveItem | Configure LIN slave simulation item | Toggle enable/disable per response ID |
| MPXLINChangeSlaveItem | Change LIN slave simulation item | Dynamically update response data |
| MPXLINSlaveWakeup | Perform LIN slave wakeup transmission | Send bus wakeup request |
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 | ||
| MPXLINSetParam | ○ | ||||||
| MPXLINGetLogEx | ○ | ○ | ○ | ||||
| MPXLINSetStatus | ○ | ○ | ○ | ||||
| MPXLINSetMasterSim | ○ | ○ | |||||
| MPXLINSetMasterItem | ○ | ||||||
| MPXLINChangeMasterItem | ○ | ||||||
| MPXLINSetMasterSchedule | ○ | ○ | |||||
| MPXLINChangeMasterSchedule | ○ | ○ | ○ | ||||
| MPXLINPauseMasterSchedule | ○ | ||||||
| MPXLINMasterInterrupt | ○ | ||||||
| MPXLINSetSlaveSim | ○ | ○ | |||||
| MPXLINSetSlaveItem | ○ | ||||||
| MPXLINChangeSlaveItem | ○ | ||||||
| MPXLINSlaveWakeup | ○ | ||||||