mbus-client 0.6.0

Modbus client stack for embedded and std environments with TCP, RTU, and ASCII transport support for modbus-rs project
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

use heapless::Vec;

use crate::{
    services::file_record::MAX_SUB_REQUESTS_PER_PDU,
    services::file_record::{
        request::ReqPduCompiler,
        response::ResponseParser,
        {SubRequest, SubRequestParams},
    },
};
use mbus_core::{
    data_unit::common::{self, MAX_ADU_FRAME_LEN, Pdu},
    errors::MbusError,
    function_codes::public::FunctionCode,
    transport::TransportType,
};

/// Provides operations for creating and parsing Modbus File Record request/response PDUs.
#[derive(Debug, Clone)]
pub struct ServiceBuilder;

impl ServiceBuilder {
    /// Sends a Read File Record request.
    pub fn read_file_record(
        txn_id: u16,
        unit_id: u8,
        sub_request: &SubRequest,
        transport_type: TransportType,
    ) -> Result<Vec<u8, MAX_ADU_FRAME_LEN>, MbusError> {
        let pdu = ReqPduCompiler::read_file_record_request(sub_request)?;
        common::compile_adu_frame(txn_id, unit_id, pdu, transport_type)
    }

    /// Sends a Write File Record request.
    pub fn write_file_record(
        txn_id: u16,
        unit_id: u8,
        sub_request: &SubRequest,
        transport_type: TransportType,
    ) -> Result<Vec<u8, MAX_ADU_FRAME_LEN>, MbusError> {
        let pdu = ReqPduCompiler::write_file_record_request(sub_request)?;
        common::compile_adu_frame(txn_id, unit_id, pdu, transport_type)
    }
}

/// Provides operations for creating and parsing Modbus File Record request/response PDUs.
#[derive(Debug, Clone)]
pub struct ServiceDecompiler;

impl ServiceDecompiler {
    /// Handles a Read File Record response.
    pub fn handle_read_file_record_rsp(
        function_code: FunctionCode,
        pdu: &Pdu,
    ) -> Result<Vec<SubRequestParams, MAX_SUB_REQUESTS_PER_PDU>, MbusError> {
        if function_code != FunctionCode::ReadFileRecord {
            return Err(MbusError::InvalidFunctionCode);
        }
        ResponseParser::parse_read_file_record_response(pdu)
    }

    /// Handles a Write File Record response.
    pub fn handle_write_file_record_rsp(
        function_code: FunctionCode,
        pdu: &Pdu,
    ) -> Result<(), MbusError> {
        if function_code != FunctionCode::WriteFileRecord {
            return Err(MbusError::InvalidFunctionCode);
        }
        ResponseParser::parse_write_file_record_response(pdu)
    }
}