@homebridge-plugins/homebridge-ecovacs 7.0.2 → 7.2.0

package/CHANGELOG.md

@@ -2,11 +2,28 @@
 
 All notable changes to homebridge-ecovacs will be documented in this file.
 
-This project tries to adhere to [Semantic Versioning](http://semver.org/). In practice, this means that the version number will be incremented based on the following:
+## v7.2.0 (2025-07-13)
 
-- `MAJOR` version when a minimum supported version of `homebridge` or `node` is increased to a new major version, or when a breaking change is made to the plugin config
-- `MINOR` version when a new device type is added, or when a new feature is added that is backwards-compatible
-- `PATCH` version when backwards-compatible bug fixes are implemented
+### Notable Changes
+
+- fix custom plugin config modal styles in ui 5
+- fix custom characteristics for hb 2
+
+### Other Changes
+
+- add `lint` step to build workflow
+- add permissions to workflows
+- improvements to the deprecate workflow
+
+## v7.1.0 (2025-07-12)
+
+### Notable Changes
+
+- set `strictValidation` to `true` in the config schema file
+
+### Other Changes
+
+- github repo maintenance
 
 ## v7.0.2 (2025-07-11)
 
@@ -296,7 +313,7 @@ This project tries to adhere to [Semantic Versioning](http://semver.org/). In pr
 
 - Ignore `Robot is operational` error in log
 - Updated `ecovacs-deebot` library to v0.6.3
-- Remove `node-machine-id` in favour of generating a client id based on ECOVACS username
+- Remove `node-machine-id` in favour of generating a client id based on Ecovacs username
 
 ## v4.1.0 (2021-08-30)
 
@@ -338,7 +355,7 @@ _Unpublished_
 
 ### Added
 
-- Support for cleaning 'Spot Areas' customised in the ECOVACS app
+- Support for cleaning 'Spot Areas' customised in the Ecovacs app
 
 ## v3.3.1 (2021-07-18)
 
@@ -442,7 +459,7 @@ _Unpublished_
 
 - Configuration settings per Deebot device
 - Support for Chinese server login
-- Enter your ECOVACS password as a base64 encoded string and use the option `encodedPassword` to let the plugin know
+- Enter your Ecovacs password as a base64 encoded string and use the option `encodedPassword` to let the plugin know
 - More viewable information in the Homebridge plugin-ui:
   - Device model, company and an image of your device in case you didn't know what it looked like
 

package/README.md

@@ -5,7 +5,7 @@
 
 # homebridge-ecovacs
 
-Homebridge plugin to integrate ECOVACS Deebot or Yeedi devices into HomeKit
+Homebridge plugin to integrate Ecovacs Deebot or Yeedi devices into HomeKit
 
 [![npm](https://img.shields.io/npm/v/@homebridge-plugins/homebridge-ecovacs/latest?label=latest)](https://www.npmjs.com/package/@homebridge-plugins/homebridge-ecovacs)
 [![npm](https://img.shields.io/npm/v/@homebridge-plugins/homebridge-ecovacs/beta?label=beta)](https://github.com/homebridge-plugins/homebridge-ecovacs/wiki/Beta-Version)
@@ -20,8 +20,8 @@ Homebridge plugin to integrate ECOVACS Deebot or Yeedi devices into HomeKit
 
 ### Plugin Information
 
-- This plugin allows you to view and control your ECOVACS or Yeedi devices within HomeKit. The plugin:
-  - requires your ECOVACS or Yeedi credentials to function
+- This plugin allows you to view and control your Ecovacs or Yeedi devices within HomeKit. The plugin:
+  - requires your Ecovacs or Yeedi credentials to function
   - uses a cloud-based connection (i.e. requires the internet)
 
 ### Prerequisites
@@ -59,5 +59,5 @@ Homebridge plugin to integrate ECOVACS Deebot or Yeedi devices into HomeKit
 
 ### Disclaimer
 
-- I am in no way affiliated with ECOVACS/Deebot/Yeedi and this plugin is a personal project that I maintain in my free time.
+- I am in no way affiliated with Ecovacs/Deebot/Yeedi and this plugin is a personal project that I maintain in my free time.
 - Use this plugin entirely at your own risk - please see licence for more information.

package/config.schema.json

@@ -2,6 +2,7 @@
   "pluginAlias": "Deebot",
   "pluginType": "platform",
   "singular": true,
+  "strictValidation": true,
   "customUi": true,
   "customUiPath": "./lib/homebridge-ui",
   "headerDisplay": "<p align=\"center\"><img width=\"60%\" src=\"https://user-images.githubusercontent.com/43026681/101321841-f0eb5280-385d-11eb-8dd4-f57113f6e078.png\"></p><p align=\"center\">For help and support please visit our <a href=\"https://github.com/homebridge-plugins/homebridge-ecovacs/wiki\">GitHub Wiki</a>. We hope you find this plugin useful!</p>",
@@ -16,7 +17,7 @@
       "useYeedi": {
         "title": "Use Yeedi Login",
         "type": "boolean",
-        "description": "Enable this for Yeedi login instead of ECOVACS."
+        "description": "Enable this for Yeedi login instead of Ecovacs."
       },
       "countryCode": {
         "title": "Country Code",
@@ -25,13 +26,13 @@
         "required": true
       },
       "username": {
-        "title": "ECOVACS/Yeedi Username",
+        "title": "Ecovacs/Yeedi Username",
         "required": true,
         "type": "string",
-        "description": "Your username, if your account is based in China you should use your ECOVACS ID."
+        "description": "Your username, if your account is based in China you should use your Ecovacs ID."
       },
       "password": {
-        "title": "ECOVACS/Yeedi Password",
+        "title": "Ecovacs/Yeedi Password",
         "required": true,
         "type": "string",
         "description": "Your password, can also be a base64 encoded version of your password."
@@ -56,7 +57,7 @@
             "deviceId": {
               "title": "Device ID",
               "type": "string",
-              "description": "ECOVACS Device ID of the device these settings apply to, can be of format E2000000000000000000 or 11111111-aaaa-bbbb-2222-cccccccccccc."
+              "description": "Ecovacs Device ID of the device these settings apply to, can be of format E2000000000000000000 or 11111111-aaaa-bbbb-2222-cccccccccccc."
             },
             "ignoreDevice": {
               "type": "boolean",
@@ -70,7 +71,7 @@
               "title": "Polling Interval",
               "type": "integer",
               "placeholder": 120,
-              "description": "An interval (in seconds) in which this device will refresh with ECOVACS. Set to 0 to disable, otherwise must be 30 or more."
+              "description": "An interval (in seconds) in which this device will refresh with Ecovacs. Set to 0 to disable, otherwise must be 30 or more."
             },
             "hideMotionSensor": {
               "title": "Hide Motion Sensor",

package/lib/homebridge-ui/public/index.html

@@ -1,3 +1,39 @@
+<style>
+  .dark-mode {
+    background-color: #242424;
+    color: lightgrey;
+
+    .form-control {
+      background-color: #333333 !important;
+      border: none !important;
+      color: #eeeeee !important;
+    }
+
+    thead, tbody, tr {
+      border-style: hidden;
+    }
+
+    th {
+      color: #eeeeee !important;
+      font-weight: 500 !important;
+    }
+  }
+  select {
+    background-image:
+      linear-gradient(45deg, transparent 50%, gray 50%),
+      linear-gradient(135deg, gray 50%, transparent 50%),
+      linear-gradient(to right, #ccc, #ccc);
+    background-position:
+      calc(100% - 20px) calc(1em + 2px),
+      calc(100% - 15px) calc(1em + 2px),
+      calc(100% - 2.5em) 0.5em;
+    background-size:
+      5px 5px,
+      5px 5px,
+      1px 1.5em;
+    background-repeat: no-repeat;
+  }
+</style>
 <p class="text-center">
   <img
     src="https://user-images.githubusercontent.com/43026681/101321841-f0eb5280-385d-11eb-8dd4-f57113f6e078.png"
@@ -7,7 +43,7 @@
 </p>
 <div id="pageIntro" class="text-center" style="display: none;">
   <p class="lead">Thank you for installing <strong>homebridge-ecovacs</strong></p>
-  <p>You will need to enter your ECOVACS username, password and region on the next page</p>
+  <p>You will need to enter your Ecovacs username, password and region on the next page</p>
   <button type="button" class="btn btn-primary" id="introContinue">Continue &rarr;</button>
 </div>
 <div
@@ -28,7 +64,7 @@
         <select class="form-control" id="deviceSelect"></select>
       </div>
     </form>
-    <table class="table w-100" id="deviceTable" style="display: none;">
+    <table class="table w-100 mt-3" id="deviceTable" style="display: none;">
       <thead>
         <tr class="table-active">
           <th scope="col" style="width: 40%;">Device Name</th>
@@ -161,7 +197,7 @@
   <h4>Disclaimer</h4>
   <ul>
     <li>
-      I am in no way affiliated with ECOVACS and this plugin is a personal project that I maintain
+      I am in no way affiliated with Ecovacs and this plugin is a personal project that I maintain
       in my free time.
     </li>
     <li>Use this plugin entirely at your own risk - please see licence for more information.</li>

package/lib/platform.js

@@ -363,7 +363,7 @@ export default class {
       // Require any libraries that the accessory instances use
       this.cusChar = new platformChars(this.api)
 
-      // Connect to ECOVACS/Yeedi
+      // Connect to Ecovacs/Yeedi
       this.ecovacsAPI = new EcoVacsAPI(
         EcoVacsAPI.getDeviceId(this.api.hap.uuid.generate(this.config.username)),
         this.config.countryCode,
@@ -374,7 +374,7 @@ export default class {
       // Display version of the ecovacs-deebot library in the log
       this.log('%s v%s.', platformLang.ecovacsLibVersion, this.ecovacsAPI.getVersion())
 
-      // Attempt to log in to ECOVACS/Yeedi
+      // Attempt to log in to Ecovacs/Yeedi
       try {
         await this.ecovacsAPI.connect(this.config.username, EcoVacsAPI.md5(this.config.password))
       } catch (err) {
@@ -393,7 +393,7 @@ export default class {
         }
       }
 
-      // Get a device list from ECOVACS/Yeedi
+      // Get a device list from Ecovacs/Yeedi
       const deviceList = await this.ecovacsAPI.devices()
 
       // Check the request for device list was successful
@@ -402,7 +402,7 @@ export default class {
       }
 
       // Initialise each device into Homebridge
-      this.log('[%s] %s.', deviceList.length, platformLang.deviceCount(this.config.useYeedi ? 'Yeedi' : 'ECOVACS'))
+      this.log('[%s] %s.', deviceList.length, platformLang.deviceCount(this.config.useYeedi ? 'Yeedi' : 'Ecovacs'))
       for (let i = 0; i < deviceList.length; i += 1) {
         await this.initialiseDevice(deviceList[i])
       }
@@ -429,7 +429,7 @@ export default class {
         clearInterval(this.refreshIntervals[id])
       })
 
-      // Disconnect from each ECOVACS/Yeedi device
+      // Disconnect from each Ecovacs/Yeedi device
       devicesInHB.forEach((accessory) => {
         if (accessory.control?.is_ready) {
           accessory.control.disconnect()
@@ -453,7 +453,7 @@ export default class {
         return
       }
 
-      // Load the device control information from ECOVACS/Yeedi
+      // Load the device control information from Ecovacs/Yeedi
       const loadedDevice = this.ecovacsAPI.getVacBot(
         this.ecovacsAPI.uid,
         EcoVacsAPI.REALM,

package/lib/utils/custom-chars.js

@@ -1,50 +1,51 @@
-import { inherits } from 'node:util'
-
 export default class {
   constructor(api) {
-    this.hapChar = api.hap.Characteristic
     this.uuids = {
       maxSpeed: 'E963F001-079E-48FF-8F27-9C2605A29F52',
       predefinedArea: 'E963F002-079E-48FF-8F27-9C2605A29F52',
       trueDetect: 'E963F003-079E-48FF-8F27-9C2605A29F52',
     }
-    const self = this
-    this.MaxSpeed = function MaxSpeed() {
-      self.hapChar.call(this, 'Max Speed', self.uuids.maxSpeed)
-      this.setProps({
-        format: api.hap.Formats.BOOL,
-        perms: [api.hap.Perms.PAIRED_READ, api.hap.Perms.PAIRED_WRITE, api.hap.Perms.NOTIFY],
-      })
-      this.value = this.getDefaultValue()
+    const uuids = this.uuids
+
+    this.MaxSpeed = class extends api.hap.Characteristic {
+      constructor() {
+        super('Max Speed', uuids.maxSpeed)
+        this.setProps({
+          format: api.hap.Formats.BOOL,
+          perms: [api.hap.Perms.PAIRED_READ, api.hap.Perms.PAIRED_WRITE, api.hap.Perms.NOTIFY],
+        })
+        this.value = this.getDefaultValue()
+      }
     }
 
-    this.PredefinedArea = function PredefinedArea() {
-      self.hapChar.call(this, 'Predefined Area', self.uuids.predefinedArea)
-      this.setProps({
-        format: api.hap.Formats.UINT8,
-        perms: [api.hap.Perms.PAIRED_READ, api.hap.Perms.PAIRED_WRITE, api.hap.Perms.NOTIFY],
-        minValue: 0,
-        maxValue: 15,
-        minStep: 1,
-        validValues: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15],
-      })
-      this.value = this.getDefaultValue()
+    this.PredefinedArea = class extends api.hap.Characteristic {
+      constructor() {
+        super('Predefined Area', uuids.predefinedArea)
+        this.setProps({
+          format: api.hap.Formats.UINT8,
+          perms: [api.hap.Perms.PAIRED_READ, api.hap.Perms.PAIRED_WRITE, api.hap.Perms.NOTIFY],
+          minValue: 0,
+          maxValue: 15,
+          minStep: 1,
+          validValues: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15],
+        })
+        this.value = this.getDefaultValue()
+      }
     }
 
-    this.TrueDetect = function TrueDetect() {
-      self.hapChar.call(this, 'TrueDetect', self.uuids.trueDetect)
-      this.setProps({
-        format: api.hap.Formats.BOOL,
-        perms: [api.hap.Perms.PAIRED_READ, api.hap.Perms.PAIRED_WRITE, api.hap.Perms.NOTIFY],
-      })
-      this.value = this.getDefaultValue()
+    this.TrueDetect = class extends api.hap.Characteristic {
+      constructor() {
+        super('TrueDetect', uuids.trueDetect)
+        this.setProps({
+          format: api.hap.Formats.BOOL,
+          perms: [api.hap.Perms.PAIRED_READ, api.hap.Perms.PAIRED_WRITE, api.hap.Perms.NOTIFY],
+        })
+        this.value = this.getDefaultValue()
+      }
     }
 
-    inherits(this.MaxSpeed, this.hapChar)
-    inherits(this.PredefinedArea, this.hapChar)
-    inherits(this.TrueDetect, this.hapChar)
-    this.MaxSpeed.UUID = this.uuids.maxSpeed
     this.PredefinedArea.UUID = this.uuids.predefinedArea
     this.TrueDetect.UUID = this.uuids.trueDetect
+    this.MaxSpeed.UUID = this.uuids.maxSpeed
   }
 }

package/package.json

@@ -3,8 +3,8 @@
   "displayName": "Homebridge Ecovacs",
   "alias": "Deebot",
   "type": "module",
-  "version": "7.0.2",
-  "description": "Homebridge plugin to integrate ECOVACS Deebot devices into HomeKit.",
+  "version": "7.2.0",
+  "description": "Homebridge plugin to integrate Ecovacs Deebot devices into HomeKit.",
   "author": {
     "name": "bwp91",
     "email": "bwp91@icloud.com"
@@ -57,9 +57,9 @@
     "node": "^20 || ^22 || ^24"
   },
   "scripts": {
-    "lint": "eslint . --fix",
-    "postinstall": "patch-package",
-    "rebuild": "rm -rf package-lock.json && rm -rf node_modules && npm install"
+    "lint": "eslint . --max-warnings=0",
+    "lint:fix": "npm run lint -- --fix",
+    "postinstall": "patch-package"
   },
   "dependencies": {
     "@homebridge/plugin-ui-utils": "^2.1.0",