Skip to main content

Reading

Struct Reading 

Source
pub struct Reading { /* private fields */ }
Expand description

One result register word, with the conversion to illuminance.

§Examples

use pamoja_sensors::opt3001::Reading;

// Exponent 0 over mantissa 3200: 0.01 lux per count, 32 lux.
let reading = Reading::new(0x0C80);
assert_eq!(reading.milli_lux(), 32_000);
assert_eq!(u16::from_be_bytes(reading.to_bytes()), 0x0C80, "high byte first");

Implementations§

Source§

impl Reading

Source

pub fn new(raw: u16) -> Reading

Wraps a result register word.

§Arguments
  • raw - the word: a four-bit exponent over a twelve-bit mantissa.
§Returns

The reading.

Source

pub fn raw(&self) -> u16

Returns the register word.

Source

pub fn milli_lux(&self) -> u32

Returns the illuminance in millilux, exact in integer arithmetic.

Source

pub fn lux(&self) -> f32

Returns the illuminance in lux.

Source

pub fn to_bytes(&self) -> [u8; 2]

Returns the register bytes, most significant first, as the part sends them.

Trait Implementations§

Source§

impl Clone for Reading

Source§

fn clone(&self) -> Reading

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 Reading

Source§

impl Debug for Reading

Source§

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

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

impl Eq for Reading

Source§

impl PartialEq for Reading

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Reading

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.