|
dsm-api-v2
|
|
dsm-api-v2
|
This group of API calls addresses zones and their properties. More...
Typedefs | |
| typedef void(* | ZoneCount_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
| Returns the number of configured zones on the dSM. | |
| typedef void(* | ZoneCount_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t ZoneCount) |
| Returns the number of configured zones on the dSM. | |
| typedef void(* | ZoneDeviceCount_all_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId) |
| Returns the number of devices in a zone. | |
| typedef void(* | ZoneDeviceCount_all_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t NumberOfDevices) |
| Returns the number of devices in a zone. | |
| typedef void(* | ZoneDeviceCount_only_active_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId) |
| Returns the number of active devices in a zone. | |
| typedef void(* | ZoneDeviceCount_only_active_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t NumberOfDevices) |
| Returns the number of active devices in a zone. | |
| typedef void(* | ZoneDeviceCount_only_inactive_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId) |
| Returns the number of inactive devices in a zone. | |
| typedef void(* | ZoneDeviceCount_only_inactive_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t NumberOfDevices) |
| Returns the number of inactive devices in a zone. | |
| typedef void(* | ZoneInfo_by_id_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneIdReq) |
| Get info about a zone. | |
| typedef void(* | ZoneInfo_by_id_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t VirtualZoneId, uint8_t NumberOfGroups, const uint8_t *Name) |
| Get info about a zone. | |
| typedef void(* | ZoneInfo_by_index_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t ZoneIndex) |
| Get info about a zone. | |
| typedef void(* | ZoneInfo_by_index_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t VirtualZoneId, uint8_t NumberOfGroups, const uint8_t *Name) |
| Get info about a zone. | |
| typedef void(* | ZoneModify_add_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId) |
| Create a new zone with the given zone ID. | |
| typedef void(* | ZoneModify_add_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
| Create a new zone with the given zone ID. | |
| typedef void(* | ZoneModify_change_id_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint16_t NewZoneId) |
| Change the zone ID of the zone. | |
| typedef void(* | ZoneModify_change_id_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
| Change the zone ID of the zone. | |
| typedef void(* | ZoneModify_remove_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId) |
| Remove zone with given zone ID. | |
| typedef void(* | ZoneModify_remove_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
| Remove zone with given zone ID. | |
| typedef void(* | ZoneProperties_get_scene_history_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId) |
| Returns the most recently called scenes in this zone in descending order (e.g. | |
| typedef void(* | ZoneProperties_get_scene_history_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t HistorySize, uint8_t GroupId_0, uint8_t Scene_0, uint8_t GroupId_1, uint8_t Scene_1, uint8_t GroupId_2, uint8_t Scene_2, uint8_t GroupId_3, uint8_t Scene_3, uint8_t GroupId_4, uint8_t Scene_4, uint8_t GroupId_5, uint8_t Scene_5, uint8_t GroupId_6, uint8_t Scene_6) |
| Returns the most recently called scenes in this zone in descending order (e.g. | |
| typedef void(* | ZoneProperties_set_name_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, const uint8_t *Name) |
| Set the name of the zone. | |
| typedef void(* | ZoneProperties_set_name_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
| Set the name of the zone. | |
Functions | |
| int | ZoneCount (DsmApiHandle_t handle, dsid_t dSMdSID, uint8_t *ZoneCount) |
| Returns the number of configured zones on the dSM. | |
| int | ZoneDeviceCount_all (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneId, uint16_t *NumberOfDevices) |
| Returns the number of devices in a zone. | |
| int | ZoneDeviceCount_only_active (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneId, uint16_t *NumberOfDevices) |
| Returns the number of active devices in a zone. | |
| int | ZoneDeviceCount_only_inactive (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneId, uint16_t *NumberOfDevices) |
| Returns the number of inactive devices in a zone. | |
| int | ZoneInfo_by_id (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneIdReq, uint16_t *ZoneId, uint8_t *VirtualZoneId, uint8_t *NumberOfGroups, uint8_t *Name) |
| Get info about a zone. | |
| int | ZoneInfo_by_index (DsmApiHandle_t handle, dsid_t dSMdSID, uint8_t ZoneIndex, uint16_t *ZoneId, uint8_t *VirtualZoneId, uint8_t *NumberOfGroups, uint8_t *Name) |
| Get info about a zone. | |
| int | ZoneModify_add (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneId) |
| Create a new zone with the given zone ID. | |
| int | ZoneModify_change_id (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneId, uint16_t NewZoneId) |
| Change the zone ID of the zone. | |
| int | ZoneModify_remove (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneId) |
| Remove zone with given zone ID. | |
| int | ZoneProperties_get_scene_history (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneId, uint8_t *HistorySize, uint8_t *GroupId_0, uint8_t *Scene_0, uint8_t *GroupId_1, uint8_t *Scene_1, uint8_t *GroupId_2, uint8_t *Scene_2, uint8_t *GroupId_3, uint8_t *Scene_3, uint8_t *GroupId_4, uint8_t *Scene_4, uint8_t *GroupId_5, uint8_t *Scene_5, uint8_t *GroupId_6, uint8_t *Scene_6) |
| Returns the most recently called scenes in this zone in descending order (e.g. | |
| int | ZoneProperties_set_name (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneId, const uint8_t *Name) |
| Set the name of the zone. | |
This group of API calls addresses zones and their properties.
| typedef void(* ZoneCount_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Returns the number of configured zones on the dSM.
Request callback function prototype for call ZoneCount.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = ZONE_COUNT and ModifierId = #0
| [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(* ZoneCount_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t ZoneCount) |
Returns the number of configured zones on the dSM.
Response callback function prototype for call ZoneCount.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = ZONE_COUNT and ModifierId = #0
| [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] | ZoneCount | Number of configured zones |
| typedef void(* ZoneDeviceCount_all_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId) |
Returns the number of devices in a zone.
Request callback function prototype for call ZoneDeviceCount_all.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = ZONE_DEVICE_COUNT and ModifierId = ZONE_DEVICE_COUNT_ALL
| [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 | Zone ID. |
| typedef void(* ZoneDeviceCount_all_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t NumberOfDevices) |
Returns the number of devices in a zone.
Response callback function prototype for call ZoneDeviceCount_all.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = ZONE_DEVICE_COUNT and ModifierId = ZONE_DEVICE_COUNT_ALL
| [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] | NumberOfDevices | Number of devices that are part of this zone. |
| typedef void(* ZoneDeviceCount_only_active_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId) |
Returns the number of active devices in a zone.
Request callback function prototype for call ZoneDeviceCount_only_active.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = ZONE_DEVICE_COUNT and ModifierId = ZONE_DEVICE_COUNT_ONLY_ACTIVE
| [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 | Zone ID. |
| typedef void(* ZoneDeviceCount_only_active_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t NumberOfDevices) |
Returns the number of active devices in a zone.
Response callback function prototype for call ZoneDeviceCount_only_active.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = ZONE_DEVICE_COUNT and ModifierId = ZONE_DEVICE_COUNT_ONLY_ACTIVE
| [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] | NumberOfDevices | Number of devices that are part of this zone. |
| typedef void(* ZoneDeviceCount_only_inactive_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId) |
Returns the number of inactive devices in a zone.
Request callback function prototype for call ZoneDeviceCount_only_inactive.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = ZONE_DEVICE_COUNT and ModifierId = ZONE_DEVICE_COUNT_ONLY_INACTIVE
| [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 | Zone ID. |
| typedef void(* ZoneDeviceCount_only_inactive_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t NumberOfDevices) |
Returns the number of inactive devices in a zone.
Response callback function prototype for call ZoneDeviceCount_only_inactive.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = ZONE_DEVICE_COUNT and ModifierId = ZONE_DEVICE_COUNT_ONLY_INACTIVE
| [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] | NumberOfDevices | Number of devices that are part of this zone. |
| typedef void(* ZoneInfo_by_id_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneIdReq) |
Get info about a zone.
Select the zone by its zone ID.
Request callback function prototype for call ZoneInfo_by_id.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = ZONE_INFO and ModifierId = ZONE_INFO_BY_ID
| [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] | ZoneIdReq | Zone ID. |
| typedef void(* ZoneInfo_by_id_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t VirtualZoneId, uint8_t NumberOfGroups, const uint8_t *Name) |
Get info about a zone.
Select the zone by its zone ID.
Response callback function prototype for call ZoneInfo_by_id.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = ZONE_INFO and ModifierId = ZONE_INFO_BY_ID
| [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 | Global zone ID. |
| [in] | VirtualZoneId | Local zone ID (VSK, local to the dSM). |
| [in] | NumberOfGroups | Number of groups configured in the zone. |
| [in] | Name | Name of the zone (21 character, zero terminated string). |
| typedef void(* ZoneInfo_by_index_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t ZoneIndex) |
Get info about a zone.
Select the zone by sequential index (0 based).
Request callback function prototype for call ZoneInfo_by_index.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = ZONE_INFO and ModifierId = ZONE_INFO_BY_INDEX
| [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] | ZoneIndex | Index of the zone (0-15). |
| typedef void(* ZoneInfo_by_index_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t VirtualZoneId, uint8_t NumberOfGroups, const uint8_t *Name) |
Get info about a zone.
Select the zone by sequential index (0 based).
Response callback function prototype for call ZoneInfo_by_index.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = ZONE_INFO and ModifierId = ZONE_INFO_BY_INDEX
| [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 | Global zone ID. |
| [in] | VirtualZoneId | Local zone ID (VSK, local to the dSM). |
| [in] | NumberOfGroups | Number of groups configured in the zone. |
| [in] | Name | Name of the zone (21 character, zero terminated string). |
| typedef void(* ZoneModify_add_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId) |
Create a new zone with the given zone ID.
Request callback function prototype for call ZoneModify_add.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = ZONE_MODIFY and ModifierId = ZONE_MODIFY_ADD
| [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 | Zone ID. |
| typedef void(* ZoneModify_add_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Create a new zone with the given zone ID.
Response callback function prototype for call ZoneModify_add.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = ZONE_MODIFY and ModifierId = ZONE_MODIFY_ADD
| [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(* ZoneModify_change_id_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint16_t NewZoneId) |
Change the zone ID of the zone.
Request callback function prototype for call ZoneModify_change_id.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = ZONE_MODIFY and ModifierId = ZONE_MODIFY_CHANGE_ID
| [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 | Zone ID. |
| [in] | NewZoneId | New zone ID. |
| typedef void(* ZoneModify_change_id_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Change the zone ID of the zone.
Response callback function prototype for call ZoneModify_change_id.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = ZONE_MODIFY and ModifierId = ZONE_MODIFY_CHANGE_ID
| [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(* ZoneModify_remove_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId) |
Remove zone with given zone ID.
Removing a zone is only possible if no devices are currently part of the zone.
Request callback function prototype for call ZoneModify_remove.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = ZONE_MODIFY and ModifierId = ZONE_MODIFY_REMOVE
| [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 | Zone ID. |
| typedef void(* ZoneModify_remove_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Remove zone with given zone ID.
Removing a zone is only possible if no devices are currently part of the zone.
Response callback function prototype for call ZoneModify_remove.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = ZONE_MODIFY and ModifierId = ZONE_MODIFY_REMOVE
| [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(* ZoneProperties_get_scene_history_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId) |
Returns the most recently called scenes in this zone in descending order (e.g.
Scene_0 is newest, Scene_6 is oldest).
Request callback function prototype for call ZoneProperties_get_scene_history.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = ZONE_PROPERTIES and ModifierId = ZONE_PROPERTIES_GET_SCENE_HISTORY
| [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 | Zone ID. |
| typedef void(* ZoneProperties_get_scene_history_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t HistorySize, uint8_t GroupId_0, uint8_t Scene_0, uint8_t GroupId_1, uint8_t Scene_1, uint8_t GroupId_2, uint8_t Scene_2, uint8_t GroupId_3, uint8_t Scene_3, uint8_t GroupId_4, uint8_t Scene_4, uint8_t GroupId_5, uint8_t Scene_5, uint8_t GroupId_6, uint8_t Scene_6) |
Returns the most recently called scenes in this zone in descending order (e.g.
Scene_0 is newest, Scene_6 is oldest).
Response callback function prototype for call ZoneProperties_get_scene_history.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = ZONE_PROPERTIES and ModifierId = ZONE_PROPERTIES_GET_SCENE_HISTORY
| [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] | HistorySize | Number of valid history steps (0-7). |
| [in] | GroupId_0 | Bits 0-5: Group ID of the scene call, Bit 6: Set if call was 'Force_call_scene', Bit 7: Set if call was 'undo_scene_number'. |
| [in] | Scene_0 | Scene ID of the scene call. |
| [in] | GroupId_1 | See GroupId_0. |
| [in] | Scene_1 | See Scene_0. |
| [in] | GroupId_2 | See GroupId_0. |
| [in] | Scene_2 | See Scene_0. |
| [in] | GroupId_3 | See GroupId_0. |
| [in] | Scene_3 | See Scene_0. |
| [in] | GroupId_4 | See GroupId_0. |
| [in] | Scene_4 | See Scene_0. |
| [in] | GroupId_5 | See GroupId_0. |
| [in] | Scene_5 | See Scene_0. |
| [in] | GroupId_6 | See GroupId_0. |
| [in] | Scene_6 | See Scene_0. |
| typedef void(* ZoneProperties_set_name_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, const uint8_t *Name) |
Set the name of the zone.
Request callback function prototype for call ZoneProperties_set_name.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = ZONE_PROPERTIES and ModifierId = ZONE_PROPERTIES_SET_NAME
| [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 | Zone ID. |
| [in] | Name | Name of the zone (21 character, zero terminated string). |
| typedef void(* ZoneProperties_set_name_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Set the name of the zone.
Response callback function prototype for call ZoneProperties_set_name.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = ZONE_PROPERTIES and ModifierId = ZONE_PROPERTIES_SET_NAME
| [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 ZoneCount | ( | DsmApiHandle_t | handle, |
| dsid_t | dSMdSID, | ||
| uint8_t * | ZoneCount | ||
| ) |
Returns the number of configured zones on the dSM.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ZoneCount_response_callback_t callback. To receive this request from other bus members register the ZoneCount_request_callback_t callback.
| [in] | handle | Handle to the library instance |
| [in] | dSMdSID | Destination dSM of the call |
| [out] | ZoneCount | Number of configured zones |
| int ZoneDeviceCount_all | ( | DsmApiHandle_t | handle, |
| dsid_t | dSMdSID, | ||
| uint16_t | ZoneId, | ||
| uint16_t * | NumberOfDevices | ||
| ) |
Returns the number of devices in a zone.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ZoneDeviceCount_all_response_callback_t callback. To receive this request from other bus members register the ZoneDeviceCount_all_request_callback_t callback.
| [in] | handle | Handle to the library instance |
| [in] | dSMdSID | Destination dSM of the call |
| [in] | ZoneId | Zone ID. |
| [out] | NumberOfDevices | Number of devices that are part of this zone. |
| int ZoneDeviceCount_only_active | ( | DsmApiHandle_t | handle, |
| dsid_t | dSMdSID, | ||
| uint16_t | ZoneId, | ||
| uint16_t * | NumberOfDevices | ||
| ) |
Returns the number of active devices in a zone.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ZoneDeviceCount_only_active_response_callback_t callback. To receive this request from other bus members register the ZoneDeviceCount_only_active_request_callback_t callback.
| [in] | handle | Handle to the library instance |
| [in] | dSMdSID | Destination dSM of the call |
| [in] | ZoneId | Zone ID. |
| [out] | NumberOfDevices | Number of devices that are part of this zone. |
| int ZoneDeviceCount_only_inactive | ( | DsmApiHandle_t | handle, |
| dsid_t | dSMdSID, | ||
| uint16_t | ZoneId, | ||
| uint16_t * | NumberOfDevices | ||
| ) |
Returns the number of inactive devices in a zone.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ZoneDeviceCount_only_inactive_response_callback_t callback. To receive this request from other bus members register the ZoneDeviceCount_only_inactive_request_callback_t callback.
| [in] | handle | Handle to the library instance |
| [in] | dSMdSID | Destination dSM of the call |
| [in] | ZoneId | Zone ID. |
| [out] | NumberOfDevices | Number of devices that are part of this zone. |
| int ZoneInfo_by_id | ( | DsmApiHandle_t | handle, |
| dsid_t | dSMdSID, | ||
| uint16_t | ZoneIdReq, | ||
| uint16_t * | ZoneId, | ||
| uint8_t * | VirtualZoneId, | ||
| uint8_t * | NumberOfGroups, | ||
| uint8_t * | Name | ||
| ) |
Get info about a zone.
Select the zone by its zone ID.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ZoneInfo_by_id_response_callback_t callback. To receive this request from other bus members register the ZoneInfo_by_id_request_callback_t callback.
| [in] | handle | Handle to the library instance |
| [in] | dSMdSID | Destination dSM of the call |
| [in] | ZoneIdReq | Zone ID. |
| [out] | ZoneId | Global zone ID. |
| [out] | VirtualZoneId | Local zone ID (VSK, local to the dSM). |
| [out] | NumberOfGroups | Number of groups configured in the zone. |
| [out] | Name | Name of the zone (21 character, zero terminated string). (pass a reference to a preallocated buffer of at least 21 bytes.) |
| int ZoneInfo_by_index | ( | DsmApiHandle_t | handle, |
| dsid_t | dSMdSID, | ||
| uint8_t | ZoneIndex, | ||
| uint16_t * | ZoneId, | ||
| uint8_t * | VirtualZoneId, | ||
| uint8_t * | NumberOfGroups, | ||
| uint8_t * | Name | ||
| ) |
Get info about a zone.
Select the zone by sequential index (0 based).
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ZoneInfo_by_index_response_callback_t callback. To receive this request from other bus members register the ZoneInfo_by_index_request_callback_t callback.
| [in] | handle | Handle to the library instance |
| [in] | dSMdSID | Destination dSM of the call |
| [in] | ZoneIndex | Index of the zone (0-15). |
| [out] | ZoneId | Global zone ID. |
| [out] | VirtualZoneId | Local zone ID (VSK, local to the dSM). |
| [out] | NumberOfGroups | Number of groups configured in the zone. |
| [out] | Name | Name of the zone (21 character, zero terminated string). (pass a reference to a preallocated buffer of at least 21 bytes.) |
| int ZoneModify_add | ( | DsmApiHandle_t | handle, |
| dsid_t | dSMdSID, | ||
| uint16_t | ZoneId | ||
| ) |
Create a new zone with the given zone ID.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ZoneModify_add_response_callback_t callback. To receive this request from other bus members register the ZoneModify_add_request_callback_t callback.
| [in] | handle | Handle to the library instance |
| [in] | dSMdSID | Destination dSM of the call |
| [in] | ZoneId | Zone ID. |
| int ZoneModify_change_id | ( | DsmApiHandle_t | handle, |
| dsid_t | dSMdSID, | ||
| uint16_t | ZoneId, | ||
| uint16_t | NewZoneId | ||
| ) |
Change the zone ID of the zone.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ZoneModify_change_id_response_callback_t callback. To receive this request from other bus members register the ZoneModify_change_id_request_callback_t callback.
| [in] | handle | Handle to the library instance |
| [in] | dSMdSID | Destination dSM of the call |
| [in] | ZoneId | Zone ID. |
| [in] | NewZoneId | New zone ID. |
| int ZoneModify_remove | ( | DsmApiHandle_t | handle, |
| dsid_t | dSMdSID, | ||
| uint16_t | ZoneId | ||
| ) |
Remove zone with given zone ID.
Removing a zone is only possible if no devices are currently part of the zone.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ZoneModify_remove_response_callback_t callback. To receive this request from other bus members register the ZoneModify_remove_request_callback_t callback.
| [in] | handle | Handle to the library instance |
| [in] | dSMdSID | Destination dSM of the call |
| [in] | ZoneId | Zone ID. |
| int ZoneProperties_get_scene_history | ( | DsmApiHandle_t | handle, |
| dsid_t | dSMdSID, | ||
| uint16_t | ZoneId, | ||
| uint8_t * | HistorySize, | ||
| uint8_t * | GroupId_0, | ||
| uint8_t * | Scene_0, | ||
| uint8_t * | GroupId_1, | ||
| uint8_t * | Scene_1, | ||
| uint8_t * | GroupId_2, | ||
| uint8_t * | Scene_2, | ||
| uint8_t * | GroupId_3, | ||
| uint8_t * | Scene_3, | ||
| uint8_t * | GroupId_4, | ||
| uint8_t * | Scene_4, | ||
| uint8_t * | GroupId_5, | ||
| uint8_t * | Scene_5, | ||
| uint8_t * | GroupId_6, | ||
| uint8_t * | Scene_6 | ||
| ) |
Returns the most recently called scenes in this zone in descending order (e.g.
Scene_0 is newest, Scene_6 is oldest).
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ZoneProperties_get_scene_history_response_callback_t callback. To receive this request from other bus members register the ZoneProperties_get_scene_history_request_callback_t callback.
| [in] | handle | Handle to the library instance |
| [in] | dSMdSID | Destination dSM of the call |
| [in] | ZoneId | Zone ID. |
| [out] | HistorySize | Number of valid history steps (0-7). |
| [out] | GroupId_0 | Bits 0-5: Group ID of the scene call, Bit 6: Set if call was 'Force_call_scene', Bit 7: Set if call was 'undo_scene_number'. |
| [out] | Scene_0 | Scene ID of the scene call. |
| [out] | GroupId_1 | See GroupId_0. |
| [out] | Scene_1 | See Scene_0. |
| [out] | GroupId_2 | See GroupId_0. |
| [out] | Scene_2 | See Scene_0. |
| [out] | GroupId_3 | See GroupId_0. |
| [out] | Scene_3 | See Scene_0. |
| [out] | GroupId_4 | See GroupId_0. |
| [out] | Scene_4 | See Scene_0. |
| [out] | GroupId_5 | See GroupId_0. |
| [out] | Scene_5 | See Scene_0. |
| [out] | GroupId_6 | See GroupId_0. |
| [out] | Scene_6 | See Scene_0. |
| int ZoneProperties_set_name | ( | DsmApiHandle_t | handle, |
| dsid_t | dSMdSID, | ||
| uint16_t | ZoneId, | ||
| const uint8_t * | Name | ||
| ) |
Set the name of the zone.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ZoneProperties_set_name_response_callback_t callback. To receive this request from other bus members register the ZoneProperties_set_name_request_callback_t callback.
| [in] | handle | Handle to the library instance |
| [in] | dSMdSID | Destination dSM of the call |
| [in] | ZoneId | Zone ID. |
| [in] | Name | Name of the zone (21 character, zero terminated string). |
1.7.6.1
