Struct SimpleCodec

pub struct SimpleCodec<const HEADER_SIZE: usize> {}

This codec represents the most commonly found codecs for I2C devices. The main variable is the size of register addresses in bytes.

This codec has no information over register sizes or the existence of read/write address-auto-increment which some devices support. It will always send one header and then receive/send the associated register data, so it’s compatible with auto-increment usage, but cannot be used to read or write registers that require interspersing the address between bytes.

Devices often use a mixed mode, where some registers allow auto-increment while others don’t, or where the address is directly associated with a specific, but varying, register size. Therefore, it is up to the user to make sure that accessing a register via this codec is supported by the hardware.

The following generic parameters are available:

Parameter	Type	Description
HEADER_SIZE	usize	The size of the command header (register address) in bytes

Trait Implementations

impl<const HEADER_SIZE: usize> CodecAsync for SimpleCodec<HEADER_SIZE>

async fn read_register<R, I, A>( bound_bus: &mut I2cBoundBusAsync<I, A>, ) -> Result<R, I::Error>

where R: ReadableRegister, I: I2c<A> + ErrorType, A: AddressMode + Copy,

Read this register from the given I2C interface/device.

async fn write_register<R, I, A>( bound_bus: &mut I2cBoundBusAsync<I, A>, register: impl AsRef<R>, ) -> Result<(), I::Error>

where R: WritableRegister, I: I2c<A> + ErrorType, A: AddressMode + Copy,

Write this register to the given I2C interface/device.

impl<const HEADER_SIZE: usize> CodecSync for SimpleCodec<HEADER_SIZE>

fn read_register<R, I, A>( bound_bus: &mut I2cBoundBusSync<I, A>, ) -> Result<R, I::Error>

where R: ReadableRegister, I: I2c<A> + ErrorType, A: AddressMode + Copy,

Read this register from the given I2C interface/device.

fn write_register<R, I, A>( bound_bus: &mut I2cBoundBusSync<I, A>, register: impl AsRef<R>, ) -> Result<(), I::Error>

where R: WritableRegister, I: I2c<A> + ErrorType, A: AddressMode + Copy,

Write this register to the given I2C interface/device.

impl<const HEADER_SIZE: usize> Default for SimpleCodec<HEADER_SIZE>

fn default() -> SimpleCodec<HEADER_SIZE>

Returns the “default value” for a type.