homebridge-tesy-heater-mqtt 1.0.2 → 1.0.4

package/CHANGELOG.md

@@ -7,6 +7,44 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.3] - 2025-12-15
+
+### Fixed
+- **Fixed Config Schema validation** (Homebridge verification requirement)
+  - Removed invalid `required: true` from individual properties
+  - Added proper `required` array at schema object level: `["name", "userid", "username", "password"]`
+  - Config schema now passes Homebridge plugin verification checks
+
+### Added
+- **MQTT real-time status updates** (Performance improvement)
+  - Added message handler for incoming MQTT `setTempStatistic` messages
+  - Devices send status updates every ~10 seconds automatically
+  - Temperatures (current and target) now update within 1 second of device changes
+  - Heating state updates triggered on MQTT messages (with API fetch for full status)
+  - Significantly faster than polling-only approach (10s vs 60s)
+  - Debug logging with [MQTT] prefix to distinguish from polling updates
+  - Polling still active as fallback for reliability
+
+### Security
+- **Removed deprecated `request` dependency** (Critical security fix)
+  - Eliminated 2 critical vulnerabilities (form-data unsafe random, tough-cookie prototype pollution)
+  - Replaced with Node.js built-in `https` module
+  - Reduces package size by removing 3 vulnerable transitive dependencies
+  - No functionality changes - API calls work identically
+  - All 38 unit tests pass with new implementation
+
+### Changed
+- Implemented `_httpsGet()` helper method for API requests
+- Updated `discoverDevices()` and `fetchDeviceStatus()` to use native HTTPS
+- **Enhanced Accessory Information display**
+  - Serial Number now shows Device ID and MAC address (e.g., "216884 (1C:9D:C2:36:9D:84)")
+  - Firmware Revision now displays actual device firmware version (e.g., "4.79")
+  - Improves device identification in Homebridge UI and HomeKit
+- **Improved test coverage**
+  - Added 11 unit tests for MQTT message handler
+  - Test coverage increased from 49% to 64% (+15%)
+  - 49 tests total, all passing
+
 ## [1.0.2] - 2025-12-15
 
 ### Fixed
@@ -119,7 +157,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Tested Devices
 - Tesy CN 06 100 EА CLOUD AS W
 
-[Unreleased]: https://github.com/svjakrm/homebridge-tesy-heater-mqtt/compare/v1.0.1...HEAD
+[Unreleased]: https://github.com/svjakrm/homebridge-tesy-heater-mqtt/compare/v1.0.3...HEAD
+[1.0.3]: https://github.com/svjakrm/homebridge-tesy-heater-mqtt/compare/v1.0.2...v1.0.3
+[1.0.2]: https://github.com/svjakrm/homebridge-tesy-heater-mqtt/compare/v1.0.1...v1.0.2
 [1.0.1]: https://github.com/svjakrm/homebridge-tesy-heater-mqtt/compare/v1.0.0...v1.0.1
 [1.0.0]: https://github.com/svjakrm/homebridge-tesy-heater-mqtt/compare/v0.0.1...v1.0.0
 [0.0.1]: https://github.com/svjakrm/homebridge-tesy-heater-mqtt/releases/tag/v0.0.1

package/README.md

@@ -107,28 +107,26 @@ Add this platform to your Homebridge `config.json`:
 - `username` is your email used to log in to Tesy Cloud
 - `password` is your Tesy Cloud password
 
-**To find your User ID**, run this command:
-```bash
-curl -s 'https://ad.mytesy.com/rest/get-my-devices?userEmail=YOUR_EMAIL&userPass=YOUR_PASSWORD&lang=en' | python3 -m json.tool
+**To find your User ID**:
+
+1. Log in to [Tesy Cloud](https://v4.mytesy.com) in your browser
+2. Open Developer Tools:
+   - **Chrome/Edge**: Press `F12` or right-click → **Inspect**
+   - **Firefox**: Press `F12` or right-click → **Inspect Element**
+   - **Safari**: First enable developer menu in **Safari → Settings → Advanced** → check "Show features for web developers", then press `Cmd+Option+I`
+3. Go to the **Network** tab
+4. Refresh the page (`Cmd+R` or `F5`)
+5. Find a request named `get-my-devices` or `get-my-messages` in the list
+6. Click on it and look for the **Payload**, **Headers**, or **Request** tab
+7. Find the `userID` parameter - this is your User ID
+
+Example:
 ```
-
-The response will show your `userid` and all your devices. Example:
-```json
-{
-  "AA:BB:CC:DD:EE:FF": {
-    "deviceName": "Living Room Heater",
-    "token": "abc1234",
-    "state": {
-      "id": 123456,
-      "mac": "AA:BB:CC:DD:EE:FF",
-      "status": "on",
-      "temp": 20,
-      ...
-    }
-  }
-}
+GET https://ad.mytesy.com/rest/get-my-devices?userID=11111&userEmail=...
 ```
 
+Your `userID` in this example is `11111`.
+
 **That's it!** The plugin will automatically discover all devices in your account.
 
 ## Technical Details

package/config.schema.json

@@ -8,26 +8,22 @@
       "name": {
         "title": "Platform Name",
         "type": "string",
-        "default": "TesyHeater",
-        "required": true
+        "default": "TesyHeater"
       },
       "userid": {
         "title": "Tesy Cloud User ID",
         "type": "string",
-        "required": true,
         "description": "Your Tesy Cloud account user ID (numeric)"
       },
       "username": {
         "title": "Tesy Cloud Email",
         "type": "string",
-        "required": true,
         "format": "email",
         "description": "Your Tesy Cloud account email address"
       },
       "password": {
         "title": "Tesy Cloud Password",
         "type": "string",
-        "required": true,
         "description": "Your Tesy Cloud account password"
       },
       "maxTemp": {
@@ -54,7 +50,8 @@
         "maximum": 300000,
         "description": "How often to poll device status (in milliseconds). Default: 60000 (1 minute)"
       }
-    }
+    },
+    "required": ["name", "userid", "username", "password"]
   },
   "layout": [
     {
@@ -107,7 +104,7 @@
     },
     {
       "type": "help",
-      "helpvalue": "<p><strong>How to find your User ID:</strong></p><ol><li>Log in to <a href='https://v4.mytesy.com' target='_blank'>Tesy Cloud</a></li><li>Check the browser URL or use the API to retrieve your user ID</li><li>Or run: <code>curl 'https://ad.mytesy.com/rest/get-my-devices?userEmail=YOUR_EMAIL&userPass=YOUR_PASSWORD&lang=en'</code></li></ol>"
+      "helpvalue": "<p><strong>How to find your User ID:</strong></p><ol><li>Log in to <a href='https://v4.mytesy.com' target='_blank'>Tesy Cloud</a> in your browser</li><li>Open Developer Tools (<kbd>F12</kbd> or right-click → Inspect)</li><li>Go to the <strong>Network</strong> tab and refresh the page</li><li>Find request named <code>get-my-devices</code> or <code>get-my-messages</code></li><li>Click on it and look for <code>userID</code> parameter in the request URL or Payload tab</li><li>Example: <code>userID=27356</code> - your User ID is <strong>27356</strong></li></ol>"
     }
   ]
 }

package/index.js

@@ -1,6 +1,6 @@
 var Service, Characteristic, API;
 const mqtt = require('mqtt');
-const request = require('request');
+const https = require('https');
 const querystring = require('querystring');
 
 module.exports = function(homebridge) {
@@ -20,6 +20,7 @@ class TesyHeaterPlatform {
     this.accessories = [];
     this.devices = {};
     this.mqttClient = null;
+    this.mqttReconnecting = false;
 
     // Configuration
     this.userid = this.config.userid;
@@ -61,19 +62,16 @@ class TesyHeaterPlatform {
       'lang': 'en'
     });
 
-    const options = {
-      'method': 'GET',
-      'url': 'https://ad.mytesy.com/rest/get-my-devices?' + queryParams
-    };
+    const url = 'https://ad.mytesy.com/rest/get-my-devices?' + queryParams;
 
-    request(options, (error, response) => {
+    this._httpsGet(url, (error, body) => {
       if (error) {
         this.log.error("API Error:", error);
         return;
       }
 
       try {
-        const data = JSON.parse(response.body);
+        const data = JSON.parse(body);
 
         if (!data || Object.keys(data).length === 0) {
           this.log.warn("No devices found in your Tesy Cloud account");
@@ -115,6 +113,7 @@ class TesyHeaterPlatform {
             mac: mac,
             token: deviceData.token,
             model: deviceData.model || 'cn05uv',
+            firmware_version: deviceData.firmware_version,
             name: deviceName,
             state: state
           });
@@ -225,7 +224,8 @@ class TesyHeaterPlatform {
     informationService
       .setCharacteristic(Characteristic.Manufacturer, 'Tesy')
       .setCharacteristic(Characteristic.Model, deviceInfo.model || 'Convector')
-      .setCharacteristic(Characteristic.SerialNumber, deviceInfo.id);
+      .setCharacteristic(Characteristic.SerialNumber, `${deviceInfo.id} (${deviceInfo.mac})`)
+      .setCharacteristic(Characteristic.FirmwareRevision, deviceInfo.firmware_version || '0.0.0');
 
     // HeaterCooler Service
     let service = accessory.getService(Service.HeaterCooler);
@@ -285,10 +285,14 @@ class TesyHeaterPlatform {
       clientId: 'mqttjs_' + Math.random().toString(16).substr(2, 8),
       protocol: 'wss',
       reconnectPeriod: 5000,
+      keepalive: 60,
+      clean: true,
+      connectTimeout: 30 * 1000,
     });
 
     this.mqttClient.on('connect', () => {
       this.log.info("✓ Connected to MQTT broker");
+      this.mqttReconnecting = false;
 
       // Subscribe to all device response topics
       Object.values(this.devices).forEach(device => {
@@ -304,16 +308,109 @@ class TesyHeaterPlatform {
       });
     });
 
+    this.mqttClient.on('reconnect', () => {
+      if (!this.mqttReconnecting) {
+        this.log.info("Reconnecting to MQTT broker...");
+        this.mqttReconnecting = true;
+      }
+    });
+
     this.mqttClient.on('error', (error) => {
-      this.log.error("MQTT Error:", error);
+      // Keepalive timeout is expected and will trigger reconnect automatically
+      if (error.message && error.message.includes('Keepalive timeout')) {
+        this.log.warn("MQTT keepalive timeout - reconnecting...");
+      } else {
+        this.log.error("MQTT Error:", error.message || error);
+      }
     });
 
     this.mqttClient.on('close', () => {
-      this.log.warn("MQTT connection closed");
+      this.log.debug("MQTT connection closed");
     });
 
     this.mqttClient.on('offline', () => {
-      this.log.warn("MQTT client offline");
+      this.log.warn("MQTT client offline - will retry connection");
+    });
+
+    this.mqttClient.on('end', () => {
+      this.log.debug("MQTT client ended");
+    });
+
+    // Handle incoming MQTT messages for real-time status updates
+    this.mqttClient.on('message', (topic, message) => {
+      try {
+        // Parse topic: v1/{MAC}/response/{MODEL}/{TOKEN}/{COMMAND}
+        const topicParts = topic.split('/');
+        if (topicParts.length < 6) return;
+
+        const mac = topicParts[1];
+        const command = topicParts[5];
+
+        // Only process setTempStatistic messages (periodic status updates from device)
+        if (command !== 'setTempStatistic') return;
+
+        const data = JSON.parse(message.toString());
+        if (!data.payload) return;
+
+        const payload = data.payload;
+
+        // Find device by MAC address
+        const device = Object.values(this.devices).find(d => d.info.mac === mac);
+        if (!device) return;
+
+        // Update temperatures immediately from MQTT
+        // Note: setTempStatistic messages don't include 'status' (on/off) field,
+        // so we'll fetch full status separately when heating state changes
+        const service = device.accessory.getService(Service.HeaterCooler);
+        if (!service) return;
+
+        // Update current temperature
+        if (payload.currentTemp !== undefined) {
+          const currentTemp = parseFloat(payload.currentTemp);
+          if (!isNaN(currentTemp)) {
+            const oldTemp = service.getCharacteristic(Characteristic.CurrentTemperature).value;
+            if (currentTemp !== oldTemp) {
+              service.getCharacteristic(Characteristic.CurrentTemperature).updateValue(currentTemp);
+              this.log.debug("%s: [MQTT] CurrentTemperature %s -> %s",
+                device.info.name, oldTemp, currentTemp);
+            }
+          }
+        }
+
+        // Update target temperature
+        if (payload.target !== undefined && payload.target > 0) {
+          const targetTemp = parseFloat(payload.target);
+          if (!isNaN(targetTemp) && targetTemp >= this.minTemp && targetTemp <= this.maxTemp) {
+            const oldTarget = service.getCharacteristic(Characteristic.HeatingThresholdTemperature).value;
+            if (targetTemp !== oldTarget) {
+              service.getCharacteristic(Characteristic.HeatingThresholdTemperature).updateValue(targetTemp);
+              this.log.debug("%s: [MQTT] HeatingThresholdTemperature %s -> %s",
+                device.info.name, oldTarget, targetTemp);
+            }
+          }
+        }
+
+        // For heating state, we need full status including 'status' (on/off)
+        // MQTT setTempStatistic doesn't include 'status' field
+        // So we'll trigger a fetch if heating field changed
+        if (payload.heating !== undefined) {
+          // Fetch full status to update heating state correctly
+          this.fetchDeviceStatus(device.info, (error, fullStatus) => {
+            if (error) return;
+
+            const heatingState = this._calculateHeatingState(fullStatus);
+            const oldState = service.getCharacteristic(Characteristic.CurrentHeaterCoolerState).value;
+
+            if (heatingState !== oldState) {
+              service.getCharacteristic(Characteristic.CurrentHeaterCoolerState).updateValue(heatingState);
+              this.log.debug("%s: [MQTT] Heating state %s -> %s",
+                device.info.name, oldState, heatingState);
+            }
+          });
+        }
+      } catch (error) {
+        this.log.debug("Error processing MQTT message:", error.message);
+      }
     });
   }
 
@@ -349,18 +446,15 @@ class TesyHeaterPlatform {
       'lang': 'en'
     });
 
-    const options = {
-      'method': 'GET',
-      'url': 'https://ad.mytesy.com/rest/get-my-devices?' + queryParams
-    };
+    const url = 'https://ad.mytesy.com/rest/get-my-devices?' + queryParams;
 
-    request(options, (error, response) => {
+    this._httpsGet(url, (error, body) => {
       if (error) {
         return callback(error, null);
       }
 
       try {
-        const data = JSON.parse(response.body);
+        const data = JSON.parse(body);
         const deviceData = data[deviceInfo.mac];
 
         if (!deviceData || !deviceData.state) {
@@ -573,6 +667,23 @@ class TesyHeaterPlatform {
       });
     });
   }
+
+  // Helper method for HTTPS GET requests
+  _httpsGet(url, callback) {
+    https.get(url, (response) => {
+      let data = '';
+
+      response.on('data', (chunk) => {
+        data += chunk;
+      });
+
+      response.on('end', () => {
+        callback(null, data);
+      });
+    }).on('error', (error) => {
+      callback(error, null);
+    });
+  }
 }
 
 // Export for testing

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "homebridge-tesy-heater-mqtt",
   "displayName": "Homebridge Tesy Heater MQTT",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Tesy heater plugin for Homebridge using MQTT control (API v4). Supports on/off control and temperature adjustment.",
   "license": "MIT",
   "keywords": [
@@ -32,8 +32,7 @@
     "url": "git+https://github.com/svjakrm/homebridge-tesy-heater-mqtt.git"
   },
   "dependencies": {
-    "mqtt": "^5.14.1",
-    "request": "^2.65.0"
+    "mqtt": "^5.14.1"
   },
   "bugs": {
     "url": "https://github.com/svjakrm/homebridge-tesy-heater-mqtt/issues"