homebridge-solaxcloud-api 1.2.0 → 1.2.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.
package/README.md
CHANGED
|
@@ -8,10 +8,12 @@
|
|
|
8
8
|
|
|
9
9
|
# Solax Cloud Plugin for Homebridge
|
|
10
10
|
|
|
11
|
+
 
|
|
11
12
|
|
|
12
|
-
This Homebridge platform plugin was created to gather data from the Solax Cloud API (as documented in the official [Solax Cloud API](https://www.eu.solaxcloud.com/phoebus/resource/files/userGuide/Solax_API_for_End-user_V1.0.pdf)) by relying on the provided TokenID and SN.
|
|
13
13
|
|
|
14
|
-
This
|
|
14
|
+
This [Homebridge](https://homebridge.io/) platform plugin was created to gather data from the Solax Cloud API (as documented in the official [Solax Cloud API](https://www.eu.solaxcloud.com/phoebus/resource/files/userGuide/Solax_API_for_End-user_V1.0.pdf)) by relying on the provided TokenID and SN.
|
|
15
|
+
|
|
16
|
+
HomeKit is still clueless about what a solar panel is. So, this Solax Cloud Plugin exposes a set of standard HomeKit accessories though Homebridge that will allow interacting and automating your smart home based on the data available from the Solax platform:
|
|
15
17
|
|
|
16
18
|
- Inverter PV (outlet with power consumption)
|
|
17
19
|
- Inverter AC (outlet with power consumption)
|
|
@@ -20,6 +22,8 @@ This Solax Cloud Plugin will expose a set of Homekit accessories though Homebrid
|
|
|
20
22
|
- Grid To House (outlet with power consumption)
|
|
21
23
|
- Update (Motion sensor)
|
|
22
24
|
|
|
25
|
+
|
|
26
|
+
|
|
23
27
|
## Required information
|
|
24
28
|
|
|
25
29
|
For this plugin to work, two critical pieces of information are required:
|
|
@@ -27,6 +31,15 @@ For this plugin to work, two critical pieces of information are required:
|
|
|
27
31
|
- **Token ID**: Solax users can get inverter information through the granted tokenID. You need to obtain your tokenID on the API page of Solaxcloud.
|
|
28
32
|
- **SN**: Registration No (communication module SN).
|
|
29
33
|
|
|
34
|
+
## Installation
|
|
35
|
+
|
|
36
|
+
This plugin is supported under Homebridge. It is highly recommended that you use Homebridge Config UI X to install and configure this plugin.
|
|
37
|
+
|
|
38
|
+
### Manual Installation
|
|
39
|
+
|
|
40
|
+
Install this plugin using: `sudo npm install -g homebridge-solaxcloud-api`.
|
|
41
|
+
Edit `config.json` manually to add your Solax inverters. See below for instructions on that.
|
|
42
|
+
|
|
30
43
|
## Platform configuration
|
|
31
44
|
|
|
32
45
|
Minimum platform configuration is depicted by the example configuration file below:
|
|
@@ -46,27 +59,27 @@ Minimum platform configuration is depicted by the example configuration file bel
|
|
|
46
59
|
```
|
|
47
60
|
Configuration through the the use of Homebridge UI plugin is also available:
|
|
48
61
|
|
|
49
|
-
|
|
50
63
|
|
|
51
64
|
## Non-standard characteristics
|
|
52
65
|
|
|
53
66
|
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.
|
|
54
67
|
|
|
55
|
-
This will allow some important characteristics to be visible (
|
|
56
|
-
|
|
68
|
+
This will allow some important non-standard characteristics to be visible (like consumption), as depicted in the image below:
|
|
57
69
|
|
|
70
|
+
|
|
58
71
|
|
|
59
72
|
# Automation
|
|
60
73
|
|
|
61
74
|
Automation can be achived with the help of the virtual "Update" motion sensor that was specifically tailored for this effect. This motion sensor will be triggered whenever data gets updated from the Solax Cloud API (according to the `pollingFrequency` configuration setting).
|
|
62
75
|
|
|
63
|
-
|
|
76
|
+
|
|
64
77
|
|
|
65
|
-
|
|
78
|
+
Whenever motion is detected, plugin data was refreshed for each of the virtual outlets enumerated above and may be used for further defining an automation.
|
|
66
79
|
|
|
67
80
|
## Automation example
|
|
68
81
|
|
|
69
|
-
As an automation example
|
|
82
|
+
As an automation example...
|
|
70
83
|
|
|
71
84
|
# TO DO
|
|
72
85
|
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
package/package.json
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"private": false,
|
|
3
|
-
"displayName": "Solax Cloud API
|
|
3
|
+
"displayName": "Solax Cloud API",
|
|
4
4
|
"name": "homebridge-solaxcloud-api",
|
|
5
|
-
"version": "1.2.
|
|
5
|
+
"version": "1.2.1",
|
|
6
6
|
"description": "Integrates solar production info using public Solax Cloud API into Homebrigde acessories.",
|
|
7
7
|
"license": "Apache-2.0",
|
|
8
8
|
"repository": {
|