matterbridge 3.0.2 → 3.0.3-dev-20250517-720018f

package/dist/helpers.js

@@ -1,83 +1,53 @@
-/**
- * This file contains the helpers functions of Matterbridge.
- *
- * @file helpers.ts
- * @author Luca Liguori
- * @date 2025-05-12
- * @version 1.0.0
- *
- * Copyright 2025, 2026, 2027 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. *
- */
-// @matter module
 import { OnOff } from '@matter/main/clusters/on-off';
 import { Endpoint } from '@matter/node';
 import { BridgedDeviceBasicInformationServer } from '@matter/node/behaviors/bridged-device-basic-information';
 import { OnOffBaseServer } from '@matter/node/behaviors/on-off';
 import { OnOffPlugInUnitDevice } from '@matter/node/devices/on-off-plug-in-unit';
 import { hasParameter } from './utils/commandLine.js';
-/**
- * Adds a virtual device to the provided endpoint, sets up an event listener for device state changes,
- * and ensures the device is initialized in the off state.
- *
- * @param {Endpoint<AggregatorEndpoint>} aggregatorEndpoint - The aggragator endpoint to which the virtual device will be added.
- * @param {string} name - The name of the virtual device. Spaces in the name are removed to form the device ID.
- * @param {() => Promise<void>} callback - A callback function that gets executed when the device's on/off state changes to true.
- * @returns {Promise<Endpoint>} A promise that resolves with the created virtual device.
- * @remark The virtual device is created as an instance of `Endpoint` with the `OnOffPlugInUnitDevice` device type.
- * The onOff state always reverts to false when the device is turned on.
- */
-export async function addVirtualDevice(aggregatorEndpoint, name, callback) {
-    // Create a new virtual device by instantiating `Endpoint` with device information.
-    // The device ID is created by replacing all spaces in the name with an empty string.
-    // The node label of the bridged device basic information is set to the given name.
-    const device = new Endpoint(OnOffPlugInUnitDevice.with(BridgedDeviceBasicInformationServer), {
-        id: name.replaceAll(' ', ''),
+import { MountedOnOffControlDevice } from '@matter/node/devices/mounted-on-off-control';
+import { OnOffLightDevice } from '@matter/node/devices/on-off-light';
+import { OnOffLightSwitchDevice } from '@matter/node/devices/on-off-light-switch';
+export async function addVirtualDevice(aggregatorEndpoint, name, type, callback) {
+    let deviceType;
+    switch (type) {
+        case 'light':
+            deviceType = OnOffLightDevice.with(BridgedDeviceBasicInformationServer);
+            break;
+        case 'outlet':
+            deviceType = OnOffPlugInUnitDevice.with(BridgedDeviceBasicInformationServer);
+            break;
+        case 'switch':
+            deviceType = OnOffLightSwitchDevice.with(BridgedDeviceBasicInformationServer, OnOffBaseServer);
+            break;
+        case 'mounted_switch':
+            deviceType = MountedOnOffControlDevice.with(BridgedDeviceBasicInformationServer);
+            break;
+    }
+    const device = new Endpoint(deviceType, {
+        id: name.replaceAll(' ', '') + ':' + type,
         bridgedDeviceBasicInformation: { nodeLabel: name },
         onOff: { onOff: false, startUpOnOff: OnOff.StartUpOnOff.Off },
     });
-    // Set up an event listener for when the `onOff` state changes.
     device.events.onOff.onOff$Changed.on(async (value) => {
-        // If the `onOff` state becomes true, turn off the virtual device and execute the callback.
         if (value) {
             await device.setStateOf(OnOffBaseServer, { onOff: false });
             callback();
         }
     });
-    // Add the created device to the given endpoint.
     await aggregatorEndpoint.add(device);
-    // Initially set the state of the virtual device's `OnOffBaseServer` to false (off).
     await device.setStateOf(OnOffBaseServer, { onOff: false });
     return device;
 }
-/**
- * Creates and add the virtual devices to the aggregator.
- *
- * @param {Matterbridge} matterbridge - The Matterbridge instance.
- * @param {Endpoint<AggregatorEndpoint>} aggregatorEndpoint - The aggregator node to add the virtual devices to.
- * @returns {Promise<void>} A promise that resolves when the virtual devices are added.
- */
 export async function addVirtualDevices(matterbridge, aggregatorEndpoint) {
-    if (!hasParameter('novirtual') && matterbridge.bridgeMode === 'bridge' && aggregatorEndpoint) {
+    if (matterbridge.matterbridgeInformation.virtualMode !== 'disabled' && matterbridge.bridgeMode === 'bridge' && aggregatorEndpoint) {
         matterbridge.log.notice(`Creating virtual devices for Matterbridge server node...`);
-        await addVirtualDevice(aggregatorEndpoint, 'Restart Matterbridge', async () => {
+        await addVirtualDevice(aggregatorEndpoint, 'Restart Matterbridge', matterbridge.matterbridgeInformation.virtualMode, async () => {
             if (matterbridge.restartMode === '')
                 await matterbridge.restartProcess();
             else
                 await matterbridge.shutdownProcess();
         });
-        await addVirtualDevice(aggregatorEndpoint, 'Update Matterbridge', async () => {
+        await addVirtualDevice(aggregatorEndpoint, 'Update Matterbridge', matterbridge.matterbridgeInformation.virtualMode, async () => {
             if (hasParameter('shelly')) {
                 const { getShelly } = await import('./shelly.js');
                 getShelly('/api/updates/sys/perform', 10 * 1000)
@@ -100,7 +70,7 @@ export async function addVirtualDevices(matterbridge, aggregatorEndpoint) {
             }
         });
         if (hasParameter('shelly')) {
-            await addVirtualDevice(aggregatorEndpoint, 'Reboot Matterbridge', async () => {
+            await addVirtualDevice(aggregatorEndpoint, 'Reboot Matterbridge', matterbridge.matterbridgeInformation.virtualMode, async () => {
                 const { postShelly } = await import('./shelly.js');
                 postShelly('/api/system/reboot', {}, 60 * 1000)
                     .then(() => {
@@ -113,4 +83,3 @@ export async function addVirtualDevices(matterbridge, aggregatorEndpoint) {
         }
     }
 }
-//# sourceMappingURL=helpers.js.map

package/dist/index.js

@@ -1,35 +1,6 @@
-/**
- * This file contains the entry point of Matterbridge.
- *
- * @file index.ts
- * @author Luca Liguori
- * @date 2023-12-29
- * @version 1.0.7
- *
- * 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. *
- */
-// Matterbridge
 import { Matterbridge } from './matterbridge.js';
 import { hasParameter } from './utils/export.js';
-// AnsiLogger module
 import { AnsiLogger } from './logger/export.js';
-// @matter
-export { SemanticNamespace, ClosureTag, CompassDirectionTag, CompassLocationTag, DirectionTag, ElectricalMeasurementTag, LaundryTag, LevelTag, LocationTag, NumberTag, PositionTag, PowerSourceTag, RefrigeratorTag, RoomAirConditionerTag, SwitchesTag, } from '@matter/main';
-export * from '@matter/main/clusters';
-export * from '@matter/main/types';
-// Matterbridge
 export * from './matterbridge.js';
 export * from './matterbridgeTypes.js';
 export * from './matterbridgeEndpoint.js';
@@ -40,7 +11,8 @@ export * from './matterbridgePlatform.js';
 export * from './matterbridgeAccessoryPlatform.js';
 export * from './matterbridgeDynamicPlatform.js';
 export * from './roboticVacuumCleaner.js';
-const log = new AnsiLogger({ logName: 'Main', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: hasParameter('debug') ? "debug" /* LogLevel.DEBUG */ : "info" /* LogLevel.INFO */ });
+export { addVirtualDevice } from './helpers.js';
+const log = new AnsiLogger({ logName: 'Main', logTimestampFormat: 4, logLevel: hasParameter('debug') ? "debug" : "info" });
 async function main() {
     log.debug('***Matterbridge.loadInstance() called');
     await Matterbridge.loadInstance();
@@ -49,4 +21,3 @@ async function main() {
 main().catch((error) => {
     log.error(`Matterbridge.loadInstance() failed with error: ${error instanceof Error ? error.message : error}`);
 });
-//# sourceMappingURL=index.js.map

package/dist/logger/export.js

@@ -1,2 +1 @@
 export * from 'node-ansi-logger';
-//# sourceMappingURL=export.js.map

package/dist/matter/behaviors.js

@@ -1,3 +1 @@
-// @matter
 export * from '@matter/node/behaviors';
-//# sourceMappingURL=behaviors.js.map

package/dist/matter/clusters.js

@@ -1,3 +1 @@
-// @matter
 export * from '@matter/types/clusters';
-//# sourceMappingURL=clusters.js.map

package/dist/matter/devices.js

@@ -1,3 +1 @@
-// @matter
 export * from '@matter/node/devices';
-//# sourceMappingURL=devices.js.map

package/dist/matter/endpoints.js

@@ -1,3 +1 @@
-// @matter
 export { AggregatorEndpoint, ElectricalSensorEndpoint, PowerSourceEndpoint, BridgedNodeEndpoint, RootEndpoint, DeviceEnergyManagementEndpoint, OtaProviderEndpoint, OtaRequestorEndpoint } from '@matter/node/endpoints';
-//# sourceMappingURL=endpoints.js.map

package/dist/matter/export.js

@@ -1,6 +1,4 @@
-// @matter
 export * from '@matter/main';
 export { SemanticNamespace, ClosureTag, CompassDirectionTag, CompassLocationTag, DirectionTag, ElectricalMeasurementTag, LaundryTag, LevelTag, LocationTag, NumberTag, PositionTag, PowerSourceTag, RefrigeratorTag, RoomAirConditionerTag, SwitchesTag, } from '@matter/main';
 export { AttributeElement, ClusterElement, ClusterModel, CommandElement, EventElement, FieldElement } from '@matter/main/model';
 export { logEndpoint, MdnsService, Val } from '@matter/main/protocol';
-//# sourceMappingURL=export.js.map

package/dist/matter/types.js

@@ -1,4 +1,2 @@
-// @matter
 export * from '@matter/types';
 export { ClusterRegistry } from '@matter/types';
-//# sourceMappingURL=types.js.map