openrgb 0.1.2

OpenRGB SDK client
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

use array2d::Array2D;
use async_trait::async_trait;

use crate::data::{OpenRGBReadable, ZoneType};
use crate::OpenRGBError;
use crate::protocol::OpenRGBReadableStream;

/// RGB controller zone.
///
/// See [Open SDK documentation](https://gitlab.com/CalcProgrammer1/OpenRGB/-/wikis/OpenRGB-SDK-Documentation#zone-data) for more information.
#[derive(Debug, Eq, PartialEq)]
pub struct Zone {
    /// Zone name.
    pub name: String,

    /// Zone type.
    pub r#type: ZoneType,

    /// Zone minimum LED number.
    pub leds_min: u32,

    /// Zone maximum LED number.
    pub leds_max: u32,

    /// Zone LED count.
    pub leds_count: u32,

    /// Zone LED matrix (if [Zone::type] is [ZoneType::Matrix]).
    pub matrix: Option<Array2D<u32>>,
}

#[async_trait]
impl OpenRGBReadable for Zone {
    async fn read(stream: &mut impl OpenRGBReadableStream, protocol: u32) -> Result<Self, OpenRGBError> {
        let name = stream.read_value(protocol).await?;
        let r#type = stream.read_value(protocol).await?;
        let leds_min = stream.read_value(protocol).await?;
        let leds_max = stream.read_value(protocol).await?;
        let leds_count = stream.read_value(protocol).await?;
        let matrix_len = stream.read_value::<u16>(protocol).await? as usize;
        let matrix = match matrix_len {
            0 => None,
            _ => Some({
                let matrix_height = stream.read_value::<u32>(protocol).await? as usize;
                let matrix_width = stream.read_value::<u32>(protocol).await? as usize;
                let matrix_size = matrix_height * matrix_width;
                let mut matrix_data = Vec::with_capacity(matrix_size);
                for _ in 0..matrix_size {
                    matrix_data.push(stream.read_value(protocol).await?);
                }
                Array2D::from_row_major(&matrix_data, matrix_height, matrix_width)
            })
        };
        Ok(Zone {
            name,
            r#type,
            leds_min,
            leds_max,
            leds_count,
            matrix,
        })
    }
}

#[cfg(test)]
mod tests {
    use std::error::Error;

    use array2d::Array2D;
    use tokio_test::io::Builder;

    use crate::data::{Zone, ZoneType};
    use crate::DEFAULT_PROTOCOL;
    use crate::protocol::OpenRGBReadableStream;
    use crate::tests::setup;

    #[tokio::test]
    async fn test_read_001() -> Result<(), Box<dyn Error>> {
        setup()?;

        let mut stream = Builder::new()
            .read(&5_u16.to_le_bytes()) // name len
            .read(b"test\0") // name
            .read(&1_u32.to_le_bytes()) // type
            .read(&3_u32.to_le_bytes()) // leds_min
            .read(&18_u32.to_le_bytes()) // leds_max
            .read(&15_u32.to_le_bytes()) // leds_count
            .read(&0_u16.to_le_bytes()) // matrix_len
            .build();

        assert_eq!(stream.read_value::<Zone>(DEFAULT_PROTOCOL).await?, Zone {
            name: "test".to_string(),
            r#type: ZoneType::Linear,
            leds_min: 3,
            leds_max: 18,
            leds_count: 15,
            matrix: None,
        });

        Ok(())
    }

    #[tokio::test]
    async fn test_read_002() -> Result<(), Box<dyn Error>> {
        setup()?;

        let mut stream = Builder::new()
            .read(&5_u16.to_le_bytes()) // name len
            .read(b"test\0") // name
            .read(&1_u32.to_le_bytes()) // type
            .read(&3_u32.to_le_bytes()) // leds_min
            .read(&18_u32.to_le_bytes()) // leds_max
            .read(&15_u32.to_le_bytes()) // leds_count
            .read(&32_u16.to_le_bytes()) // matrix_len
            .read(&2_u32.to_le_bytes()) // matrix_height
            .read(&3_u32.to_le_bytes()) // matrix_width
            .read(&0_u32.to_le_bytes()) // matrix[0]
            .read(&1_u32.to_le_bytes()) // matrix[1]
            .read(&2_u32.to_le_bytes()) // matrix[2]
            .read(&3_u32.to_le_bytes()) // matrix[3]
            .read(&4_u32.to_le_bytes()) // matrix[4]
            .read(&5_u32.to_le_bytes()) // matrix[5]
            .build();

        assert_eq!(stream.read_value::<Zone>(DEFAULT_PROTOCOL).await?, Zone {
            name: "test".to_string(),
            r#type: ZoneType::Linear,
            leds_min: 3,
            leds_max: 18,
            leds_count: 15,
            matrix: Some(Array2D::from_rows(&[vec![0, 1, 2], vec![3, 4, 5]])),
        });

        Ok(())
    }
}