openrgb2 0.3.0

OpenRGB SDK client, successor to openrgb
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

use crate::impl_enum_discriminant;

/// `OpenRGB` protocol packet ID.
///
/// See [Open SDK documentation](https://gitlab.com/CalcProgrammer1/OpenRGB/-/wikis/OpenRGB-SDK-Documentation#packet-ids) for more information.
#[derive(PartialEq, Debug, Copy, Clone)]
pub(crate) enum PacketId {
    /// Request `RGBController` device count from server.
    RequestControllerCount = 0,

    /// Request `RGBController` data block.
    RequestControllerData = 1,

    /// Request `OpenRGB` SDK protocol version from server.
    RequestProtocolVersion = 40,

    /// Send client name string to server.
    SetClientName = 50,

    /// Indicate to clients that device list has updated.
    DeviceListUpdated = 100,

    /// Request a device rescan. (Protocol 5)
    RequestDeviceRescan = 140,

    /// Request profile list. (Protocol 2)
    RequestProfileList = 150,

    /// Save current configuration in a new profile. (Protocol 2)
    RequestSaveProfile = 151,

    /// Load a given profile. (Protocol 2)
    RequestLoadProfile = 152,

    /// Delete a given profile. (Protocol 2)
    RequestDeleteProfile = 153,

    /// Request list of plugins. (Protocol 4)
    RequestPluginList = 200,

    /// Plugin specific request. (Protocol 4)
    PluginSpecific = 201,

    /// `RGBController::ResizeZone()`.
    RGBControllerResizeZone = 1000,

    /// `RGBController::ClearSegments()`. (Protocol 5)
    RgbControllerClearSegments = 1001,

    /// `RGBController::AddSegment()`. (Protocol 5)
    RGBControllerAddSegment = 1002,

    /// `RGBController::UpdateLEDs()`.
    RGBControllerUpdateLeds = 1050,

    /// `RGBController::UpdateZoneLEDs()`.
    RGBControllerUpdateZoneLeds = 1051,

    /// `RGBController::UpdateSingleLED()`.
    RGBControllerUpdateSingleLed = 1052,

    /// `RGBController::SetCustomMode()`.
    RGBControllerSetCustomMode = 1100,

    /// `RGBController::UpdateMode()`.
    RGBControllerUpdateMode = 1101,

    /// `RGBController::SaveMode()`. (Protocol 3)
    RGBControllerSaveMode = 1102,
}

impl_enum_discriminant!(
    PacketId,
    RequestControllerCount: 0,
    RequestControllerData: 1,
    RequestProtocolVersion: 40,
    SetClientName: 50,
    DeviceListUpdated: 100,
    RequestDeviceRescan: 140,
    RequestProfileList: 150,
    RequestSaveProfile: 151,
    RequestLoadProfile: 152,
    RequestDeleteProfile: 153,
    RequestPluginList: 200,
    PluginSpecific: 201,
    RGBControllerResizeZone: 1000,
    RgbControllerClearSegments: 1001,
    RGBControllerAddSegment: 1002,
    RGBControllerUpdateLeds: 1050,
    RGBControllerUpdateZoneLeds: 1051,
    RGBControllerUpdateSingleLed: 1052,
    RGBControllerSetCustomMode: 1100,
    RGBControllerUpdateMode: 1101,
    RGBControllerSaveMode: 1102
);

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

    use crate::{PacketId, WriteMessage};

    #[tokio::test]
    async fn test_read_001() -> Result<(), Box<dyn Error>> {
        let mut buf = WriteMessage::new(crate::DEFAULT_PROTOCOL);
        let mut msg = buf.push_value(&152_u32)?.to_received_msg();

        assert_eq!(msg.read_value::<PacketId>()?, PacketId::RequestLoadProfile);
        Ok(())
    }

    #[tokio::test]
    async fn test_write_001() -> Result<(), Box<dyn Error>> {
        let mut buf = WriteMessage::new(crate::DEFAULT_PROTOCOL);
        let mut msg = buf
            .push_value(&PacketId::RequestLoadProfile)?
            .to_received_msg();
        assert_eq!(msg.read_value::<u32>()?, 152);
        Ok(())
    }
}