homebridge-solaxcloud-api 2.3.0-beta.0 → 2.3.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.
Files changed (3) hide show
  1. package/CHANGELOG.md +116 -110
  2. package/README.md +194 -194
  3. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,111 +1,117 @@
1
- # Changelog
2
-
3
- All notable changes to this project will be documented in this file.
4
-
5
- ## [v2.1.12] - 2023-05-31
6
- ### Changes
7
- * Bumped dependencies.
8
-
9
- ## [v2.1.11] - 2023-03-14
10
- ### Changes
11
- * Bumped dependencies.
12
-
13
- ## [v2.1.10] - 2022-12-13
14
- ### Changes
15
- * Bumped dependencies.
16
-
17
- ## [v2.1.9] - 2022-11-16
18
- ### Changes
19
- * Bumped dependencies.
20
-
21
- ## [v2.1.8] - 2022-07-20
22
- ### Changes
23
- * Bumped dependencies.
24
- ### Fixed
25
- * Update on polling logic to prevent event memory leak issue ([#04](https://github.com/AllMightySauron/homebride-solaxcloud-api/issues/4)).
26
-
27
- ## [v2.1.7] - 2022-05-03
28
- ### Changes
29
- * Bumped dependencies.
30
- * Unit testing for multiple inverters.
31
- ### Fixed
32
- * Documentation updates.
33
-
34
- ## [v2.1.6] - 2022-04-07
35
- ### Changes
36
- * Battery totals SoC updated to "All inverters".
37
- ### Fixed
38
- * Compressed image size for README information.
39
-
40
- ## [v2.1.5] - 2022-04-07
41
- ### Changed
42
- * New inverter accessory **Battery** for State of Charge (SoC) information.
43
- * Support for battery charge level, charge state and low battery handler (<10%).
44
-
45
- ## [v2.1.4] - 2022-04-06
46
- ### Changed
47
- * Added "All inverters" virtual inverter for totalizing inverter figures for all sensors.
48
- * Preliminary battery support with **From Battery** and **To Battery** charge power ([#02](https://github.com/AllMightySauron/homebride-solaxcloud-api/issues/2)).
49
-
50
- ## [v2.1.2] - 2022-03-31
51
- ### Fixed
52
- * Bumped dependencies to latest versions.
53
- ### Changed
54
- * Initial support for multiple inverters.
55
-
56
- ## [v2.0.3] - 2022-01-25
57
- ### Fixed
58
- * Fixed dependabot detected vulnerabilities.
59
-
60
- ## [v2.0.2] - 2022-01-24
61
- ### Changed
62
- * Added support for "pure" Home app accessories (power consumption displayed as Ambient Light Sensors) ([#01](https://github.com/AllMightySauron/homebride-solaxcloud-api/issues/1)).
63
- * Created optional accessories to display smooth value from raw API data (minimizing sporadic events like a cloud passing).
64
-
65
- ## [v1.5.1] - 2022-01-08
66
- ### Fixed
67
- * Disabled repeat last data for history (connection problems may lead to strange values).
68
-
69
- ## [v1.5.0] - 2021-12-31
70
- ### Changed
71
- * Homebridge certified!
72
-
73
- ## [v1.4.6] - 2021-12-28
74
- ### Fixed
75
- * Added extended parameter check (including Solax Cloud limits).
76
-
77
- ## [v1.4.5] - 2021-12-27
78
- ### Fixed
79
- * Sanity checks for mandatory config parameters.
80
-
81
- ## [v1.4.4] - 2021-12-22
82
- ### Fixed
83
- * Automation example added to documentation.
84
-
85
- ## [v1.4.3] - 2021-12-21
86
- ### Fixed
87
- * Code cleanup and optimizations.
88
-
89
- ## [v1.4.1] - 2021-12-21
90
- ### Fixed
91
- * First working version with fakegato-history for Eve.
92
-
93
- ## [v1.4.0] - 2021-12-20
94
- ### Changed
95
- * Initial fakegato-history release for Eve.
96
-
97
- ## [v1.3.1] - 2021-12-14
98
- ### Fixed
99
- * Documentation updated to reflect new **Total Energy** characteristic on Inverter AC.
100
-
101
- ## [v1.3.0] - 2021-12-14
102
- ### Changed
103
- * Added support for total energy consumption.
104
-
105
- ## [v1.2.1] - 2021-12-14
106
- ### Fixed
107
- * Updates to the official documentation.
108
-
109
- ## [v1.2.0] - 2021-12-13
110
- ### Changed
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file.
4
+
5
+ ## [v2.3.0] - 2024-03-14
6
+ ### Changes
7
+ * Added support for inverters from QCells through the QCells cloud API.
8
+ * **Breaking change** - plug-in configuration must be re-done to support inverters from multiple brands.
9
+ * Bumped dependencies.
10
+
11
+ ## [v2.1.12] - 2023-05-31
12
+ ### Changes
13
+ * Bumped dependencies.
14
+
15
+ ## [v2.1.11] - 2023-03-14
16
+ ### Changes
17
+ * Bumped dependencies.
18
+
19
+ ## [v2.1.10] - 2022-12-13
20
+ ### Changes
21
+ * Bumped dependencies.
22
+
23
+ ## [v2.1.9] - 2022-11-16
24
+ ### Changes
25
+ * Bumped dependencies.
26
+
27
+ ## [v2.1.8] - 2022-07-20
28
+ ### Changes
29
+ * Bumped dependencies.
30
+ ### Fixed
31
+ * Update on polling logic to prevent event memory leak issue ([#04](https://github.com/AllMightySauron/homebride-solaxcloud-api/issues/4)).
32
+
33
+ ## [v2.1.7] - 2022-05-03
34
+ ### Changes
35
+ * Bumped dependencies.
36
+ * Unit testing for multiple inverters.
37
+ ### Fixed
38
+ * Documentation updates.
39
+
40
+ ## [v2.1.6] - 2022-04-07
41
+ ### Changes
42
+ * Battery totals SoC updated to "All inverters".
43
+ ### Fixed
44
+ * Compressed image size for README information.
45
+
46
+ ## [v2.1.5] - 2022-04-07
47
+ ### Changed
48
+ * New inverter accessory **Battery** for State of Charge (SoC) information.
49
+ * Support for battery charge level, charge state and low battery handler (<10%).
50
+
51
+ ## [v2.1.4] - 2022-04-06
52
+ ### Changed
53
+ * Added "All inverters" virtual inverter for totalizing inverter figures for all sensors.
54
+ * Preliminary battery support with **From Battery** and **To Battery** charge power ([#02](https://github.com/AllMightySauron/homebride-solaxcloud-api/issues/2)).
55
+
56
+ ## [v2.1.2] - 2022-03-31
57
+ ### Fixed
58
+ * Bumped dependencies to latest versions.
59
+ ### Changed
60
+ * Initial support for multiple inverters.
61
+
62
+ ## [v2.0.3] - 2022-01-25
63
+ ### Fixed
64
+ * Fixed dependabot detected vulnerabilities.
65
+
66
+ ## [v2.0.2] - 2022-01-24
67
+ ### Changed
68
+ * Added support for "pure" Home app accessories (power consumption displayed as Ambient Light Sensors) ([#01](https://github.com/AllMightySauron/homebride-solaxcloud-api/issues/1)).
69
+ * Created optional accessories to display smooth value from raw API data (minimizing sporadic events like a cloud passing).
70
+
71
+ ## [v1.5.1] - 2022-01-08
72
+ ### Fixed
73
+ * Disabled repeat last data for history (connection problems may lead to strange values).
74
+
75
+ ## [v1.5.0] - 2021-12-31
76
+ ### Changed
77
+ * Homebridge certified!
78
+
79
+ ## [v1.4.6] - 2021-12-28
80
+ ### Fixed
81
+ * Added extended parameter check (including Solax Cloud limits).
82
+
83
+ ## [v1.4.5] - 2021-12-27
84
+ ### Fixed
85
+ * Sanity checks for mandatory config parameters.
86
+
87
+ ## [v1.4.4] - 2021-12-22
88
+ ### Fixed
89
+ * Automation example added to documentation.
90
+
91
+ ## [v1.4.3] - 2021-12-21
92
+ ### Fixed
93
+ * Code cleanup and optimizations.
94
+
95
+ ## [v1.4.1] - 2021-12-21
96
+ ### Fixed
97
+ * First working version with fakegato-history for Eve.
98
+
99
+ ## [v1.4.0] - 2021-12-20
100
+ ### Changed
101
+ * Initial fakegato-history release for Eve.
102
+
103
+ ## [v1.3.1] - 2021-12-14
104
+ ### Fixed
105
+ * Documentation updated to reflect new **Total Energy** characteristic on Inverter AC.
106
+
107
+ ## [v1.3.0] - 2021-12-14
108
+ ### Changed
109
+ * Added support for total energy consumption.
110
+
111
+ ## [v1.2.1] - 2021-12-14
112
+ ### Fixed
113
+ * Updates to the official documentation.
114
+
115
+ ## [v1.2.0] - 2021-12-13
116
+ ### Changed
111
117
  * First official release.
package/README.md CHANGED
@@ -1,194 +1,194 @@
1
-
2
- <table cellspacing="0" cellpadding="0">
3
- <tr>
4
- <td align="center"><img src="https://github.com/homebridge/branding/raw/master/logos/homebridge-wordmark-logo-vertical.png" width="150"></td>
5
- <td align="center"><img src="https://www.solaxpower.com/wp-content/uploads/2020/03/weblogo5.png" width="300"></td>
6
- <tr>
7
- </table>
8
-
9
- # Solax Cloud Plugin for Homebridge
10
-
11
- ![npm](https://badgen.net/npm/v/homebridge-solaxcloud-api) ![npm](https://badgen.net/npm/dt/homebridge-solaxcloud-api) [![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
12
-
13
-
14
- The Solax Cloud Plugin for [Homebridge](https://homebridge.io/) was created as a platform plugin to gather data exposed by **Solax inverters** to the cloud through the [Solax Cloud API](https://www.solaxcloud.com/phoebus/resource/files/userGuide/Solax_API.pdf). Please note that **QCells inverters** all also supported cloud requests sharea a similar approach.
15
-
16
- Now with support for **multiple inverters**! Sensors will be created for each of the inverters present in the configuration. Additionally, a virtual inverter named "All inverters" will be created whenever a multiple inverters configuration is present. This inverter will present summarized power and consumption figures derived from data for all the physical inverters.
17
-
18
- As HomeKit is still clueless about what a solar panel is, this plugin exposes a set of standard HomeKit accessories though Homebridge for each configured inverter that will allow interacting and automating your smart home based on the data made available from the Solax platform:
19
-
20
- - **PV** (PV outlet with power consumption)
21
- - **AC** (Inverter AC outlet with power and total energy consumptions)
22
- - **To Grid** (Inverter to Grid outlet with power consumption)
23
- - **To House** (Inverter to House outlet with power consumption)
24
- - **From Grid** (Grid to House outlet with power consumption)
25
- - **Update** (Motion sensor)
26
-
27
- Battery information is also provided as Homekit accessories in case there are any batteries installed for any of the configured inverters:
28
-
29
- - **To Battery** (Outlet with inverter power charging the battery)
30
- - **From Battery** (Outlet with power drawn from the battery to the inverter)
31
- - **Battery** (Battery with State of Charge information such as level or charge state)
32
-
33
- <img src="images/plugin-accessories-home.png" width="50%" height="50%">
34
-
35
- Please note that additional accessories are created by default with smooth power consumption curves (by applying either a simple or exponential moving average to the power series). This prevents sporadic events like a cloud passing by to have an immediate affect on provided meters.
36
-
37
- ## Required information
38
-
39
- For this plugin to work, two critical pieces of information are required from Solax/QCells Cloud:
40
-
41
- - **Token ID**: Solax/Qcells users can get inverter information through the granted tokenID. You need to obtain your tokenID on the API page of Solax/Qcells cloud.
42
- - **SN**: Registration No (communication module SN) for each desired inverter.
43
-
44
- ## Installation
45
-
46
- This plugin is supported under Homebridge. It is highly recommended that you use Homebridge Config UI X to install and configure this plugin.
47
-
48
- ### Manual Installation
49
-
50
- Install this plugin using: `sudo npm install -g homebridge-solaxcloud-api`.
51
- Edit `config.json` manually to add your Solax inverters. See below for instructions on that.
52
-
53
- ## Platform configuration
54
-
55
- Minimal platform configuration is depicted by the example configuration file below:
56
-
57
- ```json
58
- {
59
- "platforms": [
60
- {
61
- "platform": "SolaxCloudAPI",
62
- "inverters": [
63
- {
64
- "brand": "solax",
65
- "tokenId": "20200722185111234567890",
66
- "name": "Solax",
67
- "sn": "ABCDEFGHIJ"
68
- }
69
- ],
70
- }
71
- ]
72
- }
73
- ```
74
- Configuration parameters are described on the table below:
75
-
76
- | **Parameter** | **Type** | **Description** | **Default** | **Mandatory?** |
77
- | ------------------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------:| :------------: |
78
- | `platform` | string | Platform name (must be SolaxCloudAPI) | - | Y |
79
- | `inverters` | array | Array of configured inverters as objects with `{ brand: string, tokenId: string, name: string, sn: string, hasBattery: boolean }`, where `brand` is "solax" or "qcells", `tokenID` is the access token retrieved from the API page of Solax/QCells Cloud, `name` is the inverter name, used as prefix for accessory naming, `sn` is the inverter registration no. (inverter module SN) and `hasBattery` indicates on whether this inverter is connected to a battery. | - | Y |
80
- | `pollingFrequency` | number | Plugin data polling frequency from Solax Cloud (in seconds) | 300 | N |
81
- | `smoothingMeters` | boolean | Whether to create additional meters by smoothing raw values from Solax Cloud | true | N |
82
- | `smoothingMethod` | string | Statistical method to use for smoothing raw values from Solax Cloud (simple or exponential moving average - "sma" or "ema") | "sma" | N |
83
- | `pureHomeApp` | boolean | Whether to create meters as standard accessories that can be used on the Home App (power will show as ambient light sensors) | false | N |
84
-
85
- **NOTE:** The `pollingFrequency` parameter defaults to 300 seconds, since Solax/QCells inverters update cloud data every 5 minutes.
86
-
87
- Configuration through the the use of [Homebridge UI](https://github.com/oznu/homebridge-config-ui-x) plugin is also available and recommended:
88
-
89
- <img src="images/homebridge-ui.png" width="100%" height="100%">
90
-
91
- ## Non-standard characteristics
92
-
93
- Non-standard accessory characteristics are available through the use of [Eve for HomeKit app](https://apps.apple.com/us/app/eve-for-homekit/id917695792) you may download from the App Store.
94
-
95
- This will allow some non-standard characteristics to be visible along with its historical data (like power or total energy consumption), as depicted in the image below:
96
-
97
- <img src="images/plugin-outlet-consumption.png" width="50%" height="50%">
98
-
99
- If you want to rely solely on the native Home App, please enable the `pureHomeApp` config setting. In this case, power consumption on each meter will be exposed as an Ambient Light Sensor, as shown below (minimum value for an Ambient Light Sensor is 0.1 lux):
100
-
101
- <img src="images/plugin-accessories-home-pure.png" width="50%" height="50%">
102
-
103
- # Automation
104
-
105
- Automation can be achieved with the help of the virtual **Update** motion sensor that was specifically tailored for this effect and which is available for each inverter. This motion sensor will be triggered whenever inverter data gets updated from the Solax Cloud API (according to what is defined on the `pollingFrequency` configuration setting).
106
-
107
- <img src="images/plugin-accessories-eve.png" width="50%" height="50%">
108
-
109
- Motion is detected by the **Update** motion sensor whenever there is newly fetched inverter data from Solax Cloud. Using this sensor as a trigger combined with power and energy data from the virtual outlets enumerated above forms the basic building blocks for defining an automation.
110
-
111
- ## Automation example
112
-
113
- Since automations are probably going to be dependent on the non-standard **Consumption** characteristics from the virtual outlets, these must created by using the Eve App.
114
-
115
- As an automation example, let's imagine we want to turn a pool heater pump on whenever the inverter AC power is greater than a specific figure (in Watt):
116
-
117
- <table cellspacing="0" cellpadding="0">
118
- <tr>
119
- <td width="50%">1. Under Automation, select <b>Rules</b></td>
120
- <td width="50%">2. Click <b>Next</b></td>
121
- </tr>
122
- <tr>
123
- <td><img src="images/automation/automation_1.png"></td>
124
- <td><img src="images/automation/automation_2.png"></td>
125
- </tr>
126
- <tr>
127
- <td>3. Click <b>Add Trigger</b></td>
128
- <td>4. Select <b>Motion</b> as trigger type</td>
129
- </tr>
130
- <tr>
131
- <td><img src="images/automation/automation_3.png"></td>
132
- <td><img src="images/automation/automation_4.png"></td>
133
- </tr>
134
- <tr>
135
- <td>5. Select the Solax <b>Update</b> motion detector and set <b>Motion</b> as trigger</td>
136
- <td>6. Click <b>Next</b></td>
137
- </tr>
138
- <tr>
139
- <td><img src="images/automation/automation_5.png"></td>
140
- <td><img src="images/automation/automation_6.png"></td>
141
- </tr>
142
- <tr>
143
- <td>7. Select <b>Add Value Condition</b></td>
144
- <td>8. Choose <b>Inverter AC Consumption</b> as characteristic and elect <b>&gt=</b> a desired value</b></td>
145
- </tr>
146
- <tr>
147
- <td><img src="images/automation/automation_7.png"></td>
148
- <td><img src="images/automation/automation_8.png"></td>
149
- </tr>
150
- <tr>
151
- <td>9. Click <b>Next</b></td>
152
- <td>10. If no scene exists, click <b>Add Scene</b></td>
153
- </tr>
154
- <tr>
155
- <td><img src="images/automation/automation_9.png"></td>
156
- <td><img src="images/automation/automation_10.png"></td>
157
- </tr>
158
- <tr>
159
- <td>11. Click <b>Add Actions</b></td>
160
- <td>12. Select the accessory to be controlled (in this case <b>Garden Pool Outlet</b> will be turned <b>ON</b>)</td>
161
- </tr>
162
- <tr>
163
- <td><img src="images/automation/automation_11.png"></td>
164
- <td><img src="images/automation/automation_12.png"></td>
165
- </tr>
166
- <tr>
167
- <td>13. Click <b>Next</b></td>
168
- <td>14. Name your scene and click <b>Done</b></td>
169
- </tr>
170
- <tr>
171
- <td><img src="images/automation/automation_13.png"></td>
172
- <td><img src="images/automation/automation_14.png"></td>
173
- </tr>
174
- <tr>
175
- <td>15. Click <b>Next</b></td>
176
- <td>16. Name your rule and click <b>Done</b></td>
177
- </tr>
178
- <tr>
179
- <td><img src="images/automation/automation_15.png"></td>
180
- <td><img src="images/automation/automation_16.png"></td>
181
- </tr>
182
- </table>
183
-
184
- # TO DO
185
-
186
- Next planned plugin releases should include:
187
-
188
- - [X] **Inverter AC** to include Total Yield Energy
189
- - [X] Consumption history through the [fakegato-history](https://github.com/simont77/fakegato-history) module
190
- - [x] Enable support for "pure" Home App accessories (power meters will be exposed as Ambient Light sensors)
191
- - [x] Add "smooth" accessories for power meters (compensating for sporadic scenarios like cloud a passing)
192
- - [x] Support for multiple inverters
193
- - [x] Support for multiple brands (between Solax and QCells)
194
- - [x] Accessories for battery state and consumptions
1
+
2
+ <table cellspacing="0" cellpadding="0">
3
+ <tr>
4
+ <td align="center"><img src="https://github.com/homebridge/branding/raw/master/logos/homebridge-wordmark-logo-vertical.png" width="150"></td>
5
+ <td align="center"><img src="https://www.solaxpower.com/wp-content/uploads/2020/03/weblogo5.png" width="300"></td>
6
+ <tr>
7
+ </table>
8
+
9
+ # Solax Cloud Plugin for Homebridge
10
+
11
+ ![npm](https://badgen.net/npm/v/homebridge-solaxcloud-api) ![npm](https://badgen.net/npm/dt/homebridge-solaxcloud-api) [![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
12
+
13
+
14
+ The Solax Cloud Plugin for [Homebridge](https://homebridge.io/) was created as a platform plugin to gather data exposed by **Solax inverters** to the cloud through the [Solax Cloud API](https://www.solaxcloud.com/phoebus/resource/files/userGuide/Solax_API.pdf). Please note that **QCells inverters** all also supported cloud requests sharea a similar approach.
15
+
16
+ Now with support for **multiple inverters**! Sensors will be created for each of the inverters present in the configuration. Additionally, a virtual inverter named "All inverters" will be created whenever a multiple inverters configuration is present. This inverter will present summarized power and consumption figures derived from data for all the physical inverters.
17
+
18
+ As HomeKit is still clueless about what a solar panel is, this plugin exposes a set of standard HomeKit accessories though Homebridge for each configured inverter that will allow interacting and automating your smart home based on the data made available from the Solax platform:
19
+
20
+ - **PV** (PV outlet with power consumption)
21
+ - **AC** (Inverter AC outlet with power and total energy consumptions)
22
+ - **To Grid** (Inverter to Grid outlet with power consumption)
23
+ - **To House** (Inverter to House outlet with power consumption)
24
+ - **From Grid** (Grid to House outlet with power consumption)
25
+ - **Update** (Motion sensor)
26
+
27
+ Battery information is also provided as Homekit accessories in case there are any batteries installed for any of the configured inverters:
28
+
29
+ - **To Battery** (Outlet with inverter power charging the battery)
30
+ - **From Battery** (Outlet with power drawn from the battery to the inverter)
31
+ - **Battery** (Battery with State of Charge information such as level or charge state)
32
+
33
+ <img src="images/plugin-accessories-home.png" width="50%" height="50%">
34
+
35
+ Please note that additional accessories are created by default with smooth power consumption curves (by applying either a simple or exponential moving average to the power series). This prevents sporadic events like a cloud passing by to have an immediate affect on provided meters.
36
+
37
+ ## Required information
38
+
39
+ For this plugin to work, two critical pieces of information are required from Solax/QCells Cloud:
40
+
41
+ - **Token ID**: Solax/Qcells users can get inverter information through the granted tokenID. You need to obtain your tokenID on the API page of Solax/Qcells cloud.
42
+ - **SN**: Registration No (communication module SN) for each desired inverter.
43
+
44
+ ## Installation
45
+
46
+ This plugin is supported under Homebridge. It is highly recommended that you use Homebridge Config UI X to install and configure this plugin.
47
+
48
+ ### Manual Installation
49
+
50
+ Install this plugin using: `sudo npm install -g homebridge-solaxcloud-api`.
51
+ Edit `config.json` manually to add your Solax inverters. See below for instructions on that.
52
+
53
+ ## Platform configuration
54
+
55
+ Minimal platform configuration is depicted by the example configuration file below:
56
+
57
+ ```json
58
+ {
59
+ "platforms": [
60
+ {
61
+ "platform": "SolaxCloudAPI",
62
+ "inverters": [
63
+ {
64
+ "brand": "solax",
65
+ "tokenId": "20200722185111234567890",
66
+ "name": "Solax",
67
+ "sn": "ABCDEFGHIJ"
68
+ }
69
+ ],
70
+ }
71
+ ]
72
+ }
73
+ ```
74
+ Configuration parameters are described on the table below:
75
+
76
+ | **Parameter** | **Type** | **Description** | **Default** | **Mandatory?** |
77
+ | ------------------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------:| :------------: |
78
+ | `platform` | string | Platform name (must be SolaxCloudAPI) | - | Y |
79
+ | `inverters` | array | Array of configured inverters as objects with `{ brand: string, tokenId: string, name: string, sn: string, hasBattery: boolean }`, where `brand` is "solax" or "qcells", `tokenID` is the access token retrieved from the API page of Solax/QCells Cloud, `name` is the inverter name, used as prefix for accessory naming, `sn` is the inverter registration no. (inverter module SN) and `hasBattery` indicates on whether this inverter is connected to a battery. | - | Y |
80
+ | `pollingFrequency` | number | Plugin data polling frequency from Solax Cloud (in seconds) | 300 | N |
81
+ | `smoothingMeters` | boolean | Whether to create additional meters by smoothing raw values from Solax Cloud | true | N |
82
+ | `smoothingMethod` | string | Statistical method to use for smoothing raw values from Solax Cloud (simple or exponential moving average - "sma" or "ema") | "sma" | N |
83
+ | `pureHomeApp` | boolean | Whether to create meters as standard accessories that can be used on the Home App (power will show as ambient light sensors) | false | N |
84
+
85
+ **NOTE:** The `pollingFrequency` parameter defaults to 300 seconds, since Solax/QCells inverters update cloud data every 5 minutes.
86
+
87
+ Configuration through the the use of [Homebridge UI](https://github.com/oznu/homebridge-config-ui-x) plugin is also available and recommended:
88
+
89
+ <img src="images/homebridge-ui.png" width="100%" height="100%">
90
+
91
+ ## Non-standard characteristics
92
+
93
+ Non-standard accessory characteristics are available through the use of [Eve for HomeKit app](https://apps.apple.com/us/app/eve-for-homekit/id917695792) you may download from the App Store.
94
+
95
+ This will allow some non-standard characteristics to be visible along with its historical data (like power or total energy consumption), as depicted in the image below:
96
+
97
+ <img src="images/plugin-outlet-consumption.png" width="50%" height="50%">
98
+
99
+ If you want to rely solely on the native Home App, please enable the `pureHomeApp` config setting. In this case, power consumption on each meter will be exposed as an Ambient Light Sensor, as shown below (minimum value for an Ambient Light Sensor is 0.1 lux):
100
+
101
+ <img src="images/plugin-accessories-home-pure.png" width="50%" height="50%">
102
+
103
+ # Automation
104
+
105
+ Automation can be achieved with the help of the virtual **Update** motion sensor that was specifically tailored for this effect and which is available for each inverter. This motion sensor will be triggered whenever inverter data gets updated from the Solax Cloud API (according to what is defined on the `pollingFrequency` configuration setting).
106
+
107
+ <img src="images/plugin-accessories-eve.png" width="50%" height="50%">
108
+
109
+ Motion is detected by the **Update** motion sensor whenever there is newly fetched inverter data from Solax Cloud. Using this sensor as a trigger combined with power and energy data from the virtual outlets enumerated above forms the basic building blocks for defining an automation.
110
+
111
+ ## Automation example
112
+
113
+ Since automations are probably going to be dependent on the non-standard **Consumption** characteristics from the virtual outlets, these must created by using the Eve App.
114
+
115
+ As an automation example, let's imagine we want to turn a pool heater pump on whenever the inverter AC power is greater than a specific figure (in Watt):
116
+
117
+ <table cellspacing="0" cellpadding="0">
118
+ <tr>
119
+ <td width="50%">1. Under Automation, select <b>Rules</b></td>
120
+ <td width="50%">2. Click <b>Next</b></td>
121
+ </tr>
122
+ <tr>
123
+ <td><img src="images/automation/automation_1.png"></td>
124
+ <td><img src="images/automation/automation_2.png"></td>
125
+ </tr>
126
+ <tr>
127
+ <td>3. Click <b>Add Trigger</b></td>
128
+ <td>4. Select <b>Motion</b> as trigger type</td>
129
+ </tr>
130
+ <tr>
131
+ <td><img src="images/automation/automation_3.png"></td>
132
+ <td><img src="images/automation/automation_4.png"></td>
133
+ </tr>
134
+ <tr>
135
+ <td>5. Select the Solax <b>Update</b> motion detector and set <b>Motion</b> as trigger</td>
136
+ <td>6. Click <b>Next</b></td>
137
+ </tr>
138
+ <tr>
139
+ <td><img src="images/automation/automation_5.png"></td>
140
+ <td><img src="images/automation/automation_6.png"></td>
141
+ </tr>
142
+ <tr>
143
+ <td>7. Select <b>Add Value Condition</b></td>
144
+ <td>8. Choose <b>Inverter AC Consumption</b> as characteristic and elect <b>&gt=</b> a desired value</b></td>
145
+ </tr>
146
+ <tr>
147
+ <td><img src="images/automation/automation_7.png"></td>
148
+ <td><img src="images/automation/automation_8.png"></td>
149
+ </tr>
150
+ <tr>
151
+ <td>9. Click <b>Next</b></td>
152
+ <td>10. If no scene exists, click <b>Add Scene</b></td>
153
+ </tr>
154
+ <tr>
155
+ <td><img src="images/automation/automation_9.png"></td>
156
+ <td><img src="images/automation/automation_10.png"></td>
157
+ </tr>
158
+ <tr>
159
+ <td>11. Click <b>Add Actions</b></td>
160
+ <td>12. Select the accessory to be controlled (in this case <b>Garden Pool Outlet</b> will be turned <b>ON</b>)</td>
161
+ </tr>
162
+ <tr>
163
+ <td><img src="images/automation/automation_11.png"></td>
164
+ <td><img src="images/automation/automation_12.png"></td>
165
+ </tr>
166
+ <tr>
167
+ <td>13. Click <b>Next</b></td>
168
+ <td>14. Name your scene and click <b>Done</b></td>
169
+ </tr>
170
+ <tr>
171
+ <td><img src="images/automation/automation_13.png"></td>
172
+ <td><img src="images/automation/automation_14.png"></td>
173
+ </tr>
174
+ <tr>
175
+ <td>15. Click <b>Next</b></td>
176
+ <td>16. Name your rule and click <b>Done</b></td>
177
+ </tr>
178
+ <tr>
179
+ <td><img src="images/automation/automation_15.png"></td>
180
+ <td><img src="images/automation/automation_16.png"></td>
181
+ </tr>
182
+ </table>
183
+
184
+ # TO DO
185
+
186
+ Next planned plugin releases should include:
187
+
188
+ - [X] **Inverter AC** to include Total Yield Energy
189
+ - [X] Consumption history through the [fakegato-history](https://github.com/simont77/fakegato-history) module
190
+ - [x] Enable support for "pure" Home App accessories (power meters will be exposed as Ambient Light sensors)
191
+ - [x] Add "smooth" accessories for power meters (compensating for sporadic scenarios like cloud a passing)
192
+ - [x] Support for multiple inverters
193
+ - [x] Support for multiple brands (between Solax and QCells)
194
+ - [x] Accessories for battery state and consumptions
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "private": false,
3
3
  "displayName": "Homebridge Solax Cloud API",
4
4
  "name": "homebridge-solaxcloud-api",
5
- "version": "2.3.0-beta.0",
5
+ "version": "2.3.0",
6
6
  "description": "Integrates solar production info using public Solax/QCells Cloud API into Homebridge accessories.",
7
7
  "license": "Apache-2.0",
8
8
  "repository": {