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.
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 watt (W).
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.

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


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
force boolean false


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 watt (W). 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 dsid true


removeInactiveMeters

Removes all non present dSMs from the dSS.

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.
blink
Calls the blink function on the zone to locate and identify it.
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 watt (W).
sceneSetName
Sets the name of the scene on the given group
sceneGetName
Returns the name of the scene on the given group
getReachableScenes
Returns the list of used scenes in a zone depending on the present components
pushSensorValues
Send a sensor value to the components of a zone

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


blink

Calls the blink function on the zone to locate and identify it.

No parameter


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
force boolean false


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 watt (W). 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


sceneSetName

Sets the name of the scene on the given group
Parameter
Name Type Required
groupID integer false
groupName string false
sceneNumber integer true
newName string true


sceneGetName

Returns the name of the scene on the given group
Parameter
Name Type Required
groupID integer false
groupName string false
sceneNumber integer true


getReachableScenes

Returns the list of used scenes in a zone depending on the present components

No parameter


pushSensorValues

Send a sensor value to the components of a zone
Parameter
Name Type Required
sourceDSID string true
sensorType integer true
sensorValue integer true

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 dsid 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 true if the device is on
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.
blink
Calls the blink function on the device to locate and identify it.
setConfig
Sets the value of config class at offset index to value
getConfig
Gets the value of config class at offset index
getConfigWord
Gets the value of config class at offset index
setJokerGroup
Sets the color group of a joker device
setButtonID
Sets the button id of a device
setButtonInputMode
Sets the input mode of a device button
setOutputMode
Sets the output operation mode
setProgMode
Enables or disables the programming mode of a device.
getTransmissionQuality
Request upstream and downstream quality information
getOutputValue
Gets the device output value from parameter at the given offset.
setOutputValue
Sets the device output value at the given offset.
getSceneMode
Gets the device configuration for a specific scene command.
setSceneMode
Sets the configuration flags for a specific scene command.
getTransitionTime
Gets the timing configuration preset.
setTransitionTime
Sets the timing configuration preset.
getLedMode
Gets the led configuration flags preset.
setLedMode
Sets the led configuration flags preset.
getSensorValue
Request the sensor value of a given index.
getSensorType
Request the sensor type code of a given index.
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 watt (W).
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.
getSensorEventTableEntry
Requests the sensor event table entry.
setSensorEventTableEntry
Configures a sensor event table entry in the device. If 'action' == 2 and depending on the type of the device either ('buttonNumber'/'clickType') or ('sceneDeviceMode'/'sceneID') are required.
addToArea
Add device to the specified area. 'areaScene' can be either the areaOn or areaOff scenes.
removeFromArea
Remove a device from the specified area. 'areaScene' can be either the areaOn or areaOff scenes.

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 true if the device is on Meaning that the last called scene was not: SceneOff, SceneMin, SceneDeepOff, or SceneStandBy

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


blink

Calls the blink function on the device to locate and identify it.

No parameter


setConfig

Sets the value of config class at offset index to value
Parameter
Name Type Required
value integer true
class integer true
index integer true


getConfig

Gets the value of config class at offset index
Parameter
Name Type Required
class integer true
index integer true


getConfigWord

Gets the value of config class at offset index
Parameter
Name Type Required
class integer true
index integer true


setJokerGroup

Sets the color group of a joker device
Parameter
Name Type Required
groupID integer true


setButtonID

Sets the button id of a device
Parameter
Name Type Required
buttonID integer true


setButtonInputMode

Sets the input mode of a device button
Parameter
Name Type Required
modeID integer true


setOutputMode

Sets the output operation mode
Parameter
Name Type Required
modeID integer true


setProgMode

Enables or disables the programming mode of a device. The valid mode values are: enabled or disabled.
Parameter
Name Type Required
mode string true


getTransmissionQuality

Request upstream and downstream quality information

No parameter


getOutputValue

Gets the device output value from parameter at the given offset. The available parameters and offsets depend on the features of the hardware components.
Parameter
Name Type Required
offset integer true


setOutputValue

Sets the device output value at the given offset. The available parameters and offsets depend on the features of the hardware components.
Parameter
Name Type Required
offset integer true
value integer true


getSceneMode

Gets the device configuration for a specific scene command.
Parameter
Name Type Required
sceneID integer true


setSceneMode

Sets the configuration flags for a specific scene command.
Parameter
Name Type Required
sceneID integer true
dontCare integer false
localPrio integer false
specialMode integer false
flashMode integer false
ledconIndex integer false
dimtimeIndex integer false


getTransitionTime

Gets the timing configuration preset.
Parameter
Name Type Required
dimetimeIndex integer true


setTransitionTime

Sets the timing configuration preset.
Parameter
Name Type Required
dimetimeIndex integer true
up integer true
down integer true


getLedMode

Gets the led configuration flags preset.
Parameter
Name Type Required
ledconIndex integer true


setLedMode

Sets the led configuration flags preset.
Parameter
Name Type Required
ledconIndex integer true
colorSelect integer false
modeSelect integer false
dimMode integer false
rgbMode integer false
groupColorMode integer false


getSensorValue

Request the sensor value of a given index.
Parameter
Name Type Required
sensorIndex integer true


getSensorType

Request the sensor type code of a given index.
Parameter
Name Type Required
sensorIndex integer true


callScene

Calls scene sceneNumber on the device.
Parameter
Name Type Required
sceneNumber integer true
force boolean false


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 watt (W). 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


getSensorEventTableEntry

Requests the sensor event table entry.
Parameter
Name Type Required
eventIndex integer true


setSensorEventTableEntry

Configures a sensor event table entry in the device. If 'action' == 2 and depending on the type of the device either ('buttonNumber'/'clickType') or ('sceneDeviceMode'/'sceneID') are required.
Parameter
Name Type Required
eventIndex integer true
eventName string true
sensorIndex integer true
test integer true
action integer true
value integer true
hysteresis integer true
validity integer true
buttonNumber integer false
clickType integer false
sceneDeviceMode integer false
sceneID integer false


addToArea

Add device to the specified area. 'areaScene' can be either the areaOn or areaOff scenes.
Parameter
Name Type Required
areaScene integer true


removeFromArea

Remove a device from the specified area. 'areaScene' can be either the areaOn or areaOff scenes.
Parameter
Name Type Required
areaScene integer true

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 watt (W)
getEnergyMeterValue
Returns the meter-value in watt-hours (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 watt (W)

No parameter


getEnergyMeterValue

Returns the meter-value in watt-hours (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
setFlag
Sets flag to a given value, supported flags are READABLE, WRITEABLE and ARCHIVE
getFlags
Returns an array of flags and their values
query
Returns a part of the tree specified by query. All queries start from the root. The properties to be included have to be put in parentheses. A query to get all device from zone4 would look like this: '/apartment/zones/zone4/*(ZoneID,name)'
remove
Removes a node from the property tree

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


setFlag

Sets flag to a given value, supported flags are READABLE, WRITEABLE and ARCHIVE
Parameter
Name Type Required
flag string true
value boolean true


getFlags

Returns an array of flags and their values

No parameter


query

Returns a part of the tree specified by query. All queries start from the root. The properties to be included have to be put in parentheses. A query to get all device from zone4 would look like this: '/apartment/zones/zone4/*(ZoneID,name)'
Parameter
Name Type Required
query string true


remove

Removes a node from the property tree

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 UTC seconds since epoch
login
Creates a new session using the credentials provided
loginApplication
Creates a new session using the registered application token
logout
Destroys the session and signs out the user
loggedInUser
Returns the name of the currently logged in user
setPassword
Changes the currently logged in users password
requestApplicationToken
Returns a token for paswordless login. The token will need to be approved by a user first. The caller must not be logged in.
enableToken
Enables a application token.
revokeToken
Revokes an application token

version

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

No parameter


time

Returns the dSS time in UTC seconds since epoch

No parameter


login

Creates a new session using the credentials provided
Parameter
Name Type Required
user string true
password string true


loginApplication

Creates a new session using the registered application token
Parameter
Name Type Required
loginToken string true


logout

Destroys the session and signs out the user

No parameter


loggedInUser

Returns the name of the currently logged in user

No parameter


setPassword

Changes the currently logged in users password
Parameter
Name Type Required
password string true


requestApplicationToken

Returns a token for paswordless login. The token will need to be approved by a user first. The caller must not be logged in.
Parameter
Name Type Required
applicationName string true


enableToken

Enables a application token.
Parameter
Name Type Required
applicationToken string true


revokeToken

Revokes an application token
Parameter
Name Type Required
applicationToken string true

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.
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.
getConsumption
Returns the consumption of all devices in the set in watt (W).

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


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
force boolean false


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


getConsumption

Returns the consumption of all devices in the set in watt (W).

No parameter

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.
persistSet
Creates a group containing all devices contained in the set
unpersistSet
Removes the group associated with the set
addGroup
Adds a group in the zone with the given id
groupAddDevice
Adds a device to the group
groupRemoveDevice
Removes the device from the group

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


persistSet

Creates a group containing all devices contained in the set
Parameter
Name Type Required
set string true
groupID integer false


unpersistSet

Removes the group associated with the set
Parameter
Name Type Required
set string true


addGroup

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


groupAddDevice

Adds a device to the group
Parameter
Name Type Required
deviceID integer true
groupID integer true


groupRemoveDevice

Removes the device from the group
Parameter
Name Type Required
deviceID integer true
groupID integer 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
Returns all metering series stored on this dSS
getValues
Returns the stored values for the dSM with the given dsid. Type and Resolution can be found out by looking at the output of the 'getResolutions'-method. For now the types 'energy', 'energyDelta' and 'consumption' are available. 'energy' and 'energyDelta' are available in two units: 'Wh' (default) and 'Ws'. The optional parameters 'startTime', 'endTime' and 'valueCount' select which window and how many metering values are returned.
getLatest
Returns cached energy meter value or cached power consumption value in watt (W). The type parameter defines what should be returned, valid types, 'energyDelta' are 'energy' and 'consumption'. 'energy' and 'energyDelta' are available in two units: 'Wh' (default) and 'Ws'. 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

Returns all metering series stored on this dSS

No parameter


getValues

Returns the stored values for the dSM with the given dsid. Type and Resolution can be found out by looking at the output of the 'getResolutions'-method. For now the types 'energy', 'energyDelta' and 'consumption' are available. 'energy' and 'energyDelta' are available in two units: 'Wh' (default) and 'Ws'. The optional parameters 'startTime', 'endTime' and 'valueCount' select which window and how many metering values are returned.
Parameter
Name Type Required
dsid string true
type string true
resolution integer true
unit string false
startTime integer false
endTime integer false
valueCount integer false


getLatest

Returns cached energy meter value or cached power consumption value in watt (W). The type parameter defines what should be returned, valid types, 'energyDelta' are 'energy' and 'consumption'. 'energy' and 'energyDelta' are available in two units: 'Wh' (default) and 'Ws'. 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
unit string false