-
Notifications
You must be signed in to change notification settings - Fork 21
Expand file tree
/
Copy path_P151_DucoSerialGateway.ino
More file actions
749 lines (621 loc) · 25.3 KB
/
Copy path_P151_DucoSerialGateway.ino
File metadata and controls
749 lines (621 loc) · 25.3 KB
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
//#################################### Plugin 151: DUCO Serial Gateway ##################################
//
// DUCO Serial Gateway to read Ducobox data
// https://github.com/arnemauer/Ducobox-ESPEasy-Plugin
// http://arnemauer.nl/ducobox-gateway/
//#######################################################################################################
#include "_Plugin_Helper.h"
#include "DucoSerialHelpers.h"
#define PLUGIN_151
#define PLUGIN_ID_151 151
#define PLUGIN_NAME_151 "DUCO Serial Gateway"
#define PLUGIN_VALUENAME1_151 "DUCO_STATUS" // networkcommand
#define PLUGIN_VALUENAME2_151 "FLOW_PERCENTAGE" // networkcommand
#define PLUGIN_READ_TIMEOUT_151 3000
#define PLUGIN_LOG_PREFIX_151 String("[P151] DUCO SER GW: ")
#define DUCOBOX_NODE_NUMBER 1
#define PLUGIN_151_HARDWARE_83_AND_LOWER_SERIALSWITCH_PIN 2
#define PLUGIN_151_PCF_ADDRESS 0x38 // 7-bit address!
boolean Plugin_151_init = false;
boolean ventilation_gateway_disable_serial = false;
boolean ventilation_gateway_serial_status_led = false; // false = off, true=on; need this to prevent continues turning gpio off (or sending command to PCF) in PLUGIN_TEN_PER_SECOND
// 0 -> "auto" = AutomaticMode;
// 1 -> "man1" = ManualMode1;
// 2 -> "man2" = ManualMode2;
// 3 -> "man3" = ManualMode3;
// 4 -> "empt" = EmptyHouse;
// 5 -> "alrm" = AlarmMode;
// 11 -> "cnt1" = PermanentManualMode1;
// 12 -> "cnt2" = PermanentManualMode2;
// 13 -> "cnt3"= PermanentManualMode3;
// 20 -> "aut0" = AutomaticMode;
// 21 -> "aut1" = Boost10min;
// 22 -> "aut2" = Boost20min;
// 23 -> "aut3" = Boost30min;
#define DUCO_STATUS_MODUS_COUNT 13
const char DucoStatusModes[DUCO_STATUS_MODUS_COUNT][5] =
{"AUTO", "MAN1", "MAN2", "MAN3", "EMPT", "ALRM", "CNT1", "CNT2", "CNT3", "AUT0", "AUT1", "AUT2", "AUT3"};
const int DucoStatusModesNumbers[DUCO_STATUS_MODUS_COUNT] =
{0, 1, 2, 3, 4, 5, 11, 12, 13, 20, 21, 22, 23};
typedef enum {
P151_CONFIG_VALUE_TYPE = 0,
P151_CONFIG_LOG_SERIAL = 1,
P151_CONFIG_USE_FOR_NETWORK_TOOL = 2,
P151_CONFIG_HARDWARE_TYPE = 3,
} P151PluginConfigs; // max 8 values
typedef enum {
P151_VALUE_VENTMODE = 0,
P151_VALUE_VENT_PERCENTAGE = 1,
P151_VALUE_CURRENT_FAN = 2,
P151_VALUE_COUNTDOWN = 3,
P151_VALUE_NONE = 4,
} P151Values;
typedef enum {
P151_HARDWARE_DIY = 0,
P151_HARDWARE_83_AND_LOWER = 1,
P151_HARDWARE_84_AND_HIGHER = 2,
} P151HardwareTypes;
//global variables
int P151_DATA_VALUE[4]; // store here data of P151_VALUE_VENTMODE, P151_VALUE_VENT_PERCENTAGE, P151_VALUE_CURRENT_FAN and P151_VALUE_COUNTDOWN
bool P151_mainPluginActivatedInTask = false;
bool P151_disableCoreLogLevel = true; // if this variable is true de plugin is trying to 'disable' coreloglevel to prevent debug output from the Ducobox on the serial line (sometimes Duco network tool doesnt disable this).
// when calling 'PLUGIN_READ', if serial port is in use set this flag and check in PLUGIN_ONCE_A_SECOND if serial port is free.
bool P151_waitingForSerialPort = false;
#define P151_NR_OUTPUT_VALUES 4 // how many values do we need to read from networklist.
uint8_t varColumnNumbers[P151_NR_OUTPUT_VALUES]; // stores the columnNumbers
uint8_t P151_PCF_pin_state = 0b11110111; // pin P0 needs to be high (input)
#define P151_VALUENAME_NR_OUTPUT_OPTIONS 5
String Plugin_151_valuename(byte value_nr, bool displayString) {
switch (value_nr) {
case P151_VALUE_VENTMODE: return displayString ? F("Ventilationmode") : F("stat");
case P151_VALUE_VENT_PERCENTAGE: return displayString ? F("Ventilation_Percentage") : F("%dbt");
case P151_VALUE_CURRENT_FAN: return displayString ? F("Current_Fan_Value") : F("cval");
case P151_VALUE_COUNTDOWN: return displayString ? F("Countdown") : F("cntdwn");
case P151_VALUE_NONE: return displayString ? F("None") : F("");
default:
break;
}
return "";
}
#define P151_HARDWARE_NR_OUTPUT_OPTIONS 3
String Plugin_151_hardware_type(byte value_nr) {
switch (value_nr) {
case P151_HARDWARE_DIY: return F("DIY esp8266 hardware");
case P151_HARDWARE_83_AND_LOWER: return F("Ventilation gateway V8.3 and lower");
case P151_HARDWARE_84_AND_HIGHER: return F("Ventilation gateway V8.4 and higher");
default:
break;
}
return "";
}
boolean Plugin_151(byte function, struct EventStruct *event, String &string){
boolean success = false;
switch (function){
case PLUGIN_DEVICE_ADD:{
Device[++deviceCount].Number = PLUGIN_ID_151;
Device[deviceCount].Type = DEVICE_TYPE_SINGLE;
Device[deviceCount].VType = Sensor_VType::SENSOR_TYPE_SINGLE;
Device[deviceCount].Ports = 0;
Device[deviceCount].PullUpOption = false;
Device[deviceCount].InverseLogicOption = false;
Device[deviceCount].FormulaOption = false;
Device[deviceCount].DecimalsOnly = true;
Device[deviceCount].ValueCount = 1;
Device[deviceCount].SendDataOption = true;
Device[deviceCount].TimerOption = true;
Device[deviceCount].GlobalSyncOption = true;
break;
}
case PLUGIN_GET_DEVICENAME: {
string = F(PLUGIN_NAME_151);
break;
}
case PLUGIN_GET_DEVICEVALUENAMES: {
safe_strncpy(ExtraTaskSettings.TaskDeviceValueNames[0], Plugin_151_valuename(PCONFIG(P151_CONFIG_VALUE_TYPE), true), sizeof(ExtraTaskSettings.TaskDeviceValueNames[0]));
break;
}
case PLUGIN_GET_DEVICEGPIONAMES:{
event->String1 = formatGpioName_output(F("Status LED"));
event->String2 = formatGpioName_output(F("Use as Network Tool"));
break;
}
case PLUGIN_EXIT: {
if(PCONFIG(P151_CONFIG_VALUE_TYPE) == P151_VALUE_VENTMODE){
P151_mainPluginActivatedInTask = false;
if(serialPortInUseByTask == event->TaskIndex){
serialPortInUseByTask = 255;
}
if(PCONFIG(P151_CONFIG_HARDWARE_TYPE) == P151_HARDWARE_84_AND_HIGHER){
P151_PCF_set_pin_output(0, HIGH); // PCF8574; P0 serial_switch_button = HIGH (input);
P151_PCF_set_pin_output(1, HIGH); // PCF8574; P1 SER_SWITCH_CONNECT_DUCO = HIGH (disconnect uart ducobox)
P151_PCF_set_pin_output(2, HIGH); // PCF8574; P2 SER_SWITCH_SWAP_UART = HIGH (uart NOT swapped)
P151_PCF_set_pin_output(4, HIGH); // PCF8574; P4 LED_SERIAL_SWITCH_GREEN = HIGH (led off)
P151_PCF_set_pin_output(5, HIGH); // PCF8574; P5 LED_GREEN = HIGH (Led off)
//P151_PCF_set_pin_output(6, HIGH); // PCF8574; P6 LED_YELLOW = HIGH (Led off)
//P151_PCF_set_pin_output(7, HIGH); // PCF8574; P7 LED_BLUE = HIGH (Led off)
}
}
clearPluginTaskData(event->TaskIndex); // clear plugin taskdata
addLogMove(LOG_LEVEL_INFO, PLUGIN_LOG_PREFIX_151 + F("EXIT PLUGIN_151"));
success = true;
break;
}
case PLUGIN_WEBFORM_LOAD: {
addRowLabel(F("Output Value Type"));
addSelector_Head(PCONFIG_LABEL(P151_CONFIG_VALUE_TYPE));
for (byte x = 0; x < P151_VALUENAME_NR_OUTPUT_OPTIONS; x++){
String name = Plugin_151_valuename(x, true);
bool disabled = false;
if(x == 0){
name = F("Ventilationmode (main plugin)");
if(P151_mainPluginActivatedInTask && (PCONFIG(P151_CONFIG_VALUE_TYPE) != P151_VALUE_VENTMODE) ){
disabled = true;
}
}else{
if(P151_mainPluginActivatedInTask == false || (PCONFIG(P151_CONFIG_VALUE_TYPE) == P151_VALUE_VENTMODE) ){
disabled = true;
}
}
addSelector_Item(name, x, PCONFIG(P151_CONFIG_VALUE_TYPE) == x, disabled, "");
}
addSelector_Foot();
if(PCONFIG(P151_CONFIG_VALUE_TYPE) == P151_VALUE_VENTMODE){
addRowLabel(F("Hardware type"));
addSelector_Head_reloadOnChange(PCONFIG_LABEL(P151_CONFIG_HARDWARE_TYPE), F("wide"), false);
for (byte x = 0; x < P151_HARDWARE_NR_OUTPUT_OPTIONS; x++){
addSelector_Item(Plugin_151_hardware_type(x), x, PCONFIG(P151_CONFIG_HARDWARE_TYPE) == x, false, "");
}
addSelector_Foot();
addFormCheckBox(F("Log serial messages to syslog"), F("Plugin151_log_serial"), PCONFIG(P151_CONFIG_LOG_SERIAL));
// if hardware is ventilation gateway show option to use as usb-cable
if(PCONFIG(P151_CONFIG_HARDWARE_TYPE) != P151_HARDWARE_DIY){
addFormCheckBox(F("Disable gateway serial to use gateway as usb-cable for network tool"), F("Plugin151_use_for_network_tool"), PCONFIG(P151_CONFIG_USE_FOR_NETWORK_TOOL));
}
}
success = true;
break;
}
case PLUGIN_SET_DEFAULTS:{
PCONFIG(P151_CONFIG_VALUE_TYPE) = P151_VALUE_NONE;
success = true;
break;
}
case PLUGIN_WEBFORM_SAVE:{
int newValueType = getFormItemInt(PCONFIG_LABEL(P151_CONFIG_VALUE_TYPE), 0);
// if value_type has changed, empty value name so default value name will be used for TaskDeviceValueNames[0]
if (newValueType != PCONFIG(P151_CONFIG_VALUE_TYPE)) {
ZERO_FILL(ExtraTaskSettings.TaskDeviceValueNames[0]);
}
PCONFIG(P151_CONFIG_VALUE_TYPE) = newValueType;
if(PCONFIG(P151_CONFIG_VALUE_TYPE) == P151_VALUE_VENTMODE){
P151_mainPluginActivatedInTask = true;
PCONFIG(P151_CONFIG_HARDWARE_TYPE) = getFormItemInt(PCONFIG_LABEL(P151_CONFIG_HARDWARE_TYPE), 0);
PCONFIG(P151_CONFIG_LOG_SERIAL) = isFormItemChecked(F("Plugin151_log_serial"));
// if hardware is ventilation gateway show option to use as usb-cable
if(PCONFIG(P151_CONFIG_HARDWARE_TYPE) != P151_HARDWARE_DIY){
PCONFIG(P151_CONFIG_USE_FOR_NETWORK_TOOL) = isFormItemChecked(F("Plugin151_use_for_network_tool"));
}else{
PCONFIG(P151_CONFIG_USE_FOR_NETWORK_TOOL) = false; // if hardware is diy, set false.
}
if(PCONFIG(P151_CONFIG_HARDWARE_TYPE) == P151_HARDWARE_84_AND_HIGHER){
Settings.TaskDevicePin1[event->TaskIndex] = -1;
}
}
success = true;
break;
}
case PLUGIN_INIT: {
// load tasksettings, if we dont call this function, PCONFIG (Settings.TaskDevicePluginConfig) will be 0.
//LoadTaskSettings(event->TaskIndex);
// only initiate serial if we are the task with main plugin activated.
if(PCONFIG(P151_CONFIG_VALUE_TYPE) == P151_VALUE_VENTMODE){
P151_mainPluginActivatedInTask = true;
// set status led
if (CONFIG_PIN1 != -1 && PCONFIG(P151_CONFIG_HARDWARE_TYPE) != P151_HARDWARE_84_AND_HIGHER){
pinMode(CONFIG_PIN1, OUTPUT);
digitalWrite(CONFIG_PIN1, HIGH);
}
// set a flag voor plugins P150, P151, P152, P153, P154, P155, P156 to stop using serial
ventilation_gateway_disable_serial = PCONFIG(P151_CONFIG_USE_FOR_NETWORK_TOOL);
// if hardwaretype is ventilation gateway show option to use as usb-cable
if(PCONFIG(P151_CONFIG_HARDWARE_TYPE) == P151_HARDWARE_83_AND_LOWER){
// set pin to control TS3A5017DRD16-M high
pinMode(PLUGIN_151_HARDWARE_83_AND_LOWER_SERIALSWITCH_PIN, OUTPUT); // gpio2 = D4
if(PCONFIG(P151_CONFIG_USE_FOR_NETWORK_TOOL)) {
Serial.end(); // stop serial
//put pins in input mode (High impedance) to prevent interference
pinMode(1, INPUT); // TX
pinMode(3, INPUT); // RX0
digitalWrite(PLUGIN_151_HARDWARE_83_AND_LOWER_SERIALSWITCH_PIN, LOW); // TS3A5017DRD16-M > LOW = TX/RX of PC usb-serial connected to ducobox
}else{
digitalWrite(PLUGIN_151_HARDWARE_83_AND_LOWER_SERIALSWITCH_PIN, HIGH); // TS3A5017DRD16-M > high = PC usb-serial connected to gateway
// reset pinmode of RX and TX to default
pinMode(1, FUNCTION_0); // TX
pinMode(3, FUNCTION_0); // RX0
Serial.begin(115200, SERIAL_8N1);
}
}else if(PCONFIG(P151_CONFIG_HARDWARE_TYPE) == P151_HARDWARE_84_AND_HIGHER){
String log = PLUGIN_LOG_PREFIX_151;
log += F("P151_HARDWARE_84_AND_HIGHER");
addLogMove(LOG_LEVEL_DEBUG, log);
Wire.begin();
// >>>>> SET PCF8574 SET pin P1 HIGH = all switches are high impedance
// PCF8574 SET P1 LOW
//P151_PCF_pin_state = 0xF7; // 0xF7 = 0b1111.0111; P0 serial_switch_button = HIGH (input); P1 SER_SWITCH_CONNECT_DUCO = HIGH (default duco uart not connected); P2 SER_SWITCH_SWAP_UART = HIGH (uart NOT swapped)
P151_PCF_set_pin_output(0, HIGH); // PCF8574; P0 serial_switch_button = HIGH (input);
P151_PCF_set_pin_output(1, HIGH); // PCF8574; P1 SER_SWITCH_CONNECT_DUCO = HIGH (disconnect uart ducobox)
P151_PCF_set_pin_output(2, HIGH); // PCF8574; P2 SER_SWITCH_SWAP_UART = HIGH (uart NOT swapped)
P151_PCF_set_pin_output(4, HIGH); // PCF8574; P4 LED_SERIAL_SWITCH_GREEN = HIGH (led off)
P151_PCF_set_pin_output(5, HIGH); // PCF8574; P5 LED_GREEN = HIGH (Led off)
// if checkbox "use for network tool" is checked, Serial tx/rx of ducobox is swapped with tx/rx of usb converter
// We need to disable the RX/TX pin to prevent interference between the cp2104 and ducobox.
if(PCONFIG(P151_CONFIG_USE_FOR_NETWORK_TOOL)) {
addLogMove(LOG_LEVEL_DEBUG, PLUGIN_LOG_PREFIX_151 + F("networktool active"));
Serial.end(); // stop serial
//put pins in input mode (High impedance) to prevent interference
pinMode(1, INPUT); // TX
pinMode(3, INPUT); // RX0
P151_PCF_set_pin_output(1, LOW); // PCF8574 SET P1 SER_SWITCH_CONNECT_DUCO = LOW (connect uart ducobox)
P151_PCF_set_pin_output(2, LOW); // PCF8574 SET P2 SER_SWITCH_SWAP_UART LOW (uart swapped)
P151_PCF_set_pin_output(4, LOW); // PCF8574 SET P4 LED_SERIAL_SWITCH_GREEN = DOWN (led on)
}else{
// >>>>> SET PCF8574 SET pin P2 HIGH = normal LOW = swap TX/RX
// PCF8574 SET P2 LOW
P151_PCF_set_pin_output(1, LOW); // PCF8574 SET P1 SER_SWITCH_CONNECT_DUCO = LOW (connect uart ducobox)
P151_PCF_set_pin_output(2, HIGH); // PCF8574 SET P2 SER_SWITCH_SWAP_UART HIGH (uart NOT swapped)
// reset pinmode of RX and TX to default
pinMode(1, FUNCTION_0); // TX
pinMode(3, FUNCTION_0); // RX0
Serial.begin(115200, SERIAL_8N1);
}
}else if(PCONFIG(P151_CONFIG_HARDWARE_TYPE) == P151_HARDWARE_DIY){
// reset pinmode of RX and TX to default
pinMode(1, FUNCTION_0); // TX
pinMode(3, FUNCTION_0); // RX0
Serial.begin(115200, SERIAL_8N1);
}
Plugin_151_init = true;
// disable coreloglevel on ducobox
P151_disableCoreLogLevel = true;
}
success = true;
break;
}
case PLUGIN_I2C_HAS_ADDRESS:{
if(PCONFIG(P151_CONFIG_HARDWARE_TYPE) == P151_HARDWARE_84_AND_HIGHER){
success = true;
}
break;
}
case PLUGIN_ONCE_A_SECOND:{
String log;
if (Plugin_151_init && PCONFIG(P151_CONFIG_VALUE_TYPE) == P151_VALUE_VENTMODE ){
if(P151_waitingForSerialPort){
if(serialPortInUseByTask == 255){
Plugin_151(PLUGIN_READ, event, string);
P151_waitingForSerialPort = false;
}
}
if(serialPortInUseByTask == event->TaskIndex){
if( (millis() - ducoSerialStartReading) > PLUGIN_READ_TIMEOUT_151){
log = PLUGIN_LOG_PREFIX_151;
log += F("Serial reading timeout");
addLogMove(LOG_LEVEL_DEBUG, log);
DucoTaskStopSerial(PLUGIN_LOG_PREFIX_151);
serialPortInUseByTask = 255;
}
}
}
if(UserVar[event->BaseVarIndex] != P151_DATA_VALUE[PCONFIG(P151_CONFIG_VALUE_TYPE)] ){
UserVar[event->BaseVarIndex] = P151_DATA_VALUE[PCONFIG(P151_CONFIG_VALUE_TYPE)];
sendData(event); // force to send data to controller
log = PLUGIN_LOG_PREFIX_151;
log += F("New value for ");
log += Plugin_151_valuename( PCONFIG(P151_CONFIG_VALUE_TYPE), true);
addLogMove(LOG_LEVEL_DEBUG, log);
}
success = true;
break;
}
case PLUGIN_SERIAL_IN: {
// if we unexpectedly receive data we need to flush and return success=true so espeasy won't interpret it as an serial command.
// also ignore data if serial is disabled
if(serialPortInUseByTask == 255 || ventilation_gateway_disable_serial){
DucoSerialFlush();
success = true;
}
if(serialPortInUseByTask == event->TaskIndex){
uint8_t result = 0;
bool stop = false;
while(result != DUCO_MESSAGE_FIFO_EMPTY && stop == false){
result = DucoSerialInterrupt();
switch(result){
case DUCO_MESSAGE_ROW_END: {
if(P151_disableCoreLogLevel){
Plugin_151_disableCoreLogLevel_processRow(event, PCONFIG(P151_CONFIG_LOG_SERIAL));
}else{
Plugin_151_processRow(event, PCONFIG(P151_CONFIG_LOG_SERIAL));
}
duco_serial_bytes_read = 0; // reset bytes read counter
break;
}
case DUCO_MESSAGE_END: {
DucoThrowErrorMessage(PLUGIN_LOG_PREFIX_151, result);
DucoTaskStopSerial(PLUGIN_LOG_PREFIX_151);
stop = true;
break;
}
}
}
success = true;
}
break;
}
case PLUGIN_READ:{
if(Plugin_151_init && PCONFIG(P151_CONFIG_VALUE_TYPE) == P151_VALUE_VENTMODE && ventilation_gateway_disable_serial == false){
// check if serial port is in use by another task, otherwise set flag.
if(serialPortInUseByTask == 255){
serialPortInUseByTask = event->TaskIndex;
if(P151_disableCoreLogLevel){
Plugin_151_disableCoreLogLevel();
}else{
if (PCONFIG(P151_CONFIG_HARDWARE_TYPE) == P151_HARDWARE_84_AND_HIGHER){ // status led
P151_PCF_set_pin_output(5, LOW); // PCF8574 SET P5 LED_GREEN = LOW (led on)
ventilation_gateway_serial_status_led = true;
}else if (CONFIG_PIN1 != -1 ){
digitalWrite(CONFIG_PIN1, LOW);
ventilation_gateway_serial_status_led = true;
}
Plugin_151_startReadNetworkList();
}
}else{
String log;
log = PLUGIN_LOG_PREFIX_151;
log += F("Serial port in use, set flag to read data later.");
addLogMove(LOG_LEVEL_DEBUG, log);
P151_waitingForSerialPort = true;
}
}
success = true;
break;
}
case PLUGIN_TEN_PER_SECOND: {
if(Plugin_151_init && ventilation_gateway_serial_status_led ){
if (PCONFIG(P151_CONFIG_HARDWARE_TYPE) == P151_HARDWARE_84_AND_HIGHER){ // status led off
P151_PCF_set_pin_output(5, HIGH); // PCF8574 SET P5 LED_GREEN = HIGH (led off)
}else if (CONFIG_PIN1 != -1 ){
digitalWrite(CONFIG_PIN1, HIGH);
}
ventilation_gateway_serial_status_led = false;
}
success = true;
break;
}
case PLUGIN_FIFTY_PER_SECOND: {
if(Plugin_151_init){
if(serialPortInUseByTask == event->TaskIndex){
if(serialSendCommandInProgress){
DucoSerialSendCommand(PLUGIN_LOG_PREFIX_151);
}
}
}
success = true;
break;
}
} // switch() end
return success;
}
/* Example output:
coreloglevel 0x10
Done
*/
void Plugin_151_disableCoreLogLevel(){
String log;
log = PLUGIN_LOG_PREFIX_151;
log += F("Start disableCoreLogLevel");
addLogMove(LOG_LEVEL_DEBUG, log);
P151_disableCoreLogLevel = true;
// set this variables before sending command
ducoSerialStartReading = millis();
duco_serial_bytes_read = 0; // reset bytes read counter
duco_serial_rowCounter = 0; // reset row counter
// SEND COMMAND
DucoSerialStartSendCommand("coreloglevel 0x10\r\n");
}
void Plugin_151_disableCoreLogLevel_processRow(struct EventStruct *event, bool serialLoggingEnabled ){
if ( PCONFIG(P151_CONFIG_LOG_SERIAL)){
if(duco_serial_rowCounter <4 ){
String prefix;
prefix += PLUGIN_LOG_PREFIX_151;
prefix += F("ROW: ");
prefix += duco_serial_rowCounter;
prefix += F(" bytes read:");
prefix += duco_serial_bytes_read;
DucoSerialLogArray(prefix, duco_serial_buf, duco_serial_bytes_read, 0);
}
}
String log;
if(duco_serial_rowCounter == 1){
if (DucoSerialCheckCommandInResponse(PLUGIN_LOG_PREFIX_151, "coreloglevel 0x10") ) {
log = PLUGIN_LOG_PREFIX_151;
log += F("Received correct response on coreloglevel 0x10");
addLogMove(LOG_LEVEL_DEBUG, log);
} else {
log = PLUGIN_LOG_PREFIX_151;
log += F("Received invalid response on coreloglevel 0x10");
addLogMove(LOG_LEVEL_DEBUG, log);
DucoTaskStopSerial(PLUGIN_LOG_PREFIX_151);
P151_disableCoreLogLevel = false;
return;
}
}else if( duco_serial_rowCounter == 2){
if(DucoSerialCheckCommandInResponse(PLUGIN_LOG_PREFIX_151, " Done")){ // re-use this function to find "Done" in the response;
log = PLUGIN_LOG_PREFIX_151;
log += F("coreloglevel 0x10 is set on Ducobox");
addLogMove(LOG_LEVEL_DEBUG, log);
} else {
log = PLUGIN_LOG_PREFIX_151;
log += F("Ducobox did not confirm coreloglevel change.");
addLogMove(LOG_LEVEL_DEBUG, log);
}
DucoTaskStopSerial(PLUGIN_LOG_PREFIX_151);
P151_disableCoreLogLevel = false;
return;
}
}
void Plugin_151_startReadNetworkList(){
String log;
log = PLUGIN_LOG_PREFIX_151;
log += F("Start readNetworkList");
addLogMove(LOG_LEVEL_DEBUG, log);
// set this variables before sending command
ducoSerialStartReading = millis();
duco_serial_bytes_read = 0; // reset bytes read counter
duco_serial_rowCounter = 0; // reset row counter
// SEND COMMAND
DucoSerialStartSendCommand("Network\r\n");
}
void Plugin_151_processRow(struct EventStruct *event, bool serialLoggingEnabled ){
if ( PCONFIG(P151_CONFIG_LOG_SERIAL)){
if(duco_serial_rowCounter <3 ){
String prefix;
prefix += PLUGIN_LOG_PREFIX_151;
prefix += F("ROW: ");
prefix += duco_serial_rowCounter;
prefix += F(" bytes read:");
prefix += duco_serial_bytes_read;
DucoSerialLogArray( prefix, duco_serial_buf, duco_serial_bytes_read, 0);
}
}
String log;
if(duco_serial_rowCounter == 1){
if (DucoSerialCheckCommandInResponse(PLUGIN_LOG_PREFIX_151, "network") ) { // gw send command "Network" with capital N, older ducoboxes returns "network" without capital N
log = PLUGIN_LOG_PREFIX_151;
log += F("Received correct response on network");
addLogMove(LOG_LEVEL_DEBUG, log);
} else if (DucoSerialCheckCommandInResponse(PLUGIN_LOG_PREFIX_151, "Network") ) { // for newer ducobox e.g. Ducobox Energy comfort 325R
log = PLUGIN_LOG_PREFIX_151;
log += F("Received correct response on network");
addLogMove(LOG_LEVEL_DEBUG, log);
} else {
log = PLUGIN_LOG_PREFIX_151;
log += F("Received invalid response on network");
addLogMove(LOG_LEVEL_DEBUG, log);
DucoTaskStopSerial(PLUGIN_LOG_PREFIX_151);
return;
}
}else if( duco_serial_rowCounter == 4){
// ROW 4: columnnames => get columnnumbers by columnname
Plugin_151_getColumnNumbersByColumnName(event, varColumnNumbers);
}else if( duco_serial_rowCounter > 4){
duco_serial_buf[duco_serial_bytes_read] = '\0'; // null terminate string
int splitCounter = 0;
char *buf = (char *)duco_serial_buf;
char *token = strtok(buf, "|");
if (token != NULL){
long nodeAddress = strtol(token, NULL, 0);
if (nodeAddress == DUCOBOX_NODE_NUMBER) {
log = PLUGIN_LOG_PREFIX_151;
log += F("Ducobox row found!");
addLogMove(LOG_LEVEL_DEBUG, log);
while (token != NULL) {
// check if there is a match for varColumnNumbers
for (int i = 0; i < P151_NR_OUTPUT_VALUES; i++){
if (splitCounter == varColumnNumbers[i]) {
int newValue = -1;
if(i == P151_VALUE_VENTMODE){ // ventilationmode / "stat"
newValue = Plugin_151_parseVentilationStatus(token);
}else if(i < P151_NR_OUTPUT_VALUES){ // parse numeric value:"cntdwn", "%dbt", "trgt", "cval", "snsr", "ovrl"
newValue = Plugin_151_parseNumericValue(token);
}
if(newValue != -1){
P151_DATA_VALUE[i] = newValue;
char logBuf[20];
snprintf(logBuf, sizeof(logBuf), " value: %d", newValue);
log = PLUGIN_LOG_PREFIX_151;
log += F("New ");
log += Plugin_151_valuename(i,true);
log += logBuf;
addLogMove(LOG_LEVEL_DEBUG, log);
}
}
} // for end
splitCounter++;
token = strtok(NULL, "|");
} //while (token != NULL)
}
}
}
return;
} // end of Plugin_151_processRow()
void Plugin_151_getColumnNumbersByColumnName(struct EventStruct *event, uint8_t varColumnNumbers[]) {
for (int i = 0; i < P151_NR_OUTPUT_VALUES; i++) {
varColumnNumbers[i] = 255; // set a default value in case we cant find a column
}
duco_serial_buf[duco_serial_bytes_read] = '\0';
int splitCounter = 0;
char *buf = (char *)duco_serial_buf;
char *token = strtok(buf, "|");
while (token != NULL) {
// check if there is a match with
for (int i = 0; i < P151_NR_OUTPUT_VALUES; i++) {
if (strstr(token, Plugin_151_valuename(i, false).c_str() ) != NULL){ // if not null, save position
varColumnNumbers[i] = splitCounter;
}
} // for
splitCounter++;
token = strtok(NULL, "|");
} //while (token != NULL) {
return;
}
int Plugin_151_parseVentilationStatus(char *token){
for (int i = 0; i < DUCO_STATUS_MODUS_COUNT; i++) {
// strstr is case sensitive!
if (strstr(token, DucoStatusModes[i]) != NULL) { // if not null, status found :)
return DucoStatusModesNumbers[i];
}
}
// if value not found return -1
String log;
log = PLUGIN_LOG_PREFIX_151;
log += F("Status value not found.");
addLogMove(LOG_LEVEL_DEBUG, log);
return -1;
}
int Plugin_151_parseNumericValue(char *token) {
int raw_value;
if (sscanf(token, "%d", &raw_value) == 1){
return raw_value; /* No conversion required */
}else{
String log;
log = PLUGIN_LOG_PREFIX_151;
log += F("Numeric value not found.");
addLogMove(LOG_LEVEL_DEBUG, log);
return -1;
}
}
// port P0 - P7
void P151_PCF_set_pin_output(uint8_t port, bool state){
if(state){ // set bit high
P151_PCF_pin_state = (P151_PCF_pin_state | (1 << port));
}else{
P151_PCF_pin_state = (P151_PCF_pin_state & (~(1 << port))); // set bit low
}
// send outputs to PCF
Plugin_151_PCF8574_setReg(PLUGIN_151_PCF_ADDRESS, P151_PCF_pin_state);
}
void Plugin_151_PCF8574_setReg(uint8_t addr, uint8_t data){
// char logBuf[30];
// snprintf(logBuf, sizeof(logBuf), "addr %#x value %#x", addr, data);
// addLogMove(LOG_LEVEL_DEBUG, PLUGIN_LOG_PREFIX_151 + "PCF DATA " + logBuf);
Wire.beginTransmission(addr);
Wire.write(data);
Wire.endTransmission();
}
uint8_t Plugin_151_PCF8574_getReg(uint8_t addr){
Wire.requestFrom(addr, (uint8_t)0x1);
if (Wire.available()){
return Wire.read();
}
return 0xFF;
}