Acyclic Data API.
Functions | |
IOL_FUNC_DECL IOL_EErrorInfo | IOLM_API_AL_eReadReq (INT8U u8Port_p, INT16U u16Index_p, INT8U u8Subindex_p) |
Send ISDU read request. More... | |
IOL_FUNC_DECL IOL_EErrorInfo | IOLM_API_AL_eWriteReq (INT8U u8Port_p, INT16U u16Index_p, INT8U u8Subindex_p, INT8U *pu8Data_p, INT8U u8Length_p) |
Send ISDU write request. More... | |
IOL_FUNC_DECL void | IOLM_API_AL_vAbort (INT8U u8Port_p) |
Abort a pending ISDU request. More... | |
IOL_FUNC_DECL void | IOLM_Port_AL_vReadCnf (INT8U u8Port_p, INT16U u16ErrorInfo_p, const INT8U *pu8Data_p, INT8U u8Length_p) |
Read confirmation. More... | |
IOL_FUNC_DECL void | IOLM_Port_AL_vWriteCnf (INT8U u8Port_p, INT16U u16ErrorInfo_p) |
Write confirmation. More... | |
IOL_FUNC_DECL IOL_EErrorInfo IOLM_API_AL_eReadReq | ( | INT8U | u8Port_p, |
INT16U | u16Index_p, | ||
INT8U | u8Subindex_p | ||
) |
Send ISDU read request.
The AL read request is used to trigger a read on the specified index and port. For index values >= 2 the ISDU channel is used. This requires a connected Device with ISDU support. Index 0 is used to access the Direct Parameter Page 1. Index 1 is used to access the Direct Parameter Page 2.
On success the function IOLM_Port_AL_vReadCnf is called if the service has finished.
For details see Annex B in IO-Link Specification v1.1.2.
[in] | u8Port_p | The port number of the affected port. |
[in] | u16Index_p | ISDU Index / 0 for DPP1 / 1 for DPP2. |
[in] | u8Subindex_p | Parameter SubIndex. |
IOL_FUNC_DECL IOL_EErrorInfo IOLM_API_AL_eWriteReq | ( | INT8U | u8Port_p, |
INT16U | u16Index_p, | ||
INT8U | u8Subindex_p, | ||
INT8U * | pu8Data_p, | ||
INT8U | u8Length_p | ||
) |
Send ISDU write request.
The AL write request is used to trigger a write on the specified index and port. For Index values >= 2 the ISDU channel is used. This requires a connected Device with ISDU support. Index 1 is used to access the Direct Parameter Page 2.
On success the function IOLM_Port_AL_vWriteCnf is called if the service has finished.
[in] | u8Port_p | The port number of the affected port. |
[in] | u16Index_p | ISDU index / 1 for DPP2. |
[in] | u8Subindex_p | Parameter SubIndex |
[in] | pu8Data_p | Data to be written. |
[in] | u8Length_p | Length of pu8Data_p. |
IOL_FUNC_DECL void IOLM_API_AL_vAbort | ( | INT8U | u8Port_p | ) |
Abort a pending ISDU request.
The AL abort cancels the pending read or write request and triggers the corresponding callback with ErrorCode IOL_eErrorType_SERV_NOTAVAIL.
[in] | u8Port_p | The port number of the affected port. |
IOL_FUNC_DECL void IOLM_Port_AL_vReadCnf | ( | INT8U | u8Port_p, |
INT16U | u16ErrorInfo_p, | ||
const INT8U * | pu8Data_p, | ||
INT8U | u8Length_p | ||
) |
Read confirmation.
This function is called if a read request is handled. If the error info is IOL_eErrorType_NONE, the data pointer is valid.
[in] | u8Port_p | The port number of the affected port. |
[in] | u16ErrorInfo_p | Error information (see IOL_EErrorType). |
[in] | pu8Data_p | Response data. |
[in] | u8Length_p | Response data Length. |
Write confirmation.
This function is called if a write request is handled. If the error info is IOL_eErrorType_NONE, the write operation was successful.
[in] | u8Port_p | The port number of the affected port. |
[in] | u16ErrorInfo_p | Error information (see IOL_EErrorType). |