homebridge-nest-accfactory 0.3.4 → 0.3.5

package/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 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.3.5 (2025/11/21)
+
+- General code cleanup and stability improvements
+- Fixed battery level reporting for Nest Thermostat (2020) 
+- Updated instructions for obtaining access token for Nest accounts
+- Updated instructions for obtaining issue token and cookie for Google accounts  
+- Updated disclaimer in `README.md` to clarify support for official Homebridge installations only
+- Added debug logging for thermostat mode and temperature changes received from outside of HomeKit [@MorelloCherry](https://github.com/MorelloCherry)
+
+### Known Issues
+
+- The ip npm package has a known security advisory [GHSA-2p57-rm9w-gvfp](https://github.com/advisories/GHSA-2p57-rm9w-gvfp); this is used indirectly via the werift library
+
 ## v0.3.4 (2025/10/17)
 
 - General code cleanup and stability improvements  
@@ -12,6 +25,10 @@ All notable changes to `homebridge-nest-accfactory` will be documented in this f
 - Fixed periodic camera snapshots when camera is turned off
 - Updated camera resource assets
 
+### Known Issues
+
+- The ip npm package has a known security advisory [GHSA-2p57-rm9w-gvfp](https://github.com/advisories/GHSA-2p57-rm9w-gvfp); this is used indirectly via the werift library
+
 ## v0.3.3 (2025/08/23)
 
 - Refined timeout warnings for camera and doorbell snapshot capture  

package/README.md

@@ -36,32 +36,35 @@ The accessory supports connection to Nest using a Nest account AND/OR a Google (
 
 ### Nest Account
 
-If you have a Nest account, you will need to obtain an access token from the Nest web app. Simply go to https://home.nest.com in your browser and log in. Once that's done, go to https://home.nest.com/session in your browser, and you will see a long string that looks like this:
+If you have a **Nest Account**, you’ll need to obtain an **access token** from the Nest web app.
 
-{"2fa_state":"enrolled","access_token":"XXX", ...}
+1. Go to [home.nest.com](https://home.nest.com) and click **Sign in with Nest**.  
+2. After logging in, open [home.nest.com/session](https://home.nest.com/session).  
+3. You’ll see a JSON string similar to:  
+   ```json
+   {"2fa_state":"enrolled","access_token":"XXX", ...}
+4. Copy the value of **access_token** near the start (a long string beginning with `b`) and paste it into your Homebridge configuration.  
+   - Ignore any other `access_token` entries further down the string.
 
-The value of "access_token" near the start of the string (the XXX) (a long sequence of letters, numbers and punctuation beginning with b) can be entered into the plugin-configuration within Homebridge
+**Note:** Do **not** log out of [home.nest.com](https://home.nest.com), as this will invalidate your credentials.
 
-There may be other keys labelled access_token further along in the string - please ignore these.
+### Obtaining a Google cookie token for a Google Account (Safari)
 
-**Do not log out of home.nest.com, as this will invalidate your credentials. Just close the browser tab**
+Google Accounts require an **"issueToken"** and **"cookie"**, which are unique to your account. You only need to do this once as long as you stay logged into your Google Account.
 
-### Obtaining a Google cookie token for a Google Account
+1. Open Safari in a **Private Window**  
+2. Enable the **Develop Menu** (Safari ▸ Settings ▸ Advanced ▸ check *Show Develop menu in menu bar*)  
+3. Open **Develop ▸ Show Web Inspector**, then select the **Network** tab  
+4. Ensure **Preserve Log** is checked  
+5. In the filter box, type **issueToken**  
+6. Go to [home.nest.com](https://home.nest.com) and click **Sign in with Google**  
+7. After login, click the **iframerpc** network request  
+8. In **Headers**, copy:  
+   - **Request URL** - this is your **Issue Token**  
+   - **cookie:** value under *Request Headers* - this is your **Cookie**  
+9. Enter both into your Homebridge configuration  
 
-Google Accounts require an "issueToken" and "cookie". The values of "issueToken" and "cookie" are specific to your Google Account. To get them, follow these steps (only needs to be done once, as long as you stay logged into your Google Account).
-
-1. Open a Chrome browser tab in Incognito Mode
-2. Open Developer Tools (View/Developer/Developer Tools).
-3. Click on 'Network' tab. Make sure 'Preserve Log' is checked.
-4. In the 'Filter' box, enter issueToken
-5. Go to home.nest.com, and click 'Sign in with Google'. Log into your account.
-6. One network call (beginning with iframerpc) will appear in the Dev Tools window. Click on it.
-7. In the Headers tab, under General, copy the entire Request URL (beginning with https://accounts.google.com). This is your "Issue Token" which can be entered into the plugin-configuration within Homebridge.
-8. In the 'Filter' box, enter oauth2/iframe
-9. Several network calls will appear in the Dev Tools window. Click on the last iframe call.
-10. In the Headers tab, under Request Headers, copy the entire cookie (include the whole string which is several lines long and has many field/value pairs - do not include the cookie: name). This is your "Cookie" which can be entered into the plugin-configuration within Homebridge.
-
-**Do not log out of home.nest.com, as this will invalidate your credentials. Just close the browser tab**
+**Note:** Do **not** log out of [home.nest.com](https://home.nest.com), as this will invalidate your credentials.
 
 ## config.json configuration
 
@@ -154,4 +157,9 @@ By default, we look in /usr/local/bin for an ffmpeg binary, however, you can spe
 
 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.
 
-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
+This plugin is only supported when used with **official Homebridge installations**.  
+Other platforms or forks such as **HOOBS**, **Home Assistant**, or similar derivatives are **not officially supported** and may not function as intended.
+
+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 encounter a problem with the source code, please [raise an issue](https://github.com/n0rt0nthec4t/homebridge-nest-accfactory/issues) on the project's **GitHub repository** so it can be reviewed and investigated.

package/dist/config.js

@@ -1,7 +1,7 @@
 // Configuration validation and processing
 // Part of homebridge-nest-accfactory
 //
-// Code version 2025.09.08
+// Code version 2025.10.21
 // Mark Hulskamp
 'use strict';
 
@@ -27,7 +27,7 @@ function processConfig(config, log) {
       ? Number(config.options.elevation)
       : 0;
 
-  // Controls what APIs we use, default is to use both Nest and protobuf APIs
+  // Controls what APIs we use, default is to use both Nest and Google APIs
   options.useNestAPI = config.options?.useNestAPI === true || config.options?.useNestAPI === undefined;
   options.useGoogleAPI = config.options?.useGoogleAPI === true || config.options?.useGoogleAPI === undefined;
 
@@ -143,15 +143,15 @@ function buildConnections(config) {
   Object.keys(config).forEach((key) => {
     let section = config[key];
 
-    if (typeof section?.access_token === 'string' && section.access_token !== '') {
+    if (typeof section?.access_token === 'string' && section.access_token.trim() !== '') {
       let fieldTest = section?.fieldTest === true;
       connections[crypto.randomUUID()] = {
         name: key,
         type: ACCOUNT_TYPE.NEST,
         authorised: false,
         allowRetry: true,
-        access_token: section.access_token,
-        fieldTest,
+        access_token: section.access_token.trim(),
+        fieldTest: fieldTest,
         referer: fieldTest ? 'home.ft.nest.com' : 'home.nest.com',
         restAPIHost: fieldTest ? 'home.ft.nest.com' : 'home.nest.com',
         cameraAPIHost: fieldTest ? 'camera.home.ft.nest.com' : 'camera.home.nest.com',
@@ -161,9 +161,9 @@ function buildConnections(config) {
 
     if (
       typeof section?.issuetoken === 'string' &&
-      section.issuetoken !== '' &&
+      section.issuetoken.trim() !== '' &&
       typeof section?.cookie === 'string' &&
-      section.cookie !== ''
+      section.cookie.trim() !== ''
     ) {
       let fieldTest = section?.fieldTest === true;
       connections[crypto.randomUUID()] = {
@@ -171,9 +171,9 @@ function buildConnections(config) {
         type: ACCOUNT_TYPE.GOOGLE,
         authorised: false,
         allowRetry: true,
-        issuetoken: section.issuetoken,
-        cookie: section.cookie,
-        fieldTest,
+        issuetoken: section.issuetoken.trim(),
+        cookie: section.cookie.trim(),
+        fieldTest: fieldTest,
         referer: fieldTest ? 'home.ft.nest.com' : 'home.nest.com',
         restAPIHost: fieldTest ? 'home.ft.nest.com' : 'home.nest.com',
         cameraAPIHost: fieldTest ? 'camera.home.ft.nest.com' : 'camera.home.nest.com',

package/dist/plugins/thermostat.js

@@ -28,7 +28,7 @@ import {
 
 export default class NestThermostat extends HomeKitDevice {
   static TYPE = 'Thermostat';
-  static VERSION = '2025.09.08'; // Code version
+  static VERSION = '2025.11.20'; // Code version
 
   thermostatService = undefined;
   batteryService = undefined;
@@ -263,6 +263,7 @@ export default class NestThermostat extends HomeKitDevice {
     this.accessory.removeService(this.humidityService);
     this.accessory.removeService(this.fanService);
     this.accessory.removeService(this.dehumidifierService);
+    this.accessory.removeService(this.humidifierService);
     this.thermostatService = undefined;
     this.batteryService = undefined;
     this.occupancyService = undefined;
@@ -434,7 +435,31 @@ export default class NestThermostat extends HomeKitDevice {
       this?.log?.info?.('Heating/cooling setup on thermostat on "%s" has changed', deviceData.description);
     }
 
-    // Update current mode temperatures
+    // Update current mode, temperatures and log any changes
+    if (deviceData.target_temperature_low !== this.deviceData.target_temperature_low) {
+      this.#logTemperatureChange(
+        'Thermostat',
+        'heating',
+        deviceData.target_temperature_low,
+        deviceData.hvac_mode?.toUpperCase?.().includes('ECO') === true,
+        deviceData.temperature_scale?.toUpperCase?.() === 'F' ? 'F' : 'C',
+      );
+    }
+
+    if (deviceData.target_temperature_high !== this.deviceData.target_temperature_high) {
+      this.#logTemperatureChange(
+        'Thermostat',
+        'cooling',
+        deviceData.target_temperature_high,
+        deviceData.hvac_mode?.toUpperCase?.().includes('ECO') === true,
+        deviceData.temperature_scale?.toUpperCase?.() === 'F' ? 'F' : 'C',
+      );
+    }
+
+    if (deviceData.hvac_mode.toUpperCase() !== this.deviceData.hvac_mode.toUpperCase()) {
+      this.#logModeChange('Thermostat', deviceData.hvac_mode);
+    }
+
     if (
       deviceData.can_heat === true &&
       (deviceData.hvac_mode.toUpperCase() === 'HEAT' || deviceData.hvac_mode.toUpperCase() === 'ECOHEAT')
@@ -786,7 +811,7 @@ export default class NestThermostat extends HomeKitDevice {
     this?.log?.info?.('Set temperature units on thermostat "%s" to "%s"', this.deviceData.description, unit === 'C' ? '°C' : '°F');
   }
 
-  setMode(thermostatMode) {
+  async setMode(thermostatMode) {
     if (thermostatMode !== this.thermostatService.getCharacteristic(this.hap.Characteristic.TargetHeatingCoolingState).value) {
       // Work out based on the HomeKit requested mode, what can the thermostat really switch too
       // We may over-ride the requested HomeKit mode
@@ -847,9 +872,9 @@ export default class NestThermostat extends HomeKitDevice {
         mode = 'range';
       }
 
-      this.message(HomeKitDevice.SET, { uuid: this.deviceData.nest_google_uuid, hvac_mode: mode });
+      await this.message(HomeKitDevice.SET, { uuid: this.deviceData.nest_google_uuid, hvac_mode: mode });
 
-      this?.log?.info?.('Set mode on "%s" to "%s"', this.deviceData.description, mode);
+      this.#logModeChange('HomeKit', mode);
     }
   }
 
@@ -877,50 +902,49 @@ export default class NestThermostat extends HomeKitDevice {
     return currentMode;
   }
 
-  setTemperature(characteristic, temperature) {
+  async setTemperature(characteristic, temperature) {
     if (typeof characteristic !== 'function' || typeof characteristic?.UUID !== 'string') {
       return;
     }
 
     let mode = this.thermostatService.getCharacteristic(this.hap.Characteristic.TargetHeatingCoolingState).value;
-    let isEco = this.deviceData.hvac_mode?.toUpperCase?.().includes('ECO') === true;
-    let scale = this.deviceData.temperature_scale?.toUpperCase?.() === 'F' ? 'F' : 'C';
-    let tempDisplay = (scale === 'F' ? (temperature * 9) / 5 + 32 : temperature).toFixed(1);
-    let tempUnit = scale === 'F' ? '°F' : '°C';
-    let ecoPrefix = isEco ? 'eco mode ' : '';
-
     let targetKey = undefined;
     let modeLabel = '';
 
     if (
       characteristic.UUID === this.hap.Characteristic.TargetTemperature.UUID &&
-      mode !== this.hap.Characteristic.TargetHeatingCoolingState.AUTO
+      mode === this.hap.Characteristic.TargetHeatingCoolingState.HEAT
     ) {
-      targetKey = 'target_temperature';
-      modeLabel = mode === this.hap.Characteristic.TargetHeatingCoolingState.HEAT ? 'heating' : 'cooling';
+      targetKey = 'target_temperature_low';
+      modeLabel = 'heating';
+    } else if (
+      characteristic.UUID === this.hap.Characteristic.TargetTemperature.UUID &&
+      mode === this.hap.Characteristic.TargetHeatingCoolingState.COOL
+    ) {
+      targetKey = 'target_temperature_high';
+      modeLabel = 'cooling';
     } else if (
       characteristic.UUID === this.hap.Characteristic.HeatingThresholdTemperature.UUID &&
-      mode === this.hap.Characteristic.TargetHeatingCoolingState.AUTO
+      (mode === this.hap.Characteristic.TargetHeatingCoolingState.HEAT || mode === this.hap.Characteristic.TargetHeatingCoolingState.AUTO)
     ) {
       targetKey = 'target_temperature_low';
       modeLabel = 'heating';
     } else if (
       characteristic.UUID === this.hap.Characteristic.CoolingThresholdTemperature.UUID &&
-      mode === this.hap.Characteristic.TargetHeatingCoolingState.AUTO
+      (mode === this.hap.Characteristic.TargetHeatingCoolingState.COOL || mode === this.hap.Characteristic.TargetHeatingCoolingState.AUTO)
     ) {
       targetKey = 'target_temperature_high';
       modeLabel = 'cooling';
     }
 
     if (targetKey !== undefined) {
-      this.message(HomeKitDevice.SET, { uuid: this.deviceData.nest_google_uuid, [targetKey]: temperature });
-      this?.log?.info?.(
-        'Set %s%s temperature on "%s" to "%s %s"',
-        ecoPrefix,
+      await this.message(HomeKitDevice.SET, { uuid: this.deviceData.nest_google_uuid, [targetKey]: temperature });
+      this.#logTemperatureChange(
+        'HomeKit',
         modeLabel,
-        this.deviceData.description,
-        tempDisplay,
-        tempUnit,
+        temperature,
+        this.deviceData.hvac_mode?.toUpperCase?.().includes('ECO') === true,
+        this.deviceData.temperature_scale?.toUpperCase?.() === 'F' ? 'F' : 'C',
       );
     }
 
@@ -1077,6 +1101,62 @@ export default class NestThermostat extends HomeKitDevice {
 
     return loadedModule;
   }
+
+  #logTemperatureChange(source, modeLabel, temperature, isEco, scale) {
+    if (typeof temperature !== 'number') {
+      return;
+    }
+
+    let unitScale = typeof scale === 'string' ? scale.toUpperCase() : this.deviceData.temperature_scale?.toUpperCase?.();
+    let isFahrenheit = unitScale === 'F';
+    let tempDisplay = (isFahrenheit ? (temperature * 9) / 5 + 32 : temperature).toFixed(1);
+    let tempUnit = isFahrenheit ? '°F' : '°C';
+    let ecoPrefix = isEco === true ? 'eco mode ' : '';
+
+    modeLabel = modeLabel.charAt(0).toUpperCase() + modeLabel.slice(1).toLowerCase();
+
+    if (source === 'Thermostat') {
+      this?.log?.debug?.(
+        '%s%s temperature on "%s" changed to "%s %s"',
+        ecoPrefix,
+        modeLabel,
+        this.deviceData.description,
+        tempDisplay,
+        tempUnit,
+      );
+    } else {
+      this?.log?.info?.(
+        'Set %s%s temperature on "%s" to "%s %s"',
+        ecoPrefix,
+        modeLabel,
+        this.deviceData.description,
+        tempDisplay,
+        tempUnit,
+      );
+    }
+  }
+
+  #logModeChange(source, modeLabel) {
+    if (typeof modeLabel !== 'string' || modeLabel.trim() === '') {
+      return;
+    }
+
+    modeLabel = modeLabel.charAt(0).toUpperCase() + modeLabel.slice(1).toLowerCase();
+
+    if (source === 'Thermostat') {
+      this?.log?.debug?.(
+        'Mode on "%s" changed to "%s"',
+        this.deviceData.description,
+        modeLabel.toLowerCase().includes('range') === true ? 'Heat/Cool' : modeLabel,
+      );
+    } else {
+      this?.log?.info?.(
+        'Set mode on "%s" to "%s"',
+        this.deviceData.description,
+        modeLabel.toLowerCase().includes('range') === true ? 'Heat/Cool' : modeLabel,
+      );
+    }
+  }
 }
 
 // Function to process our RAW Nest or Google for this device type
@@ -1105,7 +1185,6 @@ export function processRawData(log, rawData, config, deviceType = undefined) {
       data.target_temperature = adjustTemperature(data.target_temperature, 'C', 'C', true);
       data.backplate_temperature = adjustTemperature(data.backplate_temperature, 'C', 'C', true);
       data.current_temperature = adjustTemperature(data.current_temperature, 'C', 'C', true);
-      data.battery_level = scaleValue(data.battery_level, 3.6, 3.9, 0, 100);
 
       processed = data;
       // eslint-disable-next-line no-unused-vars
@@ -1182,7 +1261,24 @@ export function processRawData(log, rawData, config, deviceType = undefined) {
             Array.isArray(value.value?.display?.thermostatState) === true && value.value.display.thermostatState.includes('bpd') === true;
           RESTTypeData.backplate_temperature = parseFloat(value.value.backplate_temperature.temperatureValue.temperature.value);
           RESTTypeData.current_temperature = parseFloat(value.value.current_temperature.temperatureValue.temperature.value);
-          RESTTypeData.battery_level = parseFloat(value.value.battery_voltage.batteryValue.batteryVoltage.value);
+          if (value.value.device_info.typeName === 'google.resource.GoogleZirconium1Resource') {
+            // Lower battery voltages for the "2020" mirror thermostat. Levels are a "guestimate" :-)
+            RESTTypeData.battery_level = scaleValue(
+              parseFloat(value.value.battery_voltage.batteryValue.batteryVoltage.value),
+              2.9,
+              3.15,
+              0,
+              100,
+            );
+          } else {
+            RESTTypeData.battery_level = scaleValue(
+              parseFloat(value.value.battery_voltage.batteryValue.batteryVoltage.value),
+              3.6,
+              3.9,
+              0,
+              100,
+            );
+          }
           RESTTypeData.online = value.value?.liveness?.status === 'LIVENESS_DEVICE_STATUS_ONLINE';
           RESTTypeData.leaf = value.value?.leaf?.active === true;
           RESTTypeData.can_cool =
@@ -1404,7 +1500,7 @@ export function processRawData(log, rawData, config, deviceType = undefined) {
           RESTTypeData.removed_from_base = value.value.nlclient_state.toUpperCase() === 'BPD';
           RESTTypeData.backplate_temperature = value.value.backplate_temperature;
           RESTTypeData.current_temperature = value.value.backplate_temperature;
-          RESTTypeData.battery_level = value.value.battery_level;
+          RESTTypeData.battery_level = scaleValue(value.value.battery_level, 3.6, 3.9, 0, 100);
           RESTTypeData.online = rawData?.['track.' + value.value.serial_number]?.value?.online === true;
           RESTTypeData.leaf = value.value.leaf === true;
           RESTTypeData.has_humidifier = value.value.has_humidifier === true;

package/package.json

@@ -2,7 +2,7 @@
     "name": "homebridge-nest-accfactory",
     "displayName": "Nest Accfactory",
     "type": "module",
-    "version": "0.3.4",
+    "version": "0.3.5",
     "description": "Homebridge support for Nest/Google devices including HomeKit Secure Video (HKSV) support for doorbells and cameras",
     "author": "n0rt0nthec4t",
     "license": "Apache-2.0",
@@ -36,8 +36,8 @@
     ],
     "main": "dist/index.js",
     "engines": {
-        "node": "^20.19.0 || ^22.12.0 || ^24.0.0",
-        "homebridge": "^1.8.0 || ^2.0.0-beta.0"
+        "node": "^20 || ^22 || ^24",
+        "homebridge": "^1.11.1 || ^2.0.0-beta.0"
     },
     "files": [
         "LICENSE",
@@ -54,16 +54,16 @@
         "prepublishOnly": "npm run lint && npm run build"
     },
     "devDependencies": {
-        "@eslint/js": "^9.37.0",
-        "eslint": "^9.37.0",
-        "@stylistic/eslint-plugin": "^5.4.0",
-        "@types/node": "^24.8.1",
-        "@typescript-eslint/parser": "^8.46.1",
+        "@eslint/js": "^9.39.1",
+        "eslint": "^9.39.1",
+        "@stylistic/eslint-plugin": "^5.6.1",
+        "@types/node": "^24.10.1",
+        "@typescript-eslint/parser": "^8.47.0",
         "prettier": "^3.6.2",
         "prettier-eslint": "^16.4.2",
         "copyfiles": "^2.4.1",
-        "rimraf": "^6.0.1",
-        "homebridge": "^2.0.0-beta.0"
+        "rimraf": "^6.1.0",
+        "homebridge": "^1.11.1 || ^2.0.0-beta.0"
     },
     "dependencies": {
         "@evan/opus": "^1.0.3",