Merge pull request #476 from SmartThingsCommunity/bugfix/CHAD-10123

CHAD-10123 Fix Stelpro thermostat setpoint logic

Author: greens

drivers/SmartThings/zwave-thermostat/profiles/thermostat-temperature-temperaturealarm.yml

@@ -9,7 +9,7 @@ components:
     config:
       values:
         - key: "heatingSetpoint.value"
-          range: [ 4, 28 ]
+          range: [ 5, 30 ]
   - id: thermostatMode
     version: 1
   - id: thermostatOperatingState

drivers/SmartThings/zwave-thermostat/src/init.lua

@@ -17,31 +17,27 @@ local capabilities = require "st.capabilities"
 local ZwaveDriver = require "st.zwave.driver"
 --- @type st.zwave.defaults
 local defaults = require "st.zwave.defaults"
---- @type st.zwave.CommandClass.Battery
-local Battery = (require "st.zwave.CommandClass.Battery")({version=1})
---- @type st.zwave.CommandClass.SensorMultilevel
-local SensorMultilevel = (require "st.zwave.CommandClass.SensorMultilevel")({version=2})
+--- @type st.zwave.CommandClass
+local cc = require "st.zwave.CommandClass"
 --- @type st.zwave.CommandClass.ThermostatFanMode
 local ThermostatFanMode = (require "st.zwave.CommandClass.ThermostatFanMode")({version=3})
 --- @type st.zwave.CommandClass.ThermostatMode
 local ThermostatMode = (require "st.zwave.CommandClass.ThermostatMode")({version=2})
---- @type st.zwave.CommandClass.ThermostatOperatingState
-local ThermostatOperatingState = (require "st.zwave.CommandClass.ThermostatOperatingState")({version=1})
 --- @type st.zwave.CommandClass.ThermostatSetpoint
 local ThermostatSetpoint = (require "st.zwave.CommandClass.ThermostatSetpoint")({version=1})
 local constants = require "st.zwave.constants"
 local utils = require "st.utils"
 
-local do_refresh = function(self, device)
-  device:send(ThermostatFanMode:SupportedGet({}))
-  device:send(ThermostatFanMode:Get({}))
-  device:send(ThermostatMode:SupportedGet({}))
-  device:send(ThermostatMode:Get({}))
-  device:send(ThermostatOperatingState:Get({}))
-  device:send(SensorMultilevel:Get({}))
-  device:send(ThermostatSetpoint:Get({setpoint_type = ThermostatSetpoint.setpoint_type.COOLING_1}))
-  device:send(ThermostatSetpoint:Get({setpoint_type = ThermostatSetpoint.setpoint_type.HEATING_1}))
-  device:send(Battery:Get({}))
+local function device_added(driver, device)
+  if device:supports_capability_by_id(capabilities.thermostatMode.ID) and
+    device:is_cc_supported(cc.THERMOSTAT_MODE) then
+    device:send(ThermostatMode:SupportedGet({}))
+  end
+  if device:supports_capability_by_id(capabilities.thermostatFanMode.ID) and
+    device:is_cc_supported(cc.THERMOSTAT_FAN_MODE) then
+    device:send(ThermostatFanMode:SupportedGet({}))
+  end
+  device:refresh()
 end
 
 --TODO: Update this once we've decided how to handle setpoint commands
@@ -90,16 +86,16 @@ local driver_template = {
     capabilities.energyMeter
   },
   capability_handlers = {
-    [capabilities.refresh.ID] = {
-      [capabilities.refresh.commands.refresh.NAME] = do_refresh
-    },
     [capabilities.thermostatCoolingSetpoint.ID] = {
       [capabilities.thermostatCoolingSetpoint.commands.setCoolingSetpoint.NAME] = set_setpoint_factory(ThermostatSetpoint.setpoint_type.COOLING_1)
     },
     [capabilities.thermostatHeatingSetpoint.ID] = {
       [capabilities.thermostatHeatingSetpoint.commands.setHeatingSetpoint.NAME] = set_setpoint_factory(ThermostatSetpoint.setpoint_type.HEATING_1)
     }
   },
+  lifecycle_handlers = {
+    added = device_added
+  },
   sub_drivers = {
     require("aeotec-radiator-thermostat"),
     require("popp-radiator-thermostat"),

drivers/SmartThings/zwave-thermostat/src/stelpro-ki-thermostat/init.lua

@@ -14,22 +14,13 @@
 
 local log = require "log"
 local capabilities = require "st.capabilities"
---- @type st.utils
-local utils = require "st.utils"
 --- @type st.zwave.CommandClass
 local cc = require "st.zwave.CommandClass"
---- @type st.zwave.constants
-local constants = require "st.zwave.constants"
---- @type st.zwave.CommandClass.ThermostatSetpoint
-local ThermostatSetpoint = (require "st.zwave.CommandClass.ThermostatSetpoint")({ version = 1 })
 --- @type st.zwave.CommandClass.SensorMultilevel
 local SensorMultilevel = (require "st.zwave.CommandClass.SensorMultilevel")({ version = 5 })
 --- @type st.zwave.CommandClass.ThermostatMode
 local ThermostatMode = (require "st.zwave.CommandClass.ThermostatMode")({ version = 2 })
 
-local THERMOSTAT_MIN_HEATING_SETPOINT = 5.0
-local THERMOSTAT_MAX_HEATING_SETPOINT = 30.0
-
 local STELPRO_KI_THERMOSTAT_FINGERPRINTS = {
   { manufacturerId = 0x0239, productType = 0x0001, productId = 0x0001 } -- Stelpro Ki Thermostat
 }
@@ -44,35 +35,6 @@ local function can_handle_stelpro_ki_thermostat(opts, driver, device, cmd, ...)
   return false
 end
 
-local function set_heating_setpoint(driver, device, command)
-  local value = command.args.setpoint
-  if (value >= 40) then -- assume this is a fahrenheit value
-    value = utils.f_to_c(value)
-  end
-  if THERMOSTAT_MIN_HEATING_SETPOINT <= value and THERMOSTAT_MAX_HEATING_SETPOINT >= value then
-    local scale = device:get_field(constants.TEMPERATURE_SCALE)
-    if (scale == ThermostatSetpoint.scale.FAHRENHEIT) then
-      value = utils.c_to_f(value) -- the device has reported using F, so set using F
-    end
-
-    local set = ThermostatSetpoint:Set({
-      setpoint_type = ThermostatSetpoint.setpoint_type.HEATING_1,
-      scale = scale,
-      value = value
-    })
-    device:send_to_component(set, command.component)
-
-    local follow_up_poll = function()
-      device:send_to_component(
-        ThermostatSetpoint:Get({setpoint_type = ThermostatSetpoint.setpoint_type.HEATING_1}),
-        command.component
-      )
-    end
-
-    device.thread:call_with_delay(1, follow_up_poll)
-  end
-end
-
 local function sensor_multilevel_report_handler(self, device, cmd)
   if (cmd.args.sensor_type == SensorMultilevel.sensor_type.TEMPERATURE) then
     if cmd.args.scale ~= SensorMultilevel.scale.temperature.CELSIUS and cmd.args.scale ~= SensorMultilevel.scale.temperature.FAHRENHEIT then
@@ -115,22 +77,6 @@ local function thermostat_mode_report_handler(self, device, cmd)
   end
 end
 
-local function thermostat_supported_modes_report_handler(self, device, cmd)
-  -- The DTH for this device supported heat and eco, so we've mirrored that here, despite
-  -- the existing, more accurate "energy save heat" mode
-  local supported_modes = {}
-  table.insert(supported_modes, capabilities.thermostatMode.thermostatMode.heat.NAME)
-  table.insert(supported_modes, capabilities.thermostatMode.thermostatMode.eco.NAME)
-
-  device:emit_event_for_endpoint(
-    cmd.src_channel,
-    capabilities.thermostatMode.supportedThermostatModes(
-      supported_modes,
-      { visibility = { displayed = false }}
-    )
-  )
-end
-
 local function set_thermostat_mode(driver, device, command)
   local modes = capabilities.thermostatMode.thermostatMode
   local mode = command.args.mode
@@ -158,6 +104,19 @@ end
 
 local function device_added(self, device)
   -- device:emit_event(capabilities.temperatureAlarm.temperatureAlarm.cleared())
+
+  -- The DTH for this device supported heat and eco, so we've mirrored that here, despite
+  -- the existing, more accurate "energy save heat" mode
+  local supported_modes = {}
+  table.insert(supported_modes, capabilities.thermostatMode.thermostatMode.heat.NAME)
+  table.insert(supported_modes, capabilities.thermostatMode.thermostatMode.eco.NAME)
+
+  device:emit_event(
+    capabilities.thermostatMode.supportedThermostatModes(
+      supported_modes,
+      { visibility = { displayed = false }}
+    )
+  )
 end
 
 local stelpro_ki_thermostat = {
@@ -168,13 +127,10 @@ local stelpro_ki_thermostat = {
     },
     [cc.THERMOSTAT_MODE] = {
       [ThermostatMode.REPORT] = thermostat_mode_report_handler,
-      [ThermostatMode.SUPPORTED_REPORT] = thermostat_supported_modes_report_handler
+      [ThermostatMode.SUPPORTED_REPORT] = function(driver, device, cmd) end
     }
   },
   capability_handlers = {
-    [capabilities.thermostatHeatingSetpoint.ID] = {
-      [capabilities.thermostatHeatingSetpoint.commands.setHeatingSetpoint.NAME] = set_heating_setpoint
-    },
     [capabilities.thermostatMode.ID] = {
       [capabilities.thermostatMode.commands.setThermostatMode.NAME] = set_thermostat_mode
     }

drivers/SmartThings/zwave-thermostat/src/test/test_stelpro_ki_thermoestat.lua renamed to drivers/SmartThings/zwave-thermostat/src/test/test_stelpro_ki_thermostat.lua

@@ -69,17 +69,6 @@ test.register_coroutine_test(
   end
 )
 
-test.register_coroutine_test(
-  "Setting heating setpoint should not be handled",
-  function()
-    mock_device:set_field(constants.TEMPERATURE_SCALE, 1, {persist = true})
-
-    test.timer.__create_and_queue_test_time_advance_timer(1, "oneshot")
-    test.socket.capability:__queue_receive({ mock_device.id, { capability = "thermostatHeatingSetpoint", command = "setHeatingSetpoint", args = { 333.0 } } })
-  end
-)
-
-
 test.register_message_test(
   "Sensor multilevel report (33 CELCIUS) should be handled",
   {
@@ -88,6 +77,13 @@ test.register_message_test(
       direction = "receive",
       message = { mock_device.id, "added" }
     },
+    {
+      channel = "capability",
+      direction = "send",
+      message = mock_device:generate_test_message("main", capabilities.thermostatMode.supportedThermostatModes({
+        "heat", "eco"
+      }, {visibility={displayed=false}}))
+    },
     {
       channel = "zwave",
       direction = "receive",
@@ -117,6 +113,13 @@ test.register_message_test(
       direction = "receive",
       message = { mock_device.id, "added" }
     },
+    {
+      channel = "capability",
+      direction = "send",
+      message = mock_device:generate_test_message("main", capabilities.thermostatMode.supportedThermostatModes({
+        "heat", "eco"
+      }, {visibility={displayed=false}}))
+    },
     {
       channel = "zwave",
       direction = "receive",
@@ -151,6 +154,13 @@ test.register_message_test(
     --   direction = "send",
     --   message = mock_device:generate_test_message("main", capabilities.temperatureAlarm.temperatureAlarm.cleared())
     -- },
+    {
+      channel = "capability",
+      direction = "send",
+      message = mock_device:generate_test_message("main", capabilities.thermostatMode.supportedThermostatModes({
+        "heat", "eco"
+      }, {visibility={displayed=false}}))
+    },
     {
       channel = "zwave",
       direction = "receive",
@@ -185,6 +195,13 @@ test.register_message_test(
     --   direction = "send",
     --   message = mock_device:generate_test_message("main", capabilities.temperatureAlarm.temperatureAlarm.cleared())
     -- },
+    {
+      channel = "capability",
+      direction = "send",
+      message = mock_device:generate_test_message("main", capabilities.thermostatMode.supportedThermostatModes({
+        "heat", "eco"
+      }, {visibility={displayed=false}}))
+    },
     {
       channel = "zwave",
       direction = "receive",
@@ -219,6 +236,13 @@ test.register_message_test(
     --   direction = "send",
     --   message = mock_device:generate_test_message("main", capabilities.temperatureAlarm.temperatureAlarm.cleared())
     -- },
+    {
+      channel = "capability",
+      direction = "send",
+      message = mock_device:generate_test_message("main", capabilities.thermostatMode.supportedThermostatModes({
+        "heat", "eco"
+      }, {visibility={displayed=false}}))
+    },
     {
       channel = "zwave",
       direction = "receive",
@@ -248,6 +272,13 @@ test.register_message_test(
     --   direction = "send",
     --   message = mock_device:generate_test_message("main", capabilities.temperatureAlarm.temperatureAlarm.cleared())
     -- },
+    {
+      channel = "capability",
+      direction = "send",
+      message = mock_device:generate_test_message("main", capabilities.thermostatMode.supportedThermostatModes({
+        "heat", "eco"
+      }, {visibility={displayed=false}}))
+    },
     {
       channel = "zwave",
       direction = "receive",
@@ -265,7 +296,7 @@ test.register_message_test(
 )
 
 test.register_message_test(
-  "Supported thermostat modes report should generate an event with heat and eco, regardless of content",
+  "Supported thermostat modes report should generate nothing",
   {
     {
       channel = "zwave",
@@ -275,13 +306,6 @@ test.register_message_test(
         cool = true,
         energy_save_heat = true
       })) }
-    },
-    {
-      channel = "capability",
-      direction = "send",
-      message = mock_device:generate_test_message("main", capabilities.thermostatMode.supportedThermostatModes({
-        "heat", "eco"
-      }, {visibility={displayed=false}}))
     }
   }
 )