Trait embedded_hal::i2c::I2c

source · [−]
pub trait I2c<A: AddressMode = SevenBitAddress>: ErrorType {
    fn read(&mut self, address: A, buffer: &mut [u8]) -> Result<(), Self::Error>;
    fn write(&mut self, address: A, bytes: &[u8]) -> Result<(), Self::Error>;
    fn write_iter<B>(&mut self, address: A, bytes: B) -> Result<(), Self::Error>
    where
        B: IntoIterator<Item = u8>;
    fn write_read(
        &mut self,
        address: A,
        bytes: &[u8],
        buffer: &mut [u8]
    ) -> Result<(), Self::Error>;
    fn write_iter_read<B>(
        &mut self,
        address: A,
        bytes: B,
        buffer: &mut [u8]
    ) -> Result<(), Self::Error>
    where
        B: IntoIterator<Item = u8>;
    fn transaction<'a>(
        &mut self,
        address: A,
        operations: &mut [Operation<'a>]
    ) -> Result<(), Self::Error>;
    fn transaction_iter<'a, O>(
        &mut self,
        address: A,
        operations: O
    ) -> Result<(), Self::Error>
    where
        O: IntoIterator<Item = Operation<'a>>;
}
Expand description

Blocking I2C

Required Methods

Reads enough bytes from slave with address to fill buffer

I2C Events (contract)
Master: ST SAD+R        MAK    MAK ...    NMAK SP
Slave:           SAK B0     B1     ... BN

Where

  • ST = start condition
  • SAD+R = slave address followed by bit 1 to indicate reading
  • SAK = slave acknowledge
  • Bi = ith byte of data
  • MAK = master acknowledge
  • NMAK = master no acknowledge
  • SP = stop condition

Writes bytes to slave with address address

I2C Events (contract)
Master: ST SAD+W     B0     B1     ... BN     SP
Slave:           SAK    SAK    SAK ...    SAK

Where

  • ST = start condition
  • SAD+W = slave address followed by bit 0 to indicate writing
  • SAK = slave acknowledge
  • Bi = ith byte of data
  • SP = stop condition

Writes bytes to slave with address address

I2C Events (contract)

Same as the write method

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

I2C Events (contract)
Master: ST SAD+W     O0     O1     ... OM     SR SAD+R        MAK    MAK ...    NMAK SP
Slave:           SAK    SAK    SAK ...    SAK          SAK I0     I1     ... IN

Where

  • ST = start condition
  • SAD+W = slave address followed by bit 0 to indicate writing
  • SAK = slave acknowledge
  • Oi = ith outgoing byte of data
  • SR = repeated start condition
  • SAD+R = slave address followed by bit 1 to indicate reading
  • Ii = ith incoming byte of data
  • MAK = master acknowledge
  • NMAK = master no acknowledge
  • SP = stop condition

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

I2C Events (contract)

Same as the write_read method

Execute the provided operations on the I2C bus.

Transaction contract:

  • Before executing the first operation an ST is sent automatically. This is followed by SAD+R/W as appropriate.

  • Data from adjacent operations of the same type are sent after each other without an SP or SR.

  • Between adjacent operations of a different type an SR and SAD+R/W is sent.

  • After executing the last operation an SP is sent automatically.

  • If the last operation is a Read the master does not send an acknowledge for the last byte.

  • ST = start condition

  • SAD+R/W = slave address followed by bit 1 to indicate reading or 0 to indicate writing

  • SR = repeated start condition

  • SP = stop condition

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

Transaction contract:

  • Before executing the first operation an ST is sent automatically. This is followed by SAD+R/W as appropriate.

  • Data from adjacent operations of the same type are sent after each other without an SP or SR.

  • Between adjacent operations of a different type an SR and SAD+R/W is sent.

  • After executing the last operation an SP is sent automatically.

  • If the last operation is a Read the master does not send an acknowledge for the last byte.

  • ST = start condition

  • SAD+R/W = slave address followed by bit 1 to indicate reading or 0 to indicate writing

  • SR = repeated start condition

  • SP = stop condition

Implementations on Foreign Types

Implementors