dsm-api-v2
|
This group of API calls addresses the communication with dSLink devices. More...
Typedefs | |
typedef void(* | DeviceDslinkSend_last_byte_no_answer_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t Value) |
Send UDI commands to a single dSLink device. | |
typedef void(* | DeviceDslinkSend_last_byte_no_answer_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Send UDI commands to a single dSLink device. | |
typedef void(* | DeviceDslinkSend_last_byte_with_answer_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t Value) |
Send UDI commands to a single dSLink device. | |
typedef void(* | DeviceDslinkSend_last_byte_with_answer_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Send UDI commands to a single dSLink device. | |
typedef void(* | DeviceDslinkSend_not_last_byte_no_answer_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t Value) |
Send UDI commands to a single dSLink device. | |
typedef void(* | DeviceDslinkSend_not_last_byte_no_answer_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Send UDI commands to a single dSLink device. | |
typedef void(* | DeviceDslinkSend_not_last_byte_with_answer_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t Value) |
Send UDI commands to a single dSLink device. | |
typedef void(* | DeviceDslinkSend_not_last_byte_with_answer_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Send UDI commands to a single dSLink device. | |
typedef void(* | EventDslink_interrupt_event_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t Priority) |
Notification from a dSLink enabled device. | |
typedef void(* | EventDslink_response_event_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t Value) |
Notification from a dSLink enabled device. | |
typedef void(* | ZoneGroupDslinkSend_last_byte_no_answer_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint8_t Value) |
Send UDI commands to all dSLink devices of a group/zone. | |
typedef void(* | ZoneGroupDslinkSend_last_byte_no_answer_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Send UDI commands to all dSLink devices of a group/zone. | |
typedef void(* | ZoneGroupDslinkSend_not_last_byte_no_answer_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint8_t Value) |
Send UDI commands to all dSLink devices of a group/zone. | |
typedef void(* | ZoneGroupDslinkSend_not_last_byte_no_answer_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Send UDI commands to all dSLink devices of a group/zone. | |
Functions | |
int | DeviceDslinkSend_last_byte_no_answer (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, uint8_t Value) |
Send UDI commands to a single dSLink device. | |
int | DeviceDslinkSend_last_byte_with_answer (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, uint8_t Value) |
Send UDI commands to a single dSLink device. | |
int | DeviceDslinkSend_last_byte_with_answer_sync (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, uint8_t Value, int timeout, uint8_t *ReturnValue) |
Send UDI commands to a single dSLink device. | |
int | DeviceDslinkSend_not_last_byte_no_answer (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, uint8_t Value) |
Send UDI commands to a single dSLink device. | |
int | DeviceDslinkSend_not_last_byte_with_answer (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, uint8_t Value) |
Send UDI commands to a single dSLink device. | |
int | DeviceDslinkSend_not_last_byte_with_answer_sync (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, uint8_t Value, int timeout, uint8_t *ReturnValue) |
Send UDI commands to a single dSLink device. | |
int | ZoneGroupDslinkSend_last_byte_no_answer (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneId, uint8_t GroupId, uint8_t Value) |
Send UDI commands to all dSLink devices of a group/zone. | |
int | ZoneGroupDslinkSend_not_last_byte_no_answer (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneId, uint8_t GroupId, uint8_t Value) |
Send UDI commands to all dSLink devices of a group/zone. |
This group of API calls addresses the communication with dSLink devices.
typedef void(* DeviceDslinkSend_last_byte_no_answer_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t Value) |
Send UDI commands to a single dSLink device.
UDI device is de-selected after the call. Used only on the last access.
Request callback function prototype for call DeviceDslinkSend_last_byte_no_answer.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_DSLINK_SEND and ModifierId = DEVICE_DSLINK_SEND_LAST_BYTE_NO_ANSWER
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Select only this device. |
[in] | Value | Value to send to devices. |
typedef void(* DeviceDslinkSend_last_byte_no_answer_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Send UDI commands to a single dSLink device.
UDI device is de-selected after the call. Used only on the last access.
Response callback function prototype for call DeviceDslinkSend_last_byte_no_answer.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_DSLINK_SEND and ModifierId = DEVICE_DSLINK_SEND_LAST_BYTE_NO_ANSWER
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* DeviceDslinkSend_last_byte_with_answer_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t Value) |
Send UDI commands to a single dSLink device.
UDI device is de-selected after the call. Used only on the last access. The answer is sent with a EventDslink_response_event_callback_t callback.
Request callback function prototype for call DeviceDslinkSend_last_byte_with_answer.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_DSLINK_SEND and ModifierId = DEVICE_DSLINK_SEND_LAST_BYTE_WITH_ANSWER
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Select only this device. |
[in] | Value | Value to send to devices. |
typedef void(* DeviceDslinkSend_last_byte_with_answer_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Send UDI commands to a single dSLink device.
UDI device is de-selected after the call. Used only on the last access. The answer is sent with a EventDslink_response_event_callback_t callback.
Response callback function prototype for call DeviceDslinkSend_last_byte_with_answer.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_DSLINK_SEND and ModifierId = DEVICE_DSLINK_SEND_LAST_BYTE_WITH_ANSWER
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* DeviceDslinkSend_not_last_byte_no_answer_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t Value) |
Send UDI commands to a single dSLink device.
UDI device stays selected after the call execution. Used when multiple bytes have to be sent.
Request callback function prototype for call DeviceDslinkSend_not_last_byte_no_answer.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_DSLINK_SEND and ModifierId = DEVICE_DSLINK_SEND_NOT_LAST_BYTE_NO_ANSWER
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Select only this device. |
[in] | Value | Value to send to devices. |
typedef void(* DeviceDslinkSend_not_last_byte_no_answer_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Send UDI commands to a single dSLink device.
UDI device stays selected after the call execution. Used when multiple bytes have to be sent.
Response callback function prototype for call DeviceDslinkSend_not_last_byte_no_answer.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_DSLINK_SEND and ModifierId = DEVICE_DSLINK_SEND_NOT_LAST_BYTE_NO_ANSWER
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* DeviceDslinkSend_not_last_byte_with_answer_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t Value) |
Send UDI commands to a single dSLink device.
UDI device stays selected after the call execution. Used when multiple bytes have to be sent. The answer is sent with a EventDslink_response_event_callback_t callback.
Request callback function prototype for call DeviceDslinkSend_not_last_byte_with_answer.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_DSLINK_SEND and ModifierId = DEVICE_DSLINK_SEND_NOT_LAST_BYTE_WITH_ANSWER
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Select only this device. |
[in] | Value | Value to send to devices. |
typedef void(* DeviceDslinkSend_not_last_byte_with_answer_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Send UDI commands to a single dSLink device.
UDI device stays selected after the call execution. Used when multiple bytes have to be sent. The answer is sent with a EventDslink_response_event_callback_t callback.
Response callback function prototype for call DeviceDslinkSend_not_last_byte_with_answer.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_DSLINK_SEND and ModifierId = DEVICE_DSLINK_SEND_NOT_LAST_BYTE_WITH_ANSWER
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* EventDslink_interrupt_event_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t Priority) |
Notification from a dSLink enabled device.
UDI Request (Interrupt).
Event callback function prototype.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_EVENT, MessageId = EVENT_DSLINK and ModifierId = EVENT_DSLINK_INTERRUPT
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Source Device ID. |
[in] | Priority | 0=normal, 1=high |
typedef void(* EventDslink_response_event_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t Value) |
Notification from a dSLink enabled device.
Response to a UDI read request.
Event callback function prototype.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_EVENT, MessageId = EVENT_DSLINK and ModifierId = EVENT_DSLINK_RESPONSE
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Source Device ID. |
[in] | Value | Read-out value |
typedef void(* ZoneGroupDslinkSend_last_byte_no_answer_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint8_t Value) |
Send UDI commands to all dSLink devices of a group/zone.
UDI device is de-selected after the call. Used only on the last access.
Request callback function prototype for call ZoneGroupDslinkSend_last_byte_no_answer.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = ZONE_GROUP_DSLINK_SEND and ModifierId = ZONE_GROUP_DSLINK_SEND_LAST_BYTE_NO_ANSWER
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | ZoneId | Select only devices in this zone. |
[in] | GroupId | Select only devices in this group. |
[in] | Value | Value to send to devices. |
typedef void(* ZoneGroupDslinkSend_last_byte_no_answer_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Send UDI commands to all dSLink devices of a group/zone.
UDI device is de-selected after the call. Used only on the last access.
Response callback function prototype for call ZoneGroupDslinkSend_last_byte_no_answer.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = ZONE_GROUP_DSLINK_SEND and ModifierId = ZONE_GROUP_DSLINK_SEND_LAST_BYTE_NO_ANSWER
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* ZoneGroupDslinkSend_not_last_byte_no_answer_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint8_t Value) |
Send UDI commands to all dSLink devices of a group/zone.
UDI device stays selected after the call execution. Used when multiple bytes have to be sent.
Request callback function prototype for call ZoneGroupDslinkSend_not_last_byte_no_answer.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = ZONE_GROUP_DSLINK_SEND and ModifierId = ZONE_GROUP_DSLINK_SEND_NOT_LAST_BYTE_NO_ANSWER
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | ZoneId | Select only devices in this zone. |
[in] | GroupId | Select only devices in this group. |
[in] | Value | Value to send to devices. |
typedef void(* ZoneGroupDslinkSend_not_last_byte_no_answer_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Send UDI commands to all dSLink devices of a group/zone.
UDI device stays selected after the call execution. Used when multiple bytes have to be sent.
Response callback function prototype for call ZoneGroupDslinkSend_not_last_byte_no_answer.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = ZONE_GROUP_DSLINK_SEND and ModifierId = ZONE_GROUP_DSLINK_SEND_NOT_LAST_BYTE_NO_ANSWER
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
int DeviceDslinkSend_last_byte_no_answer | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
uint8_t | Value | ||
) |
Send UDI commands to a single dSLink device.
UDI device is de-selected after the call. Used only on the last access.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceDslinkSend_last_byte_no_answer_response_callback_t callback. To receive this request from other bus members register the DeviceDslinkSend_last_byte_no_answer_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Select only this device. |
[in] | Value | Value to send to devices. |
int DeviceDslinkSend_last_byte_with_answer | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
uint8_t | Value | ||
) |
Send UDI commands to a single dSLink device.
UDI device is de-selected after the call. Used only on the last access. The answer is sent with a EventDslink_response_event_callback_t callback.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceDslinkSend_last_byte_with_answer_response_callback_t callback. To receive this request from other bus members register the DeviceDslinkSend_last_byte_with_answer_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Select only this device. |
[in] | Value | Value to send to devices. |
int DeviceDslinkSend_last_byte_with_answer_sync | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
uint8_t | Value, | ||
int | timeout, | ||
uint8_t * | ReturnValue | ||
) |
Send UDI commands to a single dSLink device.
UDI device is de-selected after the call. Used only on the last access. Synchronous implementation of DeviceDslinkSend_last_byte_with_answer.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination of the call |
[in] | DeviceId | Select only this device. |
[in] | Value | Value to send to devices. |
[in] | timeout | time-out of the synchronous call (in Seconds) |
[out] | ReturnValue | Answer from the device |
int DeviceDslinkSend_not_last_byte_no_answer | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
uint8_t | Value | ||
) |
Send UDI commands to a single dSLink device.
UDI device stays selected after the call execution. Used when multiple bytes have to be sent.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceDslinkSend_not_last_byte_no_answer_response_callback_t callback. To receive this request from other bus members register the DeviceDslinkSend_not_last_byte_no_answer_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Select only this device. |
[in] | Value | Value to send to devices. |
int DeviceDslinkSend_not_last_byte_with_answer | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
uint8_t | Value | ||
) |
Send UDI commands to a single dSLink device.
UDI device stays selected after the call execution. Used when multiple bytes have to be sent. The answer is sent with a EventDslink_response_event_callback_t callback.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceDslinkSend_not_last_byte_with_answer_response_callback_t callback. To receive this request from other bus members register the DeviceDslinkSend_not_last_byte_with_answer_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Select only this device. |
[in] | Value | Value to send to devices. |
int DeviceDslinkSend_not_last_byte_with_answer_sync | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
uint8_t | Value, | ||
int | timeout, | ||
uint8_t * | ReturnValue | ||
) |
Send UDI commands to a single dSLink device.
UDI device stays selected after the call execution. Used when multiple bytes have to be sent. Synchronous implementation of DeviceDslinkSend_not_last_byte_with_answer.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination of the call |
[in] | DeviceId | Select only this device. |
[in] | Value | Value to send to devices. |
[in] | timeout | time-out of the synchronous call (in Seconds) |
[out] | ReturnValue | Answer from the device |
int ZoneGroupDslinkSend_last_byte_no_answer | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | ZoneId, | ||
uint8_t | GroupId, | ||
uint8_t | Value | ||
) |
Send UDI commands to all dSLink devices of a group/zone.
UDI device is de-selected after the call. Used only on the last access.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ZoneGroupDslinkSend_last_byte_no_answer_response_callback_t callback. To receive this request from other bus members register the ZoneGroupDslinkSend_last_byte_no_answer_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | ZoneId | Select only devices in this zone. |
[in] | GroupId | Select only devices in this group. |
[in] | Value | Value to send to devices. |
int ZoneGroupDslinkSend_not_last_byte_no_answer | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | ZoneId, | ||
uint8_t | GroupId, | ||
uint8_t | Value | ||
) |
Send UDI commands to all dSLink devices of a group/zone.
UDI device stays selected after the call execution. Used when multiple bytes have to be sent.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ZoneGroupDslinkSend_not_last_byte_no_answer_response_callback_t callback. To receive this request from other bus members register the ZoneGroupDslinkSend_not_last_byte_no_answer_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | ZoneId | Select only devices in this zone. |
[in] | GroupId | Select only devices in this group. |
[in] | Value | Value to send to devices. |