Embassy
embassy-nrf

Crates

git

Versions

nrf5340-net

Flavors

Struct embassy_nrf::twis::Twis

source ·
pub struct Twis<'d, T: Instance> { /* private fields */ }
Expand description

TWIS driver.

Implementations§

source§

impl<'d, T: Instance> Twis<'d, T>

source

pub fn new( twis: impl Peripheral<P = T> + 'd, _irq: impl Binding<T::Interrupt, InterruptHandler<T>> + 'd, sda: impl Peripheral<P = impl GpioPin> + 'd, scl: impl Peripheral<P = impl GpioPin> + 'd, config: Config ) -> Self

Create a new TWIS driver.

source

pub fn address_match(&self) -> u8

Returns matched address for latest command.

source

pub fn address_match_index(&self) -> usize

Returns the index of the address matched in the latest command.

source

pub fn blocking_listen(&mut self, buffer: &mut [u8]) -> Result<Command, Error>

Wait for commands from an I2C master. buffer is provided in case master does a ‘write’ and is unused for ‘read’. The buffer must have a length of at most 255 bytes on the nRF52832 and at most 65535 bytes on the nRF52840. To know which one of the addresses were matched, call address_match or address_match_index

source

pub fn blocking_respond_to_read( &mut self, buffer: &[u8] ) -> Result<usize, Error>

Respond to an I2C master READ command. Returns the number of bytes written. The buffer must have a length of at most 255 bytes on the nRF52832 and at most 65535 bytes on the nRF52840.

source

pub fn blocking_respond_to_read_from_ram( &mut self, buffer: &[u8] ) -> Result<usize, Error>

Same as blocking_respond_to_read but will fail instead of copying data into RAM. Consult the module level documentation to learn more.

source

pub fn blocking_listen_timeout( &mut self, buffer: &mut [u8], timeout: Duration ) -> Result<Command, Error>

Wait for commands from an I2C master, with timeout. buffer is provided in case master does a ‘write’ and is unused for ‘read’. The buffer must have a length of at most 255 bytes on the nRF52832 and at most 65535 bytes on the nRF52840. To know which one of the addresses were matched, call address_match or address_match_index

source

pub fn blocking_respond_to_read_timeout( &mut self, buffer: &[u8], timeout: Duration ) -> Result<usize, Error>

Respond to an I2C master READ command with timeout. Returns the number of bytes written. See [blocking_respond_to_read].

source

pub fn blocking_respond_to_read_from_ram_timeout( &mut self, buffer: &[u8], timeout: Duration ) -> Result<usize, Error>

Same as blocking_respond_to_read_timeout but will fail instead of copying data into RAM. Consult the module level documentation to learn more.

source

pub async fn listen(&mut self, buffer: &mut [u8]) -> Result<Command, Error>

Wait asynchronously for commands from an I2C master. buffer is provided in case master does a ‘write’ and is unused for ‘read’. The buffer must have a length of at most 255 bytes on the nRF52832 and at most 65535 bytes on the nRF52840. To know which one of the addresses were matched, call address_match or address_match_index

source

pub async fn respond_to_read(&mut self, buffer: &[u8]) -> Result<usize, Error>

Respond to an I2C master READ command, asynchronously. Returns the number of bytes written. The buffer must have a length of at most 255 bytes on the nRF52832 and at most 65535 bytes on the nRF52840.

source

pub async fn respond_to_read_from_ram( &mut self, buffer: &[u8] ) -> Result<usize, Error>

Same as respond_to_read but will fail instead of copying data into RAM. Consult the module level documentation to learn more.

Trait Implementations§

source§

impl<'a, T: Instance> Drop for Twis<'a, T>

source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<'d, T> Freeze for Twis<'d, T>
where T: Freeze,

§

impl<'d, T> RefUnwindSafe for Twis<'d, T>
where T: RefUnwindSafe,

§

impl<'d, T> Send for Twis<'d, T>
where T: Send,

§

impl<'d, T> Sync for Twis<'d, T>
where T: Sync,

§

impl<'d, T> Unpin for Twis<'d, T>
where T: Unpin,

§

impl<'d, T> !UnwindSafe for Twis<'d, T>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.