matterbridge-zigbee2mqtt 3.0.3-dev-20251211-1802e6b → 3.0.3-dev-20251213-a1054ac

package/CHANGELOG.md

@@ -12,17 +12,19 @@ If you like this project and find it useful, please consider giving it a star on
 
 - [mqtt]: Added a guide to setup Unix socket on the host.
 - [mqtt]: Added a guide to setup Unix socket with docker.
+- [mqtt]: Added support for web socket connection: use ws://mqtthost.
+- [mqtt]: Added support for secure web socket connection: use wss://mqtthost.
 
 ### Changed
 
 - [package]: Updated dependencies.
 - [mqtt]: Clarified in the schema that the mqtt port is not used with Unix socket.
 - [mqtt]: Use mqtt+unix:///path for Unix socket.
-- [mqtt]: Removed options.protocol.
+- [mqtt]: Removed options.protocol. Thanks Rob van Oostenrijk (https://github.com/Luligu/matterbridge-zigbee2mqtt/issues/133).
 
 ### Fixed
 
-- [mqtt]: Fixed wrong log messages with Unix socket.
+- [mqtt]: Fixed wrong log messages with Unix socket. Thanks Rob van Oostenrijk (https://github.com/Luligu/matterbridge-zigbee2mqtt/issues/133).
 
 <a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/bmc-button.svg" alt="Buy me a coffee" width="80"></a>
 

package/README.md

@@ -21,6 +21,8 @@ No hub or dedicated hardware needed.
 
 No cloud: all is local and fast.
 
+The connection to the MQTT broker is possible with **mqtt** (tcp), **mqtts** (tls), **mqtt+unix** (Unix socket), **ws** (web socket) and **wss** (secure web socket). Self signed certificates and mutual tls are supported too.
+
 Interested in super fast and autonomous **[automations for zigbee2mqtt](https://github.com/Luligu/zigbee2mqtt-automations)**? Try this: https://github.com/Luligu/zigbee2mqtt-automations.
 
 If you like this project and find it useful, please consider giving it a star on [GitHub](https://github.com/Luligu/matterbridge-zigbee2mqtt) and sponsoring it.
@@ -75,19 +77,7 @@ matterbridge
 
 ## If you want to contribute to the plugin
 
-On windows:
-
-```
-cd $HOME\Matterbridge
-git clone https://github.com/Luligu/matterbridge-zigbee2mqtt
-cd matterbridge-zigbee2mqtt
-npm ci
-npm run dev:link
-npm run build
-matterbridge -add .
-```
-
-On linux and macOS:
+Clone the plugin
 
 ```
 cd ~/Matterbridge
@@ -284,6 +274,8 @@ If one of your devices is not supported out of the box, open an issue and we wil
 
 ## Unix socket (Linux only)
 
+**Note**: Unix domain sockets (mqtt+unix://) are always local and do not support TLS. Security is enforced through filesystem permissions on the socket file.
+
 ### Create the directory for the Unix socket on the host
 
 ```bash
@@ -296,11 +288,11 @@ sudo chown mosquitto:mosquitto /var/run/mosquitto
 # Allow group users (e.g. matterbridge) to access the socket
 sudo chmod 750 /var/run/mosquitto
 
-# Optional: Add your user to the mosquitto group to access the socket without sudo
-# sudo usermod -aG mosquitto $USER
+# Add your user to the mosquitto group to access the socket without sudo
+sudo usermod -aG mosquitto $USER
 
 # If matterbridge runs like user matterbridge, add the matterbridge user to the mosquitto group to access the socket without sudo
-# sudo usermod -aG mosquitto matterbridge
+sudo usermod -aG mosquitto matterbridge
 ```
 
 Log out and back in after running usermod -aG for the group changes to take effect.

package/dist/module.js

@@ -49,7 +49,13 @@ export class ZigbeePlatform extends MatterbridgeDynamicPlatform {
         if (config.host && typeof config.host === 'string') {
             this.mqttHost = config.host;
             this.mqttHost =
-                !this.mqttHost.startsWith('mqtt://') && !this.mqttHost.startsWith('mqtts://') && !this.mqttHost.startsWith('mqtt+unix://') ? 'mqtt://' + this.mqttHost : this.mqttHost;
+                !this.mqttHost.startsWith('mqtt://') &&
+                    !this.mqttHost.startsWith('mqtts://') &&
+                    !this.mqttHost.startsWith('ws://') &&
+                    !this.mqttHost.startsWith('wss://') &&
+                    !this.mqttHost.startsWith('mqtt+unix://')
+                    ? 'mqtt://' + this.mqttHost
+                    : this.mqttHost;
         }
         if (config.port)
             this.mqttPort = config.port;

package/dist/zigbee2mqtt.js

@@ -53,7 +53,7 @@ export class Zigbee2MQTT extends EventEmitter {
         if (mqttClientId)
             this.options.clientId = mqttClientId;
         this.options.protocolVersion = protocolVersion;
-        if (mqttHost.startsWith('mqtts://')) {
+        if (mqttHost.startsWith('mqtts://') || mqttHost.startsWith('wss://')) {
             this.log.debug('Using mqtts:// protocol for secure MQTT connection');
             if (!ca) {
                 this.log.info('When using mqtts:// protocol, you must provide the ca certificate for SSL/TLS connections with self-signed certificates.');
@@ -62,17 +62,19 @@ export class Zigbee2MQTT extends EventEmitter {
                 try {
                     fs.accessSync(ca, fs.constants.R_OK);
                     this.options.ca = fs.readFileSync(ca);
+                    this.log.info(`Successfully read the CA certificate from ${ca}`);
                 }
                 catch (error) {
                     this.log.error(`Error reading the CA certificate from ${ca}:`, error);
                 }
             }
             this.options.rejectUnauthorized = rejectUnauthorized !== undefined ? rejectUnauthorized : true;
-            this.options.protocol = 'mqtts';
+            this.log.info(`TLS rejectUnauthorized is set to ${this.options.rejectUnauthorized}`);
             if (cert && key) {
                 try {
                     fs.accessSync(cert, fs.constants.R_OK);
                     this.options.cert = fs.readFileSync(cert);
+                    this.log.info(`Successfully read the client certificate from ${cert}`);
                 }
                 catch (error) {
                     this.log.error(`Error reading the client certificate from ${cert}:`, error);
@@ -80,13 +82,14 @@ export class Zigbee2MQTT extends EventEmitter {
                 try {
                     fs.accessSync(key, fs.constants.R_OK);
                     this.options.key = fs.readFileSync(key);
+                    this.log.info(`Successfully read the client key from ${key}`);
                 }
                 catch (error) {
                     this.log.error(`Error reading the client key from ${key}:`, error);
                 }
             }
         }
-        else if (mqttHost.startsWith('mqtt://')) {
+        else if (mqttHost.startsWith('mqtt://') || mqttHost.startsWith('ws://')) {
             this.log.debug('Using mqtt:// protocol for non-secure MQTT connection');
             if (ca) {
                 this.log.warn('You are using mqtt:// protocol, but you provided a CA certificate. It will be ignored.');
@@ -111,7 +114,7 @@ export class Zigbee2MQTT extends EventEmitter {
             }
         }
         else {
-            this.log.warn('You are using an unsupported MQTT protocol. Please use mqtt:// or mqtts:// or mqtt+unix://.');
+            this.log.warn('You are using an unsupported MQTT protocol. Please use mqtt:// or mqtts:// or ws:// or wss:// or mqtt+unix://.');
         }
         this.z2mIsAvailabilityEnabled = false;
         this.z2mIsOnline = false;

package/matterbridge-zigbee2mqtt.schema.json

@@ -17,12 +17,12 @@
       "ui:widget": "hidden"
     },
     "host": {
-      "description": "MQTT server host (IP address or hostname with mqtt:// or mqtts:// prefix) or mqtt+unix://<SOCKET_PATH> for Unix socket on Linux (e.g. mqtt+unix:///var/run/mosquitto/mqtt.sock). For secure connections, use the mqtts:// prefix and ensure your certificates are configured. If you use a hostname, make sure that the hostname is resolvable by the system running matterbridge.",
+      "description": "MQTT server host (IP address or hostname with mqtt:// or mqtts:// or ws:// or wss:// prefix) or mqtt+unix://<SOCKET_PATH> for Unix socket on Linux (e.g. mqtt+unix:///var/run/mosquitto/mqtt.sock). For secure connections, use the mqtts:// or wss:// prefix and ensure your certificates are configured. If you use a hostname, make sure that the hostname is resolvable by the system running matterbridge.",
       "type": "string",
       "default": "mqtt://localhost"
     },
     "port": {
-      "description": "MQTT server port (i.e. 1883 for mqtt:// and 8883 for mqtts://). For Unix socket, this value is ignored.",
+      "description": "MQTT server port (i.e. 1883 for mqtt://, 8883 for mqtts://, 9001 for ws:// or 9443 for wss://). For Unix socket, this value is ignored.",
       "type": "number",
       "default": 1883
     },

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge-zigbee2mqtt",
-  "version": "3.0.3-dev-20251211-1802e6b",
+  "version": "3.0.3-dev-20251213-a1054ac",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge-zigbee2mqtt",
-      "version": "3.0.3-dev-20251211-1802e6b",
+      "version": "3.0.3-dev-20251213-a1054ac",
       "license": "Apache-2.0",
       "dependencies": {
         "moment": "2.30.1",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge-zigbee2mqtt",
-  "version": "3.0.3-dev-20251211-1802e6b",
+  "version": "3.0.3-dev-20251213-a1054ac",
   "description": "Matterbridge zigbee2mqtt plugin",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",