matterbridge-example-dynamic-platform 1.0.18 → 1.0.19

package/CHANGELOG.md

@@ -2,7 +2,24 @@
 
 All notable changes to this project will be documented in this file.
 
-If you like this project and find it useful, please consider giving it a star on GitHub at https://github.com/Luligu/matterbridge-shelly and sponsoring it.
+If you like this project and find it useful, please consider giving it a star on GitHub at https://github.com/Luligu/matterbridge-example-dynamic-platform and sponsoring it.
+
+## [1.0.19] - 2024-09-04
+
+### Added
+
+- [plugin] Added:
+- a light with onOff
+- a light with onOff, levelControl
+- an air quality device
+
+### Changed
+
+- [package]: Updated dependencies.
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="./yellow-button.png" alt="Buy me a coffee" width="120">
+</a>
 
 ## [1.0.18] - 2024-09-03
 

package/README.md

@@ -18,15 +18,17 @@ Matterbridge dynamic platform example plugin is a template to develop your own p
 It exposes:
 
 - a switch with onOff cluster
+- a light with onOff
+- a light with onOff and levelControl (dimmer)
 - a light with onOff, levelControl and colorControl (with XY, HS and CT) clusters
 - a light with onOff, levelControl and colorControl (with HS only) clusters
 - a light with onOff, levelControl and colorControl (with XY only) clusters
 - a light with onOff, levelControl and colorControl (with CT only) clusters
-- an outlet with onOff cluster
+- an outlet (plug) with onOff cluster
 - a cover with windowCovering cluster
 - a lock with doorLock cluster
 - a thermo with thermostat cluster and 3 sub endpoints with flowMeasurement cluster, temperatureMeasurement cluster
-  and relativeHumidityMeasurement cluster (to show how to create a composed device with sub enpoints)
+  and relativeHumidityMeasurement cluster (to show how to create a composed device with sub endpoints)
 - a fan with FanControl cluster
 - a rainSensor device
 - a waterFreezeDetector device

package/create-release.js

@@ -0,0 +1,81 @@
+/* eslint-disable no-console */
+
+/*
+Add the following scripts to package.json file:
+    "prepublishOnly": "npm run lint && npm run test && npm run cleanBuild",
+    "npmPublish": "npm publish",
+    "gitPublish": "npm run lint && npm run test && npm run cleanBuild && node create-release.js",
+    "preversion": "npm run lint && npm run test && npm run cleanBuild",
+    "postversion": "git push && git push --tags && node create-release.js",
+    "version:patch": "npm version patch",
+    "version:minor": "npm version minor",
+    "version:major": "npm version major",
+*/
+
+import { execSync } from 'child_process';
+import { readFileSync, writeFileSync, unlinkSync } from 'fs';
+import path from 'path';
+import readline from 'readline';
+
+// Get the latest tag
+let tag = execSync('git describe --tags --abbrev=0').toString().trim();
+if (tag.startsWith('v')) {
+  tag = tag.substring(1);
+}
+
+// Read the changelog file
+const changelogPath = path.join(process.cwd(), 'CHANGELOG.md');
+const changelog = readFileSync(changelogPath, 'utf8');
+
+// Extract the relevant section from the changelog
+const changelogSection = extractChangelogSection(changelog, tag);
+
+const title = `Release ${tag}`;
+const notes = `Release notes for version ${tag}\n\n## [${tag}] ${changelogSection}`;
+
+// Log the release details
+console.log(`Creating release ${tag} with the following details:\nTitle:\n${title}\nNotes:\n${notes}`);
+
+// Write the release notes to a temporary file
+const notesFilePath = path.join(process.cwd(), 'release-notes.md');
+writeFileSync(notesFilePath, notes);
+
+// Wait for user input before proceeding
+await pressAnyKey();
+
+// Create the release using the temporary file
+execSync(`gh release create ${tag} -t "${title}" -F "${notesFilePath}"`, { stdio: 'inherit' });
+
+// Clean up the temporary file
+unlinkSync(notesFilePath);
+
+/**
+ * Extracts the relevant section from the changelog for the given tag.
+ * Assumes that each version section in the changelog starts with a heading like "## [tag]".
+ * @param {string} changelog - The content of the changelog file.
+ * @param {string} tag - The tag for which to extract the changelog section.
+ * @returns {string} - The extracted changelog section.
+ */
+function extractChangelogSection(changelog, tag) {
+  const regex = new RegExp(`## \\[${tag}\\](.*?)(## \\[|$)`, 's');
+  const match = changelog.match(regex);
+  return match ? match[1].trim() : 'No changelog entry found for this version.';
+}
+
+/**
+ * Waits for the user to press any key.
+ * @returns {Promise<void>}
+ */
+function pressAnyKey() {
+  return new Promise((resolve) => {
+    const rl = readline.createInterface({
+      input: process.stdin,
+      output: process.stdout,
+    });
+
+    rl.question('Press any key to continue...', () => {
+      rl.close();
+      resolve();
+    });
+  });
+}

package/dist/platform.d.ts

@@ -3,6 +3,8 @@ import { Matterbridge, MatterbridgeDevice, MatterbridgeDynamicPlatform } from 'm
 import { AnsiLogger } from 'matterbridge/logger';
 export declare class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatform {
     switch: MatterbridgeDevice | undefined;
+    lightOnOff: MatterbridgeDevice | undefined;
+    dimmer: MatterbridgeDevice | undefined;
     light: MatterbridgeDevice | undefined;
     lightXY: MatterbridgeDevice | undefined;
     lightHS: MatterbridgeDevice | undefined;
@@ -16,6 +18,7 @@ export declare class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDyna
     waterFreeze: MatterbridgeDevice | undefined;
     rain: MatterbridgeDevice | undefined;
     smoke: MatterbridgeDevice | undefined;
+    airQuality: MatterbridgeDevice | undefined;
     switchInterval: NodeJS.Timeout | undefined;
     lightInterval: NodeJS.Timeout | undefined;
     outletInterval: NodeJS.Timeout | undefined;
@@ -27,6 +30,7 @@ export declare class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDyna
     waterFreezeInterval: NodeJS.Timeout | undefined;
     rainInterval: NodeJS.Timeout | undefined;
     smokeInterval: NodeJS.Timeout | undefined;
+    airQualityInterval: NodeJS.Timeout | undefined;
     constructor(matterbridge: Matterbridge, log: AnsiLogger, config: PlatformConfig);
     onStart(reason?: string): Promise<void>;
     onConfigure(): Promise<void>;

package/dist/platform.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"platform.d.ts","sourceRoot":"","sources":["../src/platform.ts"],"names":[],"mappings":"AAAA,OAAO,EAgBL,cAAc,EAgBf,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,2BAA2B,EAAE,MAAM,cAAc,CAAC;AAE7F,OAAO,EAAE,UAAU,EAAc,MAAM,qBAAqB,CAAC;AAE7D,qBAAa,kCAAmC,SAAQ,2BAA2B;IACjF,MAAM,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACvC,KAAK,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACtC,OAAO,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACxC,OAAO,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACxC,OAAO,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACxC,MAAM,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACvC,KAAK,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACtC,IAAI,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACrC,MAAM,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACvC,GAAG,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACpC,SAAS,EAAE,kBAAkB,GAAG,SAAS,CAAC;IAC1C,WAAW,EAAE,kBAAkB,GAAG,SAAS,CAAC;IAC5C,IAAI,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACrC,KAAK,EAAE,kBAAkB,GAAG,SAAS,CAAC;IAEtC,cAAc,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;IAC3C,aAAa,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;IAC1C,cAAc,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;IAC3C,aAAa,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;IAC1C,YAAY,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;IACzC,cAAc,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;IAC3C,WAAW,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;IACxC,iBAAiB,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;IAC9C,mBAAmB,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;IAChD,YAAY,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;IACzC,aAAa,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;gBAE9B,YAAY,EAAE,YAAY,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,EAAE,cAAc;IAKhE,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM;IAodvB,WAAW;IA4OX,UAAU,CAAC,MAAM,CAAC,EAAE,MAAM;CAe1C"}
+{"version":3,"file":"platform.d.ts","sourceRoot":"","sources":["../src/platform.ts"],"names":[],"mappings":"AAAA,OAAO,EAsBL,cAAc,EAsBf,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,2BAA2B,EAAE,MAAM,cAAc,CAAC;AAE7F,OAAO,EAAE,UAAU,EAAkB,MAAM,qBAAqB,CAAC;AAEjE,qBAAa,kCAAmC,SAAQ,2BAA2B;IACjF,MAAM,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACvC,UAAU,EAAE,kBAAkB,GAAG,SAAS,CAAC;IAC3C,MAAM,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACvC,KAAK,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACtC,OAAO,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACxC,OAAO,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACxC,OAAO,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACxC,MAAM,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACvC,KAAK,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACtC,IAAI,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACrC,MAAM,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACvC,GAAG,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACpC,SAAS,EAAE,kBAAkB,GAAG,SAAS,CAAC;IAC1C,WAAW,EAAE,kBAAkB,GAAG,SAAS,CAAC;IAC5C,IAAI,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACrC,KAAK,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACtC,UAAU,EAAE,kBAAkB,GAAG,SAAS,CAAC;IAE3C,cAAc,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;IAC3C,aAAa,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;IAC1C,cAAc,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;IAC3C,aAAa,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;IAC1C,YAAY,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;IACzC,cAAc,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;IAC3C,WAAW,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;IACxC,iBAAiB,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;IAC9C,mBAAmB,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;IAChD,YAAY,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;IACzC,aAAa,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;IAC1C,kBAAkB,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;gBAEnC,YAAY,EAAE,YAAY,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,EAAE,cAAc;IAKhE,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM;IAskBvB,WAAW;IA0QX,UAAU,CAAC,MAAM,CAAC,EAAE,MAAM;CAgB1C"}