1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
//! This is a platform agnostic Rust driver for the TMP102 and TMP112
//! high-accuracy, low-power, digital temperature sensors, based on the
//! [`embedded-hal`] traits.
//!
//! [`embedded-hal`]: https://github.com/rust-embedded/embedded-hal
//!
//! This driver allows you to:
//! - Change into one-shot or continuous conversion mode.
//! - Read the temperature.
//! - Enable/disable the extended measurement mode.
//! - Trigger a one-shot measurement.
//! - Read whether the one-shot measurement result is ready.
//! - Set the conversion rate.
//! - Set the high/low temperature threshold.
//! - Set the fault queue.
//! - Set the alert polarity.
//! - Set the thermostat mode.
//! - Read whether a comparator mode alert is active.
//!
//! ## The devices
//!
//! This driver is compatible with both the TMP102 device as well as the TMP112
//! family of devices, including TMP112A, TMP112B and TMP112N.
//!
//! These temperature sensors are highly linear and do not require complex
//! calculations or lookup tables to derive the temperature. The on-chip
//! 12-bit ADC offers resolutions down to 0.0625°C.
//!
//! The TMP102 device is a digital temperature sensor ideal for NTC/PTC
//! thermistor replacement where high accuracy is required. The device offers an
//! accuracy of +/-0.5°C without requiring calibration or external component
//! signal conditioning.
//!
//! The TMP112 family of devices are digital temperature sensors designed for
//! high-accuracy, low-power, NTC/PTC thermistor replacements where high accuracy
//! is required. The TMP112A and TMP112B offers 0.5°C accuracy and are optimized
//! to provide the best PSR performance for 3.3V and 1.8V operation respectively,
//! while TMP112N offers 1°C accuracy.
//!
//! The devices feature SMBus(TM), two-wire and I2C interface compatibility,
//! and allows up to four devices on one bus.
//!
//! Datasheets:
//! - [TMP102](http://www.ti.com/lit/ds/symlink/tmp102.pdf)
//! - [TMP112x](http://www.ti.com/lit/ds/symlink/tmp112.pdf)
//!
//! ## Usage examples (see also examples folder)
//!
//! To use this driver, import this crate and an `embedded_hal` implementation,
//! then instantiate the appropriate device.
//!
//! Please find additional examples in this repository: [driver-examples]
//!
//! [driver-examples]: https://github.com/eldruin/driver-examples
//!
//! ### Read temperature in continuous mode
//!
//! ```no_run
//! use linux_embedded_hal::I2cdev;
//! use tmp1x2::{Tmp1x2, SlaveAddr};
//!
//! let dev = I2cdev::new("/dev/i2c-1").unwrap();
//! let address = SlaveAddr::default();
//! // Per default the device is in continuous mode
//! let mut sensor = Tmp1x2::new(dev, address);
//! let temperature = sensor.read_temperature().unwrap();
//! println!("Temperature: {}", temperature);
//! ```
//!
//! ### Provide an alternative address
//!
//! ```no_run
//! use linux_embedded_hal::I2cdev;
//! use tmp1x2::{Tmp1x2, SlaveAddr};
//!
//! let dev = I2cdev::new("/dev/i2c-1").unwrap();
//! let (a1, a0) = (false, true);
//! let address = SlaveAddr::Alternative(a1, a0);
//! let mut sensor = Tmp1x2::new(dev, address);
//! ```
//!
//! ### Change into one-shot mode and trigger a measurement
//!
//! ```no_run
//! use linux_embedded_hal::I2cdev;
//! use nb::block;
//! use tmp1x2::{Tmp1x2, SlaveAddr};
//!
//! let dev = I2cdev::new("/dev/i2c-1").unwrap();
//! let sensor = Tmp1x2::new(dev, SlaveAddr::default());
//! let mut sensor = sensor.into_one_shot().ok().expect("Mode change error");
//! let temperature = block!(sensor.read_temperature());
//! ```
//!
//! ### Get the device back if there was an error during a mode change
//!
//! ```no_run
//! use linux_embedded_hal::I2cdev;
//! use tmp1x2::{ModeChangeError, Tmp1x2, SlaveAddr};
//!
//! let dev = I2cdev::new("/dev/i2c-1").unwrap();
//! let mut sensor_continuous = Tmp1x2::new(dev, SlaveAddr::default());
//! let result = sensor_continuous.into_one_shot();
//! if let Err(ModeChangeError::I2C(e, dev)) = result {
//! sensor_continuous = dev;
//! } else if let Ok(one_shot_sensor) = result {
//! // do something with one-shot sensor...
//! } else {
//! unreachable!();
//! }
//! ```
//!
//! ### Enable the extended measurement mode
//!
//! ```no_run
//! use linux_embedded_hal::I2cdev;
//! use tmp1x2::{Tmp1x2, SlaveAddr};
//!
//! let dev = I2cdev::new("/dev/i2c-1").unwrap();
//! let mut sensor = Tmp1x2::new(dev, SlaveAddr::default());
//! sensor.enable_extended_mode().unwrap();
//! ```
//!
//! ### Set the conversion rate to 1Hz
//!
//! ```no_run
//! use linux_embedded_hal::I2cdev;
//! use tmp1x2::{Tmp1x2, SlaveAddr, ConversionRate};
//!
//! let dev = I2cdev::new("/dev/i2c-1").unwrap();
//! let mut sensor = Tmp1x2::new(dev, SlaveAddr::default());
//! sensor.set_conversion_rate(ConversionRate::_1Hz).unwrap();
//! ```
//!
//! ### Set the high and low temperature thresholds
//!
//! ```no_run
//! use linux_embedded_hal::I2cdev;
//! use tmp1x2::{Tmp1x2, SlaveAddr, ConversionRate};
//!
//! let dev = I2cdev::new("/dev/i2c-1").unwrap();
//! let mut sensor = Tmp1x2::new(dev, SlaveAddr::default());
//! sensor.set_low_temperature_threshold(-15.0).unwrap();
//! sensor.set_high_temperature_threshold(60.0).unwrap();
//! ```
//!
//! ### Set the fault queue
//!
//! This sets the number of consecutive faults that will trigger an alert.
//!
//! ```no_run
//! use linux_embedded_hal::I2cdev;
//! use tmp1x2::{Tmp1x2, SlaveAddr, FaultQueue};
//!
//! let dev = I2cdev::new("/dev/i2c-1").unwrap();
//! let mut sensor = Tmp1x2::new(dev, SlaveAddr::default());
//! sensor.set_fault_queue(FaultQueue::_4).unwrap();
//! ```
//!
//! ### Set the alert polarity
//!
//! ```no_run
//! use linux_embedded_hal::I2cdev;
//! use tmp1x2::{ Tmp1x2, SlaveAddr, AlertPolarity };
//!
//! let dev = I2cdev::new("/dev/i2c-1").unwrap();
//! let mut sensor = Tmp1x2::new(dev, SlaveAddr::default());
//! sensor.set_alert_polarity(AlertPolarity::ActiveHigh).unwrap();
//! ```
//!
//! ### Set the thermostat mode
//!
//! ```no_run
//! use linux_embedded_hal::I2cdev;
//! use tmp1x2::{ Tmp1x2, SlaveAddr, ThermostatMode };
//!
//! let dev = I2cdev::new("/dev/i2c-1").unwrap();
//! let mut sensor = Tmp1x2::new(dev, SlaveAddr::default());
//! sensor.set_thermostat_mode(ThermostatMode::Interrupt).unwrap();
//! ```
//!
//! ### Check whether an alert is active as defined by the comparator mode
//!
//! Note that this ignores the thermostat mode setting and always refers to
//! the status as defined by the comparator mode.
//!
//! ```no_run
//! use linux_embedded_hal::I2cdev;
//! use tmp1x2::{Tmp1x2, SlaveAddr};
//!
//! let dev = I2cdev::new("/dev/i2c-1").unwrap();
//! let mut sensor = Tmp1x2::new(dev, SlaveAddr::default());
//! let alert = sensor.is_comparator_mode_alert_active().unwrap();
//! ```
#![deny(unsafe_code)]
#![deny(missing_docs)]
#![no_std]
use core::marker::PhantomData;
use embedded_hal::i2c;
pub use nb;
/// Possible errors in this crate
#[derive(Debug)]
pub enum Error<E> {
/// I²C bus error
I2C(E),
}
/// Error type for mode changes.
///
/// This allows to retrieve the unchanged device in case of an error.
#[derive(Debug)]
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),
}
/// Conversion rate for continuous conversion mode
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Hash)]
pub enum ConversionRate {
/// 0.25Hz
_0_25Hz,
/// 1Hz
_1Hz,
/// 4 Hz (default)
#[default]
_4Hz,
/// 8 Hz
_8Hz,
}
/// Fault queue
///
/// Number of consecutive faults necessary to trigger an alert.
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Hash)]
pub enum FaultQueue {
/// 1 fault will trigger an alert (default)
#[default]
_1,
/// 2 consecutive faults will trigger an alert
_2,
/// 4 consecutive faults will trigger an alert
_4,
/// 6 consecutive faults will trigger an alert
_6,
}
/// Alert polarity
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Hash)]
pub enum AlertPolarity {
/// Active low (default)
#[default]
ActiveLow,
/// Active high
ActiveHigh,
}
/// Thermostat mode
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Hash)]
pub enum ThermostatMode {
/// Comparator (default)
///
/// In this mode an alert is generated (set alert pin and alert bit
/// according to selected active polarity) when the temperature equals or
/// exceeds the value set as *high* temperature threshold and remains
/// active until the temperature falls below the value set as *low*
/// temperature threshold.
#[default]
Comparator,
/// Interrupt
///
/// In this mode an alert is generated (set alert pin and alert bit
/// according to selected active polarity) when the temperature exceeds the
/// value set as *high* temperature threshold or goes below the value set
/// as *low* temperature threshold.
Interrupt,
}
/// Possible slave addresses
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Hash)]
pub enum SlaveAddr {
/// Default slave address
#[default]
Default,
/// Alternative slave address providing bit values for A1 and A0
Alternative(bool, bool),
}
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,
}
}
}
const DEVICE_BASE_ADDRESS: u8 = 0b100_1000;
struct Register;
impl Register {
const TEMPERATURE: u8 = 0x00;
const CONFIG: u8 = 0x01;
const T_LOW: u8 = 0x02;
const T_HIGH: u8 = 0x03;
}
struct BitFlagsLow;
impl BitFlagsLow {
const SHUTDOWN: u8 = 0b0000_0001;
const THERMOSTAT: u8 = 0b0000_0010;
const ALERT_POLARITY: u8 = 0b0000_0100;
const FAULT_QUEUE0: u8 = 0b0000_1000;
const FAULT_QUEUE1: u8 = 0b0001_0000;
const RESOLUTION: u8 = 0b0110_0000;
const ONE_SHOT: u8 = 0b1000_0000;
}
struct BitFlagsHigh;
impl BitFlagsHigh {
const EXTENDED_MODE: u8 = 0b0001_0000;
const ALERT: u8 = 0b0010_0000;
const CONV_RATE0: u8 = 0b0100_0000;
const CONV_RATE1: u8 = 0b1000_0000;
}
#[derive(Debug, Clone)]
struct Config {
lsb: u8,
msb: u8,
}
impl Default for Config {
fn default() -> Self {
Config {
lsb: BitFlagsLow::RESOLUTION,
msb: BitFlagsHigh::ALERT | BitFlagsHigh::CONV_RATE1,
}
}
}
#[doc(hidden)]
pub mod marker {
pub mod mode {
#[derive(Debug)]
pub struct Continuous(());
#[derive(Debug)]
pub struct OneShot(());
}
}
/// TMP1X2 device driver.
#[derive(Debug, Default)]
pub struct Tmp1x2<I2C, MODE> {
/// The concrete I²C device implementation.
i2c: I2C,
/// The I²C device address.
address: u8,
/// Configuration register status.
config: Config,
/// A temperature conversion was started.
a_temperature_conversion_was_started: bool,
_mode: PhantomData<MODE>,
}
impl<I2C, E> Tmp1x2<I2C, marker::mode::Continuous>
where
I2C: i2c::I2c<Error = E>,
{
/// Create new instance of the TMP102 or TMP112x device.
///
/// By default they are in continuous conversion mode.
pub fn new(i2c: I2C, address: SlaveAddr) -> Self {
Tmp1x2 {
i2c,
address: address.addr(DEVICE_BASE_ADDRESS),
config: Config::default(),
a_temperature_conversion_was_started: false,
_mode: PhantomData,
}
}
}
impl<I2C, MODE> Tmp1x2<I2C, MODE> {
/// Destroy driver instance, return I²C bus instance.
pub fn destroy(self) -> I2C {
self.i2c
}
}
mod configuration;
mod conversion;
mod reading;
//impl<E> core::fmt::Debug for nb::Error<E> {}
#[cfg(test)]
mod tests {
use super::*;
use embedded_hal_mock as hal;
use DEVICE_BASE_ADDRESS as BASE_ADDR;
#[test]
fn can_get_default_address() {
let addr = SlaveAddr::default();
assert_eq!(BASE_ADDR, addr.addr(BASE_ADDR));
}
#[test]
fn can_generate_alternative_addresses() {
assert_eq!(
0b100_1000,
SlaveAddr::Alternative(false, false).addr(BASE_ADDR)
);
assert_eq!(
0b100_1001,
SlaveAddr::Alternative(false, true).addr(BASE_ADDR)
);
assert_eq!(
0b100_1010,
SlaveAddr::Alternative(true, false).addr(BASE_ADDR)
);
assert_eq!(
0b100_1011,
SlaveAddr::Alternative(true, true).addr(BASE_ADDR)
);
}
#[test]
fn default_config() {
let dev = Tmp1x2::new(hal::eh1::i2c::Mock::new(&[]), SlaveAddr::default());
assert_eq!(0b0110_0000, dev.config.lsb);
assert_eq!(0b1010_0000, dev.config.msb);
dev.destroy().done()
}
}