Make clippy happy and spell Sense HAT correctly.

Move Relative Humidity out to its own module.

Author: thejpster

Cargo.toml

@@ -1,16 +1,16 @@
 [package]
 name = "sensehat"
-version = "0.3.0"
+version = "0.4.0"
 authors = ["Jonathan Pallant <[email protected]>"]
 license-file = "LICENSE.md"
 documentation = "https://docs.rs/crate/sensehat"
 repository = "https://github.com/thejpster/sensehat-rs"
 keywords = ["sensehat", "raspberry", "pi", "sensors"]
-description = "Interface with the Raspberry Pi Foundation's official Sense Hat sensor board."
+description = "Interface with the Raspberry Pi Foundation's official Sense HAT sensor board."
 readme = "README.md"
 
 [dependencies]
-measurements = "0.7.0"
+measurements = "0.10.2"
 i2cdev = "0.3.1"
 byteorder = "1.0.0"
 libc = { version = "0.2.0", optional = true }
@@ -20,8 +20,7 @@ gcc = "0.3"
 
 [features]
 # The default set of optional packages. Most people will want to use these
-# packages, but they are strictly optional. Note that `session` is not a package
-# but rather another feature listed in this manifest.
+# packages, but they are strictly optional.
 default = ["rtimu"]
 rtimu = [ "libc" ]
 

README.md

@@ -1,6 +1,9 @@
 # sensehat-rs
-Rust support for the Raspberry Pi Sense Hat
 
-See https://www.raspberrypi.org/products/sense-hat/ for details on the Sense Hat.
+Rust support for the Raspberry Pi Sense HAT
 
-See https://github.com/RPi-Distro/python-sense-hat for the official Python driver. This one tries to follow the same API as the Python version.
+See <https://www.raspberrypi.org/products/sense-hat/> for details on the Sense HAT.
+
+See <https://github.com/RPi-Distro/python-sense-hat> for the official Python driver. This one tries to follow the same API as the Python version.
+
+See <https://github.com/thejpster/pi-workshop-rs/> for some workshop materials which use this driver.

examples/get_all.rs

@@ -3,7 +3,7 @@ extern crate sensehat;
 use sensehat::SenseHat;
 
 fn main() {
-    let mut sense_hat = SenseHat::new().expect("Couldn't create Sense Hat object");
+    let mut sense_hat = SenseHat::new().expect("Couldn't create Sense HAT object");
     let temp = sense_hat
         .get_temperature_from_humidity()
         .expect("Couldn't get temp");

src/hts221.rs

@@ -45,44 +45,44 @@ where
         let mut buf = [0u8; 2];
         buf[0] = i2cdev.smbus_read_byte_data(REG_T0_C_8)?;
         buf[1] = i2cdev.smbus_read_byte_data(REG_T1_T0)? & 0x03;
-        let t0 = (LittleEndian::read_i16(&buf) as f64) / 8.0;
+        let t0 = f64::from(LittleEndian::read_i16(&buf)) / 8.0;
         buf[0] = i2cdev.smbus_read_byte_data(REG_T1_C_8)?;
         buf[1] = (i2cdev.smbus_read_byte_data(REG_T1_T0)? & 0x0C) >> 2;
-        let t1 = (LittleEndian::read_i16(&buf) as f64) / 8.0;
+        let t1 = f64::from(LittleEndian::read_i16(&buf)) / 8.0;
 
         buf[0] = i2cdev.smbus_read_byte_data(REG_T0_OUT)?;
         buf[1] = i2cdev.smbus_read_byte_data(REG_T0_OUT + 1)?;
-        let t0_out = LittleEndian::read_i16(&buf) as f64;
+        let t0_out = f64::from(LittleEndian::read_i16(&buf));
 
         buf[0] = i2cdev.smbus_read_byte_data(REG_T1_OUT)?;
         buf[1] = i2cdev.smbus_read_byte_data(REG_T1_OUT + 1)?;
-        let t1_out = LittleEndian::read_i16(&buf) as f64;
+        let t1_out = f64::from(LittleEndian::read_i16(&buf));
 
         buf[0] = i2cdev.smbus_read_byte_data(REG_H0_H_2)?;
-        let h0 = (buf[0] as f64) / 2.0;
+        let h0 = f64::from(buf[0]) / 2.0;
 
         buf[0] = i2cdev.smbus_read_byte_data(REG_H1_H_2)?;
-        let h1 = (buf[0] as f64) / 2.0;
+        let h1 = f64::from(buf[0]) / 2.0;
 
         buf[0] = i2cdev.smbus_read_byte_data(REG_H0_T0_OUT)?;
         buf[1] = i2cdev.smbus_read_byte_data(REG_H0_T0_OUT + 1)?;
-        let h0_t0_out = LittleEndian::read_i16(&buf) as f64;
+        let h0_t0_out = f64::from(LittleEndian::read_i16(&buf));
 
         buf[0] = i2cdev.smbus_read_byte_data(REG_H1_T0_OUT)?;
         buf[1] = i2cdev.smbus_read_byte_data(REG_H1_T0_OUT + 1)?;
-        let h1_t0_out = LittleEndian::read_i16(&buf) as f64;
+        let h1_t0_out = f64::from(LittleEndian::read_i16(&buf));
 
         let temp_m = (t1 - t0) / (t1_out - t0_out);
         let temp_c = t0 - (temp_m * t0_out);
         let hum_m = (h1 - h0) / (h1_t0_out - h0_t0_out);
         let hum_c = h0 - (hum_m * h0_t0_out);
 
         Ok(Hts221 {
-            i2cdev: i2cdev,
-            temp_m: temp_m,
-            temp_c: temp_c,
-            hum_m: hum_m,
-            hum_c: hum_c,
+            i2cdev,
+            temp_m,
+            temp_c,
+            hum_m,
+            hum_c,
         })
     }
 
@@ -100,7 +100,7 @@ where
 
     pub fn get_relative_humidity_percent(&mut self) -> Result<f64, T::Error> {
         self.get_relative_humidity()
-            .and_then(|c| Ok((c as f64 * self.hum_m) + self.hum_c))
+            .and_then(|c| Ok((f64::from(c) * self.hum_m) + self.hum_c))
     }
 
     pub fn get_temperature(&mut self) -> Result<i16, T::Error> {
@@ -112,6 +112,6 @@ where
 
     pub fn get_temperature_celcius(&mut self) -> Result<f64, T::Error> {
         self.get_temperature()
-            .and_then(|c| Ok((c as f64 * self.temp_m) + self.temp_c))
+            .and_then(|c| Ok((f64::from(c) * self.temp_m) + self.temp_c))
     }
 }

src/lib.rs

@@ -1,20 +1,38 @@
+//! # A driver for the Raspberry Pi Sense HAT
+//!
+//! The [Sense HAT](https://www.raspberrypi.org/products/sense-hat/) is a
+//! sensor board for the Raspberry Pi. It features an LED matrix, a humidity
+//! and temperature sensor, a pressure and temperature sensor and a gyroscope.
+//!
+//! Supported components:
+//!
+//! * Humidity and Temperature Sensor (an HTS221)
+//! * Pressure and Temperature Sensor (a LPS25H)
+//! * Gyroscope (an LSM9DS1, requires the RTIMU library)
+//!
+//! Currently unsupported components:
+//!
+//! * LED matrix
+//! * Joystick
+
 extern crate byteorder;
 extern crate i2cdev;
 extern crate measurements;
 
 #[cfg(feature = "rtimu")]
 extern crate libc;
 
+mod rh;
+mod hts221;
+mod lps25h;
+
 pub use measurements::Temperature;
 pub use measurements::Pressure;
+pub use measurements::Angle;
+pub use rh::RelativeHumidity;
 
 use i2cdev::linux::{LinuxI2CDevice, LinuxI2CError};
 
-use std::fmt;
-
-mod hts221;
-mod lps25h;
-
 #[cfg(feature = "rtimu")]
 mod lsm9ds1;
 
@@ -23,18 +41,6 @@ mod lsm9ds1_dummy;
 #[cfg(not(feature = "rtimu"))]
 use lsm9ds1_dummy as lsm9ds1;
 
-/// An angle between two lines
-#[derive(Debug, Copy, Clone)]
-pub struct Angle {
-    value: f64,
-}
-
-/// Represents a relative humidity reading from the humidity sensor
-#[derive(Debug, Copy, Clone)]
-pub struct RelativeHumidity {
-    value: f64,
-}
-
 /// Represents an orientation from the IMU
 #[derive(Debug, Copy, Clone)]
 pub struct Orientation {
@@ -43,7 +49,7 @@ pub struct Orientation {
     pub yaw: Angle,
 }
 
-/// Represents the Sense Hat itself
+/// Represents the Sense HAT itself
 pub struct SenseHat<'a> {
     /// LPS25H pressure sensor
     pressure_chip: lps25h::Lps25h<LinuxI2CDevice>,
@@ -71,7 +77,7 @@ impl<'a> SenseHat<'a> {
     /// Try and create a new SenseHat object.
     ///
     /// Will open the relevant I2C devices and then attempt to initialise the
-    /// chips on the Sense Hat.
+    /// chips on the Sense HAT.
     pub fn new() -> SenseHatResult<SenseHat<'a>> {
         Ok(SenseHat {
             humidity_chip: hts221::Hts221::new(LinuxI2CDevice::new("/dev/i2c-1", 0x5f)?)?,
@@ -90,7 +96,8 @@ impl<'a> SenseHat<'a> {
     pub fn get_temperature_from_pressure(&mut self) -> SenseHatResult<Temperature> {
         let status = self.pressure_chip.status()?;
         if (status & 1) != 0 {
-            Ok(Temperature::from_celsius(self.pressure_chip.get_temp_celcius()?))
+            Ok(Temperature::from_celsius(self.pressure_chip
+                .get_temp_celcius()?))
         } else {
             Err(SenseHatError::NotReady)
         }
@@ -100,7 +107,8 @@ impl<'a> SenseHat<'a> {
     pub fn get_pressure(&mut self) -> SenseHatResult<Pressure> {
         let status = self.pressure_chip.status()?;
         if (status & 2) != 0 {
-            Ok(Pressure::from_hectopascals(self.pressure_chip.get_pressure_hpa()?))
+            Ok(Pressure::from_hectopascals(self.pressure_chip
+                .get_pressure_hpa()?))
         } else {
             Err(SenseHatError::NotReady)
         }
@@ -177,14 +185,6 @@ impl<'a> SenseHat<'a> {
     }
 }
 
-fn radians_to_degrees(radians: f64) -> f64 {
-    360.0 * (radians / (::std::f64::consts::PI * 2.0))
-}
-
-fn degrees_to_radians(degrees: f64) -> f64 {
-    (degrees * (::std::f64::consts::PI * 2.0)) / 360.0
-}
-
 impl From<LinuxI2CError> for SenseHatError {
     fn from(err: LinuxI2CError) -> SenseHatError {
         SenseHatError::I2CError(err)
@@ -197,56 +197,4 @@ impl From<lsm9ds1::Error> for SenseHatError {
     }
 }
 
-impl Angle {
-    pub fn from_radians(rad: f64) -> Angle {
-        Angle {
-            value: radians_to_degrees(rad),
-        }
-    }
-
-    pub fn as_radians(&self) -> f64 {
-        degrees_to_radians(self.value)
-    }
-
-    pub fn from_degrees(deg: f64) -> Angle {
-        Angle { value: deg }
-    }
-
-    pub fn as_degrees(&self) -> f64 {
-        self.value
-    }
-}
-
-impl RelativeHumidity {
-    pub fn from_percent(pc: f64) -> RelativeHumidity {
-        RelativeHumidity { value: pc }
-    }
-
-    pub fn as_percent(&self) -> f64 {
-        self.value
-    }
-}
-
-impl fmt::Display for RelativeHumidity {
-    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
-        write!(f, "{:.1}%", self.as_percent())
-    }
-}
-
-impl fmt::Display for Angle {
-    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
-        write!(f, "{:.1}°", self.as_degrees())
-    }
-}
-
-#[cfg(test)]
-mod tests {
-    use super::*;
-
-    #[test]
-    pub fn pressure_test() {
-        let p = Pressure::from_hectopascals(1000.0);
-        assert!((p.as_bars() - 1.0).abs() < 1e-6);
-        assert!((p.as_psi() - 14.50376807894691).abs() < 1e-6);
-    }
-}
+// End of file

src/lps25h.rs

@@ -1,5 +1,5 @@
 //! * Driver for the LPS25H Pressure sensor
-//! See http://www.st.com/en/mems-and-sensors/lps25h.html
+//! See <http://www.st.com/en/mems-and-sensors/lps25h.html>
 
 use i2cdev::core::I2CDevice;
 use byteorder::{ByteOrder, LittleEndian};
@@ -31,7 +31,7 @@ where
         i2cdev.smbus_write_byte_data(REG_FIFO_CTRL, 0xc0)?;
         i2cdev.smbus_write_byte_data(REG_CTRL_REG_2, 0x40)?;
 
-        Ok(Lps25h { i2cdev: i2cdev })
+        Ok(Lps25h { i2cdev })
     }
 
     /// Obtain the status bitfield from the chip.
@@ -50,7 +50,7 @@ where
 
     /// Obtain the temperature reading from the chip in deg C.
     pub fn get_temp_celcius(&mut self) -> Result<f64, T::Error> {
-        self.get_temp().and_then(|c| Ok((c as f64 / 480.0) + 42.5))
+        self.get_temp().and_then(|c| Ok((f64::from(c) / 480.0) + 42.5))
     }
 
     /// Obtain the pressure reading from the chip.
@@ -65,6 +65,6 @@ where
 
     /// Obtain the pressure reading from the chip in hPa.
     pub fn get_pressure_hpa(&mut self) -> Result<f64, T::Error> {
-        self.get_pressure().and_then(|c| Ok(c as f64 / 4096.0))
+        self.get_pressure().and_then(|c| Ok(f64::from(c) / 4096.0))
     }
 }

src/lsm9ds1.rs

@@ -5,8 +5,8 @@
 //! in how it manages the settings file.
 //!
 //! It turns out handling IMUs is really complicated and involves a ton of
-//! vector maths. We just wrap RTIMULib. We use the `gcc` crate to compile
-//! a C wrapper of the RTIMULib C++ API. We then call that unsafe C wrapper
+//! vector maths. We just wrap `RTIMULib`. We use the `gcc` crate to compile
+//! a C wrapper of the `RTIMULib` C++ API. We then call that unsafe C wrapper
 //! here, ensuring that any memory allocations were undone on drop.
 
 use super::{Angle, Orientation};
@@ -47,7 +47,7 @@ pub struct Lsm9ds1<'a> {
 }
 
 impl<'a> Lsm9ds1<'a> {
-    /// Uses the RTIMULib library.
+    /// Uses the `RTIMULib` library.
     pub fn new() -> Result<Lsm9ds1<'a>, Error> {
         let ctx_ref = unsafe {
             let ctx_p = rtimulib_wrapper_create();

src/lsm9ds1_dummy.rs

@@ -17,7 +17,7 @@ pub struct Lsm9ds1<'a> {
 }
 
 impl<'a> Lsm9ds1<'a> {
-    /// Uses the RTIMULib library.
+    /// Uses the `RTIMULib` library.
     pub fn new() -> Result<Lsm9ds1<'a>, Error> {
         Ok(Lsm9ds1 {
             phantom: PhantomData,

src/rh.rs

@@ -0,0 +1,27 @@
+//! # Defines a unit for Relative Humidity (which isn't in the measurements crate)
+
+use std::fmt;
+
+/// Represents a relative humidity reading from the humidity sensor
+#[derive(Debug, Copy, Clone)]
+pub struct RelativeHumidity {
+    value: f64,
+}
+
+impl RelativeHumidity {
+    pub fn from_percent(pc: f64) -> RelativeHumidity {
+        RelativeHumidity { value: pc }
+    }
+
+    pub fn as_percent(&self) -> f64 {
+        self.value
+    }
+}
+
+impl fmt::Display for RelativeHumidity {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        write!(f, "{:.1}%", self.as_percent())
+    }
+}
+
+// End of file