Page tree
Skip to end of metadata
Go to start of metadata

Scenes allow users to control multiple devices using the App or a controller type device.  Scenes consist of Controllers and Responders. This resource allows a user to put an entire network or a part of the network into a predefined mode (e.g. Movie time or Night or Day for a lightning network). Also, it provides a way to activate and deactivate your scene quickly using a keypad as scene controller. This same functionality is available through the API.

 

As part of the integration with devices, a pseudo device is created and maintained per scene. This allows to activate or deactivate the scene using an effect within an automation rule.

For more details about this resource schema, refer to Scene.

The Controller object for a 3 button keypad device used as a controller for a scene would look like this:

{
	"name": "New Controller",
	"params": {},
	"path": "/devices/5935cd80d00d2f6e5783a052/comps/1/procs/OnOffClient",
	"parents": {
		"scenes": [{
			"id": "591bb503b262be5d3cb0de19",
			"name": "Scene container name"
		}],
		"devices": [{
			"id": "5935cd80d00d2f6e5783a052",
			"name": "Controller Device ZBWS3B(4037A) - 3872"
		}]
	},
	"componentName": "Button 1",
	"description": "When ZBWS3B(4037A) - 3872 Button 1 is Pressed"
}

 

The Responder object for controlling OnOff in a Smartplug would look like this:

{
	"name": "New Responder 1",
	"parents": {
		"scenes": [{
			"id": "591bb503b262be5d3cb0de19",
			"name": "Scene container name"
		}],
		"devices": [{
			"id": "5935bcdfd00d2f6e57839e96",
			"name": "Responder device ZBMPlug15 - 7024"
		}]
	},
	"path": "/devices/5935bcdfd00d2f6e57839e96/comps/1/procs/OnOff/attrs/OnOff",
	"params": {
		"value": true
	},
	"componentName": "Device Load",
	"description": "Turn On ZBMPlug15 - 7024"
}

 

Another example of a Responder object but for a Dimmer which uses the CurrentLevel attribute would look like this:

{
	"name": "New Responder 2",
	"parents": {
		"scenes": [{
			"id": "591bb503b262be5d3cb0de19",
			"name": "Scene container name"
		}],
		"devices": [{
			"id": "593062d2cbf216745e9b9444",
			"name": "Responder device Level - 8132"
		}]
	},
	"path": "/devices/593062d2cbf216745e9b9444/comps/1/procs/LevelControlServer/attrs/CurrentLevel",
	"params": {
		"value": 127
	},
	"componentName": "Device Level",
	"description": "Set Level - 8132 to 50%"
}
  • No labels