Struct rust_gpiozero::output_devices::Buzzer

pub struct Buzzer { /* fields omitted */ }

Represents a digital buzzer component.

Connect the cathode (negative pin) of the buzzer to a ground pin; connect the other side to any GPIO pin.

Methods

impl Buzzer

pub fn new(pin: u8) -> Buzzer

pub fn is_active(&self) -> bool

Returns True if the device is currently active and False otherwise.

pub fn on(&self)

Turns the device on.

pub fn off(&self)

Turns the device off.

pub fn toggle(&mut self)

Reverse the state of the device. If it's on, turn it off; if it's off, turn it on.

pub fn value(&self) -> bool

Returns True if the device is currently active and False otherwise.

pub fn active_high(&self) -> bool

When True, the value property is True when the device's pin is high. When False the value property is True when the device's pin is low (i.e. the value is inverted). Be warned that changing it will invert value (i.e. changing this property doesn't change the device's pin state - it just changes how that state is interpreted).

pub fn set_active_high(&mut self, value: bool)

Set the state for active_high

pub fn pin(&self) -> u8

The Pin that the device is connected to.

pub fn close(self)

Shut down the device and release all associated resources.

pub fn wait(&mut self)

Block until background process is done

pub fn beep(&mut self, on_time: f32, off_time: f32)

Make the device turn on and off repeatedly in the background. Use set_beep_count to set the number of times to beep the device

• on_time - Number of seconds on
• off_time - Number of seconds off

pub fn set_beep_count(&mut self, n: i32)

Set the number of times to beep the device

• n - Number of times to beep

Trait Implementations

impl Debug for Buzzer

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.