Merge branch 'main' into feature/dht20

Author: zeldan

.github/workflows/rust.yml

@@ -0,0 +1,22 @@
+name: Rust
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Build
+      run: cargo build --verbose
+    - name: Run tests
+      run: cargo test --verbose

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "embedded-dht-rs"
-version = "0.1.1"
+version = "0.2.0"
 edition = "2021"
 license = "Apache-2.0"
 description = "A platform agnostic driver to interface with the DHT11/DHT22 (AM2302) temperature and humidity sensor"

Cargo.toml

@@ -1,3 +1,7 @@
+![build workflow](https://github.com/rust-dd/embedded-dht-rs/actions/workflows/rust.yml/badge.svg)
+[![Crates.io](https://img.shields.io/crates/v/embedded-dht-rs?style=flat-square)](https://crates.io/crates/embedded-dht-rs)
+![Crates.io](https://img.shields.io/crates/l/embedded-dht-rs?style=flat-square)
+
 # embedded-dht-rs
 
 Welcome to `embedded-dht-rs`, a Rust library designed to make working with DHT sensors a breeze!

README.md

@@ -16,7 +16,7 @@ impl<P: InputPin + OutputPin, D: DelayNs> Dht11<P, D> {
         }
     }
 
-    pub fn read(&mut self) -> Result<SensorReading, SensorError> {
+    pub fn read(&mut self) -> Result<SensorReading<u8>, SensorError> {
         // Start communication: pull pin low for 18ms, then release.
         let _ = self.dht.pin.set_low();
         self.dht.delay.delay_ms(18);
@@ -46,8 +46,8 @@ impl<P: InputPin + OutputPin, D: DelayNs> Dht11<P, D> {
         }
 
         Ok(SensorReading {
-            humidity: humidity_integer as f32,
-            temperature: temperature_integer as f32,
+            humidity: humidity_integer,
+            temperature: temperature_integer,
         })
     }
 }

src/dht11.rs

@@ -16,7 +16,7 @@ impl<P: InputPin + OutputPin, D: DelayNs> Dht22<P, D> {
         }
     }
 
-    pub fn read(&mut self) -> Result<SensorReading, SensorError> {
+    pub fn read(&mut self) -> Result<SensorReading<f32>, SensorError> {
         // Start communication: pull pin low for 18ms, then release.
         let _ = self.dht.pin.set_low();
         self.dht.delay.delay_ms(18);
@@ -52,8 +52,8 @@ impl<P: InputPin + OutputPin, D: DelayNs> Dht22<P, D> {
         let temperatue_percentage = temperature_value as f32 / 10.0;
 
         Ok(SensorReading {
-            humidity: humidity_percentage as f32,
-            temperature: temperatue_percentage as f32,
+            humidity: humidity_percentage,
+            temperature: temperatue_percentage,
         })
     }
 }

src/dht22.rs

@@ -6,9 +6,9 @@ pub mod dht20;
 pub mod dht22;
 
 /// Represents a reading from the sensor.
-pub struct SensorReading {
-    pub humidity: f32,
-    pub temperature: f32,
+pub struct SensorReading<T> {
+    pub humidity: T,
+    pub temperature: T,
 }
 
 /// Possible errors when interacting with the sensor.