matterbridge 1.3.3 → 1.3.5

package/dist/matterbridgeDevice.js

@@ -1107,7 +1107,6 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
             activeNetworkFaults: [],
         }, {
             resetCounts: async (data) => {
-                // eslint-disable-next-line no-console
                 this.log.debug('Matter command: resetCounts');
                 await this.commandHandler.executeHandler('resetCounts', data);
             },
@@ -1160,7 +1159,7 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
         }, {
             moveToLevel: async ({ request, attributes, endpoint }) => {
                 this.log.debug('Matter command: moveToLevel request:', request, 'attributes.currentLevel:', attributes.currentLevel.getLocal());
-                await this.commandHandler.executeHandler('moveToLevel', { request: request, attributes: attributes, endpoint: endpoint });
+                await this.commandHandler.executeHandler('moveToLevel', { request, attributes, endpoint });
             },
             move: async () => {
                 this.log.error('Matter command: move not implemented');
@@ -1173,7 +1172,7 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
             },
             moveToLevelWithOnOff: async ({ request, attributes, endpoint }) => {
                 this.log.debug('Matter command: moveToLevelWithOnOff request:', request, 'attributes.currentLevel:', attributes.currentLevel.getLocal());
-                await this.commandHandler.executeHandler('moveToLevelWithOnOff', { request: request, attributes: attributes, endpoint: endpoint });
+                await this.commandHandler.executeHandler('moveToLevelWithOnOff', { request, attributes, endpoint });
             },
             moveWithOnOff: async () => {
                 this.log.error('Matter command: moveWithOnOff not implemented');
@@ -1218,57 +1217,46 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
             colorTempPhysicalMinMireds,
             colorTempPhysicalMaxMireds,
         }, {
-            moveToHue: async ({ request: request, attributes: attributes }) => {
-                // eslint-disable-next-line no-console
+            moveToHue: async ({ request, attributes, endpoint }) => {
                 this.log.debug('Matter command: moveToHue request:', request, 'attributes.currentHue:', attributes.currentHue.getLocal());
                 // attributes.currentHue.setLocal(request.hue);
-                this.commandHandler.executeHandler('moveToHue', { request: request, attributes: attributes });
+                this.commandHandler.executeHandler('moveToHue', { request, attributes, endpoint });
             },
             moveHue: async () => {
-                // eslint-disable-next-line no-console
                 this.log.error('Matter command: moveHue not implemented');
             },
             stepHue: async () => {
-                // eslint-disable-next-line no-console
                 this.log.error('Matter command: stepHue not implemented');
             },
-            moveToSaturation: async ({ request: request, attributes: attributes }) => {
-                // eslint-disable-next-line no-console
+            moveToSaturation: async ({ request, attributes, endpoint }) => {
                 this.log.debug('Matter command: moveToSaturation request:', request, 'attributes.currentSaturation:', attributes.currentSaturation.getLocal());
                 // attributes.currentSaturation.setLocal(request.saturation);
-                this.commandHandler.executeHandler('moveToSaturation', { request: request, attributes: attributes });
+                this.commandHandler.executeHandler('moveToSaturation', { request, attributes, endpoint });
             },
             moveSaturation: async () => {
-                // eslint-disable-next-line no-console
                 this.log.error('Matter command: moveSaturation not implemented');
             },
             stepSaturation: async () => {
-                // eslint-disable-next-line no-console
                 this.log.error('Matter command: stepSaturation not implemented');
             },
-            moveToHueAndSaturation: async ({ request: request, attributes: attributes }) => {
-                // eslint-disable-next-line no-console
+            moveToHueAndSaturation: async ({ request, attributes, endpoint }) => {
                 this.log.debug('Matter command: moveToHueAndSaturation request:', request, 'attributes.currentHue:', attributes.currentHue.getLocal(), 'attributes.currentSaturation:', attributes.currentSaturation.getLocal());
                 // attributes.currentHue.setLocal(request.hue);
                 // attributes.currentSaturation.setLocal(request.saturation);
-                this.commandHandler.executeHandler('moveToHueAndSaturation', { request: request, attributes: attributes });
+                this.commandHandler.executeHandler('moveToHueAndSaturation', { request, attributes, endpoint });
             },
             stopMoveStep: async () => {
-                // eslint-disable-next-line no-console
                 this.log.error('Matter command: stopMoveStep not implemented');
             },
-            moveToColorTemperature: async ({ request: request, attributes: attributes }) => {
-                // eslint-disable-next-line no-console
+            moveToColorTemperature: async ({ request, attributes, endpoint }) => {
                 this.log.debug('Matter command: moveToColorTemperature request:', request, 'attributes.colorTemperatureMireds:', attributes.colorTemperatureMireds.getLocal());
                 // attributes.colorTemperatureMireds.setLocal(request.colorTemperatureMireds);
-                this.commandHandler.executeHandler('moveToColorTemperature', { request: request, attributes: attributes });
+                this.commandHandler.executeHandler('moveToColorTemperature', { request, attributes, endpoint });
             },
             moveColorTemperature: async () => {
-                // eslint-disable-next-line no-console
                 this.log.error('Matter command: moveColorTemperature not implemented');
             },
             stepColorTemperature: async () => {
-                // eslint-disable-next-line no-console
                 this.log.error('Matter command: stepColorTemperature not implemented');
             },
         }, {});
@@ -1285,6 +1273,93 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
     createDefaultColorControlClusterServer(currentHue = 0, currentSaturation = 0, colorTemperatureMireds = 500, colorTempPhysicalMinMireds = 147, colorTempPhysicalMaxMireds = 500) {
         this.addClusterServer(this.getDefaultColorControlClusterServer(currentHue, currentSaturation, colorTemperatureMireds, colorTempPhysicalMinMireds, colorTempPhysicalMaxMireds));
     }
+    /**
+     * Get a default color control cluster server.
+     *
+     * @param currentHue - The current hue value.
+     * @param currentSaturation - The current saturation value.
+     * @param colorTemperatureMireds - The color temperature in mireds.
+     * @param colorTempPhysicalMinMireds - The physical minimum color temperature in mireds.
+     * @param colorTempPhysicalMaxMireds - The physical maximum color temperature in mireds.
+     */
+    getDefaultXYColorControlClusterServer(currentX = 0, currentY = 0, colorTemperatureMireds = 500, colorTempPhysicalMinMireds = 147, colorTempPhysicalMaxMireds = 500) {
+        return ClusterServer(ColorControlCluster.with(ColorControl.Feature.Xy, ColorControl.Feature.HueSaturation, ColorControl.Feature.ColorTemperature), {
+            colorMode: ColorControl.ColorMode.CurrentHueAndCurrentSaturation,
+            options: {
+                executeIfOff: false,
+            },
+            numberOfPrimaries: null,
+            enhancedColorMode: ColorControl.EnhancedColorMode.CurrentHueAndCurrentSaturation,
+            colorCapabilities: { xy: true, hueSaturation: true, colorLoop: false, enhancedHue: false, colorTemperature: true },
+            currentHue: 0,
+            currentSaturation: 0,
+            currentX,
+            currentY,
+            colorTemperatureMireds,
+            colorTempPhysicalMinMireds,
+            colorTempPhysicalMaxMireds,
+        }, {
+            moveToColor: async (data) => {
+                this.log.debug('Matter command: moveToColor request:', data.request, 'attributes.currentHue:', data.attributes.currentX.getLocal(), data.attributes.currentY.getLocal());
+                this.commandHandler.executeHandler('moveToColor', data);
+            },
+            moveColor: async () => {
+                this.log.error('Matter command: moveColor not implemented');
+            },
+            stepColor: async () => {
+                this.log.error('Matter command: stepColor not implemented');
+            },
+            moveToHue: async ({ request, attributes, endpoint }) => {
+                this.log.debug('Matter command: moveToHue request:', request, 'attributes.currentHue:', attributes.currentHue.getLocal());
+                this.commandHandler.executeHandler('moveToHue', { request, attributes, endpoint });
+            },
+            moveHue: async () => {
+                this.log.error('Matter command: moveHue not implemented');
+            },
+            stepHue: async () => {
+                this.log.error('Matter command: stepHue not implemented');
+            },
+            moveToSaturation: async ({ request, attributes, endpoint }) => {
+                this.log.debug('Matter command: moveToSaturation request:', request, 'attributes.currentSaturation:', attributes.currentSaturation.getLocal());
+                this.commandHandler.executeHandler('moveToSaturation', { request, attributes, endpoint });
+            },
+            moveSaturation: async () => {
+                this.log.error('Matter command: moveSaturation not implemented');
+            },
+            stepSaturation: async () => {
+                this.log.error('Matter command: stepSaturation not implemented');
+            },
+            moveToHueAndSaturation: async ({ request, attributes, endpoint }) => {
+                this.log.debug('Matter command: moveToHueAndSaturation request:', request, 'attributes.currentHue:', attributes.currentHue.getLocal(), 'attributes.currentSaturation:', attributes.currentSaturation.getLocal());
+                this.commandHandler.executeHandler('moveToHueAndSaturation', { request, attributes, endpoint });
+            },
+            stopMoveStep: async () => {
+                this.log.error('Matter command: stopMoveStep not implemented');
+            },
+            moveToColorTemperature: async ({ request, attributes, endpoint }) => {
+                this.log.debug('Matter command: moveToColorTemperature request:', request, 'attributes.colorTemperatureMireds:', attributes.colorTemperatureMireds.getLocal());
+                this.commandHandler.executeHandler('moveToColorTemperature', { request, attributes, endpoint });
+            },
+            moveColorTemperature: async () => {
+                this.log.error('Matter command: moveColorTemperature not implemented');
+            },
+            stepColorTemperature: async () => {
+                this.log.error('Matter command: stepColorTemperature not implemented');
+            },
+        }, {});
+    }
+    /**
+     * Creates a default color control cluster server.
+     *
+     * @param currentHue - The current hue value.
+     * @param currentSaturation - The current saturation value.
+     * @param colorTemperatureMireds - The color temperature in mireds.
+     * @param colorTempPhysicalMinMireds - The physical minimum color temperature in mireds.
+     * @param colorTempPhysicalMaxMireds - The physical maximum color temperature in mireds.
+     */
+    createDefaultXYColorControlClusterServer(currentX = 0, currentY = 0, colorTemperatureMireds = 500, colorTempPhysicalMinMireds = 147, colorTempPhysicalMaxMireds = 500) {
+        this.addClusterServer(this.getDefaultXYColorControlClusterServer(currentX, currentY, colorTemperatureMireds, colorTempPhysicalMinMireds, colorTempPhysicalMaxMireds));
+    }
     /**
      * Get a default window covering cluster server.
      *
@@ -1311,22 +1386,18 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
             installedOpenLimitLift: 0,
         }, {
             upOrOpen: async (data) => {
-                // eslint-disable-next-line no-console
                 this.log.debug('Matter command: upOrOpen');
                 await this.commandHandler.executeHandler('upOrOpen', data);
             },
             downOrClose: async (data) => {
-                // eslint-disable-next-line no-console
                 this.log.debug('Matter command: downOrClose');
                 await this.commandHandler.executeHandler('downOrClose', data);
             },
             stopMotion: async (data) => {
-                // eslint-disable-next-line no-console
                 this.log.debug('Matter command: stopMotion');
                 await this.commandHandler.executeHandler('stopMotion', data);
             },
             goToLiftPercentage: async (data) => {
-                // eslint-disable-next-line no-console
                 this.log.debug(`Matter command: goToLiftPercentage: ${data.request.liftPercent100thsValue} current: ${data.attributes.currentPositionLiftPercent100ths?.getLocal()} ` +
                     `target: ${data.attributes.targetPositionLiftPercent100ths?.getLocal()} status: ${data.attributes.operationalStatus.getLocal().lift}`);
                 await this.commandHandler.executeHandler('goToLiftPercentage', data);
@@ -1358,7 +1429,6 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
                     tilt: 0,
                 });
             }
-            // eslint-disable-next-line no-console
             // console.log(`Set WindowCovering initial currentPositionLiftPercent100ths and targetPositionLiftPercent100ths to ${position} and operationalStatus to Stopped.`);
         }
     }
@@ -1381,7 +1451,6 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
                 tilt: 0,
             });
         }
-        // eslint-disable-next-line no-console
         // console.log(`Set WindowCovering currentPositionLiftPercent100ths: ${current}, targetPositionLiftPercent100ths: ${target} and operationalStatus: ${status}.`);
     }
     /**
@@ -1395,7 +1464,6 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
         if (!windowCovering)
             return;
         windowCovering.setOperationalStatusAttribute({ global: status, lift: status, tilt: 0 });
-        // eslint-disable-next-line no-console
         // console.log(`Set WindowCovering operationalStatus: ${status}`);
     }
     /**
@@ -1409,7 +1477,6 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
         if (!windowCovering)
             return undefined;
         const status = windowCovering.getOperationalStatusAttribute();
-        // eslint-disable-next-line no-console
         // console.log(`Get WindowCovering operationalStatus: ${status.global}`);
         return status.global;
     }
@@ -1426,7 +1493,6 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
             return;
         windowCovering.setCurrentPositionLiftPercent100thsAttribute(position);
         windowCovering.setTargetPositionLiftPercent100thsAttribute(position);
-        // eslint-disable-next-line no-console
         // console.log(`Set WindowCovering currentPositionLiftPercent100ths: ${position} and targetPositionLiftPercent100ths: ${position}.`);
     }
     /**
@@ -1445,12 +1511,10 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
             supportedOperatingModes: { normal: true, vacation: false, privacy: false, noRemoteLockUnlock: false, passage: false },
         }, {
             lockDoor: async (data) => {
-                // eslint-disable-next-line no-console
                 this.log.debug('Matter command: lockDoor', data.request);
                 await this.commandHandler.executeHandler('lockDoor', data);
             },
             unlockDoor: async (data) => {
-                // eslint-disable-next-line no-console
                 this.log.debug('Matter command: unlockDoor', data.request);
                 await this.commandHandler.executeHandler('unlockDoor', data);
             },
@@ -1471,7 +1535,7 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
         this.addClusterServer(this.getDefaultDoorLockClusterServer(lockState, lockType));
     }
     /**
-     * Get a default switch cluster server.
+     * Get a default momentary switch cluster server.
      *
      * @remarks
      * This method adds a cluster server with default momentary switch features and configurations suitable for (AppleHome) Single Double Long automations.
@@ -1491,16 +1555,41 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
         });
     }
     /**
-     * Creates a default switch cluster server.
+     * Creates a default momentary switch cluster server.
      *
      * @remarks
-     * This method adds a cluster server with default switch features and configurations.
+     * This method adds a cluster server with default momentary switch features and configurations.
      */
     createDefaultSwitchClusterServer() {
         this.addClusterServer(this.getDefaultSwitchClusterServer());
         this.addFixedLabel('orientation', 'Switch');
         this.addFixedLabel('label', 'Switch');
     }
+    /**
+     * Get a default latching switch cluster server.
+     *
+     * @remarks
+     * This method adds a cluster server with default latching switch features and configuration.
+     */
+    getDefaultLatchingSwitchClusterServer() {
+        return ClusterServer(SwitchCluster.with(Switch.Feature.LatchingSwitch), {
+            numberOfPositions: 2,
+            currentPosition: 0,
+        }, {}, {
+            switchLatched: true,
+        });
+    }
+    /**
+     * Creates a default latching switch cluster server.
+     *
+     * @remarks
+     * This method adds a cluster server with default latching switch features and configuration.
+     */
+    createDefaultLatchingSwitchClusterServer() {
+        this.addClusterServer(this.getDefaultLatchingSwitchClusterServer());
+        this.addFixedLabel('orientation', 'Switch');
+        this.addFixedLabel('label', 'Switch');
+    }
     getDefaultModeSelectClusterServer(description, supportedModes, currentMode = 0, startUpMode = 0) {
         return ClusterServer(ModeSelectCluster, {
             description: description,
@@ -1686,7 +1775,6 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
             sensorFault: { generalFault: sensorFault },
         }, {
             enableDisableAlarm: async ({ request, attributes }) => {
-                // eslint-disable-next-line no-console
                 this.log.debug('Matter command: enableDisableAlarm', request);
                 await this.commandHandler.executeHandler('enableDisableAlarm', { request, attributes });
             },
@@ -1866,7 +1954,6 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
             thermostatRunningMode: Thermostat.ThermostatRunningMode.Off,
         }, {
             setpointRaiseLower: async ({ request, attributes }) => {
-                // eslint-disable-next-line no-console
                 this.log.debug('Matter command: setpointRaiseLower', request);
                 await this.commandHandler.executeHandler('setpointRaiseLower', { request, attributes });
             },
@@ -2136,7 +2223,7 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
      * @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The medium of measurement.
      * @returns {ClusterServer} - The default Carbon Monoxide Concentration Measurement Cluster Server.
      */
-    getDefaultOzoneConcentrationMeasurementClusterServer(measuredValue = 0, measurementUnit = ConcentrationMeasurement.MeasurementUnit.Ppm, measurementMedium = ConcentrationMeasurement.MeasurementMedium.Air) {
+    getDefaultOzoneConcentrationMeasurementClusterServer(measuredValue = 0, measurementUnit = ConcentrationMeasurement.MeasurementUnit.Ugm3, measurementMedium = ConcentrationMeasurement.MeasurementMedium.Air) {
         return ClusterServer(OzoneConcentrationMeasurementCluster.with('NumericMeasurement'), {
             measuredValue,
             minMeasuredValue: null,
@@ -2153,7 +2240,7 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
      * @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement.
      * @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The medium of measurement.
      */
-    createDefaulOzoneConcentrationMeasurementClusterServer(measuredValue = 0, measurementUnit = ConcentrationMeasurement.MeasurementUnit.Ppm, measurementMedium = ConcentrationMeasurement.MeasurementMedium.Air) {
+    createDefaulOzoneConcentrationMeasurementClusterServer(measuredValue = 0, measurementUnit = ConcentrationMeasurement.MeasurementUnit.Ugm3, measurementMedium = ConcentrationMeasurement.MeasurementMedium.Air) {
         this.addClusterServer(this.getDefaultOzoneConcentrationMeasurementClusterServer(measuredValue, measurementUnit, measurementMedium));
     }
     /**
@@ -2192,7 +2279,7 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
      * @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The medium of measurement.
      * @returns {ClusterServer} - The default Carbon Monoxide Concentration Measurement Cluster Server.
      */
-    getDefaultNitrogenDioxideConcentrationMeasurementClusterServer(measuredValue = 0, measurementUnit = ConcentrationMeasurement.MeasurementUnit.Ppm, measurementMedium = ConcentrationMeasurement.MeasurementMedium.Air) {
+    getDefaultNitrogenDioxideConcentrationMeasurementClusterServer(measuredValue = 0, measurementUnit = ConcentrationMeasurement.MeasurementUnit.Ugm3, measurementMedium = ConcentrationMeasurement.MeasurementMedium.Air) {
         return ClusterServer(NitrogenDioxideConcentrationMeasurementCluster.with('NumericMeasurement'), {
             measuredValue,
             minMeasuredValue: null,
@@ -2209,7 +2296,7 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
      * @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement.
      * @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The medium of measurement.
      */
-    createDefaulNitrogenDioxideConcentrationMeasurementClusterServer(measuredValue = 0, measurementUnit = ConcentrationMeasurement.MeasurementUnit.Ppm, measurementMedium = ConcentrationMeasurement.MeasurementMedium.Air) {
+    createDefaulNitrogenDioxideConcentrationMeasurementClusterServer(measuredValue = 0, measurementUnit = ConcentrationMeasurement.MeasurementUnit.Ugm3, measurementMedium = ConcentrationMeasurement.MeasurementMedium.Air) {
         this.addClusterServer(this.getDefaultNitrogenDioxideConcentrationMeasurementClusterServer(measuredValue, measurementUnit, measurementMedium));
     }
     /**