device-envoy-rp 0.1.0

Build Pico applications with LED panels, easy Wi-Fi, and composable device abstractions
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

// @generated by `cargo check-all`. Do not edit by hand.
//! Module containing generated LCD text sample types.
//!
//! Auto-generated.

#[cfg(all(not(doc), not(feature = "host")))]
use crate::i2cs;

#[cfg(all(not(doc), not(feature = "host")))]
i2cs! {
    i2c: I2C0,
    sda_pin: PIN_4,
    scl_pin: PIN_5,
    pub I2csGenerated {
        pub LcdTextGenerated { width: 16, height: 2, address: 0x27 },
        pub LcdTextGenerated20x4 { width: 20, height: 4, address: 0x3F },
    }
}

#[cfg(doc)]
/// Sample struct type generated by the [`i2cs!`](macro@crate::i2cs) macro.
///
/// This page exists to show constructor and methods in one place.
/// For narrative examples, see the [`lcd_text`](mod@crate::lcd_text) module.
///
/// Auto-generated.
pub struct LcdTextGenerated;

#[cfg(doc)]
use crate::Result;

#[cfg(doc)]
/// Sample I2C LCD group type generated by [`i2cs!`](macro@crate::i2cs).
pub struct I2csGenerated;

#[cfg(doc)]
/// Sample LCD text struct type generated by [`i2cs!`](macro@crate::i2cs).
pub struct LcdTextGenerated20x4;

#[cfg(doc)]
impl I2csGenerated {
    /// Construct all generated LCD text devices in this group.
    /// See the [`lcd_text` module documentation](mod@crate::lcd_text) for usage examples.
    pub fn new(
        i2c_peripheral: embassy_rp::Peri<'static, embassy_rp::peripherals::I2C0>,
        sda: embassy_rp::Peri<'static, embassy_rp::peripherals::PIN_4>,
        scl: embassy_rp::Peri<'static, embassy_rp::peripherals::PIN_5>,
        spawner: embassy_executor::Spawner,
    ) -> Result<(&'static LcdTextGenerated, &'static LcdTextGenerated20x4)> {
        static INSTANCE_16X2: LcdTextGenerated = LcdTextGenerated;
        static INSTANCE_20X4: LcdTextGenerated20x4 = LcdTextGenerated20x4;
        let _ = (i2c_peripheral, sda, scl, spawner);
        Ok((&INSTANCE_16X2, &INSTANCE_20X4))
    }
}

#[cfg(doc)]
impl LcdTextGenerated {
    /// Display width in characters.
    pub const WIDTH: usize = 16;
    /// Display height in characters.
    pub const HEIGHT: usize = 2;
    /// LCD I2C address.
    pub const ADDRESS: u8 = 0x27;

    /// Create this generated LCD text instance.
    /// See the [`lcd_text` module documentation](mod@crate::lcd_text) for usage examples.
    pub fn new(
        i2c_peripheral: embassy_rp::Peri<'static, embassy_rp::peripherals::I2C0>,
        sda: embassy_rp::Peri<'static, embassy_rp::peripherals::PIN_4>,
        scl: embassy_rp::Peri<'static, embassy_rp::peripherals::PIN_5>,
        spawner: embassy_executor::Spawner,
    ) -> Result<&'static Self> {
        static INSTANCE: LcdTextGenerated = LcdTextGenerated;
        let _ = (i2c_peripheral, sda, scl, spawner);
        Ok(&INSTANCE)
    }
}

#[cfg(doc)]
impl crate::lcd_text::LcdText<16, 2> for LcdTextGenerated {
    const ADDRESS: u8 = 0x27;

    fn write_text(&self, text: impl AsRef<str>) {
        let _ = text;
    }
}

#[cfg(doc)]
impl LcdTextGenerated20x4 {
    /// Display width in characters.
    pub const WIDTH: usize = 20;
    /// Display height in characters.
    pub const HEIGHT: usize = 4;
    /// LCD I2C address.
    pub const ADDRESS: u8 = 0x3F;

    /// Create this generated LCD text instance.
    /// See the [`lcd_text` module documentation](mod@crate::lcd_text) for usage examples.
    pub fn new(
        i2c_peripheral: embassy_rp::Peri<'static, embassy_rp::peripherals::I2C0>,
        sda: embassy_rp::Peri<'static, embassy_rp::peripherals::PIN_4>,
        scl: embassy_rp::Peri<'static, embassy_rp::peripherals::PIN_5>,
        spawner: embassy_executor::Spawner,
    ) -> Result<&'static Self> {
        static INSTANCE: LcdTextGenerated20x4 = LcdTextGenerated20x4;
        let _ = (i2c_peripheral, sda, scl, spawner);
        Ok(&INSTANCE)
    }
}

#[cfg(doc)]
impl crate::lcd_text::LcdText<20, 4> for LcdTextGenerated20x4 {
    const ADDRESS: u8 = 0x3F;

    fn write_text(&self, text: impl AsRef<str>) {
        let _ = text;
    }
}