modbus-mapping-derive 0.4.0

Derive macros for modbus-mapping
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165

use crate::config::Config;
use crate::entry::{Address, Entry, Quantity, ScaleFactor};
use proc_macro2::Ident;
use syn::{Data, DeriveInput, Fields};

#[derive(Debug, Clone)]
pub struct Mapping(pub Vec<Entry>);

impl Mapping {
    pub fn new(ast: &DeriveInput) -> Self {
        let data_struct = match ast.data.clone() {
            Data::Struct(data_struct) => data_struct,
            _ => panic!("Trait can be implemented only for a struct."),
        };

        let named_fields = match data_struct.fields {
            Fields::Named(fields_named) => fields_named.named,
            _ => panic!("Trait can be implemented only for a struct with named fields."),
        };
        let mut map: Vec<Entry> = named_fields
            .into_iter()
            .filter(|field| {
                field
                    .attrs
                    .iter()
                    .any(|attr| attr.path().is_ident("modbus"))
            })
            .map(From::from)
            .collect::<Vec<_>>();

        map.sort_by_key(|x| x.addr);

        Self(map)
    }

    pub fn field_name_vec(&self) -> Vec<Ident> {
        self.0
            .iter()
            .map(|x| x.field_name_ident())
            .collect::<Vec<_>>()
    }

    pub fn field_ty_vec(&self) -> Vec<Ident> {
        self.0
            .iter()
            .map(|x| x.field_ty_ident())
            .collect::<Vec<_>>()
    }

    pub fn addr_vec(&self) -> Vec<Address> {
        self.0.iter().map(|x| x.addr).collect::<Vec<_>>()
    }

    pub fn ty_vec(&self) -> Vec<Ident> {
        self.0
            .iter()
            .map(|entry| entry.ty_ident())
            .collect::<Vec<_>>()
    }

    pub fn cnt_vec(&self) -> Vec<Quantity> {
        self.0.iter().map(|x| x.ty.word_size()).collect::<Vec<_>>()
    }

    pub fn fn_to_words_vec(&self) -> Vec<Ident> {
        self.0
            .iter()
            .map(|entry| entry.fn_to_words())
            .collect::<Vec<_>>()
    }

    pub fn fn_from_words_vec(&self) -> Vec<Ident> {
        self.0
            .iter()
            .map(|entry| entry.fn_from_words())
            .collect::<Vec<_>>()
    }

    pub fn x_vec(&self) -> Vec<ScaleFactor> {
        self.0.iter().map(|x| x.x).collect::<Vec<_>>()
    }

    pub fn register_range(&self) -> (Address, Address) {
        if self.0.is_empty() {
            (0, 0)
        } else {
            let first = self.0.first().unwrap();
            let last = self.0.last().unwrap();
            (first.addr, last.addr + last.ty.word_size())
        }
    }
}

impl Mapping {
    pub fn split_into_block_mappings(self, config: &Config) -> Vec<Self> {
        let mut block_mappings = vec![];

        let mut entries = Vec::with_capacity(self.0.len());

        for entry in self.0 {
            if entries.is_empty() {
                entries.push(entry);
            } else {
                let first = entries.first().unwrap();
                let last = entries.last().unwrap();
                let max_cond =
                    entry.addr + entry.ty.word_size() - first.addr <= config.max_cnt_per_request;
                let gap_cond = last.addr + last.ty.word_size() == entry.addr;

                if max_cond && (gap_cond || config.allow_register_gaps) {
                    entries.push(entry)
                } else {
                    let mapping = Mapping(entries.clone());
                    block_mappings.push(mapping);
                    entries.clear();
                    entries.push(entry);
                }
            }
        }

        let mapping = Mapping(entries.clone());
        block_mappings.push(mapping);

        block_mappings
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::entry::{DataType, WordOrder};

    #[test]
    fn test_split_into_block_mappings() {
        let addrs = [0, 4, 8, 10];
        let mapping = Mapping(
            addrs
                .into_iter()
                .map(|addr| Entry {
                    field_name: format!("field_{}", addr),
                    field_ty: format!("ty_{}", addr),
                    addr: addr,
                    ty: DataType::F32,
                    ord: WordOrder::BigEndian,
                    x: 1.0,
                    unit: format!("unit_{}", addr),
                })
                .collect(),
        );

        for (allow_register_gaps, expected) in [(true, vec![2, 2]), (false, vec![1, 1, 2])] {
            let config = Config {
                max_cnt_per_request: 8,
                allow_register_gaps,
            };
            let result = mapping
                .clone()
                .split_into_block_mappings(&config)
                .iter()
                .map(|m| m.0.len())
                .collect::<Vec<_>>();
            assert_eq!(result, expected)
        }
    }
}