Struct INA226Sync 

pub struct INA226Sync<D: DelayNs, I: RegisterInterfaceSync> { /* private fields */ }

The INA226 is an ultra-precise digital power monitor with a 16-bit delta-sigma ADC for high- or low-side current-sensing applications. The device can measure a full-scale differential input of ±81.92 mV across a resistive shunt sense element with bus voltage support from 0 V to +36 V.

For a full description and usage examples, refer to the module documentation.

Implementations

impl<D, I> INA226Sync<D, I2cDeviceSync<I, SevenBitAddress>>

where I: I2c<SevenBitAddress> + ErrorType, D: DelayNs,

pub fn new_i2c(delay: D, interface: I, address: Address) -> Self

Initializes a new device with the given address on the specified bus. This consumes the I2C bus I.

Before using this device, you should call the Self::init method which saves the calibration values to enable current and power output.

impl<D: DelayNs, I: RegisterInterfaceSync> INA226Sync<D, I>

pub fn init( &mut self, shunt_resistance: ElectricalResistance, max_expected_current: ElectricCurrent, ) -> Result<(), InitError<I::BusError>>

Soft-resets the device, calibrates it with the given shunt resistor value and maximum expected current.

You can change the values later using Self::calibrate.

pub fn calibrate( &mut self, shunt_resistance: ElectricalResistance, max_expected_current: ElectricCurrent, ) -> Result<(), TransportError<(), I::BusError>>

Writes the given shunt resistance and maximum expected current into the device configuration register. This enables power and current output.

pub fn read_measurements( &mut self, ) -> Result<Measurement, MeasurementError<I::BusError>>

Returns the currently stored measurement values without triggering a new measurement. A timeout error cannot occur here.

pub fn read_register<R>( &mut self, ) -> Result<R, TransportError<<R as Register>::CodecError, I::BusError>>

where R: ReadableRegister + INA226Register,

Reads from the given register. For a list of all available registers, refer to implementors of INA226Register.

pub fn write_register<R>( &mut self, register: impl AsRef<R>, ) -> Result<(), TransportError<<R as Register>::CodecError, I::BusError>>

where R: WritableRegister + INA226Register,

Writes to the given register. For a list of all available registers, refer to implementors of INA226Register.

Trait Implementations

impl<D: DelayNs, I: RegisterInterfaceSync> ContinuousSensorSync for INA226Sync<D, I>

fn start_measuring(&mut self) -> Result<(), Self::Error>

Starts continuous measurement.

fn stop_measuring(&mut self) -> Result<(), Self::Error>

Stops continuous measurement.

fn measurement_interval_us(&mut self) -> Result<u32, Self::Error>

Expected amount of time between measurements in microseconds.

fn current_measurement( &mut self, ) -> Result<Option<Self::Measurement>, Self::Error>

Returns the most recent measurement. Will never return None.

fn is_measurement_ready(&mut self) -> Result<bool, Self::Error>

Check if new measurements are available.

fn next_measurement(&mut self) -> Result<Self::Measurement, Self::Error>

Wait indefinitely until new measurements are available and return them. Checks whether data is ready in intervals of 100us.

type Error = ContinuousMeasurementError<<I as RegisterInterfaceSync>::BusError>

The error type which may occur on associated functions

type Measurement = Measurement

A type holding the measurements obtained by this sensor

impl<D: DelayNs, I: RegisterInterfaceSync> OneshotSensorSync for INA226Sync<D, I>

fn measure(&mut self) -> Result<Self::Measurement, Self::Error>

Performs a one-shot measurement. This will set the operating mode to [`self::registers::OperatingMode::ShuntAndBusTriggered´] and enable all conversion outputs causing the device to perform a single conversion a return to sleep afterwards.

type Error = MeasurementError<<I as RegisterInterfaceSync>::BusError>

The error type which may occur on associated functions

type Measurement = Measurement

A type holding the measurements obtained by this sensor

impl<D: DelayNs, I: RegisterInterfaceSync> ResettableDeviceSync for INA226Sync<D, I>

fn reset(&mut self) -> Result<(), Self::Error>

Performs a soft-reset of the device, restoring internal registers to power-on reset values.

type Error = TransportError<(), <I as RegisterInterfaceSync>::BusError>

The error type which may occur when resetting the device

impl<D: DelayNs, I: RegisterInterfaceSync> CurrentSensor for INA226Sync<D, I>

impl<D: DelayNs, I: RegisterInterfaceSync> PowerSensor for INA226Sync<D, I>

impl<D: DelayNs, I: RegisterInterfaceSync> VoltageSensor for INA226Sync<D, I>