can2mqtt 3.0.2

CAN-Bus -- MQTT bridge: bidirectional, configurable and extendable
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 std::fmt;

use crate::converter::types::{CANFrame, Converter, MQTTPayload};
use hex;

#[derive(Debug, Default)]
pub struct ByteColor2ColorCodeConverter {}

impl Converter for ByteColor2ColorCodeConverter {
    fn towards_mqtt(self: &ByteColor2ColorCodeConverter, cf: CANFrame) -> Result<MQTTPayload, String> {
        if cf.len() != 3 {
            return Err(format!(
                "Input does not contain exactly 3 bytes, got {} instead",
                cf.len()
            ));
        }
        Ok(MQTTPayload::from(format!(
            "#{:02x}{:02x}{:02x}",
            cf[0], cf[1], cf[2]
        )))
    }

    fn towards_can(self: &ByteColor2ColorCodeConverter, msg: MQTTPayload) -> Result<CANFrame, String> {
        if !msg.is_ascii() {
            return Err(("input contains non-ASCII characters").to_string());
        }
        let str = msg.escape_ascii().to_string();
        let str = str.strip_prefix("#").unwrap_or(&str);
        if str.len() != 6 {
            return Err(format!(
                "input does not contain exactly 6 nibbles each represented by one character, got {} instead",
                str.len()
            ));
        }
        match hex::decode(str) {
            Ok(v) => {
                assert_eq!(v.len(), 3);
                Ok(CANFrame::new([v[0], v[1], v[2]]))
            }
            Err(e) => Err(format!("Error while converting: {e}")),
        }
    }
}

impl fmt::Display for ByteColor2ColorCodeConverter {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "bytecolor2colorcode")
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn towards_can_test() {
        let cv = ByteColor2ColorCodeConverter {};
        let msg = MQTTPayload::from("#00ff00");
        match cv.towards_can(msg) {
            Ok(cf) => {
                assert_eq!(cf.len(), 3);
                assert_eq!(cf[0], 0);
                assert_eq!(cf[1], 255);
                assert_eq!(cf[2], 0);
            }
            Err(e) => {
                panic!("{}", e)
            }
        }
    }

    #[test]
    fn towards_can_test2() {
        let cv = ByteColor2ColorCodeConverter {};
        let msg = MQTTPayload::from("00ff00");
        match cv.towards_can(msg) {
            Ok(cf) => {
                assert_eq!(cf.len(), 3);
                assert_eq!(cf[0], 0);
                assert_eq!(cf[1], 255);
                assert_eq!(cf[2], 0);
            }
            Err(e) => {
                panic!("{}", e)
            }
        }
    }

    #[test]
    fn towards_can_test3() {
        let cv = ByteColor2ColorCodeConverter {};
        let msg = MQTTPayload::from("0ff00");
        cv.towards_can(msg)
            .expect_err("message too short, should fail");
    }

    #[test]
    fn towards_can_test4() {
        let cv = ByteColor2ColorCodeConverter {};
        let msg = MQTTPayload::from("00tf00");
        cv.towards_can(msg)
            .expect_err("message contains non-hex bytes, should fail");
    }

    #[test]
    fn towards_can_test5() {
        let cv = ByteColor2ColorCodeConverter {};
        let msg = MQTTPayload::from("00Ff00");
        match cv.towards_can(msg) {
            Ok(cf) => {
                assert_eq!(cf.len(), 3);
                assert_eq!(cf[0], 0);
                assert_eq!(cf[1], 255);
                assert_eq!(cf[2], 0);
            }
            Err(e) => {
                panic!("{}", e)
            }
        }
    }

    #[test]
    fn towards_mqtt_test() {
        let cv = ByteColor2ColorCodeConverter {};
        let cf = CANFrame::new([0, 255, 0]);
        match cv.towards_mqtt(cf) {
            Ok(msg) => {
                assert_eq!(msg, "#00ff00")
            }
            Err(e) => {
                panic!("{}", e)
            }
        }
    }

    #[test]
    fn towards_mqtt_test2() {
        let cv = ByteColor2ColorCodeConverter {};
        let cf = CANFrame::new([0, 255, 0, 0]);
        cv.towards_mqtt(cf)
            .expect_err("Should err, 4 bytes input are too long");
    }

    #[test]
    fn towards_mqtt_test3() {
        let cv = ByteColor2ColorCodeConverter {};
        let cf = CANFrame::new([0, 255]);
        cv.towards_mqtt(cf)
            .expect_err("Should err, 2 bytes input are too short");
    }

    #[test]
    fn back_and_forth() {
        let cv = ByteColor2ColorCodeConverter {};
        let cf = CANFrame::new([0, 255, 0]);
        let msg = cv.towards_mqtt(cf).unwrap();
        assert_eq!(cf, cv.towards_can(msg).unwrap());
    }

    #[test]
    fn test_name() {
        let cv = ByteColor2ColorCodeConverter {};
        assert_eq!(cv.to_string(), "bytecolor2colorcode");
    }
}