pub struct INA228Sync<D: DelayNs, I: RegisterInterfaceSync> {
pub current_lsb_na: i64,
pub adc_range: AdcRange,
/* private fields */
}Expand description
The INA228 is an ultra-precise digital power monitor with a 20-bit delta-sigma ADC specifically designed for current-sensing applications. The device can measure a full-scale differential input of ±163.84 mV or ±40.96 mV across a resistive shunt sense element with common-mode voltage support from –0.3 V to +85 V.
For a full description and usage examples, refer to the module documentation.
Fields§
§current_lsb_na: i64Configured nA/LSB for current readings
adc_range: AdcRangeThe configured adc range
Implementations§
Source§impl<D, I> INA228Sync<D, I2cDeviceSync<I, SevenBitAddress>>
impl<D, I> INA228Sync<D, I2cDeviceSync<I, SevenBitAddress>>
Sourcepub fn new_i2c(delay: D, interface: I, address: Address) -> Self
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.
Source§impl<D: DelayNs, I: RegisterInterfaceSync> INA228Sync<D, I>
impl<D: DelayNs, I: RegisterInterfaceSync> INA228Sync<D, I>
Sourcepub fn init(
&mut self,
shunt_resistance: ElectricalResistance,
max_expected_current: ElectricCurrent,
) -> Result<(), InitError<I::BusError>>
pub fn init( &mut self, shunt_resistance: ElectricalResistance, max_expected_current: ElectricCurrent, ) -> Result<(), InitError<I::BusError>>
Soft-resets the device, verifies its device id and manufacturer id and calibrates it with the given shunt resistor value and maximum expected current.
You can change the values later using Self::calibrate.
Sourcepub fn calibrate(
&mut self,
shunt_resistance: ElectricalResistance,
max_expected_current: ElectricCurrent,
) -> Result<(), TransportError<(), I::BusError>>
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. Automatically selects the adc range appropriately, leaving 10% headroom if possible. This required to enable power and current output.
Sourcepub fn read_register<R>(
&mut self,
) -> Result<R, TransportError<<R as Register>::CodecError, I::BusError>>where
R: ReadableRegister + INA228Register,
pub fn read_register<R>(
&mut self,
) -> Result<R, TransportError<<R as Register>::CodecError, I::BusError>>where
R: ReadableRegister + INA228Register,
Reads from the given register. For a list of all available registers, refer to implementors of INA228Register.
Sourcepub fn write_register<R>(
&mut self,
register: impl AsRef<R>,
) -> Result<(), TransportError<<R as Register>::CodecError, I::BusError>>where
R: WritableRegister + INA228Register,
pub fn write_register<R>(
&mut self,
register: impl AsRef<R>,
) -> Result<(), TransportError<<R as Register>::CodecError, I::BusError>>where
R: WritableRegister + INA228Register,
Writes to the given register. For a list of all available registers, refer to implementors of INA228Register.
Trait Implementations§
Source§impl<D: DelayNs, I: RegisterInterfaceSync> ContinuousSensorSync for INA228Sync<D, I>
impl<D: DelayNs, I: RegisterInterfaceSync> ContinuousSensorSync for INA228Sync<D, I>
Source§fn measurement_interval_us(&mut self) -> Result<u32, Self::Error>
fn measurement_interval_us(&mut self) -> Result<u32, Self::Error>
Expected amount of time between measurements in microseconds.
Source§fn current_measurement(
&mut self,
) -> Result<Option<Self::Measurement>, Self::Error>
fn current_measurement( &mut self, ) -> Result<Option<Self::Measurement>, Self::Error>
Returns the most recent measurement. Will never return None.
Source§fn is_measurement_ready(&mut self) -> Result<bool, Self::Error>
fn is_measurement_ready(&mut self) -> Result<bool, Self::Error>
Check if new measurements are available.
Source§fn next_measurement(&mut self) -> Result<Self::Measurement, Self::Error>
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.
Source§type Error = ContinuousMeasurementError<<I as RegisterInterfaceSync>::BusError>
type Error = ContinuousMeasurementError<<I as RegisterInterfaceSync>::BusError>
Source§type Measurement = Measurement
type Measurement = Measurement
Source§impl<D: DelayNs, I: RegisterInterfaceSync> OneshotSensorSync for INA228Sync<D, I>
impl<D: DelayNs, I: RegisterInterfaceSync> OneshotSensorSync for INA228Sync<D, I>
Source§fn measure(&mut self) -> Result<Self::Measurement, Self::Error>
fn measure(&mut self) -> Result<Self::Measurement, Self::Error>
Performs a one-shot measurement. This will set the operating mode to [`self::registers::OperatingMode::Triggered´] and enable all conversion outputs causing the device to perform a single conversion a return to sleep afterwards.
Source§type Error = MeasurementError<<I as RegisterInterfaceSync>::BusError>
type Error = MeasurementError<<I as RegisterInterfaceSync>::BusError>
Source§type Measurement = Measurement
type Measurement = Measurement
Source§impl<D: DelayNs, I: RegisterInterfaceSync> ResettableDeviceSync for INA228Sync<D, I>
impl<D: DelayNs, I: RegisterInterfaceSync> ResettableDeviceSync for INA228Sync<D, I>
impl<D: DelayNs, I: RegisterInterfaceSync> ChargeSensor for INA228Sync<D, I>
impl<D: DelayNs, I: RegisterInterfaceSync> CurrentSensor for INA228Sync<D, I>
impl<D: DelayNs, I: RegisterInterfaceSync> EnergySensor for INA228Sync<D, I>
impl<D: DelayNs, I: RegisterInterfaceSync> PowerSensor for INA228Sync<D, I>
impl<D: DelayNs, I: RegisterInterfaceSync> TemperatureSensor for INA228Sync<D, I>
impl<D: DelayNs, I: RegisterInterfaceSync> VoltageSensor for INA228Sync<D, I>
Auto Trait Implementations§
impl<D, I> Freeze for INA228Sync<D, I>
impl<D, I> !RefUnwindSafe for INA228Sync<D, I>
impl<D, I> Send for INA228Sync<D, I>
impl<D, I> Sync for INA228Sync<D, I>
impl<D, I> Unpin for INA228Sync<D, I>
impl<D, I> !UnwindSafe for INA228Sync<D, I>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.