Struct Configuration 

pub struct Configuration {
    pub range_number: u8,
    pub conversion_time: ConversionTime,
    pub mode: Mode,
    pub overflow: bool,
    pub conversion_ready: bool,
    pub flag_high: bool,
    pub flag_low: bool,
    pub latch: Latch,
    pub polarity: Polarity,
    pub mask_exponent: bool,
    pub fault_count: FaultCount,
}

A decoded OPT3001 configuration 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. Configuration::default is the power-on state, CONFIGURATION_RESET. The four status fields are read-only on the part and are ignored by bits.

Examples

use pamoja_sensors::opt3001::{Configuration, Mode};

// Convert continuously with the range set automatically, everything else default.
let config = Configuration {
    mode: Mode::Continuous,
    ..Configuration::default()
};
assert_eq!(config.bits(), 0xCC10);
assert_eq!(Configuration::from_bits(0xCC10), config);

Fields

range_number: u8

The range number (bits 15:12): 0 to 11 for a fixed full-scale range, or RANGE_AUTOMATIC to let the part choose and report its choice in the result’s exponent.

conversion_time: ConversionTime

The conversion time.

mode: Mode

The mode of conversion operation.

overflow: bool

Read-only: the last conversion overflowed its full-scale range.

conversion_ready: bool

Read-only: a conversion has completed since the register was last read or written with a non-shutdown mode.

flag_high: bool

Read-only: the result exceeded the high limit for the fault count.

flag_low: bool

Read-only: the result fell below the low limit for the fault count.

latch: Latch

The interrupt reporting style.

polarity: Polarity

The INT pin polarity.

mask_exponent: bool

Force the result’s exponent to zero on a fixed range, so the mantissa alone is the reading at that range’s LSB.

fault_count: FaultCount

The consecutive faults required to trigger a report.

Implementations

impl Configuration

pub fn bits(self) -> u16

Assembles the 16-bit configuration register value.

The read-only status bits are written as zero, and the range number is truncated to its four bits.

Returns

The register value to write, most significant byte first.

pub fn from_bits(bits: u16) -> Configuration

Parses a 16-bit configuration register value.

Arguments

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

Returns

The decoded configuration, status flags included.

pub fn is_automatic_range(&self) -> bool

Returns whether the range number selects automatic full-scale setting.

Trait Implementations

impl Clone for Configuration

fn clone(&self) -> Configuration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Configuration

impl Debug for Configuration

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

Formats the value using the given formatter.

impl Default for Configuration

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Configuration

impl PartialEq for Configuration

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Configuration