homebridge-withings-environment-data 0.2.0 → 0.3.2

package/README.md

@@ -54,14 +54,17 @@ Fields:
   matching the scale's own upload cadence).
 - **CO2 Detected Threshold (ppm)**: ppm above which the CarbonDioxideSensor
   reports "abnormal" (default 1000).
+- **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
+  a poll succeeds again does the next failure trigger a fresh
+  notification). Leave blank to disable.
 
 ## How authentication works
 
-Logging in with email and password on every poll turned out to be a bad
-idea in practice: Withings appears to throttle repeated automated logins
-quite aggressively. Instead, the plugin reuses a long-lived (~1 week)
-`session_key` that Withings' own web app relies on to stay logged in
-without re-entering credentials each time.
+The plugin reuses a long-lived (~1 week) `session_key`, the same
+mechanism Withings' own web app relies on to stay logged in without
+re-entering credentials each time.
 
 That session is cached in a small file in Homebridge's own storage
 directory, `withings-environment-data-session.json`, and reused across

package/config.schema.json

@@ -55,6 +55,11 @@
         "default": 2,
         "minimum": 0,
         "description": "Consecutive failed polls to tolerate (keeping the last known readings) before the Home app shows \"No Response\". 0 means show it immediately on any failure."
+      },
+      "ntfyTopic": {
+        "title": "ntfy Topic (optional)",
+        "type": "string",
+        "description": "If set, sends a push notification via ntfy.sh to this topic the first time a poll fails (not repeated on every subsequent failure in the same streak). Leave blank to disable."
       }
     }
   }

package/index.js

@@ -93,6 +93,9 @@ class WithingsEnvironmentDataPlatform {
     this.hasEverSucceeded = false;
     this.missedCycles = 0;
     this.lastReading = { co2: null, temperature: null };
+    // Only send one ntfy notification per failure streak, not on every
+    // missed poll — reset once a poll succeeds again.
+    this.hasNotifiedFailure = false;
 
     // The long-lived (~1 week) session_key that lets us skip email/password/2FA
     // entirely on most polls — see lib/login.js's resumeSession(). Persisted to
@@ -235,6 +238,7 @@ class WithingsEnvironmentDataPlatform {
       this.applyReading(co2, temperature);
       this.setFault(false);
       this.missedCycles = 0;
+      this.hasNotifiedFailure = false;
     } catch (err) {
       // Deliberately do not touch the value characteristics here — the Home app
       // should keep showing the last known good reading, not go blank, on a
@@ -245,6 +249,26 @@ class WithingsEnvironmentDataPlatform {
       this.missedCycles += 1;
       this.log.error(`Withings poll failed (missed cycle ${this.missedCycles}): ${err.message}`);
       this.setFault(true);
+
+      if (!this.hasNotifiedFailure) {
+        this.hasNotifiedFailure = true;
+        await this.sendNtfyNotification(err.message);
+      }
+    }
+  }
+
+  async sendNtfyNotification(errorMessage) {
+    const topic = this.config.ntfyTopic;
+    if (!topic) return;
+
+    try {
+      await fetch(`https://ntfy.sh/${encodeURIComponent(topic)}`, {
+        method: 'POST',
+        headers: { Title: 'Homebridge: Getting Withings Environment Data Failed!' },
+        body: errorMessage,
+      });
+    } catch (err) {
+      this.log.warn(`Failed to send ntfy notification: ${err.message}`);
     }
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homebridge-withings-environment-data",
-  "version": "0.2.0",
+  "version": "0.3.2",
   "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": [
@@ -9,7 +9,14 @@
     "config.schema.json"
   ],
   "keywords": [
-    "homebridge-plugin"
+    "homebridge-plugin",
+    "withings",
+    "ws-50",
+    "environment-data",
+    "temperature",
+    "co2",
+    "air-quality",
+    "homekit"
   ],
   "engines": {
     "homebridge": ">=1.6.0",