homebridge-octopus-energy 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,58 @@
+# Homebridge Octopus Energy
+
+Homebridge platform plugin that surfaces Octopus Energy SMETS2 import (and optional export) meters into HomeKit. It polls the Octopus public API, converts interval kWh readings into watts, and exposes Eve-style energy characteristics (instantaneous watts and today’s total kWh). Apple Home will show the Outlet accessory; rich energy data appears in Eve, Home+, and other advanced HomeKit apps.
+
+## Requirements
+- Node.js >= 18
+- Homebridge >= 1.7
+- Octopus API key plus MPAN and meter serial(s)
+
+## Installation
+### Homebridge UI X
+1. Open **Config UI X** → **Plugins**.
+2. Search for `homebridge-octopus-energy`.
+3. Install and restart Homebridge.
+
+### npm (global)
+```bash
+npm i -g homebridge-octopus-energy
+```
+
+## Configuration
+Add to `config.json` (or use the UI form powered by `config.schema.json`):
+```json
+{
+  "platform": "OctopusEnergyPlatform",
+  "name": "Octopus Energy",
+  "apiKey": "sk_live_your_key",
+  "pollSeconds": 300,
+  "import": {
+    "name": "Octopus Import",
+    "mpan": "YOUR_IMPORT_MPAN",
+    "meterSerial": "IMPORT_SERIAL"
+  },
+  "export": {
+    "name": "Octopus Export",
+    "mpan": "YOUR_EXPORT_MPAN",
+    "meterSerial": "EXPORT_SERIAL"
+  }
+}
+```
+
+Notes:
+- Import is required; export is optional (requires both MPAN and meter serial).
+- Polls immediately on startup, then every `pollSeconds` (min 60s).
+- Eve characteristics expose live watts and a rolling “today” total (kWh). Apple Home won’t show these values, but Eve/Home+ will.
+
+## What it does
+- Calls the Octopus REST API for electricity consumption.
+- Converts the latest interval kWh to watts; sums today’s intervals for total kWh.
+- Exposes an `Outlet` service for Home visibility plus Eve Energy characteristics for power and total energy.
+- Keeps last values if the API fails and logs warnings instead of crashing.
+
+## Links
+- GitHub: https://github.com/icebondx/homebridge-octopus-energy
+- Issues: https://github.com/icebondx/homebridge-octopus-energy/issues
+
+## License
+MIT

package/config.schema.json

@@ -0,0 +1,71 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "pluginAlias": "OctopusEnergyPlatform",
+  "pluginType": "platform",
+  "singular": false,
+  "schema": {
+    "type": "object",
+    "properties": {
+      "name": {
+        "type": "string",
+        "title": "Platform Name",
+        "default": "Octopus Energy"
+      },
+      "apiKey": {
+        "type": "string",
+        "title": "Octopus API Key",
+        "description": "Create an API key in your Octopus Energy account.",
+        "required": true
+      },
+      "pollSeconds": {
+        "type": "number",
+        "title": "Polling Interval (seconds)",
+        "default": 300,
+        "minimum": 60
+      },
+      "import": {
+        "type": "object",
+        "title": "Import Meter",
+        "properties": {
+          "name": {
+            "type": "string",
+            "title": "Accessory Name",
+            "default": "Octopus Import"
+          },
+          "mpan": {
+            "type": "string",
+            "title": "MPAN",
+            "required": true
+          },
+          "meterSerial": {
+            "type": "string",
+            "title": "Meter Serial",
+            "required": true
+          }
+        },
+        "required": ["mpan", "meterSerial"]
+      },
+      "export": {
+        "type": "object",
+        "title": "Export Meter (optional)",
+        "properties": {
+          "name": {
+            "type": "string",
+            "title": "Accessory Name",
+            "default": "Octopus Export"
+          },
+          "mpan": {
+            "type": "string",
+            "title": "MPAN"
+          },
+          "meterSerial": {
+            "type": "string",
+            "title": "Meter Serial"
+          }
+        }
+      }
+    },
+    "required": ["apiKey", "import"],
+    "additionalProperties": false
+  }
+}

package/dist/accessory.js

@@ -0,0 +1,165 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OctopusMeterAccessory = void 0;
+const node_fetch_1 = __importDefault(require("node-fetch"));
+class OctopusMeterAccessory {
+    constructor(platform, accessory, meter, apiKey, pollSeconds) {
+        this.platform = platform;
+        this.accessory = accessory;
+        this.meter = meter;
+        this.apiKey = apiKey;
+        this.pollSeconds = pollSeconds;
+        this.evePower = null;
+        this.eveTotal = null;
+        this.lastWatts = 0;
+        this.lastTotalKWh = 0;
+        const { Service, Characteristic } = this.platform;
+        const info = this.accessory.getService(Service.AccessoryInformation);
+        info?.setCharacteristic(Characteristic.Manufacturer, 'Octopus Energy');
+        info?.setCharacteristic(Characteristic.Model, `${meter.side.toUpperCase()} meter`);
+        info?.setCharacteristic(Characteristic.SerialNumber, meter.meterSerial);
+        const outlet = this.accessory.getService(Service.Outlet)
+            || this.accessory.addService(Service.Outlet);
+        outlet.setCharacteristic(Characteristic.Name, meter.name);
+        outlet.updateCharacteristic(Characteristic.On, true);
+        outlet.updateCharacteristic(Characteristic.OutletInUse, true);
+        outlet.getCharacteristic(Characteristic.On).onSet(async () => {
+            // This accessory is read-only; keep it "on" for Home UI presence.
+            outlet.updateCharacteristic(Characteristic.On, true);
+        });
+        this.outletService = outlet;
+        this.evePower = this.ensureEveCharacteristic(this.platform.Eve.Power);
+        this.eveTotal = this.ensureEveCharacteristic(this.platform.Eve.TotalConsumption);
+        this.refreshNow().catch((error) => {
+            this.platform.log.warn(`Initial fetch failed for ${this.meter.name}: ${error instanceof Error ? error.message : String(error)}`);
+        });
+        this.timer = setInterval(() => {
+            this.refreshNow().catch((error) => {
+                this.platform.log.warn(`Refresh failed for ${this.meter.name}: ${error instanceof Error ? error.message : String(error)}`);
+            });
+        }, this.pollSeconds * 1000);
+        this.platform.api.on('shutdown', () => this.stopPolling());
+    }
+    stopPolling() {
+        if (this.timer) {
+            clearInterval(this.timer);
+            this.timer = undefined;
+        }
+    }
+    ensureEveCharacteristic(charType) {
+        try {
+            return this.outletService.getCharacteristic(charType);
+        }
+        catch (error) {
+            try {
+                return this.outletService.addCharacteristic(charType);
+            }
+            catch (innerError) {
+                this.platform.log.warn(`Failed to register Eve characteristic on ${this.meter.name}: ${innerError instanceof Error ? innerError.message : String(innerError)}`);
+                return null;
+            }
+        }
+    }
+    async refreshNow() {
+        await this.refreshPower();
+        await this.refreshTotal();
+    }
+    async refreshPower() {
+        try {
+            const watts = await this.fetchLatestWatts();
+            this.lastWatts = watts;
+            this.accessory.context.lastWatts = watts;
+            const safeValue = Math.max(0, watts);
+            if (this.evePower) {
+                this.evePower.updateValue(safeValue);
+            }
+            this.platform.log.debug(`${this.meter.name} Eve power updated to ${safeValue.toFixed(2)} W`);
+        }
+        catch (error) {
+            this.platform.log.warn(`Failed to update power for ${this.meter.name}: ${error instanceof Error ? error.message : String(error)}`);
+        }
+    }
+    async refreshTotal() {
+        try {
+            const totalKWh = await this.fetchTodayTotalKWh();
+            this.lastTotalKWh = totalKWh;
+            this.accessory.context.totalKWh = totalKWh;
+            if (this.eveTotal) {
+                this.eveTotal.updateValue(totalKWh);
+            }
+            this.platform.log.debug(`${this.meter.name} Eve total updated to ${totalKWh.toFixed(3)} kWh (today)`);
+        }
+        catch (error) {
+            this.platform.log.warn(`Failed to update total consumption for ${this.meter.name}: ${error instanceof Error ? error.message : String(error)}`);
+        }
+    }
+    async fetchLatestWatts() {
+        const url = `https://api.octopus.energy/v1/electricity-meter-points/${this.meter.mpan}/meters/${this.meter.meterSerial}/consumption/?page_size=1&order_by=-period_start`;
+        const response = await (0, node_fetch_1.default)(url, {
+            headers: {
+                Authorization: `Basic ${Buffer.from(`${this.apiKey}:`).toString('base64')}`,
+            },
+        });
+        if (!response.ok) {
+            throw new Error(`HTTP ${response.status}`);
+        }
+        const payload = (await response.json());
+        const record = payload.results?.[0];
+        if (!record) {
+            throw new Error('No consumption records returned');
+        }
+        const consumption = record.consumption;
+        if (typeof consumption !== 'number') {
+            throw new Error('Consumption value missing or invalid');
+        }
+        const intervalStart = record.interval_start ?? record.period_start;
+        const intervalEnd = record.interval_end ?? record.period_end;
+        let intervalHours = 0.5;
+        if (intervalStart && intervalEnd) {
+            const start = Date.parse(intervalStart);
+            const end = Date.parse(intervalEnd);
+            if (!Number.isNaN(start) && !Number.isNaN(end)) {
+                const hours = (end - start) / (1000 * 60 * 60);
+                if (hours > 0) {
+                    intervalHours = hours;
+                }
+            }
+        }
+        const watts = (consumption * 1000) / intervalHours;
+        return Math.max(0, Math.round(watts * 100) / 100);
+    }
+    async fetchTodayTotalKWh() {
+        const now = new Date();
+        const start = new Date(Date.UTC(now.getUTCFullYear(), now.getUTCMonth(), now.getUTCDate(), 0, 0, 0));
+        const end = new Date(Date.UTC(now.getUTCFullYear(), now.getUTCMonth(), now.getUTCDate() + 1, 0, 0, 0));
+        const params = new URLSearchParams({
+            page_size: '96',
+            order_by: 'period_start',
+            period_from: start.toISOString(),
+            period_to: end.toISOString(),
+        });
+        const url = `https://api.octopus.energy/v1/electricity-meter-points/${this.meter.mpan}/meters/${this.meter.meterSerial}/consumption/?${params.toString()}`;
+        const response = await (0, node_fetch_1.default)(url, {
+            headers: {
+                Authorization: `Basic ${Buffer.from(`${this.apiKey}:`).toString('base64')}`,
+            },
+        });
+        if (!response.ok) {
+            throw new Error(`HTTP ${response.status}`);
+        }
+        const payload = (await response.json());
+        const records = payload.results ?? [];
+        let total = 0;
+        for (const record of records) {
+            if (typeof record.consumption === 'number') {
+                total += record.consumption;
+            }
+        }
+        return Math.max(0, Math.round(total * 1000) / 1000);
+    }
+}
+exports.OctopusMeterAccessory = OctopusMeterAccessory;
+//# sourceMappingURL=accessory.js.map

package/dist/accessory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accessory.js","sourceRoot":"","sources":["../src/accessory.ts"],"names":[],"mappings":";;;;;;AAAA,4DAA+B;AAyB/B,MAAa,qBAAqB;IAQhC,YACmB,QAA+B,EAC/B,SAA4B,EAC5B,KAAkB,EAClB,MAAc,EACd,WAAmB;QAJnB,aAAQ,GAAR,QAAQ,CAAuB;QAC/B,cAAS,GAAT,SAAS,CAAmB;QAC5B,UAAK,GAAL,KAAK,CAAa;QAClB,WAAM,GAAN,MAAM,CAAQ;QACd,gBAAW,GAAX,WAAW,CAAQ;QAX9B,aAAQ,GAAoD,IAAI,CAAC;QACjE,aAAQ,GAAoD,IAAI,CAAC;QACjE,cAAS,GAAG,CAAC,CAAC;QACd,iBAAY,GAAG,CAAC,CAAC;QAUvB,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC;QAElD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;QACrE,IAAI,EAAE,iBAAiB,CAAC,cAAc,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC;QACvE,IAAI,EAAE,iBAAiB,CAAC,cAAc,CAAC,KAAK,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QACnF,IAAI,EAAE,iBAAiB,CAAC,cAAc,CAAC,YAAY,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;QAExE,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC;eACnD,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC/C,MAAM,CAAC,iBAAiB,CAAC,cAAc,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QAC1D,MAAM,CAAC,oBAAoB,CAAC,cAAc,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QACrD,MAAM,CAAC,oBAAoB,CAAC,cAAc,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAC9D,MAAM,CAAC,iBAAiB,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE;YAC3D,kEAAkE;YAClE,MAAM,CAAC,oBAAoB,CAAC,cAAc,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC;QAE5B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACtE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QAEjF,IAAI,CAAC,UAAU,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YAChC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,4BAA4B,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACnI,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE;YAC5B,IAAI,CAAC,UAAU,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBAChC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,sBAAsB,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAC7H,CAAC,CAAC,CAAC;QACL,CAAC,EAAE,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,CAAC;QAE5B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,UAAU,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAC7D,CAAC;IAEM,WAAW;QAChB,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC1B,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;QACzB,CAAC;IACH,CAAC;IAEO,uBAAuB,CAAC,QAA4C;QAC1E,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QACxD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC;gBACH,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;YACxD,CAAC;YAAC,OAAO,UAAU,EAAE,CAAC;gBACpB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,4CAA4C,IAAI,CAAC,KAAK,CAAC,IAAI,KAChF,UAAU,YAAY,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CACtE,EAAE,CAAC,CAAC;gBACJ,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,UAAU;QACtB,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAC1B,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;IAC5B,CAAC;IAEO,KAAK,CAAC,YAAY;QACxB,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC5C,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;YACvB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,GAAG,KAAK,CAAC;YAEzC,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YACrC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAClB,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,SAAgC,CAAC,CAAC;YAC9D,CAAC;YACD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,yBAAyB,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC/F,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,8BAA8B,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACrI,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,YAAY;QACxB,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACjD,IAAI,CAAC,YAAY,GAAG,QAAQ,CAAC;YAC7B,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;YAE3C,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAClB,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,QAA+B,CAAC,CAAC;YAC7D,CAAC;YACD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,yBAAyB,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC;QACxG,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,0CAA0C,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACjJ,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,gBAAgB;QAC5B,MAAM,GAAG,GAAG,0DAA0D,IAAI,CAAC,KAAK,CAAC,IAAI,WAAW,IAAI,CAAC,KAAK,CAAC,WAAW,kDAAkD,CAAC;QAEzK,MAAM,QAAQ,GAAG,MAAM,IAAA,oBAAK,EAAC,GAAG,EAAE;YAChC,OAAO,EAAE;gBACP,aAAa,EAAE,SAAS,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;aAC5E;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,QAAQ,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QAC7C,CAAC;QAED,MAAM,OAAO,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAwB,CAAC;QAC/D,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACrD,CAAC;QAED,MAAM,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;QACvC,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;YACpC,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QAED,MAAM,aAAa,GAAG,MAAM,CAAC,cAAc,IAAI,MAAM,CAAC,YAAY,CAAC;QACnE,MAAM,WAAW,GAAG,MAAM,CAAC,YAAY,IAAI,MAAM,CAAC,UAAU,CAAC;QAE7D,IAAI,aAAa,GAAG,GAAG,CAAC;QACxB,IAAI,aAAa,IAAI,WAAW,EAAE,CAAC;YACjC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;YACxC,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;YACpC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC/C,MAAM,KAAK,GAAG,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC;gBAC/C,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;oBACd,aAAa,GAAG,KAAK,CAAC;gBACxB,CAAC;YACH,CAAC;QACH,CAAC;QAED,MAAM,KAAK,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,aAAa,CAAC;QACnD,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC;IACpD,CAAC;IAEO,KAAK,CAAC,kBAAkB;QAC9B,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,KAAK,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,GAAG,CAAC,WAAW,EAAE,EAAE,GAAG,CAAC,UAAU,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACrG,MAAM,GAAG,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,GAAG,CAAC,WAAW,EAAE,EAAE,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAEvG,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC;YACjC,SAAS,EAAE,IAAI;YACf,QAAQ,EAAE,cAAc;YACxB,WAAW,EAAE,KAAK,CAAC,WAAW,EAAE;YAChC,SAAS,EAAE,GAAG,CAAC,WAAW,EAAE;SAC7B,CAAC,CAAC;QAEH,MAAM,GAAG,GAAG,0DAA0D,IAAI,CAAC,KAAK,CAAC,IAAI,WAAW,IAAI,CAAC,KAAK,CAAC,WAAW,iBAAiB,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;QAE3J,MAAM,QAAQ,GAAG,MAAM,IAAA,oBAAK,EAAC,GAAG,EAAE;YAChC,OAAO,EAAE;gBACP,aAAa,EAAE,SAAS,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;aAC5E;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,QAAQ,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QAC7C,CAAC;QAED,MAAM,OAAO,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAwB,CAAC;QAC/D,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;QAEtC,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,IAAI,OAAO,MAAM,CAAC,WAAW,KAAK,QAAQ,EAAE,CAAC;gBAC3C,KAAK,IAAI,MAAM,CAAC,WAAW,CAAC;YAC9B,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;IACtD,CAAC;CACF;AA1LD,sDA0LC"}

package/dist/eve.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEveCharacteristics = getEveCharacteristics;
+const UUID_POWER = 'E863F10A-079E-48FF-8F27-9C2605A29F52';
+const UUID_TOTAL_CONSUMPTION = 'E863F10C-079E-48FF-8F27-9C2605A29F52';
+let cached;
+function getEveCharacteristics(api) {
+    if (cached) {
+        return cached;
+    }
+    const { Characteristic, Formats, Perms } = api.hap;
+    class EvePower extends Characteristic {
+        constructor() {
+            super('Eve Instantaneous Power', EvePower.UUID, {
+                format: "float" /* Formats.FLOAT */,
+                unit: 'W',
+                perms: ["pr" /* Perms.READ */, "ev" /* Perms.NOTIFY */],
+                minValue: 0,
+            });
+        }
+    }
+    EvePower.UUID = UUID_POWER;
+    class EveTotalConsumption extends Characteristic {
+        constructor() {
+            super('Eve Total Consumption', EveTotalConsumption.UUID, {
+                format: "float" /* Formats.FLOAT */,
+                unit: 'kWh',
+                perms: ["pr" /* Perms.READ */, "ev" /* Perms.NOTIFY */],
+                minValue: 0,
+            });
+        }
+    }
+    EveTotalConsumption.UUID = UUID_TOTAL_CONSUMPTION;
+    cached = {
+        Power: EvePower,
+        TotalConsumption: EveTotalConsumption,
+    };
+    return cached;
+}
+//# sourceMappingURL=eve.js.map

package/dist/eve.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eve.js","sourceRoot":"","sources":["../src/eve.ts"],"names":[],"mappings":";;AAYA,sDAuCC;AA5CD,MAAM,UAAU,GAAG,sCAAsC,CAAC;AAC1D,MAAM,sBAAsB,GAAG,sCAAsC,CAAC;AAEtE,IAAI,MAAsC,CAAC;AAE3C,SAAgB,qBAAqB,CAAC,GAAQ;IAC5C,IAAI,MAAM,EAAE,CAAC;QACX,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,EAAE,cAAc,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,GAAG,CAAC,GAAG,CAAC;IAEnD,MAAM,QAAS,SAAQ,cAAc;QAGnC;YACE,KAAK,CAAC,yBAAyB,EAAE,QAAQ,CAAC,IAAI,EAAE;gBAC9C,MAAM,6BAAe;gBACrB,IAAI,EAAE,GAAG;gBACT,KAAK,EAAE,gDAA0B;gBACjC,QAAQ,EAAE,CAAC;aACZ,CAAC,CAAC;QACL,CAAC;;IATsB,aAAI,GAAG,UAAU,CAAC;IAY3C,MAAM,mBAAoB,SAAQ,cAAc;QAG9C;YACE,KAAK,CAAC,uBAAuB,EAAE,mBAAmB,CAAC,IAAI,EAAE;gBACvD,MAAM,6BAAe;gBACrB,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE,gDAA0B;gBACjC,QAAQ,EAAE,CAAC;aACZ,CAAC,CAAC;QACL,CAAC;;IATsB,wBAAI,GAAG,sBAAsB,CAAC;IAYvD,MAAM,GAAG;QACP,KAAK,EAAE,QAAQ;QACf,gBAAgB,EAAE,mBAAmB;KACtC,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/index.js

@@ -0,0 +1,7 @@
+"use strict";
+const settings_1 = require("./settings");
+const platform_1 = require("./platform");
+module.exports = (api) => {
+    api.registerPlatform(settings_1.PLATFORM_NAME, platform_1.OctopusEnergyPlatform);
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA,yCAA2C;AAC3C,yCAAmD;AAEnD,iBAAS,CAAC,GAAQ,EAAE,EAAE;IACpB,GAAG,CAAC,gBAAgB,CAAC,wBAAa,EAAE,gCAAqB,CAAC,CAAC;AAC7D,CAAC,CAAC"}

package/dist/platform.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OctopusEnergyPlatform = void 0;
+const accessory_1 = require("./accessory");
+const settings_1 = require("./settings");
+const eve_1 = require("./eve");
+class OctopusEnergyPlatform {
+    constructor(log, config, api) {
+        this.log = log;
+        this.config = config;
+        this.api = api;
+        this.Service = this.api.hap.Service;
+        this.Characteristic = this.api.hap.Characteristic;
+        this.accessories = [];
+        this.managed = [];
+        this.Eve = (0, eve_1.getEveCharacteristics)(this.api);
+        this.pollSeconds = Math.max(60, typeof config?.pollSeconds === 'number' ? config.pollSeconds : 300);
+        if (!config || !config.apiKey) {
+            this.log.error('Missing apiKey in configuration; plugin will not start.');
+        }
+        this.api.on("didFinishLaunching" /* APIEvent.DID_FINISH_LAUNCHING */, () => {
+            this.log.debug('Finished launching, starting discovery');
+            this.discoverMeters();
+        });
+        this.api.on("shutdown" /* APIEvent.SHUTDOWN */, () => {
+            this.managed.forEach((meter) => meter.stopPolling());
+        });
+    }
+    configureAccessory(accessory) {
+        this.log.info('Restored accessory from cache:', accessory.displayName);
+        this.accessories.push(accessory);
+    }
+    discoverMeters() {
+        if (!this.config || !this.config.apiKey) {
+            return;
+        }
+        if (!this.config.import) {
+            this.log.error('Import meter configuration missing.');
+            return;
+        }
+        this.registerMeter('import', this.config.import);
+        if (this.config.export) {
+            if (this.config.export.mpan && this.config.export.meterSerial) {
+                this.registerMeter('export', this.config.export);
+            }
+            else {
+                this.log.warn('Export configuration incomplete; skipping export accessory.');
+            }
+        }
+    }
+    registerMeter(side, meter) {
+        const name = meter.name || (side === 'import' ? 'Octopus Import' : 'Octopus Export');
+        const uuid = this.api.hap.uuid.generate(`${side}-${meter.mpan}-${meter.meterSerial}`);
+        const existing = this.accessories.find((accessory) => accessory.UUID === uuid);
+        let accessory;
+        if (existing) {
+            accessory = existing;
+            accessory.displayName = name;
+            this.log.info('Updating cached accessory', name);
+        }
+        else {
+            accessory = new this.api.platformAccessory(name, uuid);
+            this.log.info('Registering new accessory', name);
+            this.api.registerPlatformAccessories(settings_1.PLUGIN_NAME, settings_1.PLATFORM_NAME, [accessory]);
+        }
+        accessory.context.meter = {
+            side,
+            mpan: meter.mpan,
+            meterSerial: meter.meterSerial,
+            name,
+        };
+        const octopusAccessory = new accessory_1.OctopusMeterAccessory(this, accessory, accessory.context.meter, this.config.apiKey, this.pollSeconds);
+        this.managed.push(octopusAccessory);
+        this.api.updatePlatformAccessories([accessory]);
+    }
+}
+exports.OctopusEnergyPlatform = OctopusEnergyPlatform;
+//# sourceMappingURL=platform.js.map

package/dist/platform.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"platform.js","sourceRoot":"","sources":["../src/platform.ts"],"names":[],"mappings":";;;AACA,2CAA4E;AAC5E,yCAAwD;AACxD,+BAAkE;AAelE,MAAa,qBAAqB;IAShC,YACkB,GAAW,EACX,MAA6B,EAC7B,GAAQ;QAFR,QAAG,GAAH,GAAG,CAAQ;QACX,WAAM,GAAN,MAAM,CAAuB;QAC7B,QAAG,GAAH,GAAG,CAAK;QAXV,YAAO,GAAmB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC;QAC/C,mBAAc,GAA0B,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC;QAGnE,gBAAW,GAAwB,EAAE,CAAC;QACtC,YAAO,GAA4B,EAAE,CAAC;QAQrD,IAAI,CAAC,GAAG,GAAG,IAAA,2BAAqB,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,OAAO,MAAM,EAAE,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAEpG,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YAC9B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,yDAAyD,CAAC,CAAC;QAC5E,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,EAAE,2DAAgC,GAAG,EAAE;YAC9C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,wCAAwC,CAAC,CAAC;YACzD,IAAI,CAAC,cAAc,EAAE,CAAC;QACxB,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,GAAG,CAAC,EAAE,qCAAoB,GAAG,EAAE;YAClC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;IACL,CAAC;IAED,kBAAkB,CAAC,SAA4B;QAC7C,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,gCAAgC,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC;QACvE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAEO,cAAc;QACpB,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACxC,OAAO;QACT,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACxB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,qCAAqC,CAAC,CAAC;YACtD,OAAO;QACT,CAAC;QAED,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAEjD,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACvB,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;gBAC9D,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACnD,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,6DAA6D,CAAC,CAAC;YAC/E,CAAC;QACH,CAAC;IACH,CAAC;IAEO,aAAa,CAAC,IAAe,EAAE,KAAiB;QACtD,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;QACrF,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;QAEtF,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QAE/E,IAAI,SAA4B,CAAC;QACjC,IAAI,QAAQ,EAAE,CAAC;YACb,SAAS,GAAG,QAAQ,CAAC;YACrB,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC;YAC7B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,2BAA2B,EAAE,IAAI,CAAC,CAAC;QACnD,CAAC;aAAM,CAAC;YACN,SAAS,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACvD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,2BAA2B,EAAE,IAAI,CAAC,CAAC;YACjD,IAAI,CAAC,GAAG,CAAC,2BAA2B,CAAC,sBAAW,EAAE,wBAAa,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;QAChF,CAAC;QAED,SAAS,CAAC,OAAO,CAAC,KAAK,GAAG;YACxB,IAAI;YACJ,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,IAAI;SACU,CAAC;QAEjB,MAAM,gBAAgB,GAAG,IAAI,iCAAqB,CAChD,IAAI,EACJ,SAAS,EACT,SAAS,CAAC,OAAO,CAAC,KAAK,EACvB,IAAI,CAAC,MAAM,CAAC,MAAM,EAClB,IAAI,CAAC,WAAW,CACjB,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACpC,IAAI,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IAClD,CAAC;CACF;AA5FD,sDA4FC"}

package/dist/settings.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PLATFORM_NAME = exports.PLUGIN_NAME = void 0;
+exports.PLUGIN_NAME = 'homebridge-octopus-energy';
+exports.PLATFORM_NAME = 'OctopusEnergyPlatform';
+//# sourceMappingURL=settings.js.map

package/dist/settings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":";;;AAAa,QAAA,WAAW,GAAG,2BAA2B,CAAC;AAC1C,QAAA,aAAa,GAAG,uBAAuB,CAAC"}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "homebridge-octopus-energy",
+  "version": "0.0.1",
+  "description": "Homebridge plugin to expose Octopus Energy smart meter import/export consumption to HomeKit",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/icebondx/homebridge-octopus-energy.git"
+  },
+  "homepage": "https://github.com/icebondx/homebridge-octopus-energy",
+  "bugs": {
+    "url": "https://github.com/icebondx/homebridge-octopus-energy/issues"
+  },
+  "main": "dist/index.js",
+  "files": [
+    "dist",
+    "config.schema.json"
+  ],
+  "keywords": [
+    "homebridge-plugin",
+    "octopus",
+    "energy",
+    "electricity",
+    "homekit",
+    "octopus-energy",
+    "smart-meter",
+    "eve",
+    "power-monitoring"
+  ],
+  "engines": {
+    "node": ">=18",
+    "homebridge": ">=1.7.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "watch": "tsc -w -p tsconfig.json",
+    "lint": "eslint src --ext .ts",
+    "clean": "rimraf dist",
+    "prepare": "npm run build"
+  },
+  "homebridge": {
+    "platforms": [
+      {
+        "platform": "OctopusEnergyPlatform",
+        "name": "Octopus Energy"
+      }
+    ]
+  },
+  "dependencies": {
+    "homebridge": "^1.7.0",
+    "node-fetch": "^2.6.11"
+  },
+  "devDependencies": {
+    "@types/node": "^20.14.2",
+    "@types/node-fetch": "^2.6.11",
+    "@typescript-eslint/eslint-plugin": "^7.8.0",
+    "@typescript-eslint/parser": "^7.8.0",
+    "eslint": "^8.57.0",
+    "rimraf": "^5.0.5",
+    "typescript": "^5.4.5"
+  }
+}