Struct circuit_playground_express::sercom::I2CMaster5

pub struct I2CMaster5 { /* fields omitted */ }

Represents the Sercom instance configured to act as an I2C Master. The embedded_hal blocking I2C traits are implemented by this instance.

Methods

impl I2CMaster5

pub fn new<F>(
    clock: &Sercom5CoreClock,
    freq: F,
    sercom: SERCOM5,
    pm: &mut PM,
    sda: Sercom5Pad0,
    scl: Sercom5Pad1
) -> I2CMaster5 where
    F: Into<Hertz>, 

Configures the sercom instance to work as an I2C Master. The clock is obtained via the GenericClockGenerator type. freq specifies the bus frequency to use for I2C communication. There are typically a handful of values that tend to be supported; standard mode is 100.khz(), full speed mode is 400.khz(). The hardware in the atsamd device supports fast mode at 1.mhz() and fast mode, but there may be additional hardware configuration missing from the current software implementation that prevents that from working as-written today.

let mut i2c = I2CMaster3::new(
    &clocks.sercom3_core(&gclk0).unwrap(),
    400.khz(),
    p.device.SERCOM3,
    &mut p.device.PM,
    // Metro M0 express has I2C on pins PA22, PA23
    pins.pa22.into_pad(&mut pins.port),
    pins.pa23.into_pad(&mut pins.port),
);

pub fn free(self) -> (Sercom5Pad0, Sercom5Pad1, SERCOM5)

Breaks the sercom device up into its constituent pins and the SERCOM instance. Does not make any changes to power management.

Trait Implementations

impl WriteRead for I2CMaster5

type Error = I2CError

Error type

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

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

impl Read for I2CMaster5

type Error = I2CError

Error type

fn read(
    &mut self,
    addr: u8,
    buffer: &mut [u8]
) -> Result<(), <I2CMaster5 as Read>::Error>

Reads enough bytes from slave with address to fill buffer

impl Write for I2CMaster5

type Error = I2CError

Error type

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

Sends bytes to slave with address addr