Skip to main content

Config

Struct Config 

Source
pub struct Config {
    pub start_conversion: bool,
    pub mux: Mux,
    pub pga: Pga,
    pub mode: Mode,
    pub data_rate: DataRate,
    pub comparator_mode: ComparatorMode,
    pub comparator_polarity: ComparatorPolarity,
    pub comparator_latch: ComparatorLatch,
    pub comparator_queue: ComparatorQueue,
}
Expand description

A decoded ADS1115 Config register.

Build one, set the fields, and turn it into the 16-bit register value with bits; or parse a register read with from_bits. Config::default is the power-on state, 0x8583.

§Examples

use pamoja_sensors::ads1115::{Config, Mux, Pga};

// Read AIN0 against ground at the ±4.096 V range, leaving everything else default.
let config = Config {
    mux: Mux::Ain0Gnd,
    pga: Pga::Fsr4_096,
    ..Config::default()
};
// The high byte then low byte are written to the Config register.
let [hi, lo] = config.bits().to_be_bytes();
assert_eq!(Config::from_bits(u16::from_be_bytes([hi, lo])), config);

Fields§

§start_conversion: bool

Start a single conversion when written; reads as “not converting” when set.

§mux: Mux

The input multiplexer setting.

§pga: Pga

The full-scale range.

§mode: Mode

The conversion mode.

§data_rate: DataRate

The output data rate.

§comparator_mode: ComparatorMode

The comparator mode.

§comparator_polarity: ComparatorPolarity

The ALERT/RDY pin polarity.

§comparator_latch: ComparatorLatch

Whether the comparator latches.

§comparator_queue: ComparatorQueue

The comparator queue, or disable.

Implementations§

Source§

impl Config

Source

pub fn bits(self) -> u16

Assembles the 16-bit Config register value.

§Returns

The register value to write, most significant bit first.

Source

pub fn from_bits(bits: u16) -> Config

Parses a 16-bit Config register value.

§Arguments
  • bits - the register value, as read from the device.
§Returns

The decoded configuration.

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

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 Config

Source§

impl Debug for Config

Source§

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

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

impl Default for Config

Source§

fn default() -> Self

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

impl Eq for Config

Source§

impl PartialEq for Config

Source§

fn eq(&self, other: &Config) -> 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 Config

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.