humidity->relative_humidity, fixing typos

Author: siddacious

adafruit_hts221.py

@@ -129,19 +129,16 @@ class Rate(CV):
     )
 )
 
-# def bp(val):
-#     return format(val, "#010b")
+
 class HTS221:  # pylint: disable=too-many-instance-attributes
-    """Library for the ST LPS2x family of humidity sensors
+    """Library for the ST HTS221 Humidity and Temperature Sensor
 
         :param ~busio.I2C i2c_bus: The I2C bus the HTS221HB is connected to.
-        :param address: The I2C device address for the sensor. Default is ``0x5d`` but will accept
-            ``0x5c`` when the ``SDO`` pin is connected to Ground.
 
     """
 
     _chip_id = ROUnaryStruct(_WHO_AM_I, "<B")
-    _boot = RWBit(_CTRL_REG2, 7)
+    _boot_bit = RWBit(_CTRL_REG2, 7)
     enabled = RWBit(_CTRL_REG1, 7)
     """Controls the power down state of the sensor. Setting to `False` will shut the sensor down"""
     _data_rate = RWBits(2, _CTRL_REG1, 0)
@@ -165,13 +162,13 @@ class HTS221:  # pylint: disable=too-many-instance-attributes
     _h0_t0_out = ROUnaryStruct(_H0_T0_OUT, "<h")
     _h1_t0_out = ROUnaryStruct(_H1_T1_OUT, "<h")
 
-    def __init__(self, i2c_bus, address=_HTS221_DEFAULT_ADDRESS):
-        self.i2c_device = i2cdevice.I2CDevice(i2c_bus, address)
+    def __init__(self, i2c_bus):
+        self.i2c_device = i2cdevice.I2CDevice(i2c_bus, _HTS221_DEFAULT_ADDRESS)
         if not self._chip_id in [_HTS221_CHIP_ID]:
             raise RuntimeError(
                 "Failed to find HTS221HB! Found chip ID 0x%x" % self._chip_id
             )
-        self.boot()
+        self._boot()
         self.enabled = True
         self.data_rate = Rate.RATE_12_5_HZ  # pylint:disable=no-member
 
@@ -197,16 +194,16 @@ def __init__(self, i2c_bus, address=_HTS221_DEFAULT_ADDRESS):
         self.calib_hum_meas_0 = self._h0_t0_out
         self.calib_hum_meas_1 = self._h1_t0_out
 
-    def boot(self):
-        """Reset the sensor, restoring all configuration registers to their defaults"""
-        self._boot = True
+    # This is the closest thing to a software reset. It re-loads the calibration values from flash
+    def _boot(self):
+        self._boot_bit = True
         # wait for the reset to finish
-        while self._boot:
+        while self._boot_bit:
             pass
 
     @property
-    def humidity(self):
-        """The current humidity measurement in hPa"""
+    def relative_humidity(self):
+        """The current relative humidity measurement in %rH"""
         calibrated_value_delta = self.calib_hum_value_1 - self.calib_hum_value_0
         calibrated_measurement_delta = self.calib_hum_meas_1 - self.calib_hum_meas_0
 
@@ -243,10 +240,10 @@ def temperature(self):
 
     @property
     def data_rate(self):
-        """The rate at which the sensor measures ``humidity`` and ``temperature``. ``data_rate``
-        should be set to one of the values of ``adafruit_hts221.Rate``. Note that setting
-        ``data_rate`` to ``Rate.ONE_SHOT`` will cause  ``humidity`` and ``temperature`` measurements
-        to only update when ``take_measurements`` is called."""
+        """The rate at which the sensor measures ``relative_humidity`` and ``temperature``.
+        ``data_rate`` should be set to one of the values of ``adafruit_hts221.Rate``. Note that
+        setting ``data_rate`` to ``Rate.ONE_SHOT`` will cause  ``relative_humidity`` and
+        ``temperature`` measurements to only update when ``take_measurements`` is called."""
         return self._data_rate
 
     @data_rate.setter
@@ -258,7 +255,7 @@ def data_rate(self, value):
 
     @property
     def humidity_data_ready(self):
-        """Returns true if a new humidity measurement is available to be read"""
+        """Returns true if a new relative humidity measurement is available to be read"""
         return self._humidity_status_bit
 
     @property
@@ -267,8 +264,8 @@ def temperature_data_ready(self):
         return self._temperature_status_bit
 
     def take_measurements(self):
-        """Update the value of ``pressure`` and ``temperature`` by taking a single measurement.
-            Only meaningful if ``data_rate`` is set to ``ONE_SHOT``"""
+        """Update the value of ``relative_humidity`` and ``temperature`` by taking a single
+        measurement. Only meaningful if ``data_rate`` is set to ``ONE_SHOT``"""
         self._one_shot_bit = True
         while self._one_shot_bit:
             pass

examples/hts221_simpletest.py

@@ -6,6 +6,7 @@
 i2c = busio.I2C(board.SCL, board.SDA)
 hts = adafruit_hts221.HTS221(i2c)
 while True:
-    print("Humidity: %.2f percent rH" % hts.humidity)
+    print("Relative Humidity: %.2f %% rH" % hts.relative_humidity)
     print("Temperature: %.2f C" % hts.temperature)
+    print("")
     time.sleep(1)