Scene

This group of API calls addresses scenes and their properties. More...

Typedefs
typedef void(*	ZoneGroupActionRequest_action_blink_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId)
	Execute actions on all devices of a zone/group.
typedef void(*	ZoneGroupActionRequest_action_blink_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Execute actions on all devices of a zone/group.
typedef void(*	ZoneGroupActionRequest_action_call_scene_min_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId, uint8_t SceneId)
	Execute actions on all devices of a zone/group.
typedef void(*	ZoneGroupActionRequest_action_call_scene_min_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Execute actions on all devices of a zone/group.
typedef void(*	ZoneGroupActionRequest_action_call_scene_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId, uint8_t SceneId)
	Execute actions on all devices of a zone/group.
typedef void(*	ZoneGroupActionRequest_action_call_scene_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Execute actions on all devices of a zone/group.
typedef void(*	ZoneGroupActionRequest_action_force_call_scene_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId, uint8_t SceneId)
	Execute actions on all devices of a zone/group.
typedef void(*	ZoneGroupActionRequest_action_force_call_scene_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Execute actions on all devices of a zone/group.
typedef void(*	ZoneGroupActionRequest_action_local_stop_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId)
	Execute actions on all devices of a zone/group.
typedef void(*	ZoneGroupActionRequest_action_local_stop_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Execute actions on all devices of a zone/group.
typedef void(*	ZoneGroupActionRequest_action_programming_mode_off_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId)
	Execute actions on all devices of a zone/group.
typedef void(*	ZoneGroupActionRequest_action_programming_mode_off_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Execute actions on all devices of a zone/group.
typedef void(*	ZoneGroupActionRequest_action_programming_mode_on_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId)
	Execute actions on all devices of a zone/group.
typedef void(*	ZoneGroupActionRequest_action_programming_mode_on_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Execute actions on all devices of a zone/group.
typedef void(*	ZoneGroupActionRequest_action_register_scene_local_priority_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId, uint8_t SceneId)
	Execute actions on all devices of a zone/group.
typedef void(*	ZoneGroupActionRequest_action_register_scene_local_priority_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Execute actions on all devices of a zone/group.
typedef void(*	ZoneGroupActionRequest_action_save_scene_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId, uint8_t SceneId)
	Execute actions on all devices of a zone/group.
typedef void(*	ZoneGroupActionRequest_action_save_scene_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Execute actions on all devices of a zone/group.
typedef void(*	ZoneGroupActionRequest_action_select_group_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId)
	Execute actions on all devices of a zone/group.
typedef void(*	ZoneGroupActionRequest_action_select_group_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Execute actions on all devices of a zone/group.
typedef void(*	ZoneGroupActionRequest_action_set_outval_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId, uint8_t Value)
	Execute actions on all devices of a zone/group.
typedef void(*	ZoneGroupActionRequest_action_set_outval_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Execute actions on all devices of a zone/group.
typedef void(*	ZoneGroupActionRequest_action_set_scene_local_priority_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId, uint8_t SceneId)
	Execute actions on all devices of a zone/group.
typedef void(*	ZoneGroupActionRequest_action_set_scene_local_priority_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Execute actions on all devices of a zone/group.
typedef void(*	ZoneGroupActionRequest_action_undo_scene_number_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId, uint8_t SceneId)
	Execute actions on all devices of a zone/group.
typedef void(*	ZoneGroupActionRequest_action_undo_scene_number_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Execute actions on all devices of a zone/group.
typedef void(*	ZoneGroupActionRequest_action_undo_scene_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId)
	Execute actions on all devices of a zone/group.
typedef void(*	ZoneGroupActionRequest_action_undo_scene_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Execute actions on all devices of a zone/group.
typedef void(*	ZoneGroupSceneInfo_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint8_t SceneId)
	Returns the properties of a scene.
typedef void(*	ZoneGroupSceneInfo_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, const uint8_t *Name)
	Returns the properties of a scene.
typedef void(*	ZoneGroupSceneProperties_set_name_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint8_t SceneId, const uint8_t *Name)
	Set the name of a scene.
typedef void(*	ZoneGroupSceneProperties_set_name_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Set the name of a scene.
typedef void(*	ZoneSensorPush_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint32_t SourceDevice, uint8_t SensorType, uint16_t Value, uint8_t Precision)
	Distribute sensor values to devices.
typedef void(*	ZoneSensorPush_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Distribute sensor values to devices.
Functions
int	ZoneGroupActionRequest_action_blink (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId)
	Execute actions on all devices of a zone/group.
int	ZoneGroupActionRequest_action_call_scene (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId, uint8_t SceneId)
	Execute actions on all devices of a zone/group.
int	ZoneGroupActionRequest_action_call_scene_min (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId, uint8_t SceneId)
	Execute actions on all devices of a zone/group.
int	ZoneGroupActionRequest_action_force_call_scene (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId, uint8_t SceneId)
	Execute actions on all devices of a zone/group.
int	ZoneGroupActionRequest_action_local_stop (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId)
	Execute actions on all devices of a zone/group.
int	ZoneGroupActionRequest_action_programming_mode_off (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId)
	Execute actions on all devices of a zone/group.
int	ZoneGroupActionRequest_action_programming_mode_on (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId)
	Execute actions on all devices of a zone/group.
int	ZoneGroupActionRequest_action_register_scene_local_priority (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId, uint8_t SceneId)
	Execute actions on all devices of a zone/group.
int	ZoneGroupActionRequest_action_save_scene (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId, uint8_t SceneId)
	Execute actions on all devices of a zone/group.
int	ZoneGroupActionRequest_action_select_group (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId)
	Execute actions on all devices of a zone/group.
int	ZoneGroupActionRequest_action_set_outval (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId, uint8_t Value)
	Execute actions on all devices of a zone/group.
int	ZoneGroupActionRequest_action_set_scene_local_priority (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId, uint8_t SceneId)
	Execute actions on all devices of a zone/group.
int	ZoneGroupActionRequest_action_undo_scene (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId)
	Execute actions on all devices of a zone/group.
int	ZoneGroupActionRequest_action_undo_scene_number (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId, uint8_t SceneId)
	Execute actions on all devices of a zone/group.
int	ZoneGroupSceneInfo (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneId, uint8_t GroupId, uint8_t SceneId, uint8_t *Name)
	Returns the properties of a scene.
int	ZoneGroupSceneProperties_set_name (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneId, uint8_t GroupId, uint8_t SceneId, const uint8_t *Name)
	Set the name of a scene.
int	ZoneSensorPush (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneId, uint32_t SourceDevice, uint8_t SensorType, uint16_t Value, uint8_t Precision)
	Distribute sensor values to devices.

---

Detailed Description

This group of API calls addresses scenes and their properties.

---

Typedef Documentation

typedef void(* ZoneGroupActionRequest_action_blink_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId)

Execute actions on all devices of a zone/group.

Let all devices of the zone/group blink their load.

Request callback function prototype for call ZoneGroupActionRequest_action_blink.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = ZONE_GROUP_ACTION_REQUEST and ModifierId = ZONE_GROUP_ACTION_REQUEST_ACTION_BLINK

Parameters:

[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]	GroupId	Group ID.
[in]	OriginDeviceId	Device ID of the origin device (0 if unknown).

typedef void(* ZoneGroupActionRequest_action_blink_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Execute actions on all devices of a zone/group.

Let all devices of the zone/group blink their load.

Response callback function prototype for call ZoneGroupActionRequest_action_blink.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = ZONE_GROUP_ACTION_REQUEST and ModifierId = ZONE_GROUP_ACTION_REQUEST_ACTION_BLINK

Parameters:

[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(* ZoneGroupActionRequest_action_call_scene_min_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId, uint8_t SceneId)

Execute actions on all devices of a zone/group.

Prepare the devices for dimming from zero.

Request callback function prototype for call ZoneGroupActionRequest_action_call_scene_min.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = ZONE_GROUP_ACTION_REQUEST and ModifierId = ZONE_GROUP_ACTION_REQUEST_ACTION_CALL_SCENE_MIN

Parameters:

[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]	GroupId	Group ID.
[in]	OriginDeviceId	Device ID of the origin device (0 if unknown).
[in]	SceneId	Scene ID.

typedef void(* ZoneGroupActionRequest_action_call_scene_min_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Execute actions on all devices of a zone/group.

Prepare the devices for dimming from zero.

Response callback function prototype for call ZoneGroupActionRequest_action_call_scene_min.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = ZONE_GROUP_ACTION_REQUEST and ModifierId = ZONE_GROUP_ACTION_REQUEST_ACTION_CALL_SCENE_MIN

Parameters:

[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(* ZoneGroupActionRequest_action_call_scene_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId, uint8_t SceneId)

Execute actions on all devices of a zone/group.

Call a scene.

Request callback function prototype for call ZoneGroupActionRequest_action_call_scene.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = ZONE_GROUP_ACTION_REQUEST and ModifierId = ZONE_GROUP_ACTION_REQUEST_ACTION_CALL_SCENE

Parameters:

[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]	GroupId	Group ID.
[in]	OriginDeviceId	Device ID of the origin device (0 if unknown).
[in]	SceneId	Scene ID.

typedef void(* ZoneGroupActionRequest_action_call_scene_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Execute actions on all devices of a zone/group.

Call a scene.

Response callback function prototype for call ZoneGroupActionRequest_action_call_scene.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = ZONE_GROUP_ACTION_REQUEST and ModifierId = ZONE_GROUP_ACTION_REQUEST_ACTION_CALL_SCENE

Parameters:

[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(* ZoneGroupActionRequest_action_force_call_scene_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId, uint8_t SceneId)

Execute actions on all devices of a zone/group.

Call a scene in the zone/group. Overwrite any locally selected state.

Request callback function prototype for call ZoneGroupActionRequest_action_force_call_scene.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = ZONE_GROUP_ACTION_REQUEST and ModifierId = ZONE_GROUP_ACTION_REQUEST_ACTION_FORCE_CALL_SCENE

Parameters:

[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]	GroupId	Group ID.
[in]	OriginDeviceId	Device ID of the origin device (0 if unknown).
[in]	SceneId	Scene ID.

typedef void(* ZoneGroupActionRequest_action_force_call_scene_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Execute actions on all devices of a zone/group.

Call a scene in the zone/group. Overwrite any locally selected state.

Response callback function prototype for call ZoneGroupActionRequest_action_force_call_scene.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = ZONE_GROUP_ACTION_REQUEST and ModifierId = ZONE_GROUP_ACTION_REQUEST_ACTION_FORCE_CALL_SCENE

Parameters:

[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(* ZoneGroupActionRequest_action_local_stop_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId)

Execute actions on all devices of a zone/group.

A device has reached its final position during calibration mode.

Request callback function prototype for call ZoneGroupActionRequest_action_local_stop.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = ZONE_GROUP_ACTION_REQUEST and ModifierId = ZONE_GROUP_ACTION_REQUEST_ACTION_LOCAL_STOP

Parameters:

[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]	GroupId	Group ID.
[in]	OriginDeviceId	Device ID of the origin device (0 if unknown).

typedef void(* ZoneGroupActionRequest_action_local_stop_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Execute actions on all devices of a zone/group.

A device has reached its final position during calibration mode.

Response callback function prototype for call ZoneGroupActionRequest_action_local_stop.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = ZONE_GROUP_ACTION_REQUEST and ModifierId = ZONE_GROUP_ACTION_REQUEST_ACTION_LOCAL_STOP

Parameters:

[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(* ZoneGroupActionRequest_action_programming_mode_off_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId)

Execute actions on all devices of a zone/group.

Finish programming mode.

Request callback function prototype for call ZoneGroupActionRequest_action_programming_mode_off.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = ZONE_GROUP_ACTION_REQUEST and ModifierId = ZONE_GROUP_ACTION_REQUEST_ACTION_PROGRAMMING_MODE_OFF

Parameters:

[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]	GroupId	Group ID.
[in]	OriginDeviceId	Device ID of the origin device (0 if unknown).

typedef void(* ZoneGroupActionRequest_action_programming_mode_off_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Execute actions on all devices of a zone/group.

Finish programming mode.

Response callback function prototype for call ZoneGroupActionRequest_action_programming_mode_off.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = ZONE_GROUP_ACTION_REQUEST and ModifierId = ZONE_GROUP_ACTION_REQUEST_ACTION_PROGRAMMING_MODE_OFF

Parameters:

[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(* ZoneGroupActionRequest_action_programming_mode_on_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId)

Execute actions on all devices of a zone/group.

Start Programming mode.

Request callback function prototype for call ZoneGroupActionRequest_action_programming_mode_on.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = ZONE_GROUP_ACTION_REQUEST and ModifierId = ZONE_GROUP_ACTION_REQUEST_ACTION_PROGRAMMING_MODE_ON

Parameters:

[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]	GroupId	Group ID.
[in]	OriginDeviceId	Device ID of the origin device (0 if unknown).

typedef void(* ZoneGroupActionRequest_action_programming_mode_on_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Execute actions on all devices of a zone/group.

Start Programming mode.

Response callback function prototype for call ZoneGroupActionRequest_action_programming_mode_on.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = ZONE_GROUP_ACTION_REQUEST and ModifierId = ZONE_GROUP_ACTION_REQUEST_ACTION_PROGRAMMING_MODE_ON

Parameters:

[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(* ZoneGroupActionRequest_action_register_scene_local_priority_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId, uint8_t SceneId)

Execute actions on all devices of a zone/group.

Register local priority.

Request callback function prototype for call ZoneGroupActionRequest_action_register_scene_local_priority.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = ZONE_GROUP_ACTION_REQUEST and ModifierId = ZONE_GROUP_ACTION_REQUEST_ACTION_REGISTER_SCENE_LOCAL_PRIORITY

Parameters:

[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]	GroupId	Group ID.
[in]	OriginDeviceId	Device ID of the origin device (0 if unknown).
[in]	SceneId	Scene ID.

typedef void(* ZoneGroupActionRequest_action_register_scene_local_priority_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Execute actions on all devices of a zone/group.

Register local priority.

Response callback function prototype for call ZoneGroupActionRequest_action_register_scene_local_priority.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = ZONE_GROUP_ACTION_REQUEST and ModifierId = ZONE_GROUP_ACTION_REQUEST_ACTION_REGISTER_SCENE_LOCAL_PRIORITY

Parameters:

[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(* ZoneGroupActionRequest_action_save_scene_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId, uint8_t SceneId)

Execute actions on all devices of a zone/group.

Save the current state in given scene.

Request callback function prototype for call ZoneGroupActionRequest_action_save_scene.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = ZONE_GROUP_ACTION_REQUEST and ModifierId = ZONE_GROUP_ACTION_REQUEST_ACTION_SAVE_SCENE

Parameters:

[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]	GroupId	Group ID.
[in]	OriginDeviceId	Device ID of the origin device (0 if unknown).
[in]	SceneId	Scene ID.

typedef void(* ZoneGroupActionRequest_action_save_scene_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Execute actions on all devices of a zone/group.

Save the current state in given scene.

Response callback function prototype for call ZoneGroupActionRequest_action_save_scene.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = ZONE_GROUP_ACTION_REQUEST and ModifierId = ZONE_GROUP_ACTION_REQUEST_ACTION_SAVE_SCENE

Parameters:

[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(* ZoneGroupActionRequest_action_select_group_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId)

Execute actions on all devices of a zone/group.

Preselect the group in this zone.

Request callback function prototype for call ZoneGroupActionRequest_action_select_group.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = ZONE_GROUP_ACTION_REQUEST and ModifierId = ZONE_GROUP_ACTION_REQUEST_ACTION_SELECT_GROUP

Parameters:

[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]	GroupId	Group ID.
[in]	OriginDeviceId	Device ID of the origin device (0 if unknown).

typedef void(* ZoneGroupActionRequest_action_select_group_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Execute actions on all devices of a zone/group.

Preselect the group in this zone.

Response callback function prototype for call ZoneGroupActionRequest_action_select_group.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = ZONE_GROUP_ACTION_REQUEST and ModifierId = ZONE_GROUP_ACTION_REQUEST_ACTION_SELECT_GROUP

Parameters:

[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(* ZoneGroupActionRequest_action_set_outval_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId, uint8_t Value)

Execute actions on all devices of a zone/group.

Set the output to the given value independent of any scene configurations.

Request callback function prototype for call ZoneGroupActionRequest_action_set_outval.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = ZONE_GROUP_ACTION_REQUEST and ModifierId = ZONE_GROUP_ACTION_REQUEST_ACTION_SET_OUTVAL

Parameters:

[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]	GroupId	Group ID.
[in]	OriginDeviceId	Device ID of the origin device (0 if unknown).
[in]	Value	Output value (0-255).

typedef void(* ZoneGroupActionRequest_action_set_outval_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Execute actions on all devices of a zone/group.

Set the output to the given value independent of any scene configurations.

Response callback function prototype for call ZoneGroupActionRequest_action_set_outval.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = ZONE_GROUP_ACTION_REQUEST and ModifierId = ZONE_GROUP_ACTION_REQUEST_ACTION_SET_OUTVAL

Parameters:

[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(* ZoneGroupActionRequest_action_set_scene_local_priority_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId, uint8_t SceneId)

Execute actions on all devices of a zone/group.

Set local priority on all devices that have #SceneId active.

Request callback function prototype for call ZoneGroupActionRequest_action_set_scene_local_priority.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = ZONE_GROUP_ACTION_REQUEST and ModifierId = ZONE_GROUP_ACTION_REQUEST_ACTION_SET_SCENE_LOCAL_PRIORITY

Parameters:

[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]	GroupId	Group ID.
[in]	OriginDeviceId	Device ID of the origin device (0 if unknown).
[in]	SceneId	Scene ID.

typedef void(* ZoneGroupActionRequest_action_set_scene_local_priority_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Execute actions on all devices of a zone/group.

Set local priority on all devices that have #SceneId active.

Response callback function prototype for call ZoneGroupActionRequest_action_set_scene_local_priority.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = ZONE_GROUP_ACTION_REQUEST and ModifierId = ZONE_GROUP_ACTION_REQUEST_ACTION_SET_SCENE_LOCAL_PRIORITY

Parameters:

[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(* ZoneGroupActionRequest_action_undo_scene_number_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId, uint8_t SceneId)

Execute actions on all devices of a zone/group.

Instruct the devices to undo the last scene call if it was the scene with the given scene ID.

Request callback function prototype for call ZoneGroupActionRequest_action_undo_scene_number.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = ZONE_GROUP_ACTION_REQUEST and ModifierId = ZONE_GROUP_ACTION_REQUEST_ACTION_UNDO_SCENE_NUMBER

Parameters:

[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]	GroupId	Group ID.
[in]	OriginDeviceId	Device ID of the origin device (0 if unknown).
[in]	SceneId	Scene ID.

typedef void(* ZoneGroupActionRequest_action_undo_scene_number_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Execute actions on all devices of a zone/group.

Instruct the devices to undo the last scene call if it was the scene with the given scene ID.

Response callback function prototype for call ZoneGroupActionRequest_action_undo_scene_number.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = ZONE_GROUP_ACTION_REQUEST and ModifierId = ZONE_GROUP_ACTION_REQUEST_ACTION_UNDO_SCENE_NUMBER

Parameters:

[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(* ZoneGroupActionRequest_action_undo_scene_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint16_t OriginDeviceId)

Execute actions on all devices of a zone/group.

Instruct the devices to undo the last scene call.

Request callback function prototype for call ZoneGroupActionRequest_action_undo_scene.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = ZONE_GROUP_ACTION_REQUEST and ModifierId = ZONE_GROUP_ACTION_REQUEST_ACTION_UNDO_SCENE

Parameters:

[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]	GroupId	Group ID.
[in]	OriginDeviceId	Device ID of the origin device (0 if unknown).

typedef void(* ZoneGroupActionRequest_action_undo_scene_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Execute actions on all devices of a zone/group.

Instruct the devices to undo the last scene call.

Response callback function prototype for call ZoneGroupActionRequest_action_undo_scene.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = ZONE_GROUP_ACTION_REQUEST and ModifierId = ZONE_GROUP_ACTION_REQUEST_ACTION_UNDO_SCENE

Parameters:

[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(* ZoneGroupSceneInfo_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint8_t SceneId)

Returns the properties of a scene.

Request callback function prototype for call ZoneGroupSceneInfo.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = ZONE_GROUP_SCENE_INFO and ModifierId = #0

Parameters:

[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]	GroupId	Group ID.
[in]	SceneId	Scene ID.

typedef void(* ZoneGroupSceneInfo_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, const uint8_t *Name)

Returns the properties of a scene.

Response callback function prototype for call ZoneGroupSceneInfo.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = ZONE_GROUP_SCENE_INFO and ModifierId = #0

Parameters:

[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]	Name	The name of this scene (21 character, zero terminated string).

typedef void(* ZoneGroupSceneProperties_set_name_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint8_t GroupId, uint8_t SceneId, const uint8_t *Name)

Set the name of a scene.

Request callback function prototype for call ZoneGroupSceneProperties_set_name.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = ZONE_GROUP_SCENE_PROPERTIES and ModifierId = ZONE_GROUP_SCENE_PROPERTIES_SET_NAME

Parameters:

[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]	GroupId	Group ID.
[in]	SceneId	Scene ID.
[in]	Name	The new name of this scene (21 character, zero terminated string).

typedef void(* ZoneGroupSceneProperties_set_name_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Set the name of a scene.

Response callback function prototype for call ZoneGroupSceneProperties_set_name.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = ZONE_GROUP_SCENE_PROPERTIES and ModifierId = ZONE_GROUP_SCENE_PROPERTIES_SET_NAME

Parameters:

[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(* ZoneSensorPush_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneId, uint32_t SourceDevice, uint8_t SensorType, uint16_t Value, uint8_t Precision)

Distribute sensor values to devices.

Request callback function prototype for call ZoneSensorPush.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = ZONE_SENSOR_PUSH and ModifierId = #0

Parameters:

[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]	SourceDevice	dSID of sensor value source device. A DSID of 0 overrides the setting in the Push table and sends out the value in any case.
[in]	SensorType	Type of sensor value.
[in]	Value	12-bit sensor value.
[in]	Precision	0=use bits 11:2, 1=use bits 9:0 for push.

typedef void(* ZoneSensorPush_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Distribute sensor values to devices.

Response callback function prototype for call ZoneSensorPush.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = ZONE_SENSOR_PUSH and ModifierId = #0

Parameters:

[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

---

Function Documentation

int ZoneGroupActionRequest_action_blink	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint16_t	ZoneId,
		uint8_t	GroupId,
		uint16_t	OriginDeviceId
	)

Execute actions on all devices of a zone/group.

Let all devices of the zone/group blink their load.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ZoneGroupActionRequest_action_blink_response_callback_t callback. To receive this request from other bus members register the ZoneGroupActionRequest_action_blink_request_callback_t callback.

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	ZoneId	Zone ID.
[in]	GroupId	Group ID.
[in]	OriginDeviceId	Device ID of the origin device (0 if unknown).

Returns:

0: success (return parameters are valid); <0: Library error; >0: dSM error code

int ZoneGroupActionRequest_action_call_scene	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint16_t	ZoneId,
		uint8_t	GroupId,
		uint16_t	OriginDeviceId,
		uint8_t	SceneId
	)

Execute actions on all devices of a zone/group.

Call a scene.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ZoneGroupActionRequest_action_call_scene_response_callback_t callback. To receive this request from other bus members register the ZoneGroupActionRequest_action_call_scene_request_callback_t callback.

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	ZoneId	Zone ID.
[in]	GroupId	Group ID.
[in]	OriginDeviceId	Device ID of the origin device (0 if unknown).
[in]	SceneId	Scene ID.

Returns:

0: success (return parameters are valid); <0: Library error; >0: dSM error code

int ZoneGroupActionRequest_action_call_scene_min	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint16_t	ZoneId,
		uint8_t	GroupId,
		uint16_t	OriginDeviceId,
		uint8_t	SceneId
	)

Execute actions on all devices of a zone/group.

Prepare the devices for dimming from zero.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ZoneGroupActionRequest_action_call_scene_min_response_callback_t callback. To receive this request from other bus members register the ZoneGroupActionRequest_action_call_scene_min_request_callback_t callback.

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	ZoneId	Zone ID.
[in]	GroupId	Group ID.
[in]	OriginDeviceId	Device ID of the origin device (0 if unknown).
[in]	SceneId	Scene ID.

Returns:

0: success (return parameters are valid); <0: Library error; >0: dSM error code

int ZoneGroupActionRequest_action_force_call_scene	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint16_t	ZoneId,
		uint8_t	GroupId,
		uint16_t	OriginDeviceId,
		uint8_t	SceneId
	)

Execute actions on all devices of a zone/group.

Call a scene in the zone/group. Overwrite any locally selected state.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ZoneGroupActionRequest_action_force_call_scene_response_callback_t callback. To receive this request from other bus members register the ZoneGroupActionRequest_action_force_call_scene_request_callback_t callback.

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	ZoneId	Zone ID.
[in]	GroupId	Group ID.
[in]	OriginDeviceId	Device ID of the origin device (0 if unknown).
[in]	SceneId	Scene ID.

Returns:

0: success (return parameters are valid); <0: Library error; >0: dSM error code

int ZoneGroupActionRequest_action_local_stop	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint16_t	ZoneId,
		uint8_t	GroupId,
		uint16_t	OriginDeviceId
	)

Execute actions on all devices of a zone/group.

A device has reached its final position during calibration mode.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ZoneGroupActionRequest_action_local_stop_response_callback_t callback. To receive this request from other bus members register the ZoneGroupActionRequest_action_local_stop_request_callback_t callback.

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	ZoneId	Zone ID.
[in]	GroupId	Group ID.
[in]	OriginDeviceId	Device ID of the origin device (0 if unknown).

Returns:

0: success (return parameters are valid); <0: Library error; >0: dSM error code

int ZoneGroupActionRequest_action_programming_mode_off	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint16_t	ZoneId,
		uint8_t	GroupId,
		uint16_t	OriginDeviceId
	)

Execute actions on all devices of a zone/group.

Finish programming mode.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ZoneGroupActionRequest_action_programming_mode_off_response_callback_t callback. To receive this request from other bus members register the ZoneGroupActionRequest_action_programming_mode_off_request_callback_t callback.

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	ZoneId	Zone ID.
[in]	GroupId	Group ID.
[in]	OriginDeviceId	Device ID of the origin device (0 if unknown).

Returns:

0: success (return parameters are valid); <0: Library error; >0: dSM error code

int ZoneGroupActionRequest_action_programming_mode_on	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint16_t	ZoneId,
		uint8_t	GroupId,
		uint16_t	OriginDeviceId
	)

Execute actions on all devices of a zone/group.

Start Programming mode.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ZoneGroupActionRequest_action_programming_mode_on_response_callback_t callback. To receive this request from other bus members register the ZoneGroupActionRequest_action_programming_mode_on_request_callback_t callback.

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	ZoneId	Zone ID.
[in]	GroupId	Group ID.
[in]	OriginDeviceId	Device ID of the origin device (0 if unknown).

Returns:

0: success (return parameters are valid); <0: Library error; >0: dSM error code

int ZoneGroupActionRequest_action_register_scene_local_priority	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint16_t	ZoneId,
		uint8_t	GroupId,
		uint16_t	OriginDeviceId,
		uint8_t	SceneId
	)

Execute actions on all devices of a zone/group.

Register local priority.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ZoneGroupActionRequest_action_register_scene_local_priority_response_callback_t callback. To receive this request from other bus members register the ZoneGroupActionRequest_action_register_scene_local_priority_request_callback_t callback.

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	ZoneId	Zone ID.
[in]	GroupId	Group ID.
[in]	OriginDeviceId	Device ID of the origin device (0 if unknown).
[in]	SceneId	Scene ID.

Returns:

0: success (return parameters are valid); <0: Library error; >0: dSM error code

int ZoneGroupActionRequest_action_save_scene	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint16_t	ZoneId,
		uint8_t	GroupId,
		uint16_t	OriginDeviceId,
		uint8_t	SceneId
	)

Execute actions on all devices of a zone/group.

Save the current state in given scene.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ZoneGroupActionRequest_action_save_scene_response_callback_t callback. To receive this request from other bus members register the ZoneGroupActionRequest_action_save_scene_request_callback_t callback.

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	ZoneId	Zone ID.
[in]	GroupId	Group ID.
[in]	OriginDeviceId	Device ID of the origin device (0 if unknown).
[in]	SceneId	Scene ID.

Returns:

0: success (return parameters are valid); <0: Library error; >0: dSM error code

int ZoneGroupActionRequest_action_select_group	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint16_t	ZoneId,
		uint8_t	GroupId,
		uint16_t	OriginDeviceId
	)

Execute actions on all devices of a zone/group.

Preselect the group in this zone.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ZoneGroupActionRequest_action_select_group_response_callback_t callback. To receive this request from other bus members register the ZoneGroupActionRequest_action_select_group_request_callback_t callback.

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	ZoneId	Zone ID.
[in]	GroupId	Group ID.
[in]	OriginDeviceId	Device ID of the origin device (0 if unknown).

Returns:

0: success (return parameters are valid); <0: Library error; >0: dSM error code

int ZoneGroupActionRequest_action_set_outval	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint16_t	ZoneId,
		uint8_t	GroupId,
		uint16_t	OriginDeviceId,
		uint8_t	Value
	)

Execute actions on all devices of a zone/group.

Set the output to the given value independent of any scene configurations.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ZoneGroupActionRequest_action_set_outval_response_callback_t callback. To receive this request from other bus members register the ZoneGroupActionRequest_action_set_outval_request_callback_t callback.

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	ZoneId	Zone ID.
[in]	GroupId	Group ID.
[in]	OriginDeviceId	Device ID of the origin device (0 if unknown).
[in]	Value	Output value (0-255).

Returns:

0: success (return parameters are valid); <0: Library error; >0: dSM error code

int ZoneGroupActionRequest_action_set_scene_local_priority	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint16_t	ZoneId,
		uint8_t	GroupId,
		uint16_t	OriginDeviceId,
		uint8_t	SceneId
	)

Execute actions on all devices of a zone/group.

Set local priority on all devices that have #SceneId active.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ZoneGroupActionRequest_action_set_scene_local_priority_response_callback_t callback. To receive this request from other bus members register the ZoneGroupActionRequest_action_set_scene_local_priority_request_callback_t callback.

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	ZoneId	Zone ID.
[in]	GroupId	Group ID.
[in]	OriginDeviceId	Device ID of the origin device (0 if unknown).
[in]	SceneId	Scene ID.

Returns:

0: success (return parameters are valid); <0: Library error; >0: dSM error code

int ZoneGroupActionRequest_action_undo_scene	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint16_t	ZoneId,
		uint8_t	GroupId,
		uint16_t	OriginDeviceId
	)

Execute actions on all devices of a zone/group.

Instruct the devices to undo the last scene call.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ZoneGroupActionRequest_action_undo_scene_response_callback_t callback. To receive this request from other bus members register the ZoneGroupActionRequest_action_undo_scene_request_callback_t callback.

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	ZoneId	Zone ID.
[in]	GroupId	Group ID.
[in]	OriginDeviceId	Device ID of the origin device (0 if unknown).

Returns:

0: success (return parameters are valid); <0: Library error; >0: dSM error code

int ZoneGroupActionRequest_action_undo_scene_number	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint16_t	ZoneId,
		uint8_t	GroupId,
		uint16_t	OriginDeviceId,
		uint8_t	SceneId
	)

Execute actions on all devices of a zone/group.

Instruct the devices to undo the last scene call if it was the scene with the given scene ID.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ZoneGroupActionRequest_action_undo_scene_number_response_callback_t callback. To receive this request from other bus members register the ZoneGroupActionRequest_action_undo_scene_number_request_callback_t callback.

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	ZoneId	Zone ID.
[in]	GroupId	Group ID.
[in]	OriginDeviceId	Device ID of the origin device (0 if unknown).
[in]	SceneId	Scene ID.

Returns:

0: success (return parameters are valid); <0: Library error; >0: dSM error code

int ZoneGroupSceneInfo	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint16_t	ZoneId,
		uint8_t	GroupId,
		uint8_t	SceneId,
		uint8_t *	Name
	)

Returns the properties of a scene.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ZoneGroupSceneInfo_response_callback_t callback. To receive this request from other bus members register the ZoneGroupSceneInfo_request_callback_t callback.

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	ZoneId	Zone ID.
[in]	GroupId	Group ID.
[in]	SceneId	Scene ID.
[out]	Name	The name of this scene (21 character, zero terminated string). (pass a reference to a preallocated buffer of at least 21 bytes.)

Returns:

0: success (return parameters are valid); <0: Library error; >0: dSM error code

int ZoneGroupSceneProperties_set_name	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint16_t	ZoneId,
		uint8_t	GroupId,
		uint8_t	SceneId,
		const uint8_t *	Name
	)

Set the name of a scene.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ZoneGroupSceneProperties_set_name_response_callback_t callback. To receive this request from other bus members register the ZoneGroupSceneProperties_set_name_request_callback_t callback.

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	ZoneId	Zone ID.
[in]	GroupId	Group ID.
[in]	SceneId	Scene ID.
[in]	Name	The new name of this scene (21 character, zero terminated string).

Returns:

0: success (return parameters are valid); <0: Library error; >0: dSM error code

int ZoneSensorPush	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint16_t	ZoneId,
		uint32_t	SourceDevice,
		uint8_t	SensorType,
		uint16_t	Value,
		uint8_t	Precision
	)

Distribute sensor values to devices.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ZoneSensorPush_response_callback_t callback. To receive this request from other bus members register the ZoneSensorPush_request_callback_t callback.

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	ZoneId	Zone ID.
[in]	SourceDevice	dSID of sensor value source device. A DSID of 0 overrides the setting in the Push table and sends out the value in any case.
[in]	SensorType	Type of sensor value.
[in]	Value	12-bit sensor value.
[in]	Precision	0=use bits 11:2, 1=use bits 9:0 for push.

Returns:

0: success (return parameters are valid); <0: Library error; >0: dSM error code