homebridge-econet-rheem 1.6.0-beta.0 → 1.6.0
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/CHANGELOG.md +4 -3
- package/README.md +37 -48
- package/dist/homebridge-ui/public/index.html +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -2,14 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to homebridge-econet-rheem will be documented in this file.
|
|
4
4
|
|
|
5
|
-
## 1.6.0
|
|
5
|
+
## 1.6.0 (2025-11-24)
|
|
6
6
|
|
|
7
7
|
### Added
|
|
8
|
-
- Real-time current temperature for water heaters ([
|
|
8
|
+
- Real-time current temperature for water heaters ([see documentation](https://github.com/mpatfield/homebridge-econet-rheem#device-details))
|
|
9
9
|
|
|
10
10
|
### Changed
|
|
11
|
-
-
|
|
11
|
+
- Consolidated persistent storage into a single file
|
|
12
12
|
- Water heater recovery simulator removed in favor of real-time updates above
|
|
13
|
+
- Updated dependencies
|
|
13
14
|
|
|
14
15
|
### Notes
|
|
15
16
|
Would you like to see Homebridge Econet Rheem in your language? Please consider [getting involved](https://github.com/mpatfield/homebridge-econet-rheem/issues/35). No coding experience required!
|
package/README.md
CHANGED
|
@@ -17,27 +17,54 @@ Homebridge plugin for HomeKit control of Rheem water heaters and thermostats
|
|
|
17
17
|
|
|
18
18
|
## Disclaimer
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
Homebridge Econet Rheem is independently developed and is not in any way affiliated with or endorsed by Rheem. Any issues or damage resulting from use of this plugin are not the fault of the developer. Use at your own risk.
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
This plugin uses an unofficial EcoNet API and could stop working at any time without warning.
|
|
23
23
|
|
|
24
|
-
## Limitations
|
|
24
|
+
## Known Limitations
|
|
25
25
|
|
|
26
26
|
* Water Heaters
|
|
27
27
|
* Switching modes is not possible, only enable/disable and adjusting desired temperature
|
|
28
28
|
* Celcius should work but is untested
|
|
29
|
-
* *
|
|
29
|
+
* *Please let me know if you have successfully used ºC by [creating a ticket](https://github.com/mpatfield/homebridge-econet-rheem/issues/new/choose) so I can remove this*
|
|
30
30
|
|
|
31
31
|
## Account Sharing
|
|
32
32
|
|
|
33
33
|
⚠️ It is recommended to use a dedicated account for use with Homebridge.
|
|
34
34
|
|
|
35
|
-
|
|
35
|
+
Rheem only allows one device to be subscribed to real-time updates, so if you open the Rheem app then the Homebridge plugin will silently stop receiving updates.
|
|
36
36
|
|
|
37
37
|
The plugin will eventually resubscribe after being idle for an extended period, but you could miss updates in the meantime. Using a separate account will avoid this issue.
|
|
38
38
|
|
|
39
39
|
To get started, visit "Account Sharing" in the Rheem app menu.
|
|
40
40
|
|
|
41
|
+
## Configuration
|
|
42
|
+
|
|
43
|
+
Using the Homebridge Config UI is the easiest way to set up this plugin. However, if you wish to do things manually then you will need to add the following to your Homebridge `config.json`:
|
|
44
|
+
|
|
45
|
+
```json
|
|
46
|
+
{
|
|
47
|
+
"name": "Econet Rheem",
|
|
48
|
+
"email": "string",
|
|
49
|
+
"password": "string",
|
|
50
|
+
"devices": [
|
|
51
|
+
{
|
|
52
|
+
"serialNumber": "string",
|
|
53
|
+
"deviceName": "string",
|
|
54
|
+
"activeKey": "string"
|
|
55
|
+
}
|
|
56
|
+
...
|
|
57
|
+
],
|
|
58
|
+
"verbose": false,
|
|
59
|
+
"platform": "HomebridgeEconetRheem"
|
|
60
|
+
}
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
- `platform`: (Required) Must be "HomebridgeEconetRheem"
|
|
64
|
+
- `email`: (Required) Your Econet account email
|
|
65
|
+
- `password`: (Required) Your Econet account password
|
|
66
|
+
- `verbose`: (Optional) Set to `true` to enable additional debug logging. Default is `false`
|
|
67
|
+
|
|
41
68
|
## Device Details
|
|
42
69
|
|
|
43
70
|
⚠️ This has only been tested with a Rheem Heat Pump Water Heater. You are welcome to try other equipment, but you may run into issues. If you do, please [open a ticket](https://github.com/mpatfield/homebridge-econet-rheem/issues/new/choose) and we can work together to support your equipment.
|
|
@@ -55,9 +82,9 @@ The easiest way to get the `serialNumber` is by visiting [this site](https://mpa
|
|
|
55
82
|
|
|
56
83
|
For `deviceName` and `activeKey`, you will need to connect to your devices WiFi.
|
|
57
84
|
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
85
|
+
1. Put your equipment in WiFi setup mode — for most controllers, press and hold the WiFi button
|
|
86
|
+
2. Connect to the WiFi network (e.g. *EcoNet-XXXX*)
|
|
87
|
+
3. Visit https://192.168.10.1/cred and you should see something like the following:
|
|
61
88
|
|
|
62
89
|
```json
|
|
63
90
|
{
|
|
@@ -73,49 +100,11 @@ For `deviceName` and `activeKey`, you will need to connect to your devices WiFi.
|
|
|
73
100
|
}
|
|
74
101
|
```
|
|
75
102
|
|
|
76
|
-
|
|
77
|
-
|
|
103
|
+
4. Copy and paste the pieces you need
|
|
104
|
+
5. Reconnect your device to your WiFi network by opening the Rheem app and choosing "Add Product"
|
|
78
105
|
|
|
79
106
|
Enter the `serialNumber`, `deviceName`, and `activeKey` you collected from above in the Homebridge Econet Rheem config UI and restart Homebridge. You should now see more accurate real-time information in the Home app!
|
|
80
107
|
|
|
81
|
-
## Configuration
|
|
82
|
-
|
|
83
|
-
Using the Homebridge Config UI is the easiest way to set up this plugin. However, if you wish to do things manually then you will need to add the following to your Homebridge `config.json`:
|
|
84
|
-
|
|
85
|
-
```json
|
|
86
|
-
{
|
|
87
|
-
"platforms": [
|
|
88
|
-
{
|
|
89
|
-
"platform": "HomebridgeEconetRheem",
|
|
90
|
-
"email": "your_econet_email",
|
|
91
|
-
"password": "your_econet_password",
|
|
92
|
-
"verbose": false
|
|
93
|
-
}
|
|
94
|
-
]
|
|
95
|
-
}
|
|
96
|
-
```
|
|
97
|
-
|
|
98
|
-
- `platform`: (Required) Must be "HomebridgeEconetRheem".
|
|
99
|
-
- `email`: (Required) Your Econet account email.
|
|
100
|
-
- `password`: (Required) Your Econet account password.
|
|
101
|
-
- `verbose`: (Optional) Set to `true` to enable additional debug logging. Default is `false`.
|
|
102
|
-
|
|
103
|
-
## Contributing
|
|
104
|
-
|
|
105
|
-
Ideas and bug reports are welcome. To assist:
|
|
106
|
-
|
|
107
|
-
1. Turn on "Verbose" logging in the plugin config under "Advanced Settings"
|
|
108
|
-
2. Run Homebridge in debug mode
|
|
109
|
-
|
|
110
|
-
```
|
|
111
|
-
Homebridge Settings -> Startup & Environment -> Homebridge Debug Mode -D
|
|
112
|
-
```
|
|
113
|
-
|
|
114
|
-
3. Capture the JSON responses in the Logs for HTTP and MQTT state changes
|
|
115
|
-
4. Submit the captured data via a GitHub [issue](https://github.com/mpatfield/homebridge-econet-rheem/issues/new/choose) or [pull request](https://github.com/mpatfield/homebridge-econet-rheem/pulls).
|
|
116
|
-
|
|
117
|
-
Your contributions will help enhance the plugin's functionality and device support.
|
|
118
|
-
|
|
119
108
|
## Credits
|
|
120
109
|
|
|
121
110
|
[@w1ll1am23](https://github.com/sponsors/w1ll1am23) for earlier work done in [pyeconet](https://github.com/w1ll1am23/pyeconet), a Python 3 interface to the EcoNet API
|
package/package.json
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
"displayName": "Homebridge Econet Rheem",
|
|
5
5
|
"description": "Homebridge plugin for control of Rheem and Ruud thermostats and water heaters",
|
|
6
6
|
"type": "module",
|
|
7
|
-
"version": "1.6.0
|
|
7
|
+
"version": "1.6.0",
|
|
8
8
|
"homepage": "https://github.com/mpatfield/homebridge-econet-rheem#readme",
|
|
9
9
|
"repository": {
|
|
10
10
|
"type": "git",
|