Struct embassy_nrf::twim::Twim

pub struct Twim<'d, T: Instance> { /* private fields */ }

TWI driver.

Implementations

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

pub fn new(
twim: 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 TWI driver.

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

Write to an I2C slave.

The buffer must have a length of at most 255 bytes on the nRF52832 and at most 65535 bytes on the nRF52840.

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

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

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

Read from an I2C slave.

The buffer must have a length of at most 255 bytes on the nRF52832 and at most 65535 bytes on the nRF52840.

pub fn blocking_write_read(
&mut self,
address: u8,
wr_buffer: &[u8],
rd_buffer: &mut [u8]
) -> Result<(), Error>

Write data to an I2C slave, then read data from the slave without triggering a stop condition between the two.

The buffers must have a length of at most 255 bytes on the nRF52832 and at most 65535 bytes on the nRF52840.

pub fn blocking_write_read_from_ram(
&mut self,
address: u8,
wr_buffer: &[u8],
rd_buffer: &mut [u8]
) -> Result<(), Error>

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

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

Read from an I2C slave.

The buffer must have a length of at most 255 bytes on the nRF52832 and at most 65535 bytes on the nRF52840.

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

Write to an I2C slave.

The buffer must have a length of at most 255 bytes on the nRF52832 and at most 65535 bytes on the nRF52840.

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

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

pub async fn write_read(
&mut self,
address: u8,
wr_buffer: &[u8],
rd_buffer: &mut [u8]
) -> Result<(), Error>

Write data to an I2C slave, then read data from the slave without triggering a stop condition between the two.

The buffers must have a length of at most 255 bytes on the nRF52832 and at most 65535 bytes on the nRF52840.

pub async fn write_read_from_ram(
&mut self,
address: u8,
wr_buffer: &[u8],
rd_buffer: &mut [u8]
) -> Result<(), Error>

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

Trait Implementations

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

fn drop(&mut self)

Executes the destructor for this type.

impl<'d, T: Instance> ErrorType for Twim<'d, T>

type Error = Error

Error type

impl<'d, T: Instance> I2c<u8> for Twim<'d, T>

fn read(&mut self, address: u8, buffer: &mut [u8]) -> Result<(), Self::Error>

Reads enough bytes from slave with address to fill buffer

fn write(&mut self, address: u8, buffer: &[u8]) -> Result<(), Self::Error>

Writes bytes to slave with address address

fn write_iter<B>(&mut self, _address: u8, _bytes: B) -> Result<(), Self::Error>where
B: IntoIterator<Item = u8>,

Writes bytes to slave with address address

fn write_iter_read<B>(
&mut self,
_address: u8,
_bytes: B,
_buffer: &mut [u8]
) -> Result<(), Self::Error>where
B: IntoIterator<Item = u8>,

Writes bytes to slave with address address and then reads enough bytes to fill buffer in a single transaction

fn write_read(
&mut self,
address: u8,
wr_buffer: &[u8],
rd_buffer: &mut [u8]
) -> Result<(), Self::Error>

Writes bytes to slave with address address and then reads enough bytes to fill buffer in a single transaction

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

Execute the provided operations on the I2C bus.

fn transaction_iter<'a, O>(
&mut self,
_address: u8,
_operations: O
) -> Result<(), Self::Error>where
O: IntoIterator<Item = Operation<'a>>,

Execute the provided operations on the I2C bus (iterator version).

impl<'d, T: Instance> I2c<u8> for Twim<'d, T>

async fn read<'a>(
&'a mut self,
address: u8,
buffer: &'a mut [u8]
) -> Result<(), Error>

Reads enough bytes from slave with address to fill buffer

async fn write<'a>(
&'a mut self,
address: u8,
bytes: &'a [u8]
) -> Result<(), Error>

Writes bytes to slave with address address

async fn write_read<'a>(
&'a mut self,
address: u8,
wr_buffer: &'a [u8],
rd_buffer: &'a mut [u8]
) -> Result<(), Error>

Writes bytes to slave with address address and then reads enough bytes to fill read in a single transaction.

async fn transaction<'a, 'b>(
&'a mut self,
address: u8,
operations: &'a mut [Operation<'b>]
) -> Result<(), Error>

Execute the provided operations on the I2C bus as a single transaction.

impl<'a, T: Instance> Read<u8> for Twim<'a, T>

type Error = Error

Error type

fn read<'w>(&mut self, addr: u8, bytes: &'w mut [u8]) -> Result<(), Error>

Reads enough bytes from slave with address to fill buffer

impl<'d, T: Instance> SetConfig for Twim<'d, T>

type Config = Config

The configuration type used by this driver.

fn set_config(&mut self, config: &Self::Config)

Set the configuration of the driver.

impl<'a, T: Instance> Write<u8> for Twim<'a, T>

type Error = Error

Error type

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

Writes bytes to slave with address address

impl<'a, T: Instance> WriteRead<u8> for Twim<'a, T>

type Error = Error

Error type

fn write_read<'w>(
&mut self,
addr: u8,
bytes: &'w [u8],
buffer: &'w mut [u8]
) -> Result<(), Error>

Writes bytes to slave with address address and then reads enough bytes to fill buffer in a single transaction