matterbridge 2.1.1 → 2.1.2-dev.3

package/dist/matterbridgeEndpointHelpers.js

@@ -1,13 +1,8 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
-// Node.js modules
 import { createHash } from 'crypto';
-// AnsiLogger module
 import { BLUE, CYAN, db, debugStringify, er, hk, or, YELLOW, zb } from './logger/export.js';
 import { MatterbridgeIdentifyServer, MatterbridgeOnOffServer, MatterbridgeLevelControlServer, MatterbridgeColorControlServer, MatterbridgeWindowCoveringServer, MatterbridgeThermostatServer, MatterbridgeFanControlServer, MatterbridgeDoorLockServer, MatterbridgeModeSelectServer, MatterbridgeValveConfigurationAndControlServer, MatterbridgeSmokeCoAlarmServer, MatterbridgeBooleanStateConfigurationServer, } from './matterbridgeBehaviors.js';
-// @matter
 import { Lifecycle } from '@matter/main';
 import { getClusterNameById } from '@matter/main/types';
-// @matter clusters
 import { PowerSource } from '@matter/main/clusters/power-source';
 import { UserLabel } from '@matter/main/clusters/user-label';
 import { FixedLabel } from '@matter/main/clusters/fixed-label';
@@ -49,7 +44,6 @@ import { Pm25ConcentrationMeasurement } from '@matter/main/clusters/pm25-concent
 import { Pm10ConcentrationMeasurement } from '@matter/main/clusters/pm10-concentration-measurement';
 import { RadonConcentrationMeasurement } from '@matter/main/clusters/radon-concentration-measurement';
 import { TotalVolatileOrganicCompoundsConcentrationMeasurement } from '@matter/main/clusters/total-volatile-organic-compounds-concentration-measurement';
-// @matter behaviors
 import { PowerSourceServer } from '@matter/main/behaviors/power-source';
 import { UserLabelServer } from '@matter/main/behaviors/user-label';
 import { FixedLabelServer } from '@matter/main/behaviors/fixed-label';
@@ -96,7 +90,6 @@ export function createUniqueId(param1, param2, param3, param4) {
     return hash.digest('hex');
 }
 export function getBehaviourTypesFromClusterServerIds(clusterServerList) {
-    // Map Server ClusterId to Behavior.Type
     const behaviorTypes = [];
     clusterServerList.forEach((clusterId) => {
         behaviorTypes.push(getBehaviourTypeFromClusterServerId(clusterId));
@@ -104,15 +97,12 @@ export function getBehaviourTypesFromClusterServerIds(clusterServerList) {
     return behaviorTypes;
 }
 export function getBehaviourTypesFromClusterClientIds(clusterClientList) {
-    // Map Client ClusterId to Behavior.Type
     const behaviorTypes = [];
     clusterClientList.forEach((clusterId) => {
-        // behaviorTypes.push(getBehaviourTypeFromClusterClientId(clusterId));
     });
     return behaviorTypes;
 }
 export function getBehaviourTypeFromClusterServerId(clusterId) {
-    // Map ClusterId to Server Behavior.Type
     if (clusterId === PowerSource.Cluster.id)
         return PowerSourceServer.with(PowerSource.Feature.Wired);
     if (clusterId === UserLabel.Cluster.id)
@@ -198,8 +188,6 @@ export function getBehaviourTypeFromClusterServerId(clusterId) {
     return MatterbridgeIdentifyServer;
 }
 export function getBehaviourTypeFromClusterClientId(clusterId) {
-    // Map ClusterId to Client Behavior.Type
-    // return IdentifyClient;
 }
 export function getBehavior(endpoint, cluster) {
     let behavior;
@@ -245,13 +233,6 @@ export function addOptionalClusterServers(endpoint) {
     });
     addClusterServers(endpoint, optionalServerList);
 }
-/**
- * Adds cluster servers to the specified endpoint based on the provided server list.
- *
- * @param {MatterbridgeEndpoint} endpoint - The endpoint to add the cluster servers to.
- * @param {ClusterId[]} serverList - The list of cluster IDs to add.
- * @returns void
- */
 export function addClusterServers(endpoint, serverList) {
     if (serverList.includes(PowerSource.Cluster.id))
         endpoint.createDefaultPowerSourceWiredClusterServer();
@@ -325,16 +306,7 @@ export function addClusterServers(endpoint, serverList) {
         endpoint.createDefaultRadonConcentrationMeasurementClusterServer();
     if (serverList.includes(TotalVolatileOrganicCompoundsConcentrationMeasurement.Cluster.id))
         endpoint.createDefaultTvocMeasurementClusterServer();
-    // if (serverList.includes(DeviceEnergyManagement.Cluster.id)) endpoint.createDefaultDeviceEnergyManagementClusterServer();
-    // if (serverList.includes(DeviceEnergyManagementMode.Cluster.id)) endpoint.createDefaultDeviceEnergyManagementModeClusterServer();
 }
-/**
- * Adds a fixed label to the FixedLabel cluster. The FixedLabel cluster is created if it does not exist.
- *
- * @param {MatterbridgeEndpoint} endpoint - The endpoint to add the cluster servers to.
- * @param {string} label - The label to add.
- * @param {string} value - The value of the label.
- */
 export async function addFixedLabel(endpoint, label, value) {
     if (!endpoint.hasClusterServer(FixedLabel.Cluster.id)) {
         endpoint.log.debug(`addFixedLabel: add cluster ${hk}FixedLabel${db}:${hk}fixedLabel${db} with label ${CYAN}${label}${db} value ${CYAN}${value}${db}`);
@@ -351,13 +323,6 @@ export async function addFixedLabel(endpoint, label, value) {
         await endpoint.setAttribute(FixedLabel.Cluster.id, 'labelList', labelList, endpoint.log);
     }
 }
-/**
- * Adds a user label to the UserLabel cluster. The UserLabel cluster is created if it does not exist.
- *
- * @param {MatterbridgeEndpoint} endpoint - The endpoint to add the cluster servers to.
- * @param {string} label - The label to add.
- * @param {string} value - The value of the label.
- */
 export async function addUserLabel(endpoint, label, value) {
     if (!endpoint.hasClusterServer(UserLabel.Cluster.id)) {
         endpoint.log.debug(`addUserLabel: add cluster ${hk}UserLabel${db}:${hk}userLabel${db} with label ${CYAN}${label}${db} value ${CYAN}${value}${db}`);
@@ -421,16 +386,6 @@ export function getAttributeId(endpoint, cluster, attribute) {
         return endpoint.behaviors.supported[lowercaseFirstLetter(cluster)]?.schema?.children?.find((child) => child.name === capitalizeFirstLetter(attribute))?.id;
     }
 }
-/**
- * Retrieves the value of the provided attribute from the given cluster.
- *
- * @param {MatterbridgeEndpoint} endpoint - The endpoint to retrieve the attribute from.
- * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to retrieve the attribute from.
- * @param {string} attribute - The name of the attribute to retrieve.
- * @param {AnsiLogger} [log] - (Optional) The logger to use for logging the retrieve. Errors are logged to the endpoint logger.
- * @returns {any} The value of the attribute, or undefined if the attribute is not found.
- */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function getAttribute(endpoint, cluster, attribute, log) {
     const clusterName = getBehavior(endpoint, cluster)?.id;
     if (!clusterName) {
@@ -453,16 +408,6 @@ export function getAttribute(endpoint, cluster, attribute, log) {
     log?.info(`${db}Get endpoint ${or}${endpoint.id}${db}:${or}${endpoint.number}${db} attribute ${hk}${capitalizeFirstLetter(clusterName)}${db}.${hk}${attribute}${db} value ${YELLOW}${value !== null && typeof value === 'object' ? debugStringify(value) : value}${db}`);
     return value;
 }
-/**
- * Sets the value of an attribute on a cluster server.
- *
- * @param {MatterbridgeEndpoint} endpoint - The endpoint to set the attribute on.
- * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to set the attribute on.
- * @param {string} attribute - The name of the attribute.
- * @param {boolean | number | bigint | string | object | null} value - The value to set for the attribute.
- * @param {AnsiLogger} [log] - (Optional) The logger to use for logging the set. Errors are logged to the endpoint logger.
- * @returns {Promise<boolean>} - A promise that resolves to a boolean indicating whether the attribute was successfully set.
- */
 export async function setAttribute(endpoint, cluster, attribute, value, log) {
     const clusterName = getBehavior(endpoint, cluster)?.id;
     if (!clusterName) {
@@ -488,16 +433,6 @@ export async function setAttribute(endpoint, cluster, attribute, value, log) {
         `to ${YELLOW}${value !== null && typeof value === 'object' ? debugStringify(value) : value}${db}`);
     return true;
 }
-/**
- * Sets the value of an attribute on a cluster server.
- *
- * @param {MatterbridgeEndpoint} endpoint - The endpoint to update the attribute on.
- * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to update the attribute on.
- * @param {string} attribute - The name of the attribute.
- * @param {boolean | number | bigint | string | object | null} value - The value to set for the attribute.
- * @param {AnsiLogger} [log] - (Optional) The logger to use for logging the update. Errors are logged to the endpoint logger.
- * @returns {Promise<boolean>} - A promise that resolves to a boolean indicating whether the attribute was successfully set.
- */
 export async function updateAttribute(endpoint, cluster, attribute, value, log) {
     const clusterName = getBehavior(endpoint, cluster)?.id;
     if (!clusterName) {
@@ -528,11 +463,6 @@ export async function updateAttribute(endpoint, cluster, attribute, value, log)
         `to ${YELLOW}${value !== null && typeof value === 'object' ? debugStringify(value) : value}${db}`);
     return true;
 }
-/**
- * Get the default TemperatureMeasurement cluster server options.
- *
- * @param {number} measuredValue - The measured value of the temperature x 100.
- */
 export function getDefaultTemperatureMeasurementClusterServer(measuredValue = 0) {
     return optionsFor(TemperatureMeasurementServer, {
         measuredValue,
@@ -541,11 +471,6 @@ export function getDefaultTemperatureMeasurementClusterServer(measuredValue = 0)
         tolerance: 0,
     });
 }
-/**
- * Get the default RelativeHumidityMeasurement cluster server options.
- *
- * @param {number} measuredValue - The measured value of the relative humidity x 100.
- */
 export function getDefaultRelativeHumidityMeasurementClusterServer(measuredValue = 0) {
     return optionsFor(RelativeHumidityMeasurementServer, {
         measuredValue,
@@ -554,11 +479,6 @@ export function getDefaultRelativeHumidityMeasurementClusterServer(measuredValue
         tolerance: 0,
     });
 }
-/**
- * Get the default PressureMeasurement cluster server options.
- *
- * @param {number} measuredValue - The measured value for the pressure.
- */
 export function getDefaultPressureMeasurementClusterServer(measuredValue = 1000) {
     return optionsFor(PressureMeasurementServer, {
         measuredValue,
@@ -567,11 +487,6 @@ export function getDefaultPressureMeasurementClusterServer(measuredValue = 1000)
         tolerance: 0,
     });
 }
-/**
- * Get the default IlluminanceMeasurement cluster server options.
- *
- * @param {number} measuredValue - The measured value of illuminance.
- */
 export function getDefaultIlluminanceMeasurementClusterServer(measuredValue = 0) {
     return optionsFor(IlluminanceMeasurementServer, {
         measuredValue,
@@ -580,11 +495,6 @@ export function getDefaultIlluminanceMeasurementClusterServer(measuredValue = 0)
         tolerance: 0,
     });
 }
-/**
- * Get the default FlowMeasurement cluster server options.
- *
- * @param {number} measuredValue - The measured value of the flow in 10 x m3/h.
- */
 export function getDefaultFlowMeasurementClusterServer(measuredValue = 0) {
     return optionsFor(FlowMeasurementServer, {
         measuredValue,
@@ -593,11 +503,6 @@ export function getDefaultFlowMeasurementClusterServer(measuredValue = 0) {
         tolerance: 0,
     });
 }
-/**
- * Get the default OccupancySensing cluster server options.
- *
- * @param {boolean} occupied - A boolean indicating whether the occupancy is occupied or not. Default is false.
- */
 export function getDefaultOccupancySensingClusterServer(occupied = false) {
     return optionsFor(OccupancySensingServer, {
         occupancy: { occupied },
@@ -606,4 +511,3 @@ export function getDefaultOccupancySensingClusterServer(occupied = false) {
         pirOccupiedToUnoccupiedDelay: 30,
     });
 }
-//# sourceMappingURL=matterbridgeEndpointHelpers.js.map

package/dist/matterbridgePlatform.js

@@ -1,59 +1,23 @@
-/**
- * This file contains the class MatterbridgeAccessoryPlatform.
- *
- * @file matterbridgePlatform.ts
- * @author Luca Liguori
- * @date 2024-03-21
- * @version 1.1.0
- *
- * Copyright 2024, 2025, 2026 Luca Liguori.
- *
- * 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. *
- */
 import { isValidArray, isValidObject, isValidString } from './utils/utils.js';
-// AnsiLogger module
 import { CYAN, db, nf, wr } from './logger/export.js';
-// Storage module
 import { NodeStorageManager } from './storage/export.js';
-// Node.js module
 import path from 'path';
-/**
- * Represents the base Matterbridge platform.
- *
- */
 export class MatterbridgePlatform {
     matterbridge;
     log;
     config = {};
-    name = ''; // Will be set by the loadPlugin() method using the package.json value.
-    type = ''; // Will be set by the extending classes.
-    version = '1.0.0'; // Will be set by the loadPlugin() method using the package.json value.
+    name = '';
+    type = '';
+    version = '1.0.0';
     storage;
     context;
     selectDevice = new Map();
     selectEntity = new Map();
     registeredEndpoints = new Map();
-    /**
-     * Creates an instance of the base MatterbridgePlatform.
-     * @param {Matterbridge} matterbridge - The Matterbridge instance.
-     * @param {AnsiLogger} log - The logger instance.
-     * @param {PlatformConfig} config - The platform configuration.
-     */
     constructor(matterbridge, log, config) {
         this.matterbridge = matterbridge;
         this.log = log;
         this.config = config;
-        // create the NodeStorageManager for the plugin platform
         if (!isValidString(this.config.name))
             return;
         this.log.debug(`Creating storage for plugin ${this.config.name} in ${path.join(this.matterbridge.matterbridgeDirectory, this.config.name)}`);
@@ -65,74 +29,36 @@ export class MatterbridgePlatform {
             forgiveParseErrors: true,
         });
     }
-    /**
-     * This method must be overridden in the extended class.
-     * It is called when the platform is started.
-     * Use this method to create the MatterbridgeDevice and call this.registerDevice().
-     * @param {string} [reason] - The reason for starting.
-     * @throws {Error} - Throws an error if the method is not overridden.
-     */
     async onStart(reason) {
         this.log.error('Plugins must override onStart.', reason);
         throw new Error('Plugins must override onStart.');
     }
-    /**
-     * This method can be overridden in the extended class.
-     * It is called after the platform has been commissioned.
-     * Use this method to perform any configuration of your devices.
-     */
     async onConfigure() {
         this.log.debug(`Configuring platform ${this.name}`);
         await this.checkEndpointNumbers();
     }
-    /**
-     * This method can be overridden in the extended class.
-     * It is called when the platform is shutting down.
-     * Use this method to clean up any resources.
-     * @param {string} [reason] - The reason for shutting down.
-     */
     async onShutdown(reason) {
         this.log.debug(`Shutting down platform ${this.name}`, reason);
         await this.checkEndpointNumbers();
     }
-    /**
-     * Sets the logger level and logs a debug message indicating that the plugin doesn't override this method.
-     * @param {LogLevel} logLevel The new logger level.
-     */
     async onChangeLoggerLevel(logLevel) {
         this.log.debug(`The plugin doesn't override onChangeLoggerLevel. Logger level set to: ${logLevel}`);
     }
-    /**
-     * Registers a device with the Matterbridge platform.
-     * @param {MatterbridgeEndpoint} device - The device to register.
-     */
     async registerDevice(device) {
         device.plugin = this.name;
         await this.matterbridge.addBridgedEndpoint(this.name, device);
         if (device.uniqueId)
             this.registeredEndpoints.set(device.uniqueId, device);
     }
-    /**
-     * Unregisters a device registered with the Matterbridge platform.
-     * @param {MatterbridgeEndpoint} device - The device to unregister.
-     */
     async unregisterDevice(device) {
         await this.matterbridge.removeBridgedEndpoint(this.name, device);
         if (device.uniqueId)
             this.registeredEndpoints.delete(device.uniqueId);
     }
-    /**
-     * Unregisters all devices registered with the Matterbridge platform.
-     */
     async unregisterAllDevices() {
         await this.matterbridge.removeAllBridgedEndpoints(this.name);
         this.registeredEndpoints.clear();
     }
-    /**
-     * Verifies if the Matterbridge version meets the required version.
-     * @param {string} requiredVersion - The required version to compare against.
-     * @returns {boolean} True if the Matterbridge version meets or exceeds the required version, false otherwise.
-     */
     verifyMatterbridgeVersion(requiredVersion) {
         const compareVersions = (matterbridgeVersion, requiredVersion) => {
             const stripTag = (v) => {
@@ -157,28 +83,10 @@ export class MatterbridgePlatform {
             return false;
         return true;
     }
-    /**
-     * Validates if a device is allowed based on the whitelist and blacklist configurations.
-     * The blacklist has priority over the whitelist.
-     *
-     * @param {string | string[]} device - The device name(s) to validate.
-     * @param {boolean} [log=true] - Whether to log the validation result.
-     * @returns {boolean} - Returns true if the device is allowed, false otherwise.
-     */
-    validateDevice(device, log = true) {
-        return this.validateDeviceWhiteBlackList(device, log);
-    }
-    /**
-     * Validates if a device is allowed based on the whitelist and blacklist configurations.
-     * The blacklist has priority over the whitelist.
-     *
-     * @param {string | string[]} device - The device name(s) to validate.
-     * @param {boolean} [log=true] - Whether to log the validation result.
-     * @returns {boolean} - Returns true if the device is allowed, false otherwise.
-     *
-     * @deprecated This method is deprecated and will be removed in future versions. Use validateDevice instead.
-     */
     validateDeviceWhiteBlackList(device, log = true) {
+        return this.validateDevice(device, log);
+    }
+    validateDevice(device, log = true) {
         if (!Array.isArray(device))
             device = [device];
         let blackListBlocked = 0;
@@ -207,28 +115,10 @@ export class MatterbridgePlatform {
             this.log.info(`Skipping device ${CYAN}${device.join(', ')}${nf} because not in whitelist`);
         return false;
     }
-    /**
-     * Validates if an entity is allowed based on the entity whitelist and blacklist and the device-entity blacklist configurations.
-     *
-     * @param {string} device - The device to which the entity belongs.
-     * @param {string} entity - The entity to validate.
-     * @param {boolean} [log=true] - Whether to log the validation result.
-     * @returns {boolean} - Returns true if the entity is allowed, false otherwise.
-     */
-    validateEntity(device, entity, log = true) {
-        return this.validateEntityBlackList(device, entity, log);
-    }
-    /**
-     * Validates if an entity is allowed based on the entity blacklist and device-entity blacklist configurations.
-     *
-     * @param {string} device - The device to which the entity belongs.
-     * @param {string} entity - The entity to validate.
-     * @param {boolean} [log=true] - Whether to log the validation result.
-     * @returns {boolean} - Returns true if the entity is allowed, false otherwise.
-     *
-     * @deprecated This method is deprecated and will be removed in future versions. Use validateEntity instead.
-     */
     validateEntityBlackList(device, entity, log = true) {
+        return this.validateEntity(device, entity, log);
+    }
+    validateEntity(device, entity, log = true) {
         if (isValidArray(this.config.entityBlackList, 1) && this.config.entityBlackList.find((e) => e === entity)) {
             if (log)
                 this.log.info(`Skipping entity ${CYAN}${entity}${nf} because in entityBlackList`);
@@ -246,15 +136,6 @@ export class MatterbridgePlatform {
         }
         return true;
     }
-    /**
-     * Checks and updates the endpoint numbers for Matterbridge devices.
-     *
-     * This method retrieves the list of Matterbridge devices and their child endpoints,
-     * compares their current endpoint numbers with the stored ones, and updates the storage
-     * if there are any changes. It logs the changes and updates the endpoint numbers accordingly.
-     *
-     * @returns {Promise<number>} The size of the updated endpoint map, or -1 if storage is not available.
-     */
     async checkEndpointNumbers() {
         if (!this.storage)
             return -1;
@@ -294,4 +175,3 @@ export class MatterbridgePlatform {
         return endpointMap.size;
     }
 }
-//# sourceMappingURL=matterbridgePlatform.js.map

package/dist/matterbridgeTypes.js

@@ -1,27 +1,3 @@
-/**
- * This file contains the types for Matterbridge.
- *
- * @file matterbridgeTypes.ts
- * @author Luca Liguori
- * @date 2024-07-12
- * @version 1.0.2
- *
- * Copyright 2023, 2024, 2025 Luca Liguori.
- *
- * 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. *
- */
-// Default colors
 export const plg = '\u001B[38;5;33m';
 export const dev = '\u001B[38;5;79m';
 export const typ = '\u001B[38;5;207m';
-//# sourceMappingURL=matterbridgeTypes.js.map