echonet 1.3.2

ECHONET Lite framework for Rust
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

// Copyright (C) 2022 The uecho-rs Authors All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

pub const FORMAT1_PROPERTY_HEADER_SIZE: usize = 2;

/// PropertyCode represents an ECHONET-Lite property code (EPC) in an ECHONET-Lite message.
pub type PropertyCode = u8;

/// Each ECHONET-Lite message has properties. Property represents an ECHONET-Lite property of a message packet as specified in the ECHONET-Lite specification.
pub struct Property {
    code: PropertyCode,
    data: Vec<u8>,
}

impl Property {
    pub fn new() -> Property {
        Property {
            code: 0,
            data: Vec::new(),
        }
    }

    pub fn from(code: PropertyCode, data: Vec<u8>) -> Property {
        Property {
            code: code,
            data: data,
        }
    }

    pub fn set_code(&mut self, code: PropertyCode) -> &mut Self {
        self.code = code;
        self
    }

    pub fn code(&self) -> PropertyCode {
        self.code
    }

    pub fn set_data(&mut self, data: Vec<u8>) -> &mut Self {
        self.data = data.clone();
        self
    }

    pub fn data(&self) -> &Vec<u8> {
        &self.data
    }

    pub fn size(&self) -> usize {
        self.data.len()
    }

    pub fn parse(&mut self, msg: &[u8]) -> bool {
        let msg_len = msg.len();
        if msg_len < FORMAT1_PROPERTY_HEADER_SIZE {
            return false;
        }

        self.code = msg[0];
        let data_size = msg[1] as usize;

        self.data.clear();
        if data_size == 0 {
            return true;
        }

        if msg_len < (FORMAT1_PROPERTY_HEADER_SIZE + data_size) {
            return false;
        }

        let prop_data = &(*msg)[2..];
        for n in 0..data_size {
            self.data.push(prop_data[n]);
        }

        true
    }

    pub fn equals(&self, prop: &Property) -> bool {
        if self.code() != prop.code() {
            return false;
        }
        if self.size() != prop.size() {
            return false;
        }

        for n in 0..self.size() {
            if self.data[n] != prop.data[n] {
                return false;
            }
        }

        true
    }
}

impl Clone for Property {
    fn clone(&self) -> Property {
        Property {
            code: self.code(),
            data: self.data.clone(),
        }
    }
}