-
Notifications
You must be signed in to change notification settings - Fork 1
/
Settimino.h
256 lines (226 loc) · 9.75 KB
/
Settimino.h
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
/*=============================================================================|
| PROJECT SETTIMINO 2.0.0 |
|==============================================================================|
| Copyright (C) 2013, 2019 Davide Nardella |
| All rights reserved. |
|==============================================================================|
| SETTIMINO is free software: you can redistribute it and/or modify |
| it under the terms of the Lesser GNU General Public License as published by |
| the Free Software Foundation, either version 3 of the License, or |
| (at your option) any later version. |
| |
| It means that you can distribute your commercial software linked with |
| SETTIMINO without the requirement to distribute the source code of your |
| application and without the requirement that your application be itself |
| distributed under LGPL. |
| |
| SETTIMINO 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 |
| Lesser GNU General Public License for more details. |
| |
| You should have received a copy of the GNU General Public License and a |
| copy of Lesser GNU General Public License along with Snap7. |
| If not, see http://www.gnu.org/licenses/ |
|------------------------------------------------------------------------------|
| |
| 1.1.0 Added support for ESP8266 (Thanks to Geoffrey Hayward Piggot) |
| 2.0.0 Added new hardware support |
| Added Read/Write consistent bit into the CPU |
| Added new 18 helper functions |
| Small bugfixes (Thanks to Daniel Förstmann and Schöneberg Swen) |
| |
|=============================================================================*/
#ifndef SETTIMINO_H
#define SETTIMINO_H
#include "Platform.h"
// Memory models
//#define _SMALL
//#define _NORMAL
#define _EXTENDED
#if defined(_NORMAL) || defined(_EXTENDED)
# define _S7HELPER
#endif
#pragma pack(1)
// Error Codes
// from 0x0001 up to 0x00FF are severe errors, the Client should be disconnected
// from 0x0100 are S7 Errors such as DB not found or address beyond the limit etc..
// For Arduino Due the error code is a 32 bit integer but this doesn't change the constants use.
#define errTCPConnectionFailed 0x0001
#define errTCPConnectionReset 0x0002
#define errTCPDataRecvTout 0x0003
#define errTCPDataSend 0x0004
#define errTCPDataRecv 0x0005
#define errISOConnectionFailed 0x0006
#define errISONegotiatingPDU 0x0007
#define errISOInvalidPDU 0x0008
#define errS7InvalidPDU 0x0100
#define errS7SendingPDU 0x0200
#define errS7DataRead 0x0300
#define errS7DataWrite 0x0400
#define errS7Function 0x0500
#define errBufferTooSmall 0x0600
// Connection Type
#define PG 0x01
#define OP 0x02
#define S7_Basic 0x03
// ISO and PDU related constants
#define ISOSize 7 // Size of TPKT + COTP Header
#define isotcp 102 // ISOTCP Port
#define MinPduSize 16 // Minimum S7 valid telegram size
#define MaxPduSize 247 // Maximum S7 valid telegram size (we negotiate 240 bytes + ISOSize)
#define CC 0xD0 // Connection confirm
#define Shift 17 // We receive data 17 bytes above to align with PDU.DATA[]
// S7 ID Area (Area that we want to read/write)
#define S7AreaPE 0x81
#define S7AreaPA 0x82
#define S7AreaMK 0x83
#define S7AreaDB 0x84
#define S7AreaCT 0x1C
#define S7AreaTM 0x1D
// WordLength
#define S7WLBit 0x01
#define S7WLByte 0x02
#define S7WLWord 0x04
#define S7WLDWord 0x06
#define S7WLReal 0x08
#define S7WLCounter 0x1C
#define S7WLTimer 0x1D
#define TS_ResBit 0x03
#define TS_ResByte 0x04
#define TS_ResInt 0x05
#define TS_ResReal 0x07
#define TS_ResOctet 0x09
const byte S7CpuStatusUnknown = 0x00;
const byte S7CpuStatusRun = 0x08;
const byte S7CpuStatusStop = 0x04;
#define RxOffset 18
#define Size_RD 31
#define Size_WR 35
//typedef uint16_t word; // 16 bit unsigned integer
typedef int16_t integer; // 16 bit signed integer
typedef unsigned long dword; // 32 bit unsigned integer
typedef long dint; // 32 bit signed integer
typedef byte *pbyte;
typedef word *pword;
typedef dword *pdword;
typedef integer *pinteger;
typedef dint *pdint;
typedef float *pfloat;
typedef char *pchar;
typedef union{
struct {
byte H[Size_WR]; // PDU Header
byte DATA[MaxPduSize-Size_WR+Shift]; // PDU Data
};
byte RAW[MaxPduSize+Shift];
}TPDU;
#pragma pack()
#ifdef _S7HELPER
class S7Helper
{
public:
bool BitAt(void *Buffer, int ByteIndex, byte BitIndex);
bool BitAt(int ByteIndex, int BitIndex);
byte ByteAt(void *Buffer, int index);
byte ByteAt(int index);
word WordAt(void *Buffer, int index);
word WordAt(int index);
dword DWordAt(void *Buffer, int index);
dword DWordAt(int index);
float FloatAt(void *Buffer, int index);
float FloatAt(int index);
integer IntegerAt(void *Buffer, int index);
integer IntegerAt(int index);
long DintAt(void *Buffer, int index);
long DintAt(int index);
// New 2.0
void SetBitAt(void *Buffer, int ByteIndex, int BitIndex, bool Value);
void SetBitAt(int ByteIndex, int BitIndex, bool Value);
void SetByteAt(void *Buffer, int index, byte value);
void SetByteAt(int index, byte value);
void SetIntAt(void *Buffer, int index, integer value);
void SetIntAt(int index, integer value);
void SetDIntAt(void *Buffer, int index, dint value);
void SetDIntAt(int index, dint value);
void SetWordAt(void *Buffer, int index, word value);
void SetWordAt(int index, word value);
void SetDWordAt(void *Buffer, int index, dword value);
void SetDWordAt(int index, word value);
void SetFloatAt(void *Buffer, int index, float value);
void SetFloatAt(int index, float value);
char * StringAt(void *Buffer, int index);
char * StringAt(int index);
void SetStringAt(void *Buffer, int index, char *value);
void SetStringAt(int index, char *value);
};
extern S7Helper S7;
#endif // _S7HELPER
//-----------------------------------------------------------------------------
// Ethernet initialization
//-----------------------------------------------------------------------------
void EthernetInit(uint8_t *mac, IPAddress ip);
//-----------------------------------------------------------------------------
// S7 Client
//-----------------------------------------------------------------------------
class S7Client
{
private:
uint8_t LocalTSAP_HI;
uint8_t LocalTSAP_LO;
uint8_t RemoteTSAP_HI;
uint8_t RemoteTSAP_LO;
uint8_t LastPDUType;
uint16_t ConnType;
IPAddress Peer;
// Since we can use either an EthernetClient or a WifiClient
// we have to create the class as an ancestor and then resolve
// the inherited into S7Client creator.
Client *TCPClient;
int PDULength; // PDU Length negotiated
int IsoPduSize();
int WaitForData(uint16_t Size, uint16_t Timeout);
int RecvISOPacket(uint16_t *Size);
int RecvPacket(uint8_t *buf, uint16_t Size);
int TCPConnect();
int ISOConnect();
int NegotiatePduLength();
int SetLastError(int Error);
public:
// Output properties
bool Connected; // true if the Client is connected
int LastError; // Last Operation error
// Input properties
uint16_t RecvTimeout; // Receving timeour
// Methods
//S7Client();
S7Client();
S7Client(int Media) : S7Client(){}; // Compatibility V1.X
~S7Client();
// Basic functions
void SetConnectionParams(IPAddress Address, uint16_t LocalTSAP, uint16_t RemoteTSAP);
void SetConnectionType(uint16_t ConnectionType);
int ConnectTo(IPAddress Address, uint16_t Rack, uint16_t Slot);
int Connect();
void Disconnect();
int ReadArea(int Area, uint16_t DBNumber, uint16_t Start, uint16_t Amount, void *ptrData);
int ReadArea(int Area, uint16_t DBNumber, uint16_t Start, uint16_t Amount, int WordLen, void *ptrData);
int ReadBit(int Area, uint16_t DBNumber, uint16_t BitStart, bool &Bit);
int WriteArea(int Area, uint16_t DBNumber, uint16_t Start, uint16_t Amount, void *ptrData);
int WriteArea(int Area, uint16_t DBNumber, uint16_t Start, uint16_t Amount, int WordLen, void *ptrData);
int WriteBit(int Area, uint16_t DBNumber, uint16_t BitIndex, bool Bit);
int WriteBit(int Area, uint16_t DBNumber, uint16_t ByteIndex, uint16_t BitInByte, bool Bit);
int GetPDULength(){ return PDULength; }
// Extended functions
#ifdef _EXTENDED
int GetDBSize(uint16_t DBNumber, uint16_t *Size);
int DBGet(uint16_t DBNumber, void *ptrData, uint16_t *Size);
int PlcStart(); // Warm start
int PlcStop();
int GetPlcStatus(int *Status);
int IsoExchangeBuffer(uint16_t *Size);
void ErrorText(int Error, char *Text, int TextLen);
#endif
};
extern TPDU PDU;
#endif // SETTIMINO_H