hts221: Add HTS221 Driver

Author: nedseb

lib/hts221/README.md

@@ -0,0 +1,9 @@
+# MicroPython Driver for the HTS221 Humidity Sensor
+
+This library is a port of the [MicroPython Driver for the HTS221 Humidity Sensor](https://github.com/jposada202020/MicroPython_HTS221/tree/master).
+
+The examples could be easily tested with [mpremote](https://docs.micropython.org/en/latest/reference/mpremote.html) with the following command :
+
+```sh
+ mpremote mount . run examples/humidity.py
+```

lib/hts221/examples/humidity.py

@@ -0,0 +1,51 @@
+from machine import I2C
+from hts221 import HTS221
+from time import sleep_ms
+import pyb
+
+i2c = I2C(1)
+
+sleep_ms(1000)
+
+sensor = HTS221(i2c)
+
+led_red = pyb.LED(1)
+led_green = pyb.LED(2)
+led_blue = pyb.LED(3)
+
+
+def red() -> None:
+    led_red.on()
+    led_green.off()
+    led_blue.off()
+
+
+def green() -> None:
+    led_red.off()
+    led_green.on()
+    led_blue.off()
+
+
+def blue() -> None:
+    led_red.off()
+    led_green.off()
+    led_blue.on()
+
+
+while True:
+    sleep_ms(1000)
+
+    temp = sensor.temperature()
+    humi = sensor.humidity()
+
+    print("Temperature : % .1f °C, Humidity : % .1f %% " % (temp, humi), end="")
+
+    if temp > 25:
+        red()
+        print("🥵")
+    elif temp > 16 and temp <= 25:
+        green()
+        print("😃")
+    else:
+        blue()
+        print("🥶")

lib/hts221/hts221/__init__.py

@@ -0,0 +1,5 @@
+from hts221.device import HTS221
+
+__all__ = [
+    "HTS221",
+]

lib/hts221/hts221/const.py

@@ -0,0 +1,29 @@
+from micropython import const
+
+# HTS221 I2C address
+HTS_I2C_ADDR = const(0x5F)
+
+# HTS221 register mapping
+HTS221_WHO_AM_I = const(0x0F)
+HTS221_AV_CONF = const(0x10)
+HTS221_CTRL_REG1 = const(0x20)
+HTS221_CTRL_REG2 = const(0x21)
+HTS221_CTRL_REG3 = const(0x22)
+HTS221_STATUS_REG = const(0x27)
+HTS221_HUMIDITY_OUT_L = const(0x28)
+HTS221_HUMIDITY_OUT_H = const(0x29)
+HTS221_TEMP_OUT_L = const(0x2A)
+HTS221_TEMP_OUT_H = const(0x2B)
+HTS221_H0_rH_x2 = const(0x30)
+HTS221_H1_rH_x2 = const(0x31)
+HTS221_T0_degC_x8 = const(0x32)
+HTS221_T1_degC_x8 = const(0x33)
+HTS221_T1T0_msb = const(0x35)
+HTS221_H0_T0_OUT_L = const(0x36)
+HTS221_H0_T0_OUT_H = const(0x37)
+HTS221_H1_T0_OUT_L = const(0x3A)
+HTS221_H1_T0_OUT_H = const(0x3B)
+HTS221_T0_OUT_L = const(0x3C)
+HTS221_T0_OUT_H = const(0x3D)
+HTS221_T1_OUT_L = const(0x3E)
+HTS221_T1_OUT_H = const(0x3F)

lib/hts221/hts221/device.py

@@ -0,0 +1,103 @@
+from machine import I2C
+
+from hts221.const import *
+
+
+def int16(d):
+    return d if d < 0x8000 else d - 0x10000
+
+
+class HTS221(object):
+    def __init__(self, i2c, address=HTS_I2C_ADDR):
+        self.i2c = i2c
+        self.address = address
+
+        self.writebuffer = bytearray(1)
+        self.readbuffer = bytearray(1)
+
+        self.calibrate_temperature()
+        self.calibrate_humidity()
+
+        # set av conf: T=4 H=8
+        self.setAv(0x81)
+        # set CTRL_REG1: PD=1 BDU=1 ODR=1
+        self.setODR(0x85)
+
+    def calibrate_temperature(self):
+        # HTS221 Temp Calibration registers
+        self.T0_OUT = int16(self.get2Reg(HTS221_T0_OUT_L))
+        self.T1_OUT = int16(self.get2Reg(HTS221_T1_OUT_L))
+
+        t1 = self.getReg(HTS221_T1T0_msb)
+        self.T0_degC = (self.getReg(HTS221_T0_degC_x8) + (t1 % 4) * 256) / 8
+        self.T1_degC = (self.getReg(HTS221_T1_degC_x8) + ((t1 % 16) / 4) * 256) / 8
+
+    def calibrate_humidity(self):
+        # HTS221 Humi Calibration registers
+        self.H0_OUT = self.get2Reg(HTS221_H0_T0_OUT_L)
+        self.H1_OUT = self.get2Reg(HTS221_H1_T0_OUT_L)
+        self.H0_rH = self.getReg(HTS221_H0_rH_x2) / 2
+        self.H1_rH = self.getReg(HTS221_H1_rH_x2) / 2
+
+    def setReg(self, dat, reg):
+        self.writebuffer[0] = dat
+        self.i2c.writeto_mem(self.address, reg, self.writebuffer)
+
+    def getReg(self, reg):
+        self.i2c.readfrom_mem_into(self.address, reg, self.readbuffer)
+        return self.readbuffer[0]
+
+    def get2Reg(self, reg):
+        lowerByte = self.getReg(reg)
+        higherByte = self.getReg(reg + 1)
+        return (higherByte << 8) + lowerByte
+
+    # Device identification
+    def whoAmI(self):
+        return self.getReg(HTS221_WHO_AM_I)
+
+    # get STATUS register
+    def status(self):
+        return self.getReg(HTS221_STATUS_REG)
+
+    # power control
+    def poweroff(self):
+        t = self.getReg(HTS221_CTRL_REG1) & 0x7F
+        self.setReg(t, HTS221_CTRL_REG1)
+
+    def poweron(self):
+        t = self.getReg(HTS221_CTRL_REG1) | 0x80
+        self.setReg(t, HTS221_CTRL_REG1)
+
+    # get/set Output data rate
+    def getODR(self):
+        return self.getReg(HTS221_CTRL_REG1) & 0x03
+
+    def setODR(self, odr=0):
+        t = self.getReg(HTS221_CTRL_REG1) & 0xFC
+        self.setReg(t | odr, HTS221_CTRL_REG1)
+
+    # get/set Humidity and temperature average configuration
+    def getAv():
+        return self.getReg(HTS221_AV_CONF)
+
+    def setAv(self, av=0):
+        self.setReg(av, HTS221_AV_CONF)
+
+    # calculate Temperature
+    def temperature(self):
+        t = self.get2Reg(HTS221_TEMP_OUT_L)
+        return self.T0_degC + (self.T1_degC - self.T0_degC) * (t - self.T0_OUT) / (
+            self.T1_OUT - self.T0_OUT
+        )
+
+    # calculate Humidity
+    def humidity(self):
+        t = self.get2Reg(HTS221_HUMIDITY_OUT_L)
+        return self.H0_rH + (self.H1_rH - self.H0_rH) * (t - self.H0_OUT) / (
+            self.H1_OUT - self.H0_OUT
+        )
+
+    # get Humidity and Temperature
+    def get(self):
+        return [self.humidity(), self.temperature()]

lib/hts221/manifest.py

@@ -0,0 +1,6 @@
+metadata(
+    description="Driver of APDS9960 RGB, ambient light, proximity and gesture sensor.",
+    version="0.0.1",
+)
+
+package("apds9960")