matterbridge-example-dynamic-platform 3.0.2-dev-20260809-1aeac01 → 3.0.2-dev-20260812-5fa3c30

package/CHANGELOG.md

@@ -23,6 +23,8 @@
 
 All notable changes to this project will be documented in this file.
 
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
 If you like this project and find it useful, please consider giving it a star on [GitHub](https://github.com/Luligu/matterbridge-example-dynamic-platform) and sponsoring it.
 
 <a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="120"></a>
@@ -41,6 +43,7 @@ If you like this project and find it useful, please consider giving it a star on
 - [platform]: Add `closureGarageDoor` device. Thanks Ludovic BOUÉ.
 - [platform]: Add `closureVenetianBlind` device with Lift and Tilt panels. Thanks Ludovic BOUÉ.
 - [platform]: Add a thermostat auto mode with schedules (Weekdays and Weekend schedules) including 2 sub endpoints with temperature and humidity sensors, using `createDefaultSchedulesThermostatClusterServer()`. Thanks Ludovic BOUÉ.
+- [thermostat]: Add a thermostat auto mode with thermostat suggestions (Comfort and Eco presets with a pre-seeded suggestion) including 2 sub endpoints with temperature and humidity sensors, using `createDefaultThermostatSuggestionsClusterServer()`. Thanks Ludovic BOUÉ.
 
 ### Changed
 
@@ -48,8 +51,8 @@ If you like this project and find it useful, please consider giving it a star on
 - [package]: Update dependencies.
 - [package]: Bump `typescript` to v.7.0.2.
 - [package]: Bump `@types/node` to v.26.2.0.
-- [package]: Bump `oxfmt` to v.0.62.0.
-- [package]: Bump `oxlint` to v.1.77.0.
+- [package]: Bump `oxfmt` to v.0.63.0.
+- [package]: Bump `oxlint` to v.1.78.0.
 - [package]: Bump `oxlint-tsgolint` to v.7.0.2001.
 - [package]: Update agents configs.
 
@@ -939,34 +942,3 @@ If you like this project and find it useful, please consider giving it a star on
 - [package]: Updated dependencies.
 
 <a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="80"></a>
-
-<!-- Commented out section
-## [1.1.2] - 2024-03-08
-
-### Added
-
-- [Feature 1]: Description of the feature.
-- [Feature 2]: Description of the feature.
-
-### Changed
-
-- [Feature 3]: Description of the change.
-- [Feature 4]: Description of the change.
-
-### Deprecated
-
-- [Feature 5]: Description of the deprecation.
-
-### Removed
-
-- [Feature 6]: Description of the removal.
-
-### Fixed
-
-- [Bug 1]: Description of the bug fix.
-- [Bug 2]: Description of the bug fix.
-
-### Security
-
-- [Security 1]: Description of the security improvement.
--->

package/README.md

@@ -23,7 +23,7 @@
 
 Matterbridge dynamic platform example plugin is a template to develop your own plugin using the dynamic platform.
 
-It exposes 73 virtual devices:
+It exposes 74 virtual devices:
 
 - a door contact sensor
 - a motion sensor
@@ -54,6 +54,7 @@ It exposes 73 virtual devices:
 - a thermostat with auto mode (i.e. with Auto Heat and Cool features), occupancy and outdoorTemperature
 - a thermostat auto mode with presets (Home, Away, Sleep, Wake, Vacation and GoingToSleep modes) including 3 sub endpoints with flow, temperature and humidity sensors
 - a thermostat auto mode with schedules (Weekdays and Weekend schedules) including 2 sub endpoints with temperature and humidity sensors
+- a thermostat auto mode with thermostat suggestions (Comfort and Eco presets with a pre-seeded suggestion) including 2 sub endpoints with temperature and humidity sensors
 - a thermostat heat only with two external temperature sensors (tagged like Indoor and Outdoor)
 - a thermostat cool only
 - a fan with Off High presets
@@ -113,7 +114,11 @@ If you like this project and find it useful, please consider giving it a star on
 
 ### Matterbridge
 
-See the guidelines on [Matterbridge](https://github.com/Luligu/matterbridge/blob/main/README.md) for more information.
+See the guidelines on [Matterbridge](https://matterbridge.io/README.html) for more information.
+
+## Style guide
+
+See also the [Style Guide](./STYLEGUIDE.md) for JSDoc, naming, and logging conventions used in this repository.
 
 ## Repository toolchain
 
@@ -127,10 +132,6 @@ See the guidelines on [Matterbridge](https://github.com/Luligu/matterbridge/blob
 - **Much faster builds** — tsgo compiles the project in a fraction of the time required by the standard `tsc` build.
 - **Editor support** — use the VS Code extensions for tsgo and oxc to get the same experience in the editor.
 
-## Style guide
-
-See also the [Style Guide](./STYLEGUIDE.md) for JSDoc, naming, and logging conventions used in this repository.
-
 ## Copilot instructions
 
 | File                                                                   | Notes                                                                              |
@@ -163,8 +164,8 @@ See also the [Style Guide](./STYLEGUIDE.md) for JSDoc, naming, and logging conve
 | `.codex/config.toml`         | Codex project permissions, approvals, and profile |
 | `.codex/rules/default.rules` | Codex command allow, prompt, and deny rules       |
 
-## Documentation
+## Development guide
 
-Refer to the Matterbridge [documentation](https://matterbridge.io) for other guidelines.
+Refer to the Matterbridge [Development guide](https://matterbridge.io/README-DEV.html) for other guidelines.
 
 ---

package/dist/module.js

@@ -61,6 +61,7 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
     thermoAuto;
     thermoAutoOccupancy;
     thermoAutoPresets;
+    thermoAutoSuggestions;
     thermoAutoSchedules;
     thermoHeat;
     thermoCool;
@@ -1078,6 +1079,81 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         this.thermoAutoPresets?.subscribeAttribute(Thermostat.id, 'presets', (newValue, oldValue) => {
             this.thermoAutoPresets?.log.info(`Subscribe presets called with: ${debugStringify(newValue)} (old value: ${debugStringify(oldValue)})`);
         }, this.thermoAutoPresets.log);
+        const presets_ListSuggestions = [
+            {
+                presetHandle: new Uint8Array([0]),
+                presetScenario: Thermostat.PresetScenario.Occupied,
+                name: 'Comfort',
+                coolingSetpoint: 2400,
+                heatingSetpoint: 2100,
+                builtIn: true,
+            },
+            {
+                presetHandle: new Uint8Array([1]),
+                presetScenario: Thermostat.PresetScenario.Unoccupied,
+                name: 'Eco',
+                coolingSetpoint: 2700,
+                heatingSetpoint: 1800,
+                builtIn: true,
+            },
+        ];
+        const thermostatSuggestions_List = [
+            {
+                uniqueId: 0,
+                presetHandle: new Uint8Array([1]),
+                effectiveTime: Math.floor(Date.now() / 1000),
+                expirationTime: Math.floor(Date.now() / 1000) + 60 * 60,
+            },
+        ];
+        this.thermoAutoSuggestions = new MatterbridgeEndpoint([thermostat, bridgedNode, powerSource], { id: 'Thermostat (AutoModeSuggestions)' }, this.config.debug)
+            .createDefaultIdentifyClusterServer()
+            .createDefaultBridgedDeviceBasicInformationClusterServer('Thermostat (AutoModeSuggestions)', 'TSU00060', 0xfff1, 'Matterbridge', 'Matterbridge Thermostat With Suggestions')
+            .createDefaultThermostatSuggestionsClusterServer(20, 18, 22, 1, 0, 35, 15, 50, undefined, undefined, undefined, undefined, null, presets_ListSuggestions, undefined, thermostatSuggestions_List)
+            .createDefaultPowerSourceWiredClusterServer()
+            .addRequiredClusterServers();
+        if (this.thermoAutoSuggestions) {
+            this.thermoAutoSuggestions
+                .addChildDeviceType('Temperature', temperatureSensor)
+                .createDefaultTemperatureMeasurementClusterServer(21 * 100)
+                .addRequiredClusterServers();
+            this.thermoAutoSuggestions
+                .addChildDeviceType('Humidity', humiditySensor)
+                .createDefaultRelativeHumidityMeasurementClusterServer(50 * 100)
+                .addRequiredClusterServers();
+            this.thermoAutoSuggestions = await this.addDevice(this.thermoAutoSuggestions);
+        }
+        this.thermoAutoSuggestions?.addCommandHandler('identify', ({ request: { identifyTime } }) => {
+            this.thermoAutoSuggestions?.log.info(`Command identify called identifyTime ${identifyTime}`);
+        });
+        this.thermoAutoSuggestions?.addCommandHandler('triggerEffect', ({ request: { effectIdentifier, effectVariant } }) => {
+            this.thermoAutoSuggestions?.log.info(`Command identify called effectIdentifier ${effectIdentifier} effectVariant ${effectVariant}`);
+        });
+        this.thermoAutoSuggestions?.addCommandHandler('setpointRaiseLower', ({ request: { mode, amount } }) => {
+            const lookupSetpointAdjustMode = ['Heat', 'Cool', 'Both'];
+            this.thermoAutoSuggestions?.log.info(`Command setpointRaiseLower called with mode: ${lookupSetpointAdjustMode[mode]} amount: ${amount / 10}`);
+        });
+        this.thermoAutoSuggestions?.addCommandHandler('addThermostatSuggestion', ({ request: { presetHandle, effectiveTime, expirationInMinutes } }) => {
+            this.thermoAutoSuggestions?.log.info(`Command addThermostatSuggestion called with presetHandle: 0x${Buffer.from(presetHandle).toString('hex')} effectiveTime: ${effectiveTime ?? 'now'} expirationInMinutes: ${expirationInMinutes}`);
+        });
+        this.thermoAutoSuggestions?.addCommandHandler('removeThermostatSuggestion', ({ request: { uniqueId } }) => {
+            this.thermoAutoSuggestions?.log.info(`Command removeThermostatSuggestion called with uniqueId: ${uniqueId}`);
+        });
+        this.thermoAutoSuggestions?.subscribeAttribute(Thermostat, 'systemMode', (newValue, oldValue) => {
+            const lookupSystemMode = ['Off', 'Auto', '', 'Cool', 'Heat', 'EmergencyHeat', 'Precooling', 'FanOnly', 'Dry', 'Sleep'];
+            this.thermoAutoSuggestions?.log.info(`Subscribe systemMode called with: ${lookupSystemMode[newValue]} (old value: ${lookupSystemMode[oldValue]})`);
+        }, this.thermoAutoSuggestions.log);
+        this.thermoAutoSuggestions?.subscribeAttribute(Thermostat.id, 'occupiedHeatingSetpoint', (newValue, oldValue) => {
+            this.thermoAutoSuggestions?.log.info(`Subscribe occupiedHeatingSetpoint called with: ${newValue / 100} (old value: ${oldValue / 100})`);
+        }, this.thermoAutoSuggestions.log);
+        this.thermoAutoSuggestions?.subscribeAttribute(Thermostat.id, 'occupiedCoolingSetpoint', (newValue, oldValue) => {
+            this.thermoAutoSuggestions?.log.info(`Subscribe occupiedCoolingSetpoint called with: ${newValue / 100} (old value: ${oldValue / 100})`);
+        }, this.thermoAutoSuggestions.log);
+        this.thermoAutoSuggestions?.subscribeAttribute(Thermostat.id, 'thermostatSuggestions', (newValue, oldValue) => {
+            this.thermoAutoSuggestions?.log.info(`Subscribe thermostatSuggestions called with: ${debugStringify(newValue)} (old value: ${debugStringify(oldValue)})`);
+        }, this.thermoAutoSuggestions.log);
+        this.thermoAutoSuggestions?.subscribeAttribute(Thermostat.id, 'currentThermostatSuggestion', (newValue, oldValue) => {
+            this.thermoAutoSuggestions?.log.info(`Subscribe currentThermostatSuggestion called with: ${debugStringify(newValue)} (old value: ${debugStringify(oldValue)})`);
+        }, this.thermoAutoSuggestions.log);
         const schedules_List = [
             {
                 scheduleHandle: new Uint8Array([0]),

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge-example-dynamic-platform",
-  "version": "3.0.2-dev-20260809-1aeac01",
+  "version": "3.0.2-dev-20260812-5fa3c30",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge-example-dynamic-platform",
-      "version": "3.0.2-dev-20260809-1aeac01",
+      "version": "3.0.2-dev-20260812-5fa3c30",
       "license": "Apache-2.0",
       "dependencies": {
         "node-ansi-logger": "3.3.0",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge-example-dynamic-platform",
-  "version": "3.0.2-dev-20260809-1aeac01",
+  "version": "3.0.2-dev-20260812-5fa3c30",
   "description": "Matterbridge dynamic plugin",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",