-
Notifications
You must be signed in to change notification settings - Fork 0
/
plugin.yaml
640 lines (536 loc) · 17.5 KB
/
plugin.yaml
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
# Metadata for the Smart-Plugin
plugin:
# Global plugin attributes
type: interface # plugin type (gateway, interface, protocol, system, web)
description:
de: 'Anbindung einer KWL Pluggit AP310 über das Modbus-Protokoll.'
en: ''
maintainer: 'Cannon'
# tester: # Who tests this plugin?
# state:
keywords: modbus
# documentation:
# support:
version: 2.0.3 # Plugin version
sh_minversion: 1.4c # minimum shNG version to use this plugin
# sh_maxversion: # maximum shNG version to use this plugin (leave empty if latest)
multi_instance: False # plugin supports multi instance
classname: Pluggit # class containing the plugin
parameters:
# Definition of parameters to be configured in etc/plugin.yaml
host:
type: str
mandatory: True
description:
de: 'Hostname oder IP Adresse des Pluggit Dienstes.'
en: 'Hostname or IP address of the Pluggit service.'
port:
type: int
mandatory: False
default: 502
valid_min: 0
valid_max: 65535
description:
de: 'Port Nummer des Pluggit Dienstes.'
en: 'Port number of Pluggit service.'
cycle:
type: int
mandatory: False
default: 50
description:
de: 'Zykluszeit.'
en: 'Cycle time.'
item_attributes:
# Definition of item attributes defined by this plugin
pluggit_read:
type: str
description:
de: 'Aus der Pluggit-Einheit zu lesende Daten.'
en: 'Data to be read from the Pluggit unit.'
pluggit_write:
type: str
description:
de: 'In die Pluggit-Einheit zu schreibender Wert.'
en: 'Value to be written to the Pluggit unit.'
pluggit_convert:
type: str
description:
de: 'Wandelt den gelesenen oder den zu schreibenden Wert in bzw. von ein anderes Format um.'
en: 'Convert the read or write to value to or from another format.'
item_structs:
pluggit:
DHCPEnabled:
type: bool
pluggit_read: prmDHCPEN
visu_acl: ro
IPAdress:
type: str
pluggit_read: prmCurrentIPAddress
visu_acl: ro
IPMask:
type: str
pluggit_read: prmCurrentIPMask
visu_acl: ro
IPGateway:
type: str
pluggit_read: prmCurrentIPGateway
visu_acl: ro
MACAdress:
type: str
pluggit_read: prmMACAddr
visu_acl: ro
SystemComponents:
type: num
pluggit_read: prmSystemID
visu_acl: ro
FP1:
type: bool
pluggit_read: prmSystemID
pluggit_convert: SID_FP1
visu_acl: ro
Week:
type: bool
pluggit_read: prmSystemID
pluggit_convert: SID_Week
visu_acl: ro
Bypass:
type: bool
pluggit_read: prmSystemID
pluggit_convert: SID_Bypass
visu_acl: ro
LRSwitch:
type: bool
pluggit_read: prmSystemID
pluggit_convert: SID_LRSwitch
visu_acl: ro
InternalPreheater:
type: bool
pluggit_read: prmSystemID
pluggit_convert: SID_InternalPreheater
visu_acl: ro
ServoFlow:
type: bool
pluggit_read: prmSystemID
pluggit_convert: SID_ServoFlow
visu_acl: ro
RHSensor:
type: bool
pluggit_read: prmSystemID
pluggit_convert: SID_RHSensor
visu_acl: ro
VOCSensor:
type: bool
pluggit_read: prmSystemID
pluggit_convert: SID_VOCSensor
visu_acl: ro
ExtOverride:
type: bool
pluggit_read: prmSystemID
pluggit_convert: SID_ExtOverride
visu_acl: ro
HAC1:
type: bool
pluggit_read: prmSystemID
pluggit_convert: SID_HAC1
visu_acl: ro
HRC2:
type: bool
pluggit_read: prmSystemID
pluggit_convert: SID_HRC2
visu_acl: ro
PCTool:
type: bool
pluggit_read: prmSystemID
pluggit_convert: SID_PCTool
visu_acl: ro
Apps:
type: bool
pluggit_read: prmSystemID
pluggit_convert: SID_Apps
visu_acl: ro
ZeegBee:
type: bool
pluggit_read: prmSystemID
pluggit_convert: SID_ZeegBee
visu_acl: ro
DI1Override:
type: bool
pluggit_read: prmSystemID
pluggit_convert: SID_DI1Override
visu_acl: ro
DI2Override:
type: bool
pluggit_read: prmSystemID
pluggit_convert: SID_DI2Override
visu_acl: ro
SystemSerialNum:
type: num
pluggit_read: prmSystemSerialNum
visu_acl: ro
SystemName:
type: str
pluggit_read: prmSystemName
pluggit_write: prmSystemName
visu_acl: rw
SwitchInBPosition:
type: bool
pluggit_read: prmHALLeft
visu_acl: ro
SwitchInAPosition:
type: bool
pluggit_read: prmHALRight
visu_acl: ro
FirmwareVersion:
type: num
pluggit_read: prmFWVersion
visu_acl: ro
HACFirmwareVersion:
type: num
pluggit_read: prmRamIdxHac1FirmwareVersion
visu_acl: ro
SystemTime:
type: num
pluggit_read: prmDateTime
pluggit_write: prmDateTimeSet
visu_acl: rw
DateTime:
type: foo
pluggit_read: prmDateTime
pluggit_write: prmDateTimeSet
pluggit_convert: ToDateTime
visu_acl: rw
Date:
type: foo
pluggit_read: prmDateTime
pluggit_convert: ToDate
visu_acl: ro
Time:
type: foo
pluggit_read: prmDateTime
pluggit_convert: ToTime
visu_acl: ro
WorkTime:
type: num
pluggit_read: prmWorkTime
visu_acl: ro
ExploitationDate:
type: foo
pluggit_read: prmStartExploitationDateStamp
visu_acl: ro
Date:
type: foo
pluggit_read: prmStartExploitationDateStamp
pluggit_convert: ToDate
visu_acl: ro
BLState:
type: num
pluggit_read: prmCurrentBLState
visu_acl: ro
Text:
type: str
pluggit_read: prmCurrentBLState
pluggit_convert: ToString
visu_acl: ro
CurrentUnitMode:
type: num
pluggit_read: prmRamIdxUnitMode
pluggit_write: prmRamIdxUnitMode
visu_acl: rw
DemandMode:
type: bool
pluggit_read: prmRamIdxUnitMode
pluggit_write: prmRamIdxUnitMode
pluggit_convert: UM_DemandMode
visu_acl: rw
ManualMode:
type: bool
pluggit_read: prmRamIdxUnitMode
pluggit_write: prmRamIdxUnitMode
pluggit_convert: UM_ManualMode
visu_acl: rw
WeekProgramMode:
type: bool
pluggit_read: prmRamIdxUnitMode
pluggit_write: prmRamIdxUnitMode
pluggit_convert: UM_WeekProgramMode
visu_acl: rw
AwayMode:
type: bool
pluggit_read: prmRamIdxUnitMode
pluggit_write: prmRamIdxUnitMode
pluggit_convert: UM_AwayMode
visu_acl: rw
FireplaceMode:
type: bool
pluggit_read: prmRamIdxUnitMode
pluggit_write: prmRamIdxUnitMode
pluggit_convert: UM_FireplaceMode
visu_acl: rw
SummerMode:
type: bool
pluggit_read: prmRamIdxUnitMode
pluggit_write: prmRamIdxUnitMode
pluggit_convert: UM_SummerMode
visu_acl: rw
NightMode:
type: bool
pluggit_read: prmRamIdxUnitMode
pluggit_write: prmRamIdxUnitMode
pluggit_convert: UM_NightMode
visu_acl: rw
NightMode_StartHour:
type: num
pluggit_read: prmRomIdxNightModeStartHour
pluggit_write: prmRomIdxNightModeStartHour
visu_acl: rw
NightMode_StartMin:
type: num
pluggit_read: prmRomIdxNightModeStartMin
pluggit_write: prmRomIdxNightModeStartMin
visu_acl: rw
NightMode_EndHour:
type: num
pluggit_read: prmRomIdxNightModeEndHour
pluggit_write: prmRomIdxNightModeEndHour
visu_acl: rw
NightMode_EndMin:
type: num
pluggit_read: prmRomIdxNightModeEndMin
pluggit_write: prmRomIdxNightModeEndMin
visu_acl: rw
ManualBypass:
type: bool
pluggit_read: prmRamIdxUnitMode
pluggit_write: prmRamIdxUnitMode
pluggit_convert: UM_ManualBypass
visu_acl: rw
FanSpeedLevel:
type: num
pluggit_read: prmRomIdxSpeedLevel
pluggit_write: prmRomIdxSpeedLevel
visu_acl: rw
Fan1rpm:
type: num
pluggit_read: prmHALTaho1
visu_acl: ro
Fan2rpm:
type: num
pluggit_read: prmHALTaho2
visu_acl: ro
# Frischluft
OutdoorTemperature:
type: num
pluggit_read: prmRamIdxT1
visu_acl: ro
# Zuluft
SupplyTemperature:
type: num
pluggit_read: prmRamIdxT2
visu_acl: ro
# Abluft
ExtractTemperature:
type: num
pluggit_read: prmRamIdxT3
visu_acl: ro
# Fortluft
ExhaustTemperature:
type: num
pluggit_read: prmRamIdxT4
visu_acl: ro
# Raumtemperatur, kabellos
RoomTemperature:
type: num
pluggit_read: prmRamIdxT5
visu_acl: ro
FilterRemainingLifetime:
type: num
pluggit_read: prmFilterRemainingTime
visu_acl: ro
FilterDefaultTime:
type: num
pluggit_read: prmFilterDefaultTime
pluggit_write: prmFilterDefaultTime
visu_acl: rw
FilterReset:
type: bool
pluggit_read: prmFilterReset
pluggit_write: prmFilterReset
visu_acl: rw
Alarm:
type: num
pluggit_read: prmLastActiveAlarm
visu_acl: ro
Text:
type: str
pluggit_read: prmLastActiveAlarm
pluggit_convert: ToString
visu_acl: ro
ClearAlarm:
type: num
pluggit_write: prmSetAlarmNum
visu_acl: rw
WeekProgram:
type: num
pluggit_read: prmNumOfWeekProgram
pluggit_write: prmNumOfWeekProgram
visu_acl: rw
Monday:
type: list
pluggit_read: PrmWeekMon
pluggit_write: PrmWeekMon
visu_acl: rw
Tuesday:
type: list
pluggit_read: PrmWeekTue
pluggit_write: PrmWeekTue
visu_acl: rw
Wednesday:
type: list
pluggit_read: PrmWeekWed
pluggit_write: PrmWeekWed
visu_acl: rw
Thursday:
type: list
pluggit_read: PrmWeekThu
pluggit_write: PrmWeekThu
visu_acl: rw
Friday:
type: list
pluggit_read: PrmWeekFri
pluggit_write: PrmWeekFri
visu_acl: rw
Saturday:
type: list
pluggit_read: PrmWeekSat
pluggit_write: PrmWeekSat
visu_acl: rw
Sunday:
type: list
pluggit_read: PrmWeekSun
pluggit_write: PrmWeekSun
visu_acl: rw
Bypass:
type: num
pluggit_read: prmRamIdxBypassActualState
visu_acl: ro
Text:
type: str
pluggit_read: prmRamIdxBypassActualState
pluggit_convert: ToString
visu_acl: ro
Open:
type: bool
pluggit_read: prmRamIdxBypassActualState
pluggit_convert: ToBool
visu_acl: ro
Tmin:
type: num
pluggit_read: prmBypassTmin
visu_acl: ro
Tmax:
type: num
pluggit_read: prmBypassTmax
visu_acl: ro
ManualMode:
type: bool
enforce_updates: yes
pluggit_read: prmRamIdxUnitMode
pluggit_write: prmRamIdxUnitMode
pluggit_convert: UM_ManualBypass
visu_acl: rw
ManualTimeout:
type: num
pluggit_read: prmRamIdxBypassManualTimeout
visu_acl: ro
PreheaterPower:
type: num
pluggit_read: prmPreheaterDutyCycle
visu_acl: ro
ReferenceExtractFanSpeed:
type: num
pluggit_read: prmRefValEx
visu_acl: ro
ReferenceSupplyFanSpeed:
type: num
pluggit_read: prmRefValSupl
visu_acl: ro
FireplacePresent:
type: bool
pluggit_read: prmFireplacePreset
visu_acl: ro
VOC_Sensor:
SensorValue:
type: num
pluggit_read: prmVOC
visu_acl: ro
LowTreshold:
type: num
pluggit_read: prmPPM1Unit
pluggit_write: prmPPM1Unit
visu_acl: rw
MiddleTreshold:
type: num
pluggit_read: prmPPM2Unit
pluggit_write: prmPPM2Unit
visu_acl: rw
HighTreshold:
type: num
pluggit_read: prmPPM3Unit
pluggit_write: prmPPM3Unit
visu_acl: rw
RH_Sensor:
SensorValue:
type: num
pluggit_read: prmRamIdxRh3Corrected
visu_acl: ro
SetPoint:
type: num
pluggit_read: prmRomIdxRhSetPoint
visu_acl: ro
HAC_Parts:
SystemIDComponents:
type: num
pluggit_read: prmSystemIDComponents
visu_acl: ro
CO2_Level:
type: num
pluggit_read: prmHACCO2Val
visu_acl: ro
CO2_LowTreshold:
type: num
pluggit_read: prmPPM1External
pluggit_write: prmPPM1External
visu_acl: rw
CO2_MiddleTreshold:
type: num
pluggit_read: prmPPM2External
pluggit_write: prmPPM2External
visu_acl: rw
CO2_HighTreshold:
type: num
pluggit_read: prmPPM3External
pluggit_write: prmPPM3External
visu_acl: rw
IdxHac1Components:
type: num
pluggit_read: prmRamIdxHac1Components
visu_acl: ro
SetpointT2:
type: num
pluggit_read: prmRomIdxAfterHeaterT2SetPoint
pluggit_write: prmRomIdxAfterHeaterT2SetPoint
visu_acl: rw
SetpointT3:
type: num
pluggit_read: prmRomIdxAfterHeaterT3SetPoint
pluggit_write: prmRomIdxAfterHeaterT3SetPoint
visu_acl: rw
SetpointT5:
type: num
pluggit_read: prmRomIdxAfterHeaterT5SetPoint
pluggit_write: prmRomIdxAfterHeaterT5SetPoint
visu_acl: rw
logic_parameters: NONE
# Definition of logic parameters defined by this plugin
plugin_functions:
# Definition of function interface of the plugin