Enum kiibohd_hall_effect::CalibrationStatus

pub enum CalibrationStatus {
    NotReady,
    SensorMissing,
    SensorBroken,
    SensorLow,
    MagnetDetected,
    MagnetWrongPole,
    InvalidIndex,
}

Calibration status indicates if a sensor position is ready to send analysis for a particular key.

Variants

NotReady

Still trying to determine status (from power-on) Raw value must settle within a range before the sensor is considered ready This range is determined by the ADC mode that is currently set (e.g. 600-800 for at least 5 seconds)

SensorMissing

ADC value at 0 (test mode only)

SensorBroken

Reading higher than ADC supports (invalid), or magnet is too strong (test mode only)

SensorLow

Sensor value low (not enough data to quantify further)

MagnetDetected

Magnet detected, min calibrated, positive range

MagnetWrongPole

Magnet detected, wrong pole direction (test mode only)

InvalidIndex

Invalid index

Implementations

impl CalibrationStatus

pub fn update_calibration(&mut self, reading: u16, mode: SensorMode) -> bool

Update calibration status Returns true if the sensor is ready/calibrated

pub fn is_calibrated(&self) -> bool

Easy check whether or not the sensor is ready

pub fn detailed_calibration(&self, data: &SenseData) -> CalibrationStatus

Detailed calibration status Returns a more detailed calibration status (takes a few more steps and is not necessary during normal operation)

Trait Implementations

impl Clone for CalibrationStatus

fn clone(&self) -> CalibrationStatus

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CalibrationStatus

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

Formats the value using the given formatter.

impl PartialEq<CalibrationStatus> for CalibrationStatus

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for CalibrationStatus

impl Eq for CalibrationStatus

impl StructuralEq for CalibrationStatus

impl StructuralPartialEq for CalibrationStatus