Struct Sample 

pub struct Sample {
    pub raw: i16,
    pub pga: Pga,
}

One conversion result with the gain it was taken at, so it converts to volts.

Fields

raw: i16

The signed 16-bit conversion register value.

pga: Pga

The full-scale range the conversion ran at.

Implementations

impl Sample

pub fn volts(&self) -> f32

Returns the measured voltage in volts.

pub fn nanovolts(&self) -> i64

Returns the measured voltage in nanovolts, exact in integer arithmetic.

pub fn clipped(&self) -> bool

Reports whether the conversion sits at either end code, 7FFFh or 8000h, where the output clips for a signal beyond the full-scale range (datasheet section 7.5.4 and Table 7-3).

A clipped sample means the input is at or past the range the gain selects, so its voltage is a bound rather than the reading; a wider range reads it.

Returns

true at either end code.

Examples

use pamoja_sensors::ads1115::{Pga, Sample};

let pinned = Sample { raw: i16::MAX, pga: Pga::Fsr2_048 };
assert!(pinned.clipped());
assert!(!Sample { raw: 18_800, pga: Pga::Fsr4_096 }.clipped());

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

Returns the conversion register bytes for this sample, most significant first.

This is what the part sends when the register is read, so a test can script it.

Trait Implementations

impl Clone for Sample

fn clone(&self) -> Sample

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Sample

impl Debug for Sample

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

Formats the value using the given formatter.

impl Eq for Sample

impl PartialEq for Sample

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Sample