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
#[cfg(feature = "rtu")]
pub mod rtu;

#[cfg(feature = "sync")]
pub mod sync;

#[cfg(feature = "tcp")]
pub mod tcp;

pub mod util;

use crate::{frame::*, slave::*};

use std::{
    future::Future,
    io::{Error, ErrorKind},
    pin::Pin,
};

/// A transport independent asynchronous client trait.
pub trait Client: SlaveContext + Send {
    fn call<'a>(
        &'a mut self,
        request: Request,
    ) -> Pin<Box<dyn Future<Output = Result<Response, Error>> + Send + 'a>>;
}

/// An asynchronous Modbus reader.
pub trait Reader: Client {
    fn read_coils<'a>(
        &'a mut self,
        _: Address,
        _: Quantity,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<Coil>, Error>> + Send + 'a>>;

    fn read_discrete_inputs<'a>(
        &'a mut self,
        _: Address,
        _: Quantity,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<Coil>, Error>> + Send + 'a>>;

    fn read_input_registers<'a>(
        &'a mut self,
        _: Address,
        _: Quantity,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<Word>, Error>> + Send + 'a>>;

    fn read_holding_registers<'a>(
        &'a mut self,
        _: Address,
        _: Quantity,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<Word>, Error>> + Send + 'a>>;

    fn read_write_multiple_registers<'a>(
        &'a mut self,
        _: Address,
        _: Quantity,
        _: Address,
        _: &[Word],
    ) -> Pin<Box<dyn Future<Output = Result<Vec<Word>, Error>> + Send + 'a>>;
}

/// An asynchronous Modbus writer.
pub trait Writer: Client {
    fn write_single_coil<'a>(
        &'a mut self,
        _: Address,
        _: Coil,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>;

    fn write_multiple_coils<'a>(
        &'a mut self,
        _: Address,
        _: &[Coil],
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>;

    fn write_single_register<'a>(
        &'a mut self,
        _: Address,
        _: Word,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>;

    fn write_multiple_registers<'a>(
        &'a mut self,
        _: Address,
        _: &[Word],
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>;
}

/// An asynchronous Modbus client context.
pub struct Context {
    client: Box<dyn Client>,
}

impl Context {
    pub async fn disconnect(&mut self) -> Result<(), Error> {
        // Disconnecting is expected to fail!
        let res = self.client.call(Request::Disconnect).await;
        match res {
            Ok(_) => unreachable!(),
            Err(err) => match err.kind() {
                ErrorKind::NotConnected | ErrorKind::BrokenPipe => Ok(()),
                _ => Err(err),
            },
        }
    }
}

impl From<Box<dyn Client>> for Context {
    fn from(client: Box<dyn Client>) -> Self {
        Self { client }
    }
}

impl Into<Box<dyn Client>> for Context {
    fn into(self) -> Box<dyn Client> {
        self.client
    }
}

impl Client for Context {
    fn call<'a>(
        &'a mut self,
        request: Request,
    ) -> Pin<Box<dyn Future<Output = Result<Response, Error>> + Send + 'a>> {
        self.client.call(request)
    }
}

impl SlaveContext for Context {
    fn set_slave(&mut self, slave: Slave) {
        self.client.set_slave(slave);
    }
}

impl Reader for Context {
    fn read_coils<'a>(
        &'a mut self,
        addr: Address,
        cnt: Quantity,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<Coil>, Error>> + Send + 'a>> {
        let request = self.client.call(Request::ReadCoils(addr, cnt));

        Box::pin(async move {
            let rsp = request.await?;

            if let Response::ReadCoils(mut coils) = rsp {
                debug_assert!(coils.len() >= cnt as usize);
                coils.truncate(cnt as usize);
                Ok(coils)
            } else {
                Err(Error::new(ErrorKind::InvalidData, "unexpected response"))
            }
        })
    }

    fn read_discrete_inputs<'a>(
        &'a mut self,
        addr: Address,
        cnt: Quantity,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<Coil>, Error>> + Send + 'a>> {
        let request = self.client.call(Request::ReadDiscreteInputs(addr, cnt));

        Box::pin(async move {
            let rsp = request.await?;

            if let Response::ReadDiscreteInputs(mut coils) = rsp {
                debug_assert!(coils.len() >= cnt as usize);
                coils.truncate(cnt as usize);
                Ok(coils)
            } else {
                Err(Error::new(ErrorKind::InvalidData, "unexpected response"))
            }
        })
    }

    fn read_input_registers<'a>(
        &'a mut self,
        addr: Address,
        cnt: Quantity,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<Word>, Error>> + Send + 'a>> {
        let request = self.client.call(Request::ReadInputRegisters(addr, cnt));

        Box::pin(async move {
            let rsp = request.await?;

            if let Response::ReadInputRegisters(rsp) = rsp {
                if rsp.len() != cnt as usize {
                    return Err(Error::new(ErrorKind::InvalidData, "invalid response"));
                }
                Ok(rsp)
            } else {
                Err(Error::new(ErrorKind::InvalidData, "unexpected response"))
            }
        })
    }

    fn read_holding_registers<'a>(
        &'a mut self,
        addr: Address,
        cnt: Quantity,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<Word>, Error>> + Send + 'a>> {
        let request = self.client.call(Request::ReadHoldingRegisters(addr, cnt));

        Box::pin(async move {
            let rsp = request.await?;

            if let Response::ReadHoldingRegisters(rsp) = rsp {
                if rsp.len() != cnt as usize {
                    return Err(Error::new(ErrorKind::InvalidData, "invalid response"));
                }
                Ok(rsp)
            } else {
                Err(Error::new(ErrorKind::InvalidData, "unexpected response"))
            }
        })
    }

    fn read_write_multiple_registers<'a>(
        &'a mut self,
        read_addr: Address,
        read_cnt: Quantity,
        write_addr: Address,
        write_data: &[Word],
    ) -> Pin<Box<dyn Future<Output = Result<Vec<Word>, Error>> + Send + 'a>> {
        let request = self.client.call(Request::ReadWriteMultipleRegisters(
            read_addr,
            read_cnt,
            write_addr,
            write_data.to_vec(),
        ));
        Box::pin(async move {
            let rsp = request.await?;

            if let Response::ReadWriteMultipleRegisters(rsp) = rsp {
                if rsp.len() != read_cnt as usize {
                    return Err(Error::new(ErrorKind::InvalidData, "invalid response"));
                }
                Ok(rsp)
            } else {
                Err(Error::new(ErrorKind::InvalidData, "unexpected response"))
            }
        })
    }
}

impl Writer for Context {
    fn write_single_coil<'a>(
        &'a mut self,
        addr: Address,
        coil: Coil,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>> {
        let request = self.client.call(Request::WriteSingleCoil(addr, coil));

        Box::pin(async move {
            let rsp = request.await?;

            if let Response::WriteSingleCoil(rsp_addr, rsp_coil) = rsp {
                if rsp_addr != addr || rsp_coil != coil {
                    return Err(Error::new(ErrorKind::InvalidData, "invalid response"));
                }
                Ok(())
            } else {
                Err(Error::new(ErrorKind::InvalidData, "unexpected response"))
            }
        })
    }

    fn write_multiple_coils<'a>(
        &'a mut self,
        addr: Address,
        coils: &[Coil],
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>> {
        let cnt = coils.len();
        let request = self
            .client
            .call(Request::WriteMultipleCoils(addr, coils.to_vec()));

        Box::pin(async move {
            let rsp = request.await?;

            if let Response::WriteMultipleCoils(rsp_addr, rsp_cnt) = rsp {
                if rsp_addr != addr || rsp_cnt as usize != cnt {
                    return Err(Error::new(ErrorKind::InvalidData, "invalid response"));
                }
                Ok(())
            } else {
                Err(Error::new(ErrorKind::InvalidData, "unexpected response"))
            }
        })
    }

    fn write_single_register<'a>(
        &'a mut self,
        addr: Address,
        data: Word,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>> {
        let request = self.client.call(Request::WriteSingleRegister(addr, data));

        Box::pin(async move {
            let rsp = request.await?;

            if let Response::WriteSingleRegister(rsp_addr, rsp_word) = rsp {
                if rsp_addr != addr || rsp_word != data {
                    return Err(Error::new(ErrorKind::InvalidData, "invalid response"));
                }
                Ok(())
            } else {
                Err(Error::new(ErrorKind::InvalidData, "unexpected response"))
            }
        })
    }

    fn write_multiple_registers<'a>(
        &'a mut self,
        addr: Address,
        data: &[Word],
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>> {
        let cnt = data.len();
        let request = self
            .client
            .call(Request::WriteMultipleRegisters(addr, data.to_vec()));

        Box::pin(async move {
            let rsp = request.await?;

            if let Response::WriteMultipleRegisters(rsp_addr, rsp_cnt) = rsp {
                if rsp_addr != addr || rsp_cnt as usize != cnt {
                    return Err(Error::new(ErrorKind::InvalidData, "invalid response"));
                }
                Ok(())
            } else {
                Err(Error::new(ErrorKind::InvalidData, "unexpected response"))
            }
        })
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use futures::future;
    use std::{future::Future, sync::Mutex};

    #[derive(Default, Debug)]
    pub struct ClientMock {
        slave: Option<Slave>,
        last_request: Mutex<Option<Request>>,
        next_response: Option<Result<Response, Error>>,
    }

    #[allow(dead_code)]
    impl ClientMock {
        pub fn slave(&self) -> Option<Slave> {
            self.slave
        }

        pub fn last_request(&self) -> &Mutex<Option<Request>> {
            &self.last_request
        }

        pub fn set_next_response(&mut self, next_response: Result<Response, Error>) {
            self.next_response = Some(next_response);
        }
    }

    impl Client for ClientMock {
        fn call<'a>(
            &'a mut self,
            request: Request,
        ) -> Pin<Box<dyn Future<Output = Result<Response, Error>> + Send + 'a>> {
            *self.last_request.lock().unwrap() = Some(request);
            Box::pin(future::ready(match self.next_response.as_ref().unwrap() {
                Ok(response) => Ok(response.clone()),
                Err(err) => Err(Error::new(err.kind(), format!("{}", err))),
            }))
        }
    }

    impl SlaveContext for ClientMock {
        fn set_slave(&mut self, slave: Slave) {
            self.slave = Some(slave);
        }
    }

    #[test]
    fn read_some_coils() {
        // The protocol will always return entire bytes with, i.e.
        // a multiple of 8 coils.
        let response_coils = [true, false, false, true, false, true, false, true].to_vec();
        for num_coils in 1usize..8usize {
            let mut client = Box::new(ClientMock::default());
            client.set_next_response(Ok(Response::ReadCoils(response_coils.clone())));
            let mut context = Context { client };
            context.set_slave(Slave(1));
            let coils =
                futures::executor::block_on(context.read_coils(1, num_coils as u16)).unwrap();
            assert_eq!(&response_coils[0..num_coils], &coils[..]);
        }
    }

    #[test]
    fn read_some_discrete_inputs() {
        // The protocol will always return entire bytes with, i.e.
        // a multiple of 8 coils.
        let response_inputs = [true, false, false, true, false, true, false, true].to_vec();
        for num_inputs in 1usize..8usize {
            let mut client = Box::new(ClientMock::default());
            client.set_next_response(Ok(Response::ReadDiscreteInputs(response_inputs.clone())));
            let mut context = Context { client };
            context.set_slave(Slave(1));
            let inputs =
                futures::executor::block_on(context.read_discrete_inputs(1, num_inputs as u16))
                    .unwrap();
            assert_eq!(&response_inputs[0..num_inputs], &inputs[..]);
        }
    }
}