Struct 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_transaction( &mut self, address: u8, operations: &mut [Operation<'_>], ) -> Result<(), Error>

Execute the provided operations on the I2C bus.

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

Consecutive Operation::Reads are not supported due to hardware limitations.

An Operation::Write following an Operation::Read must have a non-empty buffer.

pub fn blocking_transaction_from_ram( &mut self, address: u8, operations: &mut [Operation<'_>], ) -> Result<(), Error>

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

pub fn blocking_transaction_timeout( &mut self, address: u8, operations: &mut [Operation<'_>], timeout: Duration, ) -> Result<(), Error>

Execute the provided operations on the I2C bus with timeout.

See [blocking_transaction].

pub fn blocking_transaction_from_ram_timeout( &mut self, address: u8, operations: &mut [Operation<'_>], timeout: Duration, ) -> Result<(), Error>

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

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

Execute the provided operations on the I2C bus.

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

Consecutive Operation::Reads are not supported due to hardware limitations.

An Operation::Write following an Operation::Read must have a non-empty buffer.

pub async fn transaction_from_ram( &mut self, address: u8, operations: &mut [Operation<'_>], ) -> Result<(), Error>

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

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 fn blocking_write_timeout( &mut self, address: u8, buffer: &[u8], timeout: Duration, ) -> Result<(), Error>

Write to an I2C slave with timeout.

See [blocking_write].

pub fn blocking_write_from_ram_timeout( &mut self, address: u8, buffer: &[u8], timeout: Duration, ) -> 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_timeout( &mut self, address: u8, buffer: &mut [u8], timeout: Duration, ) -> 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_timeout( &mut self, address: u8, wr_buffer: &[u8], rd_buffer: &mut [u8], timeout: Duration, ) -> 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_timeout( &mut self, address: u8, wr_buffer: &[u8], rd_buffer: &mut [u8], timeout: Duration, ) -> 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 for Twim<'d, T>

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

Execute the provided operations on the I2C bus.

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

Reads enough bytes from slave with address to fill read.

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

Writes bytes to slave with address address.

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

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

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

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

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

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

Reads enough bytes from slave with address to fill buffer.

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

Writes bytes to slave with address address.

async fn write_read( &mut self, address: A, write: &[u8], read: &mut [u8], ) -> Result<(), Self::Error>

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

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

type Config = Config

The configuration type used by this driver.

type ConfigError = ()

The error type that can occur if set_config fails.

fn set_config(&mut self, config: &Self::Config) -> Result<(), Self::ConfigError>

Set the configuration of the driver.

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

type Error = Error

Error type

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

Reads enough bytes from slave with address to fill buffer

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

type Error = Error

Error type

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

Writes bytes to slave with address address

impl<'a, T: Instance> WriteRead 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