Merge pull request #13 from n0rt0nthec4t/alpha

0.1.7 release

CHANGELOG.md

@@ -2,8 +2,14 @@
 
 All notable changes to `Nest_accfactory` will be documented in this file. This project tries to adhere to [Semantic Versioning](http://semver.org/).
 
+## 0.1.7 (2024-09-13)
 
-## 0.1.6 (2023-09-03)
+- General code cleanup and bug fixes
+- External dependancy reductions, dropped pbf and axios libraries
+- Nest Cam with Floodlight support with light on/off and brightness control
+- Fixed issued with setting range temperatures on Nest Thermostat(s)
+
+## 0.1.6 (2024-09-07)
 
 - Common code bases between my two projects, homebridge-nest-accfactory and Nest_accfactory
 - Configuration file format has change, but for this version, we'll handle the existing one   

Dockerfile

@@ -74,11 +74,14 @@ RUN ./configure \
     #--enable-vaapi \
     --disable-ffnvcodec \
     #--enable-amf \
+    --disable-doc \
     --disable-debug \
     --disable-shared \
     --enable-pthreads \
     --enable-static \
     --enable-version3 \
+    --enable-pthreads \
+    --enable-runtime-cpudetect \
     ${FFMPEG_EXTRA_OPTIONS} \
     && make -j 4 \
     && make install

README.md

@@ -16,11 +16,11 @@ This is a HAP-NodeJS accessory I have developed to allow Nest devices to be used
 
 The following Nest devices are supported
 
-* Nest Thermostats (Gen 1, Gen 2, Gen 3, E)
-* Nest Protects (Gen 1, Gen 2)
-* Nest Temp Sensors
-* Nest Cameras (Cam Indoor, IQ Indoor, Outdoor, IQ Outdoor)
-* Nest Hello (Wired Gen 1)
+* Nest Thermostats (1st gen, 2nd gen, 3rd gen, E, 2020 mirror edition, 4th gen)
+* Nest Protects (1st and 2nd gen)
+* Nest Temp Sensors (1st gen)
+* Nest Cameras (Cam Indoor, IQ Indoor, Outdoor, IQ Outdoor, Cam with Floodlight)
+* Nest Doorbells (wired 1st gen)
 
 The accessory supports connection to Nest using a Nest account OR a Google (migrated Nest account) account.
 

package.json

@@ -2,7 +2,7 @@
     "displayName": "Nest Accfactory",
     "name": "nest-accfactory",
     "homepage": "https://github.com/n0rt0nthec4t/Nest_accfactory",
-    "version": "0.1.6",
+    "version": "0.1.7",
     "description": "HomeKit integration for Nest devices using HAP-NodeJS library",
     "license": "Apache-2.0",
     "author": "n0rt0nthec4t",
@@ -42,25 +42,24 @@
         "thermostat",
         "temperature",
         "smoke",
-        "sensor"
+        "sensor",
+        "floodlight"
     ],
     "devDependencies": {
-        "@eslint/js": "^9.9.1",
-        "@stylistic/eslint-plugin": "^2.7.2",
+        "@eslint/js": "^9.10.0",
+        "@stylistic/eslint-plugin": "^2.8.0",
         "@types/node": "^20.16.1",
-        "@typescript-eslint/parser": "^8.4.0",
+        "@typescript-eslint/parser": "^8.5.0",
         "copyfiles": "^2.4.1",
-        "eslint": "^9.9.1",
+        "eslint": "^9.10.0",
         "nodemon": "^3.1.4",
         "prettier": "^3.3.3",
         "prettier-eslint": "^16.3.0",
         "rimraf": "^6.0.1"
     },
     "dependencies": {
         "hap-nodejs": "^1.1.0",
-        "axios": "^1.7.7",
         "chalk": "^5.3.0",
-        "pbf": "^4.0.1",
         "protobufjs": "^7.4.0",
         "ws": "^8.18.0"
     }

src/HomeKitDevice.js

@@ -37,7 +37,7 @@
 // HomeKitDevice.updateServices(deviceData)
 // HomeKitDevice.messageServices(type, message)
 //
-// Code version 3/9/2024
+// Code version 13/9/2024
 // Mark Hulskamp
 'use strict';
 
@@ -104,7 +104,8 @@ export default class HomeKitDevice {
       this.#eventEmitter.addListener(this.deviceData.uuid, this.#message.bind(this));
     }
 
-    // Make copy of current data and store in this object
+    // Make a clone of current data and store in this object
+    // Important that we done have a 'linked' cope of the object data
     // eslint-disable-next-line no-undef
     this.deviceData = structuredClone(deviceData);
 
@@ -149,7 +150,10 @@ export default class HomeKitDevice {
       this.deviceData.model === '' ||
       typeof this.deviceData?.manufacturer !== 'string' ||
       this.deviceData.manufacturer === '' ||
-      (this.#platform === undefined && typeof this.deviceData?.hkPairingCode !== 'string' && this.deviceData.hkPairingCode === '') ||
+      (this.#platform === undefined &&
+        typeof this.deviceData?.hkPairingCode !== 'string' &&
+        (new RegExp(/^([0-9]{3}-[0-9]{2}-[0-9]{3})$/).test(this.deviceData.hkPairingCode) === true ||
+          new RegExp(/^([0-9]{4}-[0-9]{4})$/).test(this.deviceData.hkPairingCode) === true)) ||
       (this.#platform === undefined &&
         typeof this.deviceData?.hkUsername !== 'string' &&
         new RegExp(/^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$/).test(this.deviceData.hkUsername) === false)
@@ -239,7 +243,7 @@ export default class HomeKitDevice {
     }
   }
 
-  async remove() {
+  remove() {
     this?.log?.warn && this.log.warn('Device "%s" has been removed', this.deviceData.description);
 
     if (this.#eventEmitter === undefined && typeof this.deviceData?.uuid === 'string' && this.deviceData.uuid !== '') {
@@ -249,7 +253,7 @@ export default class HomeKitDevice {
 
     if (typeof this.removeServices === 'function') {
       try {
-        await this.removeServices();
+        this.removeServices();
       } catch (error) {
         this?.log?.error && this.log.error('removeServices call for device "%s" failed. Error was', this.deviceData.description, error);
       }
@@ -278,7 +282,7 @@ export default class HomeKitDevice {
     // delete this;
   }
 
-  async update(deviceData, forceUpdate) {
+  update(deviceData, forceUpdate) {
     if (typeof deviceData !== 'object' || typeof forceUpdate !== 'boolean') {
       return;
     }
@@ -357,7 +361,7 @@ export default class HomeKitDevice {
 
       if (typeof this.updateServices === 'function') {
         try {
-          await this.updateServices(deviceData); // Pass updated data on for accessory to process as it needs
+          this.updateServices(deviceData); // Pass updated data on for accessory to process as it needs
         } catch (error) {
           this?.log?.error && this.log.error('updateServices call for device "%s" failed. Error was', this.deviceData.description, error);
         }
@@ -381,6 +385,13 @@ export default class HomeKitDevice {
 
     // Send event with data to set
     this.#eventEmitter.emit(HomeKitDevice.SET, this.deviceData.uuid, values);
+
+    // Update the internal data for the set values, as could take sometime once we emit the event
+    Object.entries(values).forEach(([key, value]) => {
+      if (this.deviceData[key] !== undefined) {
+        this.deviceData[key] = value;
+      }
+    });
   }
 
   async get(values) {
@@ -393,17 +404,16 @@ export default class HomeKitDevice {
       return;
     }
 
-    // <---- TODO
-    // Send event with data to get. Once get has completed, callback will be called with the requested data
-    //this.#eventEmitter.emit(HomeKitDevice.GET, this.deviceData.uuid, values);
-    //
-    // await ....
-    // return gottenValues;
-    // <---- TODO
-    // Probable need some sort of await event
+    // Send event with data to get
+    // Once get has completed, we'll get an event back with the requested data
+    this.#eventEmitter.emit(HomeKitDevice.GET, this.deviceData.uuid, values);
+
+    // This should always return, but we probably should put in a timeout?
+    let results = await EventEmitter.once(this.#eventEmitter, HomeKitDevice.GET + '->' + this.deviceData.uuid);
+    return results?.[0];
   }
 
-  async #message(type, message) {
+  #message(type, message) {
     switch (type) {
       case HomeKitDevice.ADD: {
         // Got message for device add
@@ -429,7 +439,7 @@ export default class HomeKitDevice {
         // This is not a message we know about, so pass onto accessory for it to perform any processing
         if (typeof this.messageServices === 'function') {
           try {
-            await this.messageServices(type, message);
+            this.messageServices(type, message);
           } catch (error) {
             this?.log?.error &&
               this.log.error('messageServices call for device "%s" failed. Error was', this.deviceData.description, error);

src/HomeKitHistory.js

@@ -8,6 +8,8 @@
 // -- Eve Degree/Weather2 history
 // -- Eve Water guard history
 //
+// Credit to https://github.com/simont77/fakegato-history for the work on starting the EveHome comms protocol decoding
+//
 // Version 29/8/2024
 // Mark Hulskamp
 
@@ -2073,15 +2075,6 @@ export default class HomeKitHistory {
       numberToEveHexString(1, 8),
     ); // first entry
 
-    if (this?.log?.debug) {
-      this.log.debug(
-        '#EveHistoryStatus: history for "%s:%s" (%s) - Entries %s',
-        this.EveHome.type,
-        this.EveHome.sub,
-        this.EveHome.evetype,
-        this.EveHome.count,
-      );
-    }
     return encodeEveData(value);
   }
 
@@ -2299,26 +2292,11 @@ export default class HomeKitHistory {
       }
       if (this.EveHome.entry > this.EveHome.count) {
         // No more history data to send back
-        this?.log?.debug &&
-          this.log.debug(
-            '#EveHistoryEntries: sent "%s" entries to EveHome ("%s") for "%s:%s"',
-            this.EveHome.send,
-            this.EveHome.evetype,
-            this.EveHome.type,
-            this.EveHome.sub,
-          );
         this.EveHome.send = 0; // no more to send
         dataStream += '00';
       }
     } else {
       // We're not transferring any data back
-      this?.log?.debug &&
-        this.log.debug(
-          '#EveHistoryEntries: no more entries to send to EveHome ("%s") for "%s:%s',
-          this.EveHome.evetype,
-          this.EveHome.type,
-          this.EveHome.sub,
-        );
       this.EveHome.send = 0; // no more to send
       dataStream = '00';
     }