Merge pull request #35 from tammymakesthings/issue32-add-type-annotations

Issue32 add type annotations

Author: tekktrik

adafruit_amg88xx.py

@@ -23,56 +23,69 @@
 **Notes:**
 """
 
-__version__ = "0.0.0-auto.0"
-__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_AMG88xx"
+__version__: str = "0.0.0-auto.0"
+__repo__: str = "https://github.com/adafruit/Adafruit_CircuitPython_AMG88xx"
 
 from adafruit_bus_device.i2c_device import I2CDevice
 from adafruit_register import i2c_bit, i2c_bits
+from adafruit_register.i2c_bits import (
+    RWBits,
+)  # pylint: disable=unused-import,line-too-long
+from adafruit_register.i2c_bit import (
+    RWBit,
+)  # pylint: disable=unused-import,line-too-long
 from micropython import const
 
+try:
+    from typing import List
+
+    # These are only needed for typing
+    import busio  # pylint: disable=unused-import
+except ImportError:
+    pass
 
 # Registers are defined below in the class. These are possible register values.
 
 # Operating Modes
-_NORMAL_MODE = const(0x00)
-_SLEEP_MODE = const(0x10)
-_STAND_BY_60 = const(0x20)
-_STAND_BY_10 = const(0x21)
+_NORMAL_MODE: int = const(0x00)
+_SLEEP_MODE: int = const(0x10)
+_STAND_BY_60: int = const(0x20)
+_STAND_BY_10: int = const(0x21)
 
 # sw resets
-_FLAG_RESET = const(0x30)
-_INITIAL_RESET = const(0x3F)
+_FLAG_RESET: int = const(0x30)
+_INITIAL_RESET: int = const(0x3F)
 
 # frame rates
-_FPS_10 = const(0x00)
-_FPS_1 = const(0x01)
+_FPS_10: int = const(0x00)
+_FPS_1: int = const(0x01)
 
 # int enables
-_INT_DISABLED = const(0x00)
-_INT_ENABLED = const(0x01)
+_INT_DISABLED: int = const(0x00)
+_INT_ENABLED: int = const(0x01)
 
 # int modes
-_DIFFERENCE = const(0x00)
-_ABSOLUTE_VALUE = const(0x01)
+_DIFFERENCE: int = const(0x00)
+_ABSOLUTE_VALUE: int = const(0x01)
 
-_INT_OFFSET = const(0x010)
-_PIXEL_OFFSET = const(0x80)
+_INT_OFFSET: int = const(0x010)
+_PIXEL_OFFSET: int = const(0x80)
 
-_PIXEL_ARRAY_WIDTH = const(8)
-_PIXEL_ARRAY_HEIGHT = const(8)
-_PIXEL_TEMP_CONVERSION = 0.25
-_THERMISTOR_CONVERSION = 0.0625
+_PIXEL_ARRAY_WIDTH: int = const(8)
+_PIXEL_ARRAY_HEIGHT: int = const(8)
+_PIXEL_TEMP_CONVERSION: int = 0.25
+_THERMISTOR_CONVERSION: int = 0.0625
 
 
-def _signed_12bit_to_float(val):
+def _signed_12bit_to_float(val: int) -> float:
     # take first 11 bits as absolute val
     abs_val = val & 0x7FF
     if val & 0x800:
         return 0 - float(abs_val)
     return float(abs_val)
 
 
-def _twos_comp_to_float(val):
+def _twos_comp_to_float(val: int) -> float:
     val &= 0xFFF
     if val & 0x800:
         val -= 0x1000
@@ -83,34 +96,34 @@ class AMG88XX:
     """Driver for the AMG88xx GRID-Eye IR 8x8 thermal camera."""
 
     # Set up the registers
-    _pctl = i2c_bits.RWBits(8, 0x00, 0)
-    _rst = i2c_bits.RWBits(8, 0x01, 0)
-    _fps = i2c_bit.RWBit(0x02, 0)
-    _inten = i2c_bit.RWBit(0x03, 0)
-    _intmod = i2c_bit.RWBit(0x03, 1)
+    _pctl: RWBits = i2c_bits.RWBits(8, 0x00, 0)
+    _rst: RWBits = i2c_bits.RWBits(8, 0x01, 0)
+    _fps: RWBit = i2c_bit.RWBit(0x02, 0)
+    _inten: RWBit = i2c_bit.RWBit(0x03, 0)
+    _intmod: RWBit = i2c_bit.RWBit(0x03, 1)
 
-    _intf = i2c_bit.RWBit(0x04, 1)
-    _ovf_irs = i2c_bit.RWBit(0x04, 2)
-    _ovf_ths = i2c_bit.RWBit(0x04, 3)
+    _intf: RWBit = i2c_bit.RWBit(0x04, 1)
+    _ovf_irs: RWBit = i2c_bit.RWBit(0x04, 2)
+    _ovf_ths: RWBit = i2c_bit.RWBit(0x04, 3)
 
-    _intclr = i2c_bit.RWBit(0x05, 1)
-    _ovs_clr = i2c_bit.RWBit(0x05, 2)
-    _ovt_clr = i2c_bit.RWBit(0x05, 3)
+    _intclr: RWBit = i2c_bit.RWBit(0x05, 1)
+    _ovs_clr: RWBit = i2c_bit.RWBit(0x05, 2)
+    _ovt_clr: RWBit = i2c_bit.RWBit(0x05, 3)
 
-    _mamod = i2c_bit.RWBit(0x07, 5)
+    _mamod: RWBit = i2c_bit.RWBit(0x07, 5)
 
-    _inthl = i2c_bits.RWBits(8, 0x08, 0)
-    _inthh = i2c_bits.RWBits(4, 0x09, 0)
-    _intll = i2c_bits.RWBits(8, 0x0A, 0)
-    _intlh = i2c_bits.RWBits(4, 0x0B, 0)
-    _ihysl = i2c_bits.RWBits(8, 0x0C, 0)
-    _ihysh = i2c_bits.RWBits(4, 0x0D, 0)
+    _inthl: RWBits = i2c_bits.RWBits(8, 0x08, 0)
+    _inthh: RWBits = i2c_bits.RWBits(4, 0x09, 0)
+    _intll: RWBits = i2c_bits.RWBits(8, 0x0A, 0)
+    _intlh: RWBits = i2c_bits.RWBits(4, 0x0B, 0)
+    _ihysl: RWBits = i2c_bits.RWBits(8, 0x0C, 0)
+    _ihysh: RWBits = i2c_bits.RWBits(4, 0x0D, 0)
 
-    _tthl = i2c_bits.RWBits(8, 0x0E, 0)
+    _tthl: RWBits = i2c_bits.RWBits(8, 0x0E, 0)
 
-    _tthh = i2c_bits.RWBits(4, 0x0F, 0)
+    _tthh: RWBits = i2c_bits.RWBits(4, 0x0F, 0)
 
-    def __init__(self, i2c, addr=0x69):
+    def __init__(self, i2c: busio.I2C, addr: int = 0x69) -> None:
         self.i2c_device = I2CDevice(i2c, addr)
 
         # enter normal mode
@@ -126,13 +139,13 @@ def __init__(self, i2c, addr=0x69):
         self._fps = _FPS_10
 
     @property
-    def temperature(self):
+    def temperature(self) -> float:
         """Temperature of the sensor in Celsius"""
         raw = (self._tthh << 8) | self._tthl
         return _signed_12bit_to_float(raw) * _THERMISTOR_CONVERSION
 
     @property
-    def pixels(self):
+    def pixels(self) -> List[List[float]]:
         """Temperature of each pixel across the sensor in Celsius.
 
         Temperatures are stored in a two dimensional list where the first index is the row and