forked from grzegorz914/homebridge-enphase-envoy
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathconfig.schema.json
703 lines (703 loc) · 26.8 KB
/
config.schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
{
"pluginAlias": "enphaseEnvoy",
"pluginType": "platform",
"singular": true,
"fixArrays": true,
"headerDisplay": "This plugin works with Enphase Photovoltaic. Devices are exposed to HomeKit as separate accessories and each needs to be manually paired.\n\n1. Open the Home <img src='https://user-images.githubusercontent.com/3979615/78010622-4ea1d380-738e-11ea-8a17-e6a465eeec35.png' height='16.42px'> app on your device.\n2. Tap the <img src='https://user-images.githubusercontent.com/3979615/78010869-9aed1380-738e-11ea-9644-9f46b3633026.png' height='16.42px'>.\n3. Tap *Add Accessory*, and select *I Don't Have a Code or Cannot Scan* or *More Options*.\n4. Select Your accessory and press add anyway.\n5. Enter the PIN or scan the QR code, this can be found in Homebridge UI or Homebridge logs.\n6. Complete the accessory setup.",
"footerDisplay": "For documentation please see [GitHub repository](https://github.com/grzegorz914/homebridge-enphase-envoy).",
"schema": {
"type": "object",
"properties": {
"devices": {
"title": "Devices",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"title": "Name",
"type": "string",
"placeholder": "Envoy-S",
"description": "Here set the accessory `Name` to be displayed in `Homebridge/HomeKit`.",
"required": true
},
"host": {
"title": "IP/Hostname",
"type": "string",
"placeholder": "192.168.1.35",
"format": "hostname",
"description": "Here set the envoy `IP Address`/`Hostname` or leave empty (will be used default path `envoy.local`.",
"required": false
},
"envoyFirmware7xx": {
"title": "Firmware 7.x.x",
"type": "boolean",
"default": false,
"required": true,
"description": "This enable support for Envoy with firmware 7.x.x"
},
"enlightenUser": {
"title": "Enlighten User",
"type": "string",
"description": "Here set the enlighten user name.",
"required": false,
"condition": {
"functionBody": "return model.devices[arrayIndices].envoyFirmware7xx === true;"
}
},
"enlightenPasswd": {
"title": "Enlighten Password",
"type": "string",
"description": "Here set the enlighten password.",
"required": false,
"condition": {
"functionBody": "return model.devices[arrayIndices].envoyFirmware7xx === true;"
}
},
"envoySerialNumber": {
"title": "Envoy Serial Number",
"type": "string",
"description": "Here set the envoy serial number.",
"required": false,
"condition": {
"functionBody": "return model.devices[arrayIndices].envoyFirmware7xx === true;"
}
},
"envoyPasswd": {
"title": "Envoy Password",
"type": "string",
"description": "Here set the envoy password (only if U already changed default password).",
"required": false,
"condition": {
"functionBody": "return model.devices[arrayIndices].envoyFirmware7xx === false;"
}
},
"disableLogInfo": {
"title": "Disable Log Info",
"type": "boolean",
"default": false,
"required": false,
"description": "This disable log info, all values and state will not be displayed in Homebridge log console."
},
"disableLogDeviceInfo": {
"title": "Disable Log Device Info",
"type": "boolean",
"default": false,
"description": "This disable log device info by every connections device to the network.",
"required": false
},
"enableDebugMode": {
"title": "Debug",
"type": "boolean",
"default": false,
"description": "This enable debug mode.",
"required": false
},
"powerProductionSummary": {
"title": "Power Summary",
"type": "integer",
"default": 0,
"description": "Here set the power summary in (W) of all microinverters, based on this value will be calculate in % production level displayed in HomeKit.",
"required": true
},
"powerProductionOnOff": {
"title": "Power State",
"type": "boolean",
"default": false,
"description": "This enable *Power State* monitoring for production and expose contact sensor in HomeKit.",
"required": false
},
"powerProductionMax": {
"title": "Power Peak",
"type": "boolean",
"default": false,
"description": "This enable *Power Peak* monitoring for production and expose contact sensor in HomeKit.",
"required": false
},
"powerProductionMaxAutoReset": {
"title": "Power Peak Reset",
"type": "integer",
"minimum": 0,
"maximum": 3,
"default": 0,
"description": "Here select at which period of time the *Power Peak* will reset.",
"oneOf": [
{
"title": "None",
"enum": [
0
]
},
{
"title": "Every Day",
"enum": [
1
]
},
{
"title": "Every Week",
"enum": [
2
]
},
{
"title": "Every Month",
"enum": [
3
]
}
],
"required": false,
"condition": {
"functionBody": "return model.devices[arrayIndices].powerProductionMax === true;"
}
},
"powerProductionMaxDetected": {
"title": "Power Peak Detected",
"type": "integer",
"default": 0,
"description": "Here set *Power Peak Level* in (W) at which the contact sensor fired.",
"required": false,
"condition": {
"functionBody": "return model.devices[arrayIndices].powerProductionMax === true;"
}
},
"energyProductionStateSensor": {
"title": "Energy State",
"type": "boolean",
"default": false,
"description": "This enable *Energy State* monitoring for production and expose contact sensor in HomeKit.",
"required": false
},
"energyProductionLevelSensor": {
"title": "Energy Level",
"type": "boolean",
"default": false,
"description": "This enable *Energy Level* monitoring for production and expose contact sensor in HomeKit.",
"required": false
},
"energyProductionLevelDetected": {
"title": "Energy Level Detected",
"type": "integer",
"default": 0,
"description": "Here set *Energy Level* in (Wh)for production at which the contact sensor fired.",
"required": false,
"condition": {
"functionBody": "return model.devices[arrayIndices].energyProductionLevelSensor === true;"
}
},
"energyProductionLifetimeOffset": {
"title": "Energy Lifetime Offset",
"type": "integer",
"default": 0,
"description": "Here set *Offset* in (Wh) for energy production, if nedded.",
"required": false
},
"powerConsumptionTotalMax": {
"title": "Power Peak",
"type": "boolean",
"default": false,
"description": "This enable *Power Peak* monitoring for consumption (Total) and expose contact sensor in HomeKit.",
"required": false
},
"powerConsumptionTotalMaxAutoReset": {
"title": "Power Peak Reset",
"type": "integer",
"minimum": 0,
"maximum": 3,
"default": 0,
"description": "Here select at which period of time the *Power Peak* will reset.",
"oneOf": [
{
"title": "None",
"enum": [
0
]
},
{
"title": "Every Day",
"enum": [
1
]
},
{
"title": "Every Week",
"enum": [
2
]
},
{
"title": "Every Month",
"enum": [
3
]
}
],
"required": false,
"condition": {
"functionBody": "return model.devices[arrayIndices].powerConsumptionTotalMax === true;"
}
},
"powerConsumptionTotalMaxDetected": {
"title": "Power Peak Detected",
"type": "integer",
"default": 0,
"description": "Here set *Power Peak Level* in (W) at which the contact sensor fired.",
"required": false,
"condition": {
"functionBody": "return model.devices[arrayIndices].powerConsumptionTotalMax === true;"
}
},
"energyConsumptionTotalLifetimeOffset": {
"title": "Energy Lifetime Offset",
"type": "integer",
"default": 0,
"description": "Here set *Offset* in (Wh) for energy consumption (Total), if nedded.",
"required": false
},
"powerConsumptionNetMax": {
"title": "Power Peak",
"type": "boolean",
"default": false,
"description": "This enable *Power Peak* monitoring for consumption (Net) and expose contact sensor in HomeKit.",
"required": false
},
"powerConsumptionNetMaxAutoReset": {
"title": "Power Peak Reset",
"type": "integer",
"minimum": 0,
"maximum": 3,
"default": 0,
"description": "Here select at which period of time the *Power Peak* will reset.",
"oneOf": [
{
"title": "None",
"enum": [
0
]
},
{
"title": "Every Day",
"enum": [
1
]
},
{
"title": "Every Week",
"enum": [
2
]
},
{
"title": "Every Month",
"enum": [
3
]
}
],
"required": false,
"condition": {
"functionBody": "return model.devices[arrayIndices].powerConsumptionNetMax === true;"
}
},
"powerConsumptionNetMaxDetected": {
"title": "Power Peak Detected",
"type": "integer",
"default": 0,
"description": "Here set *Power Peak Level* in (W) at which the contact sensor fired.",
"required": false,
"condition": {
"functionBody": "return model.devices[arrayIndices].powerConsumptionNetMax === true;"
}
},
"energyConsumptionNetLifetimeOffset": {
"title": "Energy Lifetime Offset",
"type": "integer",
"default": 0,
"description": "Here set *Offset* in (Wh) for energy consumption (Net), if nedded.",
"required": false
},
"supportProductionPowerMode": {
"title": "Power Mode",
"type": "boolean",
"default": false,
"required": false,
"description": "This enable support to check/control production *Power Mode*, may not working with all envoy 7.x.x firmwares, if error occur, please disable it."
},
"supportPlcLevel": {
"title": "PLC Level",
"type": "boolean",
"default": false,
"required": false,
"description": "This enable support to check *PLC Level*."
},
"supportEnsembleStatus": {
"title": "Ensemble Status",
"type": "boolean",
"default": false,
"required": false,
"description": "This enable support to check *Ensemble Status*, may not working with all envoy firmwares, if error occur, please disable it.",
"condition": {
"functionBody": "return model.devices[arrayIndices].envoyFirmware7xx === true;"
}
},
"supportLiveData": {
"title": "Live Data",
"type": "boolean",
"default": false,
"required": false,
"description": "This enable support to check *Live Data*.",
"condition": {
"functionBody": "return model.devices[arrayIndices].envoyFirmware7xx === true;"
}
},
"liveDataRefreshTime": {
"title": "Live Data Refresh Time",
"type": "integer",
"default": 1000,
"minimum": 500,
"maximum": 30000,
"required": false,
"description": "Here set *Live Data* refresh time in (ms).",
"condition": {
"functionBody": "return model.devices[arrayIndices].envoyFirmware7xx === true && model.devices[arrayIndices].supportLiveData === true;"
}
},
"metersDataRefreshTime": {
"title": "Meters Refresh Time",
"type": "integer",
"default": 2500,
"minimum": 500,
"maximum": 30000,
"required": false,
"description": "Here set *Meters Data* refresh time in (ms)."
},
"productionDataRefreshTime": {
"title": "Production Refresh Time",
"type": "integer",
"default": 5000,
"minimum": 500,
"maximum": 30000,
"required": false,
"description": "Here set *Production Data* rfresh time in (ms)."
},
"enableRestFul": {
"title": "Enable",
"type": "boolean",
"default": false,
"required": false,
"description": "This enable RESTful server."
},
"restFulDebug": {
"title": "Debug",
"type": "boolean",
"default": false,
"required": false,
"description": "This enable debug mode for RESTFul.",
"condition": {
"functionBody": "return model.devices[arrayIndices].enableRestFul === true;"
}
},
"restFulPort": {
"title": "Port",
"type": "integer",
"placeholder": 3000,
"required": true,
"description": "Here set the listening Port for RESTful server.",
"condition": {
"functionBody": "return model.devices[arrayIndices].enableRestFul === true;"
}
},
"enableMqtt": {
"title": "Enable",
"type": "boolean",
"default": false,
"required": false,
"description": "This enable MQTT client."
},
"mqttDebug": {
"title": "Debug",
"type": "boolean",
"default": false,
"required": false,
"description": "This enable debug mode for MQTT.",
"condition": {
"functionBody": "return model.devices[arrayIndices].enableMqtt === true;"
}
},
"mqttHost": {
"title": "IP/Hostname",
"type": "string",
"placeholder": "ip or hostname",
"required": true,
"format": "hostname",
"description": "Here set the IP/Hostname of MQTT Broker.",
"condition": {
"functionBody": "return model.devices[arrayIndices].enableMqtt === true;"
}
},
"mqttPort": {
"title": "Port",
"type": "integer",
"placeholder": 1883,
"required": true,
"description": "Here set the port of MQTT Broker.",
"condition": {
"functionBody": "return model.devices[arrayIndices].enableMqtt === true;"
}
},
"mqttClientId": {
"title": "Client ID",
"type": "string",
"placeholder": "client id",
"required": false,
"description": "Here optional set the Client ID of MQTT Broker.",
"condition": {
"functionBody": "return model.devices[arrayIndices].enableMqtt === true"
}
},
"mqttPrefix": {
"title": "Prefix",
"type": "string",
"placeholder": "home/envoy",
"required": false,
"description": "Here set the prefix.",
"condition": {
"functionBody": "return model.devices[arrayIndices].enableMqtt === true;"
}
},
"mqttAuth": {
"title": "Authorization",
"type": "boolean",
"default": false,
"required": false,
"description": "This enable authorization for MQTT Broker.",
"condition": {
"functionBody": "return model.devices[arrayIndices].enableMqtt === true;"
}
},
"mqttUser": {
"title": "User",
"type": "string",
"placeholder": "user",
"required": false,
"description": "Here set the user of MQTT Broker.",
"condition": {
"functionBody": "return model.devices[arrayIndices].enableMqtt === true && model.devices[arrayIndices].mqttAuth === true;"
}
},
"mqttPasswd": {
"title": "Password",
"type": "string",
"placeholder": "password",
"required": false,
"description": "Here set the password of MQTT Broker.",
"condition": {
"functionBody": "return model.devices[arrayIndices].enableMqtt === true && model.devices[arrayIndices].mqttAuth === true;"
}
}
}
}
}
}
},
"layout": [
{
"key": "devices",
"type": "tabarray",
"title": "{{ value.name || 'new device' }}",
"items": [
"devices[].name",
"devices[].host",
{
"key": "devices[]",
"type": "section",
"title": "Advanced Settings",
"expandable": true,
"expanded": false,
"items": [
{
"key": "devices[]",
"type": "tabarray",
"title": "{{ value.title }}",
"items": [
{
"key": "devices[]",
"title": "Production",
"items": [
{
"key": "devices[]",
"type": "tabarray",
"title": "{{ value.title }}",
"items": [
{
"key": "devices[]",
"title": "Power",
"items": [
"devices[].powerProductionSummary",
"devices[].powerProductionOnOff",
"devices[].powerProductionMax",
"devices[].powerProductionMaxDetected",
"devices[].powerProductionMaxAutoReset"
]
},
{
"key": "devices[]",
"title": "Energy",
"items": [
"devices[].energyProductionStateSensor",
"devices[].energyProductionLevelSensor",
"devices[].energyProductionLevelDetected",
"devices[].energyProductionLifetimeOffset"
]
}
]
}
]
},
{
"key": "devices[]",
"title": "Consumption",
"items": [
{
"key": "devices[]",
"type": "tabarray",
"title": "{{ value.title }}",
"items": [
{
"key": "devices[]",
"title": "Total",
"items": [
{
"key": "devices[]",
"type": "tabarray",
"title": "{{ value.title }}",
"items": [
{
"key": "devices[]",
"title": "Power",
"items": [
"devices[].powerConsumptionTotalMax",
"devices[].powerConsumptionTotalMaxDetected",
"devices[].powerConsumptionTotalMaxAutoReset"
]
},
{
"key": "devices[]",
"title": "Energy",
"items": [
"devices[].energyConsumptionTotalLifetimeOffset"
]
}
]
}
]
},
{
"key": "devices[]",
"title": "Net",
"items": [
{
"key": "devices[]",
"type": "tabarray",
"title": "{{ value.title }}",
"items": [
{
"key": "devices[]",
"title": "Power",
"items": [
"devices[].powerConsumptionNetMax",
"devices[].powerConsumptionNetMaxDetected",
"devices[].powerConsumptionNetMaxAutoReset"
]
},
{
"key": "devices[]",
"title": "Energy",
"items": [
"devices[].energyConsumptionNetLifetimeOffset"
]
}
]
}
]
}
]
}
]
},
{
"key": "devices[]",
"title": "Authorization",
"items": [
"devices[].envoyFirmware7xx",
"devices[].envoySerialNumber",
"devices[].enlightenUser",
"devices[].enlightenPasswd",
"devices[].envoyPasswd"
]
},
{
"key": "devices[]",
"title": "System",
"items": [
"devices[].enableDebugMode",
"devices[].disableLogInfo",
"devices[].disableLogDeviceInfo",
"devices[].supportProductionPowerMode",
"devices[].supportPlcLevel",
"devices[].supportEnsembleStatus",
"devices[].supportLiveData",
"devices[].liveDataRefreshTime",
"devices[].metersDataRefreshTime",
"devices[].productionDataRefreshTime"
]
}
]
}
]
},
{
"key": "devices[]",
"type": "section",
"title": "External Integrations",
"expandable": true,
"expanded": false,
"items": [
{
"key": "devices[]",
"type": "tabarray",
"title": "{{ value.title }}",
"items": [
{
"key": "devices[]",
"title": "RESTFul",
"items": [
"devices[].enableRestFul",
"devices[].restFulDebug",
"devices[].restFulPort"
]
},
{
"key": "devices[]",
"title": "MQTT",
"items": [
"devices[].enableMqtt",
"devices[].mqttDebug",
"devices[].mqttHost",
"devices[].mqttPort",
"devices[].mqttClientId",
"devices[].mqttPrefix",
"devices[].mqttAuth",
"devices[].mqttUser",
"devices[].mqttPasswd"
]
}
]
}
]
}
]
}
]
}