homebridge-solaxcloud-api 2.5.0 → 2.5.1

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 (19) hide show
  1. package/CHANGELOG.md +172 -164
  2. package/LICENSE +175 -175
  3. package/README.md +223 -196
  4. package/config.sample +15 -15
  5. package/config.schema.json +113 -113
  6. package/dist/platformInverter.d.ts +5 -0
  7. package/dist/platformInverter.d.ts.map +1 -1
  8. package/dist/platformInverter.js +20 -7
  9. package/dist/platformInverter.js.map +1 -1
  10. package/package.json +60 -59
  11. package/test/batteryAccessory.test.ts +16 -16
  12. package/test/helpers.ts +80 -80
  13. package/test/lightSensorAccessory.test.ts +73 -73
  14. package/test/motionAccessory.test.ts +36 -36
  15. package/test/outletAccessory.test.ts +75 -75
  16. package/test/platformAccessory.test.ts +24 -24
  17. package/test/platformConfig.test.ts +188 -188
  18. package/test/platformTotalizer.test.ts +157 -123
  19. package/test/statistics.test.ts +50 -50
package/CHANGELOG.md CHANGED
@@ -1,164 +1,172 @@
1
- # Changelog
2
-
3
- All notable changes to this project will be documented in this file.
4
-
5
- ## [v2.5.0] - 2026-10-27
6
- ### Added
7
- * Added Matter electrical sensor support for power and cumulative energy in Apple Home.
8
- ### Changed
9
- * Updated the project for Homebridge 2.4, modern Node.js, TypeScript, and ESM compatibility.
10
- ### Fixed
11
- * Corrected Matter device registration, measurement schemas, unit conversions, and accessory deduplication.
12
-
13
- ## [v2.4.2] - 2026-06-03
14
- ### Changed
15
- * Bumped Homebridge Lib dependency.
16
- ### Fixed
17
- * Updated Eve HomeKit type loading for Homebridge Lib v8.
18
-
19
- ## [v2.4.1] - 2026-06-03
20
- ### Added
21
- * Added unit coverage for all accessory types, platform config validation, and totalizer inverter creation.
22
- * Added `enableHistory` config option to disable Eve/fakegato history services.
23
- ### Changed
24
- * Bumped Fakegato dependency.
25
- * Updated the test command to exit cleanly after running Mocha.
26
- ### Fixed
27
- * Handled malformed inverter entries cleanly during platform config validation.
28
-
29
- ## [v2.4.0] - 2026-06-03
30
- ### Changed
31
- * Replaced the local Solax Cloud API implementation with the external `solax-cloud-api` package.
32
- * Bumped Mocha test dependency.
33
- ### Fixed
34
- * Kept battery charge state reads in sync after updates.
35
- * Rejected polling frequencies that would break meter smoothing.
36
- * Prevented the multi-inverter totalizer from making cloud requests without real inverter credentials.
37
-
38
- ## [v2.3.3] - 2024-08-02
39
- ### Fixed
40
- * Updated URL for Solax cloud API fetches.
41
-
42
- ## [v2.3.2] - 2024-07-04
43
- ### Fixed
44
- * Updated README with fixed image logos.
45
- ### Changes
46
- * Bumped dependencies.
47
-
48
- ## [v2.3.1] - 2024-04-08
49
- ### Fixed
50
- * Changed max TokenID size to 24 ([#08](https://github.com/AllMightySauron/homebride-solaxcloud-api/issues/8)).
51
-
52
- ## [v2.3.0] - 2024-03-14
53
- ### Changes
54
- * Added support for inverters from QCells through the QCells cloud API.
55
- * **Breaking change** - plug-in configuration must be re-done to support inverters from multiple brands.
56
- * Bumped dependencies.
57
-
58
- ## [v2.1.12] - 2023-05-31
59
- ### Changes
60
- * Bumped dependencies.
61
-
62
- ## [v2.1.11] - 2023-03-14
63
- ### Changes
64
- * Bumped dependencies.
65
-
66
- ## [v2.1.10] - 2022-12-13
67
- ### Changes
68
- * Bumped dependencies.
69
-
70
- ## [v2.1.9] - 2022-11-16
71
- ### Changes
72
- * Bumped dependencies.
73
-
74
- ## [v2.1.8] - 2022-07-20
75
- ### Changes
76
- * Bumped dependencies.
77
- ### Fixed
78
- * Update on polling logic to prevent event memory leak issue ([#04](https://github.com/AllMightySauron/homebride-solaxcloud-api/issues/4)).
79
-
80
- ## [v2.1.7] - 2022-05-03
81
- ### Changes
82
- * Bumped dependencies.
83
- * Unit testing for multiple inverters.
84
- ### Fixed
85
- * Documentation updates.
86
-
87
- ## [v2.1.6] - 2022-04-07
88
- ### Changes
89
- * Battery totals SoC updated to "All inverters".
90
- ### Fixed
91
- * Compressed image size for README information.
92
-
93
- ## [v2.1.5] - 2022-04-07
94
- ### Changed
95
- * New inverter accessory **Battery** for State of Charge (SoC) information.
96
- * Support for battery charge level, charge state and low battery handler (<10%).
97
-
98
- ## [v2.1.4] - 2022-04-06
99
- ### Changed
100
- * Added "All inverters" virtual inverter for totalizing inverter figures for all sensors.
101
- * Preliminary battery support with **From Battery** and **To Battery** charge power ([#02](https://github.com/AllMightySauron/homebride-solaxcloud-api/issues/2)).
102
-
103
- ## [v2.1.2] - 2022-03-31
104
- ### Fixed
105
- * Bumped dependencies to latest versions.
106
- ### Changed
107
- * Initial support for multiple inverters.
108
-
109
- ## [v2.0.3] - 2022-01-25
110
- ### Fixed
111
- * Fixed dependabot detected vulnerabilities.
112
-
113
- ## [v2.0.2] - 2022-01-24
114
- ### Changed
115
- * Added support for "pure" Home app accessories (power consumption displayed as Ambient Light Sensors) ([#01](https://github.com/AllMightySauron/homebride-solaxcloud-api/issues/1)).
116
- * Created optional accessories to display smooth value from raw API data (minimizing sporadic events like a cloud passing).
117
-
118
- ## [v1.5.1] - 2022-01-08
119
- ### Fixed
120
- * Disabled repeat last data for history (connection problems may lead to strange values).
121
-
122
- ## [v1.5.0] - 2021-12-31
123
- ### Changed
124
- * Homebridge certified!
125
-
126
- ## [v1.4.6] - 2021-12-28
127
- ### Fixed
128
- * Added extended parameter check (including Solax Cloud limits).
129
-
130
- ## [v1.4.5] - 2021-12-27
131
- ### Fixed
132
- * Sanity checks for mandatory config parameters.
133
-
134
- ## [v1.4.4] - 2021-12-22
135
- ### Fixed
136
- * Automation example added to documentation.
137
-
138
- ## [v1.4.3] - 2021-12-21
139
- ### Fixed
140
- * Code cleanup and optimizations.
141
-
142
- ## [v1.4.1] - 2021-12-21
143
- ### Fixed
144
- * First working version with fakegato-history for Eve.
145
-
146
- ## [v1.4.0] - 2021-12-20
147
- ### Changed
148
- * Initial fakegato-history release for Eve.
149
-
150
- ## [v1.3.1] - 2021-12-14
151
- ### Fixed
152
- * Documentation updated to reflect new **Total Energy** characteristic on Inverter AC.
153
-
154
- ## [v1.3.0] - 2021-12-14
155
- ### Changed
156
- * Added support for total energy consumption.
157
-
158
- ## [v1.2.1] - 2021-12-14
159
- ### Fixed
160
- * Updates to the official documentation.
161
-
162
- ## [v1.2.0] - 2021-12-13
163
- ### Changed
164
- * First official release.
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file.
4
+
5
+ ## [v2.5.1] - 2026-10-28
6
+ ### Changed
7
+ * Matter electrical sensors are now created whenever Matter is enabled for the bridge; `pureHomeApp` is no longer required.
8
+ * Renamed the `pureHomeApp` UI option to clarify that it is only a legacy Apple Home fallback.
9
+ * Advertised both Matter and HAP support in the package metadata.
10
+ ### Fixed
11
+ * Decoupled Matter power and energy updates from the legacy `pureHomeApp` setting.
12
+
13
+ ## [v2.5.0] - 2026-10-27
14
+ ### Added
15
+ * Added Matter electrical sensor support for power and cumulative energy in Apple Home.
16
+ ### Changed
17
+ * Updated the project for Homebridge 2.4, modern Node.js, TypeScript, and ESM compatibility.
18
+ ### Fixed
19
+ * Corrected Matter device registration, measurement schemas, unit conversions, and accessory deduplication.
20
+
21
+ ## [v2.4.2] - 2026-06-03
22
+ ### Changed
23
+ * Bumped Homebridge Lib dependency.
24
+ ### Fixed
25
+ * Updated Eve HomeKit type loading for Homebridge Lib v8.
26
+
27
+ ## [v2.4.1] - 2026-06-03
28
+ ### Added
29
+ * Added unit coverage for all accessory types, platform config validation, and totalizer inverter creation.
30
+ * Added `enableHistory` config option to disable Eve/fakegato history services.
31
+ ### Changed
32
+ * Bumped Fakegato dependency.
33
+ * Updated the test command to exit cleanly after running Mocha.
34
+ ### Fixed
35
+ * Handled malformed inverter entries cleanly during platform config validation.
36
+
37
+ ## [v2.4.0] - 2026-06-03
38
+ ### Changed
39
+ * Replaced the local Solax Cloud API implementation with the external `solax-cloud-api` package.
40
+ * Bumped Mocha test dependency.
41
+ ### Fixed
42
+ * Kept battery charge state reads in sync after updates.
43
+ * Rejected polling frequencies that would break meter smoothing.
44
+ * Prevented the multi-inverter totalizer from making cloud requests without real inverter credentials.
45
+
46
+ ## [v2.3.3] - 2024-08-02
47
+ ### Fixed
48
+ * Updated URL for Solax cloud API fetches.
49
+
50
+ ## [v2.3.2] - 2024-07-04
51
+ ### Fixed
52
+ * Updated README with fixed image logos.
53
+ ### Changes
54
+ * Bumped dependencies.
55
+
56
+ ## [v2.3.1] - 2024-04-08
57
+ ### Fixed
58
+ * Changed max TokenID size to 24 ([#08](https://github.com/AllMightySauron/homebride-solaxcloud-api/issues/8)).
59
+
60
+ ## [v2.3.0] - 2024-03-14
61
+ ### Changes
62
+ * Added support for inverters from QCells through the QCells cloud API.
63
+ * **Breaking change** - plug-in configuration must be re-done to support inverters from multiple brands.
64
+ * Bumped dependencies.
65
+
66
+ ## [v2.1.12] - 2023-05-31
67
+ ### Changes
68
+ * Bumped dependencies.
69
+
70
+ ## [v2.1.11] - 2023-03-14
71
+ ### Changes
72
+ * Bumped dependencies.
73
+
74
+ ## [v2.1.10] - 2022-12-13
75
+ ### Changes
76
+ * Bumped dependencies.
77
+
78
+ ## [v2.1.9] - 2022-11-16
79
+ ### Changes
80
+ * Bumped dependencies.
81
+
82
+ ## [v2.1.8] - 2022-07-20
83
+ ### Changes
84
+ * Bumped dependencies.
85
+ ### Fixed
86
+ * Update on polling logic to prevent event memory leak issue ([#04](https://github.com/AllMightySauron/homebride-solaxcloud-api/issues/4)).
87
+
88
+ ## [v2.1.7] - 2022-05-03
89
+ ### Changes
90
+ * Bumped dependencies.
91
+ * Unit testing for multiple inverters.
92
+ ### Fixed
93
+ * Documentation updates.
94
+
95
+ ## [v2.1.6] - 2022-04-07
96
+ ### Changes
97
+ * Battery totals SoC updated to "All inverters".
98
+ ### Fixed
99
+ * Compressed image size for README information.
100
+
101
+ ## [v2.1.5] - 2022-04-07
102
+ ### Changed
103
+ * New inverter accessory **Battery** for State of Charge (SoC) information.
104
+ * Support for battery charge level, charge state and low battery handler (<10%).
105
+
106
+ ## [v2.1.4] - 2022-04-06
107
+ ### Changed
108
+ * Added "All inverters" virtual inverter for totalizing inverter figures for all sensors.
109
+ * Preliminary battery support with **From Battery** and **To Battery** charge power ([#02](https://github.com/AllMightySauron/homebride-solaxcloud-api/issues/2)).
110
+
111
+ ## [v2.1.2] - 2022-03-31
112
+ ### Fixed
113
+ * Bumped dependencies to latest versions.
114
+ ### Changed
115
+ * Initial support for multiple inverters.
116
+
117
+ ## [v2.0.3] - 2022-01-25
118
+ ### Fixed
119
+ * Fixed dependabot detected vulnerabilities.
120
+
121
+ ## [v2.0.2] - 2022-01-24
122
+ ### Changed
123
+ * Added support for "pure" Home app accessories (power consumption displayed as Ambient Light Sensors) ([#01](https://github.com/AllMightySauron/homebride-solaxcloud-api/issues/1)).
124
+ * Created optional accessories to display smooth value from raw API data (minimizing sporadic events like a cloud passing).
125
+
126
+ ## [v1.5.1] - 2022-01-08
127
+ ### Fixed
128
+ * Disabled repeat last data for history (connection problems may lead to strange values).
129
+
130
+ ## [v1.5.0] - 2021-12-31
131
+ ### Changed
132
+ * Homebridge certified!
133
+
134
+ ## [v1.4.6] - 2021-12-28
135
+ ### Fixed
136
+ * Added extended parameter check (including Solax Cloud limits).
137
+
138
+ ## [v1.4.5] - 2021-12-27
139
+ ### Fixed
140
+ * Sanity checks for mandatory config parameters.
141
+
142
+ ## [v1.4.4] - 2021-12-22
143
+ ### Fixed
144
+ * Automation example added to documentation.
145
+
146
+ ## [v1.4.3] - 2021-12-21
147
+ ### Fixed
148
+ * Code cleanup and optimizations.
149
+
150
+ ## [v1.4.1] - 2021-12-21
151
+ ### Fixed
152
+ * First working version with fakegato-history for Eve.
153
+
154
+ ## [v1.4.0] - 2021-12-20
155
+ ### Changed
156
+ * Initial fakegato-history release for Eve.
157
+
158
+ ## [v1.3.1] - 2021-12-14
159
+ ### Fixed
160
+ * Documentation updated to reflect new **Total Energy** characteristic on Inverter AC.
161
+
162
+ ## [v1.3.0] - 2021-12-14
163
+ ### Changed
164
+ * Added support for total energy consumption.
165
+
166
+ ## [v1.2.1] - 2021-12-14
167
+ ### Fixed
168
+ * Updates to the official documentation.
169
+
170
+ ## [v1.2.0] - 2021-12-13
171
+ ### Changed
172
+ * First official release.