Struct Calibration 

pub struct Calibration { /* private fields */ }

A linear map from raw sensor counts to calibrated units.

Most cheap analog sensors report arbitrary counts - ADC steps, a raw voltage - that mean nothing until they are converted to real units. A Calibration applies the line value = scale * raw + offset. Build it from two readings whose true values are known, then apply it to every sample.

Examples

use pamoja_kit::Calibration;

// A humidity probe reads 0.5 V at 0 % and 2.5 V at 100 %.
let humidity = Calibration::two_point(0.5, 0.0, 2.5, 100.0);
assert_eq!(humidity.apply(1.5), 50.0);

Implementations

impl Calibration

pub fn linear(scale: f32, offset: f32) -> Self

Builds a calibration from a scale and offset directly.

Arguments

• scale - the multiplier applied to a raw reading.
• offset - the constant added after scaling.

Returns

The calibration value = scale * raw + offset.

pub fn two_point( raw_low: f32, value_low: f32, raw_high: f32, value_high: f32, ) -> Self

Builds a calibration from two known (raw, value) points.

Arguments

• raw_low - a raw reading.
• value_low - the true value at raw_low.
• raw_high - another raw reading.
• value_high - the true value at raw_high.

Returns

The line through both points. If the two raw readings are equal the slope is undefined, so the calibration falls back to the constant value_low.

pub fn apply(&self, raw: f32) -> f32

Converts a raw reading into calibrated units.

Arguments

• raw - the uncalibrated sensor reading.

Returns

The calibrated value.

Trait Implementations

impl Clone for Calibration

fn clone(&self) -> Calibration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Calibration

impl Debug for Calibration

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

Formats the value using the given formatter.

impl PartialEq for Calibration

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