matterbridge-webhooks 1.1.0-edge.2 → 1.1.0-edge.3

package/CHANGELOG.md

@@ -6,7 +6,7 @@ If you like this project and find it useful, please consider giving it a star on
 
 <a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/bmc-button.svg" alt="Buy me a coffee" width="120"></a>
 
-## [1.0.3-edge] - Not released
+## [1.1.0-edge.3] - Not released
 
 ### Added Webhook devices
 

package/README.md

@@ -15,9 +15,9 @@
 
 ---
 
-# Webhooks
+This plugin allows you to expose single webhooks or complex webhook devices to Matter.
 
-This plugin allows you to expose any webhooks to Matter.
+# Simple webhooks
 
 Features:
 
@@ -28,13 +28,11 @@ Features:
 
 # Webhook devices
 
-It allows also to create a device based on webhooks.
-
 Features:
 
 - It is possible to choose the device type from the config.
 - It is possible to set the method with a prefix 'GET#' or 'POST# in the urls. Default if omitted is GET.
-- It is possible to use converters in the url.
+- It is possible to use converters and attributes in the url.
 
 ## Supported device types:
 
@@ -85,21 +83,9 @@ If you like this project and find it useful, please consider giving it a star on
 
 ### Matterbridge
 
-Follow these steps to install or update Matterbridge if it is not already installed and up to date:
-
-```
-npm install -g matterbridge --omit=dev
-```
-
-on Linux you may need the necessary permissions:
-
-```
-sudo npm install -g matterbridge --omit=dev
-```
-
-See the complete guidelines on [Matterbridge](https://github.com/Luligu/matterbridge/blob/main/README.md) for more information.
+See the complete guidelines on [Matterbridge](https://matterbridge.io/README.html) for more information.
 
-## How to add a webhook
+## How to add a simple webhook
 
 In the frontend open the plugin config: add a new webhook, enter the webhook name in the first field (replace newKey with the name you want to give to the webhook), select GET or POST and enter the webhook url. The webhook name will be the device name on the controller. The webhook will be exposed like a switch, like an outlet or like a light. When you turn it on, the webhook is called and in a few seconds the switch or the outlet or the light will revert to off.
 

package/dist/module.js

@@ -1,5 +1,6 @@
-import { bridgedNode, colorTemperatureLight, dimmableLight, extendedColorLight, MatterbridgeDynamicPlatform, MatterbridgeEndpoint, onOffLight, onOffOutlet, onOffSwitch, } from 'matterbridge';
+import { bridgedNode, colorTemperatureLight, dimmableLight, extendedColorLight, MatterbridgeColorControlServer, MatterbridgeDynamicPlatform, MatterbridgeEndpoint, MatterbridgeLevelControlServer, onOffLight, onOffOutlet, onOffSwitch, } from 'matterbridge';
 import { hslColorToRgbColor, isValidNumber, isValidObject, isValidString, miredToKelvin, wait } from 'matterbridge/utils';
+import { rs } from 'matterbridge/logger';
 import { fetch } from './fetch.js';
 export default function initializePlugin(matterbridge, log, config) {
     return new WebhooksPlatform(matterbridge, log, config);
@@ -32,7 +33,7 @@ export class WebhooksPlatform extends MatterbridgeDynamicPlatform {
                 .createOnOffClusterServer(false)
                 .addRequiredClusterServers()
                 .addCommandHandler('on', async () => {
-                this.log.info(`Webhook ${webhookName} triggered.`);
+                this.log.info(`Webhook ${webhookName} triggered`);
                 await device.setAttribute('onOff', 'onOff', false, device.log);
                 this.log.debug(`Fetching ${webhook.httpUrl} with ${webhook.method}...`);
                 fetch(webhook.httpUrl, webhook.method)
@@ -81,6 +82,8 @@ export class WebhooksPlatform extends MatterbridgeDynamicPlatform {
             const device = new MatterbridgeEndpoint([deviceType, bridgedNode], { id: lightName }, this.config.debug)
                 .createDefaultBridgedDeviceBasicInformationClusterServer(lightName, 'light' + i++, this.matterbridge.aggregatorVendorId, 'Matterbridge', 'Matterbridge Webhook Light', 0, this.config.version)
                 .createOnOffClusterServer(false)
+                .createDefaultColorControlClusterServer(undefined, undefined, undefined, undefined, 250, webhook.minMireds, webhook.maxMireds)
+                .createDefaultLevelControlClusterServer()
                 .addRequiredClusterServers()
                 .addCommandHandler('on', async (data) => {
                 this.parseUrl('light', lightName, 'on', webhook.onUrl, data);
@@ -175,7 +178,9 @@ export class WebhooksPlatform extends MatterbridgeDynamicPlatform {
             await this.unregisterAllDevices();
     }
     async parseUrl(deviceType, deviceName, command, url, data) {
-        this.log.info(`Webhook ${deviceType} ${deviceName} ${command} triggered.`);
+        this.log.info(`Webhook ${deviceType} ${deviceName} ${command} triggered`);
+        const endpoint = data.endpoint;
+        this.log.debug(`Webhook ${deviceType} ${deviceName} ${command} triggered on endpoint ${endpoint?.deviceName}`);
         let method = 'GET';
         let parsedUrl = url;
         if (url.startsWith('GET#')) {
@@ -212,50 +217,66 @@ export class WebhooksPlatform extends MatterbridgeDynamicPlatform {
         }
         if ((parsedUrl.includes('${level}') || parsedUrl.includes('${level100}')) && isValidNumber(data.attributes.currentLevel, 1, 254)) {
             await wait(100);
-            if (url.includes('${level}'))
-                parsedUrl = parsedUrl.replace('${level}', data.attributes.currentLevel.toString());
-            if (url.includes('${level100}'))
-                parsedUrl = parsedUrl.replace('${level100}', Math.round((data.attributes.currentLevel / 254) * 100).toString());
+            data.attributes = endpoint.stateOf(MatterbridgeLevelControlServer);
+            if (isValidNumber(data.attributes.currentLevel, 1, 254)) {
+                if (url.includes('${level}'))
+                    parsedUrl = parsedUrl.replace('${level}', data.attributes.currentLevel.toString());
+                if (url.includes('${level100}'))
+                    parsedUrl = parsedUrl.replace('${level100}', Math.round((data.attributes.currentLevel / 254) * 100).toString());
+            }
         }
         if ((parsedUrl.includes('${mired}') || parsedUrl.includes('${kelvin}')) &&
             isValidNumber(data.attributes.colorTemperatureMireds, data.attributes.colorTempPhysicalMinMireds, data.attributes.colorTempPhysicalMaxMireds)) {
             await wait(100);
-            const kelvin = miredToKelvin(data.attributes.colorTemperatureMireds);
-            this.log.debug(`Attribute colorTemperatureMireds is ${data.attributes.colorTemperatureMireds}, which is ${kelvin}K`);
-            if (url.includes('${mired}'))
-                parsedUrl = parsedUrl.replace('${mired}', data.attributes.colorTemperatureMireds.toString());
-            if (url.includes('${kelvin}'))
-                parsedUrl = parsedUrl.replace('${kelvin}', kelvin.toString());
+            data.attributes = endpoint.stateOf(MatterbridgeColorControlServer);
+            if (isValidNumber(data.attributes.colorTemperatureMireds)) {
+                const kelvin = miredToKelvin(data.attributes.colorTemperatureMireds);
+                this.log.debug(`Attribute colorTemperatureMireds is ${data.attributes.colorTemperatureMireds}, which is ${kelvin}K`);
+                if (url.includes('${mired}'))
+                    parsedUrl = parsedUrl.replace('${mired}', data.attributes.colorTemperatureMireds.toString());
+                if (url.includes('${kelvin}'))
+                    parsedUrl = parsedUrl.replace('${kelvin}', kelvin.toString());
+            }
         }
         if ((parsedUrl.includes('${hue}') || parsedUrl.includes('${saturation}') || parsedUrl.includes('${red}') || parsedUrl.includes('${green}') || parsedUrl.includes('${blue}')) &&
             isValidNumber(data.attributes.currentHue, 0, 254) &&
             isValidNumber(data.attributes.currentSaturation, 0, 254)) {
             await wait(100);
-            const rgb = hslColorToRgbColor((data.attributes.currentHue * 360) / 254, (data.attributes.currentSaturation * 100) / 254, 50);
-            this.log.debug(`Converted hue ${data.attributes.currentHue} and saturation ${data.attributes.currentSaturation} to RGB r: ${rgb.r} g: ${rgb.g} b: ${rgb.b}`);
-            if (url.includes('${hue}'))
-                parsedUrl = parsedUrl.replace('${hue}', Math.round((data.attributes.currentHue * 360) / 254).toString());
-            if (url.includes('${saturation}'))
-                parsedUrl = parsedUrl.replace('${saturation}', Math.round((data.attributes.currentSaturation * 100) / 254).toString());
-            if (url.includes('${red}') && rgb)
-                parsedUrl = parsedUrl.replace('${red}', rgb.r.toString());
-            if (url.includes('${green}') && rgb)
-                parsedUrl = parsedUrl.replace('${green}', rgb.g.toString());
-            if (url.includes('${blue}') && rgb)
-                parsedUrl = parsedUrl.replace('${blue}', rgb.b.toString());
+            data.attributes = endpoint.stateOf(MatterbridgeColorControlServer);
+            if (isValidNumber(data.attributes.currentHue, 0, 254) && isValidNumber(data.attributes.currentSaturation, 0, 254)) {
+                const rgb = hslColorToRgbColor((data.attributes.currentHue * 360) / 254, (data.attributes.currentSaturation * 100) / 254, 50);
+                this.log.debug(`Converted hue ${data.attributes.currentHue} and saturation ${data.attributes.currentSaturation} to RGB r: ${rgb.r} g: ${rgb.g} b: ${rgb.b}`);
+                if (url.includes('${hue}'))
+                    parsedUrl = parsedUrl.replace('${hue}', Math.round((data.attributes.currentHue * 360) / 254).toString());
+                if (url.includes('${saturation}'))
+                    parsedUrl = parsedUrl.replace('${saturation}', Math.round((data.attributes.currentSaturation * 100) / 254).toString());
+                if (url.includes('${red}') && rgb)
+                    parsedUrl = parsedUrl.replace('${red}', rgb.r.toString());
+                if (url.includes('${green}') && rgb)
+                    parsedUrl = parsedUrl.replace('${green}', rgb.g.toString());
+                if (url.includes('${blue}') && rgb)
+                    parsedUrl = parsedUrl.replace('${blue}', rgb.b.toString());
+            }
         }
         if ((parsedUrl.includes('${colorX}') || parsedUrl.includes('${colorY}')) &&
             isValidNumber(data.attributes.currentX, 0, 65279) &&
             isValidNumber(data.attributes.currentY, 0, 65279)) {
             await wait(100);
-            if (url.includes('${colorX}'))
-                parsedUrl = parsedUrl.replace('${colorX}', this.roundTo(data.attributes.currentX / 65536, 4).toString());
-            if (url.includes('${colorY}'))
-                parsedUrl = parsedUrl.replace('${colorY}', this.roundTo(data.attributes.currentY / 65536, 4).toString());
+            data.attributes = endpoint.stateOf(MatterbridgeColorControlServer);
+            if (isValidNumber(data.attributes.currentX, 0, 65279) && isValidNumber(data.attributes.currentY, 0, 65279)) {
+                if (url.includes('${colorX}'))
+                    parsedUrl = parsedUrl.replace('${colorX}', this.roundTo(data.attributes.currentX / 65536, 4).toString());
+                if (url.includes('${colorY}'))
+                    parsedUrl = parsedUrl.replace('${colorY}', this.roundTo(data.attributes.currentY / 65536, 4).toString());
+            }
         }
         this.log.debug(`Fetching ${parsedUrl} with ${method}...`);
         fetch(parsedUrl, method)
-            .then(() => this.log.notice(`Webhook ${deviceType} ${deviceName} ${command} successful!`))
+            .then((response) => {
+            this.log.notice(`Webhook ${deviceType} ${deviceName} ${command} successful!`);
+            this.log.debug(`Webhook ${deviceType} ${deviceName} ${command} response:${rs}\n`, response);
+            return;
+        })
             .catch((err) => {
             this.log.error(`Webhook ${deviceType} ${deviceName} ${command} failed: ${err instanceof Error ? err.message : err}`);
         });

package/matterbridge-webhooks.schema.json

@@ -106,6 +106,18 @@
         "description": "Light parameters:",
         "required": ["onUrl", "offUrl"],
         "properties": {
+          "minMireds": {
+            "type": "integer",
+            "title": "Minimum Mireds",
+            "default": 154,
+            "description": "Minimum color temperature in Mireds (Kelvin = 1000000 / Mireds). Default is 154 (6500K)."
+          },
+          "maxMireds": {
+            "type": "integer",
+            "title": "Maximum Mireds",
+            "default": 500,
+            "description": "Maximum color temperature in Mireds (Kelvin = 1000000 / Mireds). Default is 500 (2000K)."
+          },
           "onUrl": {
             "type": "string",
             "title": "Light On URL",

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge-webhooks",
-  "version": "1.1.0-edge.2",
+  "version": "1.1.0-edge.3",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge-webhooks",
-      "version": "1.1.0-edge.2",
+      "version": "1.1.0-edge.3",
       "license": "Apache-2.0",
       "dependencies": {
         "node-ansi-logger": "3.1.1",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge-webhooks",
-  "version": "1.1.0-edge.2",
+  "version": "1.1.0-edge.3",
   "description": "Matterbridge webhooks plugin",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",