Struct driver_pal::wrapper::Wrapper

pub struct Wrapper<Spi, CsPin, BusyPin, ReadyPin, ResetPin, Delay> { /* fields omitted */ }

Wrapper provides a wrapper around an SPI object with Chip Select management

Implementations

impl<Spi, CsPin, BusyPin, ReadyPin, ResetPin, Delay> Wrapper<Spi, CsPin, BusyPin, ReadyPin, ResetPin, Delay> where
    Spi: Write<u8> + Transfer<u8>,
    CsPin: OutputPin, 

pub fn new(
    spi: Spi,
    cs: CsPin,
    reset: ResetPin,
    busy: BusyPin,
    ready: ReadyPin,
    delay: Delay
) -> Self

Create a new wrapper with the provided chip select pin

pub fn inner_spi(&mut self) -> &mut Spi

Explicitly fetch the inner spi (non-CS controlling) object

(note that deref is also implemented for this)

Trait Implementations

impl<Spi, CsPin, BusyPin, ReadyPin, ResetPin, Delay> Busy for Wrapper<Spi, CsPin, BusyPin, ReadyPin, ResetPin, Delay> where
    BusyPin: InputPin,
    <BusyPin as InputPin>::Error: Debug, 

Busy pin implementation for inner objects implementing Busy

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

Fetch the busy pin state

type Error = <BusyPin as InputPin>::Error

impl<Spi, CsPin, BusyPin, ReadyPin, ResetPin, Delay> DelayMs<u32> for Wrapper<Spi, CsPin, BusyPin, ReadyPin, ResetPin, Delay> where
    Delay: DelayMs<u32>,
    <Delay as DelayMs<u32>>::Error: Debug, 

type Error = <Delay as DelayMs<u32>>::Error

Enumeration of DelayMs errors

fn delay_ms(&mut self, ms: u32) -> Result<(), Self::Error>

Pauses execution for ms milliseconds

impl<Spi, CsPin, BusyPin, ReadyPin, ResetPin, Delay> DelayUs<u32> for Wrapper<Spi, CsPin, BusyPin, ReadyPin, ResetPin, Delay> where
    Delay: DelayUs<u32>,
    <Delay as DelayUs<u32>>::Error: Debug, 

type Error = <Delay as DelayUs<u32>>::Error

Enumeration of DelayMs errors

fn delay_us(&mut self, us: u32) -> Result<(), Self::Error>

Pauses execution for us microseconds

impl<Spi, CsPin, BusyPin, ReadyPin, ResetPin, Delay> Ready for Wrapper<Spi, CsPin, BusyPin, ReadyPin, ResetPin, Delay> where
    ReadyPin: InputPin,
    <ReadyPin as InputPin>::Error: Debug, 

Ready pin implementation for inner object implementing Ready

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

Fetch the ready pin state

type Error = <ReadyPin as InputPin>::Error

impl<Spi, CsPin, BusyPin, ReadyPin, ResetPin, Delay> Reset for Wrapper<Spi, CsPin, BusyPin, ReadyPin, ResetPin, Delay> where
    ResetPin: OutputPin,
    <ResetPin as OutputPin>::Error: Debug, 

Reset pin implementation for inner objects implementing Reset

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

Set the reset pin state

type Error = <ResetPin as OutputPin>::Error

impl<Spi, CsPin, BusyPin, ReadyPin, ResetPin, Delay> Transactional<u8> for Wrapper<Spi, CsPin, BusyPin, ReadyPin, ResetPin, Delay> where
    Spi: Transactional<u8>,
    <Spi as Transactional<u8>>::Error: Debug,
    CsPin: OutputPin,
    <CsPin as OutputPin>::Error: Debug,
    Delay: DelayMs<u32>,
    <Delay as DelayMs<u32>>::Error: Debug, 

spi::Transactional implementation managing CS pin

type Error = Error<<Spi as Transactional<u8>>::Error, <CsPin as OutputPin>::Error, <Delay as DelayMs<u32>>::Error>

Associated error type

fn exec<'a>(
    &mut self,
    operations: &mut [Operation<'a, u8>]
) -> Result<(), Self::Error>

Execute the provided transactions

impl<Spi, CsPin, BusyPin, ReadyPin, ResetPin, Delay> Transfer<u8> for Wrapper<Spi, CsPin, BusyPin, ReadyPin, ResetPin, Delay> where
    Spi: Transfer<u8>,
    <Spi as Transfer<u8>>::Error: Debug,
    CsPin: OutputPin,
    <CsPin as OutputPin>::Error: Debug,
    Delay: DelayMs<u32>,
    <Delay as DelayMs<u32>>::Error: Debug, 

type Error = Error<<Spi as Transfer<u8>>::Error, <CsPin as OutputPin>::Error, <Delay as DelayMs<u32>>::Error>

Error type

fn transfer<'w>(&mut self, data: &'w mut [u8]) -> Result<(), Self::Error>

Writes and reads simultaneously. The contents of words are written to the slave, and the received words are stored into the same words buffer, overwriting it.

impl<Spi, CsPin, BusyPin, ReadyPin, ResetPin, Delay> Write<u8> for Wrapper<Spi, CsPin, BusyPin, ReadyPin, ResetPin, Delay> where
    Spi: Write<u8>,
    <Spi as Write<u8>>::Error: Debug,
    CsPin: OutputPin,
    <CsPin as OutputPin>::Error: Debug,
    Delay: DelayMs<u32>,
    <Delay as DelayMs<u32>>::Error: Debug, 

spi::Write implementation managing the CS pin

type Error = Error<<Spi as Write<u8>>::Error, <CsPin as OutputPin>::Error, <Delay as DelayMs<u32>>::Error>

Error type

fn write<'w>(&mut self, data: &'w [u8]) -> Result<(), Self::Error>

Writes words to the slave, ignoring all the incoming words

impl<Spi, CsPin, BusyPin, ReadyPin, ResetPin, Delay> ManagedChipSelect for Wrapper<Spi, CsPin, BusyPin, ReadyPin, ResetPin, Delay>

ManagedChipSelect indicates wrapper controls CS line