Changes in / [20:30]

Files:

• tags/2.2 (added)
• tags/2.2/D_VistaAlarmPanel1.json (added)
• tags/2.2/D_VistaAlarmPartition1.json (added)
• tags/2.2/S_VistaAlarmPanel1.xml (added)
• tags/2.2/D_VistaAlarmPanel1.xml (added)
• tags/2.2/S_AlarmPartition2.xml (added)
• tags/2.2/D_VistaAlarmPartition1.xml (added)
• tags/2.2/I_VistaAlarmPanel1.xml (added)
• tags/2.2/L_VistaAlarmPanel1.lua (added)
• trunk/D_VistaAlarmPanel1.json (modified) (1 diff)
• trunk/D_VistaAlarmPartition1.json (modified) (3 diffs)
• trunk/S_VistaAlarmPanel1.xml (modified) (1 diff)
• trunk/I_VistaAlarmPanel1.xml (modified) (1 diff)
• trunk/L_VistaAlarmPanel1.lua (modified) (16 diffs)
• D_VistaAlarmPanel1.json (deleted)
• D_VistaAlarmPartition1.json (deleted)
• S_VistaAlarmPanel1.xml (deleted)
• D_VistaAlarmPanel1.xml (deleted)
• S_AlarmPartition2.xml (deleted)
• D_VistaAlarmPartition1.xml (deleted)
• I_VistaAlarmPanel1.xml (deleted)
• L_VistaAlarmPanel1.lua (deleted)

/trunk/D_VistaAlarmPanel1.json

@@ -103 +103 @@
         },
         {
+            "Label": {
+                "lang_tag": "settings",
+                "text": "Settings"
+            },
+            "Position": "1",
+            "TabType": "javascript",
+            "ScriptName": "shared.js",
+            "Function": "simple_device"
+        },
+        {
             "Label": {
                 "lang_tag": "advanced",
                 "text": "Advanced"
             },
-            "Position": "1",
+            "Position": "2",
             "TabType": "javascript",
             "ScriptName": "shared.js",

/trunk/D_VistaAlarmPartition1.json

@@ -568 +568 @@
                 }
             }
+        },
+        "event_3": {
+            "label": "Alarm Active",
+            "serviceId": "urn:micasaverde-com:serviceId:AlarmPartition2",
+            "argumentList" : {
+                "argument_1" : {
+                    "dataType": "boolean",
+                    "defaultValue": "Active",
+                    "allowedValueList" : {
+                        "Active" : "Active",
+                        "NotActive" : "None"
+                    },
+                    "name": "Alarm",
+                    "comparisson": "=",
+                    "prefix": "Is Active?",
+                    "suffix": ""
+                }
+            }
         }
     },
@@ -573 +591 @@
         "group_1": {
             "cmd_1": {
-                "label": "Set Partition ... (PIN)",
+                "label": "Arm/Disarm partition",
                 "serviceId": "urn:micasaverde-com:serviceId:AlarmPartition2",
                 "action": "RequestArmMode",
@@ -600 +618 @@
                         },
                         "prefix" : "PIN",
-                        "suffix" : "0-9999 (insecure)",
+                        "suffix" : "(insecure)",
+                        "name": "PINCode"
+                    }
+                }
+            }
+        },
+        "group_2": {
+            "cmd_1": {
+                "label": "Press lettered key",
+                "serviceId": "urn:micasaverde-com:serviceId:VistaAlarmPanel1",
+                "action": "RequestLetteredKeyPress",
+                "argumentList": {
+                    "argument_1": {
+                        "dataType": "string",
+                        "defaultValue": "D",
+                        "allowedValueList": {
+                            "A" : "A",
+                            "B" : "B",
+                            "C" : "C",
+                            "D" : "D"
+                        },
+                        "name": "Key",
+                        "prefix": "Key",
+                        "suffix": "(A, B, C or D)"
+                    },
+                    "argument_2": {
+                        "dataType": "string",
+                        "defaultValue": "1234",
+                        "allowedValueRange": {
+                            "minimum": "0",
+                            "maximum": "9999"
+                        },
+                        "prefix" : "PIN",
+                        "suffix" : "(insecure)",
+                        "name": "PINCode"
+                    }
+                }
+            }
+        },
+        "group_3": {
+            "cmd_1": {
+                "label": "Change chime mode",
+                "serviceId": "urn:micasaverde-com:serviceId:VistaAlarmPanel1",
+                "action": "SetChimeMode",
+                "argumentList": {
+                    "argument_1": {
+                        "dataType": "boolean",
+                        "defaultValue": "0",
+                        "allowedValueList": {
+                            "1" : "1",
+                            "0" : "0"
+                        },
+                        "name": "Mode",
+                        "prefix": "Mode",
+                        "suffix": "(1 or 0)"
+                    },
+                    "argument_2": {
+                        "dataType": "string",
+                        "defaultValue": "1234",
+                        "allowedValueRange": {
+                            "minimum": "0",
+                            "maximum": "9999"
+                        },
+                        "prefix" : "PIN",
+                        "suffix" : "(insecure)",
                         "name": "PINCode"
                     }

/trunk/S_VistaAlarmPanel1.xml

@@ -73 +73 @@
         </action>
         <action>
+            <name>SetChimeMode</name>
+            <argumentList>
+                <argument>
+                    <name>Mode</name>
+                    <direction>in</direction>
+                    <relatedStateVariable>ChimeMode</relatedStateVariable>
+                </argument>
+                <argument>
+                    <name>PINCode</name>
+                    <direction>in</direction>
+                    <relatedStateVariable>string</relatedStateVariable>
+                </argument>
+            </argumentList>
+        </action>
+        <action>
             <name>StorePinCode</name>
             <argumentList>

/trunk/I_VistaAlarmPanel1.xml

@@ -69 +69 @@
         <action>
             <serviceId>urn:micasaverde-com:serviceId:VistaAlarmPanel1</serviceId>
+            <name>SetChimeMode</name>
+            <run>
+                vistaPlugin.setChimeMode (lul_device, lul_settings.Mode, lul_settings.PINCode)
+            </run>
+        </action>
+
+        <action>
+            <serviceId>urn:micasaverde-com:serviceId:VistaAlarmPanel1</serviceId>
             <name>StorePinCode</name>
             <run>

/trunk/L_VistaAlarmPanel1.lua

@@ -5 +5 @@
 
 -- Constants
-local VERSION = "2.2"
+local VERSION = "2.30"
 local DEBUG_MODE_DEFAULT = "1"
 
@@ -11 +11 @@
 
 local TTL = 60 -- If the panel doesn't report a zone as faulted in this number of seconds, the zone is considered unfaulted.
-               -- The timer is reset every time a fault report for this zone is received.
+            -- The timer is reset every time a fault report for this zone is received.
 local TIMER_INTERVAL = 5 -- The delay used in the 'ttlCountdownTimer' function (luup.call_delay).
 local SLEEP_MS = 250
@@ -17 +17 @@
 local SID = {
     PANEL = "urn:micasaverde-com:serviceId:VistaAlarmPanel1",
-    PARTITION = "urn:micasaverde-com:serviceId:AlarmPartition2"
+    PARTITION = "urn:micasaverde-com:serviceId:AlarmPartition2",
+    SECURITY_SENSOR = "urn:micasaverde-com:serviceId:SecuritySensor1"
 }
 
@@ -45 +46 @@
 
 local g_addrPart = {} -- Table where the keys are the keypad addresses
-                      -- and the values are the partitions assigned to the keypads.
+                    -- and the values are the partitions assigned to the keypads.
 local g_noAddrPart = true -- True if one or more partitions have no associated keypads.
 
 local g_partitions = {
     -- device
-    -- address
     -- armMode
     -- detailedArmMode
     -- chimeMode
     -- pinCode
+}
+
+local g_zones = {
+    -- device
+    -- name
 }
 
@@ -215 +220 @@
 
 
-local function getPartitionNumber (id)
-    if (type (id) == "number") then -- The 'id' is the device number.
-        for k, v in pairs (g_partitions) do
-            if (id == v.device) then
-                return k
-            end
-        end
-    else -- The 'id' is the device altid.
-        local partNo = id:match ("vista_partition_(%d+)")
-        return tonumber (partNo, 10)
+local function getPartitionNumber (deviceNo)
+    for k, v in pairs (g_partitions) do
+        if (deviceNo == v.device) then
+            return k
+        end
     end
 
@@ -313 +313 @@
 function bypassZones (device, zones, pinCode)
 
-    debug (string.format ("(bypassZones) Bypass zones: %s, device #%s.", tostring (zones), tostring (device)))
+    debug (string.format ("(bypassZones) Bypass zones: %s, device #%d.", tostring (zones), device))
 
     -- Check if the PIN code exists and is valid.
@@ -391 +391 @@
 
 
+function setChimeMode (device, mode, pinCode)
+    debug (string.format ("(setChimeMode) Set chime mode to '%s' for device #%s.", tostring (mode), device))
+
+    -- Check if the PIN code exists and is valid.
+    if (not pinCode) then
+        log ("(setChimeMode) ERROR: PIN code required.")
+        task ("PIN code required for changing the chime mode.", TASK.ERROR)
+        return false
+    elseif (not pinCode:match ("^%d%d%d%d$")) then
+        log ("(setChimeMode) ERROR: Invalid PIN code.")
+        task ("Invalid PIN code.", TASK.ERROR)
+        return false
+    end
+
+    -- Find the partition number.
+    local partNo = (g_nPartitions > 1) and getPartitionNumber (device) or 1
+    debug ("(setChimeMode) partNo = " .. partNo)
+
+    if (g_nPartitions > 1) then -- Send the GOTO command first.
+        local command = pinCode .. "*" .. partNo
+        luup.io.write (command)
+        luup.sleep (SLEEP_MS)
+    end
+
+    if (g_partitions[partNo].chimeMode ~= mode) then -- We're not already in the requested mode.
+        local command = pinCode .. "9"
+        luup.io.write (command)
+    end
+
+    -- Store the PIN code to be used for sending '*'.
+    g_partitions[partNo].pinCode = pinCode
+
+    return true
+end
+
+
 function storePinCode (device, pinCode)
 
@@ -429 +465 @@
 
 
+local function updateDevice (zone, tripped)
+
+    -- If a device for this zone doesn't exist, create it.
+    -- If it does, set Tripped = <tripped>.
+    if (not g_zones[zone]) then
+        g_zones[zone] = {}
+        local parameters = SID.SECURITY_SENSOR .. ",Armed=1\n" .. SID.SECURITY_SENSOR .. ",Tripped=" .. tripped
+        local ptr = luup.chdev.start (lug_device)
+        luup.chdev.append (lug_device, ptr, "vista_zone_" .. zone, "Vista Zone #" .. zone, "urn:schemas-micasaverde-com:device:MotionSensor:1", "D_MotionSensor1.xml", "", parameters, false)
+        luup.chdev.sync (lug_device, ptr)
+    else
+        luup.variable_set (SID.SECURITY_SENSOR, "Tripped", tripped, g_zones[zone].device)
+    end
+end
+
+
 local function addFaultedZone (zone)
     if (not zone) then
@@ -435 +487 @@
     end
 
-    local newZone = (not g_faultedZones[zone]) and true or false -- Check if this zone isn't already in the list.
-
     g_faultedZones[zone] = TTL -- Add or refresh the TTL.
     debug (string.format ("(addFaultedZone) Zone %d TTL = %d", zone, g_faultedZones[zone]))
 
-    if (newZone) then -- Update this variable only if we have a new zone.
-        luup.variable_set (SID.PANEL, "FaultedZones", table.concatKeys (g_faultedZones, ","), lug_device)
-        debug ("(addFaultedZone) Added zone #" .. zone .. ".")
-    end
+    updateDevice (zone, "1")
 end
 
@@ -459 +506 @@
 
     g_faultedZones[zone] = nil
-
-    local faultedZones = table.concatKeys (g_faultedZones, ",")
-    if (faultedZones == "") then
-        faultedZones = "none"
-    end
-    luup.variable_set (SID.PANEL, "FaultedZones", faultedZones, lug_device)
-
     debug ("(removeFaultedZone) Removed zone #" .. zone .. ".")
+
+    updateDevice (zone, "0")
 end
 
@@ -569 +611 @@
 
 
-local function checkForAlarms (flags, partNo)
+local function checkForAlarms (flags, zone, partNo)
 
     if (flags.FIRE_ALARM or flags.ALARM) then
-        local alarmText = flags.FIRE_ALARM and "FIRE ALARM!" or "ALARM!"
-        log ("(checkForAlarms) " .. alarmText)
-        task (alarmText, TASK.ERROR_PERM)
-
         local alarm = getPartitionState (partNo, "Alarm")
         if (alarm ~= "Active") then
+            zone = tonumber (zone, 10)
+            local zoneInfo = string.format ("%s (device #%d, zone #%d)", g_zones[zone].name, g_zones[zone].device, zone)
+            local alarmInfo = flags.FIRE_ALARM and ("FIRE ALARM! " .. zoneInfo) or ("ALARM! " .. zoneInfo)
+            log ("(checkForAlarms) " .. alarmInfo)
+            task (alarmInfo, TASK.ERROR_PERM)
+
+            -- Add the faulted zone that caused the alarm to the list.
+            addFaultedZone (zone)
+
+            local alarmMemory = flags.ALARM_MEMORY and "1" or "0"
+            setPartitionState (partNo, "AlarmMemory", alarmMemory)
+
             setPartitionState (partNo, "Alarm", "Active")
         end
 
+        return true
+    end
+
+    local alarm = getPartitionState (partNo, "Alarm")
+    if (alarm ~= "None") then
+        setPartitionState (partNo, "Alarm", "None")
         local alarmMemory = flags.ALARM_MEMORY and "1" or "0"
         setPartitionState (partNo, "AlarmMemory", alarmMemory)
-
-        return true
-    else
-        local alarm = getPartitionState (partNo, "Alarm")
-        if (alarm ~= "None") then
-            setPartitionState (partNo, "Alarm", "None")
-        end
-    end
+    end
+
+    return false
 end
 
@@ -608 +659 @@
 
     local debugString = "(getAddressBitMask) bitMask = " ..
-                        table.concat (bitMask, "", 1, 8) .. " " ..
-                        table.concat (bitMask, "", 9, 16) .. " " ..
-                        table.concat (bitMask, "", 17, 24) .. " " ..
-                        table.concat (bitMask, "", 25, 32)
+                        table.concat (bitMask, "", 1, 8) .. " " ..
+                        table.concat (bitMask, "", 9, 16) .. " " ..
+                        table.concat (bitMask, "", 17, 24) .. " " ..
+                        table.concat (bitMask, "", 25, 32)
     debug (debugString)
     return bitMask
@@ -721 +772 @@
         for _, partNo in pairs (targetPartitions) do
             -- Check if we have any alarms.
-            if (checkForAlarms (flags, partNo)) then
+            if (checkForAlarms (flags, sections[2], partNo)) then
                 return false
             end
@@ -747 +798 @@
 
 
-local function getPartitionDevices()
+local function getChildDevices()
+
     for k, v in pairs (luup.devices) do
         if (v.device_num_parent == lug_device) then
-            local partNo = getPartitionNumber (v.id)
-            if (partNo) then
-                debug (string.format ("(getPartitionDevices) Partition %d device number = %d", partNo, k))
-                g_partitions[partNo] = {device = k}
-            else
-                log (string.format ("(getPartitionDevices) Found unexpected child: device #%d, id=%s", k, tostring (v.id)))
-                task (string.format ("Found unexpected child: device #%d, id=%s", k, tostring (v.id)), TASK.ERROR)
+            if (v.id:match ("^vista_zone") ~= nil) then -- The device is a zone.
+                local zoneNo = v.id:match ("^vista_zone_(%d+)$")
+                zoneNo = tonumber (zoneNo, 10)
+                g_zones[zoneNo].device = k
+                g_zones[zoneNo].name = v.description
+                debug (string.format ("(getChildDevices) Zone #%d device number = %d, name = %s", zoneNo, k, v.description))
+            elseif (v.id:match ("^vista_partition") ~= nil) then -- The device is a partition.
+                local partNo = v.id:match ("^vista_partition_(%d+)$")
+                g_partitions[tonumber (partNo, 10)] = {device = k}
+                debug (string.format ("(getChildDevices) Partition %s device number = %d.", partNo, k))
+            else -- Bastard child.
+                log (string.format ("(getChildDevices) Found unexpected child: device #%d, description = %s", k, tostring (v.description)))
+                task (string.format ("Found unexpected child: device #%d, name = %s", k, tostring (v.description)), TASK.ERROR)
             end
         end
@@ -848 +906 @@
     luup.chdev.sync (lug_device, rootPtr)
 
-    getPartitionDevices()
+    getChildDevices()
 
     -- Get the partitions assigned to each keypad.
@@ -855 +913 @@
         return false, message, "Ademco Vista Plugin"
     end
-
-    luup.variable_set (SID.PANEL, "FaultedZones", "none", lug_device)
 
     -- Get the TTL.