homebridge-solaxcloud-api 1.4.3 → 1.4.4
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 +74 -5
- package/images/automation/automation_1.png +0 -0
- package/images/automation/automation_10.png +0 -0
- package/images/automation/automation_11.png +0 -0
- package/images/automation/automation_12.png +0 -0
- package/images/automation/automation_13.png +0 -0
- package/images/automation/automation_14.png +0 -0
- package/images/automation/automation_15.png +0 -0
- package/images/automation/automation_16.png +0 -0
- package/images/automation/automation_2.png +0 -0
- package/images/automation/automation_3.png +0 -0
- package/images/automation/automation_4.png +0 -0
- package/images/automation/automation_5.png +0 -0
- package/images/automation/automation_6.png +0 -0
- package/images/automation/automation_7.png +0 -0
- package/images/automation/automation_8.png +0 -0
- package/images/automation/automation_9.png +0 -0
- package/images/homebridge-ui.png +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -22,7 +22,7 @@ As HomeKit is still clueless about what a solar panel is, this plugin exposes a
|
|
|
22
22
|
- **Grid To House** (outlet with power consumption)
|
|
23
23
|
- **Update** (Motion sensor)
|
|
24
24
|
|
|
25
|
-
|
|
25
|
+
<img src="images/plugin-accessories-home.png" width="50%" height="50%">
|
|
26
26
|
|
|
27
27
|
## Required information
|
|
28
28
|
|
|
@@ -61,7 +61,7 @@ Minimum platform configuration is depicted by the example configuration file bel
|
|
|
61
61
|
|
|
62
62
|
Configuration through the the use of [Homebridge UI](https://github.com/oznu/homebridge-config-ui-x) plugin is also available and recommended:
|
|
63
63
|
|
|
64
|
-
|
|
64
|
+
<img src="images/homebridge-ui.png" width="100%" height="100%">
|
|
65
65
|
|
|
66
66
|
## Non-standard characteristics
|
|
67
67
|
|
|
@@ -69,19 +69,88 @@ Non-standard accessory characteristics are available through the use of [Eve for
|
|
|
69
69
|
|
|
70
70
|
This will allow some important non-standard characteristics to be visible (like power or total energy consumption), as depicted in the image below:
|
|
71
71
|
|
|
72
|
-
|
|
72
|
+
<img src="images/plugin-outlet-consumption.png" width="50%" height="50%">
|
|
73
73
|
|
|
74
74
|
# Automation
|
|
75
75
|
|
|
76
76
|
Automation can be achieved 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 what is defined on the `pollingFrequency` configuration setting).
|
|
77
77
|
|
|
78
|
-
|
|
78
|
+
<img src="images/plugin-accessories-eve.png" width="50%" height="50%">
|
|
79
79
|
|
|
80
80
|
Motion is detected by the **Update** motion sensor whenever there is newly fetched 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.
|
|
81
81
|
|
|
82
82
|
## Automation example
|
|
83
83
|
|
|
84
|
-
Since automations are probably going to be dependent on the non-standard
|
|
84
|
+
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.
|
|
85
|
+
|
|
86
|
+
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):
|
|
87
|
+
|
|
88
|
+
<table cellspacing="0" cellpadding="0">
|
|
89
|
+
<tr>
|
|
90
|
+
<td width="50%">1. Under Automation, select <b>Rules</b></td>
|
|
91
|
+
<td width="50%">2. Click <b>Next</b></td>
|
|
92
|
+
</tr>
|
|
93
|
+
<tr>
|
|
94
|
+
<td><img src="images/automation/automation_1.png"></td>
|
|
95
|
+
<td><img src="images/automation/automation_2.png"></td>
|
|
96
|
+
</tr>
|
|
97
|
+
<tr>
|
|
98
|
+
<td>3. Click <b>Add Trigger</b></td>
|
|
99
|
+
<td>4. Select <b>Motion</b> as trigger type</td>
|
|
100
|
+
</tr>
|
|
101
|
+
<tr>
|
|
102
|
+
<td><img src="images/automation/automation_3.png"></td>
|
|
103
|
+
<td><img src="images/automation/automation_4.png"></td>
|
|
104
|
+
</tr>
|
|
105
|
+
<tr>
|
|
106
|
+
<td>5. Select the Solax <b>Update</b> motion detector and set <b>Motion</b> as trigger</td>
|
|
107
|
+
<td>6. Click <b>Next</b></td>
|
|
108
|
+
</tr>
|
|
109
|
+
<tr>
|
|
110
|
+
<td><img src="images/automation/automation_5.png"></td>
|
|
111
|
+
<td><img src="images/automation/automation_6.png"></td>
|
|
112
|
+
</tr>
|
|
113
|
+
<tr>
|
|
114
|
+
<td>7. Select <b>Add Value Condition</b></td>
|
|
115
|
+
<td>8. Choose <b>Inverter AC Consumption</b> as characteristic and elect <b>>=</b> a desired value</b></td>
|
|
116
|
+
</tr>
|
|
117
|
+
<tr>
|
|
118
|
+
<td><img src="images/automation/automation_7.png"></td>
|
|
119
|
+
<td><img src="images/automation/automation_8.png"></td>
|
|
120
|
+
</tr>
|
|
121
|
+
<tr>
|
|
122
|
+
<td>9. Click <b>Next</b></td>
|
|
123
|
+
<td>10. If no scene exists, click <b>Add Scene</b></td>
|
|
124
|
+
</tr>
|
|
125
|
+
<tr>
|
|
126
|
+
<td><img src="images/automation/automation_9.png"></td>
|
|
127
|
+
<td><img src="images/automation/automation_10.png"></td>
|
|
128
|
+
</tr>
|
|
129
|
+
<tr>
|
|
130
|
+
<td>11. Click <b>Add Actions</b></td>
|
|
131
|
+
<td>12. Select the accessory to be controlled (in this case <b>Garden Pool Outlet</b> will be turned <b>ON</b>)</td>
|
|
132
|
+
</tr>
|
|
133
|
+
<tr>
|
|
134
|
+
<td><img src="images/automation/automation_11.png"></td>
|
|
135
|
+
<td><img src="images/automation/automation_12.png"></td>
|
|
136
|
+
</tr>
|
|
137
|
+
<tr>
|
|
138
|
+
<td>13. Click <b>Next</b></td>
|
|
139
|
+
<td>14. Name your scene and click <b>Done</b></td>
|
|
140
|
+
</tr>
|
|
141
|
+
<tr>
|
|
142
|
+
<td><img src="images/automation/automation_13.png"></td>
|
|
143
|
+
<td><img src="images/automation/automation_14.png"></td>
|
|
144
|
+
</tr>
|
|
145
|
+
<tr>
|
|
146
|
+
<td>15. Click <b>Next</b></td>
|
|
147
|
+
<td>16. Name your rule and click <b>Done</b></td>
|
|
148
|
+
</tr>
|
|
149
|
+
<tr>
|
|
150
|
+
<td><img src="images/automation/automation_15.png"></td>
|
|
151
|
+
<td><img src="images/automation/automation_16.png"></td>
|
|
152
|
+
</tr>
|
|
153
|
+
</table>
|
|
85
154
|
|
|
86
155
|
# TO DO
|
|
87
156
|
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
package/images/homebridge-ui.png
CHANGED
|
Binary file
|
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": "1.4.
|
|
5
|
+
"version": "1.4.4",
|
|
6
6
|
"description": "Integrates solar production info using public Solax Cloud API into Homebrigde acessories.",
|
|
7
7
|
"license": "Apache-2.0",
|
|
8
8
|
"repository": {
|