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
use byteorder::{BigEndian, ReadBytesExt, WriteBytesExt};
use std::borrow::BorrowMut;
use std::io::{self, Cursor, Read, Write};
use std::net::{Shutdown, TcpStream, ToSocketAddrs};
use std::time::Duration;
use modbus_protocol::exception_code::{Error, ExceptionCode, Reason, Result};
use modbus_protocol::coils::Coil;
use modbus_protocol::requests::Requests;
use modbus_protocol::utils;
use num_traits::FromPrimitive;
const MODBUS_PROTOCOL_TCP: u16 = 0x0000;
const MODBUS_TCP_DEFAULT_PORT: u16 = 502;
const MODBUS_HEADER_SIZE: usize = 7;
const MODBUS_MAX_PACKET_SIZE: usize = 260;
#[derive(Clone, Copy)]
pub struct ModbusConfig {
pub tcp_port: u16,
pub tcp_connect_timeout: Option<Duration>,
pub tcp_read_timeout: Option<Duration>,
pub tcp_write_timeout: Option<Duration>,
pub modbus_uid: u8,
}
impl Default for ModbusConfig {
fn default() -> ModbusConfig {
ModbusConfig {
tcp_port: MODBUS_TCP_DEFAULT_PORT,
tcp_connect_timeout: None,
tcp_read_timeout: None,
tcp_write_timeout: None,
modbus_uid: 1,
}
}
}
impl ModbusConfig {
pub fn set_port(self: &mut Self, port: u16) {
self.tcp_port = port;
}
pub fn set_uid(self: &mut Self, uid: u8) {
self.modbus_uid = uid;
}
}
#[derive(Debug, PartialEq)]
struct Header {
tid: u16,
pid: u16,
len: u16,
uid: u8,
}
impl Header {
fn new(transport: &mut Transport, len: u16) -> Header {
Header {
tid: transport.new_tid(),
pid: MODBUS_PROTOCOL_TCP,
len: len - MODBUS_HEADER_SIZE as u16,
uid: transport.uid,
}
}
fn pack(&self) -> Result<Vec<u8>> {
let mut buff = vec![];
buff.write_u16::<BigEndian>(self.tid)?;
buff.write_u16::<BigEndian>(self.pid)?;
buff.write_u16::<BigEndian>(self.len)?;
buff.write_u8(self.uid)?;
Ok(buff)
}
fn unpack(buff: &[u8]) -> Result<Header> {
let mut rdr = Cursor::new(buff);
Ok(Header {
tid: rdr.read_u16::<BigEndian>()?,
pid: rdr.read_u16::<BigEndian>()?,
len: rdr.read_u16::<BigEndian>()?,
uid: rdr.read_u8()?,
})
}
}
pub enum Function<'a> {
ReadCoils(u16, u16),
ReadDiscreteInputs(u16, u16),
ReadHoldingRegisters(u16, u16),
ReadInputRegisters(u16, u16),
WriteSingleCoil(u16, u16),
WriteSingleRegister(u16, u16),
WriteMultipleCoils(u16, u16, &'a [u8]),
WriteMultipleRegisters(u16, u16, &'a [u8]),
}
impl<'a> Function<'a> {
pub fn code(&self) -> u8 {
match *self {
Function::ReadCoils(_, _) => 0x01,
Function::ReadDiscreteInputs(_, _) => 0x02,
Function::ReadHoldingRegisters(_, _) => 0x03,
Function::ReadInputRegisters(_, _) => 0x04,
Function::WriteSingleCoil(_, _) => 0x05,
Function::WriteSingleRegister(_, _) => 0x06,
Function::WriteMultipleCoils(_, _, _) => 0x0f,
Function::WriteMultipleRegisters(_, _, _) => 0x10,
}
}
}
pub struct Transport {
tid: u16,
uid: u8,
stream: TcpStream,
}
impl Transport {
pub fn new_with_cfg(addr: &str, cfg: ModbusConfig) -> io::Result<Transport> {
let stream = match cfg.tcp_connect_timeout {
Some(timeout) => {
let mut socket_addrs = (addr, cfg.tcp_port).to_socket_addrs()?;
TcpStream::connect_timeout(&socket_addrs.next().unwrap(), timeout)
}
None => TcpStream::connect((addr, cfg.tcp_port)),
};
match stream {
Ok(socket) => {
let peer_addr = socket.peer_addr().unwrap();
log::info!("connected server: {:?}", peer_addr);
socket.set_read_timeout(cfg.tcp_read_timeout)?;
socket.set_write_timeout(cfg.tcp_write_timeout)?;
socket.set_nodelay(true)?;
Ok(Transport {
tid: 0,
uid: cfg.modbus_uid,
stream: socket,
})
}
Err(e) => Err(e),
}
}
pub fn _set_uid(&mut self, uid: u8) {
self.uid = uid;
}
fn new_tid(&mut self) -> u16 {
self.tid = self.tid.wrapping_add(1);
self.tid
}
fn read(self: &mut Self, fun: &Function) -> Result<Vec<u8>> {
let packed_size = |v: u16| v / 8 + if v % 8 > 0 { 1 } else { 0 };
let (addr, count, expected_bytes) = match *fun {
Function::ReadCoils(a, c) | Function::ReadDiscreteInputs(a, c) => {
(a, c, packed_size(c) as usize)
}
Function::ReadHoldingRegisters(a, c) | Function::ReadInputRegisters(a, c) => {
(a, c, 2 * c as usize)
}
_ => return Err(Error::InvalidFunction),
};
if count < 1 {
return Err(Error::InvalidData(Reason::RecvBufferEmpty));
}
if count as usize > MODBUS_MAX_PACKET_SIZE {
return Err(Error::InvalidData(Reason::UnexpectedReplySize));
}
let header = Header::new(self, MODBUS_HEADER_SIZE as u16 + 6u16);
let mut buff = header.pack()?;
buff.write_u8(fun.code())?;
buff.write_u16::<BigEndian>(addr)?;
buff.write_u16::<BigEndian>(count)?;
match self.stream.write_all(&buff) {
Ok(_s) => {
let mut reply = vec![0; MODBUS_HEADER_SIZE + expected_bytes + 2];
match self.stream.read(&mut reply) {
Ok(_s) => {
let resp_hd = Header::unpack(&reply[..MODBUS_HEADER_SIZE])?;
Transport::validate_response_header(&header, &resp_hd)?;
Transport::validate_response_code(&buff, &reply)?;
Transport::get_reply_data(&reply, expected_bytes)
}
Err(e) => Err(Error::Io(e)),
}
}
Err(e) => Err(Error::Io(e)),
}
}
fn validate_response_header(req: &Header, resp: &Header) -> Result<()> {
if req.tid != resp.tid || resp.pid != MODBUS_PROTOCOL_TCP {
log::info!("Invalid response header:");
log::info!(" tid: expected: {}, result: {}", req.tid, resp.tid);
log::info!(" pid: expected: {}, result: {}", MODBUS_PROTOCOL_TCP, resp.pid);
Err(Error::InvalidResponse)
} else {
Ok(())
}
}
fn validate_response_code(req: &[u8], resp: &[u8]) -> Result<()> {
if req[7] + 0x80 == resp[7] {
match ExceptionCode::from_u8(resp[8]) {
Some(code) => Err(Error::Exception(code)),
None => {
log::info!("Invalid Exception code: {}", resp[8]);
Err(Error::InvalidResponse)
}
}
} else if req[7] == resp[7] {
Ok(())
} else {
log::info!("invalid response code");
log::info!(" expected: {}, result: {}", req[7], resp[7]);
Err(Error::InvalidResponse)
}
}
fn get_reply_data(reply: &[u8], expected_bytes: usize) -> Result<Vec<u8>> {
if reply[8] as usize != expected_bytes
|| reply.len() != MODBUS_HEADER_SIZE + expected_bytes + 2
{
log::info!("Unexpected reply size");
log::info!(" length field, expected: {}, result: {}",
expected_bytes, reply[8]);
log::info!(" length expected: {}, result: {}",
MODBUS_HEADER_SIZE + expected_bytes + 2, reply.len());
Err(Error::InvalidData(Reason::UnexpectedReplySize))
} else {
let mut d = Vec::new();
d.extend_from_slice(&reply[MODBUS_HEADER_SIZE + 2..]);
Ok(d)
}
}
fn write_single(self: &mut Self, fun: &Function) -> Result<()> {
let (addr, value) = match *fun {
Function::WriteSingleCoil(a, v) | Function::WriteSingleRegister(a, v) => (a, v),
_ => return Err(Error::InvalidFunction),
};
let mut buff = vec![0; MODBUS_HEADER_SIZE];
buff.write_u8(fun.code())?;
buff.write_u16::<BigEndian>(addr)?;
buff.write_u16::<BigEndian>(value)?;
self.write(&mut buff)
}
fn write_multiple(self: &mut Self, fun: &Function) -> Result<()> {
let (addr, quantity, values) = match *fun {
Function::WriteMultipleCoils(a, q, v) | Function::WriteMultipleRegisters(a, q, v) => {
(a, q, v)
}
_ => return Err(Error::InvalidFunction),
};
let mut buff = vec![0; MODBUS_HEADER_SIZE];
buff.write_u8(fun.code())?;
buff.write_u16::<BigEndian>(addr)?;
buff.write_u16::<BigEndian>(quantity)?;
buff.write_u8(values.len() as u8)?;
for v in values {
buff.write_u8(*v)?;
}
self.write(&mut buff)
}
fn write(self: &mut Self, buff: &mut [u8]) -> Result<()> {
if buff.is_empty() {
return Err(Error::InvalidData(Reason::SendBufferEmpty));
}
if buff.len() > MODBUS_MAX_PACKET_SIZE {
return Err(Error::InvalidData(Reason::SendBufferTooBig));
}
let header = Header::new(self, buff.len() as u16 + 1u16);
let head_buff = header.pack()?;
{
let mut start = Cursor::new(buff.borrow_mut());
start.write_all(&head_buff)?;
}
match self.stream.write_all(buff) {
Ok(_s) => {
let reply = &mut [0; 12];
match self.stream.read(reply) {
Ok(_s) => {
let resp_hd = Header::unpack(reply)?;
Transport::validate_response_header(&header, &resp_hd)?;
Transport::validate_response_code(buff, reply)
}
Err(e) => Err(Error::Io(e)),
}
}
Err(e) => Err(Error::Io(e)),
}
}
pub fn _close(self: &mut Self) -> Result<()> {
self.stream.shutdown(Shutdown::Both).map_err(Error::Io)
}
}
impl Requests for Transport {
fn read_coils(self: &mut Self, addr: u16, count: u16) -> Result<Vec<Coil>> {
let bytes = self.read(&Function::ReadCoils(addr, count))?;
Ok(utils::unpack_bits(&bytes, count))
}
fn read_discrete_inputs(self: &mut Self, addr: u16, count: u16) -> Result<Vec<Coil>> {
let bytes = self.read(&Function::ReadDiscreteInputs(addr, count))?;
Ok(utils::unpack_bits(&bytes, count))
}
fn read_holding_registers(self: &mut Self, addr: u16, count: u16) -> Result<Vec<u16>> {
let bytes = self.read(&Function::ReadHoldingRegisters(addr, count))?;
utils::pack_bytes(&bytes[..])
}
fn read_input_registers(self: &mut Self, addr: u16, count: u16) -> Result<Vec<u16>> {
let bytes = self.read(&Function::ReadInputRegisters(addr, count))?;
utils::pack_bytes(&bytes[..])
}
fn write_single_coil(self: &mut Self, addr: u16, value: Coil) -> Result<()> {
self.write_single(&Function::WriteSingleCoil(addr, value.code()))
}
fn write_single_register(self: &mut Self, addr: u16, value: u16) -> Result<()> {
self.write_single(&Function::WriteSingleRegister(addr, value))
}
fn write_multiple_coils(self: &mut Self, addr: u16, values: &[Coil]) -> Result<()> {
let bytes = utils::pack_bits(values);
self.write_multiple(&Function::WriteMultipleCoils(
addr,
values.len() as u16,
&bytes,
))
}
fn write_multiple_registers(self: &mut Self, addr: u16, values: &[u16]) -> Result<()> {
let bytes = utils::unpack_bytes(values);
self.write_multiple(&Function::WriteMultipleRegisters(
addr,
values.len() as u16,
&bytes,
))
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn serialize_header() {
let header = Header {
tid: 12816,
pid: 3930,
len: 99,
uid: 68,
};
let serialized = header.pack().unwrap();
let deserialized = Header::unpack(&vec![50, 16, 15, 90, 0, 99, 68]).unwrap();
let re_deserialized = Header::unpack(&serialized).unwrap();
assert_eq!(serialized, vec![50, 16, 15, 90, 0, 99, 68]);
assert_eq!(deserialized, header);
assert_eq!(re_deserialized, header);
}
}