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.
Returns the name of the device
No parameter
Sets the name of the device to newName
Parameter
Name |
Type |
Required |
newName |
string |
true |
Retrieves device information such as function, product and revision ids
No parameter
Returns an array of groups the device is in
No parameter
Returns true if the device is on Meaning that the last called scene was not: SceneOff, SceneMin, SceneDeepOff, or SceneStandBy
No parameter
Turns on the device. This will call SceneMax on the device.
No parameter
Turns off the device. This will call SceneMin on the device.
No parameter
Increases the default value of the device.
No parameter
Decreases the default value of the device.
No parameter
Enables the device.
No parameter
Disables the device. A disabled device will only react to enable calls.
No parameter
Calls the blink function on the device to locate and identify it.
No parameter
Sets the value of config class at offset index to value
Parameter
Name |
Type |
Required |
value |
integer |
true |
class |
integer |
true |
index |
integer |
true |
Gets the value of config class at offset index
Parameter
Name |
Type |
Required |
class |
integer |
true |
index |
integer |
true |
Gets the value of config class at offset index
Parameter
Name |
Type |
Required |
class |
integer |
true |
index |
integer |
true |
Sets the color group of a joker device
Parameter
Name |
Type |
Required |
groupID |
integer |
true |
Sets the button id of a device
Parameter
Name |
Type |
Required |
buttonID |
integer |
true |
Sets the input mode of a device button
Parameter
Name |
Type |
Required |
modeID |
integer |
true |
Sets the output operation mode
Parameter
Name |
Type |
Required |
modeID |
integer |
true |
Enables or disables the programming mode of a device. The valid mode values are: enabled or disabled.
Parameter
Name |
Type |
Required |
mode |
string |
true |
Request upstream and downstream quality information
No parameter
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 |
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 |
Gets the device configuration for a specific scene command.
Parameter
Name |
Type |
Required |
sceneID |
integer |
true |
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 |
Gets the timing configuration preset.
Parameter
Name |
Type |
Required |
dimetimeIndex |
integer |
true |
Sets the timing configuration preset.
Parameter
Name |
Type |
Required |
dimetimeIndex |
integer |
true |
up |
integer |
true |
down |
integer |
true |
Gets the led configuration flags preset.
Parameter
Name |
Type |
Required |
ledconIndex |
integer |
true |
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 |
Request the sensor value of a given index.
Parameter
Name |
Type |
Required |
sensorIndex |
integer |
true |
Request the sensor type code of a given index.
Parameter
Name |
Type |
Required |
sensorIndex |
integer |
true |
Calls scene sceneNumber on the device.
Parameter
Name |
Type |
Required |
sceneNumber |
integer |
true |
force |
boolean |
false |
Saves the current outputvalue to sceneNumber.
Parameter
Name |
Type |
Required |
sceneNumber |
integer |
true |
Undos saving the scene value for sceneNumber
Parameter
Name |
Type |
Required |
sceneNumber |
integer |
true |
Returns the consumption of the device in watt (W). Note that this works only for simulated devices at the moment.
No parameter
Adds the tag 'tag'
Parameter
Name |
Type |
Required |
tag |
string |
true |
Removes the tag 'tag'
Parameter
Name |
Type |
Required |
tag |
string |
true |
Returns hasTag: true if tagged 'tag'
Parameter
Name |
Type |
Required |
tag |
string |
true |
Returns an array of all tags of the device
No parameter
Tells the dSM to never forget this device even if it's not found on the bus.
No parameter
Tells the dSM to that it's okay forget this device.
No parameter