From 57b46bff0a96a52f868bf6c7d84daffc66a7ea36 Mon Sep 17 00:00:00 2001 From: donghoon-ryu Date: Thu, 19 Dec 2024 22:35:11 +0900 Subject: [PATCH] Add test cases for Aqara Light Switch H2 device --- .../light-power-energy-powerConsumption.yml | 1 - .../SmartThings/matter-switch/src/init.lua | 25 +- .../src/test/test_aqara_light_switch_h2.lua | 331 ++++++++++++++++++ .../src/test/test_electrical_sensor.lua | 3 - 4 files changed, 345 insertions(+), 15 deletions(-) create mode 100644 drivers/SmartThings/matter-switch/src/test/test_aqara_light_switch_h2.lua diff --git a/drivers/SmartThings/matter-switch/profiles/light-power-energy-powerConsumption.yml b/drivers/SmartThings/matter-switch/profiles/light-power-energy-powerConsumption.yml index a72f39d17b..1e64f63594 100644 --- a/drivers/SmartThings/matter-switch/profiles/light-power-energy-powerConsumption.yml +++ b/drivers/SmartThings/matter-switch/profiles/light-power-energy-powerConsumption.yml @@ -16,4 +16,3 @@ components: version: 1 categories: - name: Light - diff --git a/drivers/SmartThings/matter-switch/src/init.lua b/drivers/SmartThings/matter-switch/src/init.lua index 6de14f7519..1c4dc55c47 100644 --- a/drivers/SmartThings/matter-switch/src/init.lua +++ b/drivers/SmartThings/matter-switch/src/init.lua @@ -66,6 +66,7 @@ local ON_OFF_SWITCH_ID = 0x0103 local ON_OFF_DIMMER_SWITCH_ID = 0x0104 local ON_OFF_COLOR_DIMMER_SWITCH_ID = 0x0105 local GENERIC_SWITCH_ID = 0x000F +local ELECTRICAL_SENSOR_ID = 0x0510 local device_type_profile_map = { [ON_OFF_LIGHT_DEVICE_TYPE_ID] = "light-binary", [DIMMABLE_LIGHT_DEVICE_TYPE_ID] = "light-level", @@ -148,6 +149,12 @@ local device_type_attribute_map = { clusters.Switch.events.LongPress, clusters.Switch.events.ShortRelease, clusters.Switch.events.MultiPressComplete + }, + [ELECTRICAL_SENSOR_ID] = { + clusters.ElectricalPowerMeasurement.attributes.ActivePower, + clusters.ElectricalEnergyMeasurement.attributes.CumulativeEnergyImported, + clusters.ElectricalEnergyMeasurement.attributes.CumulativeEnergyExported, + clusters.ElectricalEnergyMeasurement.attributes.PeriodicEnergyExported } } @@ -259,6 +266,7 @@ local HELD_THRESHOLD = 1 local STATIC_BUTTON_PROFILE_SUPPORTED = {1, 2, 3, 4, 5, 6, 7, 8} local DEFERRED_CONFIGURE = "__DEFERRED_CONFIGURE" +local TEST_CONFIGURE = "__test_configure" -- Some switches will send a MultiPressComplete event as part of a long press sequence. Normally the driver will create a -- button capability event on receipt of MultiPressComplete, but in this case that would result in an extra event because @@ -466,7 +474,7 @@ local function do_configure(driver, device) end end - if profile_name then + if not device:get_field(IS_AQARA_SWITCH_DEVICE) and profile_name then device:try_update_metadata({ profile = profile_name }) end end @@ -694,7 +702,9 @@ local function device_init(driver, device) end local main_endpoint = find_default_endpoint(device) for _, ep in ipairs(device.endpoints) do - if ep.endpoint_id ~= main_endpoint and ep.endpoint_id ~= 0 then + if ep.endpoint_id ~= main_endpoint and + (device:get_field(IS_AQARA_SWITCH_DEVICE) or ep.endpoint_id ~= 0) then + -- insert energy management into InteractionRequest list when IS_AQARA_SWITCH_DEVICE local id = 0 for _, dt in ipairs(ep.device_types) do id = math.max(id, dt.device_type_id) @@ -1154,17 +1164,10 @@ local function device_added(driver, device) device:emit_event(capabilities.energyMeter.energy({ value = 0.0, unit = "Wh" })) end - -- When device_init is performed in the aqara switch that has EDGE_CHILE, - -- a problem related to capability mapping occurs during configuration_buttons(), so this conditions are added. - if device.manufacturer_info.vendor_id ~= AQARA_MANUFACTURER_ID then + -- when unit testing, call set_configure elsewhere + if not device:get_field(TEST_CONFIGURE) then -- call device init in case init is not called after added due to device caching device_init(driver, device) - else - if device.manufacturer_info.product_id ~= 0x1008 and - device.manufacturer_info.product_id ~= 0x1009 then - -- call device init in case init is not called after added due to device caching - device_init(driver, device) - end end end diff --git a/drivers/SmartThings/matter-switch/src/test/test_aqara_light_switch_h2.lua b/drivers/SmartThings/matter-switch/src/test/test_aqara_light_switch_h2.lua new file mode 100644 index 0000000000..f33a997e06 --- /dev/null +++ b/drivers/SmartThings/matter-switch/src/test/test_aqara_light_switch_h2.lua @@ -0,0 +1,331 @@ +-- Copyright 2024 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 t_utils = require "integration_test.utils" +local capabilities = require "st.capabilities" +local utils = require "st.utils" +local dkjson = require "dkjson" + +local clusters = require "st.matter.clusters" +local button_attr = capabilities.button.button + +local DEFERRED_CONFIGURE = "__DEFERRED_CONFIGURE" +local TEST_CONFIGURE = "__test_configure" + +local aqara_parent_ep = 4 +local aqara_child1_ep = 1 +local aqara_child2_ep = 2 + +local aqara_mock_device = test.mock_device.build_test_matter_device({ + profile = t_utils.get_profile_definition("4-button.yml"), + manufacturer_info = {vendor_id = 0x115F, product_id = 0x1009, product_name = "Aqara Light Switch H2"}, + label = "Aqara Light Switch", + device_id = "00000000-1111-2222-3333-000000000001", + endpoints = { + { + endpoint_id = 0, + clusters = { + {cluster_id = clusters.Basic.ID, cluster_type = "SERVER"}, + {cluster_id = clusters.ElectricalPowerMeasurement.ID, cluster_type = "SERVER", cluster_revision = 1, feature_map = 2 }, + {cluster_id = clusters.ElectricalEnergyMeasurement.ID, cluster_type = "SERVER", cluster_revision = 1, feature_map = 5 } + }, + device_types = { + {device_type_id = 0x0016, device_type_revision = 1}, -- RootNode + {device_type_id = 0x0510, device_type_revision = 1} -- Electrical Sensor + } + }, + { + endpoint_id = aqara_child1_ep, + clusters = { + {cluster_id = clusters.OnOff.ID, cluster_type = "SERVER", cluster_revision = 1, feature_map = 0}, + }, + device_types = { + {device_type_id = 0x0100, device_type_revision = 1}, -- On/Off Light + } + }, + { + endpoint_id = aqara_child2_ep, + clusters = { + {cluster_id = clusters.OnOff.ID, cluster_type = "SERVER", cluster_revision = 1, feature_map = 0}, + }, + device_types = { + {device_type_id = 0x0100, device_type_revision = 1}, -- On/Off Light + } + }, + { + endpoint_id = aqara_parent_ep, + clusters = { + {cluster_id = clusters.Switch.ID, cluster_type = "SERVER", cluster_revision = 1, feature_map = clusters.Switch.types.Feature.MOMENTARY_SWITCH} + }, + device_types = { + {device_type_id = 0x000F, device_type_revision = 1} -- Generic Switch + } + }, + { + endpoint_id = 5, + clusters = { + {cluster_id = clusters.Switch.ID, cluster_type = "SERVER", cluster_revision = 1, feature_map = clusters.Switch.types.Feature.MOMENTARY_SWITCH} + }, + device_types = { + {device_type_id = 0x000F, device_type_revision = 1} -- Generic Switch + } + }, + { + endpoint_id = 6, + clusters = { + {cluster_id = clusters.Switch.ID, cluster_type = "SERVER", cluster_revision = 1, feature_map = clusters.Switch.types.Feature.MOMENTARY_SWITCH} + }, + device_types = { + {device_type_id = 0x000F, device_type_revision = 1} -- Generic Switch + } + }, + { + endpoint_id = 7, + clusters = { + {cluster_id = clusters.Switch.ID, cluster_type = "SERVER", cluster_revision = 1, feature_map = clusters.Switch.types.Feature.MOMENTARY_SWITCH} + }, + device_types = { + {device_type_id = 0x000F, device_type_revision = 1} -- Generic Switch + } + } + } +}) + +local aqara_child_profiles = { + [aqara_child1_ep] = t_utils.get_profile_definition("light-power-energy-powerConsumption.yml"), + [aqara_child2_ep] = t_utils.get_profile_definition("light-binary.yml"), +} + +local aqara_mock_children = {} +for i, endpoint in ipairs(aqara_mock_device.endpoints) do + if endpoint.endpoint_id == aqara_child1_ep or endpoint.endpoint_id == aqara_child2_ep then + local child_data = { + profile = aqara_child_profiles[endpoint.endpoint_id], + device_network_id = string.format("%s:%d", aqara_mock_device.id, endpoint.endpoint_id), + parent_device_id = aqara_mock_device.id, + parent_assigned_child_key = string.format("%d", endpoint.endpoint_id) + } + aqara_mock_children[endpoint.endpoint_id] = test.mock_device.build_test_child_device(child_data) + end +end + +local cumulative_report_val_19 = { + energy = 19000, + start_timestamp = 0, + end_timestamp = 0, + start_systime = 0, + end_systime = 0, +} + +local cumulative_report_val_29 = { + energy = 29000, + start_timestamp = 0, + end_timestamp = 0, + start_systime = 0, + end_systime = 0, +} + +local cumulative_report_val_39 = { + energy = 39000, + start_timestamp = 0, + end_timestamp = 0, + start_systime = 0, + end_systime = 0, +} + +local function test_init() + local opts = { persist = true } + aqara_mock_device:set_field(TEST_CONFIGURE, true, opts) + local cluster_subscribe_list = { + clusters.OnOff.attributes.OnOff, + clusters.Switch.server.events.InitialPress, + clusters.Switch.server.events.LongPress, + clusters.Switch.server.events.ShortRelease, + clusters.Switch.server.events.MultiPressComplete, + clusters.ElectricalPowerMeasurement.attributes.ActivePower, + clusters.ElectricalEnergyMeasurement.attributes.CumulativeEnergyImported, + clusters.ElectricalEnergyMeasurement.attributes.CumulativeEnergyExported, + clusters.ElectricalEnergyMeasurement.attributes.PeriodicEnergyExported + } + local subscribe_request = cluster_subscribe_list[1]:subscribe(aqara_mock_device) + for i, cluster in ipairs(cluster_subscribe_list) do + if i > 1 then + subscribe_request:merge(cluster:subscribe(aqara_mock_device)) + end + end + test.socket.matter:__expect_send({aqara_mock_device.id, subscribe_request}) + test.mock_device.add_test_device(aqara_mock_device) + + for _, child in pairs(aqara_mock_children) do + test.mock_device.add_test_device(child) + end + + aqara_mock_device:expect_device_create({ + type = "EDGE_CHILD", + label = "Aqara Light Switch 1", + profile = "light-power-energy-powerConsumption", + parent_device_id = aqara_mock_device.id, + parent_assigned_child_key = string.format("%d", aqara_child1_ep) + }) + + aqara_mock_device:expect_device_create({ + type = "EDGE_CHILD", + label = "Aqara Light Switch 2", + profile = "light-binary", + parent_device_id = aqara_mock_device.id, + parent_assigned_child_key = string.format("%d", aqara_child2_ep) + }) + test.socket.matter:__expect_send({aqara_mock_device.id, subscribe_request}) + + test.socket.device_lifecycle:__queue_receive({ aqara_mock_device.id, "added" }) + test.mock_devices_api._expected_device_updates[aqara_mock_device.device_id] = "00000000-1111-2222-3333-000000000001" + test.mock_devices_api._expected_device_updates[1] = {device_id = "00000000-1111-2222-3333-000000000001"} + test.mock_devices_api._expected_device_updates[1].metadata = {deviceId="00000000-1111-2222-3333-000000000001", profileReference="4-button"} + + aqara_mock_device:set_field(DEFERRED_CONFIGURE, true, opts) + local device_info_copy = utils.deep_copy(aqara_mock_device.raw_st_data) + device_info_copy.profile.id = "4-button" + local device_info_json = dkjson.encode(device_info_copy) + test.socket.device_lifecycle:__queue_receive({ aqara_mock_device.id, "infoChanged", device_info_json }) + + test.socket.capability:__expect_send(aqara_mock_device:generate_test_message("main", capabilities.button.supportedButtonValues({"pushed"}, {visibility = {displayed = false}}))) + test.socket.capability:__expect_send(aqara_mock_device:generate_test_message("main", button_attr.pushed({state_change = false}))) + + test.socket.capability:__expect_send(aqara_mock_device:generate_test_message("button2", capabilities.button.supportedButtonValues({"pushed"}, {visibility = {displayed = false}}))) + test.socket.capability:__expect_send(aqara_mock_device:generate_test_message("button2", button_attr.pushed({state_change = false}))) + + test.socket.capability:__expect_send(aqara_mock_device:generate_test_message("button3", capabilities.button.supportedButtonValues({"pushed"}, {visibility = {displayed = false}}))) + test.socket.capability:__expect_send(aqara_mock_device:generate_test_message("button3", button_attr.pushed({state_change = false}))) + + test.socket.capability:__expect_send(aqara_mock_device:generate_test_message("button4", capabilities.button.supportedButtonValues({"pushed"}, {visibility = {displayed = false}}))) + test.socket.capability:__expect_send(aqara_mock_device:generate_test_message("button4", button_attr.pushed({state_change = false}))) +end + +test.set_test_init_function(test_init) + +test.register_coroutine_test( + "Button/Switch device : button/switch capability should send the appropriate commands", + function() + test.socket.matter:__queue_receive( + { + aqara_mock_device.id, + clusters.Switch.events.InitialPress:build_test_event_report(aqara_mock_device, 4, {new_position = 1}) + } + ) + + test.socket.capability:__expect_send( + aqara_mock_device:generate_test_message("main", capabilities.button.button.pushed({state_change = true})) + ) + + test.socket.matter:__queue_receive( + { + aqara_mock_device.id, + clusters.Switch.events.InitialPress:build_test_event_report(aqara_mock_device, 5, {new_position = 1}) + } + ) + + test.socket.capability:__expect_send( + aqara_mock_device:generate_test_message("button2", capabilities.button.button.pushed({state_change = true})) + ) + + test.socket.matter:__queue_receive( + { + aqara_mock_device.id, + clusters.OnOff.attributes.OnOff:build_test_report_data(aqara_mock_device, aqara_child1_ep, true) + } + ) + + test.socket.capability:__expect_send( + aqara_mock_children[aqara_child1_ep]:generate_test_message("main", capabilities.switch.switch.on()) + ) + + test.socket.matter:__queue_receive( + { + aqara_mock_device.id, + clusters.OnOff.attributes.OnOff:build_test_report_data(aqara_mock_device, aqara_child2_ep, true) + } + ) + + test.socket.capability:__expect_send( + aqara_mock_children[aqara_child2_ep]:generate_test_message("main", capabilities.switch.switch.on()) + ) + end +) + +test.register_coroutine_test( + "Check Energy/Power Management and powerConsumptionReport", + function() + test.socket.matter:__queue_receive( + { + aqara_mock_children[aqara_child1_ep].id, + clusters.ElectricalPowerMeasurement.attributes.ActivePower:build_test_report_data(aqara_mock_device, 1, 17000) + } + ) + + test.socket.capability:__expect_send( + aqara_mock_children[aqara_child1_ep]:generate_test_message("main", capabilities.powerMeter.power({value = 17.0, unit="W"})) + ) + + test.socket.matter:__queue_receive( + { + aqara_mock_children[aqara_child1_ep].id, + clusters.ElectricalEnergyMeasurement.attributes.CumulativeEnergyImported:build_test_report_data(aqara_mock_device, 1, cumulative_report_val_19) + } + ) + + test.socket.capability:__expect_send( + aqara_mock_children[aqara_child1_ep]:generate_test_message("main", capabilities.energyMeter.energy({ value = 19.0, unit = "Wh" })) + ) + + -- in order to do powerConsumptionReport, CumulativeEnergyImported must be called twice. + -- This is because related variable settings are required in set_poll_report_timer_and_schedule(). + test.socket.matter:__queue_receive( + { + aqara_mock_children[aqara_child1_ep].id, + clusters.ElectricalEnergyMeasurement.attributes.CumulativeEnergyImported:build_test_report_data(aqara_mock_device, 1, cumulative_report_val_29) + } + ) + + test.socket.capability:__expect_send( + aqara_mock_children[aqara_child1_ep]:generate_test_message("main", capabilities.energyMeter.energy({ value = 29.0, unit = "Wh" })) + ) + + test.mock_time.advance_time(2000) + test.socket.capability:__expect_send( + aqara_mock_children[aqara_child1_ep]:generate_test_message("main", capabilities.powerConsumptionReport.powerConsumption({ + start = "1970-01-01T00:00:00Z", + ["end"] = "1970-01-01T00:33:19Z", + deltaEnergy = 0.0, + energy = 29.0 + })) + ) + + test.socket.matter:__queue_receive( + { + aqara_mock_children[aqara_child1_ep].id, + clusters.ElectricalEnergyMeasurement.attributes.CumulativeEnergyImported:build_test_report_data( + aqara_mock_device, 1, cumulative_report_val_39 + ) + } + ) + + test.socket.capability:__expect_send( + aqara_mock_children[aqara_child1_ep]:generate_test_message("main", capabilities.energyMeter.energy({ value = 39.0, unit = "Wh" })) + ) + end +) + +test.run_registered_tests() + diff --git a/drivers/SmartThings/matter-switch/src/test/test_electrical_sensor.lua b/drivers/SmartThings/matter-switch/src/test/test_electrical_sensor.lua index efdb319287..f1b38b15c3 100644 --- a/drivers/SmartThings/matter-switch/src/test/test_electrical_sensor.lua +++ b/drivers/SmartThings/matter-switch/src/test/test_electrical_sensor.lua @@ -18,9 +18,6 @@ local t_utils = require "integration_test.utils" local clusters = require "st.matter.clusters" -clusters.ElectricalEnergyMeasurement = require "ElectricalEnergyMeasurement" -clusters.ElectricalPowerMeasurement = require "ElectricalPowerMeasurement" - local mock_device = test.mock_device.build_test_matter_device({ profile = t_utils.get_profile_definition("plug-power-energy-powerConsumption.yml"), manufacturer_info = {