apartment

Instance variables

Instance variables identify the instance of the class being called. One of them is required on every call.

No instance parameter

Methods

getName: Returns the name of the apartment
setName: Sets the name of the apartment to newName
turnOn: Turns on all devices of the apartment.
turnOff: Turns off all devices of the apartment.
increaseValue: Increases the main value on all devices of the apartment.
decreaseValue: Decreases the main value on all devices of the apartment.
enable: Enables all devices of the apartment.
disable: Disables all devices of the apartment.
startDim: Starts dimming the devices of the apartment.
endDim: Stops dimming the devices of the apartment.
setValue: Sets the output value of all devices of the apartment to value.
callScene: Calls the scene sceneNr on all devices of the apartment.
saveScene: Saves the current output value to sceneNr.
undoScene: Undos setting the value of sceneNr.
getConsumption: Returns the consumption of all devices in the apartment in mW.
getStructure: Returns an object containing the structure of the apartment.
getDevices: Returns the list of devices in the apartment.
getCircuits: Returns a list of the circuits present in the apartment
rescan: Rescans all circuits of the apartment
getConsumption: Returns the consumption of all devices in the set in mW.

getName

Returns the name of the apartment

No parameter

setName

Sets the name of the apartment to newName

Parameter

Name	Type	Required
newName	string	true

turnOn

Turns on all devices of the apartment. If groupID or groupName are specified, only devices contained in this group will be addressed

Parameter

Name	Type	Required
groupID	integer	false
groupName	string	false

turnOff

Turns off all devices of the apartment. If groupID or groupName are specified, only devices contained in this group will be addressed

Parameter

Name	Type	Required
groupID	integer	false
groupName	string	false

increaseValue

Increases the main value on all devices of the apartment. If groupID or groupName are specified, only devices contained in this group will be addressed

Parameter

Name	Type	Required
groupID	integer	false
groupName	string	false

decreaseValue

Decreases the main value on all devices of the apartment. If groupID or groupName are specified, only devices contained in this group will be addressed

Parameter

Name	Type	Required
groupID	integer	false
groupName	string	false

enable

Enables all devices of the apartment. If groupID or groupName are specified, only devices contained in this group will be addressed

Parameter

Name	Type	Required
groupID	integer	false
groupName	string	false

disable

Disables all devices of the apartment. A disabled device will react only to an enable call. If groupID or groupName are specified, only devices contained in this group will be addressed

Parameter

Name	Type	Required
groupID	integer	false
groupName	string	false

startDim

Starts dimming the devices of the apartment. If groupID or groupName are specified, only devices contained in this group will be addressed

Parameter

Name	Type	Required
groupID	integer	false
groupName	string	false
direction	string	false

endDim

Stops dimming the devices of the apartment. If groupID or groupName are specified, only devices contained in this group will be addressed

Parameter

Name	Type	Required
groupID	integer	false
groupName	string	false

setValue

Sets the output value of all devices of the apartment to value. If groupID or groupName are specified, only devices contained in this group will be addressed

Parameter

Name	Type	Required
groupID	integer	false
groupName	string	false
value	integer	true

callScene

Calls the scene sceneNr on all devices of the apartment. If groupID or groupName are specified, only devices contained in this group will be addressed

Parameter

Name	Type	Required
groupID	integer	false
groupName	string	false
sceneNr	integer	true

saveScene

Saves the current output value to sceneNr. If groupID or groupName are specified, only devices contained in this group will be addressed

Parameter

Name	Type	Required
groupID	integer	false
groupName	string	false
sceneNr	integer	true

undoScene

Undos setting the value of sceneNr. If groupID or groupName are specified, only devices contained in this group will be addressed

Parameter

Name	Type	Required
groupID	integer	false
groupName	string	false
sceneNr	integer	true

getConsumption

Returns the consumption of all devices in the apartment in mW. If groupID or groupName are specified, only devices contained in this group will be addressed

Parameter

Name	Type	Required
groupID	integer	false
groupName	string	false

getStructure

Returns an object containing the structure of the apartment.

Parameter

Name	Type	Required
sceneNr	integer	true

getDevices

Returns the list of devices in the apartment. If unassigned is true, only devices that are not assigned to a zone get returned

Parameter

Name	Type	Required
unassigned	boolean	false

getCircuits

Returns a list of the circuits present in the apartment

No parameter

rescan

Rescans all circuits of the apartment

No parameter

getConsumption

Returns the consumption of all devices in the set in mW.

No parameter

zone

Instance variables

Instance variables identify the instance of the class being called. One of them is required on every call.

Name	Type	Required
id	integer	false
name	string	false

Methods

getName: Returns the name of the zone.
setName: Sets the name of the zone to newName.
turnOn: Turns on all devices in the zone.
turnOff: Turns off all devices in the zone.
increaseValue: Increases the main value of all devices in the zone.
decreaseValue: Decreases the main value of all devices in the zone.
enable: Enables all devices in the zone.
disable: Disables all devices in the zone.
startDim: Starts dimming the main value of all devices in the zone.
endDim: Stops dimming of all devices in the zone.
setValue: Sets the output value of all devices in the zone.
callScene: Sets the scene sceneNr on all devices in the zone.
saveScene: Saves the current output value to sceneNr of all devices in the zone.
undoScene: Undos the setting of a scene value.
getConsumption: Returns the consumption of all devices in the zone in mW.

getName

Returns the name of the zone.

No parameter

setName

Sets the name of the zone to newName.

Parameter

Name	Type	Required
newName	string	true

turnOn

Turns on all devices in the zone. If groupID or groupName are specified, only devices contained in this group will be addressed

Parameter

Name	Type	Required
groupID	integer	false
groupName	string	false

turnOff

Turns off all devices in the zone. If groupID or groupName are specified, only devices contained in this group will be addressed

Parameter

Name	Type	Required
groupID	integer	false
groupName	string	false

increaseValue

Increases the main value of all devices in the zone. If groupID or groupName are specified, only devices contained in this group will be addressed

Parameter

Name	Type	Required
groupID	integer	false
groupName	string	false

decreaseValue

Decreases the main value of all devices in the zone. If groupID or groupName are specified, only devices contained in this group will be addressed

Parameter

Name	Type	Required
groupID	integer	false
groupName	string	false

enable

Enables all devices in the zone. If groupID or groupName are specified, only devices contained in this group will be addressed

Parameter

Name	Type	Required
groupID	integer	false
groupName	string	false

disable

Disables all devices in the zone. Disabled devices will react only to a enable call. If groupID or groupName are specified, only devices contained in this group will be addressed

Parameter

Name	Type	Required
groupID	integer	false
groupName	string	false

startDim

Starts dimming the main value of all devices in the zone. If groupID or groupName are specified, only devices contained in this group will be addressed

Parameter

Name	Type	Required
groupID	integer	false
groupName	string	false
direction	string	false

endDim

Stops dimming of all devices in the zone. If groupID or groupName are specified, only devices contained in this group will be addressed

Parameter

Name	Type	Required
groupID	integer	false
groupName	string	false

setValue

Sets the output value of all devices in the zone. If groupID or groupName are specified, only devices contained in this group will be addressed

Parameter

Name	Type	Required
groupID	integer	false
groupName	string	false
value	integer	true

callScene

Sets the scene sceneNr on all devices in the zone. If groupID or groupName are specified, only devices contained in this group will be addressed

Parameter

Name	Type	Required
groupID	integer	false
groupName	string	false
sceneNr	integer	true

saveScene

Saves the current output value to sceneNr of all devices in the zone. If groupID or groupName are specified, only devices contained in this group will be addressed

Parameter

Name	Type	Required
groupID	integer	false
groupName	string	false
sceneNr	integer	true

undoScene

Undos the setting of a scene value. If groupID or groupName are specified, only devices contained in this group will be addressed

Parameter

Name	Type	Required
groupID	integer	false
groupName	string	false
sceneNr	integer	true

getConsumption

Returns the consumption of all devices in the zone in mW. If groupID or groupName are specified, only devices contained in this group will be addressed

Parameter

Name	Type	Required
groupID	integer	false
groupName	string	false

device

Instance variables

Instance variables identify the instance of the class being called. One of them is required on every call.

Name	Type	Required
dsid	integer	false
name	string	false

Methods

getName: Returns the name of the device
setName: Sets the name of the device to newName
getGroups: Returns an array of groups the device is in
getState: Returns the state of the device
getLocation: Returns the location of the device.
setLocation: Sets the location of the device.
turnOn: Turns on the device.
turnOff: Turns off the device.
increaseValue: Increases the default value of the device.
decreaseValue: Decreases the default value of the device.
enable: Enables the device.
disable: Disables the device.
startDim: Starts dimming the device.
endDim: Stops dimming.
setValue: Sets the output value of the device to value
setRawValue: Sets the value of register parameterID to value
callScene: Calls scene sceneNr on the device.
saveScene: Saves the current outputvalue to sceneNr.
undoScene: Undos saving the scene value for sceneNr
getConsumption: Returns the consumption of the device in mW.

getName

Returns the name of the device

No parameter

setName

Sets the name of the device to newName

Parameter

Name	Type	Required
newName	string	true

getGroups

Returns an array of groups the device is in

No parameter

getState

Returns the state of the device

No parameter

getLocation

Returns the location of the device.

No parameter

setLocation

Sets the location of the device.

Parameter

Name	Type	Required
x	double	false
y	double	false
z	double	false

turnOn

Turns on the device. This will call SceneMax on the device.

No parameter

turnOff

Turns off the device. This will call SceneMin on the device.

No parameter

increaseValue

Increases the default value of the device.

No parameter

decreaseValue

Decreases the default value of the device.

No parameter

enable

Enables the device.

No parameter

disable

Disables the device. A disabled device will only react to enable calls.

No parameter

startDim

Starts dimming the device. If direction equals 'up' it will dim up, otherwise down.

Parameter

Name	Type	Required
direction	string	false

endDim

Stops dimming.

No parameter

setValue

Sets the output value of the device to value

Parameter

Name	Type	Required
value	double	true

setRawValue

Sets the value of register parameterID to value

Parameter

Name	Type	Required
value	integer	true
parameterID	integer	true
size	integer	true

callScene

Calls scene sceneNr on the device.

Parameter

Name	Type	Required
sceneNr	integer	true

saveScene

Saves the current outputvalue to sceneNr.

Parameter

Name	Type	Required
sceneNr	integer	true

undoScene

Undos saving the scene value for sceneNr

Parameter

Name	Type	Required
sceneNr	integer	true

getConsumption

Returns the consumption of the device in mW. Note that this works only for simulated devices at the moment.

No parameter

circuit

Instance variables

Instance variables identify the instance of the class being called. One of them is required on every call.

Name	Type	Required
id	dsid	true

Methods

getName: Returns the name of the circuit.
setName: Sets the name of the circuit to newName.
getEnergyBorder: Returns the energy borders (orange, red).
getConsumption: Returns the consumption of all connected devices in mW
getEnergyMeterValue: Returns the meter-value in Wh
rescan: Rescans the circuit

getName

Returns the name of the circuit.

No parameter

setName

Sets the name of the circuit to newName.

Parameter

Name	Type	Required
newName	string	true

getEnergyBorder

Returns the energy borders (orange, red).

No parameter

getConsumption

Returns the consumption of all connected devices in mW

No parameter

getEnergyMeterValue

Returns the meter-value in Wh

No parameter

rescan

Rescans the circuit

No parameter

property

Instance variables

Instance variables identify the instance of the class being called. One of them is required on every call.

Name	Type	Required
path	string	true

Methods

getString: Returns the std::string value of the property
getInteger: Returns the integer value of the property
getBoolean: Returns the boolean value of the property
setString: Sets the std::string value of the property
setInteger: Sets the integer value of the property
setBoolean: Sets the boolean value of the property
getChildren: Returns an array of the nodes children
setString: Returns the type of the node

getString

Returns the std::string value of the property This will fail if the property is not of type 'string'.

No parameter

getInteger

Returns the integer value of the property This will fail if the property is not of type 'integer'.

No parameter

getBoolean

Returns the boolean value of the property This will fail if the property is not of type 'boolean'.

No parameter

setString

Sets the std::string value of the property This will fail if the property is not of type 'string'.

Parameter

Name	Type	Required
value	string	true

setInteger

Sets the integer value of the property This will fail if the property is not of type 'integer'.

Parameter

Name	Type	Required
value	integer	true

setBoolean

Sets the boolean value of the property This will fail if the property is not of type 'boolean'.

Parameter

Name	Type	Required
value	boolean	true

getChildren

Returns an array of the nodes children

Parameter

Name	Type	Required
value	string	true

setString

Returns the type of the node

No parameter

event

Instance variables

Instance variables identify the instance of the class being called. One of them is required on every call.

No instance parameter

Methods

raise: Raises an event

raise

Raises an event The context describes the source of the event. The location, if provided, defines where any action that is taken by any subscription should happen.