knust 0.1.1

Asynchronous KNX/IP library 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

//! DPT 17.xxx - Scene Number

use super::{DptValue, Result};
use crate::error::ProtocolError;

/// DPT 17.001 - Scene Number
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct SceneNumber {
    scene_number: u8,
    data: [u8; 1],
}

impl SceneNumber {
    /// # Errors
    ///
    /// Returns [`ProtocolError::DptError`] if `scene_number` is outside `1..=64`.
    pub fn new(scene_number: u8) -> Result<Self> {
        if !(1..=64).contains(&scene_number) {
            return Err(ProtocolError::DptError {
                dpt_type: "17.001".to_string(),
                details: format!("Scene number {scene_number} out of range [1-64]"),
            }
            .into());
        }

        Ok(Self {
            scene_number,
            data: [scene_number - 1],
        })
    }

    #[must_use]
    pub fn value(&self) -> u8 {
        self.scene_number
    }
}

impl DptValue for SceneNumber {
    const DPT_NUMBER: &'static str = "17.001";
    const VALUE_TYPE: &'static str = "scene_number";
    const BYTE_LENGTH: usize = 1;

    fn decode(bytes: &[u8]) -> Result<Self> {
        if bytes.len() != Self::BYTE_LENGTH {
            return Err(ProtocolError::DptError {
                dpt_type: Self::DPT_NUMBER.to_string(),
                details: format!(
                    "Invalid length: expected {}, got {}",
                    Self::BYTE_LENGTH,
                    bytes.len()
                ),
            }
            .into());
        }
        let scene_number = (bytes[0] & 0x3F) + 1;
        Ok(Self {
            scene_number,
            data: [scene_number - 1],
        })
    }

    fn validate(&self) -> Result<()> {
        if !(1..=64).contains(&self.scene_number) {
            return Err(ProtocolError::DptError {
                dpt_type: Self::DPT_NUMBER.to_string(),
                details: format!("Scene number {} out of range [1-64]", self.scene_number),
            }
            .into());
        }
        Ok(())
    }

    fn from_bytes(bytes: &[u8]) -> Result<Self> {
        Self::decode(bytes)
    }

    fn as_bytes(&self) -> &[u8] {
        &self.data
    }

    fn value_range() -> (f64, f64) {
        (1.0, 64.0)
    }
}

// Helper trait for aliases
use super::DptInnerType;

impl DptInnerType for SceneNumber {
    type InnerType = u8;
    fn new(value: u8) -> Self {
        SceneNumber::new(value).unwrap()
    }
    fn into_inner(self) -> u8 {
        self.scene_number
    }
}

// Python-style aliases
use crate::dpt_alias;

dpt_alias!(
    DPTSceneNumber,
    17,
    001,
    SceneNumber,
    "scene_number",
    None,
    None
);