-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathconfig.schema.json
1730 lines (1730 loc) · 85.9 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
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"pluginAlias": "PLC",
"headerDisplay": "Homebridge plugin for Siemens Step7 and compatible PLCs. <br>Information about push and control support mentioned in the description.",
"footerDisplay": "Please visit https://github.com/Feilner/homebridge-plc for more details.",
"pluginType": "platform",
"singular": true,
"schema": {
"type": "object",
"properties": {
"ip": {
"title": "PLC IPv4 Address (ip)",
"type": "string",
"default": "192.168.1.100",
"format": "ipv4",
"required": true,
"description": "IPv4 address of the PLC."
},
"rack": {
"title": "PLC Rack Number (rack)",
"description": "Rack number of the PLC, typically 0.",
"type": "integer",
"default": 0,
"minimum": 0,
"required": true
},
"slot": {
"title": "PLC Slot Number (slot)",
"description": "Slot number of the PLC. For S7 300/400 typically 2, for 1200/1500 typically 1.",
"type": "integer",
"default": 2,
"minimum": 0,
"required": true
},
"communicationOP": {
"title": "Use OP-Communication (communicationOP)",
"description": "Switch to OP-Communication if PG connections are limited on some PLCs.",
"type": "boolean",
"placeholder": false
},
"enablePolling": {
"title": "Enable Polling (enablePolling)",
"description": "Executes a background task every second to enable polling for the accessories.",
"type": "boolean",
"placeholder": false
},
"defaultPollInterval": {
"title": "Default Polling Interval (seconds) (defaultPollInterval)",
"description": "Defines the default polling interval when no interval is set per accessory.",
"type": "integer",
"minimum": 1,
"placeholder": 10
},
"distributePolling": {
"title": "Distribute Polling (distributePolling)",
"description": "Distributes the polling of accessories to avoid simultaneous queries and reduce PLC load.",
"type": "boolean",
"placeholder": false
},
"enablePush": {
"title": "Enable Push Server (enablePush)",
"description": "Starts an HTTP server to receive push updates from the PLC. The PLC must send an HTTP request, e.g., 'http://homebridgeIp:8888/?push&db=6096&offset=1.1&value=1'.",
"type": "boolean",
"placeholder": false
},
"enableControl": {
"title": "Enable Control Server (enableControl)",
"description": "Starts an HTTP server to allow control of accessories via HTTP, e.g., 'http://homebridgeIp:8888/?control&db=1014&offset=1&value=3'.",
"type": "boolean",
"placeholder": false
},
"port": {
"title": "Server Port (port)",
"description": "Port for the HTTP server to handle incoming requests for push and control functionality. Default port is 8888.",
"type": "integer",
"minimum": 1,
"placeholder": 8888
},
"forward": {
"title": "Enable Forwarding of Push and Control Requests (forward)",
"description": "Forward requests to another instance if the accessory limit is reached. Set the destination address of the second instance, e.g., 'http://127.0.0.1:8889'.",
"type": "boolean",
"placeholder": false
},
"mirror": {
"title": "Mirror Readings and Push Requests (mirror)",
"description": "Share the same accessories on two Homebridge instances for pairing with another Home or Home Assistant. Set the destination address of the second instance, e.g., 'http://192.168.1.11:8888'. (Experimental feature)",
"type": "boolean",
"placeholder": false
},
"accessories": {
"type": "array",
"items": {
"title": "Accessory",
"type": "object",
"properties": {
"accessory": {
"title": "PLC Accessory (accessory)",
"type": "string",
"required": true,
"default": "PLC_Dummy",
"oneOf": [
{
"title": "Select...",
"enum": ["PLC_Dummy"]
},
{
"title": "PLC_LightBulb",
"enum": ["PLC_LightBulb"]
},
{
"title": "PLC_Outlet",
"enum": ["PLC_Outlet"]
},
{
"title": "PLC_Switch",
"enum": ["PLC_Switch"]
},
{
"title": "PLC_TemperatureSensor",
"enum": ["PLC_TemperatureSensor"]
},
{
"title": "PLC_HumiditySensor",
"enum": ["PLC_HumiditySensor"]
},
{
"title": "PLC_Thermostat",
"enum": ["PLC_Thermostat"]
},
{
"title": "PLC_HumidifierDehumidifier",
"enum": ["PLC_HumidifierDehumidifier"]
},
{
"title": "PLC_WindowCovering",
"enum": ["PLC_WindowCovering"]
},
{
"title": "PLC_Window",
"enum": ["PLC_Window"]
},
{
"title": "PLC_Door",
"enum": ["PLC_Door"]
},
{
"title": "PLC_OccupancySensor",
"enum": ["PLC_OccupancySensor"]
},
{
"title": "PLC_MotionSensor",
"enum": ["PLC_MotionSensor"]
},
{
"title": "PLC_ContactSensor",
"enum": ["PLC_ContactSensor"]
},
{
"title": "PLC_LeakSensor",
"enum": ["PLC_LeakSensor"]
},
{
"title": "PLC_Faucet",
"enum": ["PLC_Faucet"]
},
{
"title": "PLC_Valve",
"enum": ["PLC_Valve"]
},
{
"title": "PLC_SecuritySystem",
"enum": ["PLC_SecuritySystem"]
},
{
"title": "PLC_StatelessProgrammableSwitch",
"enum": ["PLC_StatelessProgrammableSwitch"]
},
{
"title": "PLC_Doorbell",
"enum": ["PLC_Doorbell"]
},
{
"title": "PLC_LockMechanism",
"enum": ["PLC_LockMechanism"]
},
{
"title": "PLC_LockMechanismBool",
"enum": ["PLC_LockMechanismBool"]
},
{
"title": "PLC_GarageDoorOpener",
"enum": ["PLC_GarageDoorOpener"]
},
{
"title": "PLC_SmokeSensor",
"enum": ["PLC_SmokeSensor"]
},
{
"title": "PLC_Fan",
"enum": ["PLC_Fan"]
},
{
"title": "PLC_LightSensor",
"enum": ["PLC_LightSensor"]
},
{
"title": "PLC_LightSensor_DInt",
"enum": ["PLC_LightSensor_DInt"]
},
{
"title": "PLC_AirPurifier",
"enum": ["PLC_AirPurifier"]
},
{
"title": "PLC_FilterMaintenance",
"enum": ["PLC_FilterMaintenance"]
},
{
"title": "PLC_CarbonDioxideSensor",
"enum": ["PLC_CarbonDioxideSensor"]
},
{
"title": "PLC_CarbonMonoxideSensor",
"enum": ["PLC_CarbonMonoxideSensor"]
}
]
},
"name": {
"title": "Name (name)",
"type": "string",
"required": true,
"description": "Define the unique name for the accessory.",
"placeholder": "Enter unique name..."
},
"db": {
"title": "S7 Database Number (db)",
"type": "integer",
"minimum": 1,
"required": true,
"description": "S7 database number, e.g., 4 for DB4."
},
"manufacturer": {
"title": "Manufacturer (manufacturer)",
"type": "string",
"placeholder": "Homebridge",
"description": "Set the manufacturer name for display in the Home app."
},
"enablePolling": {
"title": "Enable Polling (enablePolling)",
"description": "Effective only when polling is enabled at the platform level.",
"type": "boolean",
"placeholder": false
},
"pollInterval": {
"title": "Polling Interval (seconds) (pollInterval)",
"description": "Overrides the platform-defined default polling interval.",
"type": "integer",
"minimum": 1,
"placeholder": 10
},
"adaptivePolling": {
"title": "Adaptive Polling (adaptivePolling) <b>(optional)</b>",
"description": "When set to `true`, the current position will be polled until the target position is reached. Polling starts with the set target position from the Home app, allowing the shutter to show as opening or closing during movement.",
"type": "boolean",
"placeholder": false,
"condition": {
"functionBody": "return ['PLC_WindowCovering','PLC_Window','PLC_Door'].includes(model.accessories[arrayIndices[0]].accessory);"
}
},
"adaptivePollingInterval": {
"title": "Adaptive Polling Interval (seconds) (adaptivePollingInterval) <b>(optional)</b>",
"description": "Poll interval in seconds during high-frequency polling. Default value is `1` second.",
"type": "integer",
"minimum": 1,
"placeholder": 1,
"condition": {
"functionBody": "return ['PLC_WindowCovering','PLC_Window','PLC_Door'].includes(model.accessories[arrayIndices[0]].accessory);"
}
},
"get_On": {
"title": "Get On (get_On) <b>(push support)</b>",
"description": "Offset and bit to read the current on/off state from the PLC. S7 type Bool, e.g., 55.1.",
"type": "number",
"required": true
},
"set_On": {
"title": "Single Bit Mode: Set on or off (set_On) <b>(control support)</b>",
"description": "Single Bit Mode: Offset and bit to set to 1/0 to the PLC when switching on/off. S7 type `Bool`, e.g., 55.1 for DB4DBX55.1. <br><b>Note:</b> Could be identical to get_On.",
"type": "number",
"required": true,
"condition": {
"functionBody": "return (!model.accessories[arrayIndices[0]].set_On_Set && !model.accessories[arrayIndices[0]].set_On_Reset);"
}
},
"set_On_Set": {
"title": "Separate Bits Mode: Set On Set (set_On_Set) <b>(control support)</b>",
"description": "Separate Bits Mode: Offset and bit set to 1 when switching on. S7 type `Bool`, e.g., 55.2 for DB4DBX55.2. <br><b>NOTE:</b> PLC has to set to 0 after handling the request.",
"type": "number",
"required": true,
"condition": {
"functionBody": "return (!model.accessories[arrayIndices[0]].set_On);"
}
},
"set_On_Reset": {
"title": "Separate Bits Mode: Set On Reset (set_On_Reset)",
"description": "Separate Bits Mode: Offset and bit set to 1 when switching off. S7 type `Bool`, e.g., 55.3 for DB4DBX55.3. <br><b>NOTE:</b> PLC has to set to 0 after handling the request.",
"type": "number",
"required": true,
"condition": {
"functionBody": "return (!model.accessories[arrayIndices[0]].set_On);"
}
},
"get_Active": {
"title": "Get Active (get_Active) <b>(push support)</b>",
"description": "Offset and bit to get the current status. S7 type `Bool`, e.g., `55.0` for `DB4DBX55.0`.",
"type": "number",
"condition": {
"functionBody": "return (!model.accessories[arrayIndices[0]].set_Active_Set && !model.accessories[arrayIndices[0]].set_Active_Reset);"
}
},
"set_Active": {
"title": "Single Bit Mode: Set Active (set_Active) <b>(control support)</b>",
"description": "Single Bit Mode: Offset and bit to set to 1/0 to the PLC when switching on/off. S7 type `Bool`, e.g., 55.1 for DB4DBX55.1. Could be the same as get_Active. <br>Separate Bits Mode: Offset and bit set to 1 when switching off. <br><b>NOTE:</b> PLC has to set to 0 after handling the request.",
"type": "number",
"condition": {
"functionBody": "return (!model.accessories[arrayIndices[0]].set_Active_Set && !model.accessories[arrayIndices[0]].set_Active_Reset);"
}
},
"set_Active_Set": {
"title": "Separate Bits Mode: Set Active Set (set_Active_Set) <b>(control support)</b>",
"description": "Separate Bits Mode: Offset and bit set to 1 when switching on. S7 type `Bool`, e.g., 55.2 for DB4DBX55.2. <br><b>NOTE:</b> PLC has to set to 0 after handling the request.",
"type": "number",
"condition": {
"functionBody": "return (!model.accessories[arrayIndices[0]].set_Active);"
}
},
"set_Active_Reset": {
"title": "Separate Bits Mode: Set Active Reset (set_Active_Reset)",
"description": "Separate Bits Mode: Offset and bit set to 1 when switching off. S7 type `Bool`, e.g., 55.3 for DB4DBX55.3. <br><b>NOTE:</b> PLC has to set to 0 after handling the request.",
"type": "number",
"condition": {
"functionBody": "return (!model.accessories[arrayIndices[0]].set_Active);"
}
},
"get_Brightness": {
"title": "Get Brightness (get_Brightness)",
"description": "Get brightness value. S7 type `Byte`, e.g., 56 for DB4DBB56.",
"type": "number"
},
"set_Brightness": {
"title": "Set Brightness (set_Brightness)",
"description": "Set brightness value. S7 type `Byte`, e.g., 57 for DB4DBB57.",
"type": "number"
},
"minTemperatureValue": {
"title": "Minimum Temperature Value (minTemperatureValue)",
"description": "Minimum temperature value.",
"type": "number",
"placeholder": -270
},
"maxTemperatureValue": {
"title": "Maximum Temperature Value (maxTemperatureValue)",
"description": "Maximum temperature value.",
"type": "number",
"placeholder": 100
},
"minTemperatureStep": {
"title": "Minimum Temperature Step (minTemperatureStep)",
"description": "Minimum temperature step.",
"type": "number",
"placeholder": 0.1
},
"minHumidityValue": {
"title": "Minimum Humidity Value (minHumidityValue)",
"description": "Minimum humidity value.",
"type": "number",
"placeholder": 0
},
"maxHumidityValue": {
"title": "Maximum Humidity Value (maxHumidityValue)",
"description": "Maximum humidity value.",
"type": "number",
"placeholder": 100
},
"minHumidityStep": {
"title": "Minimum Humidity Step (minHumidityStep)",
"description": "Minimum humidity step.",
"type": "number",
"placeholder": 1
},
"minTargetTemperatureValue": {
"title": "Minimum Target Temperature Value (minTargetTemperatureValue)",
"description": "Minimum target temperature value.",
"type": "number",
"placeholder": 10
},
"maxTargetTemperatureValue": {
"title": "Maximum Target Temperature Value (maxTargetTemperatureValue)",
"description": "Maximum target temperature value.",
"type": "number",
"placeholder": 38
},
"minTargetTemperatureStep": {
"title": "Minimum Target Temperature Step (minTargetTemperatureStep)",
"description": "Minimum target temperature step.",
"type": "number",
"placeholder": 0.1
},
"mapGetCurrentHeatingCoolingState": {
"title": "Map Get Current Heating Cooling State (mapGetCurrentHeatingCoolingState) <b>(optional)</b>",
"description": "Define mapping array for `get_CurrentHeatingCoolingState`. The PLC value is used as an index into the table. e.g., `[0, 2]` which maps the PLC value `0->0 1->2` when the PLC supports only two states with `0:inactive` and `1:cooling`.",
"type": "array",
"items": {
"type": "integer",
"minimum": 0
}
},
"mapSetTargetHeatingCoolingState": {
"title": "Map Set Target Heating Cooling State (mapSetTargetHeatingCoolingState) <b>(optional)</b>",
"type": "array",
"items": {
"type": "integer",
"minimum": 0
},
"description": "Define mapping array for `set_TargetHeatingCoolingState`. The home app value is used as an index into the table. e.g., `[0, 1, 0, 3]` which maps the PLC value `0->0 1->1 2->0, 3->3` when the PLC supports only two states with `0:off` and `1:heat` and `3:automatic`. The state cool is mapped to off."
},
"mapGetTargetHeatingCoolingState": {
"title": "Map Get Target Heating Cooling State (mapGetTargetHeatingCoolingState) <b>(optional)</b>",
"type": "array",
"items": {
"type": "integer",
"minimum": 0
},
"description": "Define mapping array for `get_TargetHeatingCoolingState`. The PLC value is used as an index into the table. e.g., `[0, 3]` which maps the PLC value `0->0 1->3` when the PLC supports only two states with `0:off` and `1:automatic`."
},
"minTargetHumidityValue": {
"title": "Minimum Target Humidity Value (minTargetHumidityValue)",
"type": "number",
"placeholder": 0,
"description": "Minimum target humidity value."
},
"maxTargetHumidityValue": {
"title": "Maximum Target Humidity Value (maxTargetHumidityValue)",
"type": "number",
"placeholder": 100,
"description": "Maximum target humidity value."
},
"minTargetHumidityStep": {
"title": "Minimum Target Humidity Step (minTargetHumidityStep)",
"type": "number",
"placeholder": 1,
"description": "Minimum target humidity step."
},
"minBrightnessValue": {
"title": "Minimum Brightness Value (minBrightnessValue)",
"type": "number",
"placeholder": 0,
"description": "Minimum brightness value."
},
"maxBrightnessValue": {
"title": "Maximum Brightness Value (maxBrightnessValue)",
"type": "number",
"placeholder": 100,
"description": "Maximum brightness value."
},
"minBrightnessStep": {
"title": "Minimum Brightness Step (minBrightnessStep)",
"type": "number",
"placeholder": 1,
"description": "Minimum brightness step."
},
"get_CurrentTemperature": {
"title": "Get Current Temperature (get_CurrentTemperature) <b>(push support)</b>",
"type": "number",
"description": "Offset to get current temperature. S7 type Real, e.g., 55 for DB4DBD55."
},
"get_CurrentRelativeHumidity": {
"title": "Get Current Relative Humidity (get_CurrentRelativeHumidity) <b>(push support)</b>",
"type": "number",
"description": "Offset to get current humidity. S7 type Real, e.g., 55 for DB4DBD55."
},
"get_TargetTemperature": {
"title": "Get Target Temperature (get_TargetTemperature) <b>(push support)</b>",
"type": "number",
"description": "Offset to get target temperature. S7 type Real, e.g., 4 for DB4DBD4."
},
"set_TargetTemperature": {
"title": "Set Target Temperature (set_TargetTemperature) <b>(control support)</b>",
"type": "number",
"description": "Offset to set target temperature. S7 type Real, e.g., 4 for DB4DBD4. Can have the same value as get_TargetTemperature."
},
"get_TargetRelativeHumidity": {
"title": "Get Target Relative Humidity (get_TargetRelativeHumidity) <b>(push support)</b>",
"type": "number",
"description": "Offset to get target humidity. S7 type Real, e.g., 4 for DB4DBD4."
},
"set_TargetRelativeHumidity": {
"title": "Set Target Relative Humidity (set_TargetRelativeHumidity) <b>(control support)</b>",
"type": "number",
"description": "Offset to set target humidity. S7 type Real, e.g., 4 for DB4DBD4. Can have the same value as get_TargetRelativeHumidity."
},
"get_CurrentHeatingCoolingState": {
"title": "Get Current Heating Cooling State (get_CurrentHeatingCoolingState) <b>(push support)</b>",
"type": "number",
"description": "Offset to get current heating/cooling state. S7 type Byte, e.g., 8 for DB4DBB8. When not defined, fixed 1: heating is used.<br>- 0: inactive (shown as green in Home app)<br>- 1: heating (shown as orange in Home app)<br>- 2: cooling (shown as blue in Home app)"
},
"get_TargetHeatingCoolingState": {
"title": "Get Target Heating Cooling State (get_TargetHeatingCoolingState) <b>(push support)</b>",
"type": "number",
"description": "Offset to get target heating/cooling state. S7 type Byte, e.g., 9 for DB4DBB9. When not defined, fixed 3: automatic is used.<br>- 0: off<br>- 1: heat<br>- 2: cool<br>- 3: automatic"
},
"set_TargetHeatingCoolingState": {
"title": "Set Target Heating Cooling State (set_TargetHeatingCoolingState) <b>(control support)</b>",
"type": "number",
"description": "Offset to set target heating/cooling state. Can be identical with get_TargetHeatingCoolingState. Has to be defined when get_TargetHeatingCoolingState is defined. When not defined, write changes are ignored. S7 type Byte, e.g., 9 for DB4DBB9.<br>- 0: off<br>- 1: heat<br>- 2: cool<br>- 3: automatic"
},
"get_CurrentHumidifierDehumidifierState": {
"title": "Get Current Humidifier Dehumidifier State (get_CurrentHumidifierDehumidifierState) <b>(optional)</b> <b>(push support)</b>",
"type": "number",
"description": "Offset to get current state. Default value 1: idle. S7 type Byte, e.g., 55 for DB4DBD55.<br>- 0: inactive<br>- 1: idle<br>- 2: humidifying<br>- 3: dehumidifying"
},
"mapGetCurrentHumidifierDehumidifierState": {
"title": "Map Get Current Humidifier Dehumidifier State (mapGetCurrentHumidifierDehumidifierState) <b>(optional)</b>",
"type": "array",
"description": "Define mapping array for get_CurrentHumidifierDehumidifierState. The PLC value is used as an index into the table. e.g., [1, 3] which maps the PLC value 0->1 1->3 when the PLC supports only two states with 0: idle and 1: dehumidifying."
},
"default_TargetHumidifierDehumidifierState": {
"title": "Default Target Humidifier Dehumidifier State (default_TargetHumidifierDehumidifierState) <b>(optional)</b>",
"type": "number",
"description": "Defines an alternative value that's returned when get_TargetHumidifierDehumidifierState is not defined. Default value 0: auto.<br>- 0: auto (humidifier or dehumidifier)<br>- 1: humidifier<br>- 2: dehumidifier"
},
"get_TargetHumidifierDehumidifierState": {
"title": "Get Target Humidifier Dehumidifier State (get_TargetHumidifierDehumidifierState) <b>(optional)</b> <b>(push support)</b>",
"type": "number",
"description": "Offset to get current target state. S7 type Byte, e.g., 55 for DB4DBD55.<br>- 0: auto (humidifier or dehumidifier)<br>- 1: humidifier<br>- 2: dehumidifier"
},
"set_TargetHumidifierDehumidifierState": {
"title": "Set Target Humidifier Dehumidifier State (set_TargetHumidifierDehumidifierState) <b>(optional)</b> <b>(control support)</b>",
"type": "number",
"description": "Offset to set current target state. Needs to be defined when get_TargetHumidifierDehumidifierState is set. S7 type Byte, e.g., 55 for DB4DBD55.<br>- 0: auto (humidifier or dehumidifier)<br>- 1: humidifier<br>- 2: dehumidifier"
},
"mapGetTargetHumidifierDehumidifierState": {
"title": "Map Get Target Humidifier Dehumidifier State (mapGetTargetHumidifierDehumidifierState) <b>(optional)</b>",
"type": "array",
"items": {
"type": "integer",
"minimum": 0
},
"description": "Define mapping array for get_TargetHumidifierDehumidifierState. The PLC value is used as an index into the table. e.g., [2, 1] which maps the PLC value 0->1 1->2 when the PLC supports only one state with 0: dehumidifier 1: humidifier."
},
"mapSetTargetHumidifierDehumidifierState": {
"title": "Map Set Target Humidifier Dehumidifier State (mapSetTargetHumidifierDehumidifierState) <b>(optional)</b>",
"type": "array",
"items": {
"type": "integer",
"minimum": 0
},
"description": "Define mapping array for set_TargetHumidifierDehumidifierState. The Home app value is used as an index into the table. e.g., [2, 2, 2] writes always the value 2 to the PLC regardless of what's set in the Home app."
},
"get_SwingMode": {
"title": "Get Swing Mode (get_SwingMode) <b>(optional)</b> <b>(push support)</b>",
"type": "number",
"description": "Offset to get swing mode. S7 type Byte, e.g., 8 for DB4DBB8.<br>- 0: swing disabled<br>- 1: swing enabled"
},
"set_SwingMode": {
"title": "Set Swing Mode (set_SwingMode) <b>(optional but required when get_SwingMode is defined)</b> <b>(push support)</b>",
"type": "number",
"description": "Offset to set swing mode. S7 type Byte, e.g., 9 for DB4DBB9.<br>- 0: swing disabled<br>- 1: swing enabled"
},
"get_WaterLevel": {
"title": "Get Water Level (get_WaterLevel) <b>(optional)</b> <b>(push support)</b>",
"type": "number",
"description": "Offset to get water level. S7 type Real, e.g., 8 for DB4DBD8."
},
"get_CurrentPosition": {
"title": "Get Current Position (get_CurrentPosition) <b>(push support)</b>",
"type": "number",
"description": "Offset to get current position 0: closed 100: open. S7 type Byte, e.g., 0 for DB4DBB0.<br>- 0: closed<br>- in between: partly open<br>- 100: open"
},
"invertPosition": {
"title": "Invert Position (invertPosition) <b>(optional)</b>",
"type": "boolean",
"placeholder": false,
"description": "Set to true to invert the values of current and target position from 0: closed 100: open to 100: closed 0: open."
},
"forceCurrentPosition": {
"title": "Force Current Position (forceCurrentPosition) <b>(optional)</b>",
"type": "boolean",
"placeholder": false,
"description": "When set to true, the position set by set_TargetPosition is directly used as the current position. This makes it appear in the Home app as if the target position was directly reached. This is recommended when not using adaptivePolling or pushing the value from the PLC."
},
"mapGetCurrentPosition": {
"title": "Map Get Current Position (mapGetCurrentPosition) <b>(optional)</b>",
"type": "array",
"items": {
"type": "integer",
"minimum": 0
},
"description": "Define mapping array for get position. The PLC value is used as an index into the table. e.g., [0, 25, 100] which maps the PLC value 0->0 1->25 2->100. This is useful, e.g., for window open state."
},
"get_TargetPosition": {
"title": "Get Target Position (get_TargetPosition) <b>(optional)</b> <b>(push support)</b>",
"type": "number",
"description": "Offset to get target position. S7 type Byte, e.g., 1 for DB4DBB1. Can have the same value as set_TargetPosition.<br>- 0: closed<br>- in between: partly open<br>- 100: open"
},
"set_TargetPosition": {
"title": "Set Target Position (set_TargetPosition) <b>(optional)</b> <b>(control support)</b>",
"type": "number",
"description": "Offset to set target position 0: closed 100: open. S7 type Byte, e.g., 2 for DB4DBB2. Can have the same value as get_TargetPosition.<br>- 0: closed<br>- in between: partly open<br>- 100: open"
},
"get_PositionState": {
"title": "Get Position State (get_PositionState) <b>(optional)</b> <b>(push support)</b>",
"type": "number",
"description": "Offset to current movement state. If not defined, fixed 2 is returned. S7 type Byte, e.g., 3 for DB4DBB3.<br>- 0: down<br>- 1: up<br>- 2: stop"
},
"set_HoldPosition": {
"title": "Set Hold Position (set_HoldPosition) <b>(optional)</b> <b>(control support)</b>",
"type": "number",
"description": "Offset and bit set to 1 to stop movement. (Seems not to be used by Home app) When not defined, writes will be ignored. S7 type Bool, e.g., 55.1 for DB4DBX55.1.<br><b>NOTE:</b> PLC has to set to 0 after handling the request."
},
"get_OccupancyDetected": {
"title": "Get Occupancy Detected (get_OccupancyDetected) <b>(push support)</b>",
"type": "number",
"description": "Offset and bit to get the current status. S7 type Bool, e.g., 55.0 for DB4DBX55.0.<br>- false: no occupancy<br>- true: occupancy detected"
},
"invertOccupancy": {
"title": "Invert Occupancy (invertOccupancy)",
"type": "boolean",
"placeholder": false,
"description": "When enabled, it inverts the logic of get_OccupancyDetected to<br> false: motion detected and true: no motion."
},
"get_MotionDetected": {
"title": "Get Motion Detected (get_MotionDetected) <b>(push support)</b>",
"type": "number",
"description": "Offset and bit to get the current status. S7 type Bool, e.g., 55.0 for DB4DBX55.0.<br>- false: no occupancy<br>- true: occupancy detected"
},
"invertMotionDetected": {
"title": "Invert Motion Detected (invertMotionDetected)",
"type": "boolean",
"placeholder": false,
"description": "When enabled, it inverts the logic of get_MotionDetected to<br> false: closed and true: no motion."
},
"get_ContactSensorState": {
"title": "Get Contact Sensor State (get_ContactSensorState) <b>(push support)</b>",
"type": "number",
"description": "Offset and bit to get the current status. S7 type Bool, e.g., 55.0 for DB4DBX55.0.<br>- false: closed<br>- true: open"
},
"invertContactSensorState": {
"title": "Invert Contact Sensor State (invertContactSensorState)",
"type": "boolean",
"placeholder": false,
"description": "When enabled, it inverts the logic of get_ContactSensorState to<br> false: open and true: closed."
},
"get_LeakDetected": {
"title": "Get Leak Detected (get_LeakDetected) <b>(push support)</b>",
"type": "number",
"description": "Offset and bit to get the current status. S7 type Bool, e.g., 55.0 for DB4DBX55.0.<br>- false: no leak detected<br>- true: leak detected"
},
"invertLeakDetected": {
"title": "Invert Leak Detected (invertLeakDetected)",
"type": "boolean",
"placeholder": false,
"description": "When enabled, it inverts the logic of get_LeakDetected to<br> false: leak detected and true: no leak detected."
},
"get_SetDuration": {
"title": "Get Set Duration (get_SetDuration) <b>(push support)</b>",
"type": "number",
"description": "Offset to get duration 0..3600 sec. S7 type Time, e.g., 10 for DB4DBD10."
},
"set_SetDuration": {
"title": "Set Set Duration (set_SetDuration) <b>(control support)</b>",
"type": "number",
"description": "Offset to set duration 0..3600 sec. S7 type Time, e.g., 14 for DB4DBD10."
},
"get_RemainingDuration": {
"title": "Get Remaining Duration (get_RemainingDuration) <b>(push support)</b>",
"type": "number",
"description": "Offset to get remaining duration 0..3600 sec. S7 type Time, e.g., 18 for DB4DBD10."
},
"get_CurrentAmbientLightLevel": {
"title": "Get Current Ambient Light Level (get_CurrentAmbientLightLevel) <b>(push support)</b>",
"type": "number",
"description": "Offset to get current illumination in LUX. S7 type Real, value limited to 0.0001 ~ 100,000, e.g., 55 for DB4DBD55."
},
"get_CurrentAmbientLightLevelDInt": {
"title": "Get Current Ambient Light Level (get_CurrentAmbientLightLevelDInt) <b>(push support)</b>",
"type": "number",
"description": "Offset to get current illumination in LUX. S7 type DInt, value limited to 0.0001 ~ 100,000, e.g., 55 for DB4DBD55."
},
"get_SecuritySystemCurrentState": {
"title": "Get Security System Current State (get_SecuritySystemCurrentState) <b>(push support)</b>",
"type": "number",
"description": "Offset to current security system state. S7 type Byte, e.g., 3 for DB4DBB3.<br>- 0: armed stay at home<br>- 1: armed away from home<br>- 2: armed night<br>- 3: disarmed<br>- 4: alarm triggered"
},
"get_SecuritySystemTargetState": {
"title": "Get Security System Target State (get_SecuritySystemTargetState) <b>(push support)</b>",
"type": "number",
"description": "Offset to set target security system state. S7 type Byte, e.g., 5 for DB4DBB4.<br>- 0: armed stay at home<br>- 1: armed away from home<br>- 2: armed night<br>- 3: disarmed"
},
"set_SecuritySystemTargetState": {
"title": "Set Security System Target State (set_SecuritySystemTargetState) <b>(control support)</b>",
"type": "number",
"description": "Offset to set target security system state. S7 type Byte, e.g., 6 for DB4DBB6.<br>- 0: armed stay at home<br>- 1: armed away from home<br>- 2: armed night<br>- 3: disarmed"
},
"mapGetSecuritySystemCurrentState": {
"title": "Map Get Security System Current State (mapGetSecuritySystemCurrentState) <b>(optional)</b>",
"type": "array",
"items": {
"type": "integer",
"minimum": 0
},
"description": "Define mapping array for get security system state. The PLC value is used as an index into the table. e.g., [3, 1] which maps the PLC value 0->3 1->2 when the PLC supports only two states with 0: disarmed and 1: armed and 2: alarm."
},
"mapSetSecuritySystemTargetState": {
"title": "Map Set Security System Target State (mapSetSecuritySystemTargetState) <b>(optional)</b>",
"type": "array",
"items": {
"type": "integer",
"minimum": 0
},
"description": "Define mapping array for set security system state. The home app value is used as an index into the table. e.g., [1, 1, 1, 0, 2] which maps the PLC value 0->1 1->1 2->1, 3->0, 4->2 when the PLC supports only two states with 0: disarmed and 1: armed and 2: alarm."
},
"mapGetSecuritySystemTargetState": {
"title": "Map Get Security System Target State (mapGetSecuritySystemTargetState) <b>(optional)</b>",
"type": "array",
"items": {
"type": "integer",
"minimum": 0
},
"description": "Define mapping array for get security system state. The PLC value is used as an index into the table. e.g., [3, 1] which maps the PLC value 0->3 1->2 when the PLC supports only two states with 0: disarmed and 1: armed and 2: alarm."
},
"isEvent": {
"title": "Is Event (isEvent) <b>(optional)</b>",
"type": "number",
"description": "Offset and bit that is polled by homebridge-plc. <br><b>NOTE:</b> PLC has to set to `true`. When polled with value `true` the actual event is read from `get_ProgrammableSwitchEvent` and this flag is set to `false` by homebridge-plc to confirm that the event is handled. S7 type `Bool`, e.g., 55.1 for `DB4DBX55.1` <b>(polling only, not used for push)</b>"
},
"get_ProgrammableSwitchEvent": {
"title": "Get Programmable Switch Event (get_ProgrammableSwitchEvent) <b>(push support)</b> <b>(control support)</b>",
"type": "number",
"description": "Offset to read current event of the switch. This is reported towards Home app. S7 type `Byte`, e.g., 3 for `DB4DBB3`.<br>- 0: single press<br>- 1: double press<br>- 2: long press<br>- 3: unknown"
},
"get_LockCurrentState": {
"title": "Get Lock Current State (get_LockCurrentState) <b>(push support)</b>",
"type": "number",
"description": "Offset to read current state. S7 type `Bool`, e.g., 3.1 for `DB4DBB3`.<br>- false: secured<br>- true: unsecured"
},
"forceCurrentLockState": {
"title": "Force Current Lock State (forceCurrentLockState) <b>(optional)</b>",
"type": "boolean",
"placeholder": false,
"description": "When set to `true`, the state set by `set_LockTargetState` is directly used as current state. This makes it appear in the Home app as if the target state was directly reached. This is recommended when not using `enablePolling` or pushing the value from the PLC."
},
"get_LockTargetState": {
"title": "Get Lock Target State (get_LockTargetState) <b>(push support)</b>",
"type": "number",
"description": "Offset to read current state. S7 type `Byte`, e.g., 3 for `DB4DBB3`.<br>- 0: unsecured<br>- 1: secured<br>- 2: jammed<br>- 3: unknown"
},
"set_LockTargetState": {
"title": "Set Lock Target State (set_LockTargetState) <b>(control support)</b>",
"type": "number",
"description": "Offset to write target state. S7 type `Byte`, e.g., 3 for `DB4DBB3`.<br>- 0: unsecured<br>- 1: secured"
},
"get_LockCurrentStateBool": {
"title": "Get Lock Current State (get_LockCurrentStateBool) <b>(push support)</b>",
"type": "number",
"description": "Offset to read current state. S7 type `Bool`, e.g., 3.1 for `DB4DBB3`.<br>- false: secured<br>- true: unsecured"
},
"invertLockState": {
"title": "Invert Lock State (invertLockState) <b>(optional)</b>",
"type": "boolean",
"description": "When set to `true`, all states are inverted (current and target state).<br>- false: unsecured<br>- true: secured"
},
"get_LockTargetStateBool": {
"title": "Get Lock Target State (get_LockTargetStateBool) <b>(push support)</b>",
"type": "number",
"description": "Offset to read target state. S7 type `Bool`, e.g., 3.1 for `DB4DBB3`.<br>- false: secured<br>- true: unsecured"
},
"set_LockTargetStateBool": {
"title": "Single Bit Mode: Set Lock Target State (set_LockTargetStateBool) <b>(control support)</b>",
"type": "number",
"description": "Offset to write target state. S7 type `Bool`, e.g., 3.1 for `DB4DBB3`.<br>- false: secured<br>- true: unsecured",
"condition": {
"functionBody": "return (!model.accessories[arrayIndices[0]].set_LockTargetStateBool_Secured && !model.accessories[arrayIndices[0]].set_LockTargetStateBool_Unsecured);"
}
},
"set_LockTargetStateBool_Secured": {
"title": "Separate Bits Mode: Set Lock Target State Secured (set_LockTargetStateBool_Secured) <b>(control support)</b>",
"type": "number",
"description": "Offset and bit set to `true` when switching to target state secured. S7 type `Bool`, e.g., 3.3 for `DB4DBX3.3`.<br><b>NOTE:</b> PLC has to set to 0 after handling the request.",
"condition": {
"functionBody": "return (!model.accessories[arrayIndices[0]].set_LockTargetStateBool);"
}
},
"set_LockTargetStateBool_Unsecured": {
"title": "Separate Bits Mode: Set Lock Target State Unsecured (set_LockTargetStateBool_Unsecured)",
"type": "number",
"description": "Offset and bit set to `true` when switching to target state unsecured. S7 type `Bool`, e.g., 3.3 for `DB4DBX3.3`.<br><b>NOTE:</b> PLC has to set to 0 after handling the request.",
"condition": {
"functionBody": "return (!model.accessories[arrayIndices[0]].set_LockTargetStateBool);"
}
},
"get_CurrentDoorState": {
"title": "Get Current Door State (get_CurrentDoorState) <b>(push support)</b>",
"type": "number",
"description": "Offset to read current state. S7 type `Byte`, e.g., 3 for `DB4DBB3`.<br>- 0: open<br>- 1: closed<br>- 2: opening<br>- 3: closing<br>- 4: stopped"
},
"forceCurrentDoorState": {
"title": "Force Current Door State (forceCurrentDoorState) <b>(optional)</b>",
"type": "boolean",
"placeholder": false,
"description": "When set to `true`, the position set by `set_TargetDoorState` is directly used as current state. This makes it appear in the Home app as if the target state was directly reached. This is recommended when not using `enablePolling` or pushing the value from the PLC."
},
"get_TargetDoorState": {
"title": "Get Target Door State (get_TargetDoorState) <b>(push support)</b>",
"type": "number",
"description": "Offset to read target state. S7 type `Byte`, e.g., 3 for `DB4DBB3`.<br>- 0: open<br>- 1: closed"
},
"set_TargetDoorState": {
"title": "Set Target Door State (set_TargetDoorState) <b>(control support)</b>",
"type": "number",
"description": "Offset to write target state. S7 type `Byte`, e.g., 3 for `DB4DBB3`.<br>- 0: open<br>- 1: closed"
},
"get_SmokeDetected": {
"title": "Get Smoke Detected (get_SmokeDetected) <b>(push support)</b>",
"type": "number",
"description": "Offset and bit to smoke detection. S7 type `Bool`, e.g., 55.1 for `DB4DBX55.1`.<br>- false: ok<br>- true: smoke detected"
},
"get_CurrentFanState": {
"title": "Get Current Fan State (get_CurrentFanState) <b>(optional)</b> <b>(push support)</b>",
"type": "number",
"description": "Offset to get current heating/cooling state. S7 type `Byte`, e.g., 8 for `DB4DBB8`.<br>- 0: inactive<br>- 1: idle<br>- 2: blowing"
},
"default_CurrentFanState": {
"title": "Default Current Fan State (default_CurrentFanState) <b>(optional)</b>",
"type": "number",
"description": "Defines an alternative value that's returned when `get_CurrentFanState` is not defined. Default value `0: inactive`."
},
"mapCurrentFanStateGet": {
"title": "Map Current Fan State Get (mapCurrentFanStateGet) <b>(optional)</b>",
"type": "array",
"items": {
"type": "integer",
"minimum": 0
},
"description": "Define mapping array for `get_CurrentFanState`. The PLC value is used as an index into the table. e.g., `[0, 2]` which maps the PLC value `0->1 1->2` when the PLC supports only two states with `0: idle` and `1: blowing`."
},
"default_TargetFanState": {
"title": "Default Target Fan State (default_TargetFanState) <b>(optional)</b>",
"type": "number",
"description": "Defines an alternative value that's returned when `get_TargetFanState` is not defined. Default value `0: manual`.<br>- 0: manual<br>- 1: automatic"
},
"get_TargetFanState": {
"title": "Get Target Fan State (get_TargetFanState) <b>(push support)</b>",
"type": "number",
"description": "Offset to get target heating/cooling state. S7 type `Byte`, e.g., 9 for `DB4DBB9`. When not defined, fixed `1: automatic` is used."
},
"set_TargetFanState": {
"title": "Set Target Fan State (set_TargetFanState) <b>(optional but required when `get_TargetFanState` is defined)</b> <b>(control support)</b>",
"type": "number",
"description": "Offset to get target heating/cooling state. S7 type `Byte`, e.g., 9 for `DB4DBB9`. When not defined, fixed `1: automatic` is used.<br>- 0: manual<br>- 1: automatic"
},
"mapTargetFanStateGet": {
"title": "Map Target Fan State Get (mapTargetFanStateGet) <b>(optional)</b> <b>(push support)</b>",
"type": "array",
"items": {
"type": "integer",
"minimum": 0
},
"description": "Define mapping array for `get_TargetFanState`. The PLC value is used as an index into the table. e.g., `[1, 0]` which maps the PLC value `0->1 1->0` when the PLC supports only two states with `0: automatic` and `1: manual`."
},
"mapTargetFanStateSet": {
"title": "Map Target Fan State Set (mapTargetFanStateSet) <b>(optional)</b>",
"type": "array",
"items": {
"type": "integer",
"minimum": 0
},
"description": "The home app value is used as an index into the table. e.g., `[1, 0]` which maps the PLC value `0->1 1->0` when the PLC supports only two states with `0: automatic` and `1: manual`."
},
"get_RotationSpeedByte": {
"title": "Get Rotation Speed Byte (get_RotationSpeedByte) <b>(optional)</b> <b>(push support)</b>",
"type": "number",
"description": "Offset to get rotation speed state. S7 type `Byte`, e.g., 8 for `DB4DBB8`.",
"condition": {
"functionBody": "return (!model.accessories[arrayIndices[0]].get_RotationSpeed && !model.accessories[arrayIndices[0]].set_RotationSpeed);"
}
},
"set_RotationSpeedByte": {
"title": "Set Rotation Speed Byte (set_RotationSpeedByte) <b>(optional but required when `set_RotationSpeedByte` is defined)</b> <b>(push support)</b>",
"type": "number",
"description": "Offset to get set speed state. S7 type `Byte`, e.g., 9 for `DB4DBB9`.",
"condition": {
"functionBody": "return (!model.accessories[arrayIndices[0]].get_RotationSpeed && !model.accessories[arrayIndices[0]].set_RotationSpeed);"
}
},
"get_RotationSpeed": {
"title": "Get Rotation Speed (get_RotationSpeed) <b>(optional)</b> <b>(push support)</b>",
"type": "number",
"description": "Offset to get rotation speed state. S7 type `Real`, e.g., 8 for `DB4DBB8`.",
"condition": {
"functionBody": "return (!model.accessories[arrayIndices[0]].get_RotationSpeedByte && !model.accessories[arrayIndices[0]].set_RotationSpeedByte);"
}
},
"set_RotationSpeed": {
"title": "Set Rotation Speed (set_RotationSpeed) <b>(optional but required when `get_RotationSpeed` is defined)</b> <b>(push support)</b>",
"type": "number",
"description": "Offset to get set speed state. S7 type `Real`, e.g., 9 for `DB4DBB9`.",
"condition": {
"functionBody": "return (!model.accessories[arrayIndices[0]].get_RotationSpeedByte && !model.accessories[arrayIndices[0]].set_RotationSpeedByte);"
}
},
"get_RotationDirection": {
"title": "Get Rotation Direction (get_RotationDirection) <b>(optional)</b> <b>(push support)</b>",
"type": "number",
"description": "Offset to get rotation direction state. S7 type `Byte`, e.g., 9 for `DB4DBB9`. When not defined, fixed `0: clockwise` is used.<br>- 0: clockwise<br>- 1: counter clockwise"
},
"set_RotationDirection": {
"title": "Set Rotation Direction (set_RotationDirection) <b>(optional)</b> <b>(control support)</b>",
"type": "number",
"description": "Offset to set rotation direction state. S7 type `Byte`, e.g., 9 for `DB4DBB9`.<br>- 0: clockwise<br>- 1: counter clockwise"
},
"mapRotationDirectionGet": {
"title": "Map Rotation Direction Get (mapRotationDirectionGet) <b>(optional)</b>",
"type": "array",
"items": {
"type": "integer",
"minimum": 0
},
"description": "Define mapping array for `get_RotationDirection`. The PLC value is used as an index into the table. e.g., `[1, 0]` inverts the direction."
},
"mapRotationDirectionSet": {
"title": "Map Rotation Direction Set (mapRotationDirectionSet) <b>(optional)</b>",
"type": "array",
"items": {
"type": "integer",
"minimum": 0
},
"description": "Define mapping array for `set_RotationDirection`. The home app value is used as an index into the table. e.g., `[1, 0]` inverts the direction."
},
"get_CurrentAirPurifierState": {
"title": "Get Current Air Purifier State (get_CurrentAirPurifierState) <b>(optional)</b> <b>(push support)</b>",
"type": "number",
"description": "Offset to get current heating/cooling state. S7 type `Byte`, e.g., 8 for `DB4DBB8`.<br>- 0: inactive<br>- 1: idle<br>- 2: purifying air"
},
"default_CurrentAirPurifierState": {
"title": "Default Current Air Purifier State (default_CurrentAirPurifierState) <b>(optional)</b>",
"type": "number",
"description": "Defines an alternative value that's returned when `get_CurrentAirPurifierState` is not defined. Default value `0: inactive`."
},
"mapCurrentAirPurifierState": {
"title": "Map Current Air Purifier State (mapCurrentAirPurifierState) <b>(optional)</b>",
"type": "array",
"items": {
"type": "integer",
"minimum": 0
},
"description": "Define mapping array for `get_CurrentFanState`. The PLC value is used as an index into the table. e.g., `[0, 2]` which maps the PLC value `0->1 1->2` when the PLC supports only two states with `0: idle` and `1: blowing`."
},
"default_TargetAirPurifierState": {
"title": "Default Target Air Purifier State (default_TargetAirPurifierState) <b>(optional)</b>",
"type": "number",
"description": "Defines an alternative value that's returned when `get_TargetAirPurifierState` is not defined. Default value `0: manual`.<br>- 0: manual<br>- 1: automatic"
},
"get_TargetAirPurifierState": {
"title": "Get Target Air Purifier State (get_TargetAirPurifierState) <b>(optional)</b> <b>(push support)</b>",
"type": "number",
"description": "Offset to get target heating/cooling state. S7 type `Byte`, e.g., 9 for `DB4DBB9`. When not defined, fixed `1: automatic` is used.<br>- 0: manual<br>- 1: automatic"
},
"set_TargetAirPurifierState": {
"title": "Set Target Air Purifier State (set_TargetAirPurifierState) <b>(optional but required when `get_TargetAirPurifierState` is defined)</b> <b>(control support)</b>",
"type": "number",
"description": "Offset to get target heating/cooling state. S7 type `Byte`, e.g., 9 for `DB4DBB9`. When not defined, fixed `1: automatic` is used.<br>- 0: manual<br>- 1: automatic"
},
"mapTargetAirPurifierStateGet": {
"title": "Map Target Air Purifier State Get (mapTargetAirPurifierStateGet) <b>(optional)</b>",
"type": "array",
"items": {
"type": "integer",
"minimum": 0
},
"description": "Define mapping array for `get_TargetAirPurifierState`. The PLC value is used as an index into the table. e.g., `[1, 0]` which maps the PLC value `0->1 1->0` when the PLC supports only two states with `0: automatic` and `1: manual`."
},
"mapTargetAirPurifierStateSet": {
"title": "Map Target Air Purifier State Set (mapTargetAirPurifierStateSet) <b>(optional)</b>",
"type": "array",
"items": {
"type": "integer",
"minimum": 0
},
"description": "Define mapping array for `set_TargetAirPurifierState`. The home app value is used as an index into the table. e.g., `[1, 0]` which maps the PLC value `0->1 1->0` when the PLC supports only two states with `0: automatic` and `1: manual`."
},
"get_FilterChangeIndication": {
"title": "Get Filter Change Indication (get_FilterChangeIndication) <b>(push support)</b>",
"type": "number",
"description": "Offset and bit to filter change indication. S7 type `Bool`, e.g., 55.3 for `DB4DBX55.3`.<br>- 0: filter ok<br>- true: change filter"
},
"get_FilterLifeLevel": {
"title": "Get Filter Life Level (get_FilterLifeLevel) <b>(optional)</b> <b>(push support)</b>",
"type": "number",
"description": "Offset and bit to filter life level. S7 type `Byte`, e.g., 56 for `DB4DBX56`.<br>- false: change filter<br>- 100: filter is new"