diff options
Diffstat (limited to 'src/lib.rs')
| -rw-r--r-- | src/lib.rs | 252 |
1 files changed, 7 insertions, 245 deletions
@@ -191,185 +191,8 @@ #![deny(missing_docs)] #![no_std] -use core::marker::PhantomData; - -/// Errors in this crate -#[derive(Debug)] -pub enum Error<E> { - /// I²C bus error - I2C(E), - /// Invalid input data provided - InvalidInputData, -} - -/// Error type for mode changes. -/// -/// This allows to retrieve the unchanged device in case of an error. -pub enum ModeChangeError<E, DEV> { - /// I²C bus error while changing mode. - /// - /// `E` is the error that happened. - /// `DEV` is the device with the mode unchanged. - I2C(E, DEV), -} - const DEVICE_BASE_ADDRESS: u8 = 0b100_1000; -/// Mode marker types -pub mod mode { - /// One-shot operating mode / power-down state (default) - pub struct OneShot(()); - - /// Continuous conversion mode - pub struct Continuous(()); -} - -/// Data rate for ADS1013, ADS1014, ADS1015 -#[derive(Debug, Clone, Copy, PartialEq)] -pub enum DataRate12Bit { - /// 128 SPS - Sps128, - /// 250 SPS - Sps250, - /// 490 SPS - Sps490, - /// 920 SPS - Sps920, - /// 1600 SPS (default) - Sps1600, - /// 2400 SPS - Sps2400, - /// 3300 SPS - Sps3300, -} - -/// Data rate for ADS1113, ADS1114, ADS1115 -#[derive(Debug, Clone, Copy, PartialEq)] -pub enum DataRate16Bit { - /// 8 SPS - Sps8, - /// 16 SPS - Sps16, - /// 32 SPS - Sps32, - /// 64 SPS - Sps64, - /// 128 SPS (default) - Sps128, - /// 250 SPS - Sps250, - /// 475 SPS - Sps475, - /// 860 SPS - Sps860, -} -/// Comparator mode (only for ADS1x14, ADS1x15) -#[derive(Debug, Clone, Copy, PartialEq)] -pub enum ComparatorMode { - /// Traditional comparator (default) - /// - /// In this mode the ALERT/RDY pin asserts (according to selected active - /// polarity) when the conversion data exceeds the limit set as *high* - /// threshold and remains active until the conversion data falls below the - /// value set as *low* threshold. - Traditional, - /// Window comparator - /// - /// In this mode the ALERT/RDY pin asserts (according to selected active - /// polarity) when the conversion data exceeds the value set as *high* - /// threshold or goes below the value set as *low* temperature threshold. - Window, -} - -/// Comparator polarity (only for ADS1x14, ADS1x15) -#[derive(Debug, Clone, Copy, PartialEq)] -pub enum ComparatorPolarity { - /// Active low (default) - ActiveLow, - /// Active high - ActiveHigh, -} - -/// Comparator polarity (only for ADS1x14, ADS1x15) -/// -/// Select whether the ALERT/RDY pin latches after being asserted or clears -/// after conversions are within the margin of the upper and lower -/// threshold values. -#[derive(Debug, Clone, Copy, PartialEq)] -pub enum ComparatorLatching { - /// Nonlatching (default) - /// - /// The ALERT/RDY pin does not latch when asserted. - Nonlatching, - /// Latching - /// - /// The asserted ALERT/RDY pin remains latched until conversion data are - /// read by the master or an appropriate SMBus alert response is sent by - /// the master. The device responds with its address, and it is the lowest - /// address currently asserting the ALERT/RDY bus line. - Latching, -} - -/// Comparator alert queue (only for ADS1x14, ADS1x15) -/// -/// The default state of the comparator is deactivated. It can be activated by setting -/// the comparator queue. -#[derive(Debug, Clone, Copy, PartialEq)] -pub enum ComparatorQueue { - /// Activate comparator and assert after one conversion exceeding thresholds - One, - /// Activate comparator and assert after two consecutive conversions exceeding thresholds - Two, - /// Activate comparator and assert after four consecutive conversions exceeding thresholds - Four, -} - -/// Full-scale range configuration for the programmable gain amplifier (PGA) (only for ADS1x14, ADS1x15) -/// -/// This sets the input voltage measurable range. -/// The FSR is fixed at ±2.048 V in the ADS1x13. -#[derive(Clone, Copy, Debug, PartialEq)] -#[allow(non_camel_case_types)] -pub enum FullScaleRange { - /// The measurable range is ±6.144V. - Within6_144V, - /// The measurable range is ±4.096V. - Within4_096V, - /// The measurable range is ±2.048V. (default) - Within2_048V, - /// The measurable range is ±1.024V. - Within1_024V, - /// The measurable range is ±0.512V. - Within0_512V, - /// The measurable range is ±0.256V. - Within0_256V, -} - -/// Possible slave addresses -#[derive(Debug, Clone, Copy, PartialEq)] -pub enum SlaveAddr { - /// Default slave address - Default, - /// Alternative slave address providing bit values for A1 and A0 - Alternative(bool, bool), -} - -impl Default for SlaveAddr { - /// Default slave address - fn default() -> Self { - SlaveAddr::Default - } -} - -impl SlaveAddr { - fn addr(self, default: u8) -> u8 { - match self { - SlaveAddr::Default => default, - SlaveAddr::Alternative(a1, a0) => default | ((a1 as u8) << 1) | a0 as u8, - } - } -} - struct Register; impl Register { @@ -399,52 +222,12 @@ impl BitFlags { const COMP_QUE0: u16 = 0b0000_0000_0000_0001; } -#[derive(Debug, Clone, PartialEq)] -struct Config { - bits: u16, -} - -impl Config { - fn is_high(&self, mask: u16) -> bool { - (self.bits & mask) != 0 - } - - fn with_high(&self, mask: u16) -> Self { - Config { - bits: self.bits | mask, - } - } - fn with_low(&self, mask: u16) -> Self { - Config { - bits: self.bits & !mask, - } - } -} - -impl Default for Config { - fn default() -> Self { - Config { bits: 0x8583 } - } -} - -impl Default for FullScaleRange { - fn default() -> Self { - FullScaleRange::Within2_048V - } -} - -/// ADS1x1x ADC driver -#[derive(Debug, Default)] -pub struct Ads1x1x<DI, IC, CONV, MODE> { - iface: DI, - config: Config, - fsr: FullScaleRange, - a_conversion_was_started: bool, - _conv: PhantomData<CONV>, - _ic: PhantomData<IC>, - _mode: PhantomData<MODE>, -} - +mod types; +use crate::types::Config; +pub use crate::types::{ + mode, Ads1x1x, ComparatorLatching, ComparatorMode, ComparatorPolarity, ComparatorQueue, + DataRate12Bit, DataRate16Bit, Error, FullScaleRange, ModeChangeError, SlaveAddr, +}; mod channels; #[doc(hidden)] pub mod ic; @@ -454,8 +237,7 @@ pub use crate::channels::channel; mod construction; mod conversion; mod devices; -pub use crate::conversion::ConvertMeasurement; -pub use crate::conversion::ConvertThreshold; +pub use crate::conversion::{ConvertMeasurement, ConvertThreshold}; mod private { use super::{ic, interface}; @@ -473,23 +255,3 @@ mod private { impl Sealed for ic::Ads1015 {} impl Sealed for ic::Ads1115 {} } - -#[cfg(test)] -mod tests { - use super::DEVICE_BASE_ADDRESS as ADDR; - use super::*; - - #[test] - fn can_get_default_address() { - let addr = SlaveAddr::default(); - assert_eq!(ADDR, addr.addr(ADDR)); - } - - #[test] - fn can_generate_alternative_addresses() { - assert_eq!(0b100_1000, SlaveAddr::Alternative(false, false).addr(ADDR)); - assert_eq!(0b100_1001, SlaveAddr::Alternative(false, true).addr(ADDR)); - assert_eq!(0b100_1010, SlaveAddr::Alternative(true, false).addr(ADDR)); - assert_eq!(0b100_1011, SlaveAddr::Alternative(true, true).addr(ADDR)); - } -} |