forked from networkupstools/nut
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapc_modbus.c
1361 lines (1134 loc) · 37.8 KB
/
apc_modbus.c
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
/* apc_modbus.c - Driver for APC Modbus UPS
* Copyright © 2023 Axel Gembe <axel@gembe.net>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#include "main.h"
#if defined NUT_MODBUS_HAS_USB
#include "nut_libusb.h"
#include "libhid.h"
#include "hidparser.h"
#endif /* defined NUT_MODBUS_HAS_USB */
#include "timehead.h"
#include "nut_stdint.h"
#include <ctype.h>
#include <stdio.h>
#include <modbus.h>
#define DRIVER_NAME "NUT APC Modbus driver"
#define DRIVER_VERSION "0.01"
#if defined NUT_MODBUS_HAS_USB
/* APC */
#define APC_VENDORID 0x051D
/* USB IDs device table */
static usb_device_id_t apc_modbus_usb_device_table[] = {
{ USB_DEVICE(APC_VENDORID, 0x0003), NULL },
/* Terminating entry */
{ 0, 0, NULL }
};
#endif /* defined NUT_MODBUS_HAS_USB */
/* Constants */
static const uint8_t modbus_default_slave_id = 1;
static const int modbus_rtu_default_baudrate = 9600;
static const char modbus_rtu_default_parity = 'N';
static const int modbus_rtu_default_databits = 8;
static const int modbus_rtu_default_stopbits = 1;
static const uint16_t modbus_tcp_default_port = 502;
#if defined NUT_MODBUS_HAS_USB
static const HIDNode_t modbus_rtu_usb_usage_rx = 0xff8600fc;
static const HIDNode_t modbus_rtu_usb_usage_tx = 0xff8600fd;
#endif /* defined NUT_MODBUS_HAS_USB */
/* Variables */
static modbus_t *modbus_ctx = NULL;
#if defined NUT_MODBUS_HAS_USB
static USBDevice_t usbdevice;
static USBDeviceMatcher_t *reopen_matcher = NULL;
static USBDeviceMatcher_t *regex_matcher = NULL;
static USBDeviceMatcher_t *best_matcher = NULL;
static int is_usb = 0;
#endif /* defined NUT_MODBUS_HAS_USB */
static int is_open = 0;
static double power_nominal;
static double realpower_nominal;
/* Function declarations */
static int _apc_modbus_read_inventory(void);
/* driver description structure */
upsdrv_info_t upsdrv_info = {
DRIVER_NAME,
DRIVER_VERSION,
"Axel Gembe <axel@gembe.net>\n",
DRV_BETA,
{NULL}
};
typedef enum {
APC_MODBUS_VALUE_TYPE_INT = 0,
APC_MODBUS_VALUE_TYPE_UINT,
APC_MODBUS_VALUE_TYPE_STRING
} apc_modbus_value_types;
static const apc_modbus_value_types apc_modbus_value_types_max = APC_MODBUS_VALUE_TYPE_STRING;
typedef struct {
apc_modbus_value_types type;
const char *format;
int scale;
void *variable_ptr;
union {
int64_t int_value;
uint64_t uint_value;
char *string_value;
} data;
} apc_modbus_value_t;
typedef struct {
int (*apc_to_nut)(const apc_modbus_value_t *value, char *output, size_t output_len);
int (*nut_to_apc)(const char *value, uint16_t *output, size_t output_len);
} apc_modbus_converter_t;
/* Converts a Modbus string to a C string.
* See MPAO-98KJ7F_EN section 1.3.3 Strings.
*
* Needs to remove leading zeroes, trailing spaces and translate characters in
* the range 0x20-0x7e as a different character.
* Zero termination is optional, so the output buffer needs to be 1 byte
* longer to add zero termination. */
static int _apc_modbus_to_string(const uint16_t *value, const size_t value_len, char *output, size_t output_len)
{
char *op;
size_t i;
if (value == NULL || output == NULL) {
/* Invalid parameters */
return 0;
}
if ((value_len * sizeof(uint16_t)) + 1 > output_len) {
/* Output buffer too small */
return 0;
}
op = output;
/* Find first non-zero register */
for (i = 0; i < value_len; i++) {
if (value[i] != 0)
break;
}
if (i < value_len) {
/* The second character could be zero, skip if it is */
if (((value[i] & 0xff00) >> 8) == 0) {
*(op++) = (char)(value[i] & 0xff);
i++;
}
/* For each remaining register, take MSB then LSB into string */
for (; i < value_len; i++) {
*(op++) = (char)((value[i] & 0xff00) >> 8);
*(op++) = (char)(value[i] & 0xff);
}
}
/* Add zero termination */
*op = 0;
assert(op < output + output_len);
/* Find last non-zero/space */
for (op--; op > output && (*op == 0 || *op == ' '); op--);
/* Cut off rest of string */
*(op + 1) = 0;
/* Translate charaters outside of 0x20-0x7e range to spaces */
for (; op > output; op--) {
if (*op < 0x20 || *op > 0x7e) {
*op = ' ';
}
}
return 1;
}
/* Converts a Modbus integer to a uint64_t.
* See MPAO-98KJ7F_EN section 1.3.1 Numbers. */
static int _apc_modbus_to_uint64(const uint16_t *value, const size_t value_len, uint64_t *output)
{
size_t i;
if (value == NULL || output == NULL) {
/* Invalid parameters */
return 0;
}
*output = 0;
for (i = 0; i < value_len; i++) {
*output = (*output << 16) | value[i];
}
return 1;
}
static int _apc_modbus_to_int64(const uint16_t *value, const size_t value_len, int64_t *output)
{
size_t shiftval;
if (!_apc_modbus_to_uint64(value, value_len, (uint64_t*)output)) {
return 0;
}
shiftval = (8 * (sizeof(int64_t) - (value_len * sizeof(uint16_t))));
*output <<= shiftval;
*output >>= shiftval;
return 1;
}
static int _apc_modbus_to_double(const apc_modbus_value_t *value, double *output)
{
int factor;
if (value == NULL || output == NULL) {
/* Invalid parameters */
return 0;
}
factor = 1 << value->scale;
assert(value->type <= apc_modbus_value_types_max);
switch (value->type) {
case APC_MODBUS_VALUE_TYPE_INT:
*output = (double)value->data.int_value / factor;
break;
case APC_MODBUS_VALUE_TYPE_UINT:
*output = (double)value->data.uint_value / factor;
break;
case APC_MODBUS_VALUE_TYPE_STRING:
return 0;
}
return 1;
}
static int _apc_modbus_double_to_nut(const apc_modbus_value_t *value, char *output, size_t output_len)
{
double double_value;
const char *format;
int res;
if (output == NULL || output_len == 0) {
/* Invalid parameters */
return 0;
}
if (!_apc_modbus_to_double(value, &double_value)) {
return 0;
}
if (value->variable_ptr) {
*((double*)value->variable_ptr) = double_value;
}
format = "%f";
if (value->format != NULL)
format = value->format;
#ifdef HAVE_PRAGMAS_FOR_GCC_DIAGNOSTIC_IGNORED_FORMAT_NONLITERAL
#pragma GCC diagnostic push
#endif
#ifdef HAVE_PRAGMA_GCC_DIAGNOSTIC_IGNORED_FORMAT_NONLITERAL
#pragma GCC diagnostic ignored "-Wformat-nonliteral"
#endif
res = snprintf(output, output_len, format, double_value);
#ifdef HAVE_PRAGMAS_FOR_GCC_DIAGNOSTIC_IGNORED_FORMAT_NONLITERAL
#pragma GCC diagnostic pop
#endif
if (res < 0 || (size_t)res >= output_len) {
return 0;
}
return 1;
}
static apc_modbus_converter_t _apc_modbus_double_conversion = { _apc_modbus_double_to_nut, NULL };
static int _apc_modbus_power_to_nut(const apc_modbus_value_t *value, char *output, size_t output_len)
{
double double_value;
const char *format;
int res;
if (output == NULL || output_len == 0) {
/* Invalid parameters */
return 0;
}
if (!_apc_modbus_to_double(value, &double_value)) {
return 0;
}
if (value->variable_ptr) {
/* variable_ptr points to the nominal value */
double_value = (double_value / 100.0) * *((double*)value->variable_ptr);
}
format = "%f";
if (value->format != NULL)
format = value->format;
#ifdef HAVE_PRAGMAS_FOR_GCC_DIAGNOSTIC_IGNORED_FORMAT_NONLITERAL
#pragma GCC diagnostic push
#endif
#ifdef HAVE_PRAGMA_GCC_DIAGNOSTIC_IGNORED_FORMAT_NONLITERAL
#pragma GCC diagnostic ignored "-Wformat-nonliteral"
#endif
res = snprintf(output, output_len, format, double_value);
#ifdef HAVE_PRAGMAS_FOR_GCC_DIAGNOSTIC_IGNORED_FORMAT_NONLITERAL
#pragma GCC diagnostic pop
#endif
if (res < 0 || (size_t)res >= output_len) {
return 0;
}
return 1;
}
static apc_modbus_converter_t _apc_modbus_power_conversion = { _apc_modbus_power_to_nut, NULL };
static int _apc_modbus_voltage_to_nut(const apc_modbus_value_t *value, char *output, size_t output_len)
{
int res;
if (value == NULL || output == NULL || output_len == 0) {
/* Invalid parameters */
return 0;
}
if (value->type != APC_MODBUS_VALUE_TYPE_UINT) {
return 0;
}
if (value->data.uint_value == 0xffff) {
/* Not applicable */
res = snprintf(output, output_len, "NA");
if (res < 0 || (size_t)res >= output_len) {
return 0;
}
return 1;
}
return _apc_modbus_double_to_nut(value, output, output_len);
}
static apc_modbus_converter_t _apc_modbus_voltage_conversion = { _apc_modbus_voltage_to_nut, NULL };
static int _apc_modbus_efficiency_to_nut(const apc_modbus_value_t *value, char *output, size_t output_len)
{
char *cause;
int res;
if (value == NULL || output == NULL || output_len == 0) {
/* Invalid parameters */
return 0;
}
if (value->type != APC_MODBUS_VALUE_TYPE_INT) {
return 0;
}
switch (value->data.int_value) {
case -1:
cause = "NotAvailable";
break;
case -2:
cause = "LoadTooLow";
break;
case -3:
cause = "OutputOff";
break;
case -4:
cause = "OnBattery";
break;
case -5:
cause = "InBypass";
break;
case -6:
cause = "BatteryCharging";
break;
case -7:
cause = "PoorACInput";
break;
case -8:
cause = "BatteryDisconnected";
break;
default:
return _apc_modbus_double_to_nut(value, output, output_len);
}
res = snprintf(output, output_len, "%s", cause);
if (res < 0 || (size_t)res >= output_len) {
return 0;
}
return 1;
}
static apc_modbus_converter_t _apc_modbus_efficiency_conversion = { _apc_modbus_efficiency_to_nut, NULL };
static int _apc_modbus_status_change_cause_to_nut(const apc_modbus_value_t *value, char *output, size_t output_len)
{
char *cause;
int res;
if (value == NULL || output == NULL || output_len == 0) {
/* Invalid parameters */
return 0;
}
if (value->type != APC_MODBUS_VALUE_TYPE_UINT) {
return 0;
}
switch (value->data.uint_value) {
case 0:
cause = "SystemInitialization";
break;
case 1:
cause = "HighInputVoltage";
break;
case 2:
cause = "LowInputVoltage";
break;
case 3:
cause = "DistortedInput";
break;
case 4:
cause = "RapidChangeOfInputVoltage";
break;
case 5:
cause = "HighInputFrequency";
break;
case 6:
cause = "LowInputFrequency";
break;
case 7:
cause = "FreqAndOrPhaseDifference";
break;
case 8:
cause = "AcceptableInput";
break;
case 9:
cause = "AutomaticTest";
break;
case 10:
cause = "TestEnded";
break;
case 11:
cause = "LocalUICommand";
break;
case 12:
cause = "ProtocolCommand";
break;
case 13:
cause = "LowBatteryVoltage";
break;
case 14:
cause = "GeneralError";
break;
case 15:
cause = "PowerSystemError";
break;
case 16:
cause = "BatterySystemError";
break;
case 17:
cause = "ErrorCleared";
break;
case 18:
cause = "AutomaticRestart";
break;
case 19:
cause = "DistortedInverterOutput";
break;
case 20:
cause = "InverterOutputAcceptable";
break;
case 21:
cause = "EPOInterface";
break;
case 22:
cause = "InputPhaseDeltaOutOfRange";
break;
case 23:
cause = "InputNeutralNotConnected";
break;
case 24:
cause = "ATSTransfer";
break;
case 25:
cause = "ConfigurationChange";
break;
case 26:
cause = "AlertAsserted";
break;
case 27:
cause = "AlertCleared";
break;
case 28:
cause = "PlugRatingExceeded";
break;
case 29:
cause = "OutletGroupStateChange";
break;
case 30:
cause = "FailureBypassExpired";
break;
default:
cause = "Unknown";
break;
}
res = snprintf(output, output_len, "%s", cause);
if (res < 0 || (size_t)res >= output_len) {
return 0;
}
return 1;
}
static apc_modbus_converter_t _apc_modbus_status_change_cause_conversion = { _apc_modbus_status_change_cause_to_nut, NULL };
static int _apc_modbus_date_to_nut(const apc_modbus_value_t *value, char *output, size_t output_len)
{
struct tm *tm_info;
time_t time_stamp;
const time_t start_offset = 946684800; /* 2000-01-01 00:00 */
if (value == NULL || output == NULL || output_len == 0) {
/* Invalid parameters */
return 0;
}
if (value->type != APC_MODBUS_VALUE_TYPE_UINT) {
return 0;
}
time_stamp = ((int64_t)value->data.uint_value * 86400) + start_offset;
tm_info = gmtime(&time_stamp);
strftime(output, output_len, "%Y-%m-%d", tm_info);
return 1;
}
static apc_modbus_converter_t _apc_modbus_date_conversion = { _apc_modbus_date_to_nut, NULL };
typedef struct {
const char *nut_variable_name;
size_t modbus_addr;
size_t modbus_len; /* Number of uint16_t registers */
apc_modbus_value_types value_type;
apc_modbus_converter_t *value_converter;
const char *value_format;
int value_scale;
void *variable_ptr;
} apc_modbus_register_t;
/* Values that only need to be updated once on startup */
static apc_modbus_register_t apc_modbus_register_map_inventory[] = {
{ "ups.firmware", 516, 8, APC_MODBUS_VALUE_TYPE_STRING, NULL, "%s", 0, NULL },
{ "ups.model", 532, 16, APC_MODBUS_VALUE_TYPE_STRING, NULL, "%s", 0, NULL }, /* also device.model, filled automatically */
{ "ups.serial", 564, 8, APC_MODBUS_VALUE_TYPE_STRING, NULL, "%s", 0, NULL }, /* also device.serial, filled automatically */
{ "ups.power.nominal", 588, 1, APC_MODBUS_VALUE_TYPE_UINT, &_apc_modbus_double_conversion, "%.0f", 0, &power_nominal },
{ "ups.realpower.nominal", 589, 1, APC_MODBUS_VALUE_TYPE_UINT, &_apc_modbus_double_conversion, "%.0f", 0, &realpower_nominal },
{ "ups.mfr.date", 591, 1, APC_MODBUS_VALUE_TYPE_UINT, &_apc_modbus_date_conversion, NULL, 0, NULL },
{ "battery.date", 595, 1, APC_MODBUS_VALUE_TYPE_UINT, &_apc_modbus_date_conversion, NULL, 0, NULL },
{ "ups.id", 596, 8, APC_MODBUS_VALUE_TYPE_STRING, NULL, "%s", 0, NULL },
{ NULL, 0, 0, 0, NULL, NULL, 0.0f, NULL }
};
static apc_modbus_register_t apc_modbus_register_map_status[] = {
{ "input.transfer.reason", 2, 1, APC_MODBUS_VALUE_TYPE_UINT, &_apc_modbus_status_change_cause_conversion, NULL, 0, NULL },
{ NULL, 0, 0, 0, NULL, NULL, 0.0f, NULL }
};
static apc_modbus_register_t apc_modbus_register_map_dynamic[] = {
{ "battery.runtime", 128, 2, APC_MODBUS_VALUE_TYPE_UINT, NULL, "%u", 0, NULL },
{ "battery.charge", 130, 1, APC_MODBUS_VALUE_TYPE_UINT, &_apc_modbus_double_conversion, "%.2f", 9, NULL },
{ "battery.voltage", 131, 1, APC_MODBUS_VALUE_TYPE_INT, &_apc_modbus_double_conversion, "%.2f", 5, NULL },
{ "battery.date.maintenance", 133, 1, APC_MODBUS_VALUE_TYPE_UINT, &_apc_modbus_date_conversion, NULL, 0, NULL },
{ "battery.temperature", 135, 1, APC_MODBUS_VALUE_TYPE_INT, &_apc_modbus_double_conversion, "%.2f", 7, NULL },
{ "ups.load", 136, 1, APC_MODBUS_VALUE_TYPE_UINT, &_apc_modbus_double_conversion, "%.2f", 8, NULL },
{ "ups.realpower", 136, 1, APC_MODBUS_VALUE_TYPE_UINT, &_apc_modbus_power_conversion, "%.2f", 8, &realpower_nominal },
{ "ups.power", 138, 1, APC_MODBUS_VALUE_TYPE_UINT, &_apc_modbus_power_conversion, "%.2f", 8, &power_nominal },
{ "output.current", 140, 1, APC_MODBUS_VALUE_TYPE_UINT, &_apc_modbus_double_conversion, "%.2f", 5, NULL },
{ "output.voltage", 142, 1, APC_MODBUS_VALUE_TYPE_UINT, &_apc_modbus_double_conversion, "%.2f", 6, NULL },
{ "output.frequency", 144, 1, APC_MODBUS_VALUE_TYPE_UINT, &_apc_modbus_double_conversion, "%.2f", 7, NULL },
{ "experimental.output.energy", 145, 2, APC_MODBUS_VALUE_TYPE_UINT, NULL, "%u", 0, NULL },
{ "input.voltage", 151, 1, APC_MODBUS_VALUE_TYPE_UINT, &_apc_modbus_voltage_conversion, "%.2f", 6, NULL },
{ "ups.efficiency", 154, 1, APC_MODBUS_VALUE_TYPE_INT, &_apc_modbus_efficiency_conversion, "%.1f", 7, NULL },
{ "ups.timer.shutdown", 155, 1, APC_MODBUS_VALUE_TYPE_INT, NULL, "%d", 0, NULL },
{ "ups.timer.start", 156, 1, APC_MODBUS_VALUE_TYPE_INT, NULL, "%d", 0, NULL },
{ "ups.timer.reboot", 157, 2, APC_MODBUS_VALUE_TYPE_INT, NULL, "%d", 0, NULL },
{ NULL, 0, 0, 0, NULL, NULL, 0.0f, NULL }
};
static apc_modbus_register_t apc_modbus_register_map_static[] = {
{ "input.transfer.high", 1026, 1, APC_MODBUS_VALUE_TYPE_UINT, NULL, "%u", 0, NULL },
{ "input.transfer.low", 1027, 1, APC_MODBUS_VALUE_TYPE_UINT, NULL, "%u", 0, NULL },
{ "ups.delay.shutdown", 1029, 1, APC_MODBUS_VALUE_TYPE_INT, NULL, "%d", 0, NULL },
{ "ups.delay.start", 1030, 1, APC_MODBUS_VALUE_TYPE_INT, NULL, "%d", 0, NULL },
{ "ups.delay.reboot", 1031, 2, APC_MODBUS_VALUE_TYPE_INT, NULL, "%d", 0, NULL },
{ NULL, 0, 0, 0, NULL, NULL, 0.0f, NULL }
};
static void _apc_modbus_close(int free_modbus)
{
if (modbus_ctx != NULL) {
modbus_close(modbus_ctx);
if (free_modbus) {
modbus_free(modbus_ctx);
modbus_ctx = NULL;
}
}
is_open = 0;
}
#if defined NUT_MODBUS_HAS_USB
static void _apc_modbus_create_reopen_matcher(void)
{
int r;
if (reopen_matcher != NULL) {
USBFreeExactMatcher(reopen_matcher);
reopen_matcher = NULL;
}
r = USBNewExactMatcher(&reopen_matcher, &usbdevice);
if (r < 0) {
fatal_with_errno(EXIT_FAILURE, "USBNewExactMatcher");
}
reopen_matcher->next = best_matcher;
best_matcher = reopen_matcher;
}
#endif /* defined NUT_MODBUS_HAS_USB */
static int _apc_modbus_reopen(void)
{
dstate_setinfo("driver.state", "reconnect.trying");
if (modbus_connect(modbus_ctx) < 0) {
upslogx(LOG_ERR, "%s: Unable to connect Modbus: %s", __func__, modbus_strerror(errno));
return 0;
}
#if defined NUT_MODBUS_HAS_USB
/* We might have matched a new device in the modbus_connect callback.
* Because of this we want a new exact matcher. */
best_matcher = best_matcher->next;
_apc_modbus_create_reopen_matcher();
#endif /* defined NUT_MODBUS_HAS_USB */
usleep(1000000);
modbus_flush(modbus_ctx);
is_open = 1;
dstate_setinfo("driver.state", "reconnect.updateinfo");
_apc_modbus_read_inventory();
dstate_setinfo("driver.state", "quiet");
return 1;
}
static useconds_t _apc_modbus_get_time_us(void)
{
struct timeval tv;
gettimeofday(&tv, NULL);
return ((useconds_t)tv.tv_sec * (useconds_t)1000000) + (useconds_t)tv.tv_usec;
}
static void _apc_modbus_interframe_delay(void)
{
/* 4.2.2 Modbus Message RTU Framing, interframe delay */
static useconds_t last_send_time = 0;
static const useconds_t inter_frame_delay = 35000;
useconds_t current_time, delta_time;
current_time = _apc_modbus_get_time_us();
delta_time = current_time - last_send_time;
if (delta_time > inter_frame_delay) {
/* Already over the inter frame delay */
goto interframe_delay_exit;
}
usleep(inter_frame_delay - delta_time);
interframe_delay_exit:
last_send_time = current_time;
}
static void _apc_modbus_handle_error(modbus_t *ctx)
{
static int flush_retries = 0;
int flush = 0;
#ifdef WIN32
int wsa_error;
#endif /* WIN32 */
/*
* We could enable MODBUS_ERROR_RECOVERY_LINK but that would just get stuck
* in libmodbus until recovery. The only indication of this is that the
* program is stuck and debug prints by libmodbus, which we don't want to
* enable on release.
*
* Instead we detect timout errors and do a sleep + flush, on every other
* error or when flush didn't work we do a reconnect.
*/
#ifdef WIN32
wsa_error = WSAGetLastError();
if (wsa_error == WSAETIMEDOUT) {
flush = 1;
}
#else
if (errno == ETIMEDOUT) {
flush = 1;
}
#endif /* WIN32 */
if (flush > 0 && flush_retries++ < 5) {
usleep(1000000);
modbus_flush(ctx);
} else {
flush_retries = 0;
upslogx(LOG_ERR, "%s: Closing connection", __func__);
/* Close without free, will retry connection on next update */
_apc_modbus_close(0);
}
}
static int _apc_modbus_read_registers(modbus_t *ctx, int addr, int nb, uint16_t *dest)
{
_apc_modbus_interframe_delay();
if (modbus_read_registers(ctx, addr, nb, dest) > 0) {
return 1;
} else {
upslogx(LOG_ERR, "%s: Read of %d:%d failed: %s (%s)", __func__, addr, addr + nb, modbus_strerror(errno), device_path);
_apc_modbus_handle_error(ctx);
return 0;
}
}
static int _apc_modbus_update_value(apc_modbus_register_t *regs_info, const uint16_t *regs, const size_t regs_len)
{
apc_modbus_value_t value;
char strbuf[33], nutvbuf[128];
if (regs_info == NULL || regs == NULL || regs_len == 0) {
/* Invalid parameters */
return 0;
}
value.type = regs_info->value_type;
value.format = regs_info->value_format;
value.scale = regs_info->value_scale;
value.variable_ptr = regs_info->variable_ptr;
assert(regs_info->value_type <= apc_modbus_value_types_max);
switch (regs_info->value_type) {
case APC_MODBUS_VALUE_TYPE_STRING:
_apc_modbus_to_string(regs, regs_info->modbus_len, strbuf, sizeof(strbuf));
value.data.string_value = strbuf;
break;
case APC_MODBUS_VALUE_TYPE_INT:
_apc_modbus_to_int64(regs, regs_info->modbus_len, &value.data.int_value);
break;
case APC_MODBUS_VALUE_TYPE_UINT:
_apc_modbus_to_uint64(regs, regs_info->modbus_len, &value.data.uint_value);
break;
}
if (regs_info->value_converter != NULL) {
/* If we have a converter, use it and set the value as a string */
if (!regs_info->value_converter->apc_to_nut(&value, nutvbuf, sizeof(nutvbuf))) {
upslogx(LOG_ERR, "%s: Failed to convert register %" PRIuSIZE ":%" PRIuSIZE, __func__,
regs_info->modbus_addr, regs_info->modbus_addr + regs_info->modbus_len);
return 0;
}
dstate_setinfo(regs_info->nut_variable_name, "%s", nutvbuf);
} else {
#ifdef HAVE_PRAGMAS_FOR_GCC_DIAGNOSTIC_IGNORED_FORMAT_NONLITERAL
#pragma GCC diagnostic push
#endif
#ifdef HAVE_PRAGMA_GCC_DIAGNOSTIC_IGNORED_FORMAT_NONLITERAL
#pragma GCC diagnostic ignored "-Wformat-nonliteral"
#endif
assert(regs_info->value_type <= apc_modbus_value_types_max);
switch (regs_info->value_type) {
case APC_MODBUS_VALUE_TYPE_STRING:
dstate_setinfo(regs_info->nut_variable_name, regs_info->value_format, value.data.string_value);
break;
case APC_MODBUS_VALUE_TYPE_INT:
dstate_setinfo(regs_info->nut_variable_name, regs_info->value_format, value.data.int_value);
break;
case APC_MODBUS_VALUE_TYPE_UINT:
dstate_setinfo(regs_info->nut_variable_name, regs_info->value_format, value.data.uint_value);
break;
}
#ifdef HAVE_PRAGMAS_FOR_GCC_DIAGNOSTIC_IGNORED_FORMAT_NONLITERAL
#pragma GCC diagnostic pop
#endif
}
return 1;
}
static int _apc_modbus_process_registers(apc_modbus_register_t* values, const uint16_t *regs, const size_t regs_len, const size_t regs_offset)
{
size_t i;
apc_modbus_register_t *v;
for (i = 0; values[i].nut_variable_name; i++) {
v = &values[i];
if ((size_t)v->modbus_addr < regs_offset || (size_t)(v->modbus_addr + v->modbus_len) > regs_offset + regs_len) {
continue;
}
_apc_modbus_update_value(v, regs + (v->modbus_addr - regs_offset), v->modbus_len);
}
return 1;
}
static int _apc_modbus_read_inventory(void)
{
uint16_t regbuf[88];
/* Inventory Information */
if (_apc_modbus_read_registers(modbus_ctx, 516, 88, regbuf)) {
_apc_modbus_process_registers(apc_modbus_register_map_inventory, regbuf, 88, 516);
} else {
return 0;
}
return 1;
}
void upsdrv_initinfo(void)
{
if (!_apc_modbus_read_inventory()) {
fatalx(EXIT_FAILURE, "Can't read inventory information from the UPS");
}
dstate_setinfo("ups.mfr", "American Power Conversion"); /* also device.mfr, filled automatically */
dstate_setinfo("device.type", "ups");
}
void upsdrv_updateinfo(void)
{
uint16_t regbuf[32];
uint64_t value;
if (!is_open) {
if (!_apc_modbus_reopen()) {
upsdebugx(2, "Failed to reopen modbus");
dstate_datastale();
return;
}
}
alarm_init();
status_init();
/* Status Data */
if (_apc_modbus_read_registers(modbus_ctx, 0, 27, regbuf)) {
/* UPSStatus_BF, 2 registers */
_apc_modbus_to_uint64(®buf[0], 2, &value);
if (value & (1 << 1)) {
status_set("OL");
}
if (value & (1 << 2)) {
status_set("OB");
}
if (value & (1 << 3)) {
status_set("BYPASS");
}
if (value & (1 << 4)) {
status_set("OFF");
}
if (value & (1 << 5)) {
alarm_set("General fault");
}
if (value & (1 << 6)) {
alarm_set("Input not acceptable");
}
if (value & (1 << 7)) {
status_set("TEST");
}
if (value & (1 << 13)) {
status_set("HE"); /* High efficiency / ECO mode*/
}
if (value & (1 << 21)) {
status_set("OVER");
}
/* SimpleSignalingStatus_BF, 1 register */
_apc_modbus_to_uint64(®buf[18], 1, &value);
if (value & (1 << 1)) { /* ShutdownImminent */
status_set("LB");
}
/* BatterySystemError_BF, 1 register */
_apc_modbus_to_uint64(®buf[18], 1, &value);
if (value & (1 << 1)) { /* NeedsReplacement */
status_set("RB");
}
/* RunTimeCalibrationStatus_BF, 1 register */
_apc_modbus_to_uint64(®buf[24], 1, &value);
if (value & (1 << 1)) { /* InProgress */
status_set("CAL");
}
_apc_modbus_process_registers(apc_modbus_register_map_status, regbuf, 27, 0);
} else {
dstate_datastale();
return;
}
/* Dynamic Data */
if (_apc_modbus_read_registers(modbus_ctx, 128, 32, regbuf)) {
/* InputStatus_BF, 1 register */
_apc_modbus_to_uint64(®buf[22], 1, &value);
if (value & (1 << 5)) {
status_set("BOOST");
}
if (value & (1 << 6)) {
status_set("TRIM");
}
_apc_modbus_process_registers(apc_modbus_register_map_dynamic, regbuf, 32, 128);
} else {
dstate_datastale();
return;
}
/* Static Data */
if (_apc_modbus_read_registers(modbus_ctx, 1026, 7, regbuf)) {
_apc_modbus_process_registers(apc_modbus_register_map_static, regbuf, 7, 1026);
} else {
dstate_datastale();
return;
}
alarm_commit();
status_commit();
dstate_dataok();
}
void upsdrv_shutdown(void)
{
/* TODO: replace with a proper shutdown function */
upslogx(LOG_ERR, "shutdown not supported");
set_exit_flag(-1);
}
void upsdrv_help(void)
{
}
void upsdrv_makevartable(void)
{
#if defined NUT_MODBUS_HAS_USB
nut_usb_addvars();
#endif /* defined NUT_MODBUS_HAS_USB */
#if defined NUT_MODBUS_HAS_USB
addvar(VAR_VALUE, "porttype", "Modbus port type (serial, tcp, usb, default=usb)");
#else
addvar(VAR_VALUE, "porttype", "Modbus port type (serial, tcp, default=serial)");
#endif /* defined NUT_MODBUS_HAS_USB */
addvar(VAR_VALUE, "slaveid", "Modbus slave id (default=1)");
addvar(VAR_VALUE, "response_timeout_ms", "Modbus response timeout in milliseconds");
/* Serial RTU parameters */
addvar(VAR_VALUE, "baudrate", "Modbus serial RTU communication speed in baud (default=9600)");
addvar(VAR_VALUE, "parity", "Modbus serial RTU parity (N=none, E=even, O=odd, default=N)");
addvar(VAR_VALUE, "databits", "Modbus serial RTU data bit count (default=8)");
addvar(VAR_VALUE, "stopbits", "Modbus serial RTU stop bit count (default=1)");
}
#if defined NUT_MODBUS_HAS_USB
static int _apc_modbus_usb_device_match_func(USBDevice_t *hd, void *privdata)
{
int status;