Skip to main content

Configuration

Struct Configuration 

Source
pub struct Configuration {
    pub reset: bool,
    pub averaging: Averaging,
    pub bus_conversion_time: ConversionTime,
    pub shunt_conversion_time: ConversionTime,
    pub mode: Mode,
}
Expand description

The configuration register (0x00), decoded into its fields.

Bit 14 is reserved and reads as 1 after reset; Configuration::to_register writes it that way so the reset value round-trips unchanged.

Fields§

§reset: bool

Set to trigger a system reset equivalent to power-on; the bit self-clears.

§averaging: Averaging

How many samples are averaged before the result registers update.

§bus_conversion_time: ConversionTime

The conversion time for each bus voltage measurement.

§shunt_conversion_time: ConversionTime

The conversion time for each shunt voltage measurement.

§mode: Mode

Which inputs are converted, and whether once or continuously.

Implementations§

Source§

impl Configuration

Source

pub const RESET: Self

The power-on configuration, the decoded form of CONFIG_RESET.

Source

pub fn from_register(raw: u16) -> Self

Decodes a configuration register value.

§Arguments
  • raw - the 16-bit configuration register.
§Returns

The decoded fields; reserved bits are ignored.

Source

pub fn to_register(self) -> u16

Encodes the fields as a configuration register value.

§Returns

The 16-bit register to write, with reserved bit 14 set as at reset.

Source

pub fn update_microseconds(self) -> u32

Returns how often the result registers update with these settings.

One update takes the averaged sample count times the sum of the conversion times of the inputs the mode measures, as the datasheet’s timing examples work it.

§Returns

The update interval in microseconds, or 0 in power-down.

Trait Implementations§

Source§

impl Clone for Configuration

Source§

fn clone(&self) -> Configuration

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for Configuration

Source§

impl Debug for Configuration

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for Configuration

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for Configuration

Source§

impl PartialEq for Configuration

Source§

fn eq(&self, other: &Configuration) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Configuration

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.