homebridge-withings-environment-data 0.3.3 → 1.1.0

package/CHANGELOG.md

@@ -0,0 +1,106 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+## [1.1.0] - 2026-07-27
+
+### Added
+- Air Quality threshold config fields (`airQualityExcellentMaxPpm`,
+  `airQualityGoodMaxPpm`, `airQualityFairMaxPpm`,
+  `airQualityInferiorMaxPpm`) to make the AirQualitySensor's ppm
+  boundaries configurable instead of hardcoded
+
+### Changed
+- ntfy notifications for an authentication failure now use a fixed,
+  generic message instead of the raw internal error text; other poll
+  failures still send the raw error message. The Homebridge log still
+  always shows the detailed error either way.
+
+## [1.0.0] - 2026-07-26
+
+### Changed
+- README's license/changelog links now point to full GitHub URLs instead
+  of relative paths
+- package.json now sets `author`, `homepage`, `bugs`, and `repository`, and
+  includes README/LICENSE/CHANGELOG in `files`
+
+## [0.3.3] - 2026-07-26
+
+### Added
+- CHANGELOG.md (this file)
+
+### Changed
+- README restructured to match project conventions (versioned title,
+  Requirements/Usage sections, license/changelog links, Configuration/How
+  authentication works/When it stops working/Getting the trust cookie
+  nested under Usage)
+
+### Fixed
+- LICENSE copyright name typo
+
+## [0.3.2] - 2026-07-26
+
+### Fixed
+- Removed an inaccurate claim from the ntfy notification body about the
+  Home app continuing to show the last known reading
+
+## [0.3.1] - 2026-07-25
+
+### Added
+- Optional `ntfyTopic` config field: sends a push notification via
+  ntfy.sh the first time a poll fails, not repeated on every failure in
+  the same streak
+
+### Changed
+- Broadened package.json keywords for discoverability
+- Simplified the README's authentication section wording
+
+## [0.2.0] - 2026-07-25
+
+### Added
+- CO2/AirQuality/Temperature characteristics now use `onGet` handlers
+  backed by a cached last-known reading; the Home app shows "No Response"
+  once consecutive failures exceed a configurable threshold
+  (`noResponseAfterMissedPolls`, default 2, minimum 0), instead of relying
+  on `StatusFault`, which isn't reliably surfaced by the stock Home app
+
+### Changed
+- Replaced per-poll email/password login with a long-lived `session_key`
+  reused across polls and persisted across Homebridge restarts, falling
+  back to a full login only when that session actually expires (fixes an
+  account lockout caused by logging in fresh every 30 minutes)
+
+## [0.1.5] - 2026-07-23
+
+### Changed
+- Replaced `.npmignore` with an explicit `"files"` whitelist in
+  package.json
+
+## [0.1.4] - 2026-07-23
+
+### Added
+- `.npmignore` to keep editor/session folders and repo-only files out of
+  the published npm package
+
+## [0.1.3] - 2026-07-23
+
+### Added
+- Homebridge platform plugin exposing CO2 (CarbonDioxideSensor +
+  AirQualitySensor) and room temperature (TemperatureSensor) as HomeKit
+  sensors, replacing the standalone scraper script
+- Config UI based configuration instead of a `.env` file
+
+### Changed
+- Simplified required config: dropped `w_uuid`, `deviceId`, `userId`, and
+  `appliver`; device/user IDs are now auto-discovered after login
+- README cleaned up: deduplicated trust-cookie capture instructions,
+  added a plain-text credential storage warning, updated install
+  instructions for npm
+
+### Fixed
+- Corrected the real "trusted device" marker to the `2fa_token_<hash>`
+  cookie instead of `w_uuid`

package/README.md

@@ -1,4 +1,4 @@
-# Homebridge Withings Environment Data v0.3.3
+# Homebridge Withings Environment Data v1.1.0
 
 **This Homebridge plugin has been 100% vibe coded with Claude.**
 
@@ -41,7 +41,8 @@ accessory:
 - **CarbonDioxideSensor**: precise CO2 level in ppm, plus a normal/abnormal
   detected alert based on a configurable threshold.
 - **AirQualitySensor**: the same CO2 reading mapped to HomeKit's
-  Excellent/Good/Fair/Inferior/Poor category.
+  Excellent/Good/Fair/Inferior/Poor category, based on configurable ppm
+  thresholds.
 - **TemperatureSensor**: room temperature in °C.
 
 These appear automatically in the Home app after Homebridge restarts, no
@@ -68,6 +69,9 @@ Fields:
   matching the scale's own upload cadence).
 - **CO2 Detected Threshold (ppm)**: ppm above which the CarbonDioxideSensor
   reports "abnormal" (default 1000).
+- **Air Quality: Excellent/Good/Fair/Inferior below (ppm)**: the four ppm
+  boundaries the AirQualitySensor category is based on (defaults 800, 1000,
+  1500, 2000).
 - **ntfy Topic (optional)**: if set, sends a push notification via
   [ntfy.sh](https://ntfy.sh) to this topic the first time a poll fails
   (not repeated on every subsequent failure in the same streak; only once
@@ -126,5 +130,5 @@ it once via DevTools:
 
 ## License and changelog
 
-- [LICENSE](LICENSE)
-- [CHANGELOG](CHANGELOG.md)
+- [LICENSE](https://github.com/LuudJacobs/homebridge-withings-environment-data/blob/main/LICENSE)
+- [CHANGELOG](https://github.com/LuudJacobs/homebridge-withings-environment-data/blob/main/CHANGELOG.md)

package/config.schema.json

@@ -49,6 +49,34 @@
         "default": 1000,
         "minimum": 400
       },
+      "airQualityExcellentMaxPpm": {
+        "title": "Air Quality: Excellent below (ppm)",
+        "type": "integer",
+        "default": 800,
+        "minimum": 1,
+        "description": "CO2 readings below this are reported as Excellent air quality."
+      },
+      "airQualityGoodMaxPpm": {
+        "title": "Air Quality: Good below (ppm)",
+        "type": "integer",
+        "default": 1000,
+        "minimum": 1,
+        "description": "CO2 readings below this are reported as Good."
+      },
+      "airQualityFairMaxPpm": {
+        "title": "Air Quality: Fair below (ppm)",
+        "type": "integer",
+        "default": 1500,
+        "minimum": 1,
+        "description": "CO2 readings below this are reported as Fair."
+      },
+      "airQualityInferiorMaxPpm": {
+        "title": "Air Quality: Inferior below (ppm)",
+        "type": "integer",
+        "default": 2000,
+        "minimum": 1,
+        "description": "CO2 readings below this are reported as Inferior. Anything above is reported as Poor."
+      },
       "noResponseAfterMissedPolls": {
         "title": "No Response After Missed Polls",
         "type": "integer",

package/index.js

@@ -63,11 +63,11 @@ async function fetchLatest({ cookieHeader, sessionToken, deviceId, userId }) {
   };
 }
 
-function mapCo2ToAirQuality(ppm, AirQuality) {
-  if (ppm < 800) return AirQuality.EXCELLENT;
-  if (ppm < 1000) return AirQuality.GOOD;
-  if (ppm < 1500) return AirQuality.FAIR;
-  if (ppm < 2000) return AirQuality.INFERIOR;
+function mapCo2ToAirQuality(ppm, AirQuality, thresholds) {
+  if (ppm < thresholds.excellentMaxPpm) return AirQuality.EXCELLENT;
+  if (ppm < thresholds.goodMaxPpm) return AirQuality.GOOD;
+  if (ppm < thresholds.fairMaxPpm) return AirQuality.FAIR;
+  if (ppm < thresholds.inferiorMaxPpm) return AirQuality.INFERIOR;
   return AirQuality.POOR;
 }
 
@@ -216,7 +216,13 @@ class WithingsEnvironmentDataPlatform {
 
   async poll() {
     try {
-      const { cookieHeader, sessionToken } = await this.authenticate();
+      let cookieHeader, sessionToken;
+      try {
+        ({ cookieHeader, sessionToken } = await this.authenticate());
+      } catch (err) {
+        err.isAuthFailure = true;
+        throw err;
+      }
 
       if (!this.deviceId || !this.userId) {
         const discovered = await discoverDevice(cookieHeader);
@@ -252,7 +258,10 @@ class WithingsEnvironmentDataPlatform {
 
       if (!this.hasNotifiedFailure) {
         this.hasNotifiedFailure = true;
-        await this.sendNtfyNotification(err.message);
+        const notificationMessage = err.isAuthFailure
+          ? 'Authentication for Withings account failed. Check the Homebridge logs for details.'
+          : err.message;
+        await this.sendNtfyNotification(notificationMessage);
       }
     }
   }
@@ -282,6 +291,19 @@ class WithingsEnvironmentDataPlatform {
     return Number.isFinite(threshold) && threshold >= 0 ? threshold : 2;
   }
 
+  getAirQualityThresholds() {
+    const excellentMaxPpm = Number(this.config.airQualityExcellentMaxPpm);
+    const goodMaxPpm = Number(this.config.airQualityGoodMaxPpm);
+    const fairMaxPpm = Number(this.config.airQualityFairMaxPpm);
+    const inferiorMaxPpm = Number(this.config.airQualityInferiorMaxPpm);
+    return {
+      excellentMaxPpm: Number.isFinite(excellentMaxPpm) && excellentMaxPpm > 0 ? excellentMaxPpm : 800,
+      goodMaxPpm: Number.isFinite(goodMaxPpm) && goodMaxPpm > 0 ? goodMaxPpm : 1000,
+      fairMaxPpm: Number.isFinite(fairMaxPpm) && fairMaxPpm > 0 ? fairMaxPpm : 1500,
+      inferiorMaxPpm: Number.isFinite(inferiorMaxPpm) && inferiorMaxPpm > 0 ? inferiorMaxPpm : 2000,
+    };
+  }
+
   isStale() {
     return !this.hasEverSucceeded || this.missedCycles > this.getNoResponseThreshold();
   }
@@ -306,7 +328,7 @@ class WithingsEnvironmentDataPlatform {
 
   getAirQualityOrThrow() {
     this.throwIfStale();
-    return mapCo2ToAirQuality(this.lastReading.co2, this.Characteristic.AirQuality);
+    return mapCo2ToAirQuality(this.lastReading.co2, this.Characteristic.AirQuality, this.getAirQualityThresholds());
   }
 
   getTemperatureOrThrow() {

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "homebridge-withings-environment-data",
-  "version": "0.3.3",
+  "version": "1.1.0",
   "description": "Homebridge plugin exposing ambient CO2/air-quality and room temperature readings from a Withings WS-50 scale as HomeKit sensors",
   "main": "index.js",
   "files": [
     "index.js",
     "lib",
-    "config.schema.json"
+    "config.schema.json",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
   ],
   "keywords": [
     "homebridge-plugin",
@@ -18,9 +21,18 @@
     "air-quality",
     "homekit"
   ],
+  "author": "Luud Jacobs",
+  "license": "MIT",
+  "homepage": "https://github.com/LuudJacobs/homebridge-withings-environment-data#readme",
+  "bugs": {
+    "url": "https://github.com/LuudJacobs/homebridge-withings-environment-data/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/LuudJacobs/homebridge-withings-environment-data.git"
+  },
   "engines": {
     "homebridge": ">=1.6.0",
     "node": ">=18"
-  },
-  "license": "MIT"
+  }
 }