Struct capsules_extra::buzzer_pwm::PwmBuzzer

pub struct PwmBuzzer<'a, A: Alarm<'a>, P: PwmPin> { /* private fields */ }

Implementations

impl<'a, A: Alarm<'a>, P: PwmPin> PwmBuzzer<'a, A, P>

pub fn new( pwm_pin: &'a P, alarm: &'a A, max_duration_ms: usize, ) -> PwmBuzzer<'a, A, P>

Trait Implementations

impl<'a, A: Alarm<'a>, P: PwmPin> AlarmClient for PwmBuzzer<'a, A, P>

fn alarm(&self)

Callback indicating the alarm time has been reached. The alarm MUST be disabled when this is called. If a new alarm is needed, the client can call Alarm::set_alarm.

impl<'a, A: Alarm<'a>, P: PwmPin> Buzzer<'a> for PwmBuzzer<'a, A, P>

fn set_client(&self, client: &'a dyn BuzzerClient)

Set the client to be used for callbacks of the Buzzer implementation.

fn buzz(&self, frequency_hz: usize, duration_ms: usize) -> Result<(), ErrorCode>

Play a sound at a chosen frequency and for a chosen duration. Once the buzzer finishes buzzing, the buzzer_done() callback is called. If it is called while the buzzer is playing, the buzzer command will be overridden with the new frequency and duration values.

fn stop(&self) -> Result<(), ErrorCode>

Stop the sound currently playing. After the buzzer is successfully stopped, the buzzer_done() callback is called.