homebridge-ariston-heater 0.1.2 → 0.1.3

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.
Files changed (2) hide show
  1. package/README.md +30 -7
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,6 +1,10 @@
1
1
  # Homebridge Ariston Heater
2
2
 
3
- Homebridge plugin for Ariston NET Velis/Lydos water heaters. It discovers your plant, reads current/target temperature and toggles power. It auto-selects the correct Velis endpoint variant (se/med/slp/one/evo).
3
+ [![npm version](https://img.shields.io/npm/v/homebridge-ariston-heater.svg?logo=npm)](https://www.npmjs.com/package/homebridge-ariston-heater)
4
+ [![license: MIT](https://img.shields.io/badge/license-MIT-yellow.svg)](LICENSE)
5
+ [![homebridge](https://img.shields.io/badge/homebridge-1.8%2B-blue.svg)](https://github.com/homebridge/homebridge)
6
+
7
+ Homebridge plugin for Ariston NET Velis/Lydos water heaters. It discovers your plant, reads current/target temperature, toggles power, and auto-selects the correct Velis endpoint variant (se/med/slp/one/evo).
4
8
 
5
9
 
6
10
  ## Installation
@@ -30,10 +34,13 @@ Add an accessory like:
30
34
  "name": "Water Heater",
31
35
  "username": "<ariston email>",
32
36
  "password": "<ariston password>",
33
- "pollInterval": 30,
37
+ "pollInterval": 1800,
34
38
  "minTemp": 35,
35
39
  "maxTemp": 70,
36
- "debug": false
40
+ "eveCharacteristics": true,
41
+ "refreshOnGet": true,
42
+ "refreshOnGetCooldownSeconds": 10,
43
+ "debug": false
37
44
  }
38
45
  ]
39
46
  }
@@ -43,9 +50,14 @@ Add an accessory like:
43
50
 
44
51
  - Auto discovery (if `gateway` not set)
45
52
  - Reads current and target temperature
46
- - Sets target temperature (35–70°C)
53
+ - Sets target temperature (default 35–70°C; configurable)
47
54
  - Power on/off mapped to Heating/Cooling State (OFF/HEAT)
48
55
  - Auto-selects best Velis variant by scoring returned payloads and ignoring zeroed responses
56
+ - Eve-only extra fields (visible in Eve app, hidden from Apple Home):
57
+ - Anti Legionella (boolean)
58
+ - Heating Request (boolean)
59
+ - Showers (0–4)
60
+ - Gentle cloud polling (default every 30 minutes) with on-demand refresh when opening the accessory tile
49
61
 
50
62
  ## Project structure
51
63
 
@@ -56,9 +68,20 @@ Add an accessory like:
56
68
 
57
69
  ## Notes
58
70
 
59
- - Requires Ariston NET cloud account credentials (same used in the mobile app).
60
- - For Lydos devices, `sePlantData` is typically selected; MED can return zeros which are ignored automatically.
61
- - If behavior seems off, delete the cache file (ariston-cache.json) from the Homebridge storage path to force a re-probe.
71
+ - Requires Ariston NET cloud account credentials (same as the mobile app).
72
+ - For many Lydos/Velis devices, `sePlantData` is commonly selected; other variants are tried as needed.
73
+ - If behavior seems off, delete the cache file (`ariston-cache.json`) from the Homebridge storage path to force re-detection of the variant.
74
+ - Rate limiting: the plugin gracefully backs off on HTTP 429 responses using Retry-After headers. Consider increasing `pollInterval` if you encounter frequent 429s.
75
+
76
+ ### Options
77
+
78
+ - `gateway` (string): Plant ID (gateway). Leave empty to auto-discover.
79
+ - `pollInterval` (number): Refresh cadence in seconds. Default 1800 (30 minutes). Minimum 15.
80
+ - `minTemp`/`maxTemp` (number): Allowed range for target temperature.
81
+ - `eveCharacteristics` (boolean): Expose Eve-only extra fields on the Thermostat service. Default true.
82
+ - `refreshOnGet` (boolean): Trigger a background refresh when the accessory is viewed/read. Default true.
83
+ - `refreshOnGetCooldownSeconds` (number): Minimum seconds between on-demand refreshes. Default 10.
84
+ - `debug` (boolean): Verbose logging.
62
85
 
63
86
  ## License
64
87
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "homebridge-ariston-heater",
3
- "version": "0.1.2",
3
+ "version": "0.1.3",
4
4
  "displayName": "Homebridge Ariston Heater",
5
5
  "description": "Homebridge plugin for Ariston Velis/Lydos water heaters (Ariston NET)",
6
6
  "license": "MIT",