1 unstable release
new 0.2.4 | Mar 3, 2025 |
---|---|
0.2.3 |
|
0.2.2 |
|
0.2.1 |
|
0.2.0 |
|
#19 in #sensirion
260 downloads per month
24KB
382 lines
Please sht4x crate instead
https://github.com/sirhcel/sht4x/
This was a fork of sirhcel's sht4x library which at the time did not have async support or use embedded-hal-1.0.0. The original library now supports both starting with version 0.2.0. Please use the sht4x crate instead of this one.
It is better for the community at large not to have forks when not needed.
Sensirion SHT4x Driver for Embedded HAL
A platform agnostic device driver for the Sensirion SHT4x temperature and
humidity sensor
family.
It is based on embedded-hal
traits and works in no_std
environments.
In theory, it supports all of the sensor family's devices but has only been tested with the SHT40-AD1B so far.
Features
- Blocking operation
- Async operation if the
async
feature is specified - Uses the latest embedded_hal 1.0.0
- Supports all commands specified in the datasheet
- Explicitly borrows
DelayNs
for command execution so that it could be shared (among multiple sensors) - Could be instantiated with the alternative I2C address for the SHT40-BD1B
- Uses fixed-point arithmetics for converting raw sensor data into measurements
in SI units
- Based on
I16F16
from thefixed
crate - Allows conversion to floating-point values, if needed
- Convenience methods for fixed-point conversions to milli degree Celsius or milli percent relative humidity which are commonly used by drivers for other humidity and temperature sensors from Sensirion
- Based on
- Optional support for
defmt
Example
use embedded_hal::delay::DelayNs;
use sht4x_ng::Sht4x;
// Device-specific use declarations.
let mut delay = // Device-specific initialization of delay.
let i2c = // Device-specific initialization of I2C peripheral.
let mut sht40 = Sht4x::new(i2c);
let serial = sht40.serial_number(&mut delay);
defmt::info!("serial number: {}", serial);
let measurement = sht40.measure(Precision::Low, &mut delay);
defmt::info!("measurement: {}", &measurement);
if let Ok(measurement) = measurement {
// Convert temperature measurand into different formats for further
// processing.
let int: i32 = measurement.temperature_milli_celsius();
let fixed: I16F16 = measurement.temperature_celsius();
let float: f32 = measurement.temperature_celsius().to_num();
}
Related Work
sensor-temp-humidity-sht40 is another driver for this sensor family.
License
Licensed under either of
-
Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
-
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your discretion.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Dependencies
~3MB
~56K SLoC