Matter: Add PM10 sensors (#2354)

Co-authored-by: Pierre-Gilles Leymarie <[email protected]>

Author: Nagromdark

front/src/components/boxs/device-in-room/device-features/sensor-value/BadgeNumberDeviceValue.jsx

@@ -63,6 +63,7 @@ const BADGE_CATEGORIES = {
   [DEVICE_FEATURE_CATEGORIES.CO2_SENSOR]: value => colorLowAsGreen(value, 600, 1200),
   [DEVICE_FEATURE_CATEGORIES.VOC_SENSOR]: value => colorLowAsGreen(value, 250, 2000),
   [DEVICE_FEATURE_CATEGORIES.VOC_INDEX_SENSOR]: value => getVocIndexColor(value),
+  [DEVICE_FEATURE_CATEGORIES.PM10_SENSOR]: value => colorLowAsGreen(value, 30, 50),
   [DEVICE_FEATURE_CATEGORIES.PM25_SENSOR]: value => colorLowAsGreen(value, 15, 25),
   [DEVICE_FEATURE_CATEGORIES.FORMALDEHYD_SENSOR]: value => colorLowAsGreen(value, 50, 120),
   [DEVICE_FEATURE_CATEGORIES.AIRQUALITY_SENSOR]: value => getAqiColor(value),

front/src/config/i18n/de.json

@@ -3378,6 +3378,10 @@
       "shortCategoryName": "PM2.5-Sensor",
       "decimal": "PM2.5 (Dezimal)"
     },
+    "pm10-sensor": {
+      "shortCategoryName": "PM10-Sensor",
+      "decimal": "PM10 (Dezimal)"
+    },
     "formaldehyd-sensor": {
       "shortCategoryName": "Formaldehyd-Sensor",
       "decimal": "Formaldehyd (Dezimal)"

front/src/config/i18n/en.json

@@ -3378,6 +3378,10 @@
       "shortCategoryName": "PM2.5 sensor",
       "decimal": "PM2.5 (decimal)"
     },
+    "pm10-sensor": {
+      "shortCategoryName": "PM10 sensor",
+      "decimal": "PM10 (decimal)"
+    },
     "formaldehyd-sensor": {
       "shortCategoryName": "Formaldehyd sensor",
       "decimal": "Formaldehyd (decimal)"

front/src/config/i18n/fr.json

@@ -3378,6 +3378,10 @@
       "shortCategoryName": "Capteur de PM2.5",
       "decimal": "PM2.5 (Décimale)"
     },
+    "pm10-sensor": {
+      "shortCategoryName": "Capteur de PM10",
+      "decimal": "PM10 (Décimale)"
+    },
     "formaldehyd-sensor": {
       "shortCategoryName": "Capteur Formaldéhyde",
       "decimal": "Formaldéhyde (Décimale)"

front/src/utils/consts.js

@@ -260,6 +260,9 @@ export const DeviceFeatureCategoriesIcon = {
   [DEVICE_FEATURE_CATEGORIES.PM25_SENSOR]: {
     [DEVICE_FEATURE_TYPES.SENSOR.DECIMAL]: 'bar-chart-2'
   },
+  [DEVICE_FEATURE_CATEGORIES.PM10_SENSOR]: {
+    [DEVICE_FEATURE_TYPES.SENSOR.DECIMAL]: 'bar-chart-2'
+  },
   [DEVICE_FEATURE_CATEGORIES.FORMALDEHYD_SENSOR]: {
     [DEVICE_FEATURE_TYPES.SENSOR.DECIMAL]: 'bar-chart-2'
   },

server/services/matter/lib/matter.listenToStateChange.js

@@ -9,6 +9,7 @@ const {
   RelativeHumidityMeasurement,
   Thermostat,
   Pm25ConcentrationMeasurement,
+  Pm10ConcentrationMeasurement,
   // eslint-disable-next-line import/no-unresolved
 } = require('@matter/main/clusters');
 
@@ -189,6 +190,22 @@ async function listenToStateChange(nodeId, devicePath, device) {
     });
   }
 
+  const pm10ConcentrationMeasurement = device.clusterClients.get(Pm10ConcentrationMeasurement.Complete.id);
+  if (pm10ConcentrationMeasurement && !this.stateChangeListeners.has(pm10ConcentrationMeasurement)) {
+    logger.debug(
+      `Matter: Adding state change listener for Pm10ConcentrationMeasurement cluster ${pm10ConcentrationMeasurement.name}`,
+    );
+    this.stateChangeListeners.add(pm10ConcentrationMeasurement);
+    // Subscribe to Pm10ConcentrationMeasurement attribute changes
+    pm10ConcentrationMeasurement.addMeasuredValueAttributeListener((value) => {
+      logger.debug(`Matter: Pm10ConcentrationMeasurement attribute changed to ${value}`);
+      this.gladys.event.emit(EVENTS.DEVICE.NEW_STATE, {
+        device_feature_external_id: `matter:${nodeId}:${devicePath}:${Pm10ConcentrationMeasurement.Complete.id}`,
+        state: value,
+      });
+    });
+  }
+
   const thermostat = device.clusterClients.get(Thermostat.Complete.id);
   if (thermostat && !this.stateChangeListeners.has(thermostat)) {
     logger.debug(`Matter: Adding state change listener for Thermostat cluster ${thermostat.name}`);

server/services/matter/utils/convertToGladysDevice.js

@@ -9,6 +9,7 @@ const {
   RelativeHumidityMeasurement,
   Thermostat,
   Pm25ConcentrationMeasurement,
+  Pm10ConcentrationMeasurement,
   // eslint-disable-next-line import/no-unresolved
 } = require('@matter/main/clusters');
 const Promise = require('bluebird');
@@ -221,6 +222,18 @@ async function convertToGladysDevice(serviceId, nodeId, device, nodeDetailDevice
           min: 0,
           max: 1500,
         });
+      } else if (clusterIndex === Pm10ConcentrationMeasurement.Complete.id) {
+        gladysDevice.features.push({
+          ...commonNewFeature,
+          category: DEVICE_FEATURE_CATEGORIES.PM10_SENSOR,
+          type: DEVICE_FEATURE_TYPES.SENSOR.DECIMAL,
+          read_only: true,
+          has_feedback: true,
+          unit: DEVICE_FEATURE_UNITS.MICROGRAM_PER_CUBIC_METER,
+          external_id: `matter:${nodeId}:${devicePath}:${clusterIndex}`,
+          min: 0,
+          max: 1500,
+        });
       }
     });
   }

server/services/zigbee2mqtt/exposes/numericType.js

@@ -908,6 +908,15 @@ module.exports = {
         max: 999,
       },
     },
+    pm10: {
+      feature: {
+        category: DEVICE_FEATURE_CATEGORIES.PM10_SENSOR,
+        type: DEVICE_FEATURE_TYPES.SENSOR.DECIMAL,
+        unit: DEVICE_FEATURE_UNITS.MICROGRAM_PER_CUBIC_METER,
+        min: 0,
+        max: 999,
+      },
+    },
     formaldehyd: {
       feature: {
         category: DEVICE_FEATURE_CATEGORIES.FORMALDEHYD_SENSOR,

server/test/services/matter/lib/listenToStateChange.test.js

@@ -9,6 +9,7 @@ const {
   RelativeHumidityMeasurement,
   Thermostat,
   Pm25ConcentrationMeasurement,
+  Pm10ConcentrationMeasurement,
   // eslint-disable-next-line import/no-unresolved
 } = require('@matter/main/clusters');
 
@@ -193,6 +194,23 @@ describe('Matter.listenToStateChange', () => {
       state: 100,
     });
   });
+  it('should listen to state change (Pm10ConcentrationMeasurement)', async () => {
+    const clusterClients = new Map();
+    clusterClients.set(Pm10ConcentrationMeasurement.Complete.id, {
+      addMeasuredValueAttributeListener: (callback) => {
+        callback(100);
+      },
+    });
+    const device = {
+      number: 1,
+      clusterClients,
+    };
+    await matterHandler.listenToStateChange(1234n, '1', device);
+    assert.calledWith(gladys.event.emit, EVENTS.DEVICE.NEW_STATE, {
+      device_feature_external_id: 'matter:1234:1:1069',
+      state: 100,
+    });
+  });
   it('should listen to state change (Thermostat heating)', async () => {
     const clusterClients = new Map();
     clusterClients.set(Thermostat.Complete.id, {

server/test/services/matter/lib/matter.init.test.js

@@ -1,5 +1,6 @@
 const {
   Pm25ConcentrationMeasurement,
+  Pm10ConcentrationMeasurement,
   // eslint-disable-next-line import/no-unresolved
 } = require('@matter/main/clusters');
 
@@ -171,6 +172,18 @@ describe('Matter.init', () => {
       addMeasuredValueAttributeListener: fake.returns(null),
     });
 
+    // PM10 concentration measurement
+    clusterClients.set(Pm10ConcentrationMeasurement.Complete.id, {
+      id: Pm10ConcentrationMeasurement.Complete.id,
+      name: 'Pm10ConcentrationMeasurement',
+      endpointId: 1,
+      attributes: {
+        measuredValue: {},
+      },
+      commands: {},
+      addMeasuredValueAttributeListener: fake.returns(null),
+    });
+
     // Mock commissioning controller
     commissioningController = {
       start: fake.resolves(null),
@@ -405,6 +418,18 @@ describe('Matter.init', () => {
             type: 'decimal',
             unit: 'microgram-per-cubic-meter',
           },
+          {
+            category: 'pm10-sensor',
+            external_id: 'matter:12345:1:1069',
+            has_feedback: true,
+            max: 1500,
+            min: 0,
+            name: 'Pm10ConcentrationMeasurement - 1',
+            read_only: true,
+            selector: matterHandler.devices[0].features[12].selector,
+            type: 'decimal',
+            unit: 'microgram-per-cubic-meter',
+          },
         ],
         params: [],
       },
@@ -555,6 +580,18 @@ describe('Matter.init', () => {
             type: 'decimal',
             unit: 'microgram-per-cubic-meter',
           },
+          {
+            category: 'pm10-sensor',
+            external_id: 'matter:12345:1:child_endpoint:2:1069',
+            has_feedback: true,
+            max: 1500,
+            min: 0,
+            name: 'Pm10ConcentrationMeasurement - 1',
+            read_only: true,
+            selector: matterHandler.devices[1].features[12].selector,
+            type: 'decimal',
+            unit: 'microgram-per-cubic-meter',
+          },
         ],
         params: [],
       },