device-envoy-esp 0.1.0

Build ESP32 applications with 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
120
121
122
123
124

// @generated by `cargo check-all`. Do not edit by hand.
//! Module containing [`AudioPlayerGenerated`], the sample struct type generated
//! by the [`audio_player!`](macro@crate::audio_player) macro.
//!
//! Auto-generated.

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

#[cfg(all(
    not(doc),
    not(feature = "host"),
    target_os = "none",
    esp_pdma_family
))]
audio_player! {
    pub AudioPlayerGenerated {
        data_pin: GPIO2,
        bit_clock_pin: GPIO3,
        word_select_pin: GPIO4,
        sample_rate_hz: crate::audio_player::VOICE_22050_HZ,
        dma: DMA_I2S0,
    }
}

#[cfg(all(
    not(doc),
    not(feature = "host"),
    target_os = "none",
    esp_gdma_family
))]
audio_player! {
    pub AudioPlayerGenerated {
        data_pin: GPIO2,
        bit_clock_pin: GPIO3,
        word_select_pin: GPIO4,
        sample_rate_hz: crate::audio_player::VOICE_22050_HZ,
        dma: DMA_CH0,
    }
}

#[cfg(doc)]
/// Sample struct type generated by the [`audio_player!`](macro@crate::audio_player)
/// macro, showing methods and associated constants.
///
/// This page serves as the reference for what a generated audio player type
/// provides. For first-time readers, start with the
/// [`audio_player`](mod@crate::audio_player) module documentation, then return
/// here for a complete list of available methods and associated constants.
///
/// The macro also generates [`AudioPlayerGeneratedPlayable`], a trait-object
/// alias for clip sources at the same sample rate.
///
/// Auto-generated.
pub struct AudioPlayerGenerated;

#[cfg(doc)]
/// Trait-object clip source type at [`VOICE_22050_HZ`].
///
/// See the [audio_player module documentation](mod@crate::audio_player) for
/// usage examples.
pub type AudioPlayerGeneratedPlayable = dyn Playable<VOICE_22050_HZ>;

#[cfg(doc)]
use crate::audio_player::{AtEnd, AudioPlayer, Playable, Volume, VOICE_22050_HZ};
#[cfg(doc)]
use crate::Result;

#[cfg(doc)]
impl AudioPlayerGenerated {
    /// Sample rate used for playback by this generated player type.
    ///
    /// See the [`audio_player`](mod@crate::audio_player) module docs for usage.
    pub const SAMPLE_RATE_HZ: u32 = VOICE_22050_HZ;
    /// Maximum number of clips accepted by `play(...)`.
    pub const MAX_CLIPS: usize = 16;
    /// Initial runtime volume relative to [`Self::MAX_VOLUME`].
    pub const INITIAL_VOLUME: Volume = Volume::MAX;
    /// Runtime volume ceiling for this generated player type.
    pub const MAX_VOLUME: Volume = Volume::MAX;

    /// Creates and spawns the generated audio player instance.
    ///
    /// See the [`audio_player`](mod@crate::audio_player) module docs for usage.
    pub fn new(
        data_pin: impl Sized,
        bit_clock_pin: impl Sized,
        word_select_pin: impl Sized,
        i2s: impl Sized,
        dma: impl Sized,
        spawner: embassy_executor::Spawner,
    ) -> Result<&'static Self> {
        static INSTANCE: AudioPlayerGenerated = AudioPlayerGenerated;
        let _ = (data_pin, bit_clock_pin, word_select_pin, i2s, dma, spawner);
        Ok(&INSTANCE)
    }
}

#[cfg(doc)]
impl AudioPlayer<VOICE_22050_HZ> for AudioPlayerGenerated {
    const SAMPLE_RATE_HZ: u32 = VOICE_22050_HZ;
    const MAX_CLIPS: usize = 16;
    const INITIAL_VOLUME: Volume = Volume::MAX;
    const MAX_VOLUME: Volume = Volume::MAX;

    fn play<I>(&self, audio_clips: I, at_end: AtEnd)
    where
        I: IntoIterator<Item = &'static dyn Playable<VOICE_22050_HZ>>,
    {
        let _ = (audio_clips, at_end);
    }

    fn stop(&self) {}

    async fn wait_until_stopped(&self) {}

    fn set_volume(&self, volume: Volume) {
        let _ = volume;
    }

    fn volume(&self) -> Volume {
        Volume::MAX
    }
}