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 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.
- setID
- Sets the Apartment ID, allowed values: 0-7
- getID
- Returns the Apartment ID
- getConsumption
- Returns the consumption of all devices in the set in mW.
Returns the name of the apartment
No parameter
Sets the name of the apartment to newName
Parameter
Name |
Type |
Required |
newName |
string |
true |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Returns an object containing the structure of the apartment.
Parameter
Name |
Type |
Required |
sceneNumber |
integer |
true |
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 |
Returns a list of the circuits present in the apartment
No parameter
Rescans all circuits of the apartment
No parameter
Removes non present dSMs from the dSS.
Parameter
Name |
Type |
Required |
dsid |
integer |
true |
Removes all non present dSMs from the dSS.
No parameter
Sets the Apartment ID, allowed values: 0-7
Parameter
Name |
Type |
Required |
id |
integer |
true |
Returns the Apartment ID
No parameter
Returns the consumption of all devices in the set in mW.
No parameter