iobroker.tesla-wallconnector3 0.0.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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2022 NoBl <github@bluemle.org>
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,445 @@
1
+ ![Logo](admin/tesla-wallconnector3.png)
2
+
3
+ # ioBroker.tesla-wallconnector3
4
+
5
+ [![NPM version](http://img.shields.io/npm/v/iobroker.tesla-wallconnector3.svg)](https://www.npmjs.com/package/iobroker.tesla-wallconnector3)
6
+ [![Downloads](https://img.shields.io/npm/dm/iobroker.tesla-wallconnector3.svg)](https://www.npmjs.com/package/iobroker.tesla-wallconnector3)
7
+ ![Number of Installations (latest)](http://iobroker.live/badges/tesla-wallconnector3-installed.svg)
8
+ ![Number of Installations (stable)](http://iobroker.live/badges/tesla-wallconnector3-stable.svg)
9
+ [![Known Vulnerabilities](https://snyk.io/test/github/nobl/ioBroker.tesla-wallconnector3/badge.svg)](https://snyk.io/test/github/nobl/ioBroker.tesla-wallconnector3)
10
+
11
+ [![NPM](https://nodei.co/npm/iobroker.tesla-wallconnector3.png?downloads=true)](https://nodei.co/npm/iobroker.tesla-wallconnector3/)
12
+
13
+ **Tests:** ![Test and Release](https://github.com/nobl/ioBroker.tesla-wallconnector3/workflows/Test%20and%20Release/badge.svg)
14
+
15
+ ## tesla wall connector gen 3 adapter for ioBroker
16
+
17
+ [Dokumentation DE](docs/de/README.md)<br>
18
+ [Documentation EN](docs/en/README.md)
19
+
20
+ Targeted at the Tesla Wall Connector Gen 3.
21
+ Only provides read access to API data (write isn't supported by the API).
22
+
23
+ ## Installation
24
+ You can either install the adapter via the ioBroker web interface or on your local machine via npm.
25
+
26
+ ### Browser-based
27
+ 1. Open your ioBroker web interface in a browser (eg: 192.168.178.42:8081)
28
+ 2. Click on Tab "Adapters"
29
+ 3. Type "tesla-wallconnector3" in the filter
30
+ 4. Click on the "+" symbol of the Tesla Wall Connector Gen 3 adapter
31
+
32
+ ### Local machine
33
+ Navigate into your iobroker folder and execute the following command:
34
+ ```bash
35
+ npm i iobroker.tesla-wallconnector3
36
+ ```
37
+
38
+ ## Setup
39
+ Additional to the adapter installation you have to add an instance of the adapter.
40
+
41
+ ### ioBroker
42
+ 1. Open your ioBroker interface in a browser (eg: 192.168.178.42:8081) (if configuration dialogue was opened automatically after installation, skip to 4.).
43
+ 2. Navigate to Tab "Instances"
44
+ 3. Click on the wrench symbol of the Tesla Wall Connector Gen 3 adapter
45
+ 4. Now you can see the main settings of the adapter configuration page.<br>
46
+ ![Main Settings](/docs/en/media/mainSettings.png)
47
+ 4.1 Type in the IP-address of your Tesla Wall Connector Gen 3 (FQDN is also possible if you have a working local DNS).<br>
48
+ 4.2 You can change the polling interval, too. (Default: 10 seconds)<br>
49
+ 4.3 If your network requires a higher timeout for requests sent to Tesla Wall Connector Gen 3, please change the Request-Timeout in miliseconds accordingly. (Default: 5000 miliseconds)<br>
50
+ 4.4 In case there is an issue communicating with Tesla Wall Connector Gen 3 the adapter will retry several times. You can adjust how often it will try to read from Tesla Wall Connector Gen 3. (Default: 10)<br>
51
+ 4.5 To space retries apart a bit more you can adjust the Polling Retry Factor. (Default: 2)<br>
52
+ Example: Using default settings the 1st retry will happen 20 seconds after the initial try, the 2nd will happen 40 seconds after the 2nd try.<br>
53
+ After each successful connect to Tesla Wall Connector Gen 3, the number of retries is reset.
54
+ 5. Click on Save & Close
55
+
56
+ ## Usage
57
+ Here you can find a description of the states and how to use them. All states of this adapter are read-only states.<br>
58
+ Please be aware that most (if not all) descriptions might be way off and might require confirmation or corrections. Pull-Requests with updates are welcome and encouraged!
59
+
60
+ ### Known States
61
+
62
+ #### Channel: info
63
+
64
+ * info.connection
65
+
66
+ |Data type|Permission|
67
+ |:---:|:---:|
68
+ |boolean|R|
69
+
70
+ *Read-only boolean which is true if the adapter is connected to the Tesla Wall Connector Gen 3.*
71
+
72
+ #### Channel: lifetime
73
+
74
+ * alert_count
75
+
76
+ |Data type|Permission|
77
+ |:---:|:---:|
78
+ |number|R|
79
+
80
+ *Read-only number, representing the number of alerts.*
81
+
82
+ * avg_startup_temp
83
+
84
+ |Data type|Permission|
85
+ |:---:|:---:|
86
+ |number|R|
87
+
88
+ *Read-only number, representing if the average startup temperature.*
89
+
90
+ * charge_starts
91
+
92
+ |Data type|Permission|
93
+ |:---:|:---:|
94
+ |number|R|
95
+
96
+ *Read-only string, representing the number of charging starts.*
97
+
98
+ * charging_time_s
99
+
100
+ |Data type|Permission|
101
+ |:---:|:---:|
102
+ |number|R|
103
+
104
+ *Read-only number, representing the charging time in seconds of the WC3*
105
+
106
+ * connector_cycles
107
+
108
+ |Data type|Permission|
109
+ |:---:|:---:|
110
+ |number|R|
111
+
112
+ *Read-only number, representing the number of connector cycles (plugging in and out most likely counting each as 1).*
113
+
114
+ * contactor_cycles
115
+
116
+ |Data type|Permission|
117
+ |:---:|:---:|
118
+ |number|R|
119
+
120
+ *Read-only number, representing the number of state-changes of the relais so far.*
121
+
122
+ * contactor_cycles_loaded
123
+
124
+ |Data type|Permission|
125
+ |:---:|:---:|
126
+ |number|R|
127
+
128
+ *Read-only number, representing the number of charging cycles.*
129
+
130
+ * energy_wh
131
+
132
+ |Data type|Permission|
133
+ |:---:|:---:|
134
+ |number|R|
135
+
136
+ *Read-only number, representing the amount of energy supplied in Wh.*
137
+
138
+ * thermal_foldbacks
139
+
140
+ |Data type|Permission|
141
+ |:---:|:---:|
142
+ |number|R|
143
+
144
+ *Read-only number, representing the ???*
145
+
146
+ * uptime_s
147
+
148
+ |Data type|Permission|
149
+ |:---:|:---:|
150
+ |number|R|
151
+
152
+ *Read-only number, representing the uptime in seconds of the WC3*
153
+
154
+ #### Channel: version
155
+
156
+ * firmware_version
157
+
158
+ |Data type|Permission|
159
+ |:---:|:---:|
160
+ |string|R|
161
+
162
+ *Firmware version on the Tesla Wall Connector Gen 3*
163
+
164
+ * part_number
165
+
166
+ |Data type|Permission|
167
+ |:---:|:---:|
168
+ |string|R|
169
+
170
+ *Part number of the Tesla Wall Connector Gen 3*
171
+
172
+ * serial_number
173
+
174
+ |Data type|Permission|
175
+ |:---:|:---:|
176
+ |string|R|
177
+
178
+ *Serial number of the Tesla Wall Connector Gen 3*
179
+
180
+ #### Channel: vitals
181
+
182
+ * current_alerts
183
+
184
+ |Data type|Permission|
185
+ |:---:|:---:|
186
+ |string|R|
187
+
188
+ *Read-Only string with details about alerts.*
189
+
190
+ * contactor_closed
191
+
192
+ |Data type|Permission|
193
+ |:---:|:---:|
194
+ |boolean|R|
195
+
196
+ *Read-Only boolean indicating if the relais is closed.*
197
+
198
+ * grid_hz
199
+
200
+ |Data type|Permission|
201
+ |:---:|:---:|
202
+ |number|R|
203
+
204
+ *Read-Only number representing the grids frequency.*
205
+
206
+ * config_status
207
+
208
+ |Data type|Permission|
209
+ |:---:|:---:|
210
+ |number|R|
211
+
212
+ *Read-Only number representing the config status. Please help with details!*
213
+
214
+ * current[A,B,C,N]_a
215
+
216
+ |Data type|Permission|
217
+ |:---:|:---:|
218
+ |number|R|
219
+
220
+ *Read-Only number representing the current of line [A,B,C,N] in ampere.*
221
+
222
+ * evse_state
223
+
224
+ |Data type|Permission|
225
+ |:---:|:---:|
226
+ |number|R|
227
+
228
+ *Read-Only number representing the evse state. We seem to know so far: 0=booting, 1=idle, 2=connect but not ready, 3=???, 4=connected and ready, 5=???, 6=vehicle plugged in and handshaking, 7=???, 8=charging completed/interrupted, 9=ready for charging but waiting on car, 10=charging with reduced power (less than 3 phases, 16 amps each), 11=charging full power (3 Phases, 16 amps each), 12=??? *
229
+
230
+ * grid_v
231
+
232
+ |Data type|Permission|
233
+ |:---:|:---:|
234
+ |number|R|
235
+
236
+ *Read-Only number representing the grids voltage.*
237
+
238
+ * handle_temp_c
239
+
240
+ |Data type|Permission|
241
+ |:---:|:---:|
242
+ |number|R|
243
+
244
+ *Read-Only number representing the handle's tempearture in °C.*
245
+
246
+ * input_thermopile_uv
247
+
248
+ |Data type|Permission|
249
+ |:---:|:---:|
250
+ |number|R|
251
+
252
+ *Read-Only number representing ???.*
253
+
254
+ * mcu_temp_c
255
+
256
+ |Data type|Permission|
257
+ |:---:|:---:|
258
+ |number|R|
259
+
260
+ *Read-Only number representing the master control unit's tempearture in °C.*
261
+
262
+ * pcba_temp_c
263
+
264
+ |Data type|Permission|
265
+ |:---:|:---:|
266
+ |number|R|
267
+
268
+ *Read-Only number representing the printed circuit board's tempearture in °C.*
269
+
270
+ * pilot_high_v
271
+
272
+ |Data type|Permission|
273
+ |:---:|:---:|
274
+ |number|R|
275
+
276
+ *Read-Only number representing the pilot line's high voltage.*
277
+
278
+ * pilot_low_v
279
+
280
+ |Data type|Permission|
281
+ |:---:|:---:|
282
+ |number|R|
283
+
284
+ *Read-Only number representing the pilot line's low voltage.*
285
+
286
+ * prox_v
287
+
288
+ |Data type|Permission|
289
+ |:---:|:---:|
290
+ |number|R|
291
+
292
+ *Read-Only number representing ???.*
293
+
294
+ * relay_coil_v
295
+
296
+ |Data type|Permission|
297
+ |:---:|:---:|
298
+ |number|R|
299
+
300
+ *Read-Only number representing the relay coils voltage.*
301
+
302
+ * session_s
303
+
304
+ |Data type|Permission|
305
+ |:---:|:---:|
306
+ |number|R|
307
+
308
+ *Read-Only number representing the duration of the current charging session in seconds.*
309
+
310
+ * session_energy_wh
311
+
312
+ |Data type|Permission|
313
+ |:---:|:---:|
314
+ |number|R|
315
+
316
+ *Read-Only number representing the energy supplied in the current session in Wh.*
317
+
318
+ * uptime_s
319
+
320
+ |Data type|Permission|
321
+ |:---:|:---:|
322
+ |number|R|
323
+
324
+ *Read-Only number representing the WC3's uptime in seconds.*
325
+
326
+ * vehicle_connected
327
+
328
+ |Data type|Permission|
329
+ |:---:|:---:|
330
+ |boolean|R|
331
+
332
+ *Read-Only boolean indicating if a vehicle is connected.*
333
+
334
+ * vehicle_current_a
335
+
336
+ |Data type|Permission|
337
+ |:---:|:---:|
338
+ |number|R|
339
+
340
+ *Read-Only number representing vehicles current in ampere.*
341
+
342
+ * voltage[A,B,C]_v
343
+
344
+ |Data type|Permission|
345
+ |:---:|:---:|
346
+ |number|R|
347
+
348
+ *Read-Only number representing the voltage of line [A,B,C].*
349
+
350
+ #### Channel: wifi_status
351
+
352
+ * internet
353
+
354
+ |Data type|Permission|
355
+ |:---:|:---:|
356
+ |boolean|R|
357
+
358
+ *Read-only boolean, representing if the Tesla Wall Connector Gen 3 is connected to the internet.*
359
+
360
+ * wifi_connected
361
+
362
+ |Data type|Permission|
363
+ |:---:|:---:|
364
+ |boolean|R|
365
+
366
+ *Read-only boolean, representing if the Tesla Wall Connector Gen 3 is connected to wifi.*
367
+
368
+ * wifi_infra_ip
369
+
370
+ |Data type|Permission|
371
+ |:---:|:---:|
372
+ |string|R|
373
+
374
+ *Read-only string, representing the IP of the Tesla Wall Connector Gen 3.*
375
+
376
+ * wifi_mac
377
+
378
+ |Data type|Permission|
379
+ |:---:|:---:|
380
+ |string|R|
381
+
382
+ *Read-only string, representing the MAC address of the Tesla Wall Connector Gen 3.*
383
+
384
+ * wifi_rssi
385
+
386
+ |Data type|Permission|
387
+ |:---:|:---:|
388
+ |number|R|
389
+
390
+ *Read-only number, representing the rssi of the wifi the Tesla Wall Connector Gen 3 is connected to.*
391
+
392
+ * wifi_signal_strength
393
+
394
+ |Data type|Permission|
395
+ |:---:|:---:|
396
+ |number|R|
397
+
398
+ *Read-only number, representing the signal strength of the wifi the Tesla Wall Connector Gen 3 is connected to.*
399
+
400
+ * wifi_snr
401
+
402
+ |Data type|Permission|
403
+ |:---:|:---:|
404
+ |number|R|
405
+
406
+ *Read-only number, representing the snr of the wifi the Tesla Wall Connector Gen 3 is connected to.*
407
+
408
+ * wifi_ssid
409
+
410
+ |Data type|Permission|
411
+ |:---:|:---:|
412
+ |string|R|
413
+
414
+ *SSID the Tesla Wall Connector Gen 3 is connected to.*
415
+
416
+
417
+
418
+ ## Changelog
419
+ ### 0.0.1 (Nobl)
420
+ * Initial release
421
+
422
+
423
+
424
+ ## License
425
+ MIT License
426
+
427
+ Copyright (c) 2022 Norbert Bluemle <github@bluemle.org>
428
+
429
+ Permission is hereby granted, free of charge, to any person obtaining a copy
430
+ of this software and associated documentation files (the "Software"), to deal
431
+ in the Software without restriction, including without limitation the rights
432
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
433
+ copies of the Software, and to permit persons to whom the Software is
434
+ furnished to do so, subject to the following conditions:
435
+
436
+ The above copyright notice and this permission notice shall be included in all
437
+ copies or substantial portions of the Software.
438
+
439
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
440
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
441
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
442
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
443
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
444
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
445
+ SOFTWARE.
@@ -0,0 +1,5 @@
1
+ {
2
+ "tesla-wallconnector3 adapter settings": "Adaptereinstellungen für tesla-wallconnector3",
3
+ "option1": "Option 1",
4
+ "option2": "Option 2"
5
+ }
@@ -0,0 +1,5 @@
1
+ {
2
+ "tesla-wallconnector3 adapter settings": "Adapter settings for tesla-wallconnector3",
3
+ "option1": "option1",
4
+ "option2": "option2"
5
+ }
@@ -0,0 +1,5 @@
1
+ {
2
+ "tesla-wallconnector3 adapter settings": "Ajustes del adaptador para tesla-wallconnector3",
3
+ "option1": "Opción 1",
4
+ "option2": "opcion 2"
5
+ }
@@ -0,0 +1,5 @@
1
+ {
2
+ "tesla-wallconnector3 adapter settings": "Paramètres d'adaptateur pour tesla-wallconnector3",
3
+ "option1": "Option 1",
4
+ "option2": "Option 2"
5
+ }
@@ -0,0 +1,5 @@
1
+ {
2
+ "tesla-wallconnector3 adapter settings": "Impostazioni dell'adattatore per tesla-wallconnector3",
3
+ "option1": "opzione 1",
4
+ "option2": "opzione 2"
5
+ }
@@ -0,0 +1,5 @@
1
+ {
2
+ "tesla-wallconnector3 adapter settings": "Adapterinstellingen voor tesla-wallconnector3",
3
+ "option1": "Optie 1",
4
+ "option2": "Optie 2"
5
+ }
@@ -0,0 +1,5 @@
1
+ {
2
+ "tesla-wallconnector3 adapter settings": "Ustawienia adaptera dla tesla-wallconnector3",
3
+ "option1": "opcja 1",
4
+ "option2": "Opcja 2"
5
+ }
@@ -0,0 +1,5 @@
1
+ {
2
+ "tesla-wallconnector3 adapter settings": "Configurações do adaptador para tesla-wallconnector3",
3
+ "option1": "Opção 1",
4
+ "option2": "opção 2"
5
+ }
@@ -0,0 +1,5 @@
1
+ {
2
+ "tesla-wallconnector3 adapter settings": "Настройки адаптера для tesla-wallconnector3",
3
+ "option1": "Опция 1",
4
+ "option2": "вариант 2"
5
+ }
@@ -0,0 +1,5 @@
1
+ {
2
+ "tesla-wallconnector3 adapter settings": "tesla-wallconnector3的适配器设置",
3
+ "option1": "选项1",
4
+ "option2": "选项2"
5
+ }