-
Notifications
You must be signed in to change notification settings - Fork 0
/
ModbusTCP_IP.cpp
512 lines (412 loc) · 19.8 KB
/
ModbusTCP_IP.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
//---------------------------------------------------------------------------
#if defined(__BORLANDC__)
#pragma hdrstop
#endif
#include <algorithm>
#include "Modbus.h"
#include "ModbusTCP_IP.h"
#define MODBUS_TCP_IP_BMAP_TRANSACTION_ID_OFFSET 0
#define MODBUS_TCP_IP_BMAP_PROTOCOL_OFFSET 2
#define MODBUS_TCP_IP_BMAP_DATA_LENGTH_OFFSET 4
#define MODBUS_TCP_IP_BMAP_UNIT_ID_OFFSET 6
#define MODBUS_TCP_IP_REPLY_FUNCTION_CODE_OFFSET 0
#define MODBUS_TCP_IP_REPLY_EXCEPTION_CODE_OFFSET 1
#define MODBUS_TCP_IP_REPLY_DATA_OFFSET 1
using std::min;
//---------------------------------------------------------------------------
namespace Modbus {
//---------------------------------------------------------------------------
namespace Master {
//---------------------------------------------------------------------------
String TCPIPProtocol::GetHost() const
{
return DoGetHost();
}
//---------------------------------------------------------------------------
void TCPIPProtocol::SetHost( String Val )
{
RaiseExceptionIfIsConnected( _T( "Unable to change host" ) );
DoSetHost( Val );
}
//---------------------------------------------------------------------------
uint16_t TCPIPProtocol::GetPort() const
{
return DoGetPort();
}
//---------------------------------------------------------------------------
void TCPIPProtocol::SetPort( uint16_t Val )
{
RaiseExceptionIfIsConnected( _T( "Unable to change port" ) );
DoSetPort( Val );
}
//---------------------------------------------------------------------------
void TCPIPProtocol::RaiseExceptionIfBMAPIsNotValid( Context const & Context,
TBytes const Buffer )
{
if ( GetLength( Buffer ) < GetBMAPHeaderLength() ) {
throw EContextException( Context, _T( "Invalid BMAP length" ) );
}
}
//---------------------------------------------------------------------------
void TCPIPProtocol::RaiseExceptionIfBMAPIsNotEQ( Context const & Context,
TBytes const LBuffer,
TBytes const RBuffer )
{
RaiseExceptionIfBMAPIsNotValid( Context, LBuffer );
RaiseExceptionIfBMAPIsNotValid( Context, RBuffer );
if ( GetBMAPTransactionIdentifier( LBuffer ) != GetBMAPTransactionIdentifier( RBuffer ) ) {
throw EContextException( Context, _T( "Invalid BMAP Transaction Identifier" ) );
}
BMAPProtocolType const LBMAPProtocol = GetBMAPProtocol( LBuffer );
if ( LBMAPProtocol != GetBMAPProtocol( RBuffer ) || LBMAPProtocol ) {
throw EContextException( Context, _T( "Invalid BMAP Protocol" ) );
}
if ( GetBMAPUnitIdentifier( LBuffer ) != GetBMAPUnitIdentifier( RBuffer ) ) {
throw EContextException( Context, _T( "Invalid BMAP Unit Identifier" ) );
}
}
//---------------------------------------------------------------------------
void TCPIPProtocol::RaiseExceptionIfReplyIsNotValid( Context const & Context,
TBytes const Buffer,
FunctionCode ExpectedFunctionCode )
{
if ( GetLength( Buffer ) > 1 ) {
FunctionCode const FnCode = GetFunctionCode( Buffer );
if ( static_cast<int>( FnCode ) & 0x80 ) {
RaiseStandardException( Context, GetExceptCode( Buffer ) );
}
else if ( FnCode != ExpectedFunctionCode ) {
throw EContextException(
Context,
Format(
_T( "Invalid Function Code: expected 0x%.2X, read 0x%.2X" )
, ARRAYOFCONST( (
( static_cast<int>( ExpectedFunctionCode ) & 0xFF ),
( static_cast<int>( FnCode ) & 0xFF )
) )
)
);
}
}
else {
throw EContextException( Context, _T( "reply is too short" ) );
}
}
//---------------------------------------------------------------------------
FunctionCode TCPIPProtocol::GetFunctionCode( TBytes const Buffer )
{
return FunctionCode( Buffer[MODBUS_TCP_IP_REPLY_FUNCTION_CODE_OFFSET] );
}
//---------------------------------------------------------------------------
ExceptionCode TCPIPProtocol::GetExceptCode( TBytes const Buffer )
{
return ExceptionCode( Buffer[MODBUS_TCP_IP_REPLY_EXCEPTION_CODE_OFFSET] );
}
//---------------------------------------------------------------------------
TCPIPProtocol::BMAPDataLengthType TCPIPProtocol::GetDataLength( TBytes const Buffer )
{
return Buffer[MODBUS_TCP_IP_REPLY_DATA_OFFSET];
}
//---------------------------------------------------------------------------
TCPIPProtocol::BMAPTransactionIdType TCPIPProtocol::GetBMAPTransactionIdentifier(
TBytes const Buffer )
{
int const Idx = MODBUS_TCP_IP_BMAP_TRANSACTION_ID_OFFSET;
return ( static_cast<BMAPTransactionIdType>( Buffer[Idx] ) << 8 ) |
( static_cast<BMAPTransactionIdType>( Buffer[Idx + 1] ) & 0xFF );
}
//---------------------------------------------------------------------------
TCPIPProtocol::BMAPProtocolType TCPIPProtocol::GetBMAPProtocol(
TBytes const Buffer )
{
const int Idx = MODBUS_TCP_IP_BMAP_PROTOCOL_OFFSET;
return ( static_cast<BMAPProtocolType>( Buffer[Idx] << 8 ) ) |
( static_cast<BMAPProtocolType>( Buffer[Idx + 1] & 0xFF ) );
}
//---------------------------------------------------------------------------
TCPIPProtocol::BMAPDataLengthType TCPIPProtocol::GetBMAPDataLength(
TBytes const Buffer )
{
const int Idx = MODBUS_TCP_IP_BMAP_DATA_LENGTH_OFFSET;
return ( static_cast<BMAPDataLengthType>( Buffer[Idx] << 8 ) ) |
( static_cast<BMAPDataLengthType>( Buffer[Idx + 1] & 0xFF ) );
}
//---------------------------------------------------------------------------
TCPIPProtocol::BMAPUnitIdType TCPIPProtocol::GetBMAPUnitIdentifier(
TBytes const Buffer )
{
return Buffer[MODBUS_TCP_IP_BMAP_UNIT_ID_OFFSET];
}
//---------------------------------------------------------------------------
int TCPIPProtocol::WriteBMAPHeader( TBytes & OutBuffer, int StartIdx,
Context const & Context )
{
/*-----------------------------------------------------------------------*/
/* BMAP */
/*-------------------------+-----+---------------------------------------*/
/* Field | Len | Description */
/*-------------------------+-----+---------------------------------------*/
/* Transaction Identifier | 2 | Identification of a MODBUS */
/* | | Request / Response transaction */
/*-------------------------+-----+---------------------------------------*/
/* Protocol Identifier | 2 | 0 = MODBUS protocol */
/*-------------------------+-----+---------------------------------------*/
/* Length | 2 | Number of following bytes */
/*-------------------------+-----+---------------------------------------*/
/* Unit Identifier | 1 | Identification of a remote slave con- */
/* | | nected on a serial line or on other */
/* | | buses */
/*-------------------------+-----+---------------------------------------*/
BMAPTransactionIdType const TransactionId = Context.GetTransactionIdentifier();
OutBuffer[StartIdx++] = ( TransactionId >> 8 ) & 0xFF; // Transaction Identifier Lo
OutBuffer[StartIdx++] = TransactionId & 0xFF; // Transaction Identifier Hi
OutBuffer[StartIdx++] = 0x00; // Protocol Identifier Lo
OutBuffer[StartIdx++] = 0x00; // Protocol Identifier Hi
BMAPDataLengthType const PayloadLength = GetLength( OutBuffer ) - 6;
OutBuffer[StartIdx++] = ( PayloadLength >> 8 ) & 0xFF; // Length Lo
OutBuffer[StartIdx++] = PayloadLength & 0xFF; // Length Hi
OutBuffer[StartIdx++] = Context.GetSlaveAddr(); // Unit Identifier
return StartIdx;
}
//---------------------------------------------------------------------------
int TCPIPProtocol::WriteAddressPointCountPair( TBytes & OutBuffer,
int StartIdx,
RegAddrType StartAddr,
RegCountType PointCount )
{
OutBuffer[StartIdx++] = ( StartAddr >> 8 ) & 0xFF; // Starting Address Hi
OutBuffer[StartIdx++] = StartAddr & 0xFF; // Starting Address Lo
OutBuffer[StartIdx++] = ( PointCount >> 8 ) & 0xFF; // No. of Points Hi
OutBuffer[StartIdx++] = PointCount & 0xFF; // No. of Points Lo
return StartIdx;
}
//---------------------------------------------------------------------------
int TCPIPProtocol::WriteData( TBytes & OutBuffer,
int StartIdx, RegAddrType Data )
{
OutBuffer[StartIdx++] = ( Data >> 8 ) & 0xFF; // Data Hi
OutBuffer[StartIdx++] = Data & 0xFF; // Data Lo
return StartIdx;
}
//---------------------------------------------------------------------------
void TCPIPProtocol::CopyDataWord( Context const & Context, TBytes const Buffer,
int BufferOffset, uint16_t* Data )
{
int DataLength = GetPayloadLength( Context, Buffer, BufferOffset );
for ( int Idx = BufferOffset + 1 ; DataLength ; DataLength -= 2 ) {
*Data++ = ( (uint16_t)Buffer[Idx] << 8 ) | ( (uint16_t)Buffer[Idx + 1] & 0xFF );
Idx += 2;
}
}
//---------------------------------------------------------------------------
int TCPIPProtocol::GetPayloadLength( Context const & Context,
TBytes const Buffer,
int BufferOffset )
{
int const DataLength = GetDataLength( Buffer );
if ( ( GetLength( Buffer ) - 2 != DataLength ) ||
( ~( GetLength( Buffer ) - BufferOffset ) & 1 ) )
{
throw EContextException(
Context,
Format(
_T( "Invalid received frame lenght %d" )
, ARRAYOFCONST( (
DataLength
) )
)
);
}
return DataLength;
}
//---------------------------------------------------------------------------
String TCPIPProtocol::DoGetProtocolParamsStr() const
{
return Format( _T( "%s:%u" ), ARRAYOFCONST( ( GetHost(), GetPort() ) ) );
}
//---------------------------------------------------------------------------
// TCPIPProtocol::DoReadCoilStatus
//---------------------------------------------------------------------------
// TCPIPProtocol::DoReadInputStatus
//---------------------------------------------------------------------------
void TCPIPProtocol::ReadRegisters( FunctionCode FnCode, Context const & Context,
RegAddrType StartAddr, RegCountType PointCount,
RegDataType* Data )
{
// Send
TBytes OutBuffer;
SetLength( OutBuffer, GetBMAPHeaderLength() + 1 + GetAddressPointCountPairLength() );
int Idx = WriteBMAPHeader( OutBuffer, 0, Context );
OutBuffer[Idx++] = static_cast<RegDataType>( FnCode );
Idx = WriteAddressPointCountPair( OutBuffer, Idx, StartAddr, PointCount );
DoInputBufferClear();
DoWrite( OutBuffer );
// Receive
TBytes ReplyBMAPBuffer;
SetLength( ReplyBMAPBuffer, GetBMAPHeaderLength() );
DoRead( ReplyBMAPBuffer, GetLength( ReplyBMAPBuffer ) );
// Verifica BMAP di risposta
RaiseExceptionIfBMAPIsNotEQ( Context, OutBuffer, ReplyBMAPBuffer );
TBytes ReplyBuffer;
SetLength( ReplyBuffer, GetBMAPDataLength( ReplyBMAPBuffer ) - 1 );
DoRead( ReplyBuffer, GetLength( ReplyBuffer ) );
// Verifica parametri di risposta
RaiseExceptionIfReplyIsNotValid( Context, ReplyBuffer, FnCode );
CopyDataWord( Context, ReplyBuffer, MODBUS_TCP_IP_REPLY_DATA_OFFSET, Data );
}
//---------------------------------------------------------------------------
void TCPIPProtocol::DoReadHoldingRegisters( Context const & Context,
RegAddrType StartAddr,
RegCountType PointCount,
RegDataType* Data )
{
RaiseExceptionIfIsNotConnected( _T( "ReadHoldingRegisters failed" ) );
ReadRegisters( FunctionCode::ReadHoldingRegisters, Context, StartAddr,
PointCount, Data );
}
//---------------------------------------------------------------------------
void TCPIPProtocol::DoReadInputRegisters( Context const & Context,
RegAddrType StartAddr,
RegCountType PointCount,
RegDataType* Data )
{
RaiseExceptionIfIsNotConnected( _T( "ReadInputRegisters failed" ) );
ReadRegisters( FunctionCode::ReadInputRegisters, Context, StartAddr,
PointCount, Data );
}
//---------------------------------------------------------------------------
// TCPIPProtocol::DoForceSingleCoil
//---------------------------------------------------------------------------
// TCPIPProtocol::DoPresetSingleRegister
void TCPIPProtocol::DoPresetSingleRegister( Context const & Context,
RegAddrType Addr, RegDataType Data )
{
RaiseExceptionIfIsNotConnected( _T( "PresetSingleRegister failed" ) );
// Send
TBytes OutBuffer;
SetLength( OutBuffer, GetBMAPHeaderLength() + 1 + 2 + 2 );
int Idx = WriteBMAPHeader( OutBuffer, 0, Context );
OutBuffer[Idx++] =
static_cast<RegDataType>( FunctionCode::PresetSingleRegister );
Idx = WriteData( OutBuffer, Idx, Addr );
Idx = WriteData( OutBuffer, Idx, Data );
DoInputBufferClear();
DoWrite( OutBuffer );
// Receive
TBytes ReplyBMAPBuffer;
SetLength( ReplyBMAPBuffer, GetBMAPHeaderLength() );
DoRead( ReplyBMAPBuffer, GetLength( ReplyBMAPBuffer ) );
// Verifica BMAP di risposta
RaiseExceptionIfBMAPIsNotEQ( Context, OutBuffer, ReplyBMAPBuffer );
TBytes ReplyBuffer;
SetLength( ReplyBuffer, GetBMAPDataLength( ReplyBMAPBuffer ) - 1 );
DoRead( ReplyBuffer, GetLength( ReplyBuffer ) );
// Verifica parametri di risposta
RaiseExceptionIfReplyIsNotValid( Context, ReplyBuffer, FunctionCode::PresetSingleRegister );
}
//---------------------------------------------------------------------------
// TCPIPProtocol::DoReadExceptionStatus
//---------------------------------------------------------------------------
// TCPIPProtocol::DoDiagnostics
//---------------------------------------------------------------------------
// TCPIPProtocol::DoProgram484
//---------------------------------------------------------------------------
// TCPIPProtocol::DoPoll484
//---------------------------------------------------------------------------
// TCPIPProtocol::DoFetchCommEventCtr
//---------------------------------------------------------------------------
// TCPIPProtocol::DoFetchCommEventLog
//---------------------------------------------------------------------------
// TCPIPProtocol::DoProgramController
//---------------------------------------------------------------------------
// TCPIPProtocol::DoPollController
//---------------------------------------------------------------------------
// TCPIPProtocol::DoForceMultipleCoils
//---------------------------------------------------------------------------
void TCPIPProtocol::DoPresetMultipleRegisters( Context const & Context,
RegAddrType StartAddr,
RegCountType PointCount,
RegDataType const * Data )
{
RaiseExceptionIfIsNotConnected( _T( "PresetMultipleRegister failed" ) );
// Send
TBytes OutBuffer;
SetLength(
OutBuffer,
GetBMAPHeaderLength() + GetAddressPointCountPairLength() +
PointCount * sizeof( RegDataType ) + 2
);
int Idx = WriteBMAPHeader( OutBuffer, 0, Context );
OutBuffer[Idx++] =
static_cast<RegDataType>( FunctionCode::PresetMultipleRegisters );
Idx = WriteAddressPointCountPair( OutBuffer, Idx, StartAddr, PointCount );
OutBuffer[Idx++] = PointCount * sizeof( RegDataType );
for ( RegCountType DataIdx = 0 ; DataIdx < PointCount ; ++DataIdx ) {
const RegDataType Reg = Data[DataIdx];
OutBuffer[Idx++] = ( Reg >> 8 ) & 0xFF; // Data Hi
OutBuffer[Idx++] = Reg & 0xFF; // Data Lo
}
DoInputBufferClear();
DoWrite( OutBuffer );
// Receive
TBytes ReplyBMAPBuffer;
SetLength( ReplyBMAPBuffer, GetBMAPHeaderLength() );
DoRead( ReplyBMAPBuffer, GetLength( ReplyBMAPBuffer ) );
// Verifica BMAP di risposta
RaiseExceptionIfBMAPIsNotEQ( Context, OutBuffer, ReplyBMAPBuffer );
TBytes ReplyBuffer;
SetLength( ReplyBuffer, GetBMAPDataLength( ReplyBMAPBuffer ) - 1 );
DoRead( ReplyBuffer, GetLength( ReplyBuffer ) );
// Verifica parametri di risposta
RaiseExceptionIfReplyIsNotValid( Context, ReplyBuffer, FunctionCode::PresetMultipleRegisters );
}
//---------------------------------------------------------------------------
// TCPIPProtocol::DoReportSlave
//---------------------------------------------------------------------------
// TCPIPProtocol::DoProgram884_M84
//---------------------------------------------------------------------------
// TCPIPProtocol::DoResetCommLink
//---------------------------------------------------------------------------
// TCPIPProtocol::DoReadGeneralReference
//---------------------------------------------------------------------------
// TCPIPProtocol::DoWriteGeneralReference
//---------------------------------------------------------------------------
// TCPIPProtocol::DoMaskWrite4XRegister
void TCPIPProtocol::DoMaskWrite4XRegister( Context const & Context,
RegAddrType Addr,
RegDataType AndMask,
RegDataType OrMask )
{
RaiseExceptionIfIsNotConnected( _T( "MaskWrite4XRegister failed" ) );
// Send
TBytes OutBuffer;
SetLength( OutBuffer, GetBMAPHeaderLength() + 1 + 2 + 2 + 2 );
int Idx = WriteBMAPHeader( OutBuffer, 0, Context );
OutBuffer[Idx++] =
static_cast<RegDataType>( FunctionCode::MaskWrite4XRegister );
Idx = WriteData( OutBuffer, Idx, Addr );
Idx = WriteData( OutBuffer, Idx, AndMask );
Idx = WriteData( OutBuffer, Idx, OrMask );
DoInputBufferClear();
DoWrite( OutBuffer );
// Receive
TBytes ReplyBMAPBuffer;
SetLength( ReplyBMAPBuffer, GetBMAPHeaderLength() );
DoRead( ReplyBMAPBuffer, GetLength( ReplyBMAPBuffer ) );
// Verifica BMAP di risposta
RaiseExceptionIfBMAPIsNotEQ( Context, OutBuffer, ReplyBMAPBuffer );
TBytes ReplyBuffer;
SetLength( ReplyBuffer, GetBMAPDataLength( ReplyBMAPBuffer ) - 1 );
DoRead( ReplyBuffer, GetLength( ReplyBuffer ) );
// Verifica parametri di risposta
RaiseExceptionIfReplyIsNotValid( Context, ReplyBuffer, FunctionCode::MaskWrite4XRegister );
}
//---------------------------------------------------------------------------
// TCPIPProtocol::DoReadWrite4XRegisters
//---------------------------------------------------------------------------
// TCPIPProtocol::DoReadFIFOQueue
//---------------------------------------------------------------------------
}; // End of namespace Master
//---------------------------------------------------------------------------
}; // End of namespace Modbus
//---------------------------------------------------------------------------