Struct esp_ward::I2C

pub struct I2C<'d, T> { /* private fields */ }

I2C peripheral container (I2C)

Implementations

impl<'d, T> I2C<'d, T>

where T: Instance,

pub fn new<SDA, SCL>( i2c: impl Peripheral<P = T> + 'd, sda: impl Peripheral<P = SDA> + 'd, scl: impl Peripheral<P = SCL> + 'd, frequency: Rate<u32, 1, 1>, clocks: &Clocks<'_> ) -> I2C<'d, T>

where SDA: OutputPin + InputPin, SCL: OutputPin + InputPin,

Create a new I2C instance This will enable the peripheral but the peripheral won’t get automatically disabled when this gets dropped.

pub fn new_with_timeout<SDA, SCL>( i2c: impl Peripheral<P = T> + 'd, sda: impl Peripheral<P = SDA> + 'd, scl: impl Peripheral<P = SCL> + 'd, frequency: Rate<u32, 1, 1>, clocks: &Clocks<'_>, timeout: Option<u32> ) -> I2C<'d, T>

where SDA: OutputPin + InputPin, SCL: OutputPin + InputPin,

Create a new I2C instance with a custom timeout value. This will enable the peripheral but the peripheral won’t get automatically disabled when this gets dropped.

Trait Implementations

impl<T> ErrorType for I2C<'_, T>

type Error = Error

Error type

impl<T> I2c for I2C<'_, T>

where T: Instance,

fn read( &mut self, address: u8, buffer: &mut [u8] ) -> Result<(), <I2C<'_, T> as ErrorType>::Error>

Reads enough bytes from slave with address to fill read.

fn write( &mut self, address: u8, bytes: &[u8] ) -> Result<(), <I2C<'_, T> as ErrorType>::Error>

Writes bytes to slave with address address.

fn write_read( &mut self, address: u8, bytes: &[u8], buffer: &mut [u8] ) -> Result<(), <I2C<'_, T> as ErrorType>::Error>

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

fn transaction<'a>( &mut self, _address: u8, _operations: &mut [Operation<'a>] ) -> Result<(), <I2C<'_, T> as ErrorType>::Error>

Execute the provided operations on the I2C bus.

impl<'d, T> I2c for I2C<'d, T>

where T: Instance,

async fn read( &mut self, address: u8, read: &mut [u8] ) -> Result<(), <I2C<'d, T> as ErrorType>::Error>

Reads enough bytes from slave with address to fill buffer.

async fn write( &mut self, address: u8, write: &[u8] ) -> Result<(), <I2C<'d, T> as ErrorType>::Error>

Writes bytes to slave with address address.

async fn write_read( &mut self, address: u8, write: &[u8], read: &mut [u8] ) -> Result<(), <I2C<'d, T> as ErrorType>::Error>

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

async fn transaction( &mut self, _address: u8, _operations: &mut [Operation<'_>] ) -> Result<(), <I2C<'d, T> as ErrorType>::Error>

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

impl<T> Read for I2C<'_, T>

where T: Instance,

type Error = Error

Error type

fn read( &mut self, address: u8, buffer: &mut [u8] ) -> Result<(), <I2C<'_, T> as Read>::Error>

Reads enough bytes from slave with address to fill buffer

impl<T> Write for I2C<'_, T>

where T: Instance,

type Error = Error

Error type

fn write( &mut self, addr: u8, bytes: &[u8] ) -> Result<(), <I2C<'_, T> as Write>::Error>

Writes bytes to slave with address address

impl<T> WriteRead for I2C<'_, T>

where T: Instance,

type Error = Error

Error type

fn write_read( &mut self, address: u8, bytes: &[u8], buffer: &mut [u8] ) -> Result<(), <I2C<'_, T> as WriteRead>::Error>

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