homebridge-nest-accfactory 0.0.5 → 0.0.6

package/CHANGELOG.md

@@ -6,7 +6,11 @@ All notable changes to `homebridge-nest-accfactory` will be documented in this f
 
 Currently all releases are considered 'alpha' status, where things may or may not be working. Use at your own risk :-)
 
-## v0.0.5 (2024/09/13)
+## v0.0.6 (2024-09-14)
+
+- Fix for two/way audio starting on non-enabled HKSV camera/doorbells
+
+## v0.0.5 (2024-09-13)
 
 - General code cleanup and bug fixes
 - External dependancy reductions, dropped pbf and axios libraries

package/dist/camera.js

@@ -1,7 +1,7 @@
 // Nest Cameras
 // Part of homebridge-nest-accfactory
 //
-// Code version 12/9/2024
+// Code version 13/9/2024
 // Mark Hulskamp
 'use strict';
 
@@ -33,6 +33,7 @@ export default class NestCamera extends HomeKitDevice {
   controller = undefined; // HomeKit Camera/Doorbell controller service
   streamer = undefined; // Streamer object for live/recording stream
   motionServices = undefined; // Object of Camera/Doorbell motion sensor(s)
+  batteryService = undefined; // If a camera has a battery
   operatingModeService = undefined; // Link to camera/doorbell operating mode service
   personTimer = undefined; // Cooldown timer for person/face events
   motionTimer = undefined; // Cooldown timer for motion events

package/dist/floodlight.js

@@ -1,7 +1,7 @@
 // Nest Cam with Floodlight
 // Part of homebridge-nest-accfactory
 //
-// Code version 12/9/2024
+// Code version 13/9/2024
 // Mark Hulskamp
 'use strict';
 
@@ -48,7 +48,7 @@ export default class NestFloodlight extends NestCamera {
         if (value !== this.deviceData.light_brightness) {
           this.set({ light_brightness: value });
 
-          this?.log?.info && this.log.info('Floodlight brightness on "%s" was set to "%s %"', this.deviceData.description);
+          this?.log?.info && this.log.info('Floodlight brightness on "%s" was set to "%s %"', this.deviceData.description, value);
         }
       });
 

package/dist/nexustalk.js

@@ -5,7 +5,7 @@
 //
 // Credit to https://github.com/Brandawg93/homebridge-nest-cam for the work on the Nest Camera comms code on which this is based
 //
-// Code version 11/9/2024
+// Code version 14/9/2024
 // Mark Hulskamp
 'use strict';
 
@@ -59,11 +59,11 @@ const PacketType = {
 export default class NexusTalk extends Streamer {
   token = undefined;
   tokenType = undefined;
-  id = undefined; // Session ID
   pingTimer = undefined; // Timer object for ping interval
   stalledTimer = undefined; // Timer object for no received data
   video = {}; // Video stream details
   audio = {}; // Audio stream details
+  host = ''; // Host to connect to or connected too
 
   // Internal data only for this class
   #protobufNexusTalk = undefined; // Protobuf for NexusTalk
@@ -71,6 +71,7 @@ export default class NexusTalk extends Streamer {
   #packets = []; // Incoming packets
   #messages = []; // Incoming messages
   #authorised = false; // Have we been authorised
+  #id = undefined; // Session ID
 
   constructor(deviceData, options) {
     super(deviceData, options);
@@ -98,7 +99,7 @@ export default class NexusTalk extends Streamer {
     this.pingTimer = clearInterval(this.pingTimer);
     this.stalledTimer = clearInterval(this.stalledTimer);
 
-    this.id = undefined; // No session ID yet
+    this.#id = undefined; // No session ID yet
 
     if (this.online === true && this.videoEnabled === true) {
       if (typeof host === 'undefined' || host === null) {
@@ -134,7 +135,7 @@ export default class NexusTalk extends Streamer {
         this.#authorised = false; // Since connection close, we can't be authorised anymore
         this.#socket = undefined; // Clear socket object
         this.connected = false;
-        this.id = undefined; // Not an active session anymore
+        this.#id = undefined; // Not an active session anymore
 
         if (hadError === true && this.haveOutputs() === true) {
           // We still have either active buffering occuring or output streams running
@@ -147,7 +148,7 @@ export default class NexusTalk extends Streamer {
 
   close(stopStreamFirst) {
     // Close an authenicated socket stream gracefully
-    if (this.#socket !== null) {
+    if (this.#socket !== undefined) {
       if (stopStreamFirst === true) {
         // Send a notifcation to nexus we're finished playback
         this.#stopNexusData();
@@ -157,7 +158,7 @@ export default class NexusTalk extends Streamer {
 
     this.connected = false;
     this.#socket = undefined;
-    this.id = undefined; // Not an active session anymore
+    this.#id = undefined; // Not an active session anymore
     this.#packets = [];
     this.#messages = [];
   }
@@ -171,11 +172,16 @@ export default class NexusTalk extends Streamer {
       // access token has changed so re-authorise
       this.token = deviceData.apiAccess.token;
 
-      if (this.#socket !== null) {
+      if (this.#socket !== undefined) {
         this.#Authenticate(true); // Update authorisation only if connected
       }
     }
 
+    if (this.host !== deviceData.streaming_host) {
+      this.host = deviceData.streaming_host;
+      this?.log?.debug && this.log.debug('New host has been requested for connection. Host requested is "%s"', this.host);
+    }
+
     // Let our parent handle the remaining updates
     super.update(deviceData);
   }
@@ -183,12 +189,12 @@ export default class NexusTalk extends Streamer {
   talkingAudio(talkingData) {
     // Encode audio packet for sending to camera
     if (typeof talkingData === 'object' && this.#protobufNexusTalk !== undefined) {
-      let TraitMap = this.#protobufNexusTalk.lookup('nest.nexustalk.v1.StartPlayback');
+      let TraitMap = this.#protobufNexusTalk.lookup('nest.nexustalk.v1.AudioPayload');
       if (TraitMap !== null) {
         let encodedData = TraitMap.encode(
           TraitMap.fromObject({
             payload: talkingData,
-            sessionId: this.id,
+            sessionId: this.#id,
             codec: 'SPEEX',
             sampleRate: 16000,
           }),
@@ -227,12 +233,12 @@ export default class NexusTalk extends Streamer {
   }
 
   #stopNexusData() {
-    if (this.id !== undefined && this.#protobufNexusTalk !== undefined) {
+    if (this.#id !== undefined && this.#protobufNexusTalk !== undefined) {
       let TraitMap = this.#protobufNexusTalk.lookup('nest.nexustalk.v1.StopPlayback');
       if (TraitMap !== null) {
         let encodedData = TraitMap.encode(
           TraitMap.fromObject({
-            sessionId: this.id,
+            sessionId: this.#id,
           }),
         ).finish();
         this.#sendMessage(PacketType.STOP_PLAYBACK, encodedData);
@@ -241,7 +247,7 @@ export default class NexusTalk extends Streamer {
   }
 
   #sendMessage(type, data) {
-    if (this.#socket === null || this.#socket.readyState !== 'open' || (type !== PacketType.HELLO && this.#authorised === false)) {
+    if (this.#socket?.readyState !== 'open' || (type !== PacketType.HELLO && this.#authorised === false)) {
       // We're not connect and/or authorised yet, so 'cache' message for processing once this occurs
       this.#messages.push({ type: type, data: data });
       return;
@@ -358,11 +364,11 @@ export default class NexusTalk extends Streamer {
       });
 
       // Since this is the beginning of playback, clear any active buffers contents
-      this.id = decodedMessage.sessionId;
+      this.#id = decodedMessage.sessionId;
       this.#packets = [];
       this.#messages = [];
 
-      this?.log?.debug && this.log.debug('Playback started from "%s" with session ID "%s"', this.host, this.id);
+      this?.log?.debug && this.log.debug('Playback started from "%s" with session ID "%s"', this.host, this.#id);
     }
   }
 
@@ -381,7 +387,7 @@ export default class NexusTalk extends Streamer {
         // Setup listener for socket close event. Once socket is closed, we'll perform the re-connection
         this.#socket &&
           this.#socket.on('close', () => {
-            this.connect(this.host); // try reconnection
+            this.connect(); // try reconnection
           });
         this.close(false); // Close existing socket
       }, 8000);
@@ -405,7 +411,7 @@ export default class NexusTalk extends Streamer {
     if (typeof payload === 'object' && this.#protobufNexusTalk !== undefined) {
       let decodedMessage = this.#protobufNexusTalk.lookup('nest.nexustalk.v1.PlaybackEnd').decode(payload).toJSON();
 
-      if (this.id !== null && decodedMessage.reason === 'USER_ENDED_SESSION') {
+      if (this.#id !== undefined && decodedMessage.reason === 'USER_ENDED_SESSION') {
         // Normal playback ended ie: when we stopped playback
         this?.log?.debug && this.log.debug('Playback ended on "%s"', this.host);
       }
@@ -418,7 +424,7 @@ export default class NexusTalk extends Streamer {
         // Setup listener for socket close event. Once socket is closed, we'll perform the re-connection
         this.#socket &&
           this.#socket.on('close', () => {
-            this.connect(this.host); // try reconnection to existing host
+            this.connect(); // try reconnection to existing host
           });
         this.close(false); // Close existing socket
       }
@@ -443,7 +449,7 @@ export default class NexusTalk extends Streamer {
     // Decode talk begin packet
     if (typeof payload === 'object' && this.#protobufNexusTalk !== undefined) {
       let decodedMessage = this.#protobufNexusTalk.lookup('nest.nexustalk.v1.TalkbackBegin').decode(payload).toJSON();
-      this?.log?.debug && this.log.debug('Talkback started on "%s"', decodedMessage.deviceId);
+      this?.log?.debug && this.log.debug('Talkback started to uuid "%s" with id of "%s"', this.uuid, decodedMessage.deviceId);
     }
   }
 
@@ -451,7 +457,7 @@ export default class NexusTalk extends Streamer {
     // Decode talk end packet
     if (typeof payload === 'object' && this.#protobufNexusTalk !== undefined) {
       let decodedMessage = this.#protobufNexusTalk.lookup('nest.nexustalk.v1.TalkbackEnd').decode(payload).toJSON();
-      this?.log?.debug && this.log.debug('Talkback ended on "%s"', decodedMessage.device_id);
+      this?.log?.debug && this.log.debug('Talkback ended from uuid "%s" with id of "%s"', this.uuid, decodedMessage.deviceId);
     }
   }
 

package/dist/streamer.js

@@ -8,12 +8,12 @@
 //
 // The following functions should be overriden in your class which extends this
 //
-// streamer.connect(host)
-// streamer.close(stopStreamFirst)
+// streamer.connect()
+// streamer.close()
 // streamer.talkingAudio(talkingData)
 // streamer.update(deviceData) <- call super after
 //
-// Code version 11/9/2024
+// Code version 13/9/2024
 // Mark Hulskamp
 'use strict';
 
@@ -38,7 +38,6 @@ export default class Streamer {
   videoEnabled = undefined; // Video stream on camera enabled or not
   audioEnabled = undefined; // Audio from camera enabled or not
   online = undefined; // Camera online or not
-  host = ''; // Host to connect to or connected too
   uuid = undefined; // UUID of the device connecting
   connected = false; // Streamer connected to endpoint
 
@@ -152,11 +151,9 @@ export default class Streamer {
   startBuffering() {
     if (this.#outputs?.buffer === undefined) {
       // No active buffer session, start connection to streamer
-      if (this.connected === false && typeof this.host === 'string' && this.host !== '') {
-        if (typeof this.connect === 'function') {
-          this?.log?.debug && this.log.debug('Started buffering from "%s"', this.host);
-          this.connect(this.host);
-        }
+      if (this.connected === false && typeof this.connect === 'function') {
+        this?.log?.debug && this.log.debug('Started buffering for uuid "%s"', this.uuid);
+        this.connect();
       }
 
       this.#outputs.buffer = {
@@ -201,11 +198,9 @@ export default class Streamer {
       });
     }
 
-    if (this.connected === false && typeof this.host === 'string' && this.host !== '') {
-      // We do not have an active socket connection, so startup connection to host
-      if (typeof this.connect === 'function') {
-        this.connect(this.host);
-      }
+    if (this.connected === false && typeof this.connect === 'function') {
+      // We do not have an active connection, so startup connection
+      this.connect();
     }
 
     // Add video/audio streams for our output loop to handle outputting to
@@ -220,8 +215,8 @@ export default class Streamer {
     // finally, we've started live stream
     this?.log?.debug &&
       this.log.debug(
-        'Started live stream from "%s" %s "%s"',
-        this.host,
+        'Started live stream from uuid "%s" %s "%s"',
+        this.uuid,
         talkbackStream !== null && typeof talkbackStream === 'object' ? 'with two-way audio and sesssion id of' : 'and sesssion id of',
         sessionID,
       );
@@ -241,11 +236,9 @@ export default class Streamer {
       });
     }
 
-    if (this.connected === false && typeof this.host === 'string' && this.host !== '') {
-      // We do not have an active socket connection, so startup connection to host
-      if (typeof this.connect === 'function') {
-        this.connect(this.host);
-      }
+    if (this.connected === false && typeof this.connect === 'function') {
+      // We do not have an active connection, so startup connection
+      this.connect();
     }
 
     // Add video/audio streams for our output loop to handle outputting to
@@ -258,44 +251,44 @@ export default class Streamer {
     };
 
     // Finally we've started the recording stream
-    this?.log?.debug && this.log.debug('Started recording stream from "%s" with sesison id of "%s"', this.host, sessionID);
+    this?.log?.debug && this.log.debug('Started recording stream from uuid "%s" with sesison id of "%s"', this.uuid, sessionID);
   }
 
   stopRecordStream(sessionID) {
     // Request to stop a recording stream
-    if (typeof this.#outputs[sessionID] === 'object') {
-      this?.log?.debug && this.log.debug('Stopped recording stream from "%s"', this.host);
+    if (this.#outputs?.[sessionID] !== undefined) {
+      this?.log?.debug && this.log.debug('Stopped recording stream from uuid "%s"', this.uuid);
       delete this.#outputs[sessionID];
     }
 
-    // If we have no more output streams active, we'll close the connection to host
+    // If we have no more output streams active, we'll close the connection
     if (Object.keys(this.#outputs).length === 0 && typeof this.close === 'function') {
-      this.close(true);
+      this.close();
     }
   }
 
   stopLiveStream(sessionID) {
     // Request to stop an active live stream
-    if (typeof this.#outputs[sessionID] === 'object') {
-      this?.log?.debug && this.log.debug('Stopped live stream from "%s"', this.host);
+    if (this.#outputs?.[sessionID] !== undefined) {
+      this?.log?.debug && this.log.debug('Stopped live stream from uuid "%s"', this.uuid);
       delete this.#outputs[sessionID];
     }
 
-    // If we have no more output streams active, we'll close the connection to host
+    // If we have no more output streams active, we'll close the connection
     if (Object.keys(this.#outputs).length === 0 && typeof this.close === 'function') {
-      this.close(true);
+      this.close();
     }
   }
 
   stopBuffering() {
     if (this.#outputs?.buffer !== undefined) {
-      this?.log?.debug && this.log.debug('Stopped buffering from "%s"', this.host);
+      this?.log?.debug && this.log.debug('Stopped buffering from uuid "%s"', this.uuid);
       delete this.#outputs.buffer;
     }
 
-    // If we have no more output streams active, we'll close the connection to host
+    // If we have no more output streams active, we'll close the connection
     if (Object.keys(this.#outputs).length === 0 && typeof this.close === 'function') {
-      this.close(true);
+      this.close();
     }
   }
 
@@ -304,11 +297,6 @@ export default class Streamer {
       return;
     }
 
-    if (this.host !== deviceData.streaming_host) {
-      this.host = deviceData.streaming_host;
-      this?.log?.debug && this.log.debug('New streaming host has been requested for connection. Host requested is "%s"', this.host);
-    }
-
     if (
       this.online !== deviceData.online ||
       this.videoEnabled !== deviceData.streaming_enabled ||
@@ -319,10 +307,10 @@ export default class Streamer {
       this.videoEnabled = deviceData?.streaming_enabled === true;
       this.audioEnabled = deviceData?.audio_enabled === true;
       if ((this.online === false || this.videoEnabled === false || this.audioEnabled === false) && typeof this.close === 'function') {
-        this.close(true); // as offline or streaming not enabled, close socket
+        this.close(); // as offline or streaming not enabled, close streamer
       }
       if (this.online === true && this.videoEnabled === true && typeof this.connect === 'function') {
-        this.connect(this.host); // Connect to host for stream
+        this.connect(); // Connect for stream
       }
     }
   }

package/package.json

@@ -2,7 +2,7 @@
     "displayName": "Nest Accfactory",
     "name": "homebridge-nest-accfactory",
     "homepage": "https://github.com/n0rt0nthec4t/homebridge-nest-accfactory",
-    "version": "0.0.5",
+    "version": "0.0.6",
     "description": "Homebridge support for Nest/Google devices including HomeKit Secure Video (HKSV) support for doorbells and cameras",
     "license": "Apache-2.0",
     "author": "n0rt0nthec4t",