matterbridge 1.0.6 → 1.1.3

package/dist/matterbridgeController.js

@@ -0,0 +1,309 @@
+export {};
+/* eslint-disable max-len */
+/*
+async function startMatterController() {
+  log.info('Creating mattercontrollerContext: mattercontrollerContext');
+  mattercontrollerContext = storageManager.createContext('mattercontrollerContext');
+
+  await createMatterServer(storageManager);
+
+  log.info('Creating matter commissioning controller');
+  commissioningController = new CommissioningController({
+    autoConnect: false,
+  });
+  await matterServer.addCommissioningController(commissioningController);
+
+  log.info('Starting matter server');
+  await matterServer.start();
+  log.info('Started matter server');
+
+  AllClustersMap[EveHistoryCluster.id] = EveHistoryCluster;
+  log.info('Added custom cluster:', getClusterNameById(EveHistoryCluster.id));
+
+  if (hasParameter('ble')) {
+    //
+  }
+
+  if (hasParameter('pairingcode')) {
+    const pairingCode = getParameter('pairingcode');
+    const ip = mattercontrollerContext.has('ip') ? mattercontrollerContext.get<string>('ip') : undefined;
+    const port = mattercontrollerContext.has('port') ? mattercontrollerContext.get<number>('port') : undefined;
+
+    let longDiscriminator, setupPin, shortDiscriminator;
+    if (pairingCode !== undefined) {
+      const pairingCodeCodec = ManualPairingCodeCodec.decode(pairingCode);
+      shortDiscriminator = pairingCodeCodec.shortDiscriminator;
+      longDiscriminator = undefined;
+      setupPin = pairingCodeCodec.passcode;
+      logger.debug(`Data extracted from pairing code: ${Logger.toJSON(pairingCodeCodec)}`);
+    } else {
+      longDiscriminator = mattercontrollerContext.get('longDiscriminator', 3840);
+      if (longDiscriminator > 4095) throw new Error('Discriminator value must be less than 4096');
+      setupPin = mattercontrollerContext.get('pin', 20202021);
+    }
+    if ((shortDiscriminator === undefined && longDiscriminator === undefined) || setupPin === undefined) {
+      throw new Error('Please specify the longDiscriminator of the device to commission with -longDiscriminator or provide a valid passcode with -passcode');
+    }
+
+    const commissioningOptions: CommissioningOptions = {
+      regulatoryLocation: GeneralCommissioning.RegulatoryLocationType.IndoorOutdoor,
+      regulatoryCountryCode: 'XX',
+    };
+    const options = {
+      commissioning: commissioningOptions,
+      discovery: {
+        knownAddress: ip !== undefined && port !== undefined ? { ip, port, type: 'udp' } : undefined,
+        identifierData: longDiscriminator !== undefined ? { longDiscriminator } : shortDiscriminator !== undefined ? { shortDiscriminator } : {},
+      },
+      passcode: setupPin,
+    } as NodeCommissioningOptions;
+    log.info(`Commissioning ... ${JSON.stringify(options)}`);
+    const nodeId = await commissioningController.commissionNode(options);
+    mattercontrollerContext.set('nodeId', nodeId.nodeId);
+    log.info(`Commissioning successfully done with nodeId: ${nodeId.nodeId}`);
+    console.log('ActiveSessionInformation:', commissioningController.getActiveSessionInformation());
+  } // (hasParameter('pairingcode'))
+
+  if (hasParameter('discover')) {
+    Logger.defaultLogLevel = Level.DEBUG;
+    const discover = await commissioningController.discoverCommissionableDevices({});
+    console.log(discover);
+    Logger.defaultLogLevel = Level.INFO;
+  }
+
+  log.info(`Commissioning controller is already commisioned: ${commissioningController.isCommissioned()}`);
+  const nodes = commissioningController.getCommissionedNodes();
+  nodes.forEach(async (nodeId) => {
+    log.warn(`Connecting to commissioned node: ${nodeId}`);
+    const node = await commissioningController.connectNode(nodeId, {
+      attributeChangedCallback: (peerNodeId, { path: { nodeId, clusterId, endpointId, attributeName }, value }) =>
+        console.log(`\x1b[37;44mattributeChangedCallback ${peerNodeId}: Attribute ${nodeId}/${endpointId}/${clusterId}/${attributeName} changed to ${Logger.toJSON(value)}\x1b[40;0m`),
+      eventTriggeredCallback: (peerNodeId, { path: { nodeId, clusterId, endpointId, eventName }, events }) =>
+        console.log(`\x1b[37;44meventTriggeredCallback ${peerNodeId}: Event ${nodeId}/${endpointId}/${clusterId}/${eventName} triggered with ${Logger.toJSON(events)}\x1b[40;0m`),
+      stateInformationCallback: (peerNodeId, info) => {
+        switch (info) {
+          case NodeStateInformation.Connected:
+            console.log(`\x1b[37;44mstateInformationCallback ${peerNodeId}: Node ${nodeId} connected\x1b[40;0m`);
+            break;
+          case NodeStateInformation.Disconnected:
+            console.log(`\x1b[37;44mstateInformationCallback ${peerNodeId}: Node ${nodeId} disconnected\x1b[40;0m`);
+            break;
+          case NodeStateInformation.Reconnecting:
+            console.log(`\x1b[37;44mstateInformationCallback ${peerNodeId}: Node ${nodeId} reconnecting\x1b[40;0m`);
+            break;
+          case NodeStateInformation.WaitingForDeviceDiscovery:
+            console.log(`\x1b[37;44mstateInformationCallback ${peerNodeId}: Node ${nodeId} waiting for device discovery\x1b[40;0m`);
+            break;
+          case NodeStateInformation.StructureChanged:
+            console.log(`\x1b[37;44mstateInformationCallback ${peerNodeId}: Node ${nodeId} structure changed\x1b[40;0m`);
+            break;
+          case NodeStateInformation.Decommissioned:
+            console.log(`\x1b[37;44mstateInformationCallback ${peerNodeId}: Node ${nodeId} decommissioned\x1b[40;0m`);
+            break;
+          default:
+            console.log(`\x1b[37;44mstateInformationCallback ${peerNodeId}: Node ${nodeId} NodeStateInformation.${info}\x1b[40;0m`);
+            break;
+        }
+      },
+    });
+
+    const info = node.getRootClusterClient(BasicInformationCluster);
+    let name = '';
+    if (info !== undefined) {
+      log.info(`Node ${nodeId} VendorName ${await info.getVendorNameAttribute()}`); // This call is executed remotely
+      log.info(`Node ${nodeId} ProductName ${(name = await info.getProductNameAttribute())}`); // This call is executed remotely
+      log.info(`Node ${nodeId} NodeLabel ${await info.getNodeLabelAttribute()}`); // This call is executed remotely
+      log.info(`Node ${nodeId} ProductLabel ${await info.getProductLabelAttribute()}`); // This call is executed remotely
+      log.info(`Node ${nodeId} SerialNumber ${await info.getSerialNumberAttribute()}`); // This call is executed remotely
+      log.info(`Node ${nodeId} UniqueId ${await info.getUniqueIdAttribute()}`); // This call is executed remotely
+    } else {
+      log.error('No BasicInformation Cluster found. This should never happen!');
+    }
+
+    log.warn(`Logging commissioned node: ${nodeId} name: ${name}`);
+    //node.logStructure();
+
+    const mattercontrollerNodeContext = storageManager.createContext(name);
+    const interactionClient = await node.getInteractionClient();
+
+    // Log BasicInformationCluster
+    const attributesInfoCluster = await interactionClient.getMultipleAttributes({
+      attributes: [{ clusterId: BasicInformationCluster.id }],
+    });
+    attributesInfoCluster.forEach((attribute) => {
+      log.info(
+        `${name}:BasicInformationCluster ${attribute.path.nodeId}-${attribute.path.endpointId}-${attribute.path.clusterId} id: ${attribute.path.attributeId} name: ${attribute.path.attributeName}: ${typeof attribute.value === 'object' ? stringify(attribute.value) : attribute.value}`,
+      );
+    });
+
+    // Log PowerSourceConfigurationCluster
+    const attributesPowerConfigCluster = await interactionClient.getMultipleAttributes({
+      attributes: [{ clusterId: PowerSourceConfigurationCluster.id }],
+    });
+    attributesPowerConfigCluster.forEach((attribute) => {
+      log.info(
+        `${name}:PowerSourceConfigurationCluster ${attribute.path.nodeId}-${attribute.path.endpointId}-${attribute.path.clusterId} id: ${attribute.path.attributeId} name: ${attribute.path.attributeName}: ${typeof attribute.value === 'object' ? stringify(attribute.value) : attribute.value}`,
+      );
+    });
+
+    // Log PowerSourceCluster
+    const attributesPowerCluster = await interactionClient.getMultipleAttributes({
+      attributes: [{ clusterId: PowerSourceCluster.id }],
+    });
+    attributesPowerCluster.forEach((attribute) => {
+      log.info(
+        `${name}:PowerSourceCluster ${attribute.path.nodeId}-${attribute.path.endpointId}-${attribute.path.clusterId} id: ${attribute.path.attributeId} name: ${attribute.path.attributeName}: ${typeof attribute.value === 'object' ? stringify(attribute.value) : attribute.value}`,
+      );
+    });
+
+    // Log ThreadNetworkDiagnostics
+    const attributesThreadCluster = await interactionClient.getMultipleAttributes({
+      attributes: [{ clusterId: ThreadNetworkDiagnosticsCluster.id }]
+    });
+    attributesThreadCluster.forEach(attribute => {
+      log.info(`${name}:ThreadNetworkDiagnosticsCluster ${attribute.path.nodeId}-${attribute.path.endpointId}-${attribute.path.clusterId} id: ${attribute.path.attributeId} name: ${attribute.path.attributeName}: ${typeof attribute.value === 'object' ? stringify(attribute.value) : attribute.value}`);
+    });
+
+    const devices = node.getDevices();
+    devices.forEach(async (device) => {
+      log.info(`Device id: ${device.id} name: ${device.name}`);
+      //logEndpoint(device);
+
+      const eveHistory = device.getClusterClient(EveHistoryCluster);
+      if (eveHistory !== undefined) {
+        log.info(`EveHistory found on id: ${device.id} name: ${device.name}`);
+
+        // Log EveHistoryCluster
+        const attributesEveHistoryCluster = await interactionClient.getMultipleAttributes({
+          attributes: [{ clusterId: EveHistoryCluster.id }],
+        });
+        attributesEveHistoryCluster.forEach((attribute) => {
+          log.info(
+            `${name}:EveHistoryCluster ${attribute.path.nodeId}-${attribute.path.endpointId}-${attribute.path.clusterId} id: ${attribute.path.attributeId} name: ${attribute.path.attributeName}: ${typeof attribute.value === 'object' ? stringify(attribute.value) : attribute.value}`,
+          );
+        });
+
+        const history = new MatterHistory(log, name, { fileName: name + '_history.json' });
+        let logMessage = '';
+
+        // Get and decode HistoryStatus
+        const historyStatus: Uint8Array = await eveHistory.getHistoryStatusAttribute();
+        log.info((logMessage = history.decodeHistoryStatus(Buffer.from(historyStatus))));
+        fs.appendFileSync(name + '.log', logMessage + '\n');
+
+        // Set HistorySetTime
+        const bufferSetTime = history.encodeHistorySetTime();
+        log.info((logMessage = history.decodeHistorySetTime(bufferSetTime)));
+        fs.appendFileSync(name + '.log', logMessage + '\n');
+        await eveHistory.setHistorySetTimeAttribute(bufferSetTime);
+
+        // Set HistoryRequest
+        const entryNumber = mattercontrollerNodeContext.get('nextEntry', history.getFirstEntry());
+        const bufferRequest = history.encodeHistoryRequest(history.clamp(entryNumber, history.getFirstEntry(), history.getLastEntry()));
+        log.info((logMessage = history.decodeHistoryRequest(bufferRequest)));
+        fs.appendFileSync(name + '.log', logMessage + '\n');
+        await eveHistory.setHistoryRequestAttribute(bufferRequest);
+
+        // Get HistoryEntries
+        let historyEntries: Uint8Array = await eveHistory.getHistoryEntriesAttribute();
+        let bufferHistoryEntries = Buffer.from(historyEntries);
+        //console.log(history.historyEntriesToString(bufferHistoryEntries));
+        while (bufferHistoryEntries.length > 0) {
+          for (let i = 0; i < bufferHistoryEntries.length; ) {
+            const bufferHistoryEntry = Buffer.copyBytesFrom(bufferHistoryEntries, i, bufferHistoryEntries.readUInt8(i));
+            i += bufferHistoryEntries.readUInt8(i);
+            history.decodeHistoryEntry(bufferHistoryEntry);
+            log.info((logMessage = history.historyEntryToString(bufferHistoryEntry)));
+            fs.appendFileSync(name + '.log', logMessage + '\n');
+            mattercontrollerNodeContext.set('nextEntry', bufferHistoryEntry.readUInt32LE(1) + 1);
+          }
+          historyEntries = await eveHistory.getHistoryEntriesAttribute();
+          bufferHistoryEntries = Buffer.from(historyEntries);
+          //console.log(history.historyEntriesToString(bufferHistoryEntries));
+        }
+        history.writeHistoryFile();
+        //history.logHistory(true);
+
+        eveHistory.subscribeHistoryStatusAttribute(
+          (value: Uint8Array) => { log.warn('Received EveHistoryStatus:', value.toHex()) }, 0, 30)
+          .then(() => { log.warn('Subscription successful to EveHistoryStatus.') })
+          .catch((error) => { log.error('Error during subscription to EveHistoryStatus:', error) });
+
+        eveHistory.subscribeHistoryEntriesAttribute(
+          (value: Uint8Array) => { log.warn('Received EveHistoryEntries:', value.toHex()) }, 0, 30)
+          .then(() => { log.warn('Subscription successful to EveHistoryEntries.') })
+          .catch((error) => { log.error('Error during subscription to EveHistoryEntries:', error) });
+
+        setInterval(async () => {
+          try {
+            const attributesEveCluster = await interactionClient.getMultipleAttributes({
+              attributes: [{ clusterId: EveHistoryCluster.id }],
+            });
+            log.info('\x1b[97;45mEve device: ' + name + '\x1b[40;0m');
+
+            attributesEveCluster.forEach((attribute) => {
+              if (attribute.path.attributeId === EveHistoryCluster.attributes.ConfigDataGet.id) {
+                const data = Buffer.from(attribute.value);
+                logMessage = `ConfigDataGet(${data.length}): [${data.toHex()}]`;
+                log.info(logMessage);
+                log.info('*' + history.decodeConfigData(data));
+                fs.appendFileSync(name + '.config.log', logMessage + '\n');
+              } else if (attribute.path.attributeId === EveHistoryCluster.attributes.HistoryStatus.id) {
+                logMessage = history.decodeHistoryStatus(Buffer.from(attribute.value));
+                log.info(logMessage);
+                fs.appendFileSync(name + '.log', logMessage + '\n');
+              } else if (attribute.path.attributeId === EveHistoryCluster.attributes.HistoryEntries.id) {
+                const bufferHistoryEntries = Buffer.from(attribute.value);
+                for (let i = 0; i < bufferHistoryEntries.length; ) {
+                  const bufferHistoryEntry = Buffer.copyBytesFrom(bufferHistoryEntries, i, bufferHistoryEntries.readUInt8(i));
+                  i += bufferHistoryEntries.readUInt8(i);
+                  history.decodeHistoryEntry(bufferHistoryEntry);
+                  log.info((logMessage = history.historyEntryToString(bufferHistoryEntry)));
+                  fs.appendFileSync(name + '.log', logMessage + '\n');
+                }
+                history.writeHistoryFile();
+              } else if (attribute.path.attributeId === EveHistoryCluster.attributes.TimesOpened.id) {
+                log.info(`TimesOpened: ${attribute.value}`);
+              } else if (attribute.path.attributeId === EveHistoryCluster.attributes.LastEvent.id) {
+                log.info(`LastEvent: ${attribute.value}=${history.secsToDateString(attribute.value + history.getInitialTime() - history.getTimeOffset())}`);
+              } else if (attribute.path.attributeId === EveHistoryCluster.attributes.ResetTotal.id) {
+                log.info(`ResetTotal: ${attribute.value}=${history.secsToDateStringSinceEveEpoch(attribute.value)}`);
+              } else if (attribute.path.attributeId === EveHistoryCluster.attributes.Voltage.id) {
+                log.info(`Voltage: ${attribute.value}`);
+              } else if (attribute.path.attributeId === EveHistoryCluster.attributes.Current.id) {
+                log.info(`Current: ${attribute.value}`);
+              } else if (attribute.path.attributeId === EveHistoryCluster.attributes.Consumption.id) {
+                log.info(`Consumption: ${attribute.value}`);
+              } else if (attribute.path.attributeId === EveHistoryCluster.attributes.TotalConsumption.id) {
+                log.info(`TotalConsumption: ${attribute.value}`);
+              } else if (attribute.path.attributeId === EveHistoryCluster.attributes.ChildLock.id) {
+                log.info(`ChildLock: ${attribute.value}`);
+              } else if (attribute.path.attributeId === EveHistoryCluster.attributes.MotionSensitivity.id) {
+                log.info(`MotionSensitivity: ${attribute.value}`);
+              } else if (attribute.path.attributeId === EveHistoryCluster.attributes.RLoc.id) {
+                log.info((logMessage = `RLoc: 0x${attribute.value.toString(16)}`));
+              } else {
+                if (attribute.path.attributeId >= 0x130a0000) {
+                  log.info(`Unknown attribute ${attribute.path.attributeName} type: ${typeof attribute.value} value: [${attribute.value.toString(16)}]${attribute.value}`);
+                }
+              }
+            });
+          } catch (error) {
+            console.error(error);
+          }
+        }, 30000);
+      } else {
+        log.info(`EveHistory not found on ${device.id} name: ${device.name}`);
+      }
+    }); // devices.forEach(async device => {
+  }); // nodes.forEach(async nodeId => {
+
+  if (hasParameter('unpairall')) {
+    nodes.forEach(async (nodeId) => {
+      await commissioningController.removeNode(nodeId);
+    });
+    process.exit(0);
+  }
+}
+*/
+//# sourceMappingURL=matterbridgeController.js.map

package/dist/matterbridgeController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"matterbridgeController.js","sourceRoot":"","sources":["../src/matterbridgeController.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiTE"}

package/dist/matterbridgeDevice.d.ts

@@ -1,5 +1,30 @@
+/**
+ * This file contains the class MatterbridgeDevice.
+ *
+ * @file matterbridgeDevice.ts
+ * @author Luca Liguori
+ * @date 2023-12-29
+ * @version 1.0.15
+ *
+ * Copyright 2023, 2024 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 { ClusterServerHandlers, ColorControl, Identify, LevelControl, OnOff, PowerSource, WindowCovering } from '@project-chip/matter-node.js/cluster';
 import { Device, DeviceTypeDefinition, EndpointOptions } from '@project-chip/matter-node.js/device';
+import { MatterHistory } from 'matter-history';
+import { AirQuality } from './AirQualityCluster.js';
+import { AnsiLogger } from 'node-ansi-logger';
 type MakeMandatory<T> = Exclude<T, undefined>;
 type MatterbridgeDeviceCommands = {
     identify: MakeMandatory<ClusterServerHandlers<typeof Identify.Cluster>['identify']>;
@@ -33,25 +58,205 @@ declare const MatterbridgeDevice_base: new (definition: DeviceTypeDefinition, op
 };
 export declare class MatterbridgeDevice extends MatterbridgeDevice_base {
     constructor(definition: DeviceTypeDefinition, options?: EndpointOptions);
+    addDeviceType(deviceType: DeviceTypeDefinition): void;
+    /**
+     * Creates a room Eve History Cluster Server.
+     *
+     * @param history - The MatterHistory object.
+     * @param log - The AnsiLogger object.
+     */
+    createRoomEveHistoryClusterServer(history: MatterHistory, log: AnsiLogger): void;
+    /**
+     * Creates a Weather Eve History Cluster Server.
+     *
+     * @param history - The MatterHistory instance.
+     * @param log - The AnsiLogger instance.
+     */
+    createWeatherEveHistoryClusterServer(history: MatterHistory, log: AnsiLogger): void;
+    /**
+     * Creates an Energy Eve History Cluster Server.
+     *
+     * @param history - The MatterHistory object.
+     * @param log - The AnsiLogger object.
+     */
+    createEnergyEveHistoryClusterServer(history: MatterHistory, log: AnsiLogger): void;
+    /**
+     * Creates a Motion Eve History Cluster Server.
+     *
+     * @param history - The MatterHistory object.
+     * @param log - The AnsiLogger object.
+     */
+    createMotionEveHistoryClusterServer(history: MatterHistory, log: AnsiLogger): void;
+    /**
+     * Creates a door EveHistoryCluster server.
+     *
+     * @param history - The MatterHistory instance.
+     * @param log - The AnsiLogger instance.
+     */
+    createDoorEveHistoryClusterServer(history: MatterHistory, log: AnsiLogger): void;
+    /**
+     * Creates a default IdentifyCluster server.
+     */
     createDefaultIdentifyClusterServer(): void;
+    /**
+     * Creates a default groups cluster server and adds it to the device.
+     */
     createDefaultGroupsClusterServer(): void;
+    /**
+     * Creates a default scenes cluster server and adds it to the current instance.
+     */
     createDefaultScenesClusterServer(): void;
-    createDefaultBridgedDeviceBasicInformationClusterServer(deviceName: string, uniqueId: string, vendorId?: number, vendorName?: string, productName?: string): void;
-    createDefaultBasicInformationClusterServer(deviceName: string, uniqueId: string, vendorId: number, vendorName: string, productId: number, productName: string): void;
+    /**
+     * Creates a unique identifier based on the provided parameters.
+     * @param param1 - The first parameter.
+     * @param param2 - The second parameter.
+     * @param param3 - The third parameter.
+     * @param param4 - The fourth parameter.
+     * @returns A unique identifier generated using the MD5 hash algorithm.
+     */
+    private createUniqueId;
+    /**
+     * Creates a default Basic Information Cluster Server.
+     *
+     * @param deviceName - The name of the device.
+     * @param serialNumber - The serial number of the device.
+     * @param vendorId - The vendor ID of the device.
+     * @param vendorName - The vendor name of the device.
+     * @param productId - The product ID of the device.
+     * @param productName - The product name of the device.
+     * @param softwareVersion - The software version of the device. Default is 1.
+     * @param softwareVersionString - The software version string of the device. Default is 'v.1.0.0'.
+     * @param hardwareVersion - The hardware version of the device. Default is 1.
+     * @param hardwareVersionString - The hardware version string of the device. Default is 'v.1.0.0'.
+     */
+    createDefaultBasicInformationClusterServer(deviceName: string, serialNumber: string, vendorId: number, vendorName: string, productId: number, productName: string, softwareVersion?: number, softwareVersionString?: string, hardwareVersion?: number, hardwareVersionString?: string): void;
+    /**
+     * Creates a default BridgedDeviceBasicInformationClusterServer.
+     *
+     * @param deviceName - The name of the device.
+     * @param serialNumber - The serial number of the device.
+     * @param vendorId - The vendor ID of the device.
+     * @param vendorName - The name of the vendor.
+     * @param productName - The name of the product.
+     * @param softwareVersion - The software version of the device. Default is 1.
+     * @param softwareVersionString - The software version string of the device. Default is 'v.1.0.0'.
+     * @param hardwareVersion - The hardware version of the device. Default is 1.
+     * @param hardwareVersionString - The hardware version string of the device. Default is 'v.1.0.0'.
+     */
+    createDefaultBridgedDeviceBasicInformationClusterServer(deviceName: string, serialNumber: string, vendorId: number, vendorName: string, productName: string, softwareVersion?: number, softwareVersionString?: string, hardwareVersion?: number, hardwareVersionString?: string): void;
+    /**
+     * Creates a default Electrical Measurement Cluster Server.
+     *
+     * @param voltage - The RMS voltage value.
+     * @param current - The RMS current value.
+     * @param power - The active power value.
+     * @param consumption - The total active power consumption value.
+     */
+    createDefaultElectricalMeasurementClusterServer(voltage?: number, current?: number, power?: number, consumption?: number): void;
+    /**
+     * Creates a default Thread Network Diagnostics Cluster server.
+     *
+     * @remarks
+     * This method adds a cluster server used only to give the networkName to Eve app.
+     *
+     * @returns void
+     */
     createDefaultThreadNetworkDiagnosticsClusterServer(): void;
+    /**
+     * Creates a default OnOff cluster server.
+     *
+     * @param onOff - The initial state of the OnOff cluster (default: false).
+     */
     createDefaultOnOffClusterServer(onOff?: boolean): void;
+    /**
+     * Creates a default window covering cluster server.
+     *
+     * @param positionPercent100ths - The position percentage in 100ths (0-10000). Defaults to 0.
+     */
     createDefaultWindowCoveringClusterServer(positionPercent100ths?: number): void;
+    /**
+     * Creates a default occupancy sensing cluster server.
+     *
+     * @param occupied - A boolean indicating whether the occupancy is occupied or not. Default is false.
+     */
     createDefaultOccupancySensingClusterServer(occupied?: boolean): void;
+    /**
+     * Creates a default Illuminance Measurement Cluster Server.
+     *
+     * @param measuredValue - The measured value of illuminance.
+     */
     createDefaultIlluminanceMeasurementClusterServer(measuredValue?: number): void;
+    /**
+     * Creates a default temperature measurement cluster server.
+     *
+     * @param measuredValue - The measured value of the temperature.
+     */
     createDefaultTemperatureMeasurementClusterServer(measuredValue?: number): void;
+    /**
+     * Creates a default RelativeHumidityMeasurementCluster server.
+     *
+     * @param measuredValue - The measured value of the relative humidity.
+     */
     createDefaultRelativeHumidityMeasurementClusterServer(measuredValue?: number): void;
+    /**
+     * Creates a default Pressure Measurement Cluster Server.
+     *
+     * @param measuredValue - The measured value for the pressure.
+     */
     createDefaultPressureMeasurementClusterServer(measuredValue?: number): void;
+    /**
+     * Creates a default boolean state cluster server.
+     *
+     * @param contact - Optional boolean value indicating the contact state. Defaults to `true` if not provided.
+     */
     createDefaultBooleanStateClusterServer(contact?: boolean): void;
-    createDefaultPowerSourceReplaceableBatteryClusterServer(batPercentRemaining?: number, batChargeLevel?: PowerSource.BatChargeLevel, batVoltage?: number): void;
+    /**
+     * Creates a default power source replaceable battery cluster server.
+     *
+     * @param batPercentRemaining - The remaining battery percentage (default: 100).
+     * @param batChargeLevel - The battery charge level (default: PowerSource.BatChargeLevel.Ok).
+     * @param batVoltage - The battery voltage (default: 1500).
+     * @param batReplacementDescription - The battery replacement description (default: 'Battery type').
+     * @param batQuantity - The battery quantity (default: 1).
+     */
+    createDefaultPowerSourceReplaceableBatteryClusterServer(batPercentRemaining?: number, batChargeLevel?: PowerSource.BatChargeLevel, batVoltage?: number, batReplacementDescription?: string, batQuantity?: number): void;
+    /**
+     * Creates a default power source rechargeable battery cluster server.
+     *
+     * @param batPercentRemaining - The remaining battery percentage (default: 100).
+     * @param batChargeLevel - The battery charge level (default: PowerSource.BatChargeLevel.Ok).
+     * @param batVoltage - The battery voltage (default: 1500).
+     */
     createDefaultPowerSourceRechargableBatteryClusterServer(batPercentRemaining?: number, batChargeLevel?: PowerSource.BatChargeLevel, batVoltage?: number): void;
+    /**
+     * Creates a default power source wired cluster server.
+     *
+     * @param wiredCurrentType - The type of wired current (default: PowerSource.WiredCurrentType.Ac)
+     */
     createDefaultPowerSourceWiredClusterServer(wiredCurrentType?: PowerSource.WiredCurrentType): void;
+    /**
+     * Creates a default power source configuration cluster server.
+     *
+     * @remarks
+     * The endpoint at this time is only known for Accessory Platforms.
+     * Don't use it in Dynamic Platforms.
+     *
+     *
+     * @param endpointNumber - The endpoint number where to find the PowerSourceCluster.
+     */
     createDefaultPowerSourceConfigurationClusterServer(endpointNumber: number): void;
-    createDefaultAirQualityClusterServer(): void;
+    /**
+     * Creates a default air quality cluster server.
+     *
+     * @param airQuality The air quality type. Defaults to `AirQuality.AirQualityType.Unknown`.
+     */
+    createDefaultAirQualityClusterServer(airQuality?: AirQuality.AirQualityType): void;
+    /**
+     * Creates a default TVOC measurement cluster server.
+     *
+     * @param measuredValue - The measured value for TVOC.
+     */
+    createDefaultTvocMeasurementClusterServer(measuredValue?: number): void;
 }
 export {};
 //# sourceMappingURL=matterbridgeDevice.d.ts.map

package/dist/matterbridgeDevice.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"matterbridgeDevice.d.ts","sourceRoot":"","sources":["../src/matterbridgeDevice.ts"],"names":[],"mappings":"AACA,OAAO,EAKL,qBAAqB,EACrB,YAAY,EAEZ,QAAQ,EAGR,YAAY,EAGZ,KAAK,EAEL,WAAW,EAWX,cAAc,EAIf,MAAM,sCAAsC,CAAC;AAE9C,OAAO,EAAE,MAAM,EAAiB,oBAAoB,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AAInH,KAAK,aAAa,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;AAE9C,KAAK,0BAA0B,GAAG;IAChC,QAAQ,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;IAEpF,EAAE,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,KAAK,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IACtE,GAAG,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,KAAK,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IACxE,MAAM,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,KAAK,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC9E,aAAa,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,KAAK,CAAC,QAAQ,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC;IAE5F,WAAW,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC;IAC/F,oBAAoB,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC;IAEjH,SAAS,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;IAC3F,OAAO,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IACvF,OAAO,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IACvF,gBAAgB,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC;IACzG,cAAc,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC;IACrG,cAAc,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC;IACrG,sBAAsB,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAC,wBAAwB,CAAC,CAAC,CAAC;IACrH,sBAAsB,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAC,wBAAwB,CAAC,CAAC,CAAC;IAErH,QAAQ,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,cAAc,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;IAC3F,WAAW,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,cAAc,CAAC,QAAQ,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC;IACjG,UAAU,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,cAAc,CAAC,QAAQ,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC;IAC/F,kBAAkB,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,cAAc,CAAC,QAAQ,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC;CAChH,CAAC;AAGF,eAAO,MAAM,WAAW,sBAOtB,CAAC;AAEH,eAAO,MAAM,cAAc,sBAOzB,CAAC;AAEH,eAAO,MAAM,sBAAsB,sBAOjC,CAAC;AAEH,eAAO,MAAM,gBAAgB,sBAO3B,CAAC;;;;;;AAEH,qBAAa,kBAAmB,SAAQ,uBAA6E;gBAEjH,UAAU,EAAE,oBAAoB,EAGhC,OAAO,GAAE,eAAoB;IAK/B,kCAAkC;IAkBlC,gCAAgC;IAIhC,gCAAgC;IAIhC,uDAAuD,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM;IA0B1J,0CAA0C,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;IAgC7J,kDAAkD;IAmClD,+BAA+B,CAAC,KAAK,UAAQ;IA0B7C,wCAAwC,CAAC,qBAAqB,CAAC,EAAE,MAAM;IAqDvE,0CAA0C,CAAC,QAAQ,UAAQ;IAe3D,gDAAgD,CAAC,aAAa,GAAE,MAAU;IAgB1E,gDAAgD,CAAC,aAAa,GAAE,MAAU;IAgB1E,qDAAqD,CAAC,aAAa,GAAE,MAAU;IAgB/E,6CAA6C,CAAC,aAAa,GAAE,MAAU;IAgBvE,sCAAsC,CAAC,OAAO,CAAC,EAAE,OAAO;IAexD,uDAAuD,CACrD,mBAAmB,GAAE,MAAY,EACjC,cAAc,GAAE,WAAW,CAAC,cAA8C,EAC1E,UAAU,GAAE,MAAa;IAwB3B,uDAAuD,CACrD,mBAAmB,GAAE,MAAY,EACjC,cAAc,GAAE,WAAW,CAAC,cAA8C,EAC1E,UAAU,GAAE,MAAa;IAyB3B,0CAA0C,CAAC,gBAAgB,GAAE,WAAW,CAAC,gBAAkD;IAgB3H,kDAAkD,CAAC,cAAc,EAAE,MAAM;IAazE,oCAAoC;CAYrC"}
+{"version":3,"file":"matterbridgeDevice.d.ts","sourceRoot":"","sources":["../src/matterbridgeDevice.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,EAKL,qBAAqB,EACrB,YAAY,EAGZ,QAAQ,EAGR,YAAY,EAGZ,KAAK,EAEL,WAAW,EAWX,cAAc,EAIf,MAAM,sCAAsC,CAAC;AAE9C,OAAO,EAAE,MAAM,EAAiB,oBAAoB,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AAGnH,OAAO,EAAE,aAAa,EAAyE,MAAM,gBAAgB,CAAC;AAEtH,OAAO,EAAE,UAAU,EAAqB,MAAM,wBAAwB,CAAC;AACvE,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAI9C,KAAK,aAAa,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;AAE9C,KAAK,0BAA0B,GAAG;IAChC,QAAQ,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;IAEpF,EAAE,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,KAAK,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IACtE,GAAG,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,KAAK,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IACxE,MAAM,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,KAAK,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC9E,aAAa,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,KAAK,CAAC,QAAQ,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC;IAE5F,WAAW,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC;IAC/F,oBAAoB,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC;IAEjH,SAAS,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;IAC3F,OAAO,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IACvF,OAAO,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IACvF,gBAAgB,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC;IACzG,cAAc,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC;IACrG,cAAc,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC;IACrG,sBAAsB,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAC,wBAAwB,CAAC,CAAC,CAAC;IACrH,sBAAsB,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAC,wBAAwB,CAAC,CAAC,CAAC;IAErH,QAAQ,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,cAAc,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;IAC3F,WAAW,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,cAAc,CAAC,QAAQ,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC;IACjG,UAAU,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,cAAc,CAAC,QAAQ,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC;IAC/F,kBAAkB,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,cAAc,CAAC,QAAQ,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC;CAChH,CAAC;AAGF,eAAO,MAAM,WAAW,sBAOtB,CAAC;AAEH,eAAO,MAAM,cAAc,sBAOzB,CAAC;AAEH,eAAO,MAAM,sBAAsB,sBAOjC,CAAC;AAEH,eAAO,MAAM,gBAAgB,sBAO3B,CAAC;;;;;;AAEH,qBAAa,kBAAmB,SAAQ,uBAA6E;gBACvG,UAAU,EAAE,oBAAoB,EAAE,OAAO,GAAE,eAAoB;IAI3E,aAAa,CAAC,UAAU,EAAE,oBAAoB;IAe9C;;;;;OAKG;IACH,iCAAiC,CAAC,OAAO,EAAE,aAAa,EAAE,GAAG,EAAE,UAAU;IAiEzE;;;;;OAKG;IACH,oCAAoC,CAAC,OAAO,EAAE,aAAa,EAAE,GAAG,EAAE,UAAU;IAoE5E;;;;;OAKG;IACH,mCAAmC,CAAC,OAAO,EAAE,aAAa,EAAE,GAAG,EAAE,UAAU;IAsF3E;;;;;OAKG;IACH,mCAAmC,CAAC,OAAO,EAAE,aAAa,EAAE,GAAG,EAAE,UAAU;IAuE3E;;;;;OAKG;IACH,iCAAiC,CAAC,OAAO,EAAE,aAAa,EAAE,GAAG,EAAE,UAAU;IAsFzE;;OAEG;IACH,kCAAkC;IAmBlC;;OAEG;IACH,gCAAgC;IAIhC;;OAEG;IACH,gCAAgC;IAIhC;;;;;;;OAOG;IACH,OAAO,CAAC,cAAc;IAMtB;;;;;;;;;;;;;OAaG;IACH,0CAA0C,CACxC,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,eAAe,SAAI,EACnB,qBAAqB,SAAY,EACjC,eAAe,SAAI,EACnB,qBAAqB,SAAY;IAkCnC;;;;;;;;;;;;OAYG;IACH,uDAAuD,CACrD,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,MAAM,EACnB,eAAe,SAAI,EACnB,qBAAqB,SAAY,EACjC,eAAe,SAAI,EACnB,qBAAqB,SAAY;IA2BnC;;;;;;;OAOG;IACH,+CAA+C,CAAC,OAAO,SAAI,EAAE,OAAO,SAAI,EAAE,KAAK,SAAI,EAAE,WAAW,SAAI;IAgBpG;;;;;;;OAOG;IACH,kDAAkD;IAoClD;;;;OAIG;IACH,+BAA+B,CAAC,KAAK,UAAQ;IA6B7C;;;;OAIG;IACH,wCAAwC,CAAC,qBAAqB,CAAC,EAAE,MAAM;IAmDvE;;;;OAIG;IACH,0CAA0C,CAAC,QAAQ,UAAQ;IAe3D;;;;OAIG;IACH,gDAAgD,CAAC,aAAa,GAAE,MAAU;IAgB1E;;;;OAIG;IACH,gDAAgD,CAAC,aAAa,GAAE,MAAU;IAgB1E;;;;OAIG;IACH,qDAAqD,CAAC,aAAa,GAAE,MAAU;IAgB/E;;;;OAIG;IACH,6CAA6C,CAAC,aAAa,GAAE,MAAa;IAgB1E;;;;OAIG;IACH,sCAAsC,CAAC,OAAO,CAAC,EAAE,OAAO;IAexD;;;;;;;;OAQG;IACH,uDAAuD,CACrD,mBAAmB,GAAE,MAAY,EACjC,cAAc,GAAE,WAAW,CAAC,cAA8C,EAC1E,UAAU,GAAE,MAAa,EACzB,yBAAyB,GAAE,MAAuB,EAClD,WAAW,GAAE,MAAU;IAwBzB;;;;;;OAMG;IACH,uDAAuD,CAAC,mBAAmB,GAAE,MAAY,EAAE,cAAc,GAAE,WAAW,CAAC,cAA8C,EAAE,UAAU,GAAE,MAAa;IAwBhM;;;;OAIG;IACH,0CAA0C,CAAC,gBAAgB,GAAE,WAAW,CAAC,gBAAkD;IAgB3H;;;;;;;;;OASG;IACH,kDAAkD,CAAC,cAAc,EAAE,MAAM;IAazE;;;;OAIG;IACH,oCAAoC,CAAC,UAAU,4BAAoC;IAanF;;;;OAIG;IACH,yCAAyC,CAAC,aAAa,GAAE,MAAU;CAcpE"}