Classes

apartment
zone
device
circuit
property
event
system
set
structure
metering

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 sceneNumber on all devices of the apartment.
saveScene
Saves the current output value to sceneNumber.
undoScene
Undos setting the value of sceneNumber.
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
removeMeter
Removes non present dSMs from the dSS.
removeInactiveMeters
Removes all non present dSMs from the dSS.
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 sceneNumber 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
sceneNumber integer true

saveScene

Saves the current output value to sceneNumber. 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
sceneNumber integer true

undoScene

Undos setting the value of sceneNumber. 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
sceneNumber 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
sceneNumber 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

removeMeter

Removes non present dSMs from the dSS.
Parameter
Name Type Required
dsid integer true

removeInactiveMeters

Removes all non present dSMs from the dSS.

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 sceneNumber on all devices in the zone.
saveScene
Saves the current output value to sceneNumber 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 sceneNumber 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
sceneNumber integer true

saveScene

Saves the current output value to sceneNumber 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
sceneNumber 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
sceneNumber 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
getSpec
Retrieves device information such as function, product and revision ids
getGroups
Returns an array of groups the device is in
getState
Returns the state 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 sceneNumber on the device.
saveScene
Saves the current outputvalue to sceneNumber.
undoScene
Undos saving the scene value for sceneNumber
getConsumption
Returns the consumption of the device in mW.
addTag
Adds the tag 'tag'
removeTag
Removes the tag 'tag'
hasTag
Returns hasTag: true if tagged 'tag'
getTags
Returns an array of all tags of the device
lock
Tells the dSM to never forget this device even if it's not found on the bus.
unlock
Tells the dSM to that it's okay forget this device.

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

getSpec

Retrieves device information such as function, product and revision ids

No parameter

getGroups

Returns an array of groups the device is in

No parameter

getState

Returns the state of the device

No parameter

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 sceneNumber on the device.
Parameter
Name Type Required
sceneNumber integer true

saveScene

Saves the current outputvalue to sceneNumber.
Parameter
Name Type Required
sceneNumber integer true

undoScene

Undos saving the scene value for sceneNumber
Parameter
Name Type Required
sceneNumber integer true

getConsumption

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

No parameter

addTag

Adds the tag 'tag'
Parameter
Name Type Required
tag string true

removeTag

Removes the tag 'tag'
Parameter
Name Type Required
tag string true

hasTag

Returns hasTag: true if tagged 'tag'
Parameter
Name Type Required
tag string true

getTags

Returns an array of all tags of the device

No parameter

lock

Tells the dSM to never forget this device even if it's not found on the bus.

No parameter

unlock

Tells the dSM to that it's okay forget this device.

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
subscribe
Subscribes to an event given by the name. The subscriptionID is a unique id that is defined by the subscriber. It is possible to subscribe to several events, using the same subscription id, this allows to retrieve a grouped output of the events (i.e. get output of all subscribed by the given id)
unsubscribe
Unsubscribes from an event given by the name. The subscriptionID is a unique id that was used in the subscribe call.
get
Get event information and output. The subscriptionID is a unique id that was used in the subscribe call. All events, subscribed with the given id will be handled by this call. A timout, in case no events are taken place, can be specified (in MS). By default the timeout is disabled: 0 (zero), if no events occur the call will block.

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.
Parameter
Name Type Required
name string true
context string false
location string false

subscribe

Subscribes to an event given by the name. The subscriptionID is a unique id that is defined by the subscriber. It is possible to subscribe to several events, using the same subscription id, this allows to retrieve a grouped output of the events (i.e. get output of all subscribed by the given id)
Parameter
Name Type Required
name string true
subscriptionID integer true

unsubscribe

Unsubscribes from an event given by the name. The subscriptionID is a unique id that was used in the subscribe call.
Parameter
Name Type Required
name string true
subscriptionID integer true

get

Get event information and output. The subscriptionID is a unique id that was used in the subscribe call. All events, subscribed with the given id will be handled by this call. A timout, in case no events are taken place, can be specified (in MS). By default the timeout is disabled: 0 (zero), if no events occur the call will block.
Parameter
Name Type Required
subscriptionID integer true
timeout integer false

system

Instance variables

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

No instance parameter

Methods

version
Returns the dss version
time
Returns the dSS time in seconds since epoch

version

Returns the dss version This method returns the version std::string of the dss

No parameter

time

Returns the dSS time in seconds since epoch

No parameter

set

Instance variables

Instance variables identify the instance of the class being called. One of them is required on every call.
Name Type Required
self string false

Methods

fromApartment
Creates a set that contains all devices of the apartment
byZone
Restricts the set to the given zone
byGroup
Restricts the set to the given group
byDSID
Restricts the set to the given dsid
add
Combines the set self with other
subtract
Subtracts the set self from other
turnOn
Turns on all devices of the set.
turnOff
Turns off all devices of the set.
increaseValue
Increases the main value on all devices of the set.
decreaseValue
Decreases the main value on all devices of the set.
enable
Enables all devices of the set.
disable
Disables all devices of the set.
startDim
Starts dimming the devices of the set.
endDim
Stops dimming the devices of the set.
setValue
Sets the output value of all devices of the set to value.
callScene
Calls the scene sceneNumber on all devices of the set.
saveScene
Saves the current output value to sceneNumber.
undoScene
Undoes setting the value of sceneNumber.

fromApartment

Creates a set that contains all devices of the apartment

No parameter

byZone

Restricts the set to the given zone
Parameter
Name Type Required
zoneID integer false
zoneName string false

byGroup

Restricts the set to the given group
Parameter
Name Type Required
groupID integer false
groupName integer false

byDSID

Restricts the set to the given dsid
Parameter
Name Type Required
dsid dsid true

add

Combines the set self with other
Parameter
Name Type Required
other string true

subtract

Subtracts the set self from other
Parameter
Name Type Required
other string true

turnOn

Turns on all devices of the set.

No parameter

turnOff

Turns off all devices of the set.

No parameter

increaseValue

Increases the main value on all devices of the set.

No parameter

decreaseValue

Decreases the main value on all devices of the set.

No parameter

enable

Enables all devices of the set.

No parameter

disable

Disables all devices of the set. A disabled device will react only to an enable call.

No parameter

startDim

Starts dimming the devices of the set.
Parameter
Name Type Required
direction string false

endDim

Stops dimming the devices of the set.

No parameter

setValue

Sets the output value of all devices of the set to value.
Parameter
Name Type Required
value integer true

callScene

Calls the scene sceneNumber on all devices of the set.
Parameter
Name Type Required
sceneNumber integer true

saveScene

Saves the current output value to sceneNumber.
Parameter
Name Type Required
sceneNumber integer true

undoScene

Undoes setting the value of sceneNumber.
Parameter
Name Type Required
sceneNumber integer true

structure

Instance variables

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

No instance parameter

Methods

zoneAddDevice
Adds a device to zone
addZone
Adds a zone with the given id
removeZone
Removes a zone with the given id
removeDevice
Removes a device.
removeInactiveDevices
Removed all inactive devices from a modulator

zoneAddDevice

Adds a device to zone
Parameter
Name Type Required
deviceID integer true
zone integer true

addZone

Adds a zone with the given id
Parameter
Name Type Required
zoneID integer true

removeZone

Removes a zone with the given id
Parameter
Name Type Required
zoneID integer true

removeDevice

Removes a device. Only devices that are no longer present (isPresent flag is not set) can be removed.
Parameter
Name Type Required
deviceID integer true

removeInactiveDevices

Removed all inactive devices from a modulator
Parameter
Name Type Required
id dsid true

metering

Instance variables

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

No instance parameter

Methods

getResolutions
Returns all resolutions stored on this dSS
getSeries
getValues
getLatest
Returns cached energy meter value (in Wh) or cached power consumption value (in mW). The type parameter defines what should be returned, valid types are 'energy' and 'consumption'. The from parameter follows the set-syntax, currently it supports: .meters(dsid1,dsid2,...) and .meters(all)

getResolutions

Returns all resolutions stored on this dSS

No parameter

getSeries

No parameter

getValues

No parameter

getLatest

Returns cached energy meter value (in Wh) or cached power consumption value (in mW). The type parameter defines what should be returned, valid types are 'energy' and 'consumption'. The from parameter follows the set-syntax, currently it supports: .meters(dsid1,dsid2,...) and .meters(all)
Parameter
Name Type Required
type string true
from string true