House Modes

Revision as of 09:19, 2 September 2014

1. “Mode” top level attribute

1.1 Get “Mode” variable value

http://IP/data_request?id=variableget&Variable=Mode

1.2 Set “Mode” variable value

- luup.call_action("urn:micasaverde-com:serviceId:HomeAutomationGateway1","SetHouseMode", {Mode = value}, 0)
- http://IP/port_3480/data_request?id=lu_action&serviceId=urn:micasaverde-com:serviceId:HomeAutomationGateway1&action=SetHouseMode&Mode=value

2. “ModeSetting” top level attribute – default/custom setting for each mode

Default values:
- “!1:DC;2:DC*;3:DC*;4:DC* ” - user didn't configured preset modes yet; info message on dashboard is displayed;
- “1:DC;2:DC*;3:DC*;4:DC*” - user visited the preset mode page or configured the modes; info message on dashboard is not displayed;
Legend :
- “DC*” - corresponding mode have the default values;
- “C*” - corresponding mode have custom values;

Get ModeSetting value : http://IP:3480/data_request?id=variableget&Variable=ModeSetting
Set ModeSetting value : http://IP:3480/data_request?id=variableset&Variable=ModeSetting&Value=value

3. “ModeSetting” device state variable

3.1 “Choose sensors to arm ” section - all the devices with category 4 ( DEVICE_CATEGORY_SECURITY_SENSOR)

- if this variable is blank or doesn't exist it means the device isn't configured yet. Once the device is configured, the variable will be set;
- if “A” is present it means that the sensor is “Armed”;
- if no value is present it means that the sensor is “Disarmed/Bypassed”.

Example :
“1:;2:A;3:A;4:A”
- in “Home” mode the sensor is Disarmed/Bypassed;
- in “Away/Night/Vacation” modes the sensor is Armed;

3.2 “What to do if an armed sensor trips ? ” section - DEVICE_CATEGORY_SIREN & DEVICE_CATEGORY_SIREN

The syntax used here is the same as for sensors

3.3 “Who should be notified ?” section - look at the top level mode settings tag, like this: “1:D;2:DC*;3:DC*;4:DC*”

- if the “C” is present, it means “yes”
- if the “*” is present, it means that all users will be notify. By default, all users are “yes” in all modes except “Home”.
- if notification for an individual user is changed, then the “*” is changed to a comma separated list of the PK_Users that are set to “yes”. For example, if the PK_User=1818 is turned to “yes” for mode “Away/2” : “1:D;2:DC,1818;3:DC*;4:DC*”. If PK_User 1819 is added with “yes” also, then it will look like this: “1:D;2:DC,1818,1819;3:DC*;4:DC*”and so on;

3.4 “What to do when this mode is selected ?” section

3.4.1 DEVICE_CATEGORY_HVAC

No change = nothing;
“Off” = O;
“Heat” = H;
“Cool” = C;
“Auto” = A; v “,VALUE” = temperature;
Example :
“1:;2:H,72;3:C,73;4:A,74” - “no change” for mode #1, and the other three are heat, cool, auto.

3.4.2 DEVICE_CATEGORY_DOOR_LOCK

No Change = nothing;
“Lock” = L;
“Unlock” = U.
Example : “1:;2:L;3:U;4:” - “no change” for mode #1 and #4, #2 - “Lock” and #3 - “Unlocked”

3.4.3 DEVICE_CATEGORY_SWITCH & DEVICE_CATEGORY_DIMMABLE_LIGHT

No Change = nothing;
“On” = N;
“Off” = F.
Example : “1:;2:N;3:F;4:” - “no change” for mode #1 and #4, #2 - “On” and #3 - “Off”

4. Default modes

DEVICE_CATEGORY_SECURITY_SENSOR (4)

DEVICE_SUBCATEGORY_GLASS (6) 1:A;2:A;3:A;4:A

DEVICE_SUBCATEGORY_SMOKE (4) 1:A;2:A;3:A;4:A

DEVICE_SUBCATEGORY_CO (5) 1:A;2:A;3:A;4:A

DEVICE_SUBCATEGORY_DOOR (1) 1:;2:A;3:A;4:A

Other 1:;2:A;3:;4:A

DEVICE_CATEGORY_SIREN (24) 1:;2:A;3:A;4:A
DEVICE_CATEGORY_CAMERA (6) 1:;2:A;3:A;4:A
DEVICE_CATEGORY_HVAC (5) 1:;2:;3:;4:
DEVICE_CATEGORY_DOOR_LOCK (7) 1:;2:;3:;4:
DEVICE_CATEGORY_SWITCH (3) 1:;2:;3:;4:
DEVICE_CATEGORY_DIMMABLE_LIGHT (2) 1:;2:;3:;4: