dsm-api-v2
Typedefs | Functions
dSLink

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.

Detailed Description

This group of API calls addresses the communication with dSLink devices.


Typedef Documentation

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

Parameters:
[in]errorError result of the (potential) previous call.
[in]argUser data
[in]sourceIdSource address of the call
[in]destinationIdDestination address of the call
[in]DeviceIdSelect only this device.
[in]ValueValue 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

Parameters:
[in]errorError result of the (potential) previous call.
[in]argUser data
[in]sourceIdSource address of the call
[in]destinationIdDestination 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

Parameters:
[in]errorError result of the (potential) previous call.
[in]argUser data
[in]sourceIdSource address of the call
[in]destinationIdDestination address of the call
[in]DeviceIdSelect only this device.
[in]ValueValue 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

Parameters:
[in]errorError result of the (potential) previous call.
[in]argUser data
[in]sourceIdSource address of the call
[in]destinationIdDestination 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

Parameters:
[in]errorError result of the (potential) previous call.
[in]argUser data
[in]sourceIdSource address of the call
[in]destinationIdDestination address of the call
[in]DeviceIdSelect only this device.
[in]ValueValue 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

Parameters:
[in]errorError result of the (potential) previous call.
[in]argUser data
[in]sourceIdSource address of the call
[in]destinationIdDestination 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

Parameters:
[in]errorError result of the (potential) previous call.
[in]argUser data
[in]sourceIdSource address of the call
[in]destinationIdDestination address of the call
[in]DeviceIdSelect only this device.
[in]ValueValue 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

Parameters:
[in]errorError result of the (potential) previous call.
[in]argUser data
[in]sourceIdSource address of the call
[in]destinationIdDestination 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

Parameters:
[in]errorError result of the (potential) previous call.
[in]argUser data
[in]sourceIdSource address of the call
[in]destinationIdDestination address of the call
[in]DeviceIdSource Device ID.
[in]Priority0=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

Parameters:
[in]errorError result of the (potential) previous call.
[in]argUser data
[in]sourceIdSource address of the call
[in]destinationIdDestination address of the call
[in]DeviceIdSource Device ID.
[in]ValueRead-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

Parameters:
[in]errorError result of the (potential) previous call.
[in]argUser data
[in]sourceIdSource address of the call
[in]destinationIdDestination address of the call
[in]ZoneIdSelect only devices in this zone.
[in]GroupIdSelect only devices in this group.
[in]ValueValue 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

Parameters:
[in]errorError result of the (potential) previous call.
[in]argUser data
[in]sourceIdSource address of the call
[in]destinationIdDestination 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

Parameters:
[in]errorError result of the (potential) previous call.
[in]argUser data
[in]sourceIdSource address of the call
[in]destinationIdDestination address of the call
[in]ZoneIdSelect only devices in this zone.
[in]GroupIdSelect only devices in this group.
[in]ValueValue 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

Parameters:
[in]errorError result of the (potential) previous call.
[in]argUser data
[in]sourceIdSource address of the call
[in]destinationIdDestination address of the call

Function Documentation

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.

Parameters:
[in]handleHandle to the library instance
[in]dSMdSIDDestination dSM of the call
[in]DeviceIdSelect only this device.
[in]ValueValue to send to devices.
Returns:
0: success (return parameters are valid); <0: Library error; >0: dSM error code
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.

Parameters:
[in]handleHandle to the library instance
[in]dSMdSIDDestination dSM of the call
[in]DeviceIdSelect only this device.
[in]ValueValue to send to devices.
Returns:
0: success (return parameters are valid); <0: Library error; >0: dSM error code
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.

Parameters:
[in]handleHandle to the library instance
[in]dSMdSIDDestination of the call
[in]DeviceIdSelect only this device.
[in]ValueValue to send to devices.
[in]timeouttime-out of the synchronous call (in Seconds)
[out]ReturnValueAnswer from the device
Returns:
0: success (return parameters are valid); <0: Library error; >0: dSM error code
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.

Parameters:
[in]handleHandle to the library instance
[in]dSMdSIDDestination dSM of the call
[in]DeviceIdSelect only this device.
[in]ValueValue to send to devices.
Returns:
0: success (return parameters are valid); <0: Library error; >0: dSM error code
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.

Parameters:
[in]handleHandle to the library instance
[in]dSMdSIDDestination dSM of the call
[in]DeviceIdSelect only this device.
[in]ValueValue to send to devices.
Returns:
0: success (return parameters are valid); <0: Library error; >0: dSM error code
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.

Parameters:
[in]handleHandle to the library instance
[in]dSMdSIDDestination of the call
[in]DeviceIdSelect only this device.
[in]ValueValue to send to devices.
[in]timeouttime-out of the synchronous call (in Seconds)
[out]ReturnValueAnswer from the device
Returns:
0: success (return parameters are valid); <0: Library error; >0: dSM error code
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.

Parameters:
[in]handleHandle to the library instance
[in]dSMdSIDDestination dSM of the call
[in]ZoneIdSelect only devices in this zone.
[in]GroupIdSelect only devices in this group.
[in]ValueValue to send to devices.
Returns:
0: success (return parameters are valid); <0: Library error; >0: dSM error code
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.

Parameters:
[in]handleHandle to the library instance
[in]dSMdSIDDestination dSM of the call
[in]ZoneIdSelect only devices in this zone.
[in]GroupIdSelect only devices in this group.
[in]ValueValue to send to devices.
Returns:
0: success (return parameters are valid); <0: Library error; >0: dSM error code
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines