homebridge-nest-accfactory 0.2.1 → 0.2.3

package/CHANGELOG.md

@@ -2,9 +2,22 @@
 
 All notable changes to `homebridge-nest-accfactory` will be documented in this file. This project tries to adhere to [Semantic Versioning](http://semver.org/).
 
-## v0.2.1 (2024/10/05)
+## v0.2.3 (2024/12/06)
 
-## Changes
+- General code cleanup and bug fixes
+- Fix for HomeKit Secure Video recording for migrated camera/doorbell to Google Home
+
+## v0.2.2 (2024/10/05)
+
+- Improved handling of configuration file with docker/standalone version
+- Warning about the use of legacy configuration options with docker/standalone version
+
+## Known Issues
+
+- Audio from newer Nest/Google camera/doorbell devices is still blank
+- npm package [ip](https://github.com/advisories/GHSA-2p57-rm9w-gvfp) has severity issue. This is being used in external library (werift)
+
+## v0.2.1 (2024/10/05)
 
 - HomeKit support for multiple speeds on thermostat(s)
 - Audio library in docker release went walkabout. Added back in

package/README.md

@@ -3,16 +3,17 @@
 </p>
 <span align="center">
 
-# Homebridge Nest Accfactory
+# Nest Accfactory
 
 [![npm](https://badgen.net/npm/v/homebridge-nest-accfactory/latest)](https://www.npmjs.com/package/homebridge-nest-accfactory)
 [![npm](https://badgen.net/npm/dt/homebridge-nest-accfactory?label=downloads)](https://www.npmjs.com/package/homebridge-nest-accfactory)
-[![Donate](https://badgen.net/badge/donate/paypal/yellow)](https://paypal.me/n0rt0nthec4t)
 
 </span>
 
 Formally known as [Nest_accfactory](https://github.com/n0rt0nthec4t/Nest_accfactory), this is a Homebridge plugin I have developed to allow Nest devices to be used with HomeKit including having support for HomeKit Secure Video on doorbells and camera devices
 
+Building and maintaining this project takes time, effort, and resources. If you find it valuable, please consider sponsoring to support its development and future improvements. Your support makes a difference—thank you!
+
 ## Supported Devices
 
 The following Nest devices are known to be supported
@@ -98,6 +99,7 @@ The following options are available in the config.json options object. These app
 |-------------------|-----------------------------------------------------------------------------------------------|------------|
 | elevation         | Height above sea level for the weather station                                                | 0          |
 | eveHistory        | Provide history in EveHome application where applicable                                       | true       |
+| ffmegDebug        | Turns on specific debugging output for when ffmpeg is envoked                                 | false      |
 | ffmegPath         | Path to an ffmpeg binary for us to use. Will look in current directory by default             |            |
 | hksv              | Enable HomeKit Secure Video for supported camera(s) and doorbell(s)                           | false      |
 | maxStreams        | Maximum number of concurrent video streams in HomeKit for supported camera(s) and doorbell(s) | 2          |
@@ -114,6 +116,7 @@ The following options are available on a per-device level in the config.json dev
 | elevation         | Height above sea level for the specific weather station                                       | 0          |
 | eveHistory        | Provide history in EveHome application where applicable for the specific device               | true       |
 | exclude           | Exclude the device                                                                            | false      |
+| ffmegDebug        | Turns on specific debugging output for when ffmpeg is envoked                                 | false      |
 | hksv              | Enable HomeKit Secure Video for supported camera(s) and doorbell(s)                           | false      |
 | humiditySensor    | Create a seperate humidity sensor for supported thermostat(s)                                 | false      |
 | localAccess       | Use direct access to supported camera(s) and doorbell(s) for video streaming and recording    | false      |    
@@ -132,8 +135,10 @@ To support streaming and recording from cameras, an ffmpeg binary needs to be pr
   - libspeex
   - libopus
 
-By default, we look in the current directory where the plug-in excutes for an ffmpeg binary, however, you can specify a specific ffmpeg binary to use va the configuration option 'ffmpegPath'
+By default, we look in the current directory where the plug-in excutes for an ffmpeg binary, however, you can specify a specific ffmpeg binary to use via the configuration option 'ffmpegPath'
+
+## Disclaimer
 
-## Caveats
+This is a personal hobby project, provided "as-is," with no warranty whatsoever, express or implied, including but not limited to warranties of merchantability or fitness for a particular purpose. Building and running this project is done entirely at your own risk.
 
-homebridge-nest-accfactory and Nest_accfactory are both hobby projects of mine, provided as-is, with no warranty whatsoever. I've been running it successfully at my home, but your mileage might vary. If you do find an issue, please reachout and see what we can do
+Please note that I am not affiliated with any companies, including but not limited to Google, Apple, or any other entities. The author of this project shall not be held liable for any damages or issues arising from its use. If you do encounter any problems with the source code, feel free to reach out, and we can discuss possible solutions

package/dist/HomeKitDevice.js

@@ -19,6 +19,7 @@
 // description
 // manufacturer
 // model
+// hkUsername
 // hkPairingCode
 //
 // Following constants should be overridden in the module loading this class file
@@ -34,14 +35,13 @@
 // HomeKitDevice.updateServices(deviceData)
 // HomeKitDevice.messageServices(type, message)
 //
-// Code version 28/9/2024
+// Code version 8/10/2024
 // Mark Hulskamp
 'use strict';
 
 // Define nodejs module requirements
 import crypto from 'crypto';
 import EventEmitter from 'node:events';
-import { Buffer } from 'node:buffer';
 
 // Define our HomeKit device class
 export default class HomeKitDevice {
@@ -154,9 +154,11 @@ export default class HomeKitDevice {
       typeof this.deviceData?.manufacturer !== 'string' ||
       this.deviceData.manufacturer === '' ||
       (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))
+        (typeof this.deviceData?.hkPairingCode !== 'string' ||
+          (new RegExp(/^([0-9]{3}-[0-9]{2}-[0-9]{3})$/).test(this.deviceData.hkPairingCode) === false &&
+            new RegExp(/^([0-9]{4}-[0-9]{4})$/).test(this.deviceData.hkPairingCode) === false) ||
+          typeof this.deviceData?.hkUsername !== 'string' ||
+          new RegExp(/^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$/).test(this.deviceData.hkUsername) === false))
     ) {
       return;
     }
@@ -172,13 +174,7 @@ export default class HomeKitDevice {
       // Create HAP-NodeJS libray accessory
       this.accessory = new this.hap.Accessory(accessoryName, this.uuid);
 
-      // Create a HomeKit username for the device in format of xx:xx:xx:xx:xx:xx
-      // Use a Nest Labs prefix for first 6 digits, followed by a CRC24 based off serial number for last 6 digits.
-      this.accessory.username = ('18B430' + crc24(this.deviceData.serialNumber.toUpperCase()))
-        .toString('hex')
-        .split(/(..)/)
-        .filter((s) => s)
-        .join(':');
+      this.accessory.username = this.deviceData.hkUsername;
       this.accessory.pincode = this.deviceData.hkPairingCode;
       this.accessory.category = accessoryCategory;
     }
@@ -201,18 +197,15 @@ export default class HomeKitDevice {
     if (typeof this.addServices === 'function') {
       try {
         let postSetupDetails = await this.addServices();
-        if (this?.log?.info) {
+        this?.log?.info &&
           this.log.info('Setup %s %s as "%s"', this.deviceData.manufacturer, this.deviceData.model, this.deviceData.description);
-          if (this.historyService?.EveHome !== undefined) {
-            this.log.info('  += EveHome support as "%s"', this.historyService.EveHome.evetype);
-          }
-          if (typeof postSetupDetails === 'object') {
-            postSetupDetails.forEach((output) => {
-              if (this?.log?.info) {
-                this.log.info('  += %s', output);
-              }
-            });
-          }
+        if (this.historyService?.EveHome !== undefined) {
+          this?.log?.info && this.log.info('  += EveHome support as "%s"', this.historyService.EveHome.evetype);
+        }
+        if (typeof postSetupDetails === 'object') {
+          postSetupDetails.forEach((output) => {
+            this?.log?.info && this.log.info('  += %s', output);
+          });
         }
       } catch (error) {
         this?.log?.error && this.log.error('addServices call for device "%s" failed. Error was', this.deviceData.description, error);
@@ -229,10 +222,9 @@ export default class HomeKitDevice {
         pincode: this.accessory.pincode,
         category: this.accessory.category,
       });
-      if (this?.log?.info) {
-        this.log.info('  += Advertising as "%s"', this.accessory.displayName);
-        this.log.info('  += Pairing code is "%s"', this.accessory.pincode);
-      }
+
+      this?.log?.info && this.log.info('  += Advertising as "%s"', this.accessory.displayName);
+      this?.log?.info && this.log.info('  += Pairing code is "%s"', this.accessory.pincode);
     }
 
     return this.accessory; // Return our HomeKit accessory
@@ -440,36 +432,3 @@ export default class HomeKitDevice {
     }
   }
 }
-
-// General helper functions which don't need to be part of an object class
-function crc24(valueToHash) {
-  const crc24HashTable = [
-    0x000000, 0x864cfb, 0x8ad50d, 0x0c99f6, 0x93e6e1, 0x15aa1a, 0x1933ec, 0x9f7f17, 0xa18139, 0x27cdc2, 0x2b5434, 0xad18cf, 0x3267d8,
-    0xb42b23, 0xb8b2d5, 0x3efe2e, 0xc54e89, 0x430272, 0x4f9b84, 0xc9d77f, 0x56a868, 0xd0e493, 0xdc7d65, 0x5a319e, 0x64cfb0, 0xe2834b,
-    0xee1abd, 0x685646, 0xf72951, 0x7165aa, 0x7dfc5c, 0xfbb0a7, 0x0cd1e9, 0x8a9d12, 0x8604e4, 0x00481f, 0x9f3708, 0x197bf3, 0x15e205,
-    0x93aefe, 0xad50d0, 0x2b1c2b, 0x2785dd, 0xa1c926, 0x3eb631, 0xb8faca, 0xb4633c, 0x322fc7, 0xc99f60, 0x4fd39b, 0x434a6d, 0xc50696,
-    0x5a7981, 0xdc357a, 0xd0ac8c, 0x56e077, 0x681e59, 0xee52a2, 0xe2cb54, 0x6487af, 0xfbf8b8, 0x7db443, 0x712db5, 0xf7614e, 0x19a3d2,
-    0x9fef29, 0x9376df, 0x153a24, 0x8a4533, 0x0c09c8, 0x00903e, 0x86dcc5, 0xb822eb, 0x3e6e10, 0x32f7e6, 0xb4bb1d, 0x2bc40a, 0xad88f1,
-    0xa11107, 0x275dfc, 0xdced5b, 0x5aa1a0, 0x563856, 0xd074ad, 0x4f0bba, 0xc94741, 0xc5deb7, 0x43924c, 0x7d6c62, 0xfb2099, 0xf7b96f,
-    0x71f594, 0xee8a83, 0x68c678, 0x645f8e, 0xe21375, 0x15723b, 0x933ec0, 0x9fa736, 0x19ebcd, 0x8694da, 0x00d821, 0x0c41d7, 0x8a0d2c,
-    0xb4f302, 0x32bff9, 0x3e260f, 0xb86af4, 0x2715e3, 0xa15918, 0xadc0ee, 0x2b8c15, 0xd03cb2, 0x567049, 0x5ae9bf, 0xdca544, 0x43da53,
-    0xc596a8, 0xc90f5e, 0x4f43a5, 0x71bd8b, 0xf7f170, 0xfb6886, 0x7d247d, 0xe25b6a, 0x641791, 0x688e67, 0xeec29c, 0x3347a4, 0xb50b5f,
-    0xb992a9, 0x3fde52, 0xa0a145, 0x26edbe, 0x2a7448, 0xac38b3, 0x92c69d, 0x148a66, 0x181390, 0x9e5f6b, 0x01207c, 0x876c87, 0x8bf571,
-    0x0db98a, 0xf6092d, 0x7045d6, 0x7cdc20, 0xfa90db, 0x65efcc, 0xe3a337, 0xef3ac1, 0x69763a, 0x578814, 0xd1c4ef, 0xdd5d19, 0x5b11e2,
-    0xc46ef5, 0x42220e, 0x4ebbf8, 0xc8f703, 0x3f964d, 0xb9dab6, 0xb54340, 0x330fbb, 0xac70ac, 0x2a3c57, 0x26a5a1, 0xa0e95a, 0x9e1774,
-    0x185b8f, 0x14c279, 0x928e82, 0x0df195, 0x8bbd6e, 0x872498, 0x016863, 0xfad8c4, 0x7c943f, 0x700dc9, 0xf64132, 0x693e25, 0xef72de,
-    0xe3eb28, 0x65a7d3, 0x5b59fd, 0xdd1506, 0xd18cf0, 0x57c00b, 0xc8bf1c, 0x4ef3e7, 0x426a11, 0xc426ea, 0x2ae476, 0xaca88d, 0xa0317b,
-    0x267d80, 0xb90297, 0x3f4e6c, 0x33d79a, 0xb59b61, 0x8b654f, 0x0d29b4, 0x01b042, 0x87fcb9, 0x1883ae, 0x9ecf55, 0x9256a3, 0x141a58,
-    0xefaaff, 0x69e604, 0x657ff2, 0xe33309, 0x7c4c1e, 0xfa00e5, 0xf69913, 0x70d5e8, 0x4e2bc6, 0xc8673d, 0xc4fecb, 0x42b230, 0xddcd27,
-    0x5b81dc, 0x57182a, 0xd154d1, 0x26359f, 0xa07964, 0xace092, 0x2aac69, 0xb5d37e, 0x339f85, 0x3f0673, 0xb94a88, 0x87b4a6, 0x01f85d,
-    0x0d61ab, 0x8b2d50, 0x145247, 0x921ebc, 0x9e874a, 0x18cbb1, 0xe37b16, 0x6537ed, 0x69ae1b, 0xefe2e0, 0x709df7, 0xf6d10c, 0xfa48fa,
-    0x7c0401, 0x42fa2f, 0xc4b6d4, 0xc82f22, 0x4e63d9, 0xd11cce, 0x575035, 0x5bc9c3, 0xdd8538,
-  ];
-
-  let crc24 = 0xb704ce; // init crc24 hash;
-  valueToHash = Buffer.from(valueToHash); // convert value into buffer for processing
-  for (let index = 0; index < valueToHash.length; index++) {
-    crc24 = (crc24HashTable[((crc24 >> 16) ^ valueToHash[index]) & 0xff] ^ (crc24 << 8)) & 0xffffff;
-  }
-  return crc24.toString(16); // return crc24 as hex string
-}

package/dist/HomeKitHistory.js

@@ -10,7 +10,7 @@
 //
 // Credit to https://github.com/simont77/fakegato-history for the work on starting the EveHome comms protocol decoding
 //
-// Version 29/8/2024
+// Version 15/10/2024
 // Mark Hulskamp
 
 // Define nodejs module requirements
@@ -361,7 +361,11 @@ export default class HomeKitHistory {
       // Update types we have in history. This will just be the main type and its latest location in history
       let typeIndex = this.historyData.types.findIndex((type) => type.type === historyEntry.type && type.sub === historyEntry.sub);
       if (typeIndex === -1) {
-        this.historyData.types.push({ type: historyEntry.type, sub: historyEntry.sub, lastEntry: this.historyData.next - 1 });
+        this.historyData.types.push({
+          type: historyEntry.type,
+          sub: historyEntry.sub,
+          lastEntry: this.historyData.next - 1,
+        });
       } else {
         this.historyData.types[typeIndex].lastEntry = this.historyData.next - 1;
       }
@@ -382,44 +386,36 @@ export default class HomeKitHistory {
     // returns a JSON object of all history for this service and subtype
     // handles if we've rolled over history also
     let tempHistory = [];
-    let findUUID = null;
-    let findSub = null;
-    if (typeof subtype !== 'undefined' && subtype !== null) {
-      findSub = subtype;
+    if (specifickey === undefined) {
+      specifickey = {};
     }
-    if (typeof service !== 'object') {
+
+    if (service !== undefined && service !== '') {
       // passed in UUID byself, rather than service object
-      findUUID = service;
+      specifickey.type = service;
     }
-    if (typeof service?.UUID === 'string') {
-      findUUID = service.UUID;
+
+    if (service?.UUID !== undefined && service.UUID !== '') {
+      specifickey.type = service.UUID;
     }
-    if (typeof service.subtype === 'undefined' && typeof subtype === 'undefined') {
-      findSub = 0;
+
+    if (service?.subtype === undefined && typeof subtype === undefined) {
+      specifickey.sub = subtype;
     }
-    tempHistory = tempHistory.concat(
-      this.historyData.data.slice(this.historyData.next, this.historyData.data.length),
-      this.historyData.data.slice(0, this.historyData.next),
-    );
-    tempHistory = tempHistory.filter((historyEntry) => {
-      if (typeof specifickey === 'object' && Object.keys(specifickey).length === 1) {
-        // limit entry to a specifc key type value if specified
-        if (
-          (findSub === null && historyEntry.type === findUUID && historyEntry[Object.keys(specifickey)] === Object.values(specifickey)) ||
-          (findSub !== null &&
-            historyEntry.type === findUUID &&
-            historyEntry.sub === findSub &&
-            historyEntry[Object.keys(specifickey)] === Object.values(specifickey))
-        ) {
-          return historyEntry;
-        }
-      } else if (
-        (findSub === null && historyEntry.type === findUUID) ||
-        (findSub !== null && historyEntry.type === findUUID && historyEntry.sub === findSub)
-      ) {
-        return historyEntry;
-      }
-    });
+
+    if (subtype !== undefined && subtype !== null) {
+      specifickey.sub = subtype;
+    }
+
+    tempHistory = tempHistory
+      .concat(
+        this.historyData.data.slice(this.historyData.next, this.historyData.data.length),
+        this.historyData.data.slice(0, this.historyData.next),
+      )
+      .filter((historyEntry) => {
+        return Object.entries(specifickey).every(([key, value]) => historyEntry[key] === value);
+      });
+
     return tempHistory;
   }
 
@@ -428,7 +424,10 @@ export default class HomeKitHistory {
     // we get all the data for the service, ignoring the specific subtypes
     let tempHistory = this.getHistory(service, null); // all history
     if (tempHistory.length !== 0) {
-      let writer = fs.createWriteStream(csvfile, { flags: 'w', autoClose: 'true' });
+      let writer = fs.createWriteStream(csvfile, {
+        flags: 'w',
+        autoClose: 'true',
+      });
       if (writer !== null) {
         // write header, we'll use the first record keys for the header keys
         let header = 'time,subtype';
@@ -457,27 +456,8 @@ export default class HomeKitHistory {
 
   lastHistory(service, subtype) {
     // returns the last history event for this service type and subtype
-    let findUUID = null;
-    let findSub = null;
-    if (typeof subtype !== 'undefined') {
-      findSub = subtype;
-    }
-    if (typeof service !== 'object') {
-      // passed in UUID byself, rather than service object
-      findUUID = service;
-    }
-    if (typeof service?.UUID === 'string') {
-      findUUID = service.UUID;
-    }
-    if (typeof service.subtype === 'undefined' && typeof subtype === 'undefined') {
-      findSub = 0;
-    }
-
-    // If subtype is 'null' find newest event based on time
-    let typeIndex = this.historyData.types.findIndex(
-      (type) => (type.type === findUUID && type.sub === findSub && subtype !== null) || (type.type === findUUID && subtype === null),
-    );
-    return typeIndex !== -1 ? this.historyData.data[this.historyData.types[typeIndex].lastEntry] : null;
+    let lastHistory = this.getHistory(service, subtype);
+    return lastHistory.length > 0 ? lastHistory?.[lastHistory.length - 1] : undefined;
   }
 
   entryCount(service, subtype, specifickey) {
@@ -501,7 +481,11 @@ export default class HomeKitHistory {
             (typeof type.sub === 'undefined' && type.type === this.historyData.data[index].type),
         ) === -1
       ) {
-        this.historyData.types.push({ type: this.historyData.data[index].type, sub: this.historyData.data[index].sub, lastEntry: index });
+        this.historyData.types.push({
+          type: this.historyData.data[index].type,
+          sub: this.historyData.data[index].sub,
+          lastEntry: index,
+        });
       }
     }
   }
@@ -534,7 +518,7 @@ export default class HomeKitHistory {
         // Callbacks setup below after this is created
         let historyService = this.#createHistoryService(service, [
           this.hap.Characteristic.EveLastActivation,
-          this.hap.Characteristic.EveOpenDuration,
+          this.hap.Characteristic.EveOpenedDuration,
           this.hap.Characteristic.EveTimesOpened,
         ]);
 
@@ -561,12 +545,13 @@ export default class HomeKitHistory {
         service.updateCharacteristic(
           this.hap.Characteristic.EveTimesOpened,
           this.entryCount(this.EveHome.type, this.EveHome.sub, { status: 1 }),
-        ); // Count of entries based upon status = 1, opened
+        );
         service.updateCharacteristic(this.hap.Characteristic.EveLastActivation, this.#EveLastEventTime());
 
         // Setup callbacks for characteristics
         service.getCharacteristic(this.hap.Characteristic.EveTimesOpened).onGet(() => {
-          return this.entryCount(this.EveHome.type, this.EveHome.sub, { status: 1 }); // Count of entries based upon status = 1, opened
+          // Count of entries based upon status = 1, opened
+          return this.entryCount(this.EveHome.type, this.EveHome.sub, { status: 1 });
         });
 
         service.getCharacteristic(this.hap.Characteristic.EveLastActivation).onGet(() => {
@@ -834,7 +819,10 @@ export default class HomeKitHistory {
                 //let nowTemp = valHex.substr(index, 2) === '80' ? null : parseInt(valHex.substr(index, 2), 16) * 0.5;
                 let ecoTemp = valHex.substr(index + 2, 2) === '80' ? null : parseInt(valHex.substr(index + 2, 2), 16) * 0.5;
                 let comfortTemp = valHex.substr(index + 4, 2) === '80' ? null : parseInt(valHex.substr(index + 4, 2), 16) * 0.5;
-                processedData.scheduleTemps = { eco: ecoTemp, comfort: comfortTemp };
+                processedData.scheduleTemps = {
+                  eco: ecoTemp,
+                  comfort: comfortTemp,
+                };
                 index += 6;
                 break;
               }
@@ -883,7 +871,11 @@ export default class HomeKitHistory {
                     }
                     index += 4;
                   }
-                  programs.push({ id: programs.length + 1, days: DAYSOFWEEK[index2], schedule: times });
+                  programs.push({
+                    id: programs.length + 1,
+                    days: DAYSOFWEEK[index2],
+                    schedule: times,
+                  });
                 }
 
                 this.EveThermoPersist.programs = programs;
@@ -1442,7 +1434,11 @@ export default class HomeKitHistory {
                         offset: start_offset,
                       });
                     }
-                    programs.push({ id: programs.length + 1, days: [], schedule: times });
+                    programs.push({
+                      id: programs.length + 1,
+                      days: [],
+                      schedule: times,
+                    });
                   }
                   index2 = index2 + 4 + scheduleSize; // Move to next program
                 }
@@ -1756,7 +1752,7 @@ export default class HomeKitHistory {
     // calculate time in seconds since first event to last event. If no history we'll use the current time as the last event time
     let historyEntry = this.lastHistory(this.EveHome.type, this.EveHome.sub);
     let lastTime = Math.floor(Date.now() / 1000) - (this.EveHome.reftime + EPOCH_OFFSET);
-    if (historyEntry && Object.keys(historyEntry).length !== 0) {
+    if (isNaN(historyEntry?.time) === false) {
       lastTime -= Math.floor(Date.now() / 1000) - historyEntry.time;
     }
     return lastTime;
@@ -2259,8 +2255,8 @@ export default class HomeKitHistory {
                 '%s %s %s',
                 numberToEveHexString(parseInt('11', 2), 2), // Field include/exclude mask
                 numberToEveHexString(historyEntry.watts * 10, 4), // Power in watts
-                numberToEveHexString(historyEntry.status, 2),
-              ); // Power status, 1 = on, 0 = off
+                numberToEveHexString(historyEntry.status, 2), // Power status, 1 = on, 0 = off
+              );
               break;
             }