Struct esp_idf_hal::gpio::PinDriver

pub struct PinDriver<'d, T: Pin, MODE> { /* private fields */ }

A driver for a GPIO pin.

The driver can set the pin as a disconnected/disabled one, input, or output pin, or both or analog. On some chips (i.e. esp32 and esp32s*), the driver can also set the pin in RTC IO mode. Depending on the current operating mode, different sets of functions are available.

The mode-setting depends on the capabilities of the pin as well, i.e. input-only pins cannot be set into output or input-output mode.

Implementations

impl<'d, T: Pin> PinDriver<'d, T, Disabled>

pub fn disabled(pin: impl Peripheral<P = T> + 'd) -> Result<Self, EspError>

Creates the driver for a pin in disabled state.

impl<'d, T: InputPin> PinDriver<'d, T, Input>

pub fn input(pin: impl Peripheral<P = T> + 'd) -> Result<Self, EspError>

Creates the driver for a pin in input state.

impl<'d, T: InputPin + OutputPin> PinDriver<'d, T, InputOutput>

pub fn input_output(pin: impl Peripheral<P = T> + 'd) -> Result<Self, EspError>

Creates the driver for a pin in input-output state.

impl<'d, T: InputPin + OutputPin> PinDriver<'d, T, InputOutput>

pub fn input_output_od( pin: impl Peripheral<P = T> + 'd ) -> Result<Self, EspError>

Creates the driver for a pin in input-output open-drain state.

impl<'d, T: OutputPin> PinDriver<'d, T, Output>

pub fn output(pin: impl Peripheral<P = T> + 'd) -> Result<Self, EspError>

Creates the driver for a pin in output state.

impl<'d, T: OutputPin> PinDriver<'d, T, Output>

pub fn output_od(pin: impl Peripheral<P = T> + 'd) -> Result<Self, EspError>

Creates the driver for a pin in output open-drain state.

impl<'d, T: Pin, MODE> PinDriver<'d, T, MODE>

pub fn pin(&self) -> i32

Returns the pin number.

pub fn into_disabled(self) -> Result<PinDriver<'d, T, Disabled>, EspError>

Put the pin into disabled mode.

pub fn into_input(self) -> Result<PinDriver<'d, T, Input>, EspError>where T: InputPin,

Put the pin into input mode.

pub fn into_input_output( self ) -> Result<PinDriver<'d, T, InputOutput>, EspError>where T: InputPin + OutputPin,

Put the pin into input + output mode.

pub fn into_input_output_od( self ) -> Result<PinDriver<'d, T, InputOutput>, EspError>where T: InputPin + OutputPin,

Put the pin into input + output Open Drain mode.

This is commonly used for “open drain” mode. the hardware will drive the line low if you set it to low, and will leave it floating if you set it to high, in which case you can read the input to figure out whether another device is driving the line low.

pub fn into_output(self) -> Result<PinDriver<'d, T, Output>, EspError>where T: OutputPin,

Put the pin into output mode.

pub fn into_output_od(self) -> Result<PinDriver<'d, T, Output>, EspError>where T: OutputPin,

Put the pin into output Open Drain mode.

pub fn get_drive_strength(&self) -> Result<DriveStrength, EspError>where MODE: OutputMode,

pub fn set_drive_strength( &mut self, strength: DriveStrength ) -> Result<(), EspError>where MODE: OutputMode,

pub fn is_high(&self) -> boolwhere MODE: InputMode,

pub fn is_low(&self) -> boolwhere MODE: InputMode,

pub fn get_level(&self) -> Levelwhere MODE: InputMode,

pub fn is_set_high(&self) -> boolwhere MODE: OutputMode,

pub fn is_set_low(&self) -> boolwhere MODE: OutputMode,

Is the output pin set as low?

pub fn set_high(&mut self) -> Result<(), EspError>where MODE: OutputMode,

pub fn set_low(&mut self) -> Result<(), EspError>where MODE: OutputMode,

Set the output as low.

pub fn set_level(&mut self, level: Level) -> Result<(), EspError>where MODE: OutputMode,

pub fn toggle(&mut self) -> Result<(), EspError>where MODE: OutputMode,

Toggle pin output

pub fn set_pull(&mut self, pull: Pull) -> Result<(), EspError>where T: InputPin + OutputPin, MODE: InputMode,

pub unsafe fn subscribe( &mut self, callback: impl FnMut() + 'static ) -> Result<(), EspError>where MODE: InputMode,

Safety

Care should be taken not to call STD, libc or FreeRTOS APIs (except for a few allowed ones) in the callback passed to this function, as it is executed in an ISR context.

pub fn unsubscribe(&mut self) -> Result<(), EspError>where MODE: InputMode,

pub fn enable_interrupt(&mut self) -> Result<(), EspError>where MODE: InputMode,

pub fn disable_interrupt(&mut self) -> Result<(), EspError>where MODE: InputMode,

pub fn set_interrupt_type( &mut self, interrupt_type: InterruptType ) -> Result<(), EspError>where MODE: InputMode,

impl<T: Pin, MODE: InputMode> PinDriver<'_, T, MODE>

pub async fn wait_for_high(&mut self) -> Result<(), GpioError>

pub async fn wait_for_low(&mut self) -> Result<(), GpioError>

pub async fn wait_for_rising_edge(&mut self) -> Result<(), GpioError>

pub async fn wait_for_falling_edge(&mut self) -> Result<(), GpioError>

pub async fn wait_for_any_edge(&mut self) -> Result<(), GpioError>

Trait Implementations

impl<'d, T: Pin, MODE> Drop for PinDriver<'d, T, MODE>

fn drop(&mut self)

Executes the destructor for this type.

impl<'d, T: Pin, MODE> ErrorType for PinDriver<'d, T, MODE>

type Error = GpioError

Error type

impl<'d, T: Pin, MODE> InputPin for PinDriver<'d, T, MODE>where MODE: InputMode,

type Error = EspError

Error type

fn is_high(&self) -> Result<bool, Self::Error>

Is the input pin high?

fn is_low(&self) -> Result<bool, Self::Error>

Is the input pin low?

impl<'d, T: Pin, MODE> InputPin for PinDriver<'d, T, MODE>where MODE: InputMode,

fn is_high(&self) -> Result<bool, Self::Error>

Is the input pin high?

fn is_low(&self) -> Result<bool, Self::Error>

Is the input pin low?

impl<'d, T: Pin, MODE> OutputPin for PinDriver<'d, T, MODE>where MODE: OutputMode,

fn set_high(&mut self) -> Result<(), Self::Error>

Drives the pin high

fn set_low(&mut self) -> Result<(), Self::Error>

Drives the pin low

fn set_state(&mut self, state: PinState) -> Result<(), Self::Error>

Drives the pin high or low depending on the provided value

impl<'d, T: Pin, MODE> OutputPin for PinDriver<'d, T, MODE>where MODE: OutputMode,

type Error = GpioError

Error type

fn set_high(&mut self) -> Result<(), Self::Error>

Drives the pin high

fn set_low(&mut self) -> Result<(), Self::Error>

Drives the pin low

fn set_state(&mut self, state: PinState) -> Result<(), Self::Error>

Drives the pin high or low depending on the provided value

impl<'d, T: Pin, MODE> StatefulOutputPin for PinDriver<'d, T, MODE>where MODE: OutputMode,

fn is_set_high(&self) -> Result<bool, Self::Error>

Is the pin in drive high mode?

fn is_set_low(&self) -> Result<bool, Self::Error>

Is the pin in drive low mode?

impl<'d, T: Pin, MODE> StatefulOutputPin for PinDriver<'d, T, MODE>where MODE: OutputMode,

fn is_set_high(&self) -> Result<bool, Self::Error>

Is the pin in drive high mode?

fn is_set_low(&self) -> Result<bool, Self::Error>

Is the pin in drive low mode?

impl<'d, T: Pin, MODE> ToggleableOutputPin for PinDriver<'d, T, MODE>where MODE: OutputMode,

type Error = EspError

Error type

fn toggle(&mut self) -> Result<(), Self::Error>

Toggle pin output.

impl<'d, T: Pin, MODE> ToggleableOutputPin for PinDriver<'d, T, MODE>where MODE: OutputMode,

fn toggle(&mut self) -> Result<(), Self::Error>

Toggle pin output.

impl<'d, T: Pin, MODE> Send for PinDriver<'d, T, MODE>