esp-flow 0.2.0

ESP embedded library with reusable modules for BLE, Wi-Fi, HTTP, GPS, LED control, and more.
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

/// Represents an RGB color value.
///
/// # Fields
/// * `r` - Red component of the color.
/// * `g` - Green component of the color.
/// * `b` - Blue component of the color.
pub struct Rgb {
    r: u8,
    g: u8,
    b: u8,
}

impl Rgb {
    /// Creates a new `Rgb` instance.
    ///
    /// # Arguments
    /// * `r` - Red component of the color.
    /// * `g` - Green component of the color.
    /// * `b` - Blue component of the color.
    ///
    /// # Returns
    /// A new `Rgb` instance.
    #[must_use]
    pub fn new(r: u8, g: u8, b: u8) -> Self {
        Self { r, g, b }
    }
}

impl From<&Rgb> for u32 {
    /// Converts an `Rgb` instance to a `u32` color value.
    /// e.g. rgb: (1,2,4)
    /// G        R        B
    /// 7      0 7      0 7      0
    /// 00000010 00000001 00000100
    ///
    /// # Returns
    /// A `u32` representation of the RGB color.
    fn from(rgb: &Rgb) -> Self {
        (u32::from(rgb.g) << 16) | (u32::from(rgb.r) << 8) | u32::from(rgb.b)
    }
}

/// Default brightness level for predefined colors.
const DEFAULT_BRIGHTNESS: u8 = 25;

/// Predefined black color.
pub const BLACK: Rgb = Rgb { r: 0, g: 0, b: 0 };

/// Predefined green color with default brightness.
pub const GREEN: Rgb = Rgb {
    r: 0,
    g: DEFAULT_BRIGHTNESS,
    b: 0,
};

/// Predefined red color with default brightness.
pub const RED: Rgb = Rgb {
    r: DEFAULT_BRIGHTNESS,
    g: 0,
    b: 0,
};