#![no_std]
#![forbid(unsafe_code)]
#![warn(missing_docs)]
pub mod crc;
pub mod error;
pub mod frame;
pub mod message;
pub use error::MbrtuError;
pub use frame::Frame;
pub use message::{ModbusRequest, ModbusResponse};
pub fn decode_request(buf: &[u8]) -> Result<ModbusRequest, MbrtuError> {
let frame = Frame::parse(buf)?;
Ok(ModbusRequest::decode(frame.function_code(), frame.data())?)
}
pub fn decode_response(buf: &[u8]) -> Result<ModbusResponse, MbrtuError> {
let frame = Frame::parse_response(buf)?;
Ok(ModbusResponse::decode(frame.function_code(), frame.data())?)
}
pub fn encode_request(
address: u8,
request: &ModbusRequest,
buf: &mut [u8],
) -> Result<usize, MbrtuError> {
let mut data = [0u8; frame::MAX_DATA_LEN];
let data_len = request.encode(&mut data)?;
Ok(frame::encode(
buf,
address,
request.function_code(),
&data[..data_len],
)?)
}
pub fn encode_response(
address: u8,
response: &ModbusResponse,
buf: &mut [u8],
) -> Result<usize, MbrtuError> {
let mut data = [0u8; frame::MAX_DATA_LEN];
let data_len = response.encode(&mut data)?;
Ok(frame::encode(
buf,
address,
response.function_code(),
&data[..data_len],
)?)
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn decodes_a_reference_request_frame() {
let buf = [0x11, 0x03, 0x00, 0x6B, 0x00, 0x03, 0x76, 0x87];
let req = decode_request(&buf).unwrap();
let ModbusRequest::ReadHoldingRegisters(m) = req else {
panic!("expected ReadHoldingRegisters");
};
assert_eq!(m.starting_address, 0x006B);
assert_eq!(m.quantity, 3);
}
#[test]
fn encode_round_trips() {
let original = ModbusRequest::WriteSingleRegister(message::WriteSingleRegister {
address: 1,
value: 3,
});
let mut buf = [0u8; frame::MAX_FRAME_LEN];
let n = encode_request(0x01, &original, &mut buf).unwrap();
assert_eq!(decode_request(&buf[..n]).unwrap(), original);
}
}