fennec-modbus 0.87.0

Modular Modbus client implementation
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

use core::fmt::Debug;

use binrw::BinRead;
use thiserror::Error;

/// High-level protocol error.
///
/// The server received the request without a communication error, but could not handle it.
#[must_use]
#[derive(Copy, Clone, Debug, BinRead, Error)]
#[br(big)]
pub enum Exception {
    /// Client request was malformed.
    #[error("client error: {0}")]
    Client(ClientError),

    /// The server has failed.
    #[error("server error: {0}")]
    Server(ServerError),

    /// The client should retry.
    #[error("retry: {0}")]
    Retry(RetryException),

    /// The gateway could not delegate the request.
    #[error("gateway error: {0}")]
    Gateway(GatewayError),

    /// Unknown error code.
    #[error("unknown error ({0})")]
    Unknown(u8),
}

#[must_use]
#[derive(Copy, Clone, Debug, BinRead, Error)]
#[br(big)]
pub enum ClientError {
    /// The function code received in the query is not an allowable action for the server:
    ///
    /// - the function was not implemented in the unit selected;
    /// - the server is in the wrong state to process a request of this type.
    #[error("illegal function")]
    #[br(magic = 0x01_u8)]
    IllegalFunction,

    /// The data address received in the query is not an allowable address for the server.
    ///
    /// The combination of reference number and transfer length is invalid.
    #[error("illegal data address")]
    #[br(magic = 0x02_u8)]
    IllegalDataAddress,

    /// A value contained in the query data field is not an allowable value for server.
    #[error("illegal data value")]
    #[br(magic = 0x03_u8)]
    IllegalDataValue,
}

#[must_use]
#[derive(Copy, Clone, Debug, BinRead, Error)]
#[br(big)]
pub enum ServerError {
    /// An unrecoverable error occurred while the server was attempting to perform the requested action.
    #[error("server device failure")]
    #[br(magic = 0x04_u8)]
    ServerDeviceFailure,

    /// The server attempted to read record file, but  detected a parity error in the memory.
    ///
    /// The client can retry the request, but service may be required on the server device.
    #[error("memory parity error")]
    #[br(magic = 0x08_u8)]
    MemoryParityError,
}

#[must_use]
#[derive(Copy, Clone, Debug, BinRead, Error)]
#[br(big)]
pub enum RetryException {
    /// The server has accepted the request and is processing it, but a long duration of time will be
    /// required to do so.
    ///
    /// This response is returned to prevent a timeout error from occurring in the client.
    /// The client can next issue a «Poll Program Complete» message to determine if processing is completed.
    #[error("acknowledge")]
    #[br(magic = 0x05_u8)]
    Acknowledge,

    /// The server is engaged in processing a long–duration program command.
    ///
    /// The client should retransmit the message later when the server is free.
    #[error("server device busy")]
    #[br(magic = 0x06_u8)]
    ServerDeviceBusy,
}

#[must_use]
#[derive(Copy, Clone, Debug, BinRead, Error)]
#[br(big)]
pub enum GatewayError {
    /// The gateway was unable to allocate an internal communication path from the input port
    /// to the output port for processing the request.
    #[error("gateway path unavailable")]
    #[br(magic = 0x0A_u8)]
    GatewayPathUnavailable,

    /// No response was obtained from the target device.
    ///
    /// Usually means that the device is not present on the network.
    #[error("gateway target device failed to respond")]
    #[br(magic = 0x0B_u8)]
    GatewayTargetDeviceFailedToRespond,
}