Skip to content

Matter Thermostat: Improve test coverage and fix test cases for lower lua libs #2083

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
+1,724 −222
Open

Matter Thermostat: Improve test coverage and fix test cases for lower lua libs #2083

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0a6ab88
Fix water heater test for api 10
nickolas-deboom Apr 18, 2025
a7cf557
Matter Thermostat: Improve test coverage and backwards compatibility
nickolas-deboom Apr 18, 2025
bf489d7
Add test cases for Room AC and Air Purifier
nickolas-deboom Apr 18, 2025
abf55ad
Add test cases and subscribe to FanModeSequence
nickolas-deboom Apr 21, 2025
37d92a4
Add and update additional test cases
nickolas-deboom Apr 22, 2025
881effe
Fix new test cases for api v10
nickolas-deboom Apr 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
233 changes: 115 additions & 118 deletions drivers/SmartThings/matter-thermostat/src/init.lua
View file

Large diffs are not rendered by default.

466 changes: 460 additions & 6 deletions drivers/SmartThings/matter-thermostat/src/test/test_matter_air_purifier.lua
View file

Large diffs are not rendered by default.

106 changes: 54 additions & 52 deletions drivers/SmartThings/matter-thermostat/src/test/test_matter_fan.lua
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
-- Copyright 2024 SmartThings
-- Copyright 2025 SmartThings
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
@@ -11,79 +11,81 @@
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.

local test = require "integration_test"
local t_utils = require "integration_test.utils"

local clusters = require "st.matter.clusters"

local mock_device = test.mock_device.build_test_matter_device({
profile = t_utils.get_profile_definition("fan-rock-wind.yml"),
manufacturer_info = {
vendor_id = 0x0000,
product_id = 0x0000,
profile = t_utils.get_profile_definition("fan-rock-wind.yml"),
manufacturer_info = {
vendor_id = 0x0000,
product_id = 0x0000,
},
endpoints = {
{
endpoint_id = 0,
clusters = {
{cluster_id = clusters.Basic.ID, cluster_type = "SERVER"},
},
device_types = {
{device_type_id = 0x0016, device_type_revision = 1,} -- RootNode
}
},
endpoints = {
{
endpoint_id = 0,
clusters = {
{cluster_id = clusters.Basic.ID, cluster_type = "SERVER"},
},
device_types = {
{device_type_id = 0x0016, device_type_revision = 1,} -- RootNode
}
{
endpoint_id = 1,
clusters = {
{cluster_id = clusters.FanControl.ID, cluster_type = "SERVER", feature_map = 15},
},
{
endpoint_id = 1,
clusters = {
{cluster_id = clusters.FanControl.ID, cluster_type = "SERVER", feature_map = 15},
},
device_types = {
{device_type_id = 0x002B, device_type_revision = 1,} -- Fan
}
device_types = {
{device_type_id = 0x002B, device_type_revision = 1,} -- Fan
}
}
}
})

local mock_device_generic = test.mock_device.build_test_matter_device({
profile = t_utils.get_profile_definition("fan-generic.yml"),
manufacturer_info = {
vendor_id = 0x0000,
product_id = 0x0000,
profile = t_utils.get_profile_definition("fan-generic.yml"),
manufacturer_info = {
vendor_id = 0x0000,
product_id = 0x0000,
},
endpoints = {
{
endpoint_id = 0,
clusters = {
{cluster_id = clusters.Basic.ID, cluster_type = "SERVER"},
},
device_types = {
{device_type_id = 0x0016, device_type_revision = 1,} -- RootNode
}
},
endpoints = {
{
endpoint_id = 0,
clusters = {
{cluster_id = clusters.Basic.ID, cluster_type = "SERVER"},
},
device_types = {
{device_type_id = 0x0016, device_type_revision = 1,} -- RootNode
}
{
endpoint_id = 1,
clusters = {
{cluster_id = clusters.FanControl.ID, cluster_type = "SERVER", feature_map = 0},
},
{
endpoint_id = 1,
clusters = {
{cluster_id = clusters.FanControl.ID, cluster_type = "SERVER", feature_map = 0},
},
device_types = {
{device_type_id = 0x002B, device_type_revision = 1,} -- Fan
}
device_types = {
{device_type_id = 0x002B, device_type_revision = 1,} -- Fan
}
}
}
})

local cluster_subscribe_list = {
clusters.FanControl.attributes.FanMode,
clusters.FanControl.attributes.PercentCurrent,
clusters.FanControl.attributes.WindSupport,
clusters.FanControl.attributes.WindSetting,
clusters.FanControl.attributes.RockSupport,
clusters.FanControl.attributes.RockSetting,
clusters.FanControl.attributes.FanModeSequence,
clusters.FanControl.attributes.FanMode,
clusters.FanControl.attributes.PercentCurrent,
clusters.FanControl.attributes.WindSupport,
clusters.FanControl.attributes.WindSetting,
clusters.FanControl.attributes.RockSupport,
clusters.FanControl.attributes.RockSetting,
}

local cluster_subscribe_list_generic = {
clusters.FanControl.attributes.FanMode,
clusters.FanControl.attributes.PercentCurrent,
clusters.FanControl.attributes.FanModeSequence,
clusters.FanControl.attributes.FanMode,
clusters.FanControl.attributes.PercentCurrent,
}

local function test_init()
362 changes: 360 additions & 2 deletions drivers/SmartThings/matter-thermostat/src/test/test_matter_room_ac.lua
View file

Large diffs are not rendered by default.

43 changes: 42 additions & 1 deletion drivers/SmartThings/matter-thermostat/src/test/test_matter_thermo_battery.lua
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
-- Copyright 2023 SmartThings
-- Copyright 2025 SmartThings
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
@@ -13,6 +13,7 @@
-- limitations under the License.

local test = require "integration_test"
local capabilities = require "st.capabilities"
local t_utils = require "integration_test.utils"
local clusters = require "st.matter.clusters"
local uint32 = require "st.matter.data_types.Uint32"
@@ -144,4 +145,44 @@ test.register_coroutine_test(
end
)

test.register_coroutine_test(
"Test battery level attribute handler",
function()
test.socket.matter:__queue_receive(
{
mock_device.id,
clusters.PowerSource.attributes.BatChargeLevel:build_test_report_data(mock_device, 1, clusters.PowerSource.types.BatChargeLevelEnum.OK)
}
)
test.socket.capability:__expect_send(
mock_device:generate_test_message(
"main", capabilities.batteryLevel.battery.normal()
)
)
test.socket.matter:__queue_receive(
{
mock_device.id,
clusters.PowerSource.attributes.BatChargeLevel:build_test_report_data(mock_device, 1, clusters.PowerSource.types.BatChargeLevelEnum.WARNING)
}
)
test.socket.capability:__expect_send(
mock_device:generate_test_message(
"main", capabilities.batteryLevel.battery.warning()
)
)
test.socket.matter:__queue_receive(
{
mock_device.id,
clusters.PowerSource.attributes.BatChargeLevel:build_test_report_data(mock_device, 1, clusters.PowerSource.types.BatChargeLevelEnum.CRITICAL)
}
)
test.socket.capability:__expect_send(
mock_device:generate_test_message(
"main", capabilities.batteryLevel.battery.critical()
)
)
end
)


test.run_registered_tests()
90 changes: 88 additions & 2 deletions drivers/SmartThings/matter-thermostat/src/test/test_matter_thermo_setpoint_limits.lua
View file
Original file line number Diff line number Diff line change
@@ -237,6 +237,36 @@ test.register_coroutine_test(
end
)

test.register_coroutine_test(
"Min heat setpoint higher than max",
function()
configure(mock_device)
test.socket.matter:__queue_receive({
mock_device.id,
clusters.Thermostat.attributes.AbsMinHeatSetpointLimit:build_test_report_data(mock_device, 1, 5000)
})
test.socket.matter:__queue_receive({
mock_device.id,
clusters.Thermostat.attributes.AbsMaxHeatSetpointLimit:build_test_report_data(mock_device, 1, 3444)
})
end
)

test.register_coroutine_test(
"Min cool setpoint higher than max",
function()
configure(mock_device)
test.socket.matter:__queue_receive({
mock_device.id,
clusters.Thermostat.attributes.AbsMinCoolSetpointLimit:build_test_report_data(mock_device, 1, 4000)
})
test.socket.matter:__queue_receive({
mock_device.id,
clusters.Thermostat.attributes.AbsMaxCoolSetpointLimit:build_test_report_data(mock_device, 1, 1200)
})
end
)

test.register_coroutine_test(
"Heat setpoint inside deadband",
function()
@@ -289,7 +319,7 @@ test.register_coroutine_test(
)

test.register_message_test(
"Min and max heating setpoint attributes set capability constraint",
"Min and max cooling setpoint attributes set capability constraint",
{
{
channel = "matter",
@@ -316,7 +346,7 @@ test.register_message_test(
)

test.register_message_test(
"Min and max cooling setpoint attributes set capability constraint",
"Min and max heating setpoint attributes set capability constraint",
{
{
channel = "matter",
@@ -369,4 +399,60 @@ test.register_message_test(
}
)

test.register_message_test(
"Max temperature reported as lower than min temperature, don't emit temperatureRange capability",
{
{
channel = "matter",
direction = "receive",
message = {
mock_device.id,
clusters.TemperatureMeasurement.attributes.MinMeasuredValue:build_test_report_data(mock_device, 1, 5000)
}
},
{
channel = "matter",
direction = "receive",
message = {
mock_device.id,
clusters.TemperatureMeasurement.attributes.MaxMeasuredValue:build_test_report_data(mock_device, 1, 2900)
}
}
}
)

test.register_coroutine_test("Heating setpoint capability cached as Fahrenheit value",
function()
mock_device.wrapped_device.state_cache.main = {
[capabilities.thermostatHeatingSetpoint.ID] = {
[capabilities.thermostatHeatingSetpoint.heatingSetpoint.NAME] = { unit = "F", value = 56.67 }
}
}
test.socket.capability:__queue_receive({
mock_device.id,
{ capability = "thermostatCoolingSetpoint", component = "main", command = "setCoolingSetpoint", args = { 9 } }
})
test.socket.capability:__expect_send(
mock_device:generate_test_message("main", capabilities.thermostatCoolingSetpoint.coolingSetpoint({ value = 40.00, unit = "C" }, {state_change = true }))
)
end
)

test.register_coroutine_test("Cooling setpoint capability cached as Fahrenheit value",
function()
mock_device.wrapped_device.state_cache.main = {
[capabilities.thermostatCoolingSetpoint.ID] = {
[capabilities.thermostatCoolingSetpoint.coolingSetpoint.NAME] = { unit = "F", value = 46.67 }
}
}
test.socket.capability:__queue_receive({
mock_device.id,
{ capability = "thermostatHeatingSetpoint", component = "main", command = "setHeatingSetpoint", args = { 9 } }
})
test.socket.capability:__expect_send(
mock_device:generate_test_message("main", capabilities.thermostatHeatingSetpoint.heatingSetpoint({ value = 5.00, unit = "C" }, {state_change = true }))
)
end
)

test.run_registered_tests()
271 changes: 231 additions & 40 deletions drivers/SmartThings/matter-thermostat/src/test/test_matter_thermostat.lua
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
-- Copyright 2022 SmartThings
-- Copyright 2025 SmartThings
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
@@ -16,8 +16,13 @@ local test = require "integration_test"
local capabilities = require "st.capabilities"
local t_utils = require "integration_test.utils"
local utils = require "st.utils"

local clusters = require "st.matter.clusters"
local version = require "version"

if version.api < 11 then
clusters.Thermostat.types.SystemModeEnum = clusters.Thermostat.types.ThermostatSystemMode
clusters.Thermostat.types.ControlSequenceOfOperationEnum = clusters.Thermostat.types.ThermostatControlSequence
end

local mock_device = test.mock_device.build_test_matter_device({
profile = t_utils.get_profile_definition("thermostat-humidity-fan.yml"),
@@ -87,26 +92,27 @@ local mock_device_auto = test.mock_device.build_test_matter_device({
}
})

local cluster_subscribe_list = {
clusters.Thermostat.attributes.LocalTemperature,
clusters.Thermostat.attributes.OccupiedCoolingSetpoint,
clusters.Thermostat.attributes.OccupiedHeatingSetpoint,
clusters.Thermostat.attributes.AbsMinCoolSetpointLimit,
clusters.Thermostat.attributes.AbsMaxCoolSetpointLimit,
clusters.Thermostat.attributes.AbsMinHeatSetpointLimit,
clusters.Thermostat.attributes.AbsMaxHeatSetpointLimit,
clusters.Thermostat.attributes.SystemMode,
clusters.Thermostat.attributes.ThermostatRunningState,
clusters.Thermostat.attributes.ControlSequenceOfOperation,
clusters.TemperatureMeasurement.attributes.MeasuredValue,
clusters.TemperatureMeasurement.attributes.MinMeasuredValue,
clusters.TemperatureMeasurement.attributes.MaxMeasuredValue,
clusters.RelativeHumidityMeasurement.attributes.MeasuredValue,
clusters.FanControl.attributes.FanMode,
clusters.FanControl.attributes.FanModeSequence,
clusters.PowerSource.attributes.BatPercentRemaining,
}

local function test_init()
local cluster_subscribe_list = {
clusters.Thermostat.attributes.LocalTemperature,
clusters.Thermostat.attributes.OccupiedCoolingSetpoint,
clusters.Thermostat.attributes.OccupiedHeatingSetpoint,
clusters.Thermostat.attributes.AbsMinCoolSetpointLimit,
clusters.Thermostat.attributes.AbsMaxCoolSetpointLimit,
clusters.Thermostat.attributes.AbsMinHeatSetpointLimit,
clusters.Thermostat.attributes.AbsMaxHeatSetpointLimit,
clusters.Thermostat.attributes.SystemMode,
clusters.Thermostat.attributes.ThermostatRunningState,
clusters.Thermostat.attributes.ControlSequenceOfOperation,
clusters.TemperatureMeasurement.attributes.MeasuredValue,
clusters.TemperatureMeasurement.attributes.MinMeasuredValue,
clusters.TemperatureMeasurement.attributes.MaxMeasuredValue,
clusters.RelativeHumidityMeasurement.attributes.MeasuredValue,
clusters.FanControl.attributes.FanMode,
clusters.FanControl.attributes.FanModeSequence,
clusters.PowerSource.attributes.BatPercentRemaining,
}
test.socket.matter:__set_channel_ordering("relaxed")
local subscribe_request = cluster_subscribe_list[1]:subscribe(mock_device)
for i, cluster in ipairs(cluster_subscribe_list) do
@@ -120,25 +126,6 @@ end
test.set_test_init_function(test_init)

local function test_init_auto()
local cluster_subscribe_list = {
clusters.Thermostat.attributes.LocalTemperature,
clusters.Thermostat.attributes.OccupiedCoolingSetpoint,
clusters.Thermostat.attributes.OccupiedHeatingSetpoint,
clusters.Thermostat.attributes.AbsMinCoolSetpointLimit,
clusters.Thermostat.attributes.AbsMaxCoolSetpointLimit,
clusters.Thermostat.attributes.AbsMinHeatSetpointLimit,
clusters.Thermostat.attributes.AbsMaxHeatSetpointLimit,
clusters.Thermostat.attributes.SystemMode,
clusters.Thermostat.attributes.ThermostatRunningState,
clusters.Thermostat.attributes.ControlSequenceOfOperation,
clusters.TemperatureMeasurement.attributes.MeasuredValue,
clusters.TemperatureMeasurement.attributes.MinMeasuredValue,
clusters.TemperatureMeasurement.attributes.MaxMeasuredValue,
clusters.RelativeHumidityMeasurement.attributes.MeasuredValue,
clusters.FanControl.attributes.FanMode,
clusters.FanControl.attributes.FanModeSequence,
clusters.PowerSource.attributes.BatPercentRemaining,
}
test.socket.matter:__set_channel_ordering("relaxed")
local subscribe_request = cluster_subscribe_list[1]:subscribe(mock_device_auto)
for i, cluster in ipairs(cluster_subscribe_list) do
@@ -356,6 +343,210 @@ test.register_message_test(
}
)

test.register_message_test(
"Thermostat mode reports should generate correct messages when SystemMode is received first",
{
{
channel = "matter",
direction = "receive",
message = {
mock_device.id,
clusters.Thermostat.server.attributes.SystemMode:build_test_report_data(mock_device, 1, clusters.Thermostat.types.SystemModeEnum.PRECOOLING)
}
},
{
channel = "matter",
direction = "receive",
message = {
mock_device.id,
clusters.Thermostat.server.attributes.ControlSequenceOfOperation:build_test_report_data(mock_device, 1, clusters.Thermostat.types.ControlSequenceOfOperationEnum.COOLING_WITH_REHEAT)
}
},
{
channel = "capability",
direction = "send",
message = mock_device:generate_test_message("main", capabilities.thermostatMode.supportedThermostatModes({"off", "cool"}, {visibility={displayed=false}}))
},
{
channel = "capability",
direction = "send",
message = mock_device:generate_test_message("main", capabilities.thermostatMode.supportedThermostatModes({"off", "cool", "precooling"}, {visibility={displayed=false}}))
},
{
channel = "capability",
direction = "send",
message = mock_device:generate_test_message("main", capabilities.thermostatMode.thermostatMode.precooling())
}
}
)

test.register_message_test(
"Thermostat mode reports should generate correct messages when the ControlSequenceOfOperation attribute changes",
{
{
channel = "matter",
direction = "receive",
message = {
mock_device.id,
clusters.Thermostat.server.attributes.ControlSequenceOfOperation:build_test_report_data(mock_device, 1, clusters.Thermostat.types.ControlSequenceOfOperationEnum.COOLING_WITH_REHEAT)
}
},
{
channel = "capability",
direction = "send",
message = mock_device:generate_test_message("main", capabilities.thermostatMode.supportedThermostatModes({"off", "cool"}, {visibility={displayed=false}}))
},
{
channel = "matter",
direction = "receive",
message = {
mock_device.id,
clusters.Thermostat.server.attributes.SystemMode:build_test_report_data(mock_device, 1, clusters.Thermostat.types.SystemModeEnum.PRECOOLING)
}
},
{
channel = "capability",
direction = "send",
message = mock_device:generate_test_message("main", capabilities.thermostatMode.supportedThermostatModes({"off", "cool", "precooling"}, {visibility={displayed=false}}))
},
{
channel = "capability",
direction = "send",
message = mock_device:generate_test_message("main", capabilities.thermostatMode.thermostatMode.precooling())
},
{
channel = "matter",
direction = "receive",
message = {
mock_device.id,
clusters.Thermostat.server.attributes.ControlSequenceOfOperation:build_test_report_data(mock_device, 1, clusters.Thermostat.types.ControlSequenceOfOperationEnum.HEATING_WITH_REHEAT)
}
},
{
channel = "capability",
direction = "send",
message = mock_device:generate_test_message("main", capabilities.thermostatMode.supportedThermostatModes({"off", "heat"}, {visibility={displayed=false}}))
},
{
channel = "matter",
direction = "receive",
message = {
mock_device.id,
clusters.Thermostat.server.attributes.SystemMode:build_test_report_data(mock_device, 1, clusters.Thermostat.types.SystemModeEnum.EMERGENCY_HEAT)
}
},
{
channel = "capability",
direction = "send",
message = mock_device:generate_test_message("main", capabilities.thermostatMode.supportedThermostatModes({"off", "heat", "emergency heat"}, {visibility={displayed=false}}))
},
{
channel = "capability",
direction = "send",
message = mock_device:generate_test_message("main", capabilities.thermostatMode.thermostatMode.emergency_heat())
},
{
channel = "matter",
direction = "receive",
message = {
mock_device.id,
clusters.Thermostat.server.attributes.ControlSequenceOfOperation:build_test_report_data(mock_device, 1, clusters.Thermostat.types.ControlSequenceOfOperationEnum.COOLING_WITH_REHEAT)
}
},
{
channel = "capability",
direction = "send",
message = mock_device:generate_test_message("main", capabilities.thermostatMode.supportedThermostatModes({"off", "precooling", "cool"}, {visibility={displayed=false}}))
}
}
)

test.register_message_test(
"Thermostat mode capability commands should generate correct messages",
{
{
channel = "capability",
direction = "receive",
message = {
mock_device.id,
{ capability = "thermostatMode", component = "main", command = "auto", args = { } }
}
},
{
channel = "matter",
direction = "send",
message = {
mock_device.id,
clusters.Thermostat.attributes.SystemMode:write(mock_device, 1, clusters.Thermostat.types.SystemModeEnum.AUTO)
}
},
{
channel = "capability",
direction = "receive",
message = {
mock_device.id,
{ capability = "thermostatMode", component = "main", command = "off", args = { } }
}
},
{
channel = "matter",
direction = "send",
message = {
mock_device.id,
clusters.Thermostat.attributes.SystemMode:write(mock_device, 1, clusters.Thermostat.types.SystemModeEnum.OFF)
}
},
{
channel = "capability",
direction = "receive",
message = {
mock_device.id,
{ capability = "thermostatMode", component = "main", command = "cool", args = { } }
}
},
{
channel = "matter",
direction = "send",
message = {
mock_device.id,
clusters.Thermostat.attributes.SystemMode:write(mock_device, 1, clusters.Thermostat.types.SystemModeEnum.COOL)
}
},
{
channel = "capability",
direction = "receive",
message = {
mock_device.id,
{ capability = "thermostatMode", component = "main", command = "heat", args = { } }
}
},
{
channel = "matter",
direction = "send",
message = {
mock_device.id,
clusters.Thermostat.attributes.SystemMode:write(mock_device, 1, clusters.Thermostat.types.SystemModeEnum.HEAT)
}
},
{
channel = "capability",
direction = "receive",
message = {
mock_device.id,
{ capability = "thermostatMode", component = "main", command = "emergencyHeat", args = { } }
}
},
{
channel = "matter",
direction = "send",
message = {
mock_device.id,
clusters.Thermostat.attributes.SystemMode:write(mock_device, 1, clusters.Thermostat.types.SystemModeEnum.EMERGENCY_HEAT)
}
},
}
)

local ControlSequenceOfOperation = clusters.Thermostat.attributes.ControlSequenceOfOperation
test.register_message_test(
"Thermostat control sequence reports should generate correct messages",
36 changes: 35 additions & 1 deletion drivers/SmartThings/matter-thermostat/src/test/test_matter_water_heater.lua
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
-- Copyright 2022 SmartThings
-- Copyright 2025 SmartThings
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
@@ -13,6 +13,7 @@
-- limitations under the License.

local test = require "integration_test"
test.set_rpc_version(5)
local capabilities = require "st.capabilities"
local t_utils = require "integration_test.utils"
local utils = require "st.utils"
@@ -25,6 +26,7 @@ end

if version.api < 11 then
clusters.ElectricalEnergyMeasurement = require "ElectricalEnergyMeasurement"
clusters.ElectricalPowerMeasurement = require "ElectricalPowerMeasurement"
end

local WATER_HEATER_EP = 10
@@ -140,6 +142,11 @@ test.register_message_test(
clusters.Thermostat.server.attributes.OccupiedHeatingSetpoint:build_test_report_data(mock_device, 1, 70*100)
}
},
{
channel = "capability",
direction = "send",
message = mock_device:generate_test_message("main", capabilities.thermostatHeatingSetpoint.heatingSetpointRange({ value = { minimum = 30.00, maximum = 80.00, step = 0.1 }, unit = "C" }))
},
{
channel = "capability",
direction = "send",
@@ -465,4 +472,31 @@ test.register_message_test(
}
)

test.register_message_test(
"Min and max heating setpoint attributes set capability constraint",
{
{
channel = "matter",
direction = "receive",
message = {
mock_device.id,
clusters.Thermostat.attributes.AbsMinHeatSetpointLimit:build_test_report_data(mock_device, 1, 2800)
}
},
{
channel = "matter",
direction = "receive",
message = {
mock_device.id,
clusters.Thermostat.attributes.AbsMaxHeatSetpointLimit:build_test_report_data(mock_device, 1, 6222)
}
},
{
channel = "capability",
direction = "send",
message = mock_device:generate_test_message("main", capabilities.thermostatHeatingSetpoint.heatingSetpointRange({ value = { minimum = 30.00, maximum = 62.22, step = 0.1 }, unit = "C" }))
}
}
)

test.run_registered_tests()
339 changes: 339 additions & 0 deletions drivers/SmartThings/matter-thermostat/src/test/test_matter_water_heater_api9.lua
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,339 @@
-- Copyright 2025 SmartThings
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.

local test = require "integration_test"
local capabilities = require "st.capabilities"
local t_utils = require "integration_test.utils"
local version = require "version"
local clusters = require "st.matter.clusters"

version.api = 9

if version.api < 13 then
clusters.WaterHeaterMode = require "WaterHeaterMode"
end

if version.api < 11 then
clusters.ElectricalEnergyMeasurement = require "ElectricalEnergyMeasurement"
clusters.ElectricalPowerMeasurement = require "ElectricalPowerMeasurement"
end

local WATER_HEATER_EP = 10
local ELECTRICAL_SENSOR_EP = 11

local mock_device = test.mock_device.build_test_matter_device({
profile = t_utils.get_profile_definition("water-heater-power-energy-powerConsumption.yml"),
manufacturer_info = {
vendor_id = 0x0000,
product_id = 0x0000,
},
endpoints = {
{
endpoint_id = 0,
clusters = {
{ cluster_id = clusters.Basic.ID, cluster_type = "SERVER" },
},
device_types = {
{device_type_id = 0x0016, device_type_revision = 1}, -- RootNode
}
},
{
endpoint_id = WATER_HEATER_EP,
clusters = {
{
cluster_id = clusters.Thermostat.ID,
cluster_revision = 5,
cluster_type = "SERVER",
feature_map = 9, -- Heat and SCH features
},
{ cluster_id = clusters.TemperatureMeasurement.ID, cluster_type = "SERVER" },
{ cluster_id = clusters.WaterHeaterMode.ID, cluster_type = "SERVER" },
},
device_types = {
{device_type_id = 0x050F, device_type_revision = 1}, -- Water Heater
}
},
{
endpoint_id = ELECTRICAL_SENSOR_EP,
clusters = {
{ cluster_id = clusters.ElectricalEnergyMeasurement.ID, cluster_type = "SERVER", feature_map = 13 }, -- IMPE, CUME, PERE
{ cluster_id = clusters.ElectricalPowerMeasurement.ID, cluster_type = "SERVER" },
},
device_types = {
{device_type_id = 0x0510, device_type_revision = 1}, -- Electrical Sensor
}
}
}
})

local mock_device_periodic = test.mock_device.build_test_matter_device({
profile = t_utils.get_profile_definition("water-heater-power-energy-powerConsumption.yml"),
manufacturer_info = {
vendor_id = 0x0000,
product_id = 0x0000,
},
endpoints = {
{
endpoint_id = 0,
clusters = {
{ cluster_id = clusters.Basic.ID, cluster_type = "SERVER" },
},
device_types = {
{device_type_id = 0x0016, device_type_revision = 1}, -- RootNode
}
},
{
endpoint_id = WATER_HEATER_EP,
clusters = {
{
cluster_id = clusters.Thermostat.ID,
cluster_revision = 5,
cluster_type = "SERVER",
feature_map = 9, -- Heat and SCH features
},
{ cluster_id = clusters.TemperatureMeasurement.ID, cluster_type = "SERVER" },
{ cluster_id = clusters.WaterHeaterMode.ID, cluster_type = "SERVER" },
},
device_types = {
{device_type_id = 0x050F, device_type_revision = 1}, -- Water Heater
}
},
{
endpoint_id = ELECTRICAL_SENSOR_EP,
clusters = {
{ cluster_id = clusters.ElectricalEnergyMeasurement.ID, cluster_type = "SERVER", feature_map = 10 },
{ cluster_id = clusters.ElectricalPowerMeasurement.ID, cluster_type = "SERVER" },
},
device_types = {
{device_type_id = 0x0510, device_type_revision = 1}, -- Electrical Sensor
}
}
}
})

local cluster_subscribe_list = {
clusters.Thermostat.attributes.SystemMode,
clusters.Thermostat.attributes.ControlSequenceOfOperation,
clusters.Thermostat.attributes.OccupiedHeatingSetpoint,
clusters.Thermostat.attributes.AbsMinHeatSetpointLimit,
clusters.Thermostat.attributes.AbsMaxHeatSetpointLimit,
clusters.Thermostat.attributes.LocalTemperature,
clusters.TemperatureMeasurement.attributes.MeasuredValue,
clusters.TemperatureMeasurement.attributes.MinMeasuredValue,
clusters.TemperatureMeasurement.attributes.MaxMeasuredValue,
clusters.WaterHeaterMode.attributes.CurrentMode,
clusters.WaterHeaterMode.attributes.SupportedModes,
clusters.ElectricalPowerMeasurement.attributes.ActivePower,
clusters.ElectricalEnergyMeasurement.attributes.PeriodicEnergyImported
}

local function test_init()
test.socket.matter:__set_channel_ordering("relaxed")
local subscribe_request = cluster_subscribe_list[1]:subscribe(mock_device)
for i, cluster in ipairs(cluster_subscribe_list) do
if i > 1 then
subscribe_request:merge(cluster:subscribe(mock_device))
end
end
test.socket.matter:__expect_send({ mock_device.id, subscribe_request })
test.mock_device.add_test_device(mock_device)
test.socket.matter:__expect_send({
mock_device.id, clusters.ElectricalEnergyMeasurement.attributes.CumulativeEnergyImported:read(mock_device)
})
end
test.set_test_init_function(test_init)

local function test_init_periodic()
test.socket.matter:__set_channel_ordering("relaxed")
local subscribe_request = cluster_subscribe_list[1]:subscribe(mock_device_periodic)
for i, cluster in ipairs(cluster_subscribe_list) do
if i > 1 then
subscribe_request:merge(cluster:subscribe(mock_device_periodic))
end
end
test.socket.matter:__expect_send({ mock_device_periodic.id, subscribe_request })
test.mock_device.add_test_device(mock_device_periodic)
end

test.register_message_test(
"Ensure WaterHeaderMode supportedModes are registered and setting Oven mode should send appropriate commands",
{
{
channel = "matter",
direction = "receive",
message = {
mock_device.id,
clusters.WaterHeaterMode.attributes.SupportedModes:build_test_report_data(mock_device, WATER_HEATER_EP,
{
clusters.WaterHeaterMode.types.ModeOptionStruct({
["label"] = "Mode 1",
["mode"] = 0,
["mode_tags"] = {
clusters.WaterHeaterMode.types.ModeTagStruct({ ["mfg_code"] = 256, ["value"] = 0 })
}
}),
clusters.WaterHeaterMode.types.ModeOptionStruct({
["label"] = "Mode 2",
["mode"] = 1,
["mode_tags"] = {
clusters.WaterHeaterMode.types.ModeTagStruct({ ["mfg_code"] = 256, ["value"] = 1 })
}
})
}
)
}
},
{
channel = "capability",
direction = "send",
message = mock_device:generate_test_message("main",
capabilities.mode.supportedModes({ "Mode 1", "Mode 2" }, { visibility = { displayed = false } }))
},
{
channel = "capability",
direction = "send",
message = mock_device:generate_test_message("main",
capabilities.mode.supportedArguments({ "Mode 1", "Mode 2" }, { visibility = { displayed = false } }))
},
{
channel = "capability",
direction = "receive",
message = {
mock_device.id,
{ capability = "mode", component = "main", command = "setMode", args = { "Mode 1" } }
}
},
{
channel = "matter",
direction = "send",
message = {
mock_device.id,
clusters.WaterHeaterMode.commands.ChangeToMode(mock_device, WATER_HEATER_EP, 0) -- Index where Mode 1 is stored)
}
}
}
)

test.register_message_test(
"energyMeter capability events must be sent in 'Wh' on receiving CumulativeEnergyMeasured events",
{
{
channel = "matter",
direction = "receive",
message = {
mock_device.id,
clusters.ElectricalEnergyMeasurement.attributes
.CumulativeEnergyImported:build_test_report_data(mock_device,
ELECTRICAL_SENSOR_EP,
clusters.ElectricalEnergyMeasurement.types.EnergyMeasurementStruct({ energy = 15000, start_timestamp = 0, end_timestamp = 0, start_systime = 0, end_systime = 0 }))
}
},
{
channel = "capability",
direction = "send",
message = mock_device:generate_test_message("main", capabilities.energyMeter.energy({ value = 15, unit = "Wh" }))
}
}
)

test.register_coroutine_test(
"The total energy consumption of the device must be reported every 15 minutes",
function()
test.socket.capability:__set_channel_ordering("relaxed")
test.socket.matter:__expect_send({
mock_device.id, clusters.ElectricalEnergyMeasurement.attributes.CumulativeEnergyImported:read(mock_device)
})

test.socket.matter:__queue_receive({ mock_device.id, clusters.ElectricalEnergyMeasurement.attributes.CumulativeEnergyImported:build_test_report_data(mock_device,
ELECTRICAL_SENSOR_EP,
clusters.ElectricalEnergyMeasurement.types.EnergyMeasurementStruct({ energy = 20000, start_timestamp = 0, end_timestamp = 0, start_systime = 0, end_systime = 0 })) }) -- 20Wh

test.socket.capability:__expect_send(
mock_device:generate_test_message("main",
capabilities.energyMeter.energy({
value = 20, unit = "Wh"
}))
)

test.wait_for_events()
test.mock_time.advance_time(60 * 15)

test.socket.capability:__expect_send(
mock_device:generate_test_message("main",
capabilities.powerConsumptionReport.powerConsumption({
energy = 20,
deltaEnergy = 20,
start = "1970-01-01T00:00:00Z",
["end"] = "1970-01-01T00:14:59Z"
}))
)

test.wait_for_events()

test.socket.matter:__expect_send({
mock_device.id, clusters.ElectricalEnergyMeasurement.attributes.CumulativeEnergyImported:read(mock_device)
})

test.socket.matter:__queue_receive({ mock_device.id, clusters.ElectricalEnergyMeasurement.attributes.CumulativeEnergyImported:build_test_report_data(mock_device,
ELECTRICAL_SENSOR_EP,
clusters.ElectricalEnergyMeasurement.types.EnergyMeasurementStruct({ energy = 30000, start_timestamp = 0, end_timestamp = 0, start_systime = 0, end_systime = 0 })) }) -- 30Wh

test.socket.capability:__expect_send(
mock_device:generate_test_message("main",
capabilities.energyMeter.energy({
value = 30, unit = "Wh"
}))
)

test.wait_for_events()
test.mock_time.advance_time(60 * 15)

test.socket.capability:__expect_send(
mock_device:generate_test_message("main",
capabilities.powerConsumptionReport.powerConsumption({
energy = 30,
deltaEnergy = 10,
start = "1970-01-01T00:15:00Z",
["end"] = "1970-01-01T00:29:59Z"
}))
)
test.wait_for_events()
end,
{
test_init = function()
test_init()
test.timer.__create_and_queue_test_time_advance_timer(60 * 15, "interval", "polling_report_schedule_timer")
test.timer.__create_and_queue_test_time_advance_timer(60, "interval", "create_poll_schedule")
end
}
)

test.register_coroutine_test(
"PeriodicEnergyImported should report the energyMeter values",
function()
test.socket.matter:__queue_receive({ mock_device_periodic.id, clusters.ElectricalEnergyMeasurement.attributes.PeriodicEnergyImported:build_test_report_data(mock_device_periodic,
ELECTRICAL_SENSOR_EP,
clusters.ElectricalEnergyMeasurement.types.EnergyMeasurementStruct({ energy = 30000, start_timestamp = 0, end_timestamp = 100, start_systime = 0, end_systime = 0 })) }) -- 30Wh

test.socket.capability:__expect_send(
mock_device_periodic:generate_test_message("main",
capabilities.energyMeter.energy({
value = 30, unit = "Wh"
}))
)
end,
{ test_init = test_init_periodic }
)

test.run_registered_tests()