Struct PinGroup 

pub struct PinGroup<T = HNil>(/* private fields */);

A group of pins to be controlled together and guaranty single cycle control of several pins.

use rp235x_hal::{
    self as hal,
    gpio::{bank0::Gpio12, Pin, PinGroup, PinState, Pins},
    sio::Sio,
};

let mut peripherals = hal::pac::Peripherals::take().unwrap();
let sio = Sio::new(peripherals.SIO);
let pins = Pins::new(
    peripherals.IO_BANK0,
    peripherals.PADS_BANK0,
    sio.gpio_bank0,
    &mut peripherals.RESETS,
);

let group = PinGroup::new();
let group = group.add_pin(pins.gpio0.into_pull_up_input());
let mut group = group.add_pin(pins.gpio4.into_push_pull_output_in_state(PinState::High));

defmt!("Group's state is: {}", group.read());
group.toggle();
defmt!("Group's state is: {}", group.read());

Implementations

impl PinGroup

pub fn new() -> PinGroup

Creates an empty pin group.

pub fn add_pin<P, C>(self, pin: P) -> PinGroup<HCons<P, HNil>>

where C: SioConfig, P: AnyPin<Function = FunctionSio<C>>, <P as AnyPin>::Id: TypeLevelPinId,

Add a pin to the group.

impl<T, H> PinGroup<HCons<H, T>>

where <H as AnyPin>::Id: TypeLevelPinId, H: AnyPin,

pub fn add_pin<C, P>(self, pin: P) -> PinGroup<HCons<P, HCons<H, T>>>

where C: SioConfig, P: AnyPin<Function = FunctionSio<C>>, <P as AnyPin>::Id: TypeLevelPinId<Bank = <<H as AnyPin>::Id as TypeLevelPinId>::Bank>,

Add a pin to the group.

pub fn remove_pin<P, Index>( self, ) -> (P, PinGroup<<HCons<H, T> as Plucker<P, Index>>::Remainder>)

where HCons<H, T>: Plucker<P, Index>,

Pluck a pin from the group.

impl<H, T> PinGroup<HCons<H, T>>

where HCons<H, T>: ReadPinHList + WritePinHList, H: AnyPin,

pub fn read(&self) -> u32

Read the whole group at once.

The returned value is a bit field where each pin populates its own index. Therefore, there might be “holes” in the value. Unoccupied bits will always read as 0.

For example, if the group contains Gpio1 and Gpio3, a read may yield:

0b0000_0000__0000_0000__0000_0000__0000_1010
                         This is Gpio3  ↑↑↑
                     Gpio2 is not used   ||
                         This is Gpio1    |

pub fn set(&mut self, state: PinState)

Write this set of pins all at the same time.

This only affects output pins. Input pins in the set are ignored.

pub fn set_u32(&mut self, state: u32)

Set this set of pins to the state given in a single operation.

The state passed in must be a mask where each bit corresponds to a gpio.

For example, if the group contains Gpio1 and Gpio3, a read may yield:

0b0000_0000__0000_0000__0000_0000__0000_1010
                         This is Gpio3  ↑↑↑
                     Gpio2 is not used   ||
                         This is Gpio1    |

State corresponding to bins not in this group are ignored.

pub fn toggle(&mut self)

Toggles this set of pins all at the same time.

This only affects output pins. Input pins in the set are ignored.

Trait Implementations

impl Default for PinGroup

fn default() -> PinGroup

Returns the “default value” for a type.