Module i2c

Available on crate feature eh1 only.

I²C mock implementations.

Usage

use embedded_hal::i2c::{ErrorKind, I2c, Operation};
use embedded_hal_mock::eh1::i2c::{Mock as I2cMock, Transaction as I2cTransaction};

// Configure expectations
let expectations = [
    I2cTransaction::write(0xaa, vec![1, 2]),
    I2cTransaction::read(0xbb, vec![3, 4]),
];
let mut i2c = I2cMock::new(&expectations);

// Writing
i2c.write(0xaa, &vec![1, 2]).unwrap();

// Reading
let mut buf = vec![0; 2];
i2c.read(0xbb, &mut buf).unwrap();
assert_eq!(buf, vec![3, 4]);

// Finalise expectations
i2c.done();

Testing Error Handling

If you want to test error handling of your code, you can attach an error to a transaction. When the transaction is executed, an error is returned.

// Configure expectations
let expectations = [
    I2cTransaction::write(0xaa, vec![1, 2]),
    I2cTransaction::read(0xbb, vec![3, 4]).with_error(ErrorKind::Other),
];
let mut i2c = I2cMock::new(&expectations);

// Writing returns without an error
i2c.write(0xaa, &vec![1, 2]).unwrap();

// Reading returns an error
let mut buf = vec![0; 2];
let err = i2c.read(0xbb, &mut buf).unwrap_err();
assert_eq!(err, ErrorKind::Other);

// Finalise expectations
i2c.done();

Structs

Transaction

I2C Transaction type

Enums

Mode

I2C Transaction modes

Type Aliases

Mock

Mock I2C implementation