ads-proto 0.1.1

Implementation of the Beckhoff ADS protocol (Automation Device Specification)
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
use crate::error::AdsError;
use crate::proto::proto_traits::{ReadFrom, WriteTo};
use crate::proto::response::{ReadResponse, ReadWriteResponse, WriteResponse};
use byteorder::{LittleEndian, ReadBytesExt, WriteBytesExt};
use std::io::{self, Read, Write};

//Helper struct
#[derive(Debug, Clone, PartialEq, Eq)]
struct AccessData {
    result: u32,
    length: u32,
}

impl WriteTo for AccessData {
    fn write_to<W: Write>(&self, mut wtr: W) -> io::Result<()> {
        wtr.write_u32::<LittleEndian>(self.result)?;
        wtr.write_u32::<LittleEndian>(self.length)?;
        Ok(())
    }
}

impl ReadFrom for AccessData {
    fn read_from<R: Read>(read: &mut R) -> io::Result<Self> {
        let result = read.read_u32::<LittleEndian>()?;
        let length = read.read_u32::<LittleEndian>()?;

        Ok(AccessData { result, length })
    }
}

///Ads Sumup Read Write response
///Bundle multiple responses toghether. Add this data to the read write response or parse from.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct SumupReadWriteResponse {
    pub read_write_responses: Vec<ReadWriteResponse>,
}

impl SumupReadWriteResponse {
    pub fn new(read_write_responses: Vec<ReadWriteResponse>) -> Self {
        SumupReadWriteResponse {
            read_write_responses,
        }
    }
}

impl ReadFrom for SumupReadWriteResponse {
    fn read_from<R: Read>(read: &mut R) -> io::Result<Self> {
        let mut data_buf: Vec<u8> = Vec::new();
        let mut read_access: Vec<AccessData> = Vec::new();

        //Read all bytes to get the total length
        read.read_to_end(&mut data_buf)?;
        let total_data_len = data_buf.len() as u32;
        let mut access_data_length: u32 = 0;
        let mut data_length: u32 = 0;
        let mut data_buf = data_buf.as_slice();

        //Get the access data bytes
        for _ in 0..total_data_len / 8 {
            let access_data = AccessData::read_from(&mut data_buf)?;
            access_data_length += 8;
            data_length += access_data.length;
            read_access.push(access_data);
            if (total_data_len - data_length - access_data_length) == 0 {
                break;
            }
        }

        //Get the actual data/value bytes and create ReadWriteResponses
        let mut read_write_response: Vec<ReadWriteResponse> = Vec::new();
        for access in read_access {
            let mut buf = vec![0; access.length as usize];
            data_buf.read_exact(&mut buf)?;
            read_write_response.push(ReadWriteResponse::new(AdsError::from(access.result), buf));
        }
        Ok(SumupReadWriteResponse::new(read_write_response))
    }
}

impl WriteTo for SumupReadWriteResponse {
    fn write_to<W: Write>(&self, mut wtr: W) -> io::Result<()> {
        let mut access_data: Vec<u8> = Vec::new();
        let mut data: Vec<u8> = Vec::new();
        for response in &self.read_write_responses {
            access_data.write_u32::<LittleEndian>(response.result.as_u32())?;
            access_data.write_u32::<LittleEndian>(response.length)?;
            data.write_all(response.data.as_slice())?;
        }
        access_data.append(&mut data);
        wtr.write_all(&access_data)?;
        Ok(())
    }
}

///Ads Sumup Read response
///Bundle multiple responses toghether. Add this data to the read write response or parse from.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct SumupReadResponse {
    pub read_responses: Vec<ReadResponse>,
}

impl SumupReadResponse {
    pub fn new(read_responses: Vec<ReadResponse>) -> Self {
        SumupReadResponse { read_responses }
    }
}

impl ReadFrom for SumupReadResponse {
    fn read_from<R: Read>(read: &mut R) -> io::Result<Self> {
        let mut data_buf: Vec<u8> = Vec::new();
        let mut read_access: Vec<AccessData> = Vec::new();

        //Read all bytes to get the total length
        read.read_to_end(&mut data_buf)?;
        let total_data_len = data_buf.len() as u32;
        let mut access_data_length: u32 = 0;
        let mut data_length: u32 = 0;
        let mut data_buf = data_buf.as_slice();

        //Get the access data bytes
        for _ in 0..total_data_len / 8 {
            let access_data = AccessData::read_from(&mut data_buf)?;
            access_data_length += 8;
            data_length += access_data.length;
            read_access.push(access_data);
            if (total_data_len - data_length - access_data_length) == 0 {
                break;
            }
        }

        //Get the actual data/value bytes and create ReadWriteResponses
        let mut read_response: Vec<ReadResponse> = Vec::new();
        for access in read_access {
            let mut buf = vec![0; access.length as usize];
            data_buf.read_exact(&mut buf)?;
            read_response.push(ReadResponse::new(AdsError::from(access.result), buf));
        }
        Ok(SumupReadResponse::new(read_response))
    }
}

impl WriteTo for SumupReadResponse {
    fn write_to<W: Write>(&self, mut wtr: W) -> io::Result<()> {
        let mut access_data: Vec<u8> = Vec::new();
        let mut data: Vec<u8> = Vec::new();
        for response in &self.read_responses {
            access_data.write_u32::<LittleEndian>(response.result.as_u32())?;
            access_data.write_u32::<LittleEndian>(response.length)?;
            data.write_all(response.data.as_slice())?;
        }
        access_data.append(&mut data);
        wtr.write_all(&access_data)?;
        Ok(())
    }
}

///Ads Sumup Write response
///Bundle multiple responses toghether. Add this data to the read write response or parse from.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct SumupWriteResponse {
    pub write_responses: Vec<WriteResponse>,
}

impl SumupWriteResponse {
    pub fn new(write_responses: Vec<WriteResponse>) -> Self {
        SumupWriteResponse { write_responses }
    }
}

impl ReadFrom for SumupWriteResponse {
    fn read_from<R: Read>(read: &mut R) -> io::Result<Self> {
        let mut data_buf: Vec<u8> = Vec::new();
        read.read_to_end(&mut data_buf)?;
        let mut write_resp: Vec<WriteResponse> = Vec::new();
        let mut buf = data_buf.as_slice();
        for _ in 0..(data_buf.len() / 4) {
            write_resp.push(WriteResponse::read_from(&mut buf)?)
        }
        Ok(SumupWriteResponse::new(write_resp))
    }
}

impl WriteTo for SumupWriteResponse {
    fn write_to<W: Write>(&self, mut wtr: W) -> io::Result<()> {
        for result in &self.write_responses {
            result.write_to(&mut wtr)?;
        }
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn sumup_read_write_write_to_test() {
        let mut response_group: Vec<ReadWriteResponse> = Vec::new();
        let data_1 = vec![1, 0];
        let response_1 = ReadWriteResponse::new(AdsError::ErrNoError, data_1);
        response_group.push(response_1);
        let data_2 = vec![2, 0, 0, 0];
        let response_2 = ReadWriteResponse::new(AdsError::ErrNoError, data_2);
        response_group.push(response_2);
        let data_3 = vec![3, 0, 0, 0, 0, 0, 0, 0];
        let response_3 = ReadWriteResponse::new(AdsError::ErrNoError, data_3);
        response_group.push(response_3);

        let sum_read_write_response = SumupReadWriteResponse::new(response_group);
        let mut buf: Vec<u8> = Vec::new();
        sum_read_write_response.write_to(&mut buf).unwrap();

        #[rustfmt::skip]
        let compare_data = vec![
            0,0,0,0,        //result response 1
            2,0,0,0,        //data length response 1
            0,0,0,0,        //result response 2
            4,0,0,0,        //data length response 1
            0,0,0,0,        //result response 3
            8,0,0,0,        //data length response 1
            1,0,            //data response 1
            2,0,0,0,        //data response 2
            3,0,0,0,0,0,0,0 //data response 3
        ];

        assert_eq!(buf, compare_data);
    }

    #[test]
    fn sumup_read_write_read_from_test() {
        #[rustfmt::skip]
        let data = vec![
            0,0,0,0,        //result response 1
            2,0,0,0,        //data length response 1
            0,0,0,0,        //result response 2
            4,0,0,0,        //data length response 1
            0,0,0,0,        //result response 3
            8,0,0,0,        //data length response 1
            1,0,            //data response 1
            2,0,0,0,        //data response 2
            3,0,0,0,0,0,0,0 //data response 3
        ];

        let sum_read_response = SumupReadResponse::read_from(&mut data.as_slice()).unwrap();

        let data_1 = vec![1, 0];
        let response_1 = ReadResponse::new(AdsError::ErrNoError, data_1);
        let data_2 = vec![2, 0, 0, 0];
        let response_2 = ReadResponse::new(AdsError::ErrNoError, data_2);
        let data_3 = vec![3, 0, 0, 0, 0, 0, 0, 0];
        let response_3 = ReadResponse::new(AdsError::ErrNoError, data_3);

        assert_eq!(sum_read_response.read_responses[0], response_1);
        assert_eq!(sum_read_response.read_responses[1], response_2);
        assert_eq!(sum_read_response.read_responses[2], response_3);

        let value_1: u16 = sum_read_response.read_responses[0]
            .data
            .as_slice()
            .read_u16::<LittleEndian>()
            .unwrap();
        assert_eq!(value_1, 1);
        assert_eq!(
            sum_read_response.read_responses[0].result,
            AdsError::ErrNoError
        );
        assert_eq!(sum_read_response.read_responses[0].length, 2);
        let value_2: u32 = sum_read_response.read_responses[1]
            .data
            .as_slice()
            .read_u32::<LittleEndian>()
            .unwrap();
        assert_eq!(value_2, 2);
        assert_eq!(
            sum_read_response.read_responses[1].result,
            AdsError::ErrNoError
        );
        assert_eq!(sum_read_response.read_responses[1].length, 4);
        let value_3: u64 = sum_read_response.read_responses[2]
            .data
            .as_slice()
            .read_u64::<LittleEndian>()
            .unwrap();
        assert_eq!(value_3, 3);
        assert_eq!(
            sum_read_response.read_responses[2].result,
            AdsError::ErrNoError
        );
        assert_eq!(sum_read_response.read_responses[2].length, 8);
    }

    #[test]
    fn sumup_read_write_to_test() {
        let mut response_group: Vec<ReadResponse> = Vec::new();
        let data_1 = vec![1, 0];
        let response_1 = ReadResponse::new(AdsError::ErrNoError, data_1);
        response_group.push(response_1);
        let data_2 = vec![2, 0, 0, 0];
        let response_2 = ReadResponse::new(AdsError::ErrNoError, data_2);
        response_group.push(response_2);
        let data_3 = vec![3, 0, 0, 0, 0, 0, 0, 0];
        let response_3 = ReadResponse::new(AdsError::ErrNoError, data_3);
        response_group.push(response_3);

        let sum_read_write_response = SumupReadResponse::new(response_group);
        let mut buf: Vec<u8> = Vec::new();
        sum_read_write_response.write_to(&mut buf).unwrap();

        #[rustfmt::skip]
        let compare_data = vec![
            0,0,0,0,        //result response 1
            2,0,0,0,        //data length response 1
            0,0,0,0,        //result response 2
            4,0,0,0,        //data length response 1
            0,0,0,0,        //result response 3
            8,0,0,0,        //data length response 1
            1,0,            //data response 1
            2,0,0,0,        //data response 2
            3,0,0,0,0,0,0,0 //data response 3
        ];

        assert_eq!(buf, compare_data);
    }

    #[test]
    fn sumup_read_read_from_test() {
        #[rustfmt::skip]
        let data = vec![
            0,0,0,0,        //result response 1
            2,0,0,0,        //data length response 1
            0,0,0,0,        //result response 2
            4,0,0,0,        //data length response 1
            0,0,0,0,        //result response 3
            8,0,0,0,        //data length response 1
            1,0,            //data response 1
            2,0,0,0,        //data response 2
            3,0,0,0,0,0,0,0 //data response 3
        ];

        let sum_read_response = SumupReadResponse::read_from(&mut data.as_slice()).unwrap();

        let data_1 = vec![1, 0];
        let response_1 = ReadResponse::new(AdsError::ErrNoError, data_1);
        let data_2 = vec![2, 0, 0, 0];
        let response_2 = ReadResponse::new(AdsError::ErrNoError, data_2);
        let data_3 = vec![3, 0, 0, 0, 0, 0, 0, 0];
        let response_3 = ReadResponse::new(AdsError::ErrNoError, data_3);

        assert_eq!(sum_read_response.read_responses[0], response_1);
        assert_eq!(sum_read_response.read_responses[1], response_2);
        assert_eq!(sum_read_response.read_responses[2], response_3);

        let value_1: u16 = sum_read_response.read_responses[0]
            .data
            .as_slice()
            .read_u16::<LittleEndian>()
            .unwrap();
        assert_eq!(value_1, 1);
        assert_eq!(
            sum_read_response.read_responses[0].result,
            AdsError::ErrNoError
        );
        assert_eq!(sum_read_response.read_responses[0].length, 2);
        let value_2: u32 = sum_read_response.read_responses[1]
            .data
            .as_slice()
            .read_u32::<LittleEndian>()
            .unwrap();
        assert_eq!(value_2, 2);
        assert_eq!(
            sum_read_response.read_responses[1].result,
            AdsError::ErrNoError
        );
        assert_eq!(sum_read_response.read_responses[1].length, 4);
        let value_3: u64 = sum_read_response.read_responses[2]
            .data
            .as_slice()
            .read_u64::<LittleEndian>()
            .unwrap();
        assert_eq!(value_3, 3);
        assert_eq!(
            sum_read_response.read_responses[2].result,
            AdsError::ErrNoError
        );
        assert_eq!(sum_read_response.read_responses[2].length, 8);
    }

    #[test]
    fn sumup_write_write_to_test() {
        let mut response_group: Vec<WriteResponse> = Vec::new();
        let response_1 = WriteResponse::new(AdsError::ErrNoError);
        response_group.push(response_1);
        let response_2 = WriteResponse::new(AdsError::AdsErrClientPortNotOpen);
        response_group.push(response_2);
        let response_3 = WriteResponse::new(AdsError::ErrNoError);
        response_group.push(response_3);

        let sum_read_write_response = SumupWriteResponse::new(response_group);
        let mut buf: Vec<u8> = Vec::new();
        sum_read_write_response.write_to(&mut buf).unwrap();

        #[rustfmt::skip]
        let compare_data = vec![
            0,0,0,0,        //AdsError::ErrNoError
            72,7,0,0,       //AdsError::AdsErrClientPortNotOpen
            0,0,0,0,        //AdsError::ErrNoError        
        ];

        assert_eq!(buf, compare_data);
    }

    #[test]
    fn sumup_write_read_from_test() {
        #[rustfmt::skip]
        let data = vec![
            0,0,0,0,        //AdsError::ErrNoError
            72,7,0,0,       //AdsError::AdsErrClientPortNotOpen
            0,0,0,0,        //AdsError::ErrNoError        
        ];

        let sum_write_response = SumupWriteResponse::read_from(&mut data.as_slice()).unwrap();

        let mut response_group: Vec<WriteResponse> = Vec::new();
        let response_1 = WriteResponse::new(AdsError::ErrNoError);
        response_group.push(response_1);
        let response_2 = WriteResponse::new(AdsError::AdsErrClientPortNotOpen);
        response_group.push(response_2);
        let response_3 = WriteResponse::new(AdsError::ErrNoError);
        response_group.push(response_3);
        let compare = SumupWriteResponse::new(response_group);

        assert_eq!(sum_write_response, compare);
    }
}