Changeset 45

Timestamp:

2012-11-02 20:18:57 (12 years ago)

Author:

lolodomo

Message:

Support for Mertik-Maxitrol thermostats added (nirb contrib)

Location:

trunk

Files:

• I_RFXtrx.xml (modified) (1 diff)
• L_RFXtrx.lua (modified) (12 diffs)

trunk/I_RFXtrx.xml ¶

@@ -397 +397 @@
       <run>if (pluginLib ~= nil) then pluginLib.sendATICode(lul_device, lul_settings.Code or "") end</run>
     </action>
+    <action>
+        <serviceId>urn:upnp-org:serviceId:HVAC_UserOperatingMode1</serviceId>
+        <name>SetModeTarget</name>
+        <run>if (pluginLib ~= nil) then pluginLib.setModeTarget(lul_device, lul_settings.NewModeTarget) end</run>
+    </action>
+    <action>
+        <serviceId>urn:micasaverde-com:serviceId:HaDevice1</serviceId>
+        <name>ToggleState</name>
+        <run>if (pluginLib ~= nil) then pluginLib.toggleState(lul_device) end</run>
+    </action>
     </actionList>
 </implementation>

trunk/L_RFXtrx.lua ¶

@@ -48 +48 @@
     LIGHTING_BLYSS = { 0x15, 0x0, 11, nil, "Thomson", "Blyss" },
     
+    HEATER3_MERTIK1 = { 0x42, 0x0, 8, nil, "Mertik", "Mertik Maxitrol G6R-H4T1" },
+    HEATER3_MERTIK2 = { 0x42, 0x1, 8, nil, "Mertik", "Mertik Maxitrol G6R-H4TB" },
+
     TEMP1 = { 0x50, 0x1, 8, nil, "Oregon Scientific", "THR128/138, THC138" },
     TEMP2 = { 0x50, 0x2, 8, nil, "Oregon Scientific", "THC238/268, THN132, THWR288, THRN122, THN122, AW129/131" },
@@ -175 +178 @@
     CMD_ATI_SCENE_ON = { "ATISceneOn", "ATI_REMOTE", "VAR_SCENE_ON" },
     CMD_ATI_SCENE_OFF = { "ATISceneOff", "ATI_REMOTE", "VAR_SCENE_OFF" },
+    CMD_HEATER = { "Heater", "HEATER", "VAR_HEATER" },
+    CMD_HEATER_SW = { "HeaterSwitch", "HEATER", "VAR_HEATER_SW" },
+    CMD_HEATER_UP = { "HeaterUp", "HEATER", nil },
+    CMD_HEATER_DOWN = { "HeaterDown", "HEATER", nil }
 }
 
@@ -213 +220 @@
     VAR_SCENE_OFF = { "urn:micasaverde-com:serviceId:SceneController1", "sl_SceneDeactivated", false, false },
     VAR_EXIT_DELAY = { "urn:rfxcom-com:serviceId:SecurityRemote1", "ExitDelay", false, false },
-    
+    VAR_HEATER = { "urn:upnp-org:serviceId:HVAC_UserOperatingMode1", "ModeStatus", false, false },
+    VAR_HEATER_SW = { "urn:upnp-org:serviceId:SwitchPower1", "Status", false, false },
+    --VAR_HEATER_HA = { "urn:micasaverde-com:serviceId:HaDevice1", "Status", false, false },
+
     VAR_PLUGIN_VERSION = { "upnp-rfxcom-com:serviceId:rfxtrx1", "PluginVersion", false, false },
     VAR_AUTO_CREATE = { "upnp-rfxcom-com:serviceId:rfxtrx1", "AutoCreate", true, false },
@@ -272 +282 @@
     REMOTE = { "urn:rfxcom-com:device:X10ChaconRemote:1", "D_X10ChaconRemote1.xml", "RFX Remote ", "RC/", false, false, false },
     LWRF_REMOTE = { "urn:rfxcom-com:device:LWRFRemote:1", "D_LWRFRemote1.xml", "RFX Remote ", "RC/", false, false, false },
-    ATI_REMOTE = { "urn:rfxcom-com:device:ATIRemote:1", "D_ATIRemote1.xml", "RFX Remote ", "RC/", false, false, false }
+    ATI_REMOTE = { "urn:rfxcom-com:device:ATIRemote:1", "D_ATIRemote1.xml", "RFX Remote ", "RC/", false, false, false },
+    HEATER = { "urn:schemas-upnp-org:device:Heater:1", "D_Heater1.xml", "RFX Heater ", "HT/", false, false, false }
 }
 
@@ -389 +400 @@
     tableMsgTypes.LIGHTING_LIGHTWARERF[4] = decodeLighting5
     tableMsgTypes.LIGHTING_BLYSS[4] = decodeLighting6
+    tableMsgTypes.HEATER3_MERTIK1[4] = decodeThermostat3
+    tableMsgTypes.HEATER3_MERTIK2[4] = decodeThermostat3
     tableMsgTypes.TEMP1[4] = decodeTemp
     tableMsgTypes.TEMP2[4] = decodeTemp
@@ -683 +696 @@
     then
         category = 7
+    elseif ((string.len(id) == 15) and (string.sub(id, 1, 5) == "HT/HT") and (string.sub(id, 7, 7) == ".")  and (string.sub(id, 9, 9) == "/"))
+    then
+        category = 8
     else
         log("Unexpected device id " .. id .. ". Switch Power command not sent", 2)
@@ -852 +868 @@
                                 cmdCode, 0)
         end
+    -- elseif (category == 8)
+    -- then
+        -- TODO: Mertik
     else
         log("Unimpemented lighting type " .. category .. ". Switch Power command not sent", 2)
@@ -1502 +1521 @@
 end
 
+function setModeTarget(device, NewModeTarget)
+    local id = luup.devices[device].id
+    log("setModeTarget " .. id .. " target " .. NewModeTarget)
+
+    local category
+    if ((string.len(id) == 15) and (string.sub(id, 1, 5) == "HT/HT") and (string.sub(id, 7, 7) == ".")  and (string.sub(id, 9, 9) == "/"))
+    then
+        category = 3
+    else
+        log("Unexpected device id " .. id .. ". Set Mode command not sent", 2)
+        return
+    end
+
+    local type = nil
+    local subType = nil
+    local data = nil
+
+    if (category == 3) -- Mertik
+    then
+        type = tableMsgTypes.HEATER3_MERTIK1[1]
+        subType = tonumber(string.sub(id, 8, 8))
+        local tableCmds = {}
+        local cmdCode = nil
+        --local currentState = luup.variable_get(tabVars.VAR_HEATER[1], tabVars.VAR_HEATER[2], device) or "Off"
+        local currentSwState = luup.variable_get(tabVars.VAR_HEATER_SW[1], tabVars.VAR_HEATER_SW[2], device) or "0"
+        if (NewModeTarget == "HeatOn")
+        then
+            if (currentSwState == "0")
+            then
+                cmdCode = 0x01 -- Turn on
+                table.insert(tableCmds, { string.sub(id, 4), tableCommands.CMD_HEATER_SW[1], 1, 0 })
+                table.insert(tableCmds, { string.sub(id, 4), tableCommands.CMD_HEATER[1], "HeatOn", 0 })
+            else
+                cmdCode = 0x04 -- Run up
+                table.insert(tableCmds, { string.sub(id, 4), tableCommands.CMD_HEATER[1], "HeatOn", 0 })
+            end
+        elseif (NewModeTarget == "Off")
+        then
+            if (currentSwState == "1")
+            then
+                cmdCode = 0x00 -- Turn off
+                table.insert(tableCmds, { string.sub(id, 4), tableCommands.CMD_HEATER_SW[1], 0, 0 })
+                table.insert(tableCmds, { string.sub(id, 4), tableCommands.CMD_HEATER[1], "Off", 0 })
+            else
+                cmdCode = 0x05 -- Run down
+                table.insert(tableCmds, { string.sub(id, 4), tableCommands.CMD_HEATER[1], "Off", 0 })
+            end
+        else
+            log("setModeTarget: unexpected value for NewModeTarget parameter", 2)
+            return
+        end
+        local remoteId = string.sub(id, 10, 15)
+        data = string.char(tonumber(string.sub(remoteId, 1, 2), 16),
+                            tonumber(string.sub(remoteId, 3, 4), 16),
+                            tonumber(string.sub(remoteId, 5, 6), 16),
+                            cmdCode, 0)
+    end
+
+    if (data ~= nil)
+    then
+        sendCommand(type, subType, data, tableCmds)
+    end
+
+end
+
+function toggleState(device)
+    local devType = string.sub(luup.devices[device].id, 1, 2)
+    
+    -- Only implemented for Light Switches and HeaTers so far
+    if (devType == "LS") 
+    then
+        local curStat = luup.variable_get(tabVars.VAR_LIGHT[1], tabVars.VAR_LIGHT[2], device) or "0"
+        local newTargetState
+        if (curStat == "0")
+        then
+            newTargetState = "1"
+        else
+            newTargetState = "0"
+        end
+        switchPower(device, newTargetState)
+    elseif (devType == "HT")
+    then
+        local curStat = luup.variable_get(tabVars.VAR_HEATER[1], tabVars.VAR_HEATER[2], device) or "Off"
+        local NewModeTarget
+        if (curStat == "Off")
+        then
+            NewModeTarget = "HeatOn"
+        else
+            NewModeTarget = "Off"
+        end
+        setModeTarget(device, NewModeTarget)
+    end
+end
+
 function addX10Switch(houseCode, unitCode)
 
@@ -2864 +2977 @@
     return tableCmds
     
+end
+
+function decodeThermostat3(subType, data, seqNum)
+
+    local altid = "HT3." .. subType .. "/"
+                        .. string.format("%02X", tonumber(string.byte(data, 1)))
+                        .. string.format("%02X", tonumber(string.byte(data, 2)))
+                        .. string.format("%02X", tonumber(string.byte(data, 3)))
+
+    local tableCmds = {}
+    local cmdCode = string.byte(data, 4)
+    
+    -- 0: "Off", 1: "On", 2: "Up", 3: "Down", 4: "Run Up/2nd Off", 5: "Run Down/2nd On", 6: "Stop"
+    if (cmdCode == 0x00)
+    then
+        table.insert(tableCmds, { altid, tableCommands.CMD_HEATER_SW[1], 0, 0 } )
+        table.insert(tableCmds, { altid, tableCommands.CMD_HEATER[1], "Off", 0 } )
+    elseif (cmdCode == 0x01)
+    then
+        table.insert(tableCmds, { altid, tableCommands.CMD_HEATER_SW[1], 1, 0 } )
+        table.insert(tableCmds, { altid, tableCommands.CMD_HEATER[1], "HeatOn", 0 } )
+    elseif (cmdCode == 0x02)
+    then
+        table.insert(tableCmds, { altid, tableCommands.CMD_HEATER_UP[1], nil, 0 } )
+    elseif (cmdCode == 0x03)
+    then
+        table.insert(tableCmds, { altid, tableCommands.CMD_HEATER_DOWN[1], nil, 0 } )
+    elseif (cmdCode == 0x04)
+    then
+        if (subType == 0x00)
+        then
+            table.insert(tableCmds, { altid, tableCommands.CMD_HEATER[1], "HeatOn", 0 } )
+        else
+            --table.insert(tableCmds, { altid, tableCommands.CMD_HEATER_2NDOFF[1], 0, 0 } )
+        end
+    elseif (cmdCode == 0x05)
+    then
+        if (subType == 0x00)
+        then
+            table.insert(tableCmds, { altid, tableCommands.CMD_HEATER[1], "Off", 0 } )
+        else
+            --table.insert(tableCmds, { altid, tableCommands.CMD_HEATER_2NDON[1], 0, 0 } )
+        end
+    elseif (cmdCode == 0x06) and (subType == 0x00)
+    then
+        table.insert(tableCmds, { altid, tableCommands.CMD_HEATER[1], "Off", 0 } )
+    else
+        log("Thermostat3 command not yet implemented: " .. cmdCode, 2)
+    end
+
+    return tableCmds
+
 end
 
@@ -4221 +4386 @@
     local countSR = 0
     local countRC = 0
+    local countHT = 0
     for i, v in ipairs(tableDevices)
     do
@@ -4269 +4435 @@
         then
             countRC = countRC + 1
+        elseif (key == "HEATER")
+        then
+            countHT = countHT + 1
         end
     end
@@ -4287 +4456 @@
     log("   security remotes: " .. countSR)
     log("    remote controls: " .. countRC)
+    log("    heating devices: " .. countHT)
 
 end