s7-client 0.1.2

copt protocols
Documentation
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
use std::io;
use thiserror::Error;

#[derive(Debug, Error)]
pub enum Error {
    #[error(transparent)]
    IoErr(#[from] io::Error),

    #[error(transparent)]
    TpktErr(#[from] tpkt::Error),

    #[error("Error: {0}")]
    Err(String),

    #[error("WriteTimeout")]
    WriteTimeout,

    #[error("ReadTimeout")]
    ReadTimeout,

    #[error("Error: {0}")]
    ConnectErr(String),

    #[error("InvalidBitAddr: {0}")]
    InvalidBitAddr(u16),
}

pub type Result<T> =
    std::result::Result<T, Error>;

// impl<T: TryFromPrimitive>
// From<TryFromPrimitiveError<T>> for Error {
//     fn from(value: TryFromPrimitiveError<T>) ->
// Self {         Self::Error(format!("{}",
// value))     }
// }
//
// impl ToCoptError for Error {
//     fn to_err(self) -> copt::error::Error {
//         copt::error::Error::Error(self.
// to_string())     }
// }

// Copyright 2019 Petar Dambovaliev. All rights
// reserved. This software may be modified and
// distributed under the terms of the BSD license.
// See the LICENSE file for details.

use std::{
    error, fmt,
    io::{Error as IOError, ErrorKind},
};

const TCP_SOCKET_CREATION: i32 = 1;
const TCP_CONNECTION_TIMEOUT: i32 = 2;
const TCP_CONNECTION_FAILED: i32 = 3;
const TCP_RECEIVE_TIMEOUT: i32 = 4;
const TCP_DATA_RECEIVE: i32 = -5;
const TCP_SEND_TIMEOUT: i32 = 0x00000006;
const TCP_DATA_SEND: i32 = 0x00000007;
const TCP_CONNECTION_RESET: i32 = 0x00000008;
const TCP_NOT_CONNECTED: i32 = 0x00000009;
const TCP_UNREACHALE_HOST: i32 = 0x00002751;

const ISO_CONNECT: i32 = 0x00010000;
pub(crate) const ISO_INVALID_PDU: i32 =
    0x00030000; // Bad format
pub(crate) const ISO_INVALID_DATA_SIZE: i32 =
    0x00040000;

pub(crate) const CLI_NEGOTIATING_PDU: i32 =
    0x00100000;
const CLI_INVALID_PARAMS: i32 = 0x00200000;
const CLI_JOB_PENDING: i32 = 0x00300000;
const CLI_TOO_MANY_ITEMS: i32 = 0x00400000;
const CLI_INVALID_DWORD_LEN: i32 = 0x00500000;
const CLI_PARTIAL_DATA_WRITTEN: i32 = 0x00600000;
const CLI_SIZE_OVER_PDU: i32 = 0x00700000;
pub(crate) const CLI_INVALID_PLC_ANSWER: i32 =
    0x00800000;
const CLI_ADDRESS_OUT_OF_RANGE: i32 = 0x00900000;
const CLI_INVALID_TRANSPORT_SIZE: i32 =
    0x00A00000;
const CLI_WRITE_DATA_SIZE_MISMATCH: i32 =
    0x00B00000;
const CLI_ITEM_NOT_AVAILABLE: i32 = 0x00C00000;
const CLI_INVALID_VALUE: i32 = 0x00D00000;
pub(crate) const CLI_CANNOT_START_PLC: i32 =
    0x00E00000;
pub(crate) const CLI_ALREADY_RUN: i32 =
    0x00F00000;
pub(crate) const CLI_CANNOT_STOP_PLC: i32 =
    0x01000000;
const CLI_CANNOT_COPY_RAM_TO_ROM: i32 =
    0x01100000;
const CLI_CANNOT_COMPRESS: i32 = 0x01200000;
pub(crate) const CLI_ALREADY_STOP: i32 =
    0x01300000;
const CLI_FUN_NOT_AVAILABLE: i32 = 0x01400000;
const CLI_UPLOAD_SEQUENCE_FAILED: i32 =
    0x01500000;
const CLI_INVALID_DATA_SIZE_RECVD: i32 =
    0x01600000;
const CLI_INVALID_BLOCK_TYPE: i32 = 0x01700000;
const CLI_INVALID_BLOCK_NUMBER: i32 = 0x01800000;
const CLI_INVALID_BLOCK_SIZE: i32 = 0x01900000;
const CLI_NEED_PASSWORD: i32 = 0x01D00000;
const CLI_INVALID_PASSWORD: i32 = 0x01E00000;
const CLI_NO_PASSWORD_TO_SET_OR_CLEAR: i32 =
    0x01F00000;
const CLI_JOB_TIMEOUT: i32 = 0x02000000;
const CLI_PARTIAL_DATA_READ: i32 = 0x02100000;
const CLI_BUFFER_TOO_SMALL: i32 = 0x02200000;
const CLI_FUNCTION_REFUSED: i32 = 0x02300000;
const CLI_DESTROYING: i32 = 0x02400000;
const CLI_INVALID_PARAM_NUMBER: i32 = 0x02500000;
const CLI_CANNOT_CHANGE_PARAM: i32 = 0x02600000;
const CLI_FUNCTION_NOT_IMPLEMENTED: i32 =
    0x02700000;

const CODE_7_ADDRESS_OUT_OF_RANGE: i32 = 5;
const CODE_7_INVALID_TRANSPORT_SIZE: i32 = 6;
const CODE_7_WRITE_DATA_SIZE_MISMATCH: i32 = 7;
const CODE_7_RES_ITEM_NOT_AVAILABLE: i32 = 10;
const CODE_7_RES_ITEM_NOT_AVAILABLE1: i32 = 53769;
const CODE_7_INVALID_VALUE: i32 = 56321;
const CODE_7_NEED_PASSWORD: i32 = 53825;
const CODE_7_INVALID_PASSWORD: i32 = 54786;
const CODE_7_NO_PASSWORD_TO_CLEAR: i32 = 54788;
const CODE_7_NO_PASSWORD_TO_SET: i32 = 54789;
const CODE_7_FUN_NOT_AVAILABLE: i32 = 33028;
const CODE_7_DATA_OVER_PDU: i32 = 34048;

#[derive(Debug)]
pub enum S7ConnectError {
    ConnectFail(String),
    Lock,
    IOError(ErrorKind),
    Response {
        code: i32,
    },
    CPU {
        code: i32,
    },
    InvalidInput {
        input: String,
    },
    Send,
    Iso,
    PduLength(u16),
    TryFrom(Vec<u8>, String),
    InvalidCpuStatus(u8),
    InvalidResponse {
        reason: String,
        bytes: Vec<u8>,
    },
}

impl fmt::Display for S7ConnectError {
    fn fmt(
        &self,
        f: &mut fmt::Formatter,
    ) -> fmt::Result {
        match self {
            S7ConnectError::ConnectFail(s) => {
                write!(
                    f,
                    "connection error: {}",
                    s
                )
            },
            S7ConnectError::Lock => {
                write!(f, "Lock error: panicked")
            },
            S7ConnectError::IOError(kind) => {
                write!(f, "IO error: {:?}", kind)
            },
            S7ConnectError::Response { code } => {
                write!(
                    f,
                    "Error response: {}",
                    error_text(*code)
                )
            },
            S7ConnectError::CPU { code } => {
                write!(
                    f,
                    "Error response CPU: {}",
                    error_text(cpu_error(*code))
                )
            },
            S7ConnectError::InvalidInput {
                input,
            } => write!(
                f,
                "Invalid input: {}",
                input
            ),
            S7ConnectError::Send => {
                write!(f, "Send connection error")
            },
            S7ConnectError::Iso => {
                write!(f, "ISO connection error")
            },
            S7ConnectError::PduLength(pdu) => {
                write!(
                    f,
                    "PDU length connection \
                     error {}",
                    pdu
                )
            },
            S7ConnectError::TryFrom(
                bytes,
                reason,
            ) => {
                write!(
                    f,
                    "Could not read bytes {:?} \
                     reason {}",
                    bytes, reason
                )
            },
            S7ConnectError::InvalidCpuStatus(
                status,
            ) => write!(
                f,
                "Invalid cpu status {}",
                status
            ),
            S7ConnectError::InvalidResponse {
                reason,
                bytes,
            } => {
                write!(
                    f,
                    "Invalid response {:?} err \
                     {}",
                    bytes, reason
                )
            },
            // S7ConnectError::InvalidBitAddr(
            //     addr
            // ) => {
            //     write!(
            //         f,
            //         "Invalid bit addr {}",
            //         addr
            //     )
            // }
        }
    }
}

impl From<IOError> for S7ConnectError {
    fn from(e: IOError) -> Self {
        S7ConnectError::IOError(e.kind())
    }
}
// This is important for other errors to wrap this
// one.
impl error::Error for S7ConnectError {
    fn source(
        &self,
    ) -> Option<&(dyn error::Error + 'static)>
    {
        None
    }
}

//CPUError specific CPU error after response
fn cpu_error(err: i32) -> i32 {
    match err {
        CODE_7_ADDRESS_OUT_OF_RANGE => {
            CLI_ADDRESS_OUT_OF_RANGE
        },
        CODE_7_INVALID_TRANSPORT_SIZE => {
            CLI_INVALID_TRANSPORT_SIZE
        },
        CODE_7_WRITE_DATA_SIZE_MISMATCH => {
            CLI_WRITE_DATA_SIZE_MISMATCH
        },
        CODE_7_RES_ITEM_NOT_AVAILABLE
        | CODE_7_RES_ITEM_NOT_AVAILABLE1 => {
            CLI_ITEM_NOT_AVAILABLE
        },
        CODE_7_DATA_OVER_PDU => CLI_SIZE_OVER_PDU,
        CODE_7_INVALID_VALUE => CLI_INVALID_VALUE,
        CODE_7_FUN_NOT_AVAILABLE => {
            CLI_FUN_NOT_AVAILABLE
        },
        CODE_7_NEED_PASSWORD => CLI_NEED_PASSWORD,
        CODE_7_INVALID_PASSWORD => {
            CLI_INVALID_PASSWORD
        },
        CODE_7_NO_PASSWORD_TO_SET
        | CODE_7_NO_PASSWORD_TO_CLEAR => {
            CLI_NO_PASSWORD_TO_SET_OR_CLEAR
        },
        _ => CLI_FUNCTION_REFUSED,
    }
}

//ErrorText return a string error text from error
// code integer
fn error_text(err: i32) -> &'static str {
    match err {
        0 => "OK",
        TCP_SOCKET_CREATION => {
            "SYS : Error creating the Socket"
        },
        TCP_CONNECTION_TIMEOUT => {
            "TCP : Connection Timeout"
        },
        TCP_CONNECTION_FAILED => {
            "TCP : Connection Error"
        },
        TCP_RECEIVE_TIMEOUT => {
            "TCP : Data receive Timeout"
        },
        TCP_DATA_RECEIVE => {
            "TCP : Error receiving Data"
        },
        TCP_SEND_TIMEOUT => {
            "TCP : Data send Timeout"
        },
        TCP_DATA_SEND => {
            "TCP : Error sending Data"
        },
        TCP_CONNECTION_RESET => {
            "TCP : Connection reset by the Peer"
        },
        TCP_NOT_CONNECTED => {
            "CLI : Client not connected"
        },
        TCP_UNREACHALE_HOST => {
            "TCP : Unreachable host"
        },

        ISO_CONNECT => "ISO : Connection Error",
        ISO_INVALID_PDU => {
            "ISO : Invalid PDU received"
        },
        ISO_INVALID_DATA_SIZE => {
            "ISO : Invalid Buffer passed to \
             Send/Receive"
        },

        CLI_NEGOTIATING_PDU => {
            "CLI : Error in PDU negotiation"
        },
        CLI_INVALID_PARAMS => {
            "CLI : invalid param(s) supplied"
        },
        CLI_JOB_PENDING => "CLI : Job pending",
        CLI_TOO_MANY_ITEMS => {
            "CLI : too may items (>20) in multi \
             read/write"
        },
        CLI_INVALID_DWORD_LEN => {
            "CLI : invalid WordLength"
        },
        CLI_PARTIAL_DATA_WRITTEN => {
            "CLI : Partial data written"
        },
        CLI_SIZE_OVER_PDU => {
            "CPU : total data exceeds the PDU \
             size"
        },
        CLI_INVALID_PLC_ANSWER => {
            "CLI : invalid CPU answer"
        },
        CLI_ADDRESS_OUT_OF_RANGE => {
            "CPU : Address out of range"
        },
        CLI_INVALID_TRANSPORT_SIZE => {
            "CPU : Invalid Transport size"
        },
        CLI_WRITE_DATA_SIZE_MISMATCH => {
            "CPU : Data size mismatch"
        },
        CLI_ITEM_NOT_AVAILABLE => {
            "CPU : Item not available"
        },
        CLI_INVALID_VALUE => {
            "CPU : Invalid value supplied"
        },
        CLI_CANNOT_START_PLC => {
            "CPU : Cannot start PLC"
        },
        CLI_ALREADY_RUN => {
            "CPU : PLC already RUN"
        },
        CLI_CANNOT_STOP_PLC => {
            "CPU : Cannot stop PLC"
        },
        CLI_CANNOT_COPY_RAM_TO_ROM => {
            "CPU : Cannot copy RAM to ROM"
        },
        CLI_CANNOT_COMPRESS => {
            "CPU : Cannot compress"
        },
        CLI_ALREADY_STOP => {
            "CPU : PLC already STOP"
        },
        CLI_FUN_NOT_AVAILABLE => {
            "CPU : Function not available"
        },
        CLI_UPLOAD_SEQUENCE_FAILED => {
            "CPU : Upload sequence failed"
        },
        CLI_INVALID_DATA_SIZE_RECVD => {
            "CLI : Invalid data size received"
        },
        CLI_INVALID_BLOCK_TYPE => {
            "CLI : Invalid block type"
        },
        CLI_INVALID_BLOCK_NUMBER => {
            "CLI : Invalid block number"
        },
        CLI_INVALID_BLOCK_SIZE => {
            "CLI : Invalid block size"
        },
        CLI_NEED_PASSWORD => {
            "CPU : Function not authorized for \
             current protection level"
        },
        CLI_INVALID_PASSWORD => {
            "CPU : Invalid password"
        },
        CLI_NO_PASSWORD_TO_SET_OR_CLEAR => {
            "CPU : No password to set or clear"
        },
        CLI_JOB_TIMEOUT => "CLI : Job Timeout",
        CLI_FUNCTION_REFUSED => {
            "CLI : function refused by CPU \
             (Unknown error)"
        },
        CLI_PARTIAL_DATA_READ => {
            "CLI : Partial data read"
        },
        CLI_BUFFER_TOO_SMALL => {
            "CLI : The buffer supplied is too \
             small to accomplish the operation"
        },
        CLI_DESTROYING => {
            "CLI : Cannot perform (destroying)"
        },
        CLI_INVALID_PARAM_NUMBER => {
            "CLI : Invalid Param Number"
        },
        CLI_CANNOT_CHANGE_PARAM => {
            "CLI : Cannot change this param now"
        },
        CLI_FUNCTION_NOT_IMPLEMENTED => {
            "CLI : Function not implemented"
        },
        _ => "CLI : Unknown error",
    }
}