homebridge-octopus-energy 0.0.1 → 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Homebridge Octopus Energy
2
2
 
3
- 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 todays total kWh). Apple Home will show the Outlet accessory; rich energy data appears in Eve, Home+, and other advanced HomeKit apps.
3
+ 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.
4
4
 
5
5
  ## Requirements
6
6
  - Node.js >= 18
@@ -9,7 +9,7 @@ Homebridge platform plugin that surfaces Octopus Energy SMETS2 import (and optio
9
9
 
10
10
  ## Installation
11
11
  ### Homebridge UI X
12
- 1. Open **Config UI X** **Plugins**.
12
+ 1. Open **Config UI X** -> **Plugins**.
13
13
  2. Search for `homebridge-octopus-energy`.
14
14
  3. Install and restart Homebridge.
15
15
 
@@ -22,7 +22,7 @@ npm i -g homebridge-octopus-energy
22
22
  Add to `config.json` (or use the UI form powered by `config.schema.json`):
23
23
  ```json
24
24
  {
25
- "platform": "OctopusEnergyPlatform",
25
+ "platform": "OctopusEnergy",
26
26
  "name": "Octopus Energy",
27
27
  "apiKey": "sk_live_your_key",
28
28
  "pollSeconds": 300,
@@ -42,11 +42,11 @@ Add to `config.json` (or use the UI form powered by `config.schema.json`):
42
42
  Notes:
43
43
  - Import is required; export is optional (requires both MPAN and meter serial).
44
44
  - Polls immediately on startup, then every `pollSeconds` (min 60s).
45
- - Eve characteristics expose live watts and a rolling today total (kWh). Apple Home won’t show these values, but Eve/Home+ will.
45
+ - Eve characteristics expose live watts and a rolling "today" total (kWh). Apple Home will not show these values, but Eve/Home+ will.
46
46
 
47
47
  ## What it does
48
48
  - Calls the Octopus REST API for electricity consumption.
49
- - Converts the latest interval kWh to watts; sums todays intervals for total kWh.
49
+ - Converts the latest interval kWh to watts; sums today's intervals for total kWh.
50
50
  - Exposes an `Outlet` service for Home visibility plus Eve Energy characteristics for power and total energy.
51
51
  - Keeps last values if the API fails and logs warnings instead of crashing.
52
52
 
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "$schema": "http://json-schema.org/draft-07/schema#",
3
- "pluginAlias": "OctopusEnergyPlatform",
3
+ "pluginAlias": "OctopusEnergy",
4
4
  "pluginType": "platform",
5
5
  "singular": false,
6
6
  "schema": {
package/dist/settings.js CHANGED
@@ -2,5 +2,5 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.PLATFORM_NAME = exports.PLUGIN_NAME = void 0;
4
4
  exports.PLUGIN_NAME = 'homebridge-octopus-energy';
5
- exports.PLATFORM_NAME = 'OctopusEnergyPlatform';
5
+ exports.PLATFORM_NAME = 'OctopusEnergy';
6
6
  //# sourceMappingURL=settings.js.map
@@ -1 +1 @@
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"}
1
+ {"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":";;;AAAa,QAAA,WAAW,GAAG,2BAA2B,CAAC;AAC1C,QAAA,aAAa,GAAG,eAAe,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
- {
1
+ {
2
2
  "name": "homebridge-octopus-energy",
3
- "version": "0.0.1",
3
+ "version": "0.0.2",
4
4
  "description": "Homebridge plugin to expose Octopus Energy smart meter import/export consumption to HomeKit",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -41,7 +41,7 @@
41
41
  "homebridge": {
42
42
  "platforms": [
43
43
  {
44
- "platform": "OctopusEnergyPlatform",
44
+ "platform": "OctopusEnergy",
45
45
  "name": "Octopus Energy"
46
46
  }
47
47
  ]