matterbridge 1.7.0 → 1.7.2-dev.1

package/dist/matterbridgePlatform.js

@@ -1,58 +1,24 @@
-/**
- * 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 { MatterbridgeDevice } from './matterbridgeDevice.js';
 import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
 import { isValidArray, isValidObject, isValidString } from './utils/utils.js';
-// AnsiLogger module
 import { CYAN, db, nf, wr } from 'node-ansi-logger';
-// Storage module
 import { NodeStorageManager } from 'node-persist-manager';
-// 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 = ''; // Will be set by the loadPlugin() method using the package.json value.
+    name = '';
+    type = '';
+    version = '';
     storage;
     context;
-    /**
-     * 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.
-     */
+    selectDevice = new Map();
+    selectEntity = new Map();
     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)}`);
@@ -64,47 +30,21 @@ 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 {MatterbridgeDevice} device - The device to register.
-     */
     async registerDevice(device) {
         device.plugin = this.name;
         if (device instanceof MatterbridgeDevice)
@@ -112,30 +52,18 @@ export class MatterbridgePlatform {
         if (device instanceof MatterbridgeEndpoint)
             await this.matterbridge.addBridgedEndpoint(this.name, device);
     }
-    /**
-     * Unregisters a device registered with the Matterbridge platform.
-     * @param {MatterbridgeDevice} device - The device to unregister.
-     */
     async unregisterDevice(device) {
         if (device instanceof MatterbridgeDevice)
             await this.matterbridge.removeBridgedDevice(this.name, device);
         if (device instanceof MatterbridgeEndpoint)
             await this.matterbridge.removeBridgedEndpoint(this.name, device);
     }
-    /**
-     * Unregisters all devices registered with the Matterbridge platform.
-     */
     async unregisterAllDevices() {
         if (this.matterbridge.edge)
             await this.matterbridge.removeAllBridgedEndpoints(this.name);
         else
             await this.matterbridge.removeAllBridgedDevices(this.name);
     }
-    /**
-     * 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) => {
@@ -160,14 +88,9 @@ 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);
+    }
     validateDeviceWhiteBlackList(device, log = true) {
         if (!Array.isArray(device))
             device = [device];
@@ -197,25 +120,9 @@ 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.
-     */
     validateEntityBlackList(device, entity, log = true) {
         if (isValidArray(this.config.entityBlackList, 1) && this.config.entityBlackList.find((e) => e === entity)) {
             if (log)
@@ -234,15 +141,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;
@@ -281,7 +179,6 @@ export class MatterbridgePlatform {
         this.log.debug('Endpoint numbers check completed.');
         return endpointMap.size;
     }
-    // Temporary method to create a MatterbridgeDevice before switching to the edge
     async _createMutableDevice(definition, options = {}, debug = false) {
         let device;
         if (this.matterbridge.edge === true) {
@@ -292,4 +189,3 @@ export class MatterbridgePlatform {
         return device;
     }
 }
-//# 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

package/dist/matterbridgeWebsocket.js

@@ -1,54 +1,10 @@
-/**
- * This file contains the function matterbridgeMessageHandler.
- *
- * @file matterbridgeWebsocket.ts
- * @author Luca Liguori
- * @date 2024-10-16
- * @version 1.0.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 { isValidNumber, isValidObject, isValidString } from './utils/utils.js';
-// AnsiLogger module
 import { debugStringify, stringify } from 'node-ansi-logger';
-// @matter
 import { EndpointServer, Logger } from '@matter/main';
 import { BasicInformationCluster, BridgedDeviceBasicInformationCluster } from '@matter/main/clusters';
-/**
- * Websocket message ID for logging.
- * @constant {number}
- */
 export const WS_ID_LOG = 0;
-/**
- * Websocket message ID indicating a refresh is needed.
- * @constant {number}
- */
 export const WS_ID_REFRESH_NEEDED = 1;
-/**
- * Websocket message ID indicating a restart is needed.
- * @constant {number}
- */
 export const WS_ID_RESTART_NEEDED = 2;
-/**
- * Handles incoming websocket messages for the Matterbridge.
- *
- * @param {Matterbridge} this - The Matterbridge instance.
- * @param {WebSocket} client - The websocket client that sent the message.
- * @param {WebSocket.RawData} message - The raw data of the message received from the client.
- * @returns {Promise<void>} A promise that resolves when the message has been handled.
- */
 export async function wsMessageHandler(client, message) {
     let data;
     try {
@@ -187,11 +143,17 @@ export async function wsMessageHandler(client, message) {
                 return;
             }
             const clusters = [];
+            let deviceName = '';
+            let serialNumber = '';
+            let deviceTypes = [];
             this.devices.forEach(async (device) => {
                 if (data.params.plugin !== device.plugin)
                     return;
                 if (data.params.endpoint !== device.number)
                     return;
+                deviceName = device.deviceName ?? 'Unknown';
+                serialNumber = device.serialNumber ?? 'Unknown';
+                deviceTypes = [];
                 if (this.edge)
                     device = EndpointServer.forEndpoint(device);
                 const clusterServers = device.getAllClusterServers();
@@ -199,59 +161,109 @@ export async function wsMessageHandler(client, message) {
                     Object.entries(clusterServer.attributes).forEach(([key, value]) => {
                         if (clusterServer.name === 'EveHistory')
                             return;
+                        if (clusterServer.name === 'Descriptor' && key === 'deviceTypeList') {
+                            value.getLocal().forEach((deviceType) => {
+                                deviceTypes.push(deviceType.deviceType);
+                            });
+                        }
                         let attributeValue;
+                        let attributeLocalValue;
                         try {
                             if (typeof value.getLocal() === 'object')
                                 attributeValue = stringify(value.getLocal());
                             else
                                 attributeValue = value.getLocal().toString();
+                            attributeLocalValue = value.getLocal();
                         }
                         catch (error) {
                             attributeValue = 'Fabric-Scoped';
+                            attributeLocalValue = 'Fabric-Scoped';
                             this.log.debug(`GetLocal value ${error} in clusterServer: ${clusterServer.name}(${clusterServer.id}) attribute: ${key}(${value.id})`);
                         }
                         clusters.push({
                             endpoint: device.number ? device.number.toString() : '...',
+                            id: 'main',
+                            deviceTypes,
                             clusterName: clusterServer.name,
                             clusterId: '0x' + clusterServer.id.toString(16).padStart(2, '0'),
                             attributeName: key,
                             attributeId: '0x' + value.id.toString(16).padStart(2, '0'),
                             attributeValue,
+                            attributeLocalValue,
                         });
                     });
                 });
                 device.getChildEndpoints().forEach((childEndpoint) => {
-                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                    deviceTypes = [];
                     const name = this.edge ? childEndpoint.endpoint?.id : childEndpoint.uniqueStorageKey;
                     const clusterServers = childEndpoint.getAllClusterServers();
                     clusterServers.forEach((clusterServer) => {
                         Object.entries(clusterServer.attributes).forEach(([key, value]) => {
                             if (clusterServer.name === 'EveHistory')
                                 return;
+                            if (clusterServer.name === 'Descriptor' && key === 'deviceTypeList') {
+                                value.getLocal().forEach((deviceType) => {
+                                    deviceTypes.push(deviceType.deviceType);
+                                });
+                            }
                             let attributeValue;
+                            let attributeLocalValue;
                             try {
                                 if (typeof value.getLocal() === 'object')
                                     attributeValue = stringify(value.getLocal());
                                 else
                                     attributeValue = value.getLocal().toString();
+                                attributeLocalValue = value.getLocal();
                             }
                             catch (error) {
-                                attributeValue = 'Unavailable';
+                                attributeValue = 'Fabric-Scoped';
+                                attributeLocalValue = 'Fabric-Scoped';
                                 this.log.debug(`GetLocal error ${error} in clusterServer: ${clusterServer.name}(${clusterServer.id}) attribute: ${key}(${value.id})`);
                             }
                             clusters.push({
-                                endpoint: (childEndpoint.number ? childEndpoint.number.toString() : '...') + (name ? ' (' + name + ')' : ''),
+                                endpoint: childEndpoint.number ? childEndpoint.number.toString() : '...',
+                                id: name,
+                                deviceTypes,
                                 clusterName: clusterServer.name,
                                 clusterId: '0x' + clusterServer.id.toString(16).padStart(2, '0'),
                                 attributeName: key,
                                 attributeId: '0x' + value.id.toString(16).padStart(2, '0'),
                                 attributeValue,
+                                attributeLocalValue,
                             });
                         });
                     });
                 });
             });
-            client.send(JSON.stringify({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, response: clusters }));
+            client.send(JSON.stringify({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, plugin: data.params.plugin, deviceName, serialNumber, endpoint: data.params.endpoint, deviceTypes, response: clusters }));
+            return;
+        }
+        else if (data.method === '/api/select') {
+            if (!isValidString(data.params.plugin, 10)) {
+                client.send(JSON.stringify({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, error: 'Wrong parameter plugin in /api/select' }));
+                return;
+            }
+            const plugin = this.plugins.get(data.params.plugin);
+            if (!plugin) {
+                client.send(JSON.stringify({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, error: 'Plugin not found in /api/select' }));
+                return;
+            }
+            const selectDeviceValues = plugin.platform?.selectDevice ? Array.from(plugin.platform.selectDevice.values()).sort((keyA, keyB) => keyA.name.localeCompare(keyB.name)) : [];
+            client.send(JSON.stringify({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, plugin: data.params.plugin, response: selectDeviceValues }));
+            return;
+        }
+        else if (data.method === '/api/select/entities') {
+            if (!isValidString(data.params.plugin, 10)) {
+                client.send(JSON.stringify({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, error: 'Wrong parameter plugin in /api/select/entities' }));
+                return;
+            }
+            const plugin = this.plugins.get(data.params.plugin);
+            if (!plugin) {
+                client.send(JSON.stringify({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, error: 'Plugin not found in /api/select/entities' }));
+                return;
+            }
+            const selectEntityValues = plugin.platform?.selectDevice ? Array.from(plugin.platform.selectEntity.values()).sort((keyA, keyB) => keyA.name.localeCompare(keyB.name)) : [];
+            client.send(JSON.stringify({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, plugin: data.params.plugin, response: selectEntityValues }));
             return;
         }
         else {
@@ -265,4 +277,3 @@ export async function wsMessageHandler(client, message) {
         return;
     }
 }
-//# sourceMappingURL=matterbridgeWebsocket.js.map