Skip to content

Add N/A checking for molecular weight of AQS level handling #2154

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 2 commits into
base: main
Choose a base branch
from
Open

Add N/A checking for molecular weight of AQS level handling #2154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4408aca
Add N/a checking for molecular weight
hcarter-775 May 29, 2025
a473db3
remove trailing whitespace
hcarter-775 May 29, 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
15 changes: 11 additions & 4 deletions drivers/SmartThings/matter-thermostat/src/init.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1233,8 +1233,12 @@ local conversion_tables = {
[units.PPM] = {
[units.PPM] = function(value) return utils.round(value) end,
[units.PPB] = function(value) return utils.round(value * (10^3)) end,
[units.UGM3] = function(value, molecular_weight) return utils.round((value * molecular_weight * 10^3) / MGM3_PPM_CONVERSION_FACTOR) end,
[units.MGM3] = function(value, molecular_weight) return utils.round((value * molecular_weight) / MGM3_PPM_CONVERSION_FACTOR) end,
[units.UGM3] = function(value, molecular_weight)
if molecular_weight == "N/A" then return utils.round(value) end
return utils.round((value * molecular_weight * 10^3) / MGM3_PPM_CONVERSION_FACTOR) end,
[units.MGM3] = function(value, molecular_weight)
if molecular_weight == "N/A" then return utils.round(value) end
return utils.round((value * molecular_weight) / MGM3_PPM_CONVERSION_FACTOR) end,
},
[units.PPB] = {
[units.PPM] = function(value) return utils.round(value/(10^3)) end,
Expand All @@ -1249,7 +1253,9 @@ local conversion_tables = {
},
[units.UGM3] = {
[units.UGM3] = function(value) return utils.round(value) end,
[units.PPM] = function(value, molecular_weight) return utils.round((value * MGM3_PPM_CONVERSION_FACTOR) / (molecular_weight * 10^3)) end,
[units.PPM] = function(value, molecular_weight)
if molecular_weight == "N/A" then return utils.round(value) end
return utils.round((value * MGM3_PPM_CONVERSION_FACTOR) / (molecular_weight * 10^3)) end,
},
[units.NGM3] = {
[units.UGM3] = function(value) return utils.round(value/(10^3)) end
Expand Down Expand Up @@ -1289,10 +1295,11 @@ local function measurementHandlerFactory(capability_name, attribute, target_unit
end

if value then
device:emit_event_for_endpoint(ib.endpoint_id, attribute({value = value, unit = unit_strings[target_unit]}))
-- handle case where device profile supports both fineDustLevel and dustLevel
if capability_name == capabilities.fineDustSensor.NAME and device:supports_capability(capabilities.dustSensor) then
device:emit_event_for_endpoint(ib.endpoint_id, capabilities.dustSensor.fineDustLevel({value = value, unit = unit_strings[target_unit]}))
else
device:emit_event_for_endpoint(ib.endpoint_id, attribute({value = value, unit = unit_strings[target_unit]}))
end
end
end
Expand Down
162 changes: 162 additions & 0 deletions drivers/SmartThings/matter-thermostat/src/test/test_matter_air_quality_sensor.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,162 @@
-- Copyright 2023 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 SinglePrecisionFloat = require "st.matter.data_types.SinglePrecisionFloat"

local clusters = require "st.matter.clusters"

local mock_device = test.mock_device.build_test_matter_device({
profile = t_utils.get_profile_definition("air-purifier-hepa-ac-temperature-humidity-fan-aqs-pm25-tvoc-meas.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 = 1,
clusters = {
{cluster_id = clusters.AirQuality.ID, cluster_type = "SERVER"},
{cluster_id = clusters.TemperatureMeasurement.ID, cluster_type = "SERVER"},
{cluster_id = clusters.RelativeHumidityMeasurement.ID, cluster_type = "SERVER"},
{cluster_id = clusters.CarbonMonoxideConcentrationMeasurement.ID, cluster_type = "SERVER", feature_map = 3},
{cluster_id = clusters.CarbonDioxideConcentrationMeasurement.ID, cluster_type = "SERVER", feature_map = 3},
{cluster_id = clusters.NitrogenDioxideConcentrationMeasurement.ID, cluster_type = "SERVER", feature_map = 3},
{cluster_id = clusters.OzoneConcentrationMeasurement.ID, cluster_type = "SERVER", feature_map = 3},
{cluster_id = clusters.FormaldehydeConcentrationMeasurement.ID, cluster_type = "SERVER", feature_map = 3},
{cluster_id = clusters.Pm1ConcentrationMeasurement.ID, cluster_type = "SERVER", feature_map = 3},
{cluster_id = clusters.Pm25ConcentrationMeasurement.ID, cluster_type = "SERVER", feature_map = 3},
{cluster_id = clusters.Pm10ConcentrationMeasurement.ID, cluster_type = "SERVER", feature_map = 3},
{cluster_id = clusters.RadonConcentrationMeasurement.ID, cluster_type = "SERVER", feature_map = 3},
{cluster_id = clusters.TotalVolatileOrganicCompoundsConcentrationMeasurement.ID, cluster_type = "SERVER", feature_map = 3},
},
device_types = {
{device_type_id = 0x002C, device_type_revision = 1} -- Air Quality Sensor
}
}
}
})

-- create test_init functions
local function initialize_mock_device(generic_mock_device, generic_subscribed_attributes)
local subscribe_request = nil
for _, attributes in pairs(generic_subscribed_attributes) do
for _, attribute in ipairs(attributes) do
if subscribe_request == nil then
subscribe_request = attribute:subscribe(generic_mock_device)
else
subscribe_request:merge(attribute:subscribe(generic_mock_device))
end
end
end
test.socket.matter:__expect_send({generic_mock_device.id, subscribe_request})
test.mock_device.add_test_device(generic_mock_device)
end

local function test_init()
local subscribed_attributes = {
[capabilities.relativeHumidityMeasurement.ID] = {
clusters.RelativeHumidityMeasurement.attributes.MeasuredValue
},
[capabilities.temperatureMeasurement.ID] = {
clusters.TemperatureMeasurement.attributes.MeasuredValue,
clusters.TemperatureMeasurement.attributes.MinMeasuredValue,
clusters.TemperatureMeasurement.attributes.MaxMeasuredValue
},
[capabilities.airQualityHealthConcern.ID] = {
clusters.AirQuality.attributes.AirQuality
},
[capabilities.finedustSensor.ID] = {
clusters.Pm25ConcentrationMeasurement.attributes.MeasuredValue,
clusters.Pm25ConcentrationMeasurement.attributes.MeasurementUnit,
},
[capabilities.tvocMeasurement.ID] = {
clusters.TotalVolatileOrganicCompoundsConcentrationMeasurement.attributes.MeasuredValue,
clusters.TotalVolatileOrganicCompoundsConcentrationMeasurement.attributes.MeasurementUnit,
},
}
initialize_mock_device(mock_device, subscribed_attributes)
end
test.set_test_init_function(test_init)

test.register_coroutine_test(
"Measured value reports should generate events if there is a stored unit",
function()
test.socket.matter:__queue_receive({
mock_device.id,
clusters.Pm25ConcentrationMeasurement.attributes.MeasurementUnit:build_test_report_data(
mock_device, 1, clusters.Pm25ConcentrationMeasurement.types.MeasurementUnitEnum.UGM3
)
})
test.socket.matter:__queue_receive({
mock_device.id,
clusters.Pm25ConcentrationMeasurement.attributes.MeasuredValue:build_test_report_data(
mock_device, 1, SinglePrecisionFloat(0, 4, .11187500) -- ~17.9
)
})
test.socket.capability:__expect_send(
mock_device:generate_test_message("main", capabilities.fineDustSensor.fineDustLevel({value = 18, unit = "μg/m^3"}))
)
test.socket.matter:__queue_receive({
mock_device.id,
clusters.TotalVolatileOrganicCompoundsConcentrationMeasurement.attributes.MeasurementUnit:build_test_report_data(
mock_device, 1, clusters.TotalVolatileOrganicCompoundsConcentrationMeasurement.types.MeasurementUnitEnum.PPM
)
})
test.socket.matter:__queue_receive({
mock_device.id,
clusters.TotalVolatileOrganicCompoundsConcentrationMeasurement.attributes.MeasuredValue:build_test_report_data(
mock_device, 1, SinglePrecisionFloat(0, -1, .5) -- 0.750 ppm
)
})
test.socket.capability:__expect_send(
mock_device:generate_test_message("main", capabilities.tvocMeasurement.tvocLevel({value = 750, unit = "ppb"}))
)
end
)

test.register_coroutine_test(
"Measured value reports should generate events if stored unit does not match target unit and weight is N/A",
function()
test.socket.matter:__queue_receive({
mock_device.id,
clusters.Pm25ConcentrationMeasurement.attributes.MeasurementUnit:build_test_report_data(
mock_device, 1, clusters.Pm25ConcentrationMeasurement.types.MeasurementUnitEnum.PPM
)
})
test.socket.matter:__queue_receive({
mock_device.id,
clusters.Pm25ConcentrationMeasurement.attributes.MeasuredValue:build_test_report_data(
mock_device, 1, SinglePrecisionFloat(0, 4, .11187500) -- ~17.9
)
})
test.socket.capability:__expect_send(
mock_device:generate_test_message("main", capabilities.fineDustSensor.fineDustLevel({value = 18, unit = "μg/m^3"}))
)
end
)

-- run tests
test.run_registered_tests()
Loading