Struct Thermometer 

pub struct Thermometer { /* private fields */ }

A DS18B20 the kernel exposes as a w1_slave file.

Examples

use pamoja_core::Sensor;
use pamoja_sensors::ds18b20::linux::Thermometer;

let mut probe = Thermometer::new("000005e2fdc3");
let scratchpad = probe.read().await?;
println!("{:.4} C", scratchpad.temperature_celsius());

Implementations

impl Thermometer

pub fn new(serial: &str) -> Thermometer

Names a thermometer by the serial in its directory name.

Arguments

• serial - the twelve hex digits after 28- in the device directory.

Returns

The thermometer, reading /sys/bus/w1/devices/28-<serial>/w1_slave.

pub fn at(path: impl Into<PathBuf>) -> Thermometer

Names a thermometer by the path of its w1_slave file.

Arguments

• path - the file to read.

Returns

The thermometer.

pub fn path(&self) -> &Path

Returns the path of the file the thermometer reads.

pub fn serial(&self) -> Option<&str>

Returns the serial the kernel named the thermometer’s directory after.

Returns

The twelve hex digits after 28-, as in 000005e2fdc3, which tell one probe from another and stay with the part for life. None when the file does not sit in a DS18B20’s directory, as a thermometer named by at may not.

Examples

use pamoja_sensors::ds18b20::linux::Thermometer;

assert_eq!(Thermometer::new("000005e2fdc3").serial(), Some("000005e2fdc3"));
assert_eq!(Thermometer::at("/tmp/w1_slave").serial(), None);

pub fn discover() -> Result<Vec<Thermometer>>

Lists every DS18B20 the kernel has found.

Returns

One thermometer per 28-* directory under DEVICES.

Errors

Returns the I/O error if the directory cannot be listed, which usually means the 1-Wire overlay is not enabled.

pub fn discover_in(devices: &Path) -> Result<Vec<Thermometer>>

Lists every DS18B20 directory under devices.

Arguments

• devices - the directory the kernel lists its 1-Wire devices in.

Returns

One thermometer per directory whose name starts with the DS18B20 family code, sorted by name.

Errors

Returns the I/O error if the directory cannot be listed.

pub fn read_scratchpad(&self) -> Result<Scratchpad, ThermometerError>

Reads the file, which makes the kernel run a conversion, and decodes it.

Returns

The CRC-checked scratchpad.

Errors

Returns ThermometerError::Io if the file cannot be read and ThermometerError::Sensor if it does not decode.

Trait Implementations

impl Clone for Thermometer

fn clone(&self) -> Thermometer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Thermometer

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

Formats the value using the given formatter.

impl Eq for Thermometer

impl PartialEq for Thermometer

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

Equality operator ==.

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

Inequality operator !=.

impl Sensor for Thermometer

type Reading = Scratchpad

The value produced by a single read, for example a temperature or a fix.

async fn read(&mut self) -> Result<Scratchpad>

Takes a single reading from the sensor.

fn map<F, T>(self, select: F) -> Map<Self, F>

where Self: Sized, F: FnMut(Self::Reading) -> T,

Wraps this sensor so every reading passes through select first.

impl StructuralPartialEq for Thermometer