homebridge-econet-rheem 1.0.1 → 1.0.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 (3) hide show
  1. package/README.md +12 -9
  2. package/config.schema.json +1 -1
  3. package/package.json +9 -9
package/README.md CHANGED
@@ -1,10 +1,15 @@
1
1
  <p align="center">
2
- <img src="https://github.com/homebridge/branding/raw/latest/logos/homebridge-wordmark-logo-vertical.png" width="150">
2
+ <img src="https://github.com/mpatfield/homebridge-econet-rheem/blob/latest/icon.png" width="100">
3
3
  </p>
4
4
 
5
5
  # Homebridge EcoNet Rheem Plugin
6
6
 
7
- This Homebridge plugin integrates Rheem EcoNet-enabled devices into Apple HomeKit. **Currently, only Water Heaters have been fully implemented and tested.** Thermostat support and Celsius operation remain untested.
7
+ This Homebridge plugin integrates Rheem EcoNet-enabled devices into Apple HomeKit.
8
+
9
+ > [!NOTE]
10
+ > This plugin uses an unofficial Econet API and could stop working at any time without warning.
11
+
12
+ Currently, only water heaters in Fahrenheit have been fully implemented and tested. Thermostat implementation is incomplete and Celsius operation remains untested.
8
13
 
9
14
  ## Installation
10
15
 
@@ -37,12 +42,6 @@ Add the following to your Homebridge `config.json`:
37
42
  - `password`: (Required) Your Econet account password.
38
43
  - `debug`: (Optional) Set to `true` to enable debug logging. Default is `false`.
39
44
 
40
- ## Current Limitations
41
-
42
- - **Water Heaters**: Fully implemented and tested in Farenheit.
43
- - **Thermostats**: Not implemented or tested due to lack of hardware access.
44
- - **Celsius Operation**: Untested.
45
-
46
45
  ## Contributing
47
46
 
48
47
  Contributions to support Thermostat operation are welcome. To assist:
@@ -61,4 +60,8 @@ Your contributions will help enhance the plugin's functionality and device suppo
61
60
 
62
61
  ## Disclaimer
63
62
 
64
- This plugin is independently developed and is not affiliated with or endorsed by Rheem Manufacturing Company.
63
+ This plugin is independently developed and is not in any way affiliated with or endorsed by Rheem.
64
+
65
+ ## Credits
66
+
67
+ Econet API is heavily influenced by [pyeconet](https://github.com/w1ll1am23/pyeconet).
package/config.schema.json CHANGED
@@ -20,7 +20,7 @@
20
20
  "description": "Rheem/Econet account password"
21
21
  },
22
22
  "debug": {
23
- "title": "Password",
23
+ "title": "Debug",
24
24
  "type": "boolean",
25
25
  "required": false,
26
26
  "description": "Enabled additional debug logging"
package/package.json CHANGED
@@ -4,18 +4,16 @@
4
4
  "displayName": "Homebridge Econet Rheem",
5
5
  "description": "Homebridge plugin based on pyeconet for control of Rheem water heaters",
6
6
  "type": "module",
7
- "version": "1.0.1",
7
+ "version": "1.0.3",
8
8
  "homepage": "https://github.com/mpatfield/homebridge-econet-rheem#readme",
9
9
  "repository": {
10
10
  "type": "git",
11
11
  "url": "https://github.com/mpatfield/homebridge-econet-rheem.git"
12
12
  },
13
- "funding": [
14
- {
15
- "type": "github",
16
- "url": "https://github.com/sponsors/mpatfield"
17
- }
18
- ],
13
+ "funding": {
14
+ "type": "github",
15
+ "url": "https://github.com/sponsors/mpatfield"
16
+ },
19
17
  "bugs": {
20
18
  "url": "https://github.com/mpatfield/homebridge-econet-rheem/issues"
21
19
  },
@@ -38,13 +36,11 @@
38
36
  "homebridge": "^1.8.0 || ^2.0.0-beta.0"
39
37
  },
40
38
  "dependencies": {
41
- "axios": "^1.7.2",
42
39
  "homebridge-lib": "^7.1.4",
43
40
  "mqtt": "^5.7.0"
44
41
  },
45
42
  "devDependencies": {
46
43
  "@eslint/js": "^9.21.0",
47
- "@types/axios": "^0.14.0",
48
44
  "@types/node": "^22.13.5",
49
45
  "eslint": "^9.24.0",
50
46
  "homebridge": "^2.0.0-beta.0",
@@ -54,6 +50,10 @@
54
50
  "typescript": "^5.7.3",
55
51
  "typescript-eslint": "^8.24.1"
56
52
  },
53
+ "homebridge": {
54
+ "platform": "HomebridgeEconetRheem",
55
+ "name": "homebridge-econet-rheem"
56
+ },
57
57
  "author": {
58
58
  "name": "mpatfield"
59
59
  },