-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(eclss): add SHT41 sensor support
- Loading branch information
Showing
8 changed files
with
224 additions
and
1 deletion.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| use crate::{ | ||
| error::{Context, EclssError, SensorError}, | ||
| metrics::{Gauge, SensorLabel}, | ||
| sensor::Sensor, | ||
| SharedBus, | ||
| }; | ||
| use core::{fmt, num::Wrapping, time::Duration}; | ||
| use embedded_hal_async::{ | ||
| delay::DelayNs, | ||
| i2c::{self, I2c}, | ||
| }; | ||
| use sht4x::AsyncSht4x; | ||
| pub use sht4x::Precision; | ||
|
|
||
| #[must_use = "sensors do nothing unless polled"] | ||
| pub struct Sht41<I: 'static, D> { | ||
| sensor: AsyncSht4x<&'static SharedBus<I>, D>, | ||
| temp: &'static Gauge, | ||
| rel_humidity: &'static Gauge, | ||
| abs_humidity: &'static Gauge, | ||
| abs_humidity_interval: usize, | ||
| precision: Precision, | ||
| polls: Wrapping<usize>, | ||
| delay: D, | ||
| } | ||
|
|
||
| pub struct Sht4xError<E>(sht4x::Error<E>); | ||
|
|
||
| const NAME: &str = "SHT41"; | ||
|
|
||
| impl<I, D> Sht41<I, D> | ||
| where | ||
| I: I2c + 'static, | ||
| D: DelayNs, | ||
| { | ||
| pub fn new<const SENSORS: usize>( | ||
| eclss: &'static crate::Eclss<I, { SENSORS }>, | ||
| delay: D, | ||
| ) -> Self { | ||
| let metrics = &eclss.metrics; | ||
| const LABEL: SensorLabel = SensorLabel(NAME); | ||
| // This is the default I2C address of the Adafruit breakout board. | ||
| // TODO(eliza): make this configurable | ||
| let address = sht4x::Address::Address0x44; | ||
|
|
||
| Self { | ||
| sensor: AsyncSht4x::new_with_address(&eclss.i2c, address), | ||
| temp: metrics.temp.register(LABEL).unwrap(), | ||
| rel_humidity: metrics.rel_humidity.register(LABEL).unwrap(), | ||
| abs_humidity: metrics.abs_humidity.register(LABEL).unwrap(), | ||
| polls: Wrapping(0), | ||
| abs_humidity_interval: 1, | ||
| precision: Precision::Medium, | ||
| delay, | ||
| } | ||
| } | ||
|
|
||
| pub fn with_abs_humidity_interval(self, interval: usize) -> Self { | ||
| Self { | ||
| abs_humidity_interval: interval, | ||
| ..self | ||
| } | ||
| } | ||
|
|
||
| pub fn with_precision(self, precision: Precision) -> Self { | ||
| Self { precision, ..self } | ||
| } | ||
| } | ||
|
|
||
| impl<I, D> Sensor for Sht41<I, D> | ||
| where | ||
| I: I2c + 'static, | ||
| D: DelayNs, | ||
| { | ||
| const NAME: &'static str = NAME; | ||
| const POLL_INTERVAL: Duration = Duration::from_secs(1); | ||
| type Error = EclssError<Sht4xError<I::Error>>; | ||
|
|
||
| async fn init(&mut self) -> Result<(), Self::Error> { | ||
| let serial = self | ||
| .sensor | ||
| .serial_number(&mut self.delay) | ||
| .await | ||
| .context("error reading SHT41 serial number")?; | ||
| tracing::info!("Connected to {NAME}, serial number: {serial:#x}"); | ||
| Ok(()) | ||
| } | ||
|
|
||
| async fn poll(&mut self) -> Result<(), Self::Error> { | ||
| let reading = self | ||
| .sensor | ||
| .measure(self.precision, &mut self.delay) | ||
| .await | ||
| .context("error reading SHT41 measurement")?; | ||
|
|
||
| let temp = reading.temperature_celsius().to_num::<f64>(); | ||
| let rel_humidity = reading.humidity_percent().to_num::<f64>(); | ||
| self.temp.set_value(temp); | ||
| self.rel_humidity.set_value(rel_humidity); | ||
| tracing::debug!("{NAME}: Temp: {temp}°C, Humidity: {rel_humidity}%"); | ||
|
|
||
| if self.polls.0 % self.abs_humidity_interval == 0 { | ||
| let abs_humidity = super::absolute_humidity(temp as f32, rel_humidity as f32); | ||
| self.abs_humidity.set_value(abs_humidity.into()); | ||
| tracing::debug!("{NAME}: Absolute humidity: {abs_humidity} g/m³"); | ||
| } | ||
|
|
||
| self.polls += 1; | ||
|
|
||
| Ok(()) | ||
| } | ||
| } | ||
|
|
||
| impl<E> From<sht4x::Error<E>> for Sht4xError<E> { | ||
| fn from(value: sht4x::Error<E>) -> Self { | ||
| Self(value) | ||
| } | ||
| } | ||
|
|
||
| impl<E: i2c::Error> SensorError for Sht4xError<E> { | ||
| fn i2c_error(&self) -> Option<i2c::ErrorKind> { | ||
| match self { | ||
| Self(sht4x::Error::I2c(i)) => Some(i.kind()), | ||
| _ => None, | ||
| } | ||
| } | ||
| } | ||
|
|
||
| impl<E: fmt::Display> fmt::Display for Sht4xError<E> { | ||
| fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { | ||
| match self { | ||
| Self(sht4x::Error::I2c(i)) => fmt::Display::fmt(i, f), | ||
| Self(sht4x::Error::Crc) => write!(f, "{NAME} CRC checksum validation failed"), | ||
| Self(_) => write!(f, "unknown {NAME} error"), | ||
| } | ||
| } | ||
| } |