-
-
Notifications
You must be signed in to change notification settings - Fork 4
/
modbus.cpp
2670 lines (2339 loc) · 83.7 KB
/
modbus.cpp
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
// SPDX-License-Identifier: GPL-3.0-or-later
//
// Copyright (c) 2019-2023 plan44.ch / Lukas Zeller, Zurich, Switzerland
//
// Author: Lukas Zeller <luz@plan44.ch>
//
// This file is part of p44utils.
//
// p44utils 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 3 of the License, or
// (at your option) any later version.
//
// p44utils 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 p44utils. If not, see <http://www.gnu.org/licenses/>.
//
// File scope debugging options
// - Set ALWAYS_DEBUG to 1 to enable DBGLOG output even in non-DEBUG builds of this file
#define ALWAYS_DEBUG 0
// - set FOCUSLOGLEVEL to non-zero log level (usually, 5,6, or 7==LOG_DEBUG) to get focus (extensive logging) for this file
// Note: must be before including "logger.hpp" (or anything that includes "logger.hpp")
#define FOCUSLOGLEVEL 7
#include "modbus.hpp"
#if ENABLE_MODBUS
#include "application.hpp" // for temp dir path
#include "serialcomm.hpp" // for parameter parsing
#include "crc32.hpp"
#include "utils.hpp"
using namespace p44;
#if ENABLE_MODBUS_SCRIPT_FUNCS
using namespace P44Script;
#endif
// MARK: - ModbusConnection
ModbusConnection::ModbusConnection() :
mModbus(NULL),
mIsTcp(false),
mDoAcceptConnections(false),
mServerSocket(-1),
mSlaveAddress(-1), // none
mConnected(false),
mFloatMode(float_dcba) // this was the standard mode in older libmodbus
{
}
ModbusConnection::~ModbusConnection()
{
clearModbusContext();
}
void ModbusConnection::clearModbusContext()
{
close();
if (mModbus) {
modbus_free(mModbus);
mModbus = NULL;
}
}
void ModbusConnection::setDebug(bool aDebugEnabled)
{
if (mModbus) {
modbus_set_debug(mModbus, aDebugEnabled);
}
}
extern "C" {
void setRts(modbus_t* ctx, int on, void* cbctx)
{
ModbusConnection* modbusConnection = (ModbusConnection*)cbctx;
if (modbusConnection && modbusConnection->mModbusTxEnable) {
modbusConnection->mModbusTxEnable->set(on);
if (modbusConnection->mModbusRxEnable) {
// we have separate Rx enable, set this to the inverse of Tx enable
modbusConnection->mModbusRxEnable->set(!on);
}
}
}
}
ErrorPtr ModbusConnection::setConnectionSpecification(
const char* aConnectionSpec, uint16_t aDefaultPort, const char *aDefaultCommParams,
const char *aTransmitEnableSpec, MLMicroSeconds aTxDisableDelay,
const char *aReceiveEnableSpec,
int aByteTimeNs,
modbus_error_recovery_mode aRecoveryMode
)
{
ErrorPtr err;
// get rid of old context
clearModbusContext();
// parse the connection spec
string connectionPath;
uint16_t connectionPort;
int baudRate;
int charSize; // character size 5..8 bits
bool parityEnable;
bool evenParity;
bool twoStopBits;
bool hardwareHandshake;
mIsTcp = !SerialComm::parseConnectionSpecification(
aConnectionSpec, aDefaultPort, aDefaultCommParams,
connectionPath,
baudRate,
charSize,
parityEnable,
evenParity,
twoStopBits,
hardwareHandshake,
connectionPort
);
int mberr = 0;
if (!mIsTcp) {
bool rs232 = aTransmitEnableSpec && strcasecmp("RS232", aTransmitEnableSpec)==0;
if (!rs232) {
if (aTransmitEnableSpec!=NULL && *aTransmitEnableSpec!=0 && strcasecmp("RTS", aTransmitEnableSpec)!=0) {
// not using native RTS, but digital IO specification (or * as placeholder for pinspec to be set separately with setDriverEnablePins())
if (strcmp(aTransmitEnableSpec,"*")!=0) mModbusTxEnable = DigitalIoPtr(new DigitalIo(aTransmitEnableSpec, true, false));
}
if (aReceiveEnableSpec) {
mModbusRxEnable = DigitalIoPtr(new DigitalIo(aReceiveEnableSpec, true, true));
}
}
if (baudRate==0 || connectionPath.empty()) {
err = Error::err<ModBusError>(ModBusError::InvalidConnParams, "invalid RTU connection params");
}
else {
mModbus = modbus_new_rtu(
connectionPath.c_str(),
baudRate,
parityEnable ? (evenParity ? 'E' : 'O') : 'N',
charSize,
twoStopBits ? 2 : 1
);
if (mModbus==0) {
mberr = errno;
}
else {
if (aByteTimeNs>0) {
setByteTimeNs(aByteTimeNs);
}
if (rs232) {
if (modbus_rtu_set_serial_mode(mModbus, MODBUS_RTU_RS232)<0) mberr = errno;
}
else {
// set custom RTS if needed (FIRST, otherwise modbus_rtu_set_serial_mode() might fail when TIOCSRS485 does not work)
if (mberr==0 && mModbusTxEnable) {
if (modbus_rtu_set_custom_rts_ex(mModbus, setRts, this)<0) mberr = errno;
}
if (mberr==0) {
if (modbus_rtu_set_serial_mode(mModbus, MODBUS_RTU_RS485)<0) mberr = errno;
}
if (mberr==0) {
if (modbus_rtu_set_rts(mModbus, MODBUS_RTU_RTS_UP)<0) mberr = errno;
}
}
if (mberr==0) {
if (aTxDisableDelay!=Never) {
if (modbus_rtu_set_rts_delay(mModbus, (int)aTxDisableDelay)<0) mberr = errno;
}
}
if (mberr==0) {
if (modbus_set_error_recovery(mModbus, aRecoveryMode)) mberr = errno;
}
}
}
}
else {
if (!aConnectionSpec || *aConnectionSpec==0) {
err = Error::err<ModBusError>(ModBusError::InvalidConnParams, "invalid TCP connection params");
}
mModbus = modbus_new_tcp(connectionPath.c_str(), connectionPort);
if (mModbus==0) mberr = errno;
}
if (Error::isOK(err) && mberr!=0) {
err = ModBusError::err<ModBusError>(mberr);
clearModbusContext();
}
if (Error::isOK(err)) {
mbContextReady();
}
return err;
}
ErrorPtr ModbusConnection::setByteTimeNs(int aByteTimeNs)
{
ErrorPtr err;
OLOG(LOG_DEBUG, "Setting explicit byte time: %d nS, calculated value is %d nS", aByteTimeNs, modbus_rtu_get_byte_time(mModbus));
if (modbus_rtu_set_byte_time(mModbus, (int)aByteTimeNs)) err = ModBusError::err<ModBusError>(errno);
return err;
}
ErrorPtr ModbusConnection::setRecoveryMode(modbus_error_recovery_mode aRecoveryMode)
{
ErrorPtr err;
if (modbus_set_error_recovery(mModbus, aRecoveryMode)) err = ModBusError::err<ModBusError>(errno);
return err;
}
void ModbusConnection::mbContextReady()
{
if (mSlaveAddress>=0) {
modbus_set_slave(mModbus, mSlaveAddress);
}
}
bool ModbusConnection::isCommErr(ErrorPtr aError)
{
if (aError && aError->isDomain(ModBusError::domain())) {
long err = aError->getErrorCode();
if (
err==ModBusError::SysErr+ETIMEDOUT ||
err==ModBusError::SysErr+ECONNRESET ||
err==ModBusError::MBErr+EMBBADDATA
)
return true;
}
return false;
}
void ModbusConnection::setSlaveAddress(int aSlaveAddress)
{
if (aSlaveAddress!=mSlaveAddress) {
mSlaveAddress = aSlaveAddress;
if (mModbus && mSlaveAddress>=0) {
modbus_set_slave(mModbus, aSlaveAddress);
}
}
}
ErrorPtr ModbusConnection::connect(bool aAutoFlush)
{
ErrorPtr err;
if (!mModbus) {
err = Error::err<ModBusError>(ModBusError::InvalidConnParams, "no valid connection parameters - cannot open connection");
}
if (!mConnected) {
if (mIsTcp && mDoAcceptConnections) {
// act as TCP server, waiting for connections
mServerSocket = modbus_tcp_listen(mModbus, 1);
if (mServerSocket<0) {
return Error::err<ModBusError>(errno)->withPrefix("cannot listen: ");
}
// - install connection watcher
MainLoop::currentMainLoop().registerPollHandler(mServerSocket, POLLIN, boost::bind(&ModbusConnection::connectionAcceptHandler, this, _1, _2));
mConnected = true;
}
else {
// act as TCP client or just serial connection
if (modbus_connect(mModbus)<0) {
if (errno!=EINPROGRESS) {
err = ModBusError::err<ModBusError>(errno)->withPrefix("connecting: ");
}
}
if (Error::isOK(err)) {
if (aAutoFlush) {
flush(); // flush garbage possibly already in communication device buffers
}
startServing(); // start serving in case this is a Modbus slave
mConnected = true;
}
}
}
return err;
}
bool ModbusConnection::connectionAcceptHandler(int aFd, int aPollFlags)
{
if (aPollFlags & POLLIN) {
// server socket has data, means connection waiting to get accepted
if (modbus_get_socket(mModbus)>=0) {
OLOG(LOG_ERR, "cannot handle multiple connections yet");
}
else {
modbus_tcp_accept(mModbus, &mServerSocket);
startServing();
}
}
// handled
return true;
}
void ModbusConnection::close()
{
if (mModbus && mConnected) {
if (mServerSocket>=0) {
MainLoop::currentMainLoop().unregisterPollHandler(mServerSocket);
::close(mServerSocket);
}
modbus_close(mModbus);
}
mConnected = false;
}
int ModbusConnection::flush()
{
int flushed = 0;
if (mModbus) {
flushed = modbus_flush(mModbus);
FOCUSOLOG("flushed, %d bytes", flushed);
}
return flushed;
}
double ModbusConnection::getAsDouble(const uint16_t *aTwoRegs)
{
switch (mFloatMode) {
case float_abcd: return modbus_get_float_abcd(aTwoRegs);
case float_badc: return modbus_get_float_badc(aTwoRegs);
case float_cdab: return modbus_get_float_cdab(aTwoRegs);
default:
case float_dcba: return modbus_get_float_dcba(aTwoRegs);
}
}
void ModbusConnection::setAsDouble(uint16_t *aTwoRegs, double aDouble)
{
switch (mFloatMode) {
case float_abcd: modbus_set_float_abcd((float)aDouble, aTwoRegs); break;
case float_badc: modbus_set_float_badc((float)aDouble, aTwoRegs); break;
case float_cdab: modbus_set_float_cdab((float)aDouble, aTwoRegs); break;
default:
case float_dcba: modbus_set_float_dcba((float)aDouble, aTwoRegs); break;
}
}
void ModbusConnection::buildExceptionResponse(sft_t &aSft, int aExceptionCode, const char* aErrorText, ModBusPDU& aRsp, int& aRspLen)
{
aRspLen = modbus_build_exception_response(
mModbus,
&aSft,
aExceptionCode,
(uint8_t *)aRsp,
FALSE, // no flushing (and blocking!!)
"Modbus exception %d - %s: %s\n", aExceptionCode, modbus_strerror(MODBUS_ENOBASE+aExceptionCode), nonNullCStr(aErrorText)
);
}
void ModbusConnection::buildExceptionResponse(sft_t &aSft, ErrorPtr aError, ModBusPDU& aRsp, int& aRspLen)
{
if (Error::notOK(aError) && aError->isDomain(ModBusError::domain())) {
int ex = (int)aError->getErrorCode()-ModBusError::MBErr;
if (ex<MODBUS_EXCEPTION_MAX) {
buildExceptionResponse(aSft, ex, aError->text(), aRsp, aRspLen);
}
}
else {
buildExceptionResponse(aSft, MODBUS_EXCEPTION_SLAVE_OR_SERVER_FAILURE, Error::text(aError), aRsp, aRspLen);
}
}
void ModbusConnection::buildResponseBase(sft_t &aSft, ModBusPDU& aRsp, int& aRspLen)
{
aRspLen = modbus_build_response_basis(mModbus, &aSft, aRsp);
}
bool ModbusConnection::appendToMessage(const uint8_t *aDataP, int aNumBytes, ModBusPDU& aMsg, int& aMsgLen)
{
if (aMsgLen+aNumBytes>MODBUS_MAX_PDU_LENGTH) return false;
if (aDataP)
memcpy(&aMsg[aMsgLen], aDataP, aNumBytes);
else
memset(&aMsg[aMsgLen], 0, aNumBytes);
aMsgLen += aNumBytes;
return true;
}
// MARK: - ModbusMaster
ModbusMaster::ModbusMaster()
{
}
ModbusMaster::~ModbusMaster()
{
}
ErrorPtr ModbusMaster::connectAsMaster()
{
ErrorPtr err = connect();
if (Error::isOK(err) && !mIsTcp) {
if (mSlaveAddress<0) {
err = Error::err<ModBusError>(ModBusError::InvalidSlaveAddr, "no slave address set");
}
}
return err;
}
ErrorPtr ModbusMaster::readSlaveInfo(string& aId, bool& aRunIndicator)
{
ErrorPtr err;
bool wasConnected = isConnected();
if (!wasConnected) err = connectAsMaster();
if (Error::isOK(err)) {
ModBusPDU slaveid;
int bytes = modbus_report_slave_id(mModbus, MODBUS_MAX_PDU_LENGTH, slaveid);
if (bytes<0) {
err = ModBusError::err<ModBusError>(errno);
}
else {
aId.assign((const char*)slaveid+2, bytes-2);
aRunIndicator = true; // FIXME: actually get the value
}
}
if (!wasConnected) close();
return err;
}
ErrorPtr ModbusMaster::findSlaves(SlaveAddrList& aSlaveAddrList, string aMatchString, int aFirstAddr, int aLastAddr)
{
ErrorPtr err;
if (aFirstAddr<1 || aLastAddr>0xFF || aFirstAddr>aLastAddr) {
err = Error::err<ModBusError>(ModBusError::InvalidSlaveAddr, "invalid slave address range");
}
bool wasConnected = isConnected();
if (!wasConnected) err = connect();
if (Error::isOK(err)) {
int currentSlave = getSlaveAddress();
aSlaveAddrList.clear();
string id;
bool runs;
for (int sa=aFirstAddr; sa<=aLastAddr; ++sa) {
setSlaveAddress(sa);
err = readSlaveInfo(id, runs);
if (Error::isOK(err)) {
// check for id match
if (aMatchString.empty() || id.find(aMatchString)!=string::npos) {
aSlaveAddrList.push_back(sa);
}
else {
OLOG(LOG_INFO, "address %d id '%s' does not match", sa, id.c_str());
}
}
else {
OLOG(LOG_INFO, "address %d returns error for slaveid query: %s", sa, err->text());
}
}
setSlaveAddress(currentSlave);
}
if (!wasConnected) close();
return err;
}
// MARK: - ModbusMaster register and bit access
ErrorPtr ModbusMaster::readRegister(int aRegAddr, uint16_t &aRegData, bool aInput)
{
return readRegisters(aRegAddr, 1, &aRegData, aInput);
}
ErrorPtr ModbusMaster::readFloatRegister(int aRegAddr, double &aFloatData, bool aInput)
{
uint16_t floatRegs[2];
ErrorPtr err = readRegisters(aRegAddr, 2, floatRegs, aInput);
if (Error::isOK(err)) {
aFloatData = getAsDouble(floatRegs);
}
return err;
}
ErrorPtr ModbusMaster::readRegisters(int aRegAddr, int aNumRegs, uint16_t *aRegsP, bool aInput)
{
ErrorPtr err;
bool wasConnected = isConnected();
if (!wasConnected) err = connectAsMaster();
if (Error::isOK(err)) {
int ret;
if (aInput) {
ret = modbus_read_input_registers(mModbus, aRegAddr, aNumRegs, aRegsP);
}
else {
ret = modbus_read_registers(mModbus, aRegAddr, aNumRegs, aRegsP);
}
if (ret<0) {
err = ModBusError::err<ModBusError>(errno);
}
}
if (!wasConnected) close();
return err;
}
ErrorPtr ModbusMaster::writeRegister(int aRegAddr, const uint16_t aRegData)
{
return writeRegisters(aRegAddr, 1, &aRegData);
}
ErrorPtr ModbusMaster::writeFloatRegister(int aRegAddr, double aFloatData)
{
uint16_t floatRegs[2];
setAsDouble(floatRegs, aFloatData);
return writeRegisters(aRegAddr, 2, floatRegs);
}
ErrorPtr ModbusMaster::writeRegisters(int aRegAddr, int aNumRegs, const uint16_t *aRegsP)
{
ErrorPtr err;
bool wasConnected = isConnected();
if (!wasConnected) err = connectAsMaster();
if (Error::isOK(err)) {
if (modbus_write_registers(mModbus, aRegAddr, aNumRegs, aRegsP)<0) {
err = ModBusError::err<ModBusError>(errno);
}
}
if (!wasConnected) close();
return err;
}
ErrorPtr ModbusMaster::readBit(int aBitAddr, bool &aBitData, bool aInput)
{
uint8_t bit;
ErrorPtr err = readBits(aBitAddr, 1, &bit, aInput);
if (Error::isOK(err)) aBitData = bit!=0;
return err;
}
ErrorPtr ModbusMaster::readBits(int aBitAddr, int aNumBits, uint8_t *aBitsP, bool aInput)
{
ErrorPtr err;
bool wasConnected = isConnected();
if (!wasConnected) err = connectAsMaster();
if (Error::isOK(err)) {
int ret;
if (aInput) {
ret = modbus_read_input_bits(mModbus, aBitAddr, aNumBits, aBitsP);
}
else {
ret = modbus_read_bits(mModbus, aBitAddr, aNumBits, aBitsP);
}
if (ret<0) {
err = ModBusError::err<ModBusError>(errno);
}
}
if (!wasConnected) close();
return err;
}
ErrorPtr ModbusMaster::writeBit(int aBitAddr, bool aBitData)
{
uint8_t bit = aBitData;
return writeBits(aBitAddr, 1, &bit);
}
ErrorPtr ModbusMaster::writeBits(int aBitAddr, int aNumBits, const uint8_t *aBitsP)
{
ErrorPtr err;
bool wasConnected = isConnected();
if (!wasConnected) err = connectAsMaster();
if (Error::isOK(err)) {
if (modbus_write_bits(mModbus, aBitAddr, aNumBits, aBitsP)<0) {
err = ModBusError::err<ModBusError>(errno);
}
}
if (!wasConnected) close();
return err;
}
// MARK: - ModbusMaster file record access
ErrorPtr ModbusMaster::writeFileRecords(uint16_t aFileNo, uint16_t aFirstRecordNo, uint16_t aNumRecords, const uint8_t* aDataP)
{
ErrorPtr err;
bool wasConnected = isConnected();
if (!wasConnected) err = connect();
if (Error::isOK(err)) {
ModBusPDU req;
int reqLen = modbus_build_request_basis(mModbus, MODBUS_FC_WRITE_FILE_RECORD, req);
int lenIdx = reqLen++;
req[reqLen++] = 0x06; // subrecord reference type
req[reqLen++] = aFileNo>>8;
req[reqLen++] = aFileNo & 0xFF;
req[reqLen++] = aFirstRecordNo>>8;
req[reqLen++] = aFirstRecordNo & 0xFF;
req[reqLen++] = aNumRecords>>8; // aka "record length" in the specs
req[reqLen++] = aNumRecords & 0xFF; // aka "record length" in the specs
uint16_t bytes = aNumRecords*2;
if (reqLen+bytes>MODBUS_MAX_PDU_LENGTH) {
err = Error::err<ModBusError>(EMBBADEXC, "write file record PDU size exceeded");
}
else {
// add actual data
appendToMessage(aDataP, bytes, req, reqLen);
req[lenIdx] = reqLen-lenIdx-1;
// send it
int rc;
do {
rc = modbus_send_msg(mModbus, req, reqLen);
// might return EAGAIN when broadcasting w/o waiting very fast
} while (isBroadCast() && rc<0 && errno==EAGAIN);
if (rc<0) {
err = Error::err<ModBusError>(errno)->withPrefix("sending write file record request: ");
}
else if (isBroadCast()) {
// TODO: might need some pacing here
}
else {
ModBusPDU rsp;
int rspLen = modbus_receive_msg(mModbus, rsp, MSG_CONFIRMATION);
if (rspLen<0) {
rc = -1;
}
else if (rspLen>0) {
rc = modbus_pre_check_confirmation(mModbus, req, rsp, rspLen);
if (rc>0) {
if (rsp[rc++]!=MODBUS_FC_WRITE_FILE_RECORD) { rc = -1; errno = EMBBADEXC; }
else {
if (rsp[rc]!=req[lenIdx] || rspLen<rsp[rc]+rc) { rc = -1; errno = EMBBADDATA; }
else {
// everything following, including length must be equal to request
if (memcmp(req+lenIdx, rsp+rc, (size_t)req[lenIdx])!=0) { rc = -1; errno = EMBBADDATA; }
}
}
}
}
if (rc<0) {
err = Error::err<ModBusError>(errno)->withPrefix("receiving write file record response: ");
}
}
}
}
if (!wasConnected) close();
return err;
}
ErrorPtr ModbusMaster::readFileRecords(uint16_t aFileNo, uint16_t aFirstRecordNo, uint16_t aNumRecords, uint8_t* aDataP)
{
ErrorPtr err;
bool wasConnected = isConnected();
if (!wasConnected) err = connect();
if (Error::isOK(err)) {
ModBusPDU req;
int reqLen = modbus_build_request_basis(mModbus, MODBUS_FC_READ_FILE_RECORD, req);
int lenIdx = reqLen++;
req[reqLen++] = 0x06; // subrecord reference type
req[reqLen++] = aFileNo>>8;
req[reqLen++] = aFileNo & 0xFF;
req[reqLen++] = aFirstRecordNo>>8;
req[reqLen++] = aFirstRecordNo & 0xFF;
req[reqLen++] = aNumRecords>>8; // aka "record length" in the specs
req[reqLen++] = aNumRecords & 0xFF; // aka "record length" in the specs
uint16_t bytes = aNumRecords*2;
if (reqLen+bytes>MODBUS_MAX_PDU_LENGTH) {
err = Error::err<ModBusError>(EMBBADEXC, "read file record response would exceed PDU size");
}
else {
req[lenIdx] = reqLen-lenIdx-1;
// send the read request
int rc = modbus_send_msg(mModbus, req, reqLen);
if (rc<0) {
err = Error::err<ModBusError>(errno)->withPrefix("sending read file record request: ");
}
else {
ModBusPDU rsp;
int rspLen = modbus_receive_msg(mModbus, rsp, MSG_CONFIRMATION);
if (rspLen<0) {
rc = -1;
}
else if (rspLen>0) {
rc = modbus_pre_check_confirmation(mModbus, req, rsp, rspLen);
if (rc>0) {
if (
(rsp[rc++]!=MODBUS_FC_READ_FILE_RECORD) ||
(rsp[rc++]!=bytes+2) ||
(rsp[rc++]!=bytes+1) ||
(rsp[rc++]!=0x06)
) {
rc = -1;
errno = EMBBADDATA;
}
else {
// get the data
memcpy(aDataP, rsp+rc, bytes);
}
}
}
if (rc<0) {
err = Error::err<ModBusError>(errno)->withPrefix("receiving read file record response: ");
}
}
}
}
if (!wasConnected) close();
return err;
}
// MARK: - ModbusMaster file transfers
#define WRITE_RECORD_RETRIES 3
#define READ_RECORD_RETRIES 3
#define WRITE_RETRY_DELAY (500*MilliSecond)
#define READ_RETRY_DELAY (500*MilliSecond)
#define READ_TIMEDOUT_RETRY_DELAY (10*Second)
ErrorPtr ModbusMaster::sendFile(const string& aLocalFilePath, int aFileNo, bool aUseP44Header)
{
// create a file handler
ModbusFileHandlerPtr handler = ModbusFileHandlerPtr(new ModbusFileHandler(aFileNo, 0, 1, aUseP44Header, aLocalFilePath));
// send the file
OLOG(LOG_NOTICE, "Sending file '%s' to fileNo %d in slave %d", aLocalFilePath.c_str(), aFileNo, getSlaveAddress());
return sendFile(handler, aFileNo);
}
ErrorPtr ModbusMaster::sendFile(ModbusFileHandlerPtr aHandler, int aFileNo)
{
ErrorPtr err;
err = aHandler->openLocalFile(aFileNo, false); // for local read
if (Error::isOK(err)) {
bool wasConnected = isConnected();
if (!wasConnected) err = connect();
if (Error::isOK(err)) {
uint8_t p44hdr[32];
int hdrSz = aHandler->generateP44Header(p44hdr, 32);
if (hdrSz<0) {
err = Error::err<ModBusError>(EMBBADEXC, "cannot generate header");
}
else if (hdrSz>0) {
int retries = WRITE_RECORD_RETRIES;
while (true) {
// we actually have a p44 header, send it
err = writeFileRecords(aFileNo, 0, (hdrSz+1)/2, p44hdr);
if (!isCommErr(err)) break;
retries--;
if (retries<=0) break;
MainLoop::sleep(WRITE_RETRY_DELAY);
modbus_flush(mModbus);
};
}
if (Error::isOK(err)) {
// header sent or none required, now send data
ModBusPDU buf;
uint32_t chunkIndex = 0;
if (Error::isOK(err)) {
while (true) {
uint16_t fileNo, recordNo, recordLen;
if (aHandler->isEOFforChunk(chunkIndex, false)) break; // local EOF reached
aHandler->addressForMaxChunk(chunkIndex, fileNo, recordNo, recordLen);
// get data from local file
err = aHandler->readLocalFile(fileNo, recordNo, buf, recordLen*2);
if (Error::notOK(err)) break;
chunkIndex++;
// write to the remote
int retries = WRITE_RECORD_RETRIES;
while (true) {
err = writeFileRecords(fileNo, recordNo, recordLen, buf);
if (!isCommErr(err)) break;
retries--;
if (retries<=0) break;
MainLoop::sleep(WRITE_RETRY_DELAY);
modbus_flush(mModbus);
}
if (Error::notOK(err)) break;
}
}
}
if (!wasConnected) close();
}
}
return err;
}
ErrorPtr ModbusMaster::receiveFile(const string& aLocalFilePath, int aFileNo, bool aUseP44Header)
{
ErrorPtr err;
bool wasConnected = isConnected();
if (!wasConnected) err = connect();
if (Error::isOK(err)) {
// create a file handler
ModbusFileHandlerPtr handler = ModbusFileHandlerPtr(new ModbusFileHandler(aFileNo, 0, 1, aUseP44Header, aLocalFilePath));
ModBusPDU buf;
if (aUseP44Header) {
// read p44header first
int retries = READ_RECORD_RETRIES;
while (retries--) {
err = readFileRecords(aFileNo, 0, handler->numP44HeaderRecords(), buf);
if (!isCommErr(err)) break;
if (Error::isError(err, ModBusError::domain(), ETIMEDOUT)) {
// extra wait, because this is most likely CRC calculation at the other end
MainLoop::sleep(READ_TIMEDOUT_RETRY_DELAY);
}
MainLoop::sleep(READ_RETRY_DELAY);
modbus_flush(mModbus);
}
if (Error::isOK(err)) {
// "write" header (i.e. set up handler for receiving)
err = handler->writeLocalFile(aFileNo, 0, buf, handler->numP44HeaderRecords()*2);
}
}
if (Error::isOK(err)) {
// header received or none required, now received data
ModBusPDU buf;
uint32_t chunkIndex = 0;
if (Error::isOK(err)) {
while (true) {
uint16_t fileNo, recordNo, recordLen;
if (handler->isEOFforChunk(chunkIndex, true)) break; // remote EOF reached (known via p44Header)
handler->addressForMaxChunk(chunkIndex, fileNo, recordNo, recordLen);
// read from the remote
int retries = READ_RECORD_RETRIES;
while (true) {
err = readFileRecords(fileNo, recordNo, recordLen, buf);
if (!isCommErr(err)) break;
retries--;
if (retries<=0) break;
MainLoop::sleep(READ_RETRY_DELAY);
modbus_flush(mModbus);
}
if (!aUseP44Header && Error::isError(err, ModBusError::domain(), ModBusError::MBErr+MODBUS_EXCEPTION_ILLEGAL_DATA_ADDRESS)) {
// EMBXILADD signals EOF
err.reset();
break;
}
if (Error::notOK(err)) break;
// store data in the local file
err = handler->writeLocalFile(fileNo, recordNo, buf, recordLen*2);
if (Error::notOK(err)) return err;
chunkIndex++;
}
ErrorPtr ferr = handler->finalize();
if (Error::isOK(err)) err = ferr;
}
}
}
if (!wasConnected) close();
return err;
}
ErrorPtr ModbusMaster::broadcastFile(const SlaveAddrList& aSlaveAddrList, const string& aLocalFilePath, int aFileNo, bool aUseP44Header)
{
ErrorPtr err;
bool wasConnected = isConnected();
if (!wasConnected) err = connect();
if (Error::isOK(err)) {
ModbusFileHandlerPtr handler = ModbusFileHandlerPtr(new ModbusFileHandler(aFileNo, 0, 1, aUseP44Header, aLocalFilePath));
if (!aUseP44Header) {
// simple one-by-one transfer, not real broadcast
OLOG(LOG_NOTICE, "Sending file '%s' to fileNo %d in %lu slaves, no broadcast (no p44header)", aLocalFilePath.c_str(), aFileNo, aSlaveAddrList.size());
for (SlaveAddrList::const_iterator pos = aSlaveAddrList.begin(); pos!=aSlaveAddrList.end(); ++pos) {
setSlaveAddress(*pos);
OLOG(LOG_NOTICE, "- sending file to slave %d", *pos);
ErrorPtr fileErr = sendFile(handler, aFileNo);
if (Error::notOK(fileErr)) {
OLOG(LOG_ERR, "Error sending file '%s' to fileNo %d in slave %d: %s", aLocalFilePath.c_str(), aFileNo, *pos, fileErr->text());
err = fileErr; // return most recent error
}
}
}
else {
// with p44header, we can do real broadcast of the data
OLOG(LOG_NOTICE, "Sending file '%s' to fileNo %d as broadcast", aLocalFilePath.c_str(), aFileNo);
setSlaveAddress(MODBUS_BROADCAST_ADDRESS);
err = sendFile(handler, aFileNo);
if (Error::isOK(err)) {
// query each slave for possibly missing records, send them
OLOG(LOG_NOTICE, "Broadcast complete - now verifying successful transmission");
for (SlaveAddrList::const_iterator pos = aSlaveAddrList.begin(); pos!=aSlaveAddrList.end(); ++pos) {
ErrorPtr slerr;
OLOG(LOG_NOTICE, "- Verifying with slave %d", *pos);
setSlaveAddress(*pos);
ModBusPDU buf;
while (true) {
// read p44header
int retries = READ_RECORD_RETRIES;
while (retries--) {
slerr = readFileRecords(aFileNo, 0, handler->numP44HeaderRecords(), buf);
if (!isCommErr(slerr)) break;
if (Error::isError(slerr, ModBusError::domain(), ETIMEDOUT)) {
// extra wait, because this is most likely CRC calculation at the other end
MainLoop::sleep(READ_TIMEDOUT_RETRY_DELAY);
}
MainLoop::sleep(READ_RETRY_DELAY);
modbus_flush(mModbus);
}
if (Error::notOK(slerr)) break; // failed, done with this slave
// retransmit failed block, if any
slerr = handler->parseP44Header(buf, 0, MODBUS_MAX_PDU_LENGTH, false);
if (Error::notOK(slerr)) break; // failed, done with this slave
uint16_t fileNo, recordNo, recordLen;
if (handler->addrForNextRetransmit(fileNo, recordNo, recordLen)) {
// retransmit that block
handler->readLocalFile(fileNo, recordNo, buf, recordLen*2);
retries = WRITE_RECORD_RETRIES;
while (retries--) {
slerr = writeFileRecords(fileNo, recordNo, recordLen, buf);
if (!isCommErr(slerr)) break;
MainLoop::sleep(WRITE_RETRY_DELAY);
modbus_flush(mModbus);
}
if (Error::notOK(slerr)) break; // failed, done with this slave
}
else {
// no more retransmits pending for this slave
if (handler->fileIntegrityOK()) {
OLOG(LOG_NOTICE, "- Sending file '%s' to fileNo %d in slave %d confirmed SUCCESSFUL!", aLocalFilePath.c_str(), aFileNo, *pos);
}
else {
err = Error::err<ModBusError>(EMBBADCRC, "CRC or size mismatch after retransmitting all blocks");
}
break; // done with this slave
}
} // while bad blocks
if (slerr) {
OLOG(LOG_ERR, "Failed sending file No %d in slave %d: %s", aFileNo, *pos, slerr->text());
err = slerr->withPrefix("Slave %d: ", *pos);
}
} // for all slaves
} // if broadcast ok
} // if p44header mode
}
if (!wasConnected) close();
return err;
}
// MARK: - ModbusSlave