Initial implementation.

Author: kattni

adafruit_mcp9600.py

@@ -44,14 +44,15 @@
 * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
 """
 
-# imports
-
-__version__ = "0.0.0-auto.0"
-__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_MCP9600.git"
-
 from struct import unpack
 from micropython import const
 from adafruit_bus_device.i2c_device import I2CDevice
+from adafruit_register.i2c_struct import UnaryStruct, ROUnaryStruct
+from adafruit_register.i2c_bits import RWBits, ROBits
+from adafruit_register.i2c_bit import RWBit, ROBit
+
+__version__ = "0.0.0-auto.0"
+__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_MCP9600.git"
 
 _DEFAULT_ADDRESS = const(0x67)
 
@@ -61,9 +62,115 @@
 _REGISTER_THERM_CFG = const(0x05)
 _REGISTER_VERSION = const(0x20)
 
-class MCP9600():
+
+class BurstModeSamples:
+    """An enum-like class representing the options for number of burst mode samples."""
+    BURST_SAMPLES_1 = 0b000
+    BURST_SAMPLES_2 = 0b001
+    BURST_SAMPLES_4 = 0b010
+    BURST_SAMPLES_8 = 0b011
+    BURST_SAMPLES_16 = 0b100
+    BURST_SAMPLES_32 = 0b101
+    BURST_SAMPLES_64 = 0b110
+    BURST_SAMPLES_128 = 0b111
+
+
+class ShutdownModes:
+    """An enum-like class representing the options for shutdown modes"""
+    NORMAL = 0b00
+    SHUTDOWN = 0b01
+    BURST = 0b10
+
+
+class MCP9600:
     """Interface to the MCP9600 thermocouple amplifier breakout"""
 
+    # Alert temperature monitor options
+    AMBIENT = 1
+    THERMOCOUPLE = 0
+
+    # Temperature change type to trigger alert. Rising is heating up. Falling is cooling down.
+    RISING = 1
+    FALLING = 0
+
+    # Alert output options
+    ACTIVE_HIGH = 1
+    ACTIVE_LOW = 0
+
+    # Alert mode options
+    INTERRUPT = 1  # Interrupt clear option must be set when using this mode!
+    COMPARATOR = 0
+
+    # TODO: Get clarification on this and potentially update names
+    # Interrupt clear options
+    CLEAR_INTERRUPT_FLAG = 1
+    NORMAL_STATE = 0
+
+    # Ambient (cold-junction) temperature sensor resolution options
+    AMBIENT_RESOLUTION_0_0625 = 0  # 0.0625 degrees Celsius
+    AMBIENT_RESOLUTION_0_25 = 1  # 0.25 degrees Celsius
+
+    # STATUS - 0x4
+    burst_complete = RWBit(0x4, 7)
+    temperature_update = RWBit(0x4, 6)
+    input_range = ROBit(0x4, 4)
+    alert_1 = ROBit(0x4, 0)
+    alert_2 = ROBit(0x4, 1)
+    alert_3 = ROBit(0x4, 2)
+    alert_4 = ROBit(0x4, 3)
+    # Device Configuration - 0x6
+    ambient_resolution = RWBit(0x6, 7)
+    burst_mode_samples = RWBits(3, 0x6, 2)
+    shutdown_mode = RWBits(2, 0x6, 0)
+    # Alert 1 Configuration - 0x8
+    _alert_1_interrupt_clear = RWBit(0x8, 7)
+    _alert_1_monitor = RWBit(0x8, 4)
+    _alert_1_temp_direction = RWBit(0x8, 3)
+    _alert_1_state = RWBit(0x8, 2)
+    _alert_1_mode = RWBit(0x8, 1)
+    _alert_1_enable = RWBit(0x8, 0)
+    """Set to ``True`` to enable alert output. Set to ``False`` to disable alert output."""
+    # Alert 2 Configuration - 0x9
+    _alert_2_interrupt_clear = RWBit(0x9, 7)
+    _alert_2_monitor = RWBit(0x9, 4)
+    _alert_2_temp_direction = RWBit(0x9, 3)
+    _alert_2_state = RWBit(0x9, 2)
+    _alert_2_mode = RWBit(0x9, 1)
+    _alert_2_enable = RWBit(0x9, 0)
+    # Alert 3 Configuration - 0xa
+    _alert_3_interrupt_clear = RWBit(0xa, 7)
+    _alert_3_monitor = RWBit(0xa, 4)
+    _alert_3_temp_direction = RWBit(0xa, 3)
+    _alert_3_state = RWBit(0xa, 2)
+    _alert_3_mode = RWBit(0xa, 1)
+    _alert_3_enable = RWBit(0xa, 0)
+    # Alert 4 Configuration - 0xb
+    _alert_4_interrupt_clear = RWBit(0xb, 7)
+    _alert_4_monitor = RWBit(0xb, 4)
+    _alert_4_temp_direction = RWBit(0xb, 3)
+    _alert_4_state = RWBit(0xb, 2)
+    _alert_4_mode = RWBit(0xb, 1)
+    _alert_4_enable = RWBit(0xb, 0)
+    # Alert 1 Hysteresis - 0xc
+    _alert_1_hysteresis = UnaryStruct(0xc, ">H")
+    # Alert 2 Hysteresis - 0xd
+    _alert_2_hysteresis = UnaryStruct(0xd, ">H")
+    # Alert 3 Hysteresis - 0xe
+    _alert_3_hysteresis = UnaryStruct(0xe, ">H")
+    # Alert 4 Hysteresis - 0xf
+    _alert_4_hysteresis = UnaryStruct(0xf, ">H")
+    # Alert 1 Limit - 0x10
+    _alert_1_temperature_limit = UnaryStruct(0x10, ">H")
+    # Alert 2 Limit - 0x11
+    _alert_2_limit = UnaryStruct(0x11, ">H")
+    # Alert 3 Limit - 0x12
+    _alert_3_limit = UnaryStruct(0x12, ">H")
+    # Alert 4 Limit - 0x13
+    _alert_4_limit = UnaryStruct(0x13, ">H")
+    # Device ID/Revision - 0x20
+    _device_id = ROBits(8, 0x20, 8, register_width=2, lsb_first=False)
+    _revision_id = ROBits(8, 0x20, 0, register_width=2)
+
     types = ("K", "J", "T", "N", "S", "E", "B", "R")
 
     def __init__(self, i2c, address=_DEFAULT_ADDRESS, tctype="K", tcfilter=0):
@@ -82,6 +189,26 @@ def __init__(self, i2c, address=_DEFAULT_ADDRESS, tctype="K", tcfilter=0):
         self.buf[1] = tcfilter | (ttype << 4)
         with self.i2c_device as tci2c:
             tci2c.write(self.buf, end=2)
+        if self._device_id != 0x40:
+            raise RuntimeError("Failed to find MCP9600 - check wiring!")
+
+    def alert_config(self, *, alert_number, alert_temp_source, alert_temp_limit, alert_hysteresis,
+                     alert_temp_direction, alert_mode, alert_state):
+        """ For rising temps, hysteresis is below alert limit; falling temps, above alert limit
+        Alert is enabled by default when set. To disable, use alert_disable method."""
+        setattr(self, '_alert_%d_monitor' % alert_number, alert_temp_source)
+        setattr(self, '_alert_%d_temperature_limit' % alert_number, int(alert_temp_limit / 0.0625))
+        setattr(self, '_alert_%d_hysteresis' % alert_number, alert_hysteresis)
+        setattr(self, '_alert_%d_temp_direction' % alert_number, alert_temp_direction)
+        setattr(self, '_alert_%d_mode' % alert_number, alert_mode)
+        setattr(self, '_alert_%d_state' % alert_number, alert_state)
+        setattr(self, '_alert_%d_enable' % alert_number, True)
+
+    def alert_disable(self, alert_number):
+        setattr(self, '_alert_%d_enable' % alert_number, False)
+
+    def alert_interrupt_clear(self, alert_number, interrupt_clear=True):
+        setattr(self, '_alert_%d_interrupt_clear' % alert_number, interrupt_clear)
 
     @property
     def version(self):