zigbee-herdsman-converters 25.115.0 → 25.116.0

package/dist/devices/inovelli.js

@@ -96,10 +96,12 @@ const individualLedEffects = {
     clear_effect: 255,
 };
 const mmWaveControlCommands = {
+    reset_mmwave_module: 0,
     set_interference: 1,
+    query_areas: 2,
     clear_interference: 3,
     reset_detection_area: 4,
-    reset_mmwave_module: 0,
+    clear_stay_areas: 5,
 };
 const INOVELLI_CLUSTER_NAME = "manuSpecificInovelli";
 const INOVELLI_MMWAVE_CLUSTER_NAME = "manuSpecificInovelliMMWave";
@@ -230,41 +232,103 @@ const inovelliExtend = {
         },
         commandsResponse: {},
     }),
-    addCustomMMWaveClusterInovelli: () => m.deviceAddCustomCluster(INOVELLI_MMWAVE_CLUSTER_NAME, {
-        ID: 64562, // 0xfc32
-        manufacturerCode: 0x122f,
-        attributes: {
-            mmWaveHoldTime: { ID: 0x0072, type: zigbee_herdsman_1.Zcl.DataType.UINT32, write: true, max: 0xffffffff },
-            mmWaveDetectSensitivity: { ID: 0x0070, type: zigbee_herdsman_1.Zcl.DataType.UINT8, write: true, max: 0xff },
-            mmWaveDetectTrigger: { ID: 0x0071, type: zigbee_herdsman_1.Zcl.DataType.UINT8, write: true, max: 0xff },
-            mmWaveTargetInfoReport: { ID: 0x006b, type: zigbee_herdsman_1.Zcl.DataType.UINT8, write: true, max: 0xff },
-            mmWaveStayLife: { ID: 0x006c, type: zigbee_herdsman_1.Zcl.DataType.UINT32, write: true, max: 0xffffffff },
-            mmWaveVersion: { ID: 0x0073, type: zigbee_herdsman_1.Zcl.DataType.UINT32, write: true, max: 0xffffffff },
-            mmWaveHeightMin: { ID: 0x0065, type: zigbee_herdsman_1.Zcl.DataType.INT16, write: true, min: -32768 },
-            mmWaveHeightMax: { ID: 0x0066, type: zigbee_herdsman_1.Zcl.DataType.INT16, write: true, min: -32768 },
-            mmWaveWidthMin: { ID: 0x0067, type: zigbee_herdsman_1.Zcl.DataType.INT16, write: true, min: -32768 },
-            mmWaveWidthMax: { ID: 0x0068, type: zigbee_herdsman_1.Zcl.DataType.INT16, write: true, min: -32768 },
-            mmWaveDepthMin: { ID: 0x0069, type: zigbee_herdsman_1.Zcl.DataType.INT16, write: true, min: -32768 },
-            mmWaveDepthMax: { ID: 0x006a, type: zigbee_herdsman_1.Zcl.DataType.INT16, write: true, min: -32768 },
-        },
-        commands: {
-            mmWaveControl: {
-                ID: 0,
-                parameters: [{ name: "controlID", type: zigbee_herdsman_1.Zcl.DataType.UINT8, max: 0xff }],
+    addCustomMMWaveClusterInovelli: () => {
+        const mmWaveCommandAreaParameters = [
+            { name: "areaId", type: zigbee_herdsman_1.Zcl.DataType.UINT8, max: 3 },
+            { name: "xMin", type: zigbee_herdsman_1.Zcl.DataType.INT16, min: -600, max: 600 },
+            { name: "xMax", type: zigbee_herdsman_1.Zcl.DataType.INT16, min: -600, max: 600 },
+            { name: "yMin", type: zigbee_herdsman_1.Zcl.DataType.INT16, min: -600, max: 600 },
+            { name: "yMax", type: zigbee_herdsman_1.Zcl.DataType.INT16, min: -600, max: 600 },
+            { name: "zMin", type: zigbee_herdsman_1.Zcl.DataType.INT16, min: -600, max: 600 },
+            { name: "zMax", type: zigbee_herdsman_1.Zcl.DataType.INT16, min: -600, max: 600 },
+        ];
+        const mmWaveCommandResponseAreaParameters = [
+            { name: "count", type: zigbee_herdsman_1.Zcl.DataType.UINT8 },
+            { name: "xMin1", type: zigbee_herdsman_1.Zcl.DataType.INT16 },
+            { name: "xMax1", type: zigbee_herdsman_1.Zcl.DataType.INT16 },
+            { name: "yMin1", type: zigbee_herdsman_1.Zcl.DataType.INT16 },
+            { name: "yMax1", type: zigbee_herdsman_1.Zcl.DataType.INT16 },
+            { name: "zMin1", type: zigbee_herdsman_1.Zcl.DataType.INT16 },
+            { name: "zMax1", type: zigbee_herdsman_1.Zcl.DataType.INT16 },
+            { name: "xMin2", type: zigbee_herdsman_1.Zcl.DataType.INT16 },
+            { name: "xMax2", type: zigbee_herdsman_1.Zcl.DataType.INT16 },
+            { name: "yMin2", type: zigbee_herdsman_1.Zcl.DataType.INT16 },
+            { name: "yMax2", type: zigbee_herdsman_1.Zcl.DataType.INT16 },
+            { name: "zMin2", type: zigbee_herdsman_1.Zcl.DataType.INT16 },
+            { name: "zMax2", type: zigbee_herdsman_1.Zcl.DataType.INT16 },
+            { name: "xMin3", type: zigbee_herdsman_1.Zcl.DataType.INT16 },
+            { name: "xMax3", type: zigbee_herdsman_1.Zcl.DataType.INT16 },
+            { name: "yMin3", type: zigbee_herdsman_1.Zcl.DataType.INT16 },
+            { name: "yMax3", type: zigbee_herdsman_1.Zcl.DataType.INT16 },
+            { name: "zMin3", type: zigbee_herdsman_1.Zcl.DataType.INT16 },
+            { name: "zMax3", type: zigbee_herdsman_1.Zcl.DataType.INT16 },
+            { name: "xMin4", type: zigbee_herdsman_1.Zcl.DataType.INT16 },
+            { name: "xMax4", type: zigbee_herdsman_1.Zcl.DataType.INT16 },
+            { name: "yMin4", type: zigbee_herdsman_1.Zcl.DataType.INT16 },
+            { name: "yMax4", type: zigbee_herdsman_1.Zcl.DataType.INT16 },
+            { name: "zMin4", type: zigbee_herdsman_1.Zcl.DataType.INT16 },
+            { name: "zMax4", type: zigbee_herdsman_1.Zcl.DataType.INT16 },
+        ];
+        return m.deviceAddCustomCluster(INOVELLI_MMWAVE_CLUSTER_NAME, {
+            ID: 64562, // 0xfc32
+            manufacturerCode: 0x122f,
+            attributes: {
+                mmWaveHoldTime: { ID: 0x0072, type: zigbee_herdsman_1.Zcl.DataType.UINT32, write: true, max: 0xffffffff },
+                mmWaveDetectSensitivity: { ID: 0x0070, type: zigbee_herdsman_1.Zcl.DataType.UINT8, write: true, max: 0xff },
+                mmWaveDetectTrigger: { ID: 0x0071, type: zigbee_herdsman_1.Zcl.DataType.UINT8, write: true, max: 0xff },
+                mmWaveTargetInfoReport: { ID: 0x006b, type: zigbee_herdsman_1.Zcl.DataType.UINT8, write: true, max: 0xff },
+                mmWaveStayLife: { ID: 0x006c, type: zigbee_herdsman_1.Zcl.DataType.UINT32, write: true, max: 0xffffffff },
+                mmWaveVersion: { ID: 0x0073, type: zigbee_herdsman_1.Zcl.DataType.UINT32, write: true, max: 0xffffffff },
+                mmWaveHeightMin: { ID: 0x0065, type: zigbee_herdsman_1.Zcl.DataType.INT16, write: true, min: -32768 },
+                mmWaveHeightMax: { ID: 0x0066, type: zigbee_herdsman_1.Zcl.DataType.INT16, write: true, min: -32768 },
+                mmWaveWidthMin: { ID: 0x0067, type: zigbee_herdsman_1.Zcl.DataType.INT16, write: true, min: -32768 },
+                mmWaveWidthMax: { ID: 0x0068, type: zigbee_herdsman_1.Zcl.DataType.INT16, write: true, min: -32768 },
+                mmWaveDepthMin: { ID: 0x0069, type: zigbee_herdsman_1.Zcl.DataType.INT16, write: true, min: -32768 },
+                mmWaveDepthMax: { ID: 0x006a, type: zigbee_herdsman_1.Zcl.DataType.INT16, write: true, min: -32768 },
             },
-        },
-        commandsResponse: {
-            anyoneInReportingArea: {
-                ID: 0,
-                parameters: [
-                    { name: "area1", type: zigbee_herdsman_1.Zcl.DataType.BOOLEAN },
-                    { name: "area2", type: zigbee_herdsman_1.Zcl.DataType.BOOLEAN },
-                    { name: "area3", type: zigbee_herdsman_1.Zcl.DataType.BOOLEAN },
-                    { name: "area4", type: zigbee_herdsman_1.Zcl.DataType.BOOLEAN },
-                ],
+            commands: {
+                mmWaveControl: {
+                    ID: 0,
+                    parameters: [{ name: "controlID", type: zigbee_herdsman_1.Zcl.DataType.UINT8, max: 0xff }],
+                },
+                setInterferenceArea: {
+                    ID: 1,
+                    parameters: mmWaveCommandAreaParameters,
+                },
+                setDetectionArea: {
+                    ID: 2,
+                    parameters: mmWaveCommandAreaParameters,
+                },
+                setStayArea: {
+                    ID: 3,
+                    parameters: mmWaveCommandAreaParameters,
+                },
             },
-        },
-    }),
+            commandsResponse: {
+                anyoneInReportingArea: {
+                    ID: 0,
+                    parameters: [
+                        { name: "area1", type: zigbee_herdsman_1.Zcl.DataType.UINT8 },
+                        { name: "area2", type: zigbee_herdsman_1.Zcl.DataType.UINT8 },
+                        { name: "area3", type: zigbee_herdsman_1.Zcl.DataType.UINT8 },
+                        { name: "area4", type: zigbee_herdsman_1.Zcl.DataType.UINT8 },
+                    ],
+                },
+                reportInterferenceArea: {
+                    ID: 2,
+                    parameters: mmWaveCommandResponseAreaParameters,
+                },
+                reportDetectionArea: {
+                    ID: 3,
+                    parameters: mmWaveCommandResponseAreaParameters,
+                },
+                reportStayArea: {
+                    ID: 4,
+                    parameters: mmWaveCommandResponseAreaParameters,
+                },
+            },
+        });
+    },
     inovelliDevice: ({ attrs, supportsLedEffects, supportsButtonTaps, splitValuesByEndpoint = false, }) => {
         // biome-ignore lint/suspicious/noExplicitAny: generic
         const fromZigbee = [];
@@ -388,11 +452,25 @@ const inovelliExtend = {
         };
     },
     inovelliMMWave: () => {
+        const configure = [
+            async (device, coordinatorEndpoint, definition) => {
+                const endpoint = device.getEndpoint(1);
+                await reporting.bind(endpoint, coordinatorEndpoint, [INOVELLI_MMWAVE_CLUSTER_NAME]);
+                await endpoint.command(INOVELLI_MMWAVE_CLUSTER_NAME, "mmWaveControl", {
+                    controlID: mmWaveControlCommands.query_areas,
+                }, { disableResponse: true, disableDefaultResponse: true });
+            },
+        ];
         return {
-            fromZigbee: [],
-            toZigbee: [tzLocal.inovelli_mmwave_control_commands],
-            exposes: [exposeMMWaveControl()],
-            configure: [],
+            fromZigbee: [fzLocal.anyone_in_reporting_area, fzLocal.report_areas],
+            toZigbee: [
+                tzLocal.inovelli_mmwave_control_commands,
+                tzLocal.mmwave_detection_areas,
+                tzLocal.mmwave_interference_areas,
+                tzLocal.mmwave_stay_areas,
+            ],
+            exposes: [exposeMMWaveControl(), ...exposeMMWaveAreas(), exposeInterferenceAreas(), exposeDetectionAreas(), exposeStayAreas()],
+            configure: configure,
             isModernExtend: true,
         };
     },
@@ -1614,6 +1692,49 @@ const VZM36_ATTRIBUTES = {
         description: "Use device in ceiling fan (3-Speed) or in exhaust fan (On/Off) mode.",
     },
 };
+function createMmWaveCompositeAreaConverter(key, command) {
+    return {
+        key: [key],
+        convertSet: async (entity, key, values, meta) => {
+            utils.assertObject(values);
+            // The composite structure has area1, area2, area3, area4 as keys
+            const areaKeys = ["area1", "area2", "area3", "area4"];
+            const state = { [key]: {} };
+            const compositeState = state[key];
+            // Process each area that's provided in the composite
+            for (const areaKey of areaKeys) {
+                if (areaKey in values && utils.isObject(values[areaKey])) {
+                    const areaData = values[areaKey];
+                    // Extract area number from "area1" -> 1, "area2" -> 2, etc.
+                    const areaId = Number.parseInt(areaKey.replace("area", ""), 10);
+                    const payload = {
+                        // areaID is zero indexed
+                        areaId: areaId - 1,
+                        xMin: areaData.width_min,
+                        xMax: areaData.width_max,
+                        yMin: areaData.depth_min,
+                        yMax: areaData.depth_max,
+                        zMin: areaData.height_min,
+                        zMax: areaData.height_max,
+                    };
+                    await entity.command(INOVELLI_MMWAVE_CLUSTER_NAME, command, payload, {
+                        disableResponse: true,
+                        disableDefaultResponse: true,
+                    });
+                    // Store the area data in the state
+                    compositeState[areaKey] = areaData;
+                }
+            }
+            // Query areas after all updates are complete
+            if (Object.keys(compositeState).length > 0) {
+                await entity.command(INOVELLI_MMWAVE_CLUSTER_NAME, "mmWaveControl", {
+                    controlID: mmWaveControlCommands.query_areas,
+                }, { disableResponse: true, disableDefaultResponse: true });
+            }
+            return { state };
+        },
+    };
+}
 const tzLocal = {
     inovelli_parameters: (attributes, cluster) => ({
         key: Object.keys(attributes).filter((a) => !attributes[a].readOnly),
@@ -1724,6 +1845,9 @@ const tzLocal = {
             return { state: { [key]: values } };
         },
     },
+    mmwave_detection_areas: createMmWaveCompositeAreaConverter("mmwave_detection_areas", "setDetectionArea"),
+    mmwave_interference_areas: createMmWaveCompositeAreaConverter("mmwave_interference_areas", "setInterferenceArea"),
+    mmwave_stay_areas: createMmWaveCompositeAreaConverter("mmwave_stay_areas", "setStayArea"),
     /*
      * Inovelli devices have a default transition property that the device should
      * fallback to if a transition is not specified by passing 0xffff
@@ -1903,7 +2027,7 @@ const tzLocal = {
 const fzLocal = {
     inovelli: (attributes, cluster, splitValuesByEndpoint = false) => ({
         cluster: cluster,
-        type: ["raw", "readResponse"],
+        type: ["raw", "readResponse", "attributeReport"],
         convert: (model, msg, publish, options, meta) => {
             if (msg.type === "raw" && msg.endpoint.ID === 2 && msg.data[4] === 0x00) {
                 // Scene Event
@@ -1923,7 +2047,7 @@ const fzLocal = {
                 const action = clickLookup[msg.data[6]];
                 return { action: `${button}_${action}` };
             }
-            if (msg.type === "readResponse") {
+            if (msg.type === "readResponse" || msg.type === "attributeReport") {
                 return Object.keys(msg.data).reduce((p, c) => {
                     const key = splitValuesByEndpoint ? `${c}_${msg.endpoint.ID}` : c;
                     const raw = msg.data[c];
@@ -2055,6 +2179,45 @@ const fzLocal = {
             return { notificationComplete: "Unknown" };
         },
     },
+    report_areas: {
+        cluster: INOVELLI_MMWAVE_CLUSTER_NAME,
+        type: ["commandReportInterferenceArea", "commandReportDetectionArea", "commandReportStayArea"],
+        convert: (model, msg, publish, options, meta) => {
+            const areas = {};
+            const data = msg.data;
+            for (let i = 1; i <= 4; i++) {
+                areas[`area${i}`] = {
+                    width_min: data[`xMin${i}`],
+                    width_max: data[`xMax${i}`],
+                    height_min: data[`zMin${i}`],
+                    height_max: data[`zMax${i}`],
+                    depth_min: data[`yMin${i}`],
+                    depth_max: data[`yMax${i}`],
+                };
+            }
+            const result = {};
+            // Map command types to the new property names
+            const propertyMap = {
+                commandReportInterferenceArea: "mmwave_interference_areas",
+                commandReportDetectionArea: "mmwave_detection_areas",
+                commandReportStayArea: "mmwave_stay_areas",
+            };
+            result[propertyMap[msg.type]] = areas;
+            return result;
+        },
+    },
+    anyone_in_reporting_area: {
+        cluster: INOVELLI_MMWAVE_CLUSTER_NAME,
+        type: ["commandAnyoneInReportingArea"],
+        convert: (model, msg, publish, options, meta) => {
+            return {
+                mmwave_area1_occupancy: msg.data.area1 === 1,
+                mmwave_area2_occupancy: msg.data.area2 === 1,
+                mmwave_area3_occupancy: msg.data.area3 === 1,
+                mmwave_area4_occupancy: msg.data.area4 === 1,
+            };
+        },
+    },
 };
 const exposeLedEffects = () => {
     return e
@@ -2125,6 +2288,82 @@ const exposeLedEffectComplete = () => {
 const exposeEnergyReset = () => {
     return e.enum("energy_reset", ea.SET, ["reset"]).withDescription("Reset energy meter").withCategory("config");
 };
+const exposeMMWaveAreas = () => {
+    return [
+        e
+            .binary("area1Occupancy", ea.STATE, true, false)
+            .withProperty("mmwave_area1_occupancy")
+            .withDescription("Indicates whether the device detected occupancy in Area 1"),
+        e
+            .binary("area2Occupancy", ea.STATE, true, false)
+            .withProperty("mmwave_area2_occupancy")
+            .withDescription("Indicates whether the device detected occupancy in Area 2"),
+        e
+            .binary("area3Occupancy", ea.STATE, true, false)
+            .withProperty("mmwave_area3_occupancy")
+            .withDescription("Indicates whether the device detected occupancy in Area 3"),
+        e
+            .binary("area4Occupancy", ea.STATE, true, false)
+            .withProperty("mmwave_area4_occupancy")
+            .withDescription("Indicates whether the device detected occupancy in Area 4"),
+    ];
+};
+const createAreaComposite = (areaName, property) => {
+    return e
+        .composite(areaName, property, ea.STATE)
+        .withFeature(e
+        .numeric("width_min", ea.STATE_SET)
+        .withValueMin(-600)
+        .withValueMax(600)
+        .withDescription("Defines the area (negative values are left of the switch facing away from the wall, positive values are right)"))
+        .withFeature(e
+        .numeric("width_max", ea.STATE_SET)
+        .withValueMin(-600)
+        .withValueMax(600)
+        .withDescription("Defines the area (negative values are left of the switch facing away from the wall, positive values are right)"))
+        .withFeature(e
+        .numeric("height_min", ea.STATE_SET)
+        .withValueMin(-600)
+        .withValueMax(600)
+        .withDescription("Defines the area (negative values are below the switch, positive values are above)"))
+        .withFeature(e
+        .numeric("height_max", ea.STATE_SET)
+        .withValueMin(-600)
+        .withValueMax(600)
+        .withDescription("Defines the area (negative values are below the switch, positive values are above)"))
+        .withFeature(e.numeric("depth_min", ea.STATE_SET).withValueMin(0).withValueMax(600).withDescription("Defines the area in front of the switch"))
+        .withFeature(e.numeric("depth_max", ea.STATE_SET).withValueMin(0).withValueMax(600).withDescription("Defines the area in front of the switch"));
+};
+const exposeDetectionAreas = () => {
+    return e
+        .composite("mmwave_detection_areas", "mmwave_detection_areas", ea.STATE_SET)
+        .withDescription("Defines one or more active detection zones where the sensor reports movement or occupancy. Up to four detection zones can be set.")
+        .withFeature(createAreaComposite("area_1", "area1"))
+        .withFeature(createAreaComposite("area_2", "area2"))
+        .withFeature(createAreaComposite("area_3", "area3"))
+        .withFeature(createAreaComposite("area_4", "area4"))
+        .withCategory("config");
+};
+const exposeInterferenceAreas = () => {
+    return e
+        .composite("mmwave_interference_areas", "mmwave_interference_areas", ea.STATE_SET)
+        .withDescription("Manually defines the coordinates of an interference area, which is an ignored zone where targets are not reported as present. Up to four zones can be defined.")
+        .withFeature(createAreaComposite("area_1", "area1"))
+        .withFeature(createAreaComposite("area_2", "area2"))
+        .withFeature(createAreaComposite("area_3", "area3"))
+        .withFeature(createAreaComposite("area_4", "area4"))
+        .withCategory("config");
+};
+const exposeStayAreas = () => {
+    return e
+        .composite("mmwave_stay_areas", "mmwave_stay_areas", ea.STATE_SET)
+        .withDescription("Defines one or more stay areas where stationary presence should still be detected. Up to four stay zones can be configured.")
+        .withFeature(createAreaComposite("area_1", "area1"))
+        .withFeature(createAreaComposite("area_2", "area2"))
+        .withFeature(createAreaComposite("area_3", "area3"))
+        .withFeature(createAreaComposite("area_4", "area4"))
+        .withCategory("config");
+};
 const BUTTON_TAP_SEQUENCES = [
     "down_single",
     "up_single",
@@ -2177,11 +2416,11 @@ exports.definitions = [
                 supportsButtonTaps: true,
             }),
             inovelliExtend.addCustomClusterInovelli(),
-            inovelliExtend.inovelliEnergyReset(),
             m.identify(),
+            inovelliExtend.inovelliEnergyReset(),
+            m.electricityMeter({ energy: { divisor: 1000 } }),
             m.temperature(),
             m.humidity(),
-            m.electricityMeter({ energy: { divisor: 1000 } }),
         ],
         ota: true,
     },
@@ -2202,8 +2441,8 @@ exports.definitions = [
                 supportsButtonTaps: true,
             }),
             inovelliExtend.addCustomClusterInovelli(),
-            inovelliExtend.inovelliEnergyReset(),
             m.identify(),
+            inovelliExtend.inovelliEnergyReset(),
             m.electricityMeter({
                 current: false,
                 voltage: false,
@@ -2235,12 +2474,9 @@ exports.definitions = [
             inovelliExtend.inovelliMMWave(),
             inovelliExtend.addCustomClusterInovelli(),
             inovelliExtend.addCustomMMWaveClusterInovelli(),
-            inovelliExtend.inovelliEnergyReset(),
             m.identify(),
+            inovelliExtend.inovelliEnergyReset(),
             m.electricityMeter({
-                // Current and voltage were removed in version 0.8 of the firmware and expected to be restored in the future
-                current: false,
-                voltage: false,
                 energy: { divisor: 1000 },
             }),
             m.illuminance(),