Struct rppal::gpio::Pin

pub struct Pin { /* private fields */ }

Unconfigured GPIO pin.

Pins are constructed by retrieving them using Gpio::get.

An unconfigured Pin can be used to read the pin’s mode and logic level. Converting the Pin to an InputPin, OutputPin or IoPin through the various into_ methods available on Pin configures the appropriate mode, and provides access to additional methods relevant to the selected pin mode.

The embedded-hal trait implementations for Pin can be enabled by specifying the optional hal feature in the dependency declaration for the rppal crate.

Implementations

impl Pin

pub fn pin(&self) -> u8

Returns the GPIO pin number.

Pins are addressed by their BCM GPIO numbers, rather than their physical location.

pub fn mode(&self) -> Mode

Returns the pin’s mode.

pub fn read(&self) -> Level

Reads the pin’s logic level.

pub fn into_input(self) -> InputPin

Consumes the Pin and returns an InputPin. Sets the mode to Input and disables the pin’s built-in pull-up/pull-down resistors.

pub fn into_input_pulldown(self) -> InputPin

Consumes the Pin and returns an InputPin. Sets the mode to Input and enables the pin’s built-in pull-down resistor.

The pull-down resistor is disabled when InputPin goes out of scope if reset_on_drop is set to true (default).

pub fn into_input_pullup(self) -> InputPin

Consumes the Pin and returns an InputPin. Sets the mode to Input and enables the pin’s built-in pull-up resistor.

The pull-up resistor is disabled when InputPin goes out of scope if reset_on_drop is set to true (default).

pub fn into_output(self) -> OutputPin

Consumes the Pin and returns an OutputPin. Sets the mode to Mode::Output and leaves the logic level unchanged.

pub fn into_output_low(self) -> OutputPin

Consumes the Pin and returns an OutputPin. Changes the logic level to Level::Low and then sets the mode to Mode::Output.

pub fn into_output_high(self) -> OutputPin

Consumes the Pin and returns an OutputPin. Changes the logic level to Level::High and then sets the mode to Mode::Output.

pub fn into_io(self, mode: Mode) -> IoPin

Consumes the Pin and returns an IoPin. Sets the mode to the specified mode.

Trait Implementations

impl Debug for Pin

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

Formats the value using the given formatter.

impl Drop for Pin

fn drop(&mut self)

Executes the destructor for this type.

impl ErrorType for Pin

type Error = Infallible

Error type

impl InputPin for Pin

type Error = Infallible

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 InputPin for Pin

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

Is the input pin high?

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

Is the input pin low?

impl<'a> PartialEq<&'a Pin> for Pin

fn eq(&self, other: &&'a Pin) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialEq<Pin> for &'a Pin

fn eq(&self, other: &Pin) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for Pin

fn eq(&self, other: &Pin) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Pin