fennec-modbus 0.90.2

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
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

//! Implementations of Modbus function arguments and outputs.

use core::marker::PhantomData;

use crate::{protocol, protocol::r#struct::Readable};

pub mod read_coils;
pub mod read_discrete_inputs;
pub mod read_exception_status;
pub mod read_registers;
pub mod write_multiple_coils;
pub mod write_multiple_registers;
pub mod write_single_coil;
pub mod write_single_register;

/// Associates function code with function type.
pub trait Code {
    /// Modbus function code.
    const CODE: u8;

    /// Modbus function code with the error flag
    const ERROR_CODE: u8 = Self::CODE | 0x80;
}

/// Read from 1 to 2000 contiguous status of coils in a remote device.
#[derive(Copy, Clone)]
#[must_use]
pub struct ReadCoils<S: Readable>(PhantomData<S>);

impl<S: Readable> Code for ReadCoils<S> {
    const CODE: u8 = 1;
}

impl<S: Readable> protocol::Function for ReadCoils<S> {
    type Args = read_coils::Args;
    type Output = read_coils::Output<S>;
}

/// Read from 1 to 2000 contiguous status of discrete inputs in a remote device.
#[derive(Copy, Clone)]
#[must_use]
pub struct ReadDiscreteInputs<S>(PhantomData<S>);

impl<S: Readable> Code for ReadDiscreteInputs<S> {
    const CODE: u8 = 2;
}

impl<S: Readable> protocol::Function for ReadDiscreteInputs<S> {
    type Args = read_discrete_inputs::Args;
    type Output = read_discrete_inputs::Output<S>;
}

/// Read the contents of a contiguous block of registers in a remote device.
#[must_use]
#[derive(Copy, Clone)]
pub struct ReadRegisters<C, V>(PhantomData<(C, V)>);

impl<C: Code, V: read_registers::Value> Code for ReadRegisters<C, V> {
    const CODE: u8 = C::CODE;
}

impl<C: Code, V: read_registers::Value> protocol::Function for ReadRegisters<C, V> {
    type Args = read_registers::Args<V>;
    type Output = read_registers::Output<V>;
}

/// Read the contents of a contiguous block of registers in a remote device.
///
/// This is the same function as [`ReadRegisters`] – but with the register count known at compile time.
#[must_use]
#[derive(Copy, Clone)]
pub struct ReadRegistersExact<C, V, const N: usize>(PhantomData<(C, V)>);

impl<C: Code, V: read_registers::Value, const N: usize> Code for ReadRegistersExact<C, V, N> {
    const CODE: u8 = C::CODE;
}

impl<C: Code, V: read_registers::Value, const N: usize> protocol::Function
    for ReadRegistersExact<C, V, N>
{
    type Args = read_registers::Args<V>;
    type Output = read_registers::OutputExact<N, V>;
}

/// Write a single output to either «on» or «off» in a remote device.
#[must_use]
pub struct WriteSingleCoil;

impl Code for WriteSingleCoil {
    const CODE: u8 = 5;
}

impl protocol::Function for WriteSingleCoil {
    type Args = write_single_coil::Payload;
    type Output = write_single_coil::Payload;
}

/// Write a single holding register in a remote device.
#[must_use]
pub struct WriteSingleRegister;

impl Code for WriteSingleRegister {
    const CODE: u8 = 6;
}

impl protocol::Function for WriteSingleRegister {
    type Args = write_single_register::Payload;
    type Output = write_single_register::Payload;
}

/// Read the contents of eight Exception Status outputs in a remote device.
#[must_use]
#[derive(Copy, Clone)]
pub struct ReadExceptionStatus;

impl Code for ReadExceptionStatus {
    const CODE: u8 = 7;
}

impl protocol::Function for ReadExceptionStatus {
    type Args = read_exception_status::Args;
    type Output = read_exception_status::Output;
}

/// Force each coil in a sequence of coils to either «on» or «off» in a remote device.
#[must_use]
pub struct WriteMultipleCoils;

impl Code for WriteMultipleCoils {
    const CODE: u8 = 15;
}

impl protocol::Function for WriteMultipleCoils {
    type Args = write_multiple_coils::Args;
    type Output = write_multiple_coils::Output;
}

/// Write a block of contiguous registers (1 to 123 registers) in a remote device.
#[must_use]
pub struct WriteMultipleRegisters;

impl Code for WriteMultipleRegisters {
    const CODE: u8 = 16;
}

impl protocol::Function for WriteMultipleRegisters {
    type Args = write_multiple_registers::Args;
    type Output = write_multiple_registers::Output;
}