From e70f9acf6954e70bbeeec37d001fcc17508f54ae Mon Sep 17 00:00:00 2001
From: sommersoft <sommersoft@gmail.com>
Date: Fri, 21 Dec 2018 13:19:33 -0600
Subject: [PATCH 001/107] change 'travis-ci.org' to 'travis-ci.com'

---
 README.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/README.rst b/README.rst
index 5c577c6..aaaa520 100644
--- a/README.rst
+++ b/README.rst
@@ -9,8 +9,8 @@ Introduction
     :target: https://discord.gg/nBQh6qu
     :alt: Discord
 
-.. image:: https://travis-ci.org/adafruit/Adafruit_CircuitPython_MLX90393.svg?branch=master
-    :target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_MLX90393
+.. image:: https://travis-ci.com/adafruit/Adafruit_CircuitPython_MLX90393.svg?branch=master
+    :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_MLX90393
     :alt: Build Status
 
 Adafruit CircuitPython driver for the MLX90393 3-axis magnetometer.

From bbb6b7cda09d7ec539752f7b75ff4b5010aff533 Mon Sep 17 00:00:00 2001
From: Kevin Townsend <contact@microbuilder.eu>
Date: Thu, 17 Jan 2019 22:21:52 +0100
Subject: [PATCH 002/107] Updated lookup table to latest DS, added reg read

---
 adafruit_mlx90393.py | 68 ++++++++++++++++++++++++++++++++------------
 1 file changed, 50 insertions(+), 18 deletions(-)

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index eec2f59..2ad3114 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -99,24 +99,24 @@
 # The lookup table below allows you to convert raw sensor data to uT
 # using the appropriate (gain/resolution-dependant) lsb-per-uT
 # coefficient below. Note that the z axis has a different coefficient
-# than the x and y axis.
+# than the x and y axis. Assumes HALLCONF = 0x0C!
 _LSB_LOOKUP = (
     # 5x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-    ((0.805, 1.468), (1.610, 2.936), (3.220, 5.872), (6.440, 11.744)),
+    ((0.751, 1.210), (1.502, 2.420), (3.004, 4.840), (6.009, 9.680)),
     # 4x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-    ((0.644, 1.174), (1.288, 2.349), (2.576, 4.698), (5.152, 9.395)),
+    ((0.601, 0.968), (1.202, 1.936), (2.403, 3.872), (4.840, 7.744)),
     # 3x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-    ((0.483, 0.881), (0.966, 1.762), (1.932, 3.523), (3.864, 7.046)),
+    ((0.451, 0.726), (0.901, 1.452), (1.803, 2.904), (3.605, 5.808)),
     # 2.5x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-    ((0.403, 0.734), (0.805, 1.468), (1.610, 2.936), (3.220, 5.872)),
+    ((0.376, 0.605), (0.751, 1.210), (1.502, 2.420), (3.004, 4.840)),
     # 2x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-    ((0.322, 0.587), (0.644, 1.174), (1.288, 2.349), (2.576, 4.698)),
+    ((0.300, 0.484), (0.601, 0.968), (1.202, 1.936), (2.403, 3.872)),
     # 1.667x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-    ((0.268, 0.489), (0.537, 0.979), (1.073, 1.957), (2.147, 3.915)),
+    ((0.250, 0.403), (0.501, 0.807), (1.001, 1.613), (2.003, 3.227)),
     # 1.333x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-    ((0.215, 0.391), (0.429, 0.783), (0.859, 1.566), (1.717, 3.132)),
+    ((0.200, 0.323), (0.401, 0.645), (0.801, 1.291), (1.602, 2.581)),
     # 1x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-    ((0.161, 0.294), (0.322, 0.587), (0.644, 1.174), (1.288, 2.349))
+    ((0.150, 0.242), (0.300, 0.484), (0.601, 0.968), (1.202, 1.936))
 )
 
 
@@ -143,7 +143,8 @@ def __init__(self, i2c_bus, address=0x0C, gain=GAIN_1X, debug=False):
         # Set gain to the supplied level
         self.gain = self._gain_current
 
-    def _transceive(self, payload, rxlen=0):
+
+    def _transceive(self, payload, rxlen=0, delay=0.01):
         """
         Writes the specified 'payload' to the sensor
         Returns the results of the write attempt.
@@ -154,6 +155,9 @@ def _transceive(self, payload, rxlen=0):
         with self.i2c_device as i2c:
             i2c.write(payload)
 
+        # Insert a delay since we aren't using INTs for DRDY
+        time.sleep(delay)
+
         # Read the response (+1 to account for the mandatory status byte!)
         data = bytearray(rxlen+1)
         while True:
@@ -176,6 +180,7 @@ def _transceive(self, payload, rxlen=0):
             print("\t  Status :", hex(data[0]))
         return data
 
+
     @property
     def last_status(self):
         """
@@ -183,6 +188,7 @@ def last_status(self):
         """
         return self._status_last
 
+
     @property
     def gain(self):
         """
@@ -190,6 +196,7 @@ def gain(self):
         """
         return self._gain_current
 
+
     @gain.setter
     def gain(self, value):
         """
@@ -200,10 +207,11 @@ def gain(self, value):
         if self._debug:
             print("\tSetting gain: {}".format(value))
         self._gain_current = value
-        self._transceive(bytes([0x60,
+        self._transceive(bytes([_CMD_WR,
                                 0x00,
                                 self._gain_current << _GAIN_SHIFT | _HALLCONF,
-                                0x00]))
+                                (_CMD_REG_CONF1 & 0x3F) << 2]))
+
 
     def display_status(self):
         """
@@ -222,6 +230,30 @@ def display_status(self):
         print("Reset status             :", (self._status_last & (1 << 2)) > 0)
         print("Response bytes available :", avail)
 
+
+    def read_reg(self, reg):
+        """
+        Gets the current value of the specified register.
+        """
+        # Write 'value' to the specified register
+        payload = bytes([_CMD_RR, reg << 2])
+        with self.i2c_device as i2c:
+            i2c.write(payload)
+
+        # Read the response (+1 to account for the mandatory status byte!)
+        data = bytearray(3)
+        with self.i2c_device as i2c:
+            i2c.readinto(data)
+        # Unpack data (status byte, big-endian 16-bit register value)
+        self._status_last, val = struct.unpack(">Bh", data)
+        if self._debug:
+            print("\t[{}]".format(time.monotonic()))
+            print("\t Writing :", [hex(b) for b in payload])
+            print("\tResponse :", [hex(b) for b in data])
+            print("\t  Status :", hex(data[0]))
+        return val
+
+
     def reset(self):
         """
         Performs a software reset of the sensor.
@@ -232,25 +264,25 @@ def reset(self):
         _status_last = self._transceive(bytes([_CMD_RT]))
         return _status_last
 
-    def read_data(self, delay=0.0, raw=False):
+
+    def read_data(self, raw=False):
         """
         Reads a single X/Y/Z sample from the magnetometer.
         """
         # Set the device to single measurement mode
         self._transceive(bytes([_CMD_SM | _CMD_AXIS_ALL]))
-        # Wait a bit
-        time.sleep(delay)
-        # Read 6 bytes back from 0x4E
+
+        # Read the 'XYZ' data as three signed 16-bit integers
         data = self._transceive(bytes([_CMD_RM | _CMD_AXIS_ALL]), 6)
-        # Parse the data (status byte, 3 * signed 16-bit integers)
         self._status_last, m_x, m_y, m_z = struct.unpack(">Bhhh", data)
 
         if raw:
             # Return the raw int values if requested
             return m_x, m_y, m_z
 
-        # Convert the units to uT based on gain and resolution
+        # Convert the raw integer values to uT based on gain and resolution
         m_x *= _LSB_LOOKUP[self._gain_current][self._res_current][0]
         m_y *= _LSB_LOOKUP[self._gain_current][self._res_current][0]
         m_z *= _LSB_LOOKUP[self._gain_current][self._res_current][1]
+
         return m_x, m_y, m_z

From e810fd939a2b4b248dd73ef5d4d0328def24f4e4 Mon Sep 17 00:00:00 2001
From: Kevin Townsend <contact@microbuilder.eu>
Date: Thu, 17 Jan 2019 22:40:53 +0100
Subject: [PATCH 003/107] Fixed example to match API changes

---
 README.rst                               | 3 ++-
 examples/adafruit_mlx90393_simpletest.py | 3 ++-
 2 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/README.rst b/README.rst
index aaaa520..27b6bd6 100644
--- a/README.rst
+++ b/README.rst
@@ -66,7 +66,7 @@ Usage Example
     SENSOR = adafruit_mlx90393.MLX90393(I2C_BUS, gain=adafruit_mlx90393.GAIN_1X)
 
     while True:
-        MX, MY, MZ = SENSOR.read_data(delay=1.0, raw=False)
+        MX, MY, MZ = SENSOR.read_data(raw=False)
         print("[{}]".format(time.monotonic()))
         print("X: {} uT".format(MX))
         print("Y: {} uT".format(MY))
@@ -74,6 +74,7 @@ Usage Example
         # Display the status field if an error occured, etc.
         if SENSOR.last_status > adafruit_mlx90393.STATUS_OK:
             SENSOR.display_status()
+        time.sleep(1.0)
 
 Contributing
 ============
diff --git a/examples/adafruit_mlx90393_simpletest.py b/examples/adafruit_mlx90393_simpletest.py
index 6bdadaa..e4262bd 100755
--- a/examples/adafruit_mlx90393_simpletest.py
+++ b/examples/adafruit_mlx90393_simpletest.py
@@ -8,7 +8,7 @@
 SENSOR = adafruit_mlx90393.MLX90393(I2C_BUS, gain=adafruit_mlx90393.GAIN_1X)
 
 while True:
-    MX, MY, MZ = SENSOR.read_data(delay=1.0, raw=False)
+    MX, MY, MZ = SENSOR.read_data(raw=False)
     print("[{}]".format(time.monotonic()))
     print("X: {} uT".format(MX))
     print("Y: {} uT".format(MY))
@@ -16,3 +16,4 @@
     # Display the status field if an error occured, etc.
     if SENSOR.last_status > adafruit_mlx90393.STATUS_OK:
         SENSOR.display_status()
+    time.sleep(1.0)

From 74ad039c38c1733d8cf0731a4af539e07946c4cc Mon Sep 17 00:00:00 2001
From: Kevin Townsend <contact@microbuilder.eu>
Date: Tue, 22 Jan 2019 21:26:56 +0100
Subject: [PATCH 004/107] Separated raw and processed data

---
 README.rst                               |  2 +-
 adafruit_mlx90393.py                     | 21 ++++++++++++++-------
 examples/adafruit_mlx90393_simpletest.py |  2 +-
 3 files changed, 16 insertions(+), 9 deletions(-)

diff --git a/README.rst b/README.rst
index 27b6bd6..e690ade 100644
--- a/README.rst
+++ b/README.rst
@@ -66,7 +66,7 @@ Usage Example
     SENSOR = adafruit_mlx90393.MLX90393(I2C_BUS, gain=adafruit_mlx90393.GAIN_1X)
 
     while True:
-        MX, MY, MZ = SENSOR.read_data(raw=False)
+        MX, MY, MZ = SENSOR.magnetic()
         print("[{}]".format(time.monotonic()))
         print("X: {} uT".format(MX))
         print("Y: {} uT".format(MY))
diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index 2ad3114..313c2ca 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -171,7 +171,7 @@ def _transceive(self, payload, rxlen=0, delay=0.01):
             except OSError:
                 pass
         # Track status byte
-        _status_last = data[0]
+        self._status_last = data[0]
         # Unpack data (status byte, big-endian 16-bit register value)
         if self._debug:
             print("\t[{}]".format(time.monotonic()))
@@ -261,11 +261,11 @@ def reset(self):
         if self._debug:
             print("Resetting sensor")
         time.sleep(2)
-        _status_last = self._transceive(bytes([_CMD_RT]))
-        return _status_last
+        self._status_last = self._transceive(bytes([_CMD_RT]))
+        return self._status_last
 
 
-    def read_data(self, raw=False):
+    def read_data(self):
         """
         Reads a single X/Y/Z sample from the magnetometer.
         """
@@ -276,9 +276,16 @@ def read_data(self, raw=False):
         data = self._transceive(bytes([_CMD_RM | _CMD_AXIS_ALL]), 6)
         self._status_last, m_x, m_y, m_z = struct.unpack(">Bhhh", data)
 
-        if raw:
-            # Return the raw int values if requested
-            return m_x, m_y, m_z
+        # Return the raw int values if requested
+        return m_x, m_y, m_z
+
+
+    def magnetic(self):
+        """
+        The processed magnetometer sensor values.
+        A 3-tuple of X, Y, Z axis values in microteslas that are signed floats.
+        """
+        m_x, m_y, m_z = self.read_data()
 
         # Convert the raw integer values to uT based on gain and resolution
         m_x *= _LSB_LOOKUP[self._gain_current][self._res_current][0]
diff --git a/examples/adafruit_mlx90393_simpletest.py b/examples/adafruit_mlx90393_simpletest.py
index e4262bd..cadb87b 100755
--- a/examples/adafruit_mlx90393_simpletest.py
+++ b/examples/adafruit_mlx90393_simpletest.py
@@ -8,7 +8,7 @@
 SENSOR = adafruit_mlx90393.MLX90393(I2C_BUS, gain=adafruit_mlx90393.GAIN_1X)
 
 while True:
-    MX, MY, MZ = SENSOR.read_data(raw=False)
+    MX, MY, MZ = SENSOR.magnetic()
     print("[{}]".format(time.monotonic()))
     print("X: {} uT".format(MX))
     print("Y: {} uT".format(MY))

From 6a16eba5a45c42ab70a41fea0b6d3754f4c8a7ea Mon Sep 17 00:00:00 2001
From: Kevin Townsend <contact@microbuilder.eu>
Date: Wed, 23 Jan 2019 21:57:40 +0100
Subject: [PATCH 005/107] Updated class to use `.magnetic` property

---
 README.rst                               |  2 +-
 adafruit_mlx90393.py                     | 14 ++++++++------
 examples/adafruit_mlx90393_simpletest.py |  2 +-
 3 files changed, 10 insertions(+), 8 deletions(-)

diff --git a/README.rst b/README.rst
index e690ade..c55508c 100644
--- a/README.rst
+++ b/README.rst
@@ -66,7 +66,7 @@ Usage Example
     SENSOR = adafruit_mlx90393.MLX90393(I2C_BUS, gain=adafruit_mlx90393.GAIN_1X)
 
     while True:
-        MX, MY, MZ = SENSOR.magnetic()
+        MX, MY, MZ = SENSOR.magnetic
         print("[{}]".format(time.monotonic()))
         print("X: {} uT".format(MX))
         print("Y: {} uT".format(MY))
diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index 313c2ca..c33defa 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -265,6 +265,7 @@ def reset(self):
         return self._status_last
 
 
+    @property
     def read_data(self):
         """
         Reads a single X/Y/Z sample from the magnetometer.
@@ -277,19 +278,20 @@ def read_data(self):
         self._status_last, m_x, m_y, m_z = struct.unpack(">Bhhh", data)
 
         # Return the raw int values if requested
-        return m_x, m_y, m_z
+        return (m_x, m_y, m_z)
 
 
+    @property
     def magnetic(self):
         """
         The processed magnetometer sensor values.
         A 3-tuple of X, Y, Z axis values in microteslas that are signed floats.
         """
-        m_x, m_y, m_z = self.read_data()
+        x, y, z = self.read_data
 
         # Convert the raw integer values to uT based on gain and resolution
-        m_x *= _LSB_LOOKUP[self._gain_current][self._res_current][0]
-        m_y *= _LSB_LOOKUP[self._gain_current][self._res_current][0]
-        m_z *= _LSB_LOOKUP[self._gain_current][self._res_current][1]
+        x *= _LSB_LOOKUP[self._gain_current][self._res_current][0]
+        y *= _LSB_LOOKUP[self._gain_current][self._res_current][0]
+        z *= _LSB_LOOKUP[self._gain_current][self._res_current][1]
 
-        return m_x, m_y, m_z
+        return x, y, z
diff --git a/examples/adafruit_mlx90393_simpletest.py b/examples/adafruit_mlx90393_simpletest.py
index cadb87b..1574250 100755
--- a/examples/adafruit_mlx90393_simpletest.py
+++ b/examples/adafruit_mlx90393_simpletest.py
@@ -8,7 +8,7 @@
 SENSOR = adafruit_mlx90393.MLX90393(I2C_BUS, gain=adafruit_mlx90393.GAIN_1X)
 
 while True:
-    MX, MY, MZ = SENSOR.magnetic()
+    MX, MY, MZ = SENSOR.magnetic
     print("[{}]".format(time.monotonic()))
     print("X: {} uT".format(MX))
     print("Y: {} uT".format(MY))

From 466ef98a06e277a01d5fe3ce672cc50dbc9edd48 Mon Sep 17 00:00:00 2001
From: dherrada <dylan.herrada@gmail.com>
Date: Thu, 9 May 2019 21:19:12 -0400
Subject: [PATCH 006/107] Revised filename for consistency across modules

---
 .../{adafruit_mlx90393_simpletest.py => mlx90393_simpletest.py}   | 0
 1 file changed, 0 insertions(+), 0 deletions(-)
 rename examples/{adafruit_mlx90393_simpletest.py => mlx90393_simpletest.py} (100%)

diff --git a/examples/adafruit_mlx90393_simpletest.py b/examples/mlx90393_simpletest.py
similarity index 100%
rename from examples/adafruit_mlx90393_simpletest.py
rename to examples/mlx90393_simpletest.py

From f2f1c2031c9d86cdfbaa91a6c4491c4eb50960ce Mon Sep 17 00:00:00 2001
From: dherrada <dylan.herrada@gmail.com>
Date: Thu, 9 May 2019 21:19:46 -0400
Subject: [PATCH 007/107] Updated docs to reflect this change

---
 docs/examples.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/examples.rst b/docs/examples.rst
index 4916403..a9c23ee 100644
--- a/docs/examples.rst
+++ b/docs/examples.rst
@@ -3,6 +3,6 @@ Simple test
 
 Ensure your device works with this simple test.
 
-.. literalinclude:: ../examples/adafruit_mlx90393_simpletest.py
-    :caption: examples/adafruit_mlx90393_simpletest.py
+.. literalinclude:: ../examples/mlx90393_simpletest.py
+    :caption: examples/mlx90393_simpletest.py
     :linenos:

From 163e4ac85c0cd164f9f6a48f60352fad4f1b3a5e Mon Sep 17 00:00:00 2001
From: Carter Nelson <caternuson@gmail.com>
Date: Tue, 18 Jun 2019 03:08:14 +0100
Subject: [PATCH 008/107] update transceive for repeated start

---
 adafruit_mlx90393.py | 50 +++++++++++++++++++++++++++-----------------
 1 file changed, 31 insertions(+), 19 deletions(-)

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index c33defa..a400ba8 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -144,32 +144,36 @@ def __init__(self, i2c_bus, address=0x0C, gain=GAIN_1X, debug=False):
         self.gain = self._gain_current
 
 
-    def _transceive(self, payload, rxlen=0, delay=0.01):
+    def _transceive(self, payload, rxlen=0):
         """
         Writes the specified 'payload' to the sensor
         Returns the results of the write attempt.
         :param bytearray payload: The byte array to write to the sensor
         :param rxlen: (optional) The numbers of bytes to read back (default=0)
         """
-        # Write 'value' to the specified register
-        with self.i2c_device as i2c:
-            i2c.write(payload)
-
-        # Insert a delay since we aren't using INTs for DRDY
-        time.sleep(delay)
-
         # Read the response (+1 to account for the mandatory status byte!)
         data = bytearray(rxlen+1)
-        while True:
-            # While busy, the sensor doesn't respond to reads.
-            try:
-                with self.i2c_device as i2c:
-                    i2c.readinto(data)
-                    # Make sure we have something in the response
-                    if data[0]:
-                        break
-            except OSError:
-                pass
+
+        if len(payload) == 1:
+            # Transceive with repeated start
+            with self.i2c_device as i2c:
+                i2c.write_then_readinto(payload, data, stop=False)
+        else:
+            # Write 'value' to the specified register
+            with self.i2c_device as i2c:
+                i2c.write(payload, stop=False)
+
+            while True:
+                # While busy, the sensor doesn't respond to reads.
+                try:
+                    with self.i2c_device as i2c:
+                        i2c.readinto(data)
+                        # Make sure we have something in the response
+                        if data[0]:
+                            break
+                except OSError:
+                    pass
+
         # Track status byte
         self._status_last = data[0]
         # Unpack data (status byte, big-endian 16-bit register value)
@@ -262,17 +266,25 @@ def reset(self):
             print("Resetting sensor")
         time.sleep(2)
         self._status_last = self._transceive(bytes([_CMD_RT]))
+        # burn a read post reset
+        try:
+            self.magnetic
+        except OSError:
+            pass
         return self._status_last
 
 
     @property
-    def read_data(self):
+    def read_data(self, delay=0.01):
         """
         Reads a single X/Y/Z sample from the magnetometer.
         """
         # Set the device to single measurement mode
         self._transceive(bytes([_CMD_SM | _CMD_AXIS_ALL]))
 
+        # Insert a delay since we aren't using INTs for DRDY
+        time.sleep(delay)
+
         # Read the 'XYZ' data as three signed 16-bit integers
         data = self._transceive(bytes([_CMD_RM | _CMD_AXIS_ALL]), 6)
         self._status_last, m_x, m_y, m_z = struct.unpack(">Bhhh", data)

From d0986b2d95146181b3e365d3a777ad1ab6141970 Mon Sep 17 00:00:00 2001
From: Scott Shawcroft <scott@tannewt.org>
Date: Wed, 21 Aug 2019 15:42:27 -0700
Subject: [PATCH 009/107] Remove stop kwarg and use write_then_readinto.

See https://github.com/adafruit/circuitpython/issues/2082 for details.
---
 adafruit_mlx90393.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index a400ba8..a4bc265 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -157,9 +157,10 @@ def _transceive(self, payload, rxlen=0):
         if len(payload) == 1:
             # Transceive with repeated start
             with self.i2c_device as i2c:
-                i2c.write_then_readinto(payload, data, stop=False)
+                i2c.write_then_readinto(payload, data)
         else:
             # Write 'value' to the specified register
+            # TODO: Check this. It's weird that the write is accepted but the read is naked.
             with self.i2c_device as i2c:
                 i2c.write(payload, stop=False)
 

From e1a3d84b9f6daee5aec574a4ff457b60e4311d9c Mon Sep 17 00:00:00 2001
From: dherrada <33632497+dherrada@users.noreply.github.com>
Date: Thu, 17 Oct 2019 19:14:59 -0400
Subject: [PATCH 010/107] Removed building locally section from README,
 replaced with documentation section

---
 README.rst | 51 +++------------------------------------------------
 1 file changed, 3 insertions(+), 48 deletions(-)

diff --git a/README.rst b/README.rst
index c55508c..6d8414d 100644
--- a/README.rst
+++ b/README.rst
@@ -83,52 +83,7 @@ Contributions are welcome! Please read our `Code of Conduct
 <https://github.com/adafruit/Adafruit_CircuitPython_MLX90393/blob/master/CODE_OF_CONDUCT.md>`_
 before contributing to help this project stay welcoming.
 
-Building locally
-================
-
-Zip release files
------------------
-
-To build this library locally you'll need to install the
-`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
-
-.. code-block:: shell
-
-    python3 -m venv .env
-    source .env/bin/activate
-    pip install circuitpython-build-tools
-
-Once installed, make sure you are in the virtual environment:
-
-.. code-block:: shell
-
-    source .env/bin/activate
-
-Then run the build:
-
-.. code-block:: shell
-
-    circuitpython-build-bundles --filename_prefix adafruit_circuitpython_mlx90393 --library_location .
-
-Sphinx documentation
------------------------
-
-Sphinx is used to build the documentation based on rST files and comments in the code. First,
-install dependencies (feel free to reuse the virtual environment from above):
-
-.. code-block:: shell
-
-    python3 -m venv .env
-    source .env/bin/activate
-    pip install Sphinx sphinx-rtd-theme
-
-Now, once you have the virtual environment activated:
-
-.. code-block:: shell
-
-    cd docs
-    sphinx-build -E -W -b html . _build/html
+Documentation
+=============
 
-This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
-view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
-locally verify it will pass.
+For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.

From e3e2db588d2eadc89db3493a8817497c6c6d808e Mon Sep 17 00:00:00 2001
From: dherrada <dylan.herrada@gmail.com>
Date: Wed, 1 Jan 2020 14:30:59 -0500
Subject: [PATCH 011/107] Moved repository from Travis to GitHub Actions

---
 .github/workflows/build.yml   | 50 +++++++++++++++++++++
 .github/workflows/release.yml | 81 +++++++++++++++++++++++++++++++++++
 .gitignore                    |  1 -
 .travis.yml                   | 33 --------------
 README.rst                    |  4 +-
 5 files changed, 133 insertions(+), 36 deletions(-)
 create mode 100644 .github/workflows/build.yml
 create mode 100644 .github/workflows/release.yml
 delete mode 100644 .travis.yml

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
new file mode 100644
index 0000000..66ce4db
--- /dev/null
+++ b/.github/workflows/build.yml
@@ -0,0 +1,50 @@
+name: Build CI
+
+on: [pull_request, push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Dump GitHub context
+      env:
+        GITHUB_CONTEXT: ${{ toJson(github) }}
+      run: echo "$GITHUB_CONTEXT"
+    - name: Translate Repo Name For Build Tools filename_prefix
+      id: repo-name
+      run: |
+        echo ::set-output name=repo-name::$(
+        echo ${{ github.repository }} |
+        awk -F '\/' '{ print tolower($2) }' |
+        tr '_' '-'
+        )
+    - name: Set up Python 3.6
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.6
+    - name: Versions
+      run: |
+        python3 --version
+    - name: Checkout Current Repo
+      uses: actions/checkout@v1
+      with:
+        submodules: true
+    - name: Checkout tools repo
+      uses: actions/checkout@v2
+      with:
+        repository: adafruit/actions-ci-circuitpython-libs
+        path: actions-ci
+    - name: Install deps
+      run: |
+        source actions-ci/install.sh
+    - name: Library version
+      run: git describe --dirty --always --tags
+    - name: PyLint
+      run: |
+        pylint $( find . -path './adafruit*.py' )
+        ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py)
+    - name: Build assets
+      run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location .
+    - name: Build docs
+      working-directory: docs
+      run: sphinx-build -E -W -b html . _build/html
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
new file mode 100644
index 0000000..18efb9c
--- /dev/null
+++ b/.github/workflows/release.yml
@@ -0,0 +1,81 @@
+name: Release Actions
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  upload-release-assets:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Dump GitHub context
+      env:
+        GITHUB_CONTEXT: ${{ toJson(github) }}
+      run: echo "$GITHUB_CONTEXT"
+    - name: Translate Repo Name For Build Tools filename_prefix
+      id: repo-name
+      run: |
+        echo ::set-output name=repo-name::$(
+        echo ${{ github.repository }} |
+        awk -F '\/' '{ print tolower($2) }' |
+        tr '_' '-'
+        )
+    - name: Set up Python 3.6
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.6
+    - name: Versions
+      run: |
+        python3 --version
+    - name: Checkout Current Repo
+      uses: actions/checkout@v1
+      with:
+        submodules: true
+    - name: Checkout tools repo
+      uses: actions/checkout@v2
+      with:
+        repository: adafruit/actions-ci-circuitpython-libs
+        path: actions-ci
+    - name: Install deps
+      run: |
+        source actions-ci/install.sh
+    - name: Build assets
+      run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location .
+    - name: Upload Release Assets
+      # the 'official' actions version does not yet support dynamically
+      # supplying asset names to upload. @csexton's version chosen based on
+      # discussion in the issue below, as its the simplest to implement and
+      # allows for selecting files with a pattern.
+      # https://github.com/actions/upload-release-asset/issues/4
+      #uses: actions/upload-release-asset@v1.0.1
+      uses: csexton/release-asset-action@master
+      with:
+        pattern: "bundles/*"
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+
+  upload-pypi:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: Check For setup.py
+      id: need-pypi
+      run: |
+        echo ::set-output name=setup-py::$( find . -wholename './setup.py' )
+    - name: Set up Python
+      if: contains(steps.need-pypi.outputs.setup-py, 'setup.py')
+      uses: actions/setup-python@v1
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      if: contains(steps.need-pypi.outputs.setup-py, 'setup.py')
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build and publish
+      if: contains(steps.need-pypi.outputs.setup-py, 'setup.py')
+      env:
+        TWINE_USERNAME: ${{ secrets.pypi_username }}
+        TWINE_PASSWORD: ${{ secrets.pypi_password }}
+      run: |
+        python setup.py sdist
+        twine upload dist/*
diff --git a/.gitignore b/.gitignore
index 55f127b..c83f8b7 100644
--- a/.gitignore
+++ b/.gitignore
@@ -4,7 +4,6 @@ __pycache__
 _build
 *.pyc
 .env
-build*
 bundles
 *.DS_Store
 .eggs
diff --git a/.travis.yml b/.travis.yml
deleted file mode 100644
index 3a49d3d..0000000
--- a/.travis.yml
+++ /dev/null
@@ -1,33 +0,0 @@
-dist: trusty
-sudo: false
-language: python
-python:
-- '3.6'
-cache:
-  pip: true
-deploy:
-- provider: releases
-  api_key: "$GITHUB_TOKEN"
-  file_glob: true
-  file: "$TRAVIS_BUILD_DIR/bundles/*"
-  skip_cleanup: true
-  overwrite: true
-  on:
-    tags: true
-- provider: pypi
-  user: adafruit-travis
-  on:
-    tags: true
-  password:
-    secure: m2YkBNLO2NFz4ZKpQNW/+m5Wc1/W2aP24BOu9TpoJlE0pUPtag0GUFzOb2roHDbUzLl7y0anHaVVcsVztZyS0b64KiNzZ2iWdN39S5X0nsq0aQAKcKI6TTNl//IPIn23LgrzjQF05k8YKKuY3QnSz9oo3inswVOEeQbZwkPtaVHiJgL9uCqdivy82xyjrnoxgfy1V587tvQwpiJ0Tc10seyyuBjzw33Zb5hgJGsWeS8fuqTl/8nnUGDXCnNPPyyHkxYLjDrbH9x87Hp+eR8URctwrjIn39o4uuF3pgmnmEA1u5fpKyCGuVAsLSlSvmYPzkf0fLD3YDpws4KEm2dr9bBX+x0SlZMpRKr+snW+nzMtK0ltZKOBBS9g1suohOo5qjexNl70ykLU7OchKWCmAWclRlP3GWnpX2gcKGk+fzvv5OqKFI8+6UMcOHLOLzsPkl/9hMisci+VijBIUs7rZckAy2terRayqqwOEq15j3YLCTzlLP1vIfPc8S6ukH1A6+rEoNvGMqmCIAQntbQSwzjgL+4xAlfc5SDBQG9+dKANHCH4zJlKnXfbLxn3SMchtPr8jz6JE/UtOTc7+/9as8bOxfre3ElCPzDZv6M3k5CQHr+hANAepQR8Om86aRry7a7vYym/ESoJdqBURpmq6/+/I2bxnj/1MqlGRahPx1U=
-install:
-- pip install -r requirements.txt
-- pip install circuitpython-build-tools Sphinx sphinx-rtd-theme
-- pip install --force-reinstall pylint==1.9.2
-script:
-- pylint adafruit_mlx90393.py
-- ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace
-  examples/*.py)
-- circuitpython-build-bundles --filename_prefix adafruit_circuitpython_mlx90393 --library_location
-  .
-- cd docs && sphinx-build -E -W -b html . _build/html && cd ..
diff --git a/README.rst b/README.rst
index 6d8414d..043dd7b 100644
--- a/README.rst
+++ b/README.rst
@@ -9,8 +9,8 @@ Introduction
     :target: https://discord.gg/nBQh6qu
     :alt: Discord
 
-.. image:: https://travis-ci.com/adafruit/Adafruit_CircuitPython_MLX90393.svg?branch=master
-    :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_MLX90393
+.. image:: https://github.com/adafruit/Adafruit_CircuitPython_MLX90393/workflows/Build%20CI/badge.svg
+    :target: https://github.com/adafruit/Adafruit_CircuitPython_MLX90393/actions/
     :alt: Build Status
 
 Adafruit CircuitPython driver for the MLX90393 3-axis magnetometer.

From ce8b6c2ebd19961537f7d1c9358fe9eab51b4338 Mon Sep 17 00:00:00 2001
From: sommersoft <sommersoft@gmail.com>
Date: Wed, 8 Jan 2020 21:09:22 -0600
Subject: [PATCH 012/107] update pylint examples directive

Signed-off-by: sommersoft <sommersoft@gmail.com>
---
 .github/workflows/build.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 66ce4db..11ce574 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -42,7 +42,7 @@ jobs:
     - name: PyLint
       run: |
         pylint $( find . -path './adafruit*.py' )
-        ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py)
+        ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace $( find . -path "./examples/*.py" ))
     - name: Build assets
       run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location .
     - name: Build docs

From bc92b5ff95e06cb2183b8261ad0dbe3a45a9e364 Mon Sep 17 00:00:00 2001
From: sommersoft <sommersoft@gmail.com>
Date: Tue, 3 Mar 2020 00:28:48 -0600
Subject: [PATCH 013/107] build.yml: move pylint, black, and Sphinx installs to
 each repo; add description to 'actions-ci/install.sh'

Signed-off-by: sommersoft <sommersoft@gmail.com>
---
 .github/workflows/build.yml | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 11ce574..fff3aa9 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -34,9 +34,13 @@ jobs:
       with:
         repository: adafruit/actions-ci-circuitpython-libs
         path: actions-ci
-    - name: Install deps
+    - name: Install dependencies
+      # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.)
       run: |
         source actions-ci/install.sh
+    - name: Pip install pylint, black, & Sphinx
+      run: |
+        pip install --force-reinstall pylint==1.9.2 black==19.10b0 Sphinx sphinx-rtd-theme
     - name: Library version
       run: git describe --dirty --always --tags
     - name: PyLint

From 2a3e7368252dfdbefa658a7f882161eac79daf55 Mon Sep 17 00:00:00 2001
From: sommersoft <sommersoft@gmail.com>
Date: Thu, 5 Mar 2020 22:06:59 -0600
Subject: [PATCH 014/107] update pylintrc for black

Signed-off-by: sommersoft <sommersoft@gmail.com>
---
 .pylintrc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.pylintrc b/.pylintrc
index 039eaec..d8f0ee8 100644
--- a/.pylintrc
+++ b/.pylintrc
@@ -52,7 +52,7 @@ confidence=
 # no Warning level messages displayed, use"--disable=all --enable=classes
 # --disable=W"
 # disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call
-disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error
+disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option

From 9428db2359a97b0b500bf432e624b4c83ac23e84 Mon Sep 17 00:00:00 2001
From: sommersoft <sommersoft@gmail.com>
Date: Fri, 13 Mar 2020 13:28:00 -0500
Subject: [PATCH 015/107] update code of conduct

---
 CODE_OF_CONDUCT.md | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
index 8ee6e44..d79c514 100644
--- a/CODE_OF_CONDUCT.md
+++ b/CODE_OF_CONDUCT.md
@@ -34,6 +34,8 @@ Examples of unacceptable behavior by participants include:
 * Excessive or unwelcome helping; answering outside the scope of the question
   asked
 * Trolling, insulting/derogatory comments, and personal or political attacks
+* Promoting or spreading disinformation, lies, or conspiracy theories against
+  a person, group, organisation, project, or community
 * Public or private harassment
 * Publishing others' private information, such as a physical or electronic
   address, without explicit permission
@@ -74,8 +76,8 @@ In any situation, you may send an email to <support@adafruit.com>.
 On the Adafruit Discord, you may send an open message from any channel
 to all Community Helpers by tagging @community helpers. You may also send an
 open message from any channel, or a direct message to @kattni#1507,
-@tannewt#4653, @Dan Halbert#1614, @cater#2442, @sommersoft#0222, or
-@Andon#8175.
+@tannewt#4653, @Dan Halbert#1614, @cater#2442, @sommersoft#0222,
+@Mr. Certainly#0472 or @Andon#8175.
 
 Email and direct message reports will be kept confidential.
 

From fd96579ae0f28561cd77aca822f1635217251335 Mon Sep 17 00:00:00 2001
From: dherrada <dylan.herrada@gmail.com>
Date: Sun, 15 Mar 2020 16:52:14 -0400
Subject: [PATCH 016/107] Ran black, updated to pylint 2.x

---
 .github/workflows/build.yml |   2 +-
 adafruit_mlx90393.py        |  60 +++++++++---------
 docs/conf.py                | 120 ++++++++++++++++++++++--------------
 setup.py                    |  50 +++++++--------
 4 files changed, 125 insertions(+), 107 deletions(-)

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index fff3aa9..1dad804 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -40,7 +40,7 @@ jobs:
         source actions-ci/install.sh
     - name: Pip install pylint, black, & Sphinx
       run: |
-        pip install --force-reinstall pylint==1.9.2 black==19.10b0 Sphinx sphinx-rtd-theme
+        pip install --force-reinstall pylint black==19.10b0 Sphinx sphinx-rtd-theme
     - name: Library version
       run: git describe --dirty --always --tags
     - name: PyLint
diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index a4bc265..c6e1b8d 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -46,6 +46,7 @@
 """
 
 import time
+
 try:
     import struct
 except ImportError:
@@ -57,19 +58,19 @@
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_MLX90393.git"
 
-_CMD_SB = const(0b00010000)   # Start burst mode
-_CMD_SW = const(0b00100000)   # Start wakeup on change mode
-_CMD_SM = const(0b00110000)   # Start single-measurement mode
-_CMD_RM = const(0b01000000)   # Read measurement
-_CMD_RR = const(0b01010000)   # Read register
-_CMD_WR = const(0b01100000)   # Write register
-_CMD_EX = const(0b10000000)   # Exit mode
-_CMD_HR = const(0b11010000)   # Memory recall
-_CMD_HS = const(0b11100000)   # Memory store
-_CMD_RT = const(0b11110000)   # Reset
-_CMD_NOP = const(0x00)        # NOP
+_CMD_SB = const(0b00010000)  # Start burst mode
+_CMD_SW = const(0b00100000)  # Start wakeup on change mode
+_CMD_SM = const(0b00110000)  # Start single-measurement mode
+_CMD_RM = const(0b01000000)  # Read measurement
+_CMD_RR = const(0b01010000)  # Read register
+_CMD_WR = const(0b01100000)  # Write register
+_CMD_EX = const(0b10000000)  # Exit mode
+_CMD_HR = const(0b11010000)  # Memory recall
+_CMD_HS = const(0b11100000)  # Memory store
+_CMD_RT = const(0b11110000)  # Reset
+_CMD_NOP = const(0x00)  # NOP
 
-_CMD_AXIS_ALL = const(0xE)    # X+Y+Z axis bits for commands
+_CMD_AXIS_ALL = const(0xE)  # X+Y+Z axis bits for commands
 
 _CMD_REG_CONF1 = const(0x00)  # Gain
 _CMD_REG_CONF2 = const(0x01)  # Burst, comm mode
@@ -86,13 +87,13 @@
 GAIN_1X = 0x7
 _GAIN_SHIFT = const(4)
 
-_RES_2_15 = const(0)   # +/- 2^15
+_RES_2_15 = const(0)  # +/- 2^15
 _RES_2_15B = const(1)  # +/- 2^15
 _RES_22000 = const(2)  # +/- 22000
 _RES_11000 = const(3)  # +/- 11000
 _RES_SHIFT = const(5)
 
-_HALLCONF = const(0x0C)     # Hall plate spinning rate adjust.
+_HALLCONF = const(0x0C)  # Hall plate spinning rate adjust.
 
 STATUS_OK = 0x3
 
@@ -116,7 +117,7 @@
     # 1.333x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
     ((0.200, 0.323), (0.401, 0.645), (0.801, 1.291), (1.602, 2.581)),
     # 1x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-    ((0.150, 0.242), (0.300, 0.484), (0.601, 0.968), (1.202, 1.936))
+    ((0.150, 0.242), (0.300, 0.484), (0.601, 0.968), (1.202, 1.936)),
 )
 
 
@@ -143,7 +144,6 @@ def __init__(self, i2c_bus, address=0x0C, gain=GAIN_1X, debug=False):
         # Set gain to the supplied level
         self.gain = self._gain_current
 
-
     def _transceive(self, payload, rxlen=0):
         """
         Writes the specified 'payload' to the sensor
@@ -152,7 +152,7 @@ def _transceive(self, payload, rxlen=0):
         :param rxlen: (optional) The numbers of bytes to read back (default=0)
         """
         # Read the response (+1 to account for the mandatory status byte!)
-        data = bytearray(rxlen+1)
+        data = bytearray(rxlen + 1)
 
         if len(payload) == 1:
             # Transceive with repeated start
@@ -185,7 +185,6 @@ def _transceive(self, payload, rxlen=0):
             print("\t  Status :", hex(data[0]))
         return data
 
-
     @property
     def last_status(self):
         """
@@ -193,7 +192,6 @@ def last_status(self):
         """
         return self._status_last
 
-
     @property
     def gain(self):
         """
@@ -201,7 +199,6 @@ def gain(self):
         """
         return self._gain_current
 
-
     @gain.setter
     def gain(self, value):
         """
@@ -212,11 +209,16 @@ def gain(self, value):
         if self._debug:
             print("\tSetting gain: {}".format(value))
         self._gain_current = value
-        self._transceive(bytes([_CMD_WR,
-                                0x00,
-                                self._gain_current << _GAIN_SHIFT | _HALLCONF,
-                                (_CMD_REG_CONF1 & 0x3F) << 2]))
-
+        self._transceive(
+            bytes(
+                [
+                    _CMD_WR,
+                    0x00,
+                    self._gain_current << _GAIN_SHIFT | _HALLCONF,
+                    (_CMD_REG_CONF1 & 0x3F) << 2,
+                ]
+            )
+        )
 
     def display_status(self):
         """
@@ -235,7 +237,6 @@ def display_status(self):
         print("Reset status             :", (self._status_last & (1 << 2)) > 0)
         print("Response bytes available :", avail)
 
-
     def read_reg(self, reg):
         """
         Gets the current value of the specified register.
@@ -258,7 +259,6 @@ def read_reg(self, reg):
             print("\t  Status :", hex(data[0]))
         return val
 
-
     def reset(self):
         """
         Performs a software reset of the sensor.
@@ -274,12 +274,13 @@ def reset(self):
             pass
         return self._status_last
 
-
     @property
-    def read_data(self, delay=0.01):
+    def read_data(self):
         """
         Reads a single X/Y/Z sample from the magnetometer.
         """
+        delay = 0.01
+
         # Set the device to single measurement mode
         self._transceive(bytes([_CMD_SM | _CMD_AXIS_ALL]))
 
@@ -293,7 +294,6 @@ def read_data(self, delay=0.01):
         # Return the raw int values if requested
         return (m_x, m_y, m_z)
 
-
     @property
     def magnetic(self):
         """
diff --git a/docs/conf.py b/docs/conf.py
index 4901bf1..2130937 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -2,7 +2,8 @@
 
 import os
 import sys
-sys.path.insert(0, os.path.abspath('..'))
+
+sys.path.insert(0, os.path.abspath(".."))
 
 # -- General configuration ------------------------------------------------
 
@@ -10,10 +11,10 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.napoleon',
-    'sphinx.ext.todo',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.todo",
 ]
 
 # TODO: Please Read!
@@ -23,29 +24,40 @@
 # autodoc_mock_imports = ["digitalio", "busio"]
 
 
-intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/busdevice/en/latest/', None),'Register': ('https://circuitpython.readthedocs.io/projects/register/en/latest/', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3.4", None),
+    "BusDevice": (
+        "https://circuitpython.readthedocs.io/projects/busdevice/en/latest/",
+        None,
+    ),
+    "Register": (
+        "https://circuitpython.readthedocs.io/projects/register/en/latest/",
+        None,
+    ),
+    "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None),
+}
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = u'Adafruit_CircuitPython_MLX90393 Library'
-copyright = u'2018 Kevin Townsend'
-author = u'Kevin Townsend'
+project = u"Adafruit_CircuitPython_MLX90393 Library"
+copyright = u"2018 Kevin Townsend"
+author = u"Kevin Townsend"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = u'1.0'
+version = u"1.0"
 # The full version, including alpha/beta/rc tags.
-release = u'1.0'
+release = u"1.0"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -57,7 +69,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.env', 'CODE_OF_CONDUCT.md']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".env", "CODE_OF_CONDUCT.md"]
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
@@ -69,7 +81,7 @@
 add_function_parentheses = True
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
@@ -84,59 +96,62 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+on_rtd = os.environ.get("READTHEDOCS", None) == "True"
 
 if not on_rtd:  # only import and set the theme if we're building docs locally
     try:
         import sphinx_rtd_theme
-        html_theme = 'sphinx_rtd_theme'
-        html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), '.']
+
+        html_theme = "sphinx_rtd_theme"
+        html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
     except:
-        html_theme = 'default'
-        html_theme_path = ['.']
+        html_theme = "default"
+        html_theme_path = ["."]
 else:
-    html_theme_path = ['.']
+    html_theme_path = ["."]
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 # The name of an image file (relative to this directory) to use as a favicon of
 # the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
 #
-html_favicon = '_static/favicon.ico'
+html_favicon = "_static/favicon.ico"
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'Adafruit_circuitpython_mlx90393Librarydoc'
+htmlhelp_basename = "Adafruit_circuitpython_mlx90393Librarydoc"
 
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
-     # The paper size ('letterpaper' or 'a4paper').
-     #
-     # 'papersize': 'letterpaper',
-
-     # The font size ('10pt', '11pt' or '12pt').
-     #
-     # 'pointsize': '10pt',
-
-     # Additional stuff for the LaTeX preamble.
-     #
-     # 'preamble': '',
-
-     # Latex figure (float) alignment
-     #
-     # 'figure_align': 'htbp',
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'Adafruit_CircuitPython_MLX90393Library.tex', u'Adafruit_CircuitPython_MLX90393 Library Documentation',
-     author, 'manual'),
+    (
+        master_doc,
+        "Adafruit_CircuitPython_MLX90393Library.tex",
+        u"Adafruit_CircuitPython_MLX90393 Library Documentation",
+        author,
+        "manual",
+    ),
 ]
 
 # -- Options for manual page output ---------------------------------------
@@ -144,8 +159,13 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'Adafruit_CircuitPython_MLX90393library', u'Adafruit_CircuitPython_MLX90393 Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "Adafruit_CircuitPython_MLX90393library",
+        u"Adafruit_CircuitPython_MLX90393 Library Documentation",
+        [author],
+        1,
+    )
 ]
 
 # -- Options for Texinfo output -------------------------------------------
@@ -154,7 +174,13 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'Adafruit_CircuitPython_MLX90393Library', u' Adafruit_CircuitPython_MLX90393 Library Documentation',
-     author, 'Adafruit_CircuitPython_MLX90393Library', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "Adafruit_CircuitPython_MLX90393Library",
+        u" Adafruit_CircuitPython_MLX90393 Library Documentation",
+        author,
+        "Adafruit_CircuitPython_MLX90393Library",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
diff --git a/setup.py b/setup.py
index 72a0c19..2df77ca 100644
--- a/setup.py
+++ b/setup.py
@@ -7,6 +7,7 @@
 
 # Always prefer setuptools over distutils
 from setuptools import setup, find_packages
+
 # To use a consistent encoding
 from codecs import open
 from os import path
@@ -14,47 +15,38 @@
 here = path.abspath(path.dirname(__file__))
 
 # Get the long description from the README file
-with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
+with open(path.join(here, "README.rst"), encoding="utf-8") as f:
     long_description = f.read()
 
 setup(
-    name='adafruit-circuitpython-mlx90393',
-
+    name="adafruit-circuitpython-mlx90393",
     use_scm_version=True,
-    setup_requires=['setuptools_scm'],
-
-    description='CircuitPython driver for the MLX90393 3-axis magnetometer.',
+    setup_requires=["setuptools_scm"],
+    description="CircuitPython driver for the MLX90393 3-axis magnetometer.",
     long_description=long_description,
-    long_description_content_type='text/x-rst',
-
+    long_description_content_type="text/x-rst",
     # The project's main homepage.
-    url='https://github.com/adafruit/Adafruit_CircuitPython_MLX90393',
-
+    url="https://github.com/adafruit/Adafruit_CircuitPython_MLX90393",
     # Author details
-    author='Adafruit Industries',
-    author_email='circuitpython@adafruit.com',
-
-    install_requires=['Adafruit-Blinka', 'adafruit-circuitpython-busdevice'],
-
+    author="Adafruit Industries",
+    author_email="circuitpython@adafruit.com",
+    install_requires=["Adafruit-Blinka", "adafruit-circuitpython-busdevice"],
     # Choose your license
-    license='MIT',
-
+    license="MIT",
     # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
     classifiers=[
-        'Development Status :: 3 - Alpha',
-        'Intended Audience :: Developers',
-        'Topic :: Software Development :: Libraries',
-        'Topic :: System :: Hardware',
-        'License :: OSI Approved :: MIT License',
-        'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.4',
-        'Programming Language :: Python :: 3.5',
+        "Development Status :: 3 - Alpha",
+        "Intended Audience :: Developers",
+        "Topic :: Software Development :: Libraries",
+        "Topic :: System :: Hardware",
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.4",
+        "Programming Language :: Python :: 3.5",
     ],
-
     # What does your project relate to?
-    keywords='adafruit three-axis magnetometer magnet mlx90393 hardware micropython circuitpython',
-
+    keywords="adafruit three-axis magnetometer magnet mlx90393 hardware micropython circuitpython",
     # You can just specify the packages manually here if your project is
     # simple. Or you can use find_packages().
-    py_modules=['adafruit_mlx90393'],
+    py_modules=["adafruit_mlx90393"],
 )

From d95a20ec8095ee72e05f4ecafb25ac66712e3abd Mon Sep 17 00:00:00 2001
From: sommersoft <sommersoft@gmail.com>
Date: Sun, 15 Mar 2020 11:49:22 -0500
Subject: [PATCH 017/107] update code of coduct: discord moderation contact
 section

Signed-off-by: sommersoft <sommersoft@gmail.com>
---
 CODE_OF_CONDUCT.md | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
index d79c514..134d510 100644
--- a/CODE_OF_CONDUCT.md
+++ b/CODE_OF_CONDUCT.md
@@ -74,10 +74,10 @@ You may report in the following ways:
 In any situation, you may send an email to <support@adafruit.com>.
 
 On the Adafruit Discord, you may send an open message from any channel
-to all Community Helpers by tagging @community helpers. You may also send an
-open message from any channel, or a direct message to @kattni#1507,
-@tannewt#4653, @Dan Halbert#1614, @cater#2442, @sommersoft#0222,
-@Mr. Certainly#0472 or @Andon#8175.
+to all Community Moderators by tagging @community moderators. You may 
+also send an open message from any channel, or a direct message to 
+@kattni#1507, @tannewt#4653, @Dan Halbert#1614, @cater#2442, 
+@sommersoft#0222, @Mr. Certainly#0472 or @Andon#8175.
 
 Email and direct message reports will be kept confidential.
 

From 3aee1a8a2feba7d7333bb62d7eaadc71f4c681e8 Mon Sep 17 00:00:00 2001
From: sommersoft <sommersoft@gmail.com>
Date: Tue, 7 Apr 2020 15:02:31 -0500
Subject: [PATCH 018/107] build.yml: add black formatting check

Signed-off-by: sommersoft <sommersoft@gmail.com>
---
 .github/workflows/build.yml | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 1dad804..b6977a9 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -43,6 +43,9 @@ jobs:
         pip install --force-reinstall pylint black==19.10b0 Sphinx sphinx-rtd-theme
     - name: Library version
       run: git describe --dirty --always --tags
+    - name: Check formatting
+      run: |
+        black --check --target-version=py35 .
     - name: PyLint
       run: |
         pylint $( find . -path './adafruit*.py' )

From 10138366c3fd7df70f8e82ba9689b104c368c544 Mon Sep 17 00:00:00 2001
From: Kattni Rembor <kattni@adafruit.com>
Date: Thu, 9 Apr 2020 12:55:27 -0400
Subject: [PATCH 019/107] Black reformatting with Python 3 target.

---
 docs/conf.py | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/docs/conf.py b/docs/conf.py
index 2130937..b68f2dc 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -46,18 +46,18 @@
 master_doc = "index"
 
 # General information about the project.
-project = u"Adafruit_CircuitPython_MLX90393 Library"
-copyright = u"2018 Kevin Townsend"
-author = u"Kevin Townsend"
+project = "Adafruit_CircuitPython_MLX90393 Library"
+copyright = "2018 Kevin Townsend"
+author = "Kevin Townsend"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = u"1.0"
+version = "1.0"
 # The full version, including alpha/beta/rc tags.
-release = u"1.0"
+release = "1.0"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -148,7 +148,7 @@
     (
         master_doc,
         "Adafruit_CircuitPython_MLX90393Library.tex",
-        u"Adafruit_CircuitPython_MLX90393 Library Documentation",
+        "Adafruit_CircuitPython_MLX90393 Library Documentation",
         author,
         "manual",
     ),
@@ -162,7 +162,7 @@
     (
         master_doc,
         "Adafruit_CircuitPython_MLX90393library",
-        u"Adafruit_CircuitPython_MLX90393 Library Documentation",
+        "Adafruit_CircuitPython_MLX90393 Library Documentation",
         [author],
         1,
     )
@@ -177,7 +177,7 @@
     (
         master_doc,
         "Adafruit_CircuitPython_MLX90393Library",
-        u" Adafruit_CircuitPython_MLX90393 Library Documentation",
+        " Adafruit_CircuitPython_MLX90393 Library Documentation",
         author,
         "Adafruit_CircuitPython_MLX90393Library",
         "One line description of project.",

From e2715f6094d26a3f58867bc22c5a0cf970fd8fe6 Mon Sep 17 00:00:00 2001
From: Dan Halbert <halbert@adafruit.com>
Date: Thu, 9 Apr 2020 22:14:13 -0400
Subject: [PATCH 020/107] Canonicalize names in conf.py

---
 docs/conf.py | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/docs/conf.py b/docs/conf.py
index b68f2dc..c2e8fef 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -46,7 +46,7 @@
 master_doc = "index"
 
 # General information about the project.
-project = "Adafruit_CircuitPython_MLX90393 Library"
+project = "Adafruit MLX90393 Library"
 copyright = "2018 Kevin Townsend"
 author = "Kevin Townsend"
 
@@ -122,7 +122,7 @@
 html_favicon = "_static/favicon.ico"
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = "Adafruit_circuitpython_mlx90393Librarydoc"
+htmlhelp_basename = "AdafruitMLX90393Librarydoc"
 
 # -- Options for LaTeX output ---------------------------------------------
 
@@ -147,8 +147,8 @@
 latex_documents = [
     (
         master_doc,
-        "Adafruit_CircuitPython_MLX90393Library.tex",
-        "Adafruit_CircuitPython_MLX90393 Library Documentation",
+        "AdafruitMLX90393Library.tex",
+        "Adafruit MLX90393 Library Documentation",
         author,
         "manual",
     ),
@@ -161,8 +161,8 @@
 man_pages = [
     (
         master_doc,
-        "Adafruit_CircuitPython_MLX90393library",
-        "Adafruit_CircuitPython_MLX90393 Library Documentation",
+        "AdafruitMLX90393library",
+        "Adafruit MLX90393 Library Documentation",
         [author],
         1,
     )

From 6572e2be13068b4fac83b103d2491365ff7a05fc Mon Sep 17 00:00:00 2001
From: caternuson <caternuson@gmail.com>
Date: Fri, 22 May 2020 13:06:41 -0700
Subject: [PATCH 021/107] update i2c _transceive

---
 adafruit_mlx90393.py | 11 ++++-------
 1 file changed, 4 insertions(+), 7 deletions(-)

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index c6e1b8d..2dfcc87 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -164,16 +164,13 @@ def _transceive(self, payload, rxlen=0):
             with self.i2c_device as i2c:
                 i2c.write(payload, stop=False)
 
-            while True:
-                # While busy, the sensor doesn't respond to reads.
-                try:
-                    with self.i2c_device as i2c:
+                while True:
+                    try:
                         i2c.readinto(data)
-                        # Make sure we have something in the response
                         if data[0]:
                             break
-                except OSError:
-                    pass
+                    except OSError:
+                        pass
 
         # Track status byte
         self._status_last = data[0]

From ad1e7616fbda85adee155c3dbb89920dd31d9ae4 Mon Sep 17 00:00:00 2001
From: dherrada <dylan.herrada@adafruit.com>
Date: Wed, 8 Jul 2020 16:49:04 -0400
Subject: [PATCH 022/107] Fixed discord invite link

---
 README.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.rst b/README.rst
index 043dd7b..b1c907f 100644
--- a/README.rst
+++ b/README.rst
@@ -6,7 +6,7 @@ Introduction
     :alt: Documentation Status
 
 .. image:: https://img.shields.io/discord/327254708534116352.svg
-    :target: https://discord.gg/nBQh6qu
+    :target: https://adafru.it/discord
     :alt: Discord
 
 .. image:: https://github.com/adafruit/Adafruit_CircuitPython_MLX90393/workflows/Build%20CI/badge.svg

From 43e7c76a345786b3cec7a544c316727ab652bdd5 Mon Sep 17 00:00:00 2001
From: caternuson <caternuson@gmail.com>
Date: Thu, 15 Oct 2020 09:40:58 -0700
Subject: [PATCH 023/107] add res, filt, osr

---
 adafruit_mlx90393.py | 199 ++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 179 insertions(+), 20 deletions(-)

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index 2dfcc87..5d79905 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -77,6 +77,7 @@
 _CMD_REG_CONF3 = const(0x02)  # Oversampling, Filter, Resolution
 _CMD_REG_CONF4 = const(0x03)  # Sensitivity drift
 
+# Gain settings
 GAIN_5X = 0x0
 GAIN_4X = 0x1
 GAIN_3X = 0x2
@@ -87,11 +88,27 @@
 GAIN_1X = 0x7
 _GAIN_SHIFT = const(4)
 
-_RES_2_15 = const(0)  # +/- 2^15
-_RES_2_15B = const(1)  # +/- 2^15
-_RES_22000 = const(2)  # +/- 22000
-_RES_11000 = const(3)  # +/- 11000
-_RES_SHIFT = const(5)
+# Resolution settings
+RESOLUTION_16 = 0x0
+RESOLUTION_17 = 0x1
+RESOLUTION_18 = 0x2
+RESOLUTION_19 = 0x3
+
+# Filter settings
+FILTER_0 = 0x0
+FILTER_1 = 0x1
+FILTER_2 = 0x2
+FILTER_3 = 0x3
+FILTER_4 = 0x4
+FILTER_5 = 0x5
+FILTER_6 = 0x6
+FILTER_7 = 0x7
+
+# Oversampling settings
+OSR_0 = 0x0
+OSR_1 = 0x1
+OSR_2 = 0x2
+OSR_3 = 0x3
 
 _HALLCONF = const(0x0C)  # Hall plate spinning rate adjust.
 
@@ -120,6 +137,20 @@
     ((0.150, 0.242), (0.300, 0.484), (0.601, 0.968), (1.202, 1.936)),
 )
 
+# Lookup table for conversion times for different filter and
+# oversampling settings. Values taken from datasheet.
+_TCONV_LOOKUP = (
+    # OSR = 0      1       2       3
+    (1.27, 1.84, 3.00, 5.30),  # DIG_FILT = 0
+    (1.46, 2.23, 3.76, 6.84),  # DIG_FILT = 1
+    (1.84, 3.00, 5.30, 9.91),  # DIG_FILT = 2
+    (2.61, 4.53, 8.37, 16.05),  # DIG_FILT = 3
+    (4.15, 7.60, 14.52, 28.34),  # DIG_FILT = 4
+    (7.22, 13.75, 26.80, 52.92),  # DIG_FILT = 5
+    (13.36, 26.04, 51.38, 102.07),  # DIG_FILT = 6
+    (25.65, 50.61, 100.53, 200.37),  # DIF_FILT = 7
+)
+
 
 class MLX90393:
     """
@@ -131,16 +162,38 @@ class MLX90393:
     :param bool debug: (optional) Enable debug output.
     """
 
-    def __init__(self, i2c_bus, address=0x0C, gain=GAIN_1X, debug=False):
+    def __init__(
+        self,
+        i2c_bus,
+        address=0x0C,
+        gain=GAIN_1X,
+        resolution=RESOLUTION_16,
+        filter=FILTER_7,
+        oversampling=OSR_3,
+        debug=False,
+    ):
         self.i2c_device = I2CDevice(i2c_bus, address)
         self._debug = debug
         self._status_last = 0
-        self._res_current = _RES_2_15
+        self._res_x = self._res_y = self._res_z = resolution
+        self._filter = filter
+        self._osr = oversampling
         self._gain_current = gain
 
         # Put the device in a known state to start
         self.reset()
 
+        # Set resolution to the supplied level
+        self.resolution_x = self._res_x
+        self.resolution_y = self._res_y
+        self.resolution_z = self._res_z
+
+        # Set filter to the supplied level
+        self.filter = self._filter
+
+        # Set oversampling to the supplied level
+        self.oversampling = self._osr
+
         # Set gain to the supplied level
         self.gain = self._gain_current
 
@@ -185,22 +238,19 @@ def _transceive(self, payload, rxlen=0):
     @property
     def last_status(self):
         """
-        Returns the last status byte received from the sensor.
+        The last status byte received from the sensor.
         """
         return self._status_last
 
     @property
     def gain(self):
         """
-        Gets the current gain setting for the device.
+        The gain setting for the device.
         """
         return self._gain_current
 
     @gain.setter
     def gain(self, value):
-        """
-        Sets the gain for the device.
-        """
         if value > GAIN_1X or value < GAIN_5X:
             raise ValueError("Invalid GAIN setting")
         if self._debug:
@@ -217,6 +267,81 @@ def gain(self, value):
             )
         )
 
+    @property
+    def resolution_x(self):
+        """The X axis resolution."""
+        return self._res_x
+
+    @resolution_x.setter
+    def resolution_x(self, resolution):
+        self._set_resolution(0, resolution)
+        self._res_x = resolution
+
+    @property
+    def resolution_y(self):
+        """The Y axis resolution."""
+        return self._res_y
+
+    @resolution_y.setter
+    def resolution_y(self, resolution):
+        self._set_resolution(1, resolution)
+        self._res_y = resolution
+
+    @property
+    def resolution_z(self):
+        """The Z axis resolution."""
+        return self._res_z
+
+    @resolution_z.setter
+    def resolution_z(self, resolution):
+        self._set_resolution(2, resolution)
+        self._res_z = resolution
+
+    def _set_resolution(self, axis, resolution):
+        if resolution not in (
+            RESOLUTION_16,
+            RESOLUTION_17,
+            RESOLUTION_18,
+            RESOLUTION_19,
+        ):
+            raise ValueError("Incorrect resolution setting.")
+        shift = (5, 7, 9)[axis]
+        mask = (0xFF9F, 0xFE7F, 0xF9FF)[axis]
+        reg = self.read_reg(_CMD_REG_CONF3)
+        reg &= mask
+        reg |= (resolution & 0x3) << shift
+        self.write_reg(_CMD_REG_CONF3, reg)
+
+    @property
+    def filter(self):
+        """The filter level."""
+        return self._filter
+
+    @filter.setter
+    def filter(self, level):
+        if level not in range(8):
+            raise ValueError("Incorrect filter level.")
+        reg = self.read_reg(_CMD_REG_CONF3)
+        reg &= 0xFFE3
+        reg |= (level & 0x7) << 2
+        self.write_reg(_CMD_REG_CONF3, reg)
+        self._filter = level
+
+    @property
+    def oversampling(self):
+        """The oversampling level."""
+        return self._osr
+
+    @oversampling.setter
+    def oversampling(self, level):
+        if level not in range(4):
+            raise ValueError("Incorrect oversampling level.")
+        reg = self.read_reg(_CMD_REG_CONF3)
+        reg &= 0xFFFC
+        reg |= level & 0x3
+        self.write_reg(_CMD_REG_CONF3, reg)
+        self._osr = level
+
     def display_status(self):
         """
         Prints out the content of the last status byte in a human-readble
@@ -248,7 +373,7 @@ def read_reg(self, reg):
         with self.i2c_device as i2c:
             i2c.readinto(data)
         # Unpack data (status byte, big-endian 16-bit register value)
-        self._status_last, val = struct.unpack(">Bh", data)
+        self._status_last, val = struct.unpack(">BH", data)
         if self._debug:
             print("\t[{}]".format(time.monotonic()))
             print("\t Writing :", [hex(b) for b in payload])
@@ -256,6 +381,21 @@ def read_reg(self, reg):
             print("\t  Status :", hex(data[0]))
         return val
 
+    def write_reg(self, reg, value):
+        """
+        Writes the 16-bit value to the supplied register.
+        """
+        self._transceive(
+            bytes(
+                [
+                    _CMD_WR,
+                    value >> 8,  # high byte
+                    value & 0xFF,  # low byte
+                    reg << 2,  # the register
+                ]
+            )
+        )
+
     def reset(self):
         """
         Performs a software reset of the sensor.
@@ -276,7 +416,9 @@ def read_data(self):
         """
         Reads a single X/Y/Z sample from the magnetometer.
         """
-        delay = 0.01
+        # Set conversion delay based on filter and oversampling
+        delay = _TCONV_LOOKUP[self._filter][self._osr] / 1000  # per datasheet
+        delay *= 1.1  # plus a little
 
         # Set the device to single measurement mode
         self._transceive(bytes([_CMD_SM | _CMD_AXIS_ALL]))
@@ -284,12 +426,29 @@ def read_data(self):
         # Insert a delay since we aren't using INTs for DRDY
         time.sleep(delay)
 
-        # Read the 'XYZ' data as three signed 16-bit integers
+        # Read the 'XYZ' data
         data = self._transceive(bytes([_CMD_RM | _CMD_AXIS_ALL]), 6)
-        self._status_last, m_x, m_y, m_z = struct.unpack(">Bhhh", data)
+
+        # Unpack status and raw int values
+        self._status_last = data[0]
+        m_x = self._unpack_axis_data(self._res_x, data[1:3])
+        m_y = self._unpack_axis_data(self._res_y, data[3:5])
+        m_z = self._unpack_axis_data(self._res_z, data[5:7])
 
         # Return the raw int values if requested
-        return (m_x, m_y, m_z)
+        return m_x, m_y, m_z
+
+    def _unpack_axis_data(self, resolution, data):
+        # see datasheet
+        if resolution == RESOLUTION_19:
+            (value,) = struct.unpack(">H", data)
+            value -= 0x4000
+        elif resolution == RESOLUTION_18:
+            (value,) = struct.unpack(">H", data)
+            value -= 0x8000
+        else:
+            value = struct.unpack(">h", data)[0]
+        return value
 
     @property
     def magnetic(self):
@@ -300,8 +459,8 @@ def magnetic(self):
         x, y, z = self.read_data
 
         # Convert the raw integer values to uT based on gain and resolution
-        x *= _LSB_LOOKUP[self._gain_current][self._res_current][0]
-        y *= _LSB_LOOKUP[self._gain_current][self._res_current][0]
-        z *= _LSB_LOOKUP[self._gain_current][self._res_current][1]
+        x *= _LSB_LOOKUP[self._gain_current][self._res_x][0]
+        y *= _LSB_LOOKUP[self._gain_current][self._res_y][0]
+        z *= _LSB_LOOKUP[self._gain_current][self._res_z][1]
 
         return x, y, z

From ec0b6f0e3565fd34a70222884d3cb2e06d05499d Mon Sep 17 00:00:00 2001
From: caternuson <caternuson@gmail.com>
Date: Thu, 15 Oct 2020 09:52:26 -0700
Subject: [PATCH 024/107] lint

---
 adafruit_mlx90393.py | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index 5d79905..8ba1063 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -151,8 +151,7 @@
     (25.65, 50.61, 100.53, 200.37),  # DIF_FILT = 7
 )
 
-
-class MLX90393:
+class MLX90393: # pylint: disable=too-many-instance-attributes
     """
     Driver for the MLX90393 magnetometer.
     :param i2c_bus: The `busio.I2C` object to use. This is the only
@@ -168,15 +167,15 @@ def __init__(
         address=0x0C,
         gain=GAIN_1X,
         resolution=RESOLUTION_16,
-        filter=FILTER_7,
+        filt=FILTER_7,
         oversampling=OSR_3,
         debug=False,
-    ):
+    ): # pylint: disable=too-many-arguments
         self.i2c_device = I2CDevice(i2c_bus, address)
         self._debug = debug
         self._status_last = 0
         self._res_x = self._res_y = self._res_z = resolution
-        self._filter = filter
+        self._filter = filt
         self._osr = oversampling
         self._gain_current = gain
 

From bcffd99e8d7613d1ae3273267802f5ab30b87352 Mon Sep 17 00:00:00 2001
From: caternuson <caternuson@gmail.com>
Date: Thu, 15 Oct 2020 10:03:17 -0700
Subject: [PATCH 025/107] black

---
 adafruit_mlx90393.py | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index 8ba1063..507e44c 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -151,7 +151,8 @@
     (25.65, 50.61, 100.53, 200.37),  # DIF_FILT = 7
 )
 
-class MLX90393: # pylint: disable=too-many-instance-attributes
+
+class MLX90393:  # pylint: disable=too-many-instance-attributes
     """
     Driver for the MLX90393 magnetometer.
     :param i2c_bus: The `busio.I2C` object to use. This is the only
@@ -170,7 +171,7 @@ def __init__(
         filt=FILTER_7,
         oversampling=OSR_3,
         debug=False,
-    ): # pylint: disable=too-many-arguments
+    ):  # pylint: disable=too-many-arguments
         self.i2c_device = I2CDevice(i2c_bus, address)
         self._debug = debug
         self._status_last = 0

From 39d091720e1d977907d8b70cb5a14aae426dc13d Mon Sep 17 00:00:00 2001
From: caternuson <caternuson@gmail.com>
Date: Thu, 15 Oct 2020 10:09:24 -0700
Subject: [PATCH 026/107] sshhhh

---
 adafruit_mlx90393.py | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index 507e44c..cfef1fa 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -215,6 +215,7 @@ def _transceive(self, payload, rxlen=0):
             # Write 'value' to the specified register
             # TODO: Check this. It's weird that the write is accepted but the read is naked.
             with self.i2c_device as i2c:
+                # pylint: disable=unexpected-keyword-arg
                 i2c.write(payload, stop=False)
 
                 while True:
@@ -438,6 +439,7 @@ def read_data(self):
         # Return the raw int values if requested
         return m_x, m_y, m_z
 
+    # pylint: disable=no-self-use
     def _unpack_axis_data(self, resolution, data):
         # see datasheet
         if resolution == RESOLUTION_19:

From af2e6d7d5f0d70f1bbf119189c8d4c1d316a801d Mon Sep 17 00:00:00 2001
From: caternuson <caternuson@gmail.com>
Date: Thu, 15 Oct 2020 10:34:10 -0700
Subject: [PATCH 027/107] remove stop kwarg

---
 adafruit_mlx90393.py | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index cfef1fa..2b6fd96 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -215,8 +215,7 @@ def _transceive(self, payload, rxlen=0):
             # Write 'value' to the specified register
             # TODO: Check this. It's weird that the write is accepted but the read is naked.
             with self.i2c_device as i2c:
-                # pylint: disable=unexpected-keyword-arg
-                i2c.write(payload, stop=False)
+                i2c.write(payload)
 
                 while True:
                     try:

From 5829919dfe39a2a3ecd586ba5ac23e904c60ceff Mon Sep 17 00:00:00 2001
From: dherrada <dylan.herrada@adafruit.com>
Date: Mon, 11 Jan 2021 15:06:44 -0500
Subject: [PATCH 028/107] Added pre-commit and SPDX copyright

Signed-off-by: dherrada <dylan.herrada@adafruit.com>
---
 .github/workflows/build.yml   | 28 ++++++++++++++++++++++++----
 .github/workflows/release.yml |  4 ++++
 2 files changed, 28 insertions(+), 4 deletions(-)

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index b6977a9..59baa53 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
 name: Build CI
 
 on: [pull_request, push]
@@ -38,20 +42,36 @@ jobs:
       # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.)
       run: |
         source actions-ci/install.sh
-    - name: Pip install pylint, black, & Sphinx
+    - name: Pip install pylint, Sphinx, pre-commit
       run: |
-        pip install --force-reinstall pylint black==19.10b0 Sphinx sphinx-rtd-theme
+        pip install --force-reinstall pylint Sphinx sphinx-rtd-theme pre-commit
     - name: Library version
       run: git describe --dirty --always --tags
-    - name: Check formatting
+    - name: Pre-commit hooks
       run: |
-        black --check --target-version=py35 .
+        pre-commit run --all-files
     - name: PyLint
       run: |
         pylint $( find . -path './adafruit*.py' )
         ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace $( find . -path "./examples/*.py" ))
     - name: Build assets
       run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location .
+    - name: Archive bundles
+      uses: actions/upload-artifact@v2
+      with:
+        name: bundles
+        path: ${{ github.workspace }}/bundles/
     - name: Build docs
       working-directory: docs
       run: sphinx-build -E -W -b html . _build/html
+    - name: Check For setup.py
+      id: need-pypi
+      run: |
+        echo ::set-output name=setup-py::$( find . -wholename './setup.py' )
+    - name: Build Python package
+      if: contains(steps.need-pypi.outputs.setup-py, 'setup.py')
+      run: |
+        pip install --upgrade setuptools wheel twine readme_renderer testresources
+        python setup.py sdist
+        python setup.py bdist_wheel --universal
+        twine check dist/*
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 18efb9c..6d0015a 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
 name: Release Actions
 
 on:

From c9c1635f1d5ce951eeee5d73f55872aad29e2950 Mon Sep 17 00:00:00 2001
From: dherrada <dylan.herrada@adafruit.com>
Date: Mon, 11 Jan 2021 16:06:47 -0500
Subject: [PATCH 029/107] Added pre-commit-config file

Signed-off-by: dherrada <dylan.herrada@adafruit.com>
---
 .pre-commit-config.yaml | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 .pre-commit-config.yaml

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
new file mode 100644
index 0000000..aab5f1c
--- /dev/null
+++ b/.pre-commit-config.yaml
@@ -0,0 +1,19 @@
+# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò
+#
+# SPDX-License-Identifier: Unlicense
+
+repos:
+-   repo: https://github.com/python/black
+    rev: stable
+    hooks:
+    - id: black
+-   repo: https://github.com/fsfe/reuse-tool
+    rev: latest
+    hooks:
+    - id: reuse
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace

From a3993d5c677c0700f5bacf9e651bc9292c76b034 Mon Sep 17 00:00:00 2001
From: dherrada <dylan.herrada@adafruit.com>
Date: Thu, 14 Jan 2021 11:47:21 -0500
Subject: [PATCH 030/107] Ran pre-commit, added licenses

---
 .gitignore                       |   6 +-
 .pylintrc                        |   4 +
 .readthedocs.yml                 |   4 +
 CODE_OF_CONDUCT.md               |  14 +-
 LICENSES/CC-BY-4.0.txt           | 324 +++++++++++++++++++++++++++++++
 LICENSES/MIT.txt                 |  19 ++
 LICENSES/Unlicense.txt           |  20 ++
 README.rst.license               |   3 +
 adafruit_mlx90393.py             |  23 +--
 docs/_static/favicon.ico.license |   3 +
 docs/api.rst.license             |   3 +
 docs/conf.py                     |   5 +
 docs/examples.rst.license        |   3 +
 docs/index.rst.license           |   3 +
 examples/mlx90393_simpletest.py  |   3 +
 requirements.txt                 |   4 +
 setup.py                         |   4 +
 17 files changed, 420 insertions(+), 25 deletions(-)
 create mode 100644 LICENSES/CC-BY-4.0.txt
 create mode 100644 LICENSES/MIT.txt
 create mode 100644 LICENSES/Unlicense.txt
 create mode 100644 README.rst.license
 create mode 100644 docs/_static/favicon.ico.license
 create mode 100644 docs/api.rst.license
 create mode 100644 docs/examples.rst.license
 create mode 100644 docs/index.rst.license

diff --git a/.gitignore b/.gitignore
index c83f8b7..9647e71 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense
+
 *.mpy
 .idea
 __pycache__
@@ -8,4 +12,4 @@ bundles
 *.DS_Store
 .eggs
 dist
-**/*.egg-info
\ No newline at end of file
+**/*.egg-info
diff --git a/.pylintrc b/.pylintrc
index d8f0ee8..5c31f66 100644
--- a/.pylintrc
+++ b/.pylintrc
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense
+
 [MASTER]
 
 # A comma-separated list of package or module names from where C extensions may
diff --git a/.readthedocs.yml b/.readthedocs.yml
index f4243ad..ffa84c4 100644
--- a/.readthedocs.yml
+++ b/.readthedocs.yml
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense
+
 python:
     version: 3
 requirements_file: requirements.txt
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
index 134d510..8a55c07 100644
--- a/CODE_OF_CONDUCT.md
+++ b/CODE_OF_CONDUCT.md
@@ -1,3 +1,9 @@
+<!--
+SPDX-FileCopyrightText: 2014 Coraline Ada Ehmke
+SPDX-FileCopyrightText: 2019 Kattni Rembor for Adafruit Industries
+SPDX-License-Identifier: CC-BY-4.0
+-->
+
 # Adafruit Community Code of Conduct
 
 ## Our Pledge
@@ -43,7 +49,7 @@ Examples of unacceptable behavior by participants include:
 
 The goal of the standards and moderation guidelines outlined here is to build
 and maintain a respectful community. We ask that you don’t just aim to be
-"technically unimpeachable", but rather try to be your best self. 
+"technically unimpeachable", but rather try to be your best self.
 
 We value many things beyond technical expertise, including collaboration and
 supporting others within our community. Providing a positive experience for
@@ -74,9 +80,9 @@ You may report in the following ways:
 In any situation, you may send an email to <support@adafruit.com>.
 
 On the Adafruit Discord, you may send an open message from any channel
-to all Community Moderators by tagging @community moderators. You may 
-also send an open message from any channel, or a direct message to 
-@kattni#1507, @tannewt#4653, @Dan Halbert#1614, @cater#2442, 
+to all Community Moderators by tagging @community moderators. You may
+also send an open message from any channel, or a direct message to
+@kattni#1507, @tannewt#4653, @Dan Halbert#1614, @cater#2442,
 @sommersoft#0222, @Mr. Certainly#0472 or @Andon#8175.
 
 Email and direct message reports will be kept confidential.
diff --git a/LICENSES/CC-BY-4.0.txt b/LICENSES/CC-BY-4.0.txt
new file mode 100644
index 0000000..3f92dfc
--- /dev/null
+++ b/LICENSES/CC-BY-4.0.txt
@@ -0,0 +1,324 @@
+Creative Commons Attribution 4.0 International Creative Commons Corporation
+("Creative Commons") is not a law firm and does not provide legal services
+or legal advice. Distribution of Creative Commons public licenses does not
+create a lawyer-client or other relationship. Creative Commons makes its licenses
+and related information available on an "as-is" basis. Creative Commons gives
+no warranties regarding its licenses, any material licensed under their terms
+and conditions, or any related information. Creative Commons disclaims all
+liability for damages resulting from their use to the fullest extent possible.
+
+Using Creative Commons Public Licenses
+
+Creative Commons public licenses provide a standard set of terms and conditions
+that creators and other rights holders may use to share original works of
+authorship and other material subject to copyright and certain other rights
+specified in the public license below. The following considerations are for
+informational purposes only, are not exhaustive, and do not form part of our
+licenses.
+
+Considerations for licensors: Our public licenses are intended for use by
+those authorized to give the public permission to use material in ways otherwise
+restricted by copyright and certain other rights. Our licenses are irrevocable.
+Licensors should read and understand the terms and conditions of the license
+they choose before applying it. Licensors should also secure all rights necessary
+before applying our licenses so that the public can reuse the material as
+expected. Licensors should clearly mark any material not subject to the license.
+This includes other CC-licensed material, or material used under an exception
+or limitation to copyright. More considerations for licensors : wiki.creativecommons.org/Considerations_for_licensors
+
+Considerations for the public: By using one of our public licenses, a licensor
+grants the public permission to use the licensed material under specified
+terms and conditions. If the licensor's permission is not necessary for any
+reason–for example, because of any applicable exception or limitation to copyright–then
+that use is not regulated by the license. Our licenses grant only permissions
+under copyright and certain other rights that a licensor has authority to
+grant. Use of the licensed material may still be restricted for other reasons,
+including because others have copyright or other rights in the material. A
+licensor may make special requests, such as asking that all changes be marked
+or described. Although not required by our licenses, you are encouraged to
+respect those requests where reasonable. More considerations for the public
+: wiki.creativecommons.org/Considerations_for_licensees Creative Commons Attribution
+4.0 International Public License
+
+By exercising the Licensed Rights (defined below), You accept and agree to
+be bound by the terms and conditions of this Creative Commons Attribution
+4.0 International Public License ("Public License"). To the extent this Public
+License may be interpreted as a contract, You are granted the Licensed Rights
+in consideration of Your acceptance of these terms and conditions, and the
+Licensor grants You such rights in consideration of benefits the Licensor
+receives from making the Licensed Material available under these terms and
+conditions.
+
+Section 1 – Definitions.
+
+a. Adapted Material means material subject to Copyright and Similar Rights
+that is derived from or based upon the Licensed Material and in which the
+Licensed Material is translated, altered, arranged, transformed, or otherwise
+modified in a manner requiring permission under the Copyright and Similar
+Rights held by the Licensor. For purposes of this Public License, where the
+Licensed Material is a musical work, performance, or sound recording, Adapted
+Material is always produced where the Licensed Material is synched in timed
+relation with a moving image.
+
+b. Adapter's License means the license You apply to Your Copyright and Similar
+Rights in Your contributions to Adapted Material in accordance with the terms
+and conditions of this Public License.
+
+c. Copyright and Similar Rights means copyright and/or similar rights closely
+related to copyright including, without limitation, performance, broadcast,
+sound recording, and Sui Generis Database Rights, without regard to how the
+rights are labeled or categorized. For purposes of this Public License, the
+rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.
+
+d. Effective Technological Measures means those measures that, in the absence
+of proper authority, may not be circumvented under laws fulfilling obligations
+under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996,
+and/or similar international agreements.
+
+e. Exceptions and Limitations means fair use, fair dealing, and/or any other
+exception or limitation to Copyright and Similar Rights that applies to Your
+use of the Licensed Material.
+
+f. Licensed Material means the artistic or literary work, database, or other
+material to which the Licensor applied this Public License.
+
+g. Licensed Rights means the rights granted to You subject to the terms and
+conditions of this Public License, which are limited to all Copyright and
+Similar Rights that apply to Your use of the Licensed Material and that the
+Licensor has authority to license.
+
+h. Licensor means the individual(s) or entity(ies) granting rights under this
+Public License.
+
+i. Share means to provide material to the public by any means or process that
+requires permission under the Licensed Rights, such as reproduction, public
+display, public performance, distribution, dissemination, communication, or
+importation, and to make material available to the public including in ways
+that members of the public may access the material from a place and at a time
+individually chosen by them.
+
+j. Sui Generis Database Rights means rights other than copyright resulting
+from Directive 96/9/EC of the European Parliament and of the Council of 11
+March 1996 on the legal protection of databases, as amended and/or succeeded,
+as well as other essentially equivalent rights anywhere in the world.
+
+k. You means the individual or entity exercising the Licensed Rights under
+this Public License. Your has a corresponding meaning.
+
+Section 2 – Scope.
+
+   a. License grant.
+
+1. Subject to the terms and conditions of this Public License, the Licensor
+hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive,
+irrevocable license to exercise the Licensed Rights in the Licensed Material
+to:
+
+         A. reproduce and Share the Licensed Material, in whole or in part; and
+
+         B. produce, reproduce, and Share Adapted Material.
+
+2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions
+and Limitations apply to Your use, this Public License does not apply, and
+You do not need to comply with its terms and conditions.
+
+      3. Term. The term of this Public License is specified in Section 6(a).
+
+4. Media and formats; technical modifications allowed. The Licensor authorizes
+You to exercise the Licensed Rights in all media and formats whether now known
+or hereafter created, and to make technical modifications necessary to do
+so. The Licensor waives and/or agrees not to assert any right or authority
+to forbid You from making technical modifications necessary to exercise the
+Licensed Rights, including technical modifications necessary to circumvent
+Effective Technological Measures. For purposes of this Public License, simply
+making modifications authorized by this Section 2(a)(4) never produces Adapted
+Material.
+
+      5. Downstream recipients.
+
+A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed
+Material automatically receives an offer from the Licensor to exercise the
+Licensed Rights under the terms and conditions of this Public License.
+
+B. No downstream restrictions. You may not offer or impose any additional
+or different terms or conditions on, or apply any Effective Technological
+Measures to, the Licensed Material if doing so restricts exercise of the Licensed
+Rights by any recipient of the Licensed Material.
+
+6. No endorsement. Nothing in this Public License constitutes or may be construed
+as permission to assert or imply that You are, or that Your use of the Licensed
+Material is, connected with, or sponsored, endorsed, or granted official status
+by, the Licensor or others designated to receive attribution as provided in
+Section 3(a)(1)(A)(i).
+
+   b. Other rights.
+
+1. Moral rights, such as the right of integrity, are not licensed under this
+Public License, nor are publicity, privacy, and/or other similar personality
+rights; however, to the extent possible, the Licensor waives and/or agrees
+not to assert any such rights held by the Licensor to the limited extent necessary
+to allow You to exercise the Licensed Rights, but not otherwise.
+
+2. Patent and trademark rights are not licensed under this Public License.
+
+3. To the extent possible, the Licensor waives any right to collect royalties
+from You for the exercise of the Licensed Rights, whether directly or through
+a collecting society under any voluntary or waivable statutory or compulsory
+licensing scheme. In all other cases the Licensor expressly reserves any right
+to collect such royalties.
+
+Section 3 – License Conditions.
+
+Your exercise of the Licensed Rights is expressly made subject to the following
+conditions.
+
+   a. Attribution.
+
+1. If You Share the Licensed Material (including in modified form), You must:
+
+A. retain the following if it is supplied by the Licensor with the Licensed
+Material:
+
+i. identification of the creator(s) of the Licensed Material and any others
+designated to receive attribution, in any reasonable manner requested by the
+Licensor (including by pseudonym if designated);
+
+            ii. a copyright notice;
+
+            iii. a notice that refers to this Public License;
+
+            iv. a notice that refers to the disclaimer of warranties;
+
+v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
+
+B. indicate if You modified the Licensed Material and retain an indication
+of any previous modifications; and
+
+C. indicate the Licensed Material is licensed under this Public License, and
+include the text of, or the URI or hyperlink to, this Public License.
+
+2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner
+based on the medium, means, and context in which You Share the Licensed Material.
+For example, it may be reasonable to satisfy the conditions by providing a
+URI or hyperlink to a resource that includes the required information.
+
+3. If requested by the Licensor, You must remove any of the information required
+by Section 3(a)(1)(A) to the extent reasonably practicable.
+
+4. If You Share Adapted Material You produce, the Adapter's License You apply
+must not prevent recipients of the Adapted Material from complying with this
+Public License.
+
+Section 4 – Sui Generis Database Rights.
+
+Where the Licensed Rights include Sui Generis Database Rights that apply to
+Your use of the Licensed Material:
+
+a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract,
+reuse, reproduce, and Share all or a substantial portion of the contents of
+the database;
+
+b. if You include all or a substantial portion of the database contents in
+a database in which You have Sui Generis Database Rights, then the database
+in which You have Sui Generis Database Rights (but not its individual contents)
+is Adapted Material; and
+
+c. You must comply with the conditions in Section 3(a) if You Share all or
+a substantial portion of the contents of the database.
+
+For the avoidance of doubt, this Section 4 supplements and does not replace
+Your obligations under this Public License where the Licensed Rights include
+other Copyright and Similar Rights.
+
+Section 5 – Disclaimer of Warranties and Limitation of Liability.
+
+a. Unless otherwise separately undertaken by the Licensor, to the extent possible,
+the Licensor offers the Licensed Material as-is and as-available, and makes
+no representations or warranties of any kind concerning the Licensed Material,
+whether express, implied, statutory, or other. This includes, without limitation,
+warranties of title, merchantability, fitness for a particular purpose, non-infringement,
+absence of latent or other defects, accuracy, or the presence or absence of
+errors, whether or not known or discoverable. Where disclaimers of warranties
+are not allowed in full or in part, this disclaimer may not apply to You.
+
+b. To the extent possible, in no event will the Licensor be liable to You
+on any legal theory (including, without limitation, negligence) or otherwise
+for any direct, special, indirect, incidental, consequential, punitive, exemplary,
+or other losses, costs, expenses, or damages arising out of this Public License
+or use of the Licensed Material, even if the Licensor has been advised of
+the possibility of such losses, costs, expenses, or damages. Where a limitation
+of liability is not allowed in full or in part, this limitation may not apply
+to You.
+
+c. The disclaimer of warranties and limitation of liability provided above
+shall be interpreted in a manner that, to the extent possible, most closely
+approximates an absolute disclaimer and waiver of all liability.
+
+Section 6 – Term and Termination.
+
+a. This Public License applies for the term of the Copyright and Similar Rights
+licensed here. However, if You fail to comply with this Public License, then
+Your rights under this Public License terminate automatically.
+
+b. Where Your right to use the Licensed Material has terminated under Section
+6(a), it reinstates:
+
+1. automatically as of the date the violation is cured, provided it is cured
+within 30 days of Your discovery of the violation; or
+
+      2. upon express reinstatement by the Licensor.
+
+c. For the avoidance of doubt, this Section 6(b) does not affect any right
+the Licensor may have to seek remedies for Your violations of this Public
+License.
+
+d. For the avoidance of doubt, the Licensor may also offer the Licensed Material
+under separate terms or conditions or stop distributing the Licensed Material
+at any time; however, doing so will not terminate this Public License.
+
+   e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
+
+Section 7 – Other Terms and Conditions.
+
+a. The Licensor shall not be bound by any additional or different terms or
+conditions communicated by You unless expressly agreed.
+
+b. Any arrangements, understandings, or agreements regarding the Licensed
+Material not stated herein are separate from and independent of the terms
+and conditions of this Public License.
+
+Section 8 – Interpretation.
+
+a. For the avoidance of doubt, this Public License does not, and shall not
+be interpreted to, reduce, limit, restrict, or impose conditions on any use
+of the Licensed Material that could lawfully be made without permission under
+this Public License.
+
+b. To the extent possible, if any provision of this Public License is deemed
+unenforceable, it shall be automatically reformed to the minimum extent necessary
+to make it enforceable. If the provision cannot be reformed, it shall be severed
+from this Public License without affecting the enforceability of the remaining
+terms and conditions.
+
+c. No term or condition of this Public License will be waived and no failure
+to comply consented to unless expressly agreed to by the Licensor.
+
+d. Nothing in this Public License constitutes or may be interpreted as a limitation
+upon, or waiver of, any privileges and immunities that apply to the Licensor
+or You, including from the legal processes of any jurisdiction or authority.
+
+Creative Commons is not a party to its public licenses. Notwithstanding, Creative
+Commons may elect to apply one of its public licenses to material it publishes
+and in those instances will be considered the "Licensor." The text of the
+Creative Commons public licenses is dedicated to the public domain under the
+CC0 Public Domain Dedication. Except for the limited purpose of indicating
+that material is shared under a Creative Commons public license or as otherwise
+permitted by the Creative Commons policies published at creativecommons.org/policies,
+Creative Commons does not authorize the use of the trademark "Creative Commons"
+or any other trademark or logo of Creative Commons without its prior written
+consent including, without limitation, in connection with any unauthorized
+modifications to any of its public licenses or any other arrangements, understandings,
+or agreements concerning use of licensed material. For the avoidance of doubt,
+this paragraph does not form part of the public licenses.
+
+Creative Commons may be contacted at creativecommons.org.
diff --git a/LICENSES/MIT.txt b/LICENSES/MIT.txt
new file mode 100644
index 0000000..204b93d
--- /dev/null
+++ b/LICENSES/MIT.txt
@@ -0,0 +1,19 @@
+MIT License Copyright (c) <year> <copyright holders>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished
+to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice (including the next
+paragraph) shall be included in all copies or substantial portions of the
+Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
+OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
+OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/LICENSES/Unlicense.txt b/LICENSES/Unlicense.txt
new file mode 100644
index 0000000..24a8f90
--- /dev/null
+++ b/LICENSES/Unlicense.txt
@@ -0,0 +1,20 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or distribute
+this software, either in source code form or as a compiled binary, for any
+purpose, commercial or non-commercial, and by any means.
+
+In jurisdictions that recognize copyright laws, the author or authors of this
+software dedicate any and all copyright interest in the software to the public
+domain. We make this dedication for the benefit of the public at large and
+to the detriment of our heirs and successors. We intend this dedication to
+be an overt act of relinquishment in perpetuity of all present and future
+rights to this software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
+BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH
+THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. For more information,
+please refer to <https://unlicense.org/>
diff --git a/README.rst.license b/README.rst.license
new file mode 100644
index 0000000..11cd75d
--- /dev/null
+++ b/README.rst.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
+
+SPDX-License-Identifier: MIT
diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index 2b6fd96..448a388 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -1,24 +1,7 @@
-# The MIT License (MIT)
+# SPDX-FileCopyrightText: 2018 Kevin Townsend for Adafruit Industries
 #
-# Copyright (c) 2018 Kevin Townsend for Adafruit Industries
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# SPDX-License-Identifier: MIT
+
 """
 `adafruit_mlx90393`
 ====================================================
diff --git a/docs/_static/favicon.ico.license b/docs/_static/favicon.ico.license
new file mode 100644
index 0000000..86a3fbf
--- /dev/null
+++ b/docs/_static/favicon.ico.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries
+
+SPDX-License-Identifier: CC-BY-4.0
diff --git a/docs/api.rst.license b/docs/api.rst.license
new file mode 100644
index 0000000..9aae48d
--- /dev/null
+++ b/docs/api.rst.license
@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
diff --git a/docs/conf.py b/docs/conf.py
index c2e8fef..c72aff1 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,5 +1,10 @@
 # -*- coding: utf-8 -*-
 
+# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+
 import os
 import sys
 
diff --git a/docs/examples.rst.license b/docs/examples.rst.license
new file mode 100644
index 0000000..9aae48d
--- /dev/null
+++ b/docs/examples.rst.license
@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
diff --git a/docs/index.rst.license b/docs/index.rst.license
new file mode 100644
index 0000000..9aae48d
--- /dev/null
+++ b/docs/index.rst.license
@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
diff --git a/examples/mlx90393_simpletest.py b/examples/mlx90393_simpletest.py
index 1574250..c4a2b0e 100755
--- a/examples/mlx90393_simpletest.py
+++ b/examples/mlx90393_simpletest.py
@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
+# SPDX-License-Identifier: MIT
+
 import time
 import busio
 import board
diff --git a/requirements.txt b/requirements.txt
index 3031961..f675e3b 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,2 +1,6 @@
+# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense
+
 Adafruit-Blinka
 adafruit-circuitpython-busdevice
diff --git a/setup.py b/setup.py
index 2df77ca..e00bc79 100644
--- a/setup.py
+++ b/setup.py
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
 """A setuptools based setup module.
 
 See:

From 746cfaebd91c9018a70452469cb5f40f26fecf58 Mon Sep 17 00:00:00 2001
From: Dylan Herrada <33632497+dherrada@users.noreply.github.com>
Date: Thu, 14 Jan 2021 11:49:53 -0500
Subject: [PATCH 031/107] Removing extra newline

---
 docs/conf.py | 1 -
 1 file changed, 1 deletion(-)

diff --git a/docs/conf.py b/docs/conf.py
index c72aff1..0cff00b 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -4,7 +4,6 @@
 #
 # SPDX-License-Identifier: MIT
 
-
 import os
 import sys
 

From 852d3148243107937633836dd0c5f1424c31bf96 Mon Sep 17 00:00:00 2001
From: Chris Bailey <chris@darkcubed.com>
Date: Sun, 17 Jan 2021 18:02:57 -0500
Subject: [PATCH 032/107] Fix bug in reset that wasn't setting status properly

Removed setting the `_status_last` to the return value as the return result isn't just the status field.
The `_transceive` function is actually setting the `_status_last` as part of the function so there is no need to do anything additional in reset
---
 adafruit_mlx90393.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index 448a388..258c438 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -386,7 +386,7 @@ def reset(self):
         if self._debug:
             print("Resetting sensor")
         time.sleep(2)
-        self._status_last = self._transceive(bytes([_CMD_RT]))
+        self._transceive(bytes([_CMD_RT]))
         # burn a read post reset
         try:
             self.magnetic

From 9a0d067e0bf76697ccd1a09e836971825f0dae48 Mon Sep 17 00:00:00 2001
From: dherrada <dylan.herrada@adafruit.com>
Date: Wed, 3 Feb 2021 16:38:51 -0500
Subject: [PATCH 033/107] Hardcoded Black and REUSE versions

Signed-off-by: dherrada <dylan.herrada@adafruit.com>
---
 .pre-commit-config.yaml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index aab5f1c..07f886c 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -4,11 +4,11 @@
 
 repos:
 -   repo: https://github.com/python/black
-    rev: stable
+    rev: 20.8b1
     hooks:
     - id: black
 -   repo: https://github.com/fsfe/reuse-tool
-    rev: latest
+    rev: v0.12.1
     hooks:
     - id: reuse
 -   repo: https://github.com/pre-commit/pre-commit-hooks

From 74ed9042d941fb70af59878cdf68dcc8a67f6c95 Mon Sep 17 00:00:00 2001
From: PRC-SAK <Steve@PyxisRC.com>
Date: Mon, 1 Mar 2021 13:10:47 -0800
Subject: [PATCH 034/107] Add HALLCONF=0x0 calibration data to _LSB_LOOKUP

Changed _LSB_LOOKUP to be a 4d array by adding a second set of
calibration data for HALLCONF = 0x0 as per existing Arduino library:
_LSB_LOOKUP[0][x][y][z] is for HALLCONF = 0xC
_LSB_LOOKUP[1][x][y][z] is for HALLCONF = 0x0

Verified calibration values as per most current datasheet (rev. 6)
---
 adafruit_mlx90393.py | 54 +++++++++++++++++++++++++++++++-------------
 1 file changed, 38 insertions(+), 16 deletions(-)

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index 258c438..3f4ad5c 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -102,22 +102,44 @@
 # coefficient below. Note that the z axis has a different coefficient
 # than the x and y axis. Assumes HALLCONF = 0x0C!
 _LSB_LOOKUP = (
-    # 5x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-    ((0.751, 1.210), (1.502, 2.420), (3.004, 4.840), (6.009, 9.680)),
-    # 4x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-    ((0.601, 0.968), (1.202, 1.936), (2.403, 3.872), (4.840, 7.744)),
-    # 3x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-    ((0.451, 0.726), (0.901, 1.452), (1.803, 2.904), (3.605, 5.808)),
-    # 2.5x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-    ((0.376, 0.605), (0.751, 1.210), (1.502, 2.420), (3.004, 4.840)),
-    # 2x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-    ((0.300, 0.484), (0.601, 0.968), (1.202, 1.936), (2.403, 3.872)),
-    # 1.667x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-    ((0.250, 0.403), (0.501, 0.807), (1.001, 1.613), (2.003, 3.227)),
-    # 1.333x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-    ((0.200, 0.323), (0.401, 0.645), (0.801, 1.291), (1.602, 2.581)),
-    # 1x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-    ((0.150, 0.242), (0.300, 0.484), (0.601, 0.968), (1.202, 1.936)),
+    # HALLCONF = 0xC (default)
+    (
+        # 5x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
+        ((0.751, 1.210), (1.502, 2.420), (3.004, 4.840), (6.009, 9.680)),
+        # 4x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
+        ((0.601, 0.968), (1.202, 1.936), (2.403, 3.872), (4.840, 7.744)),
+        # 3x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
+        ((0.451, 0.726), (0.901, 1.452), (1.803, 2.904), (3.605, 5.808)),
+        # 2.5x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
+        ((0.376, 0.605), (0.751, 1.210), (1.502, 2.420), (3.004, 4.840)),
+        # 2x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
+        ((0.300, 0.484), (0.601, 0.968), (1.202, 1.936), (2.403, 3.872)),
+        # 1.667x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
+        ((0.250, 0.403), (0.501, 0.807), (1.001, 1.613), (2.003, 3.227)),
+        # 1.333x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
+        ((0.200, 0.323), (0.401, 0.645), (0.801, 1.291), (1.602, 2.581)),
+        # 1x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
+        ((0.150, 0.242), (0.300, 0.484), (0.601, 0.968), (1.202, 1.936)),
+    ),
+    # HALLCONF = 0x0
+    (
+        # GAIN_SEL = 0, 5x gain
+        ((0.787, 1.267), (1.573, 2.534), (3.146, 5.068), (6.292, 10.137)),
+        # GAIN_SEL = 1, 4x gain
+        ((0.629, 1.014), (1.258, 2.027), (2.517, 4.055), (5.034, 8.109)),
+        # GAIN_SEL = 2, 3x gain
+        ((0.472, 0.760), (0.944, 1.521), (1.888, 3.041), (3.775, 6.082)),
+        # GAIN_SEL = 3, 2.5x gain
+        ((0.393, 0.634), (0.787, 1.267), (1.573, 2.534), (3.146, 5.068)),
+        # GAIN_SEL = 4, 2x gain
+        ((0.315, 0.507), (0.629, 1.014), (1.258, 2.027), (2.517, 4.055)),
+        # GAIN_SEL = 5, 1.667x gain
+        ((0.262, 0.422), (0.524, 0.845), (1.049, 1.689), (2.097, 3.379)),
+        # GAIN_SEL = 6, 1.333x gain
+        ((0.210, 0.338), (0.419, 0.676), (0.839, 1.352), (1.678, 2.703)),
+        # GAIN_SEL = 7, 1x gain
+        ((0.157, 0.253), (0.315, 0.507), (0.629, 1.014), (1.258, 2.027)),
+    ),
 )
 
 # Lookup table for conversion times for different filter and

From bb275d9ecd3897e50c9cd6314798190a8f38fb97 Mon Sep 17 00:00:00 2001
From: PRC-SAK <Steve@PyxisRC.com>
Date: Mon, 1 Mar 2021 14:37:14 -0800
Subject: [PATCH 035/107] Revert "Add HALLCONF=0x0 calibration data to
 _LSB_LOOKUP"

This reverts commit 74ed9042d941fb70af59878cdf68dcc8a67f6c95.
---
 adafruit_mlx90393.py | 54 +++++++++++++-------------------------------
 1 file changed, 16 insertions(+), 38 deletions(-)

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index 3f4ad5c..258c438 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -102,44 +102,22 @@
 # coefficient below. Note that the z axis has a different coefficient
 # than the x and y axis. Assumes HALLCONF = 0x0C!
 _LSB_LOOKUP = (
-    # HALLCONF = 0xC (default)
-    (
-        # 5x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-        ((0.751, 1.210), (1.502, 2.420), (3.004, 4.840), (6.009, 9.680)),
-        # 4x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-        ((0.601, 0.968), (1.202, 1.936), (2.403, 3.872), (4.840, 7.744)),
-        # 3x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-        ((0.451, 0.726), (0.901, 1.452), (1.803, 2.904), (3.605, 5.808)),
-        # 2.5x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-        ((0.376, 0.605), (0.751, 1.210), (1.502, 2.420), (3.004, 4.840)),
-        # 2x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-        ((0.300, 0.484), (0.601, 0.968), (1.202, 1.936), (2.403, 3.872)),
-        # 1.667x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-        ((0.250, 0.403), (0.501, 0.807), (1.001, 1.613), (2.003, 3.227)),
-        # 1.333x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-        ((0.200, 0.323), (0.401, 0.645), (0.801, 1.291), (1.602, 2.581)),
-        # 1x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-        ((0.150, 0.242), (0.300, 0.484), (0.601, 0.968), (1.202, 1.936)),
-    ),
-    # HALLCONF = 0x0
-    (
-        # GAIN_SEL = 0, 5x gain
-        ((0.787, 1.267), (1.573, 2.534), (3.146, 5.068), (6.292, 10.137)),
-        # GAIN_SEL = 1, 4x gain
-        ((0.629, 1.014), (1.258, 2.027), (2.517, 4.055), (5.034, 8.109)),
-        # GAIN_SEL = 2, 3x gain
-        ((0.472, 0.760), (0.944, 1.521), (1.888, 3.041), (3.775, 6.082)),
-        # GAIN_SEL = 3, 2.5x gain
-        ((0.393, 0.634), (0.787, 1.267), (1.573, 2.534), (3.146, 5.068)),
-        # GAIN_SEL = 4, 2x gain
-        ((0.315, 0.507), (0.629, 1.014), (1.258, 2.027), (2.517, 4.055)),
-        # GAIN_SEL = 5, 1.667x gain
-        ((0.262, 0.422), (0.524, 0.845), (1.049, 1.689), (2.097, 3.379)),
-        # GAIN_SEL = 6, 1.333x gain
-        ((0.210, 0.338), (0.419, 0.676), (0.839, 1.352), (1.678, 2.703)),
-        # GAIN_SEL = 7, 1x gain
-        ((0.157, 0.253), (0.315, 0.507), (0.629, 1.014), (1.258, 2.027)),
-    ),
+    # 5x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
+    ((0.751, 1.210), (1.502, 2.420), (3.004, 4.840), (6.009, 9.680)),
+    # 4x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
+    ((0.601, 0.968), (1.202, 1.936), (2.403, 3.872), (4.840, 7.744)),
+    # 3x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
+    ((0.451, 0.726), (0.901, 1.452), (1.803, 2.904), (3.605, 5.808)),
+    # 2.5x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
+    ((0.376, 0.605), (0.751, 1.210), (1.502, 2.420), (3.004, 4.840)),
+    # 2x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
+    ((0.300, 0.484), (0.601, 0.968), (1.202, 1.936), (2.403, 3.872)),
+    # 1.667x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
+    ((0.250, 0.403), (0.501, 0.807), (1.001, 1.613), (2.003, 3.227)),
+    # 1.333x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
+    ((0.200, 0.323), (0.401, 0.645), (0.801, 1.291), (1.602, 2.581)),
+    # 1x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
+    ((0.150, 0.242), (0.300, 0.484), (0.601, 0.968), (1.202, 1.936)),
 )
 
 # Lookup table for conversion times for different filter and

From 180f0915cdbb02b22c202cb9b5f5a359c481078c Mon Sep 17 00:00:00 2001
From: PRC-SAK <Steve@PyxisRC.com>
Date: Tue, 2 Mar 2021 11:00:25 -0800
Subject: [PATCH 036/107] Handle multiple HALLCONF values

---
 adafruit_mlx90393.py | 74 +++++++++++++++++++++++++++++++-------------
 1 file changed, 53 insertions(+), 21 deletions(-)

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index 258c438..2740280 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -93,31 +93,55 @@
 OSR_2 = 0x2
 OSR_3 = 0x3
 
-_HALLCONF = const(0x0C)  # Hall plate spinning rate adjust.
+# Hall plate spinning rate adjustment
+# Must be 0x0C (default) or 0x00
+_HALLCONF = const(0x0C)
 
 STATUS_OK = 0x3
 
 # The lookup table below allows you to convert raw sensor data to uT
 # using the appropriate (gain/resolution-dependant) lsb-per-uT
 # coefficient below. Note that the z axis has a different coefficient
-# than the x and y axis. Assumes HALLCONF = 0x0C!
+# than the x and y axis.
 _LSB_LOOKUP = (
-    # 5x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-    ((0.751, 1.210), (1.502, 2.420), (3.004, 4.840), (6.009, 9.680)),
-    # 4x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-    ((0.601, 0.968), (1.202, 1.936), (2.403, 3.872), (4.840, 7.744)),
-    # 3x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-    ((0.451, 0.726), (0.901, 1.452), (1.803, 2.904), (3.605, 5.808)),
-    # 2.5x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-    ((0.376, 0.605), (0.751, 1.210), (1.502, 2.420), (3.004, 4.840)),
-    # 2x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-    ((0.300, 0.484), (0.601, 0.968), (1.202, 1.936), (2.403, 3.872)),
-    # 1.667x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-    ((0.250, 0.403), (0.501, 0.807), (1.001, 1.613), (2.003, 3.227)),
-    # 1.333x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-    ((0.200, 0.323), (0.401, 0.645), (0.801, 1.291), (1.602, 2.581)),
-    # 1x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
-    ((0.150, 0.242), (0.300, 0.484), (0.601, 0.968), (1.202, 1.936)),
+    # HALLCONF = 0x0C (default)
+    (
+        # 5x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
+        ((0.751, 1.210), (1.502, 2.420), (3.004, 4.840), (6.009, 9.680)),
+        # 4x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
+        ((0.601, 0.968), (1.202, 1.936), (2.403, 3.872), (4.840, 7.744)),
+        # 3x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
+        ((0.451, 0.726), (0.901, 1.452), (1.803, 2.904), (3.605, 5.808)),
+        # 2.5x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
+        ((0.376, 0.605), (0.751, 1.210), (1.502, 2.420), (3.004, 4.840)),
+        # 2x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
+        ((0.300, 0.484), (0.601, 0.968), (1.202, 1.936), (2.403, 3.872)),
+        # 1.667x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
+        ((0.250, 0.403), (0.501, 0.807), (1.001, 1.613), (2.003, 3.227)),
+        # 1.333x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
+        ((0.200, 0.323), (0.401, 0.645), (0.801, 1.291), (1.602, 2.581)),
+        # 1x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z)
+        ((0.150, 0.242), (0.300, 0.484), (0.601, 0.968), (1.202, 1.936)),
+    ),
+    # HALLCONF = 0x00
+    (
+        # GAIN_SEL = 0, 5x gain
+        ((0.787, 1.267), (1.573, 2.534), (3.146, 5.068), (6.292, 10.137)),
+        # GAIN_SEL = 1, 4x gain
+        ((0.629, 1.014), (1.258, 2.027), (2.517, 4.055), (5.034, 8.109)),
+        # GAIN_SEL = 2, 3x gain
+        ((0.472, 0.760), (0.944, 1.521), (1.888, 3.041), (3.775, 6.082)),
+        # GAIN_SEL = 3, 2.5x gain
+        ((0.393, 0.634), (0.787, 1.267), (1.573, 2.534), (3.146, 5.068)),
+        # GAIN_SEL = 4, 2x gain
+        ((0.315, 0.507), (0.629, 1.014), (1.258, 2.027), (2.517, 4.055)),
+        # GAIN_SEL = 5, 1.667x gain
+        ((0.262, 0.422), (0.524, 0.845), (1.049, 1.689), (2.097, 3.379)),
+        # GAIN_SEL = 6, 1.333x gain
+        ((0.210, 0.338), (0.419, 0.676), (0.839, 1.352), (1.678, 2.703)),
+        # GAIN_SEL = 7, 1x gain
+        ((0.157, 0.253), (0.315, 0.507), (0.629, 1.014), (1.258, 2.027)),
+    ),
 )
 
 # Lookup table for conversion times for different filter and
@@ -442,9 +466,17 @@ def magnetic(self):
         """
         x, y, z = self.read_data
 
+        # Check for valid HALLCONF value and set _LSB_LOOKUP index
+        if _HALLCONF == 0x0C:
+            hallconf_index = 0
+        elif _HALLCONF == 0x00:
+            hallconf_index = 1
+        else:
+            raise ValueError("Incorrect HALLCONF value, must be '0x0C' or '0x00'.")
+
         # Convert the raw integer values to uT based on gain and resolution
-        x *= _LSB_LOOKUP[self._gain_current][self._res_x][0]
-        y *= _LSB_LOOKUP[self._gain_current][self._res_y][0]
-        z *= _LSB_LOOKUP[self._gain_current][self._res_z][1]
+        x *= _LSB_LOOKUP[hallconf_index][self._gain_current][self._res_x][0]
+        y *= _LSB_LOOKUP[hallconf_index][self._gain_current][self._res_y][0]
+        z *= _LSB_LOOKUP[hallconf_index][self._gain_current][self._res_z][1]
 
         return x, y, z

From 2de115acb9608196ba69b9e8b97f0bdbdf79fb9a Mon Sep 17 00:00:00 2001
From: dherrada <dylan.herrada@adafruit.com>
Date: Tue, 2 Mar 2021 16:46:17 -0500
Subject: [PATCH 037/107] Removed pylint process from github workflow

Signed-off-by: dherrada <dylan.herrada@adafruit.com>
---
 .github/workflows/build.yml |  8 ++------
 .pre-commit-config.yaml     | 15 +++++++++++++++
 .pylintrc                   |  2 +-
 3 files changed, 18 insertions(+), 7 deletions(-)

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 59baa53..621d5ef 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -42,18 +42,14 @@ jobs:
       # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.)
       run: |
         source actions-ci/install.sh
-    - name: Pip install pylint, Sphinx, pre-commit
+    - name: Pip install Sphinx, pre-commit
       run: |
-        pip install --force-reinstall pylint Sphinx sphinx-rtd-theme pre-commit
+        pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit
     - name: Library version
       run: git describe --dirty --always --tags
     - name: Pre-commit hooks
       run: |
         pre-commit run --all-files
-    - name: PyLint
-      run: |
-        pylint $( find . -path './adafruit*.py' )
-        ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace $( find . -path "./examples/*.py" ))
     - name: Build assets
       run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location .
     - name: Archive bundles
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 07f886c..354c761 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -17,3 +17,18 @@ repos:
     -   id: check-yaml
     -   id: end-of-file-fixer
     -   id: trailing-whitespace
+-   repo: https://github.com/pycqa/pylint
+    rev: pylint-2.7.1
+    hooks:
+    -   id: pylint
+        name: pylint (library code)
+        types: [python]
+        exclude: "^(docs/|examples/|setup.py$)"
+-   repo: local
+    hooks:
+    -   id: pylint_examples
+        name: pylint (examples code)
+        description: Run pylint rules on "examples/*.py" files
+        entry: /usr/bin/env bash -c
+        args: ['([[ ! -d "examples" ]] || for example in $(find . -path "./examples/*.py"); do pylint --disable=missing-docstring,invalid-name $example; done)']
+        language: system
diff --git a/.pylintrc b/.pylintrc
index 5c31f66..9ed669e 100644
--- a/.pylintrc
+++ b/.pylintrc
@@ -250,7 +250,7 @@ ignore-comments=yes
 ignore-docstrings=yes
 
 # Ignore imports when computing similarities.
-ignore-imports=no
+ignore-imports=yes
 
 # Minimum lines number of a similarity.
 min-similarity-lines=4

From 03593015d5bed08def3be40c4b543abbf3257dea Mon Sep 17 00:00:00 2001
From: dherrada <dylan.herrada@adafruit.com>
Date: Tue, 2 Mar 2021 17:17:50 -0500
Subject: [PATCH 038/107] Re-added pylint install to build.yml

Signed-off-by: dherrada <dylan.herrada@adafruit.com>
---
 .github/workflows/build.yml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 621d5ef..3baf502 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -42,9 +42,9 @@ jobs:
       # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.)
       run: |
         source actions-ci/install.sh
-    - name: Pip install Sphinx, pre-commit
+    - name: Pip install pylint, Sphinx, pre-commit
       run: |
-        pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit
+        pip install --force-reinstall pylint Sphinx sphinx-rtd-theme pre-commit
     - name: Library version
       run: git describe --dirty --always --tags
     - name: Pre-commit hooks

From b18719876b842fa4b44aa3eb160977e9cff21a9a Mon Sep 17 00:00:00 2001
From: dherrada <dylan.herrada@adafruit.com>
Date: Fri, 19 Mar 2021 13:46:18 -0400
Subject: [PATCH 039/107] "Increase duplicate code check threshold "

---
 .pylintrc | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/.pylintrc b/.pylintrc
index 9ed669e..0238b90 100644
--- a/.pylintrc
+++ b/.pylintrc
@@ -22,8 +22,7 @@ ignore-patterns=
 #init-hook=
 
 # Use multiple processes to speed up Pylint.
-# jobs=1
-jobs=2
+jobs=1
 
 # List of plugins (as comma separated values of python modules names) to load,
 # usually to register additional checkers.
@@ -253,7 +252,7 @@ ignore-docstrings=yes
 ignore-imports=yes
 
 # Minimum lines number of a similarity.
-min-similarity-lines=4
+min-similarity-lines=12
 
 
 [BASIC]

From 54573b8261955bb7d70abede81e2e2a6943ec3eb Mon Sep 17 00:00:00 2001
From: jposada202020 <jquintana202020@gmail.com>
Date: Tue, 27 Apr 2021 11:39:48 -0400
Subject: [PATCH 040/107] improving_docs

---
 README.rst                      |  6 ++---
 adafruit_mlx90393.py            | 48 ++++++++++++++++++++++++++-------
 docs/index.rst                  |  4 +++
 examples/mlx90393_simpletest.py |  6 ++---
 4 files changed, 46 insertions(+), 18 deletions(-)

diff --git a/README.rst b/README.rst
index b1c907f..a43eb87 100644
--- a/README.rst
+++ b/README.rst
@@ -57,13 +57,11 @@ Usage Example
 .. code-block:: python3
 
     import time
-    import busio
     import board
-
     import adafruit_mlx90393
 
-    I2C_BUS = busio.I2C(board.SCL, board.SDA)
-    SENSOR = adafruit_mlx90393.MLX90393(I2C_BUS, gain=adafruit_mlx90393.GAIN_1X)
+    i2c = board.I2C()  # uses board.SCL and board.SDA
+    SENSOR = adafruit_mlx90393.MLX90393(i2c, gain=adafruit_mlx90393.GAIN_1X)
 
     while True:
         MX, MY, MZ = SENSOR.magnetic
diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index 2740280..5cca071 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -21,10 +21,11 @@
 **Software and Dependencies:**
 
 * Adafruit CircuitPython firmware for the supported boards:
-  https://github.com/adafruit/circuitpython/releases
-
+  https://circuitpython.org/downloads
 * Adafruit's Bus Device library:
   https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
+* Adafruit's Register library:
+  https://github.com/adafruit/Adafruit_CircuitPython_Register
 
 """
 
@@ -162,11 +163,36 @@
 class MLX90393:  # pylint: disable=too-many-instance-attributes
     """
     Driver for the MLX90393 magnetometer.
-    :param i2c_bus: The `busio.I2C` object to use. This is the only
-    required parameter.
-    :param int address: (optional) The I2C address of the device.
-    :param int gain: (optional) The gain level to apply.
-    :param bool debug: (optional) Enable debug output.
+
+    :param i2c_bus: The I2C bus the device is connected to
+    :param int address: The I2C device address. Defaults to :const:`0x0C`
+    :param int gain: The gain level to apply. Defaults to :const:`GAIN_1X`
+    :param bool debug: Enable debug output. Defaults to `False`
+
+
+    **Quickstart: Importing and using the device**
+
+        Here is an example of using the :class:`MLX90393` class.
+        First you will need to import the libraries to use the sensor
+
+        .. code-block:: python
+
+            import board
+            import adafruit_mlx90393
+
+        Once this is done you can define your `board.I2C` object and define your sensor object
+
+        .. code-block:: python
+
+            i2c = board.I2C()  # uses board.SCL and board.SDA
+            SENSOR = adafruit_mlx90393.MLX90393(i2c)
+
+        Now you have access to the :attr:`magnetic` attribute
+
+        .. code-block:: python
+
+            MX, MY, MZ = SENSOR.magnetic
+
     """
 
     def __init__(
@@ -208,8 +234,10 @@ def _transceive(self, payload, rxlen=0):
         """
         Writes the specified 'payload' to the sensor
         Returns the results of the write attempt.
-        :param bytearray payload: The byte array to write to the sensor
-        :param rxlen: (optional) The numbers of bytes to read back (default=0)
+
+        :param bytes payload: The byte array to write to the sensor
+        :param int rxlen: numbers of bytes to read back. Defaults to :const:`0`
+
         """
         # Read the response (+1 to account for the mandatory status byte!)
         data = bytearray(rxlen + 1)
@@ -351,7 +379,7 @@ def oversampling(self, level):
 
     def display_status(self):
         """
-        Prints out the content of the last status byte in a human-readble
+        Prints out the content of the last status byte in a human-readable
         format.
         """
         avail = 0
diff --git a/docs/index.rst b/docs/index.rst
index 7341ccf..f44c90d 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -23,9 +23,13 @@ Table of Contents
 .. toctree::
     :caption: Tutorials
 
+    Adafruit Wide-Range Triple-axis Magnetometer - MLX90393 Learning Guide <https://learn.adafruit.com/mlx90393-wide-range-3-axis-magnetometer>
+
 .. toctree::
     :caption: Related Products
 
+    Adafruit Wide-Range Triple-axis Magnetometer - MLX90393 <https://www.adafruit.com/product/4022>
+
 .. toctree::
     :caption: Other Links
 
diff --git a/examples/mlx90393_simpletest.py b/examples/mlx90393_simpletest.py
index c4a2b0e..47650a6 100755
--- a/examples/mlx90393_simpletest.py
+++ b/examples/mlx90393_simpletest.py
@@ -2,13 +2,11 @@
 # SPDX-License-Identifier: MIT
 
 import time
-import busio
 import board
-
 import adafruit_mlx90393
 
-I2C_BUS = busio.I2C(board.SCL, board.SDA)
-SENSOR = adafruit_mlx90393.MLX90393(I2C_BUS, gain=adafruit_mlx90393.GAIN_1X)
+i2c = board.I2C()  # uses board.SCL and board.SDA
+SENSOR = adafruit_mlx90393.MLX90393(i2c, gain=adafruit_mlx90393.GAIN_1X)
 
 while True:
     MX, MY, MZ = SENSOR.magnetic

From 8aa224b561030330451c0ddc1a26aa4909c88897 Mon Sep 17 00:00:00 2001
From: dherrada <dylan.herrada@adafruit.com>
Date: Wed, 19 May 2021 13:32:42 -0400
Subject: [PATCH 041/107] Added pull request template

Signed-off-by: dherrada <dylan.herrada@adafruit.com>
---
 .../adafruit_circuitpython_pr.md                    | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 .github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md

diff --git a/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md
new file mode 100644
index 0000000..71ef8f8
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md
@@ -0,0 +1,13 @@
+# SPDX-FileCopyrightText: 2021 Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+Thank you for contributing! Before you submit a pull request, please read the following.
+
+Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://circuitpython.readthedocs.io/en/latest/docs/design_guide.html
+
+If your changes are to documentation, please verify that the documentation builds locally by following the steps found here: https://adafru.it/build-docs
+
+Before submitting the pull request, make sure you've run Pylint and Black locally on your code. You can do this manually or using pre-commit. Instructions are available here: https://adafru.it/check-your-code
+
+Please remove all of this text before submitting. Include an explanation or list of changes included in your PR, as well as, if applicable, a link to any related issues.

From 0db62df3d6b779cc1eb35e4960c79478d71494a6 Mon Sep 17 00:00:00 2001
From: dherrada <dylan.herrada@adafruit.com>
Date: Wed, 19 May 2021 13:35:18 -0400
Subject: [PATCH 042/107] Added help text and problem matcher

Signed-off-by: dherrada <dylan.herrada@adafruit.com>
---
 .github/workflows/build.yml             |  2 ++
 .github/workflows/failure-help-text.yml | 19 +++++++++++++++++++
 2 files changed, 21 insertions(+)
 create mode 100644 .github/workflows/failure-help-text.yml

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 3baf502..0ab7182 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -71,3 +71,5 @@ jobs:
         python setup.py sdist
         python setup.py bdist_wheel --universal
         twine check dist/*
+    - name: Setup problem matchers
+      uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1
diff --git a/.github/workflows/failure-help-text.yml b/.github/workflows/failure-help-text.yml
new file mode 100644
index 0000000..0b1194f
--- /dev/null
+++ b/.github/workflows/failure-help-text.yml
@@ -0,0 +1,19 @@
+# SPDX-FileCopyrightText: 2021 Scott Shawcroft for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+name: Failure help text
+
+on:
+  workflow_run:
+    workflows: ["Build CI"]
+    types:
+      - completed
+
+jobs:
+  post-help:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'failure' && github.event.workflow_run.event == 'pull_request' }}
+    steps:
+    - name: Post comment to help
+      uses: adafruit/circuitpython-action-library-ci-failed@v1

From 4d5597d7ff278cd2f9d78006271a15c760264454 Mon Sep 17 00:00:00 2001
From: dherrada <dylan.herrada@adafruit.com>
Date: Mon, 24 May 2021 09:54:31 -0400
Subject: [PATCH 043/107] Moved CI to Python 3.7

Signed-off-by: dherrada <dylan.herrada@adafruit.com>
---
 .github/workflows/build.yml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 0ab7182..c4c975d 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -22,10 +22,10 @@ jobs:
         awk -F '\/' '{ print tolower($2) }' |
         tr '_' '-'
         )
-    - name: Set up Python 3.6
+    - name: Set up Python 3.7
       uses: actions/setup-python@v1
       with:
-        python-version: 3.6
+        python-version: 3.7
     - name: Versions
       run: |
         python3 --version

From d1cbf5d68cb893304f432e2deaee1f4c81094c2a Mon Sep 17 00:00:00 2001
From: dherrada <dylan.herrada@adafruit.com>
Date: Mon, 7 Jun 2021 12:32:30 -0400
Subject: [PATCH 044/107] Moved default branch to main

---
 README.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.rst b/README.rst
index a43eb87..a1f381a 100644
--- a/README.rst
+++ b/README.rst
@@ -78,7 +78,7 @@ Contributing
 ============
 
 Contributions are welcome! Please read our `Code of Conduct
-<https://github.com/adafruit/Adafruit_CircuitPython_MLX90393/blob/master/CODE_OF_CONDUCT.md>`_
+<https://github.com/adafruit/Adafruit_CircuitPython_MLX90393/blob/main/CODE_OF_CONDUCT.md>`_
 before contributing to help this project stay welcoming.
 
 Documentation

From 0a47e5815d5b50492cfe535d83c007ac1358f835 Mon Sep 17 00:00:00 2001
From: dherrada <dylan.herrada@adafruit.com>
Date: Thu, 23 Sep 2021 17:52:55 -0400
Subject: [PATCH 045/107] Globally disabled consider-using-f-string pylint
 check

Signed-off-by: dherrada <dylan.herrada@adafruit.com>
---
 .pre-commit-config.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 354c761..8810708 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -30,5 +30,5 @@ repos:
         name: pylint (examples code)
         description: Run pylint rules on "examples/*.py" files
         entry: /usr/bin/env bash -c
-        args: ['([[ ! -d "examples" ]] || for example in $(find . -path "./examples/*.py"); do pylint --disable=missing-docstring,invalid-name $example; done)']
+        args: ['([[ ! -d "examples" ]] || for example in $(find . -path "./examples/*.py"); do pylint --disable=missing-docstring,invalid-name,consider-using-f-string $example; done)']
         language: system

From 5aadc83315ee60764491531772124f088b5b37ee Mon Sep 17 00:00:00 2001
From: foamyguy <foamyguy@gmail.com>
Date: Mon, 25 Oct 2021 11:19:18 -0500
Subject: [PATCH 046/107] add docs link to readme

---
 README.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/README.rst b/README.rst
index a1f381a..f5e44ab 100644
--- a/README.rst
+++ b/README.rst
@@ -74,6 +74,11 @@ Usage Example
             SENSOR.display_status()
         time.sleep(1.0)
 
+Documentation
+=============
+
+API documentation for this library can be found on `Read the Docs <https://circuitpython.readthedocs.io/projects/mlx90393/en/latest/>`_.
+
 Contributing
 ============
 

From 55d29df9874900b933897f245d1132cac5b277a9 Mon Sep 17 00:00:00 2001
From: dherrada <dylan.herrada@adafruit.com>
Date: Wed, 3 Nov 2021 14:40:16 -0400
Subject: [PATCH 047/107] PATCH Pylint and readthedocs patch test

Signed-off-by: dherrada <dylan.herrada@adafruit.com>
---
 .github/workflows/build.yml |  4 ++--
 .pre-commit-config.yaml     | 26 +++++++++++++++++---------
 .pylintrc                   |  2 +-
 .readthedocs.yml            |  2 +-
 docs/requirements.txt       |  5 +++++
 5 files changed, 26 insertions(+), 13 deletions(-)
 create mode 100644 docs/requirements.txt

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index c4c975d..ca35544 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -42,9 +42,9 @@ jobs:
       # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.)
       run: |
         source actions-ci/install.sh
-    - name: Pip install pylint, Sphinx, pre-commit
+    - name: Pip install Sphinx, pre-commit
       run: |
-        pip install --force-reinstall pylint Sphinx sphinx-rtd-theme pre-commit
+        pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit
     - name: Library version
       run: git describe --dirty --always --tags
     - name: Pre-commit hooks
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 8810708..1b9fadc 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -18,17 +18,25 @@ repos:
     -   id: end-of-file-fixer
     -   id: trailing-whitespace
 -   repo: https://github.com/pycqa/pylint
-    rev: pylint-2.7.1
+    rev: v2.11.1
     hooks:
     -   id: pylint
         name: pylint (library code)
         types: [python]
-        exclude: "^(docs/|examples/|setup.py$)"
--   repo: local
-    hooks:
-    -   id: pylint_examples
-        name: pylint (examples code)
+        args:
+          - --disable=consider-using-f-string
+        exclude: "^(docs/|examples/|tests/|setup.py$)"
+    -   id: pylint
+        name: pylint (example code)
         description: Run pylint rules on "examples/*.py" files
-        entry: /usr/bin/env bash -c
-        args: ['([[ ! -d "examples" ]] || for example in $(find . -path "./examples/*.py"); do pylint --disable=missing-docstring,invalid-name,consider-using-f-string $example; done)']
-        language: system
+        types: [python]
+        files: "^examples/"
+        args:
+        - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code
+    -   id: pylint
+        name: pylint (test code)
+        description: Run pylint rules on "tests/*.py" files
+        types: [python]
+        files: "^tests/"
+        args:
+        - --disable=missing-docstring,consider-using-f-string,duplicate-code
diff --git a/.pylintrc b/.pylintrc
index 0238b90..e78bad2 100644
--- a/.pylintrc
+++ b/.pylintrc
@@ -252,7 +252,7 @@ ignore-docstrings=yes
 ignore-imports=yes
 
 # Minimum lines number of a similarity.
-min-similarity-lines=12
+min-similarity-lines=4
 
 
 [BASIC]
diff --git a/.readthedocs.yml b/.readthedocs.yml
index ffa84c4..49dcab3 100644
--- a/.readthedocs.yml
+++ b/.readthedocs.yml
@@ -4,4 +4,4 @@
 
 python:
     version: 3
-requirements_file: requirements.txt
+requirements_file: docs/requirements.txt
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 0000000..88e6733
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,5 @@
+# SPDX-FileCopyrightText: 2021 Kattni Rembor for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense
+
+sphinx>=4.0.0

From addde89979adef6f2a5297db54425e3f7365f1b7 Mon Sep 17 00:00:00 2001
From: dherrada <dylan.herrada@adafruit.com>
Date: Fri, 5 Nov 2021 14:49:30 -0400
Subject: [PATCH 048/107] Disabled unspecified-encoding pylint check

Signed-off-by: dherrada <dylan.herrada@adafruit.com>
---
 .pylintrc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.pylintrc b/.pylintrc
index e78bad2..cfd1c41 100644
--- a/.pylintrc
+++ b/.pylintrc
@@ -55,7 +55,7 @@ confidence=
 # no Warning level messages displayed, use"--disable=all --enable=classes
 # --disable=W"
 # disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call
-disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation
+disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation,unspecified-encoding
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option

From e0e8b0734a884d3c7b6359c84f0d617d5f3b6fae Mon Sep 17 00:00:00 2001
From: dherrada <dylan.herrada@adafruit.com>
Date: Tue, 9 Nov 2021 13:31:14 -0500
Subject: [PATCH 049/107] Updated readthedocs file

Signed-off-by: dherrada <dylan.herrada@adafruit.com>
---
 .readthedocs.yaml | 15 +++++++++++++++
 .readthedocs.yml  |  7 -------
 2 files changed, 15 insertions(+), 7 deletions(-)
 create mode 100644 .readthedocs.yaml
 delete mode 100644 .readthedocs.yml

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 0000000..95ec218
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,15 @@
+# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense
+
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+python:
+  version: "3.6"
+  install:
+    - requirements: docs/requirements.txt
+    - requirements: requirements.txt
diff --git a/.readthedocs.yml b/.readthedocs.yml
deleted file mode 100644
index 49dcab3..0000000
--- a/.readthedocs.yml
+++ /dev/null
@@ -1,7 +0,0 @@
-# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
-#
-# SPDX-License-Identifier: Unlicense
-
-python:
-    version: 3
-requirements_file: docs/requirements.txt

From b9b86ba092b9f75873a206d2108d8649c2152b98 Mon Sep 17 00:00:00 2001
From: foamyguy <foamyguy@gmail.com>
Date: Tue, 23 Nov 2021 13:05:04 -0600
Subject: [PATCH 050/107] update rtd py version

---
 .readthedocs.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index 95ec218..1335112 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -9,7 +9,7 @@
 version: 2
 
 python:
-  version: "3.6"
+  version: "3.7"
   install:
     - requirements: docs/requirements.txt
     - requirements: requirements.txt

From 379b6cf99a0e814267a883014d12505bfd19e077 Mon Sep 17 00:00:00 2001
From: Dan Halbert <halbert@adafruit.com>
Date: Wed, 22 Dec 2021 09:36:58 -0500
Subject: [PATCH 051/107] Remove obsolete reference to ustruct

---
 adafruit_mlx90393.py | 7 +------
 1 file changed, 1 insertion(+), 6 deletions(-)

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index 5cca071..86b5154 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -28,14 +28,9 @@
   https://github.com/adafruit/Adafruit_CircuitPython_Register
 
 """
-
+import struct
 import time
 
-try:
-    import struct
-except ImportError:
-    import ustruct as struct
-
 from adafruit_bus_device.i2c_device import I2CDevice
 from micropython import const
 

From 3404ab400ca8b2f8d4edc1f70c79a3b3ff31b2ec Mon Sep 17 00:00:00 2001
From: dherrada <dylan.herrada@adafruit.com>
Date: Thu, 13 Jan 2022 16:27:30 -0500
Subject: [PATCH 052/107] First part of patch

Signed-off-by: dherrada <dylan.herrada@adafruit.com>
---
 .../PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md    | 2 +-
 .github/workflows/build.yml                               | 6 +++---
 .github/workflows/release.yml                             | 8 ++++----
 .readthedocs.yaml                                         | 2 +-
 4 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md
index 71ef8f8..8de294e 100644
--- a/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md
+++ b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md
@@ -4,7 +4,7 @@
 
 Thank you for contributing! Before you submit a pull request, please read the following.
 
-Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://circuitpython.readthedocs.io/en/latest/docs/design_guide.html
+Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://docs.circuitpython.org/en/latest/docs/design_guide.html
 
 If your changes are to documentation, please verify that the documentation builds locally by following the steps found here: https://adafru.it/build-docs
 
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index ca35544..474520d 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -22,10 +22,10 @@ jobs:
         awk -F '\/' '{ print tolower($2) }' |
         tr '_' '-'
         )
-    - name: Set up Python 3.7
-      uses: actions/setup-python@v1
+    - name: Set up Python 3.x
+      uses: actions/setup-python@v2
       with:
-        python-version: 3.7
+        python-version: "3.x"
     - name: Versions
       run: |
         python3 --version
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 6d0015a..a65e5de 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -24,10 +24,10 @@ jobs:
         awk -F '\/' '{ print tolower($2) }' |
         tr '_' '-'
         )
-    - name: Set up Python 3.6
-      uses: actions/setup-python@v1
+    - name: Set up Python 3.x
+      uses: actions/setup-python@v2
       with:
-        python-version: 3.6
+        python-version: "3.x"
     - name: Versions
       run: |
         python3 --version
@@ -67,7 +67,7 @@ jobs:
         echo ::set-output name=setup-py::$( find . -wholename './setup.py' )
     - name: Set up Python
       if: contains(steps.need-pypi.outputs.setup-py, 'setup.py')
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v2
       with:
         python-version: '3.x'
     - name: Install dependencies
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index 1335112..f8b2891 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -9,7 +9,7 @@
 version: 2
 
 python:
-  version: "3.7"
+  version: "3.x"
   install:
     - requirements: docs/requirements.txt
     - requirements: requirements.txt

From 8568bb27be6179188d5362b154b2cf1e46684429 Mon Sep 17 00:00:00 2001
From: dherrada <dylan.herrada@adafruit.com>
Date: Mon, 24 Jan 2022 16:46:17 -0500
Subject: [PATCH 053/107] Updated docs link, updated python docs link, updated
 setup.py

---
 README.rst     | 4 ++--
 docs/conf.py   | 8 ++++----
 docs/index.rst | 2 +-
 setup.py       | 2 --
 4 files changed, 7 insertions(+), 9 deletions(-)

diff --git a/README.rst b/README.rst
index f5e44ab..5d77b3d 100644
--- a/README.rst
+++ b/README.rst
@@ -2,7 +2,7 @@ Introduction
 ============
 
 .. image:: https://readthedocs.org/projects/adafruit-circuitpython-mlx90393/badge/?version=latest
-    :target: https://circuitpython.readthedocs.io/projects/mlx90393/en/latest/
+    :target: https://docs.circuitpython.org/projects/mlx90393/en/latest/
     :alt: Documentation Status
 
 .. image:: https://img.shields.io/discord/327254708534116352.svg
@@ -77,7 +77,7 @@ Usage Example
 Documentation
 =============
 
-API documentation for this library can be found on `Read the Docs <https://circuitpython.readthedocs.io/projects/mlx90393/en/latest/>`_.
+API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/mlx90393/en/latest/>`_.
 
 Contributing
 ============
diff --git a/docs/conf.py b/docs/conf.py
index 0cff00b..1f89f2b 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -29,16 +29,16 @@
 
 
 intersphinx_mapping = {
-    "python": ("https://docs.python.org/3.4", None),
+    "python": ("https://docs.python.org/3", None),
     "BusDevice": (
-        "https://circuitpython.readthedocs.io/projects/busdevice/en/latest/",
+        "https://docs.circuitpython.org/projects/busdevice/en/latest/",
         None,
     ),
     "Register": (
-        "https://circuitpython.readthedocs.io/projects/register/en/latest/",
+        "https://docs.circuitpython.org/projects/register/en/latest/",
         None,
     ),
-    "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None),
+    "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None),
 }
 
 # Add any paths that contain templates here, relative to this directory.
diff --git a/docs/index.rst b/docs/index.rst
index f44c90d..81c4c0c 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -34,7 +34,7 @@ Table of Contents
     :caption: Other Links
 
     Download <https://github.com/adafruit/CircuitPython_Adafruit_CircuitPython_MLX90393/releases/latest>
-    CircuitPython Reference Documentation <https://circuitpython.readthedocs.io>
+    CircuitPython Reference Documentation <https://docs.circuitpython.org>
     CircuitPython Support Forum <https://forums.adafruit.com/viewforum.php?f=60>
     Discord Chat <https://adafru.it/discord>
     Adafruit Learning System <https://learn.adafruit.com>
diff --git a/setup.py b/setup.py
index e00bc79..df0492c 100644
--- a/setup.py
+++ b/setup.py
@@ -45,8 +45,6 @@
         "Topic :: System :: Hardware",
         "License :: OSI Approved :: MIT License",
         "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.4",
-        "Programming Language :: Python :: 3.5",
     ],
     # What does your project relate to?
     keywords="adafruit three-axis magnetometer magnet mlx90393 hardware micropython circuitpython",

From 2fd9d64cf91a7eb5d2845c6a08cebfaaaf799514 Mon Sep 17 00:00:00 2001
From: Alec Delaney <tekktrik@gmail.com>
Date: Wed, 9 Feb 2022 13:02:55 -0500
Subject: [PATCH 054/107] Consolidate Documentation sections of README

---
 README.rst | 7 ++-----
 1 file changed, 2 insertions(+), 5 deletions(-)

diff --git a/README.rst b/README.rst
index 5d77b3d..4f4e545 100644
--- a/README.rst
+++ b/README.rst
@@ -79,14 +79,11 @@ Documentation
 
 API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/mlx90393/en/latest/>`_.
 
+For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
+
 Contributing
 ============
 
 Contributions are welcome! Please read our `Code of Conduct
 <https://github.com/adafruit/Adafruit_CircuitPython_MLX90393/blob/main/CODE_OF_CONDUCT.md>`_
 before contributing to help this project stay welcoming.
-
-Documentation
-=============
-
-For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.

From 1ebe0827f75168585336c1ffe57d52c7cb6d4d64 Mon Sep 17 00:00:00 2001
From: dherrada <dylan.herrada@adafruit.com>
Date: Mon, 14 Feb 2022 15:35:02 -0500
Subject: [PATCH 055/107] Fixed readthedocs build

Signed-off-by: dherrada <dylan.herrada@adafruit.com>
---
 .readthedocs.yaml | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index f8b2891..33c2a61 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -8,8 +8,12 @@
 # Required
 version: 2
 
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3"
+
 python:
-  version: "3.x"
   install:
     - requirements: docs/requirements.txt
     - requirements: requirements.txt

From 977d4355924b7be71e30ffcefd6e671d23e5e3f7 Mon Sep 17 00:00:00 2001
From: Alec Delaney <tekktrik@gmail.com>
Date: Thu, 24 Mar 2022 15:29:08 -0400
Subject: [PATCH 056/107] Add type annotations

---
 adafruit_mlx90393.py | 69 ++++++++++++++++++++++++--------------------
 1 file changed, 38 insertions(+), 31 deletions(-)

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index 86b5154..9403fb2 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -34,6 +34,13 @@
 from adafruit_bus_device.i2c_device import I2CDevice
 from micropython import const
 
+try:
+    from typing import Tuple
+    from circuitpython_typing import ReadableBuffer
+    from busio import I2C
+except ImportError:
+    pass
+
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_MLX90393.git"
 
@@ -192,14 +199,14 @@ class MLX90393:  # pylint: disable=too-many-instance-attributes
 
     def __init__(
         self,
-        i2c_bus,
-        address=0x0C,
-        gain=GAIN_1X,
-        resolution=RESOLUTION_16,
-        filt=FILTER_7,
-        oversampling=OSR_3,
-        debug=False,
-    ):  # pylint: disable=too-many-arguments
+        i2c_bus: I2C,
+        address: int = 0x0C,
+        gain: int = GAIN_1X,
+        resolution: int = RESOLUTION_16,
+        filt: int = FILTER_7,
+        oversampling: int = OSR_3,
+        debug: bool = False,
+    ) -> None:  # pylint: disable=too-many-arguments
         self.i2c_device = I2CDevice(i2c_bus, address)
         self._debug = debug
         self._status_last = 0
@@ -225,12 +232,12 @@ def __init__(
         # Set gain to the supplied level
         self.gain = self._gain_current
 
-    def _transceive(self, payload, rxlen=0):
+    def _transceive(self, payload: ReadableBuffer, rxlen: int = 0) -> bytearray:
         """
         Writes the specified 'payload' to the sensor
         Returns the results of the write attempt.
 
-        :param bytes payload: The byte array to write to the sensor
+        :param ReadableBuffer payload: The byte array to write to the sensor
         :param int rxlen: numbers of bytes to read back. Defaults to :const:`0`
 
         """
@@ -266,21 +273,21 @@ def _transceive(self, payload, rxlen=0):
         return data
 
     @property
-    def last_status(self):
+    def last_status(self) -> int:
         """
         The last status byte received from the sensor.
         """
         return self._status_last
 
     @property
-    def gain(self):
+    def gain(self) -> int:
         """
         The gain setting for the device.
         """
         return self._gain_current
 
     @gain.setter
-    def gain(self, value):
+    def gain(self, value: int) -> None:
         if value > GAIN_1X or value < GAIN_5X:
             raise ValueError("Invalid GAIN setting")
         if self._debug:
@@ -298,36 +305,36 @@ def gain(self, value):
         )
 
     @property
-    def resolution_x(self):
+    def resolution_x(self) -> int:
         """The X axis resolution."""
         return self._res_x
 
     @resolution_x.setter
-    def resolution_x(self, resolution):
+    def resolution_x(self, resolution: int) -> None:
         self._set_resolution(0, resolution)
         self._res_x = resolution
 
     @property
-    def resolution_y(self):
+    def resolution_y(self) -> int:
         """The Y axis resolution."""
         return self._res_y
 
     @resolution_y.setter
-    def resolution_y(self, resolution):
+    def resolution_y(self, resolution: int) -> None:
         self._set_resolution(1, resolution)
         self._res_y = resolution
 
     @property
-    def resolution_z(self):
+    def resolution_z(self) -> int:
         """The Z axis resolution."""
         return self._res_z
 
     @resolution_z.setter
-    def resolution_z(self, resolution):
+    def resolution_z(self, resolution: int) -> None:
         self._set_resolution(2, resolution)
         self._res_z = resolution
 
-    def _set_resolution(self, axis, resolution):
+    def _set_resolution(self, axis: int, resolution: int) -> None:
         if resolution not in (
             RESOLUTION_16,
             RESOLUTION_17,
@@ -343,12 +350,12 @@ def _set_resolution(self, axis, resolution):
         self.write_reg(_CMD_REG_CONF3, reg)
 
     @property
-    def filter(self):
+    def filter(self) -> int:
         """The filter level."""
         return self._filter
 
     @filter.setter
-    def filter(self, level):
+    def filter(self, level: int) -> None:
         if level not in range(8):
             raise ValueError("Incorrect filter level.")
         reg = self.read_reg(_CMD_REG_CONF3)
@@ -358,12 +365,12 @@ def filter(self, level):
         self._filter = level
 
     @property
-    def oversampling(self):
+    def oversampling(self) -> int:
         """The oversampling level."""
         return self._osr
 
     @oversampling.setter
-    def oversampling(self, level):
+    def oversampling(self, level: int) -> None:
         if level not in range(4):
             raise ValueError("Incorrect oversampling level.")
         reg = self.read_reg(_CMD_REG_CONF3)
@@ -372,7 +379,7 @@ def oversampling(self, level):
         self.write_reg(_CMD_REG_CONF3, reg)
         self._osr = level
 
-    def display_status(self):
+    def display_status(self) -> None:
         """
         Prints out the content of the last status byte in a human-readable
         format.
@@ -389,7 +396,7 @@ def display_status(self):
         print("Reset status             :", (self._status_last & (1 << 2)) > 0)
         print("Response bytes available :", avail)
 
-    def read_reg(self, reg):
+    def read_reg(self, reg: int) -> int:
         """
         Gets the current value of the specified register.
         """
@@ -411,7 +418,7 @@ def read_reg(self, reg):
             print("\t  Status :", hex(data[0]))
         return val
 
-    def write_reg(self, reg, value):
+    def write_reg(self, reg: int, value: int) -> None:
         """
         Writes the 16-bit value to the supplied register.
         """
@@ -426,7 +433,7 @@ def write_reg(self, reg, value):
             )
         )
 
-    def reset(self):
+    def reset(self) -> None:
         """
         Performs a software reset of the sensor.
         """
@@ -442,7 +449,7 @@ def reset(self):
         return self._status_last
 
     @property
-    def read_data(self):
+    def read_data(self) -> Tuple[int, int, int]:
         """
         Reads a single X/Y/Z sample from the magnetometer.
         """
@@ -469,7 +476,7 @@ def read_data(self):
         return m_x, m_y, m_z
 
     # pylint: disable=no-self-use
-    def _unpack_axis_data(self, resolution, data):
+    def _unpack_axis_data(self, resolution: int, data: ReadableBuffer) -> int:
         # see datasheet
         if resolution == RESOLUTION_19:
             (value,) = struct.unpack(">H", data)
@@ -482,7 +489,7 @@ def _unpack_axis_data(self, resolution, data):
         return value
 
     @property
-    def magnetic(self):
+    def magnetic(self) -> Tuple[float, float, float]:
         """
         The processed magnetometer sensor values.
         A 3-tuple of X, Y, Z axis values in microteslas that are signed floats.

From 566628f9758a4b0e4426259411fcc533847daf3e Mon Sep 17 00:00:00 2001
From: Alec Delaney <tekktrik@gmail.com>
Date: Thu, 24 Mar 2022 15:32:36 -0400
Subject: [PATCH 057/107] Add additional documentation to docstrings

---
 adafruit_mlx90393.py | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index 9403fb2..2e4de91 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -169,6 +169,9 @@ class MLX90393:  # pylint: disable=too-many-instance-attributes
     :param i2c_bus: The I2C bus the device is connected to
     :param int address: The I2C device address. Defaults to :const:`0x0C`
     :param int gain: The gain level to apply. Defaults to :const:`GAIN_1X`
+    :param int resolution: The resolution level to use.  Defaults to :const:`RESOLUTION_16`
+    :param int filt: The filter to use. Defaults to :const:`FILTER_7`
+    :param int oversampling: The oversampleing setting to use. Defaults to :const:`OSR_3`
     :param bool debug: Enable debug output. Defaults to `False`
 
 
@@ -399,6 +402,8 @@ def display_status(self) -> None:
     def read_reg(self, reg: int) -> int:
         """
         Gets the current value of the specified register.
+
+        :param int reg: The register to read
         """
         # Write 'value' to the specified register
         payload = bytes([_CMD_RR, reg << 2])
@@ -421,6 +426,9 @@ def read_reg(self, reg: int) -> int:
     def write_reg(self, reg: int, value: int) -> None:
         """
         Writes the 16-bit value to the supplied register.
+
+        :param int reg: The register to write to
+        :param int value: The value to write to the register
         """
         self._transceive(
             bytes(

From 2d889a4afe7d150834f486b6f5a5444afb786208 Mon Sep 17 00:00:00 2001
From: Alec Delaney <tekktrik@gmail.com>
Date: Thu, 24 Mar 2022 15:33:39 -0400
Subject: [PATCH 058/107] Reformatted and linted

---
 adafruit_mlx90393.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index 2e4de91..c95eed8 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -200,7 +200,7 @@ class MLX90393:  # pylint: disable=too-many-instance-attributes
 
     """
 
-    def __init__(
+    def __init__(  # pylint: disable=too-many-arguments
         self,
         i2c_bus: I2C,
         address: int = 0x0C,
@@ -209,7 +209,7 @@ def __init__(
         filt: int = FILTER_7,
         oversampling: int = OSR_3,
         debug: bool = False,
-    ) -> None:  # pylint: disable=too-many-arguments
+    ) -> None:
         self.i2c_device = I2CDevice(i2c_bus, address)
         self._debug = debug
         self._status_last = 0

From cf7356b53ab31a63a3b053aebada5b7a1076a1e8 Mon Sep 17 00:00:00 2001
From: Alec Delaney <tekktrik@gmail.com>
Date: Thu, 24 Mar 2022 15:39:00 -0400
Subject: [PATCH 059/107] Add circuitpython_typing and Blinka>=7.0.0
 dependencies

---
 requirements.txt | 3 ++-
 setup.py         | 6 +++++-
 2 files changed, 7 insertions(+), 2 deletions(-)

diff --git a/requirements.txt b/requirements.txt
index f675e3b..5b38a4c 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -2,5 +2,6 @@
 #
 # SPDX-License-Identifier: Unlicense
 
-Adafruit-Blinka
+Adafruit-Blinka>=7.0.0
 adafruit-circuitpython-busdevice
+adaruit-circuitpython-typing
diff --git a/setup.py b/setup.py
index df0492c..0a79be7 100644
--- a/setup.py
+++ b/setup.py
@@ -34,7 +34,11 @@
     # Author details
     author="Adafruit Industries",
     author_email="circuitpython@adafruit.com",
-    install_requires=["Adafruit-Blinka", "adafruit-circuitpython-busdevice"],
+    install_requires=[
+        "Adafruit-Blinka>=7.0.0",
+        "adafruit-circuitpython-busdevice",
+        "adafruit-circuitpython-typing"
+    ],
     # Choose your license
     license="MIT",
     # See https://pypi.python.org/pypi?%3Aaction=list_classifiers

From 3ffabf0b4ec7561e48b2f2ffcceee7eba5f7f2dc Mon Sep 17 00:00:00 2001
From: Alec Delaney <tekktrik@gmail.com>
Date: Thu, 24 Mar 2022 15:39:15 -0400
Subject: [PATCH 060/107] Reformatted per pre-commit

---
 setup.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/setup.py b/setup.py
index 0a79be7..5e62bc4 100644
--- a/setup.py
+++ b/setup.py
@@ -37,7 +37,7 @@
     install_requires=[
         "Adafruit-Blinka>=7.0.0",
         "adafruit-circuitpython-busdevice",
-        "adafruit-circuitpython-typing"
+        "adafruit-circuitpython-typing",
     ],
     # Choose your license
     license="MIT",

From 37d4c2e17be9bc0f34b204d3ba910af45ab14f9e Mon Sep 17 00:00:00 2001
From: Alec Delaney <tekktrik@gmail.com>
Date: Thu, 24 Mar 2022 15:43:14 -0400
Subject: [PATCH 061/107] Correct typo in requirements.txt

---
 requirements.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/requirements.txt b/requirements.txt
index 5b38a4c..5955484 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -4,4 +4,4 @@
 
 Adafruit-Blinka>=7.0.0
 adafruit-circuitpython-busdevice
-adaruit-circuitpython-typing
+adafruit-circuitpython-typing

From 5ada99f34ffeebb70f7f81a8661a63eab7b05c0b Mon Sep 17 00:00:00 2001
From: Kattni Rembor <kattni@adafruit.com>
Date: Mon, 28 Mar 2022 15:52:04 -0400
Subject: [PATCH 062/107] Update Black to latest.

Signed-off-by: Kattni Rembor <kattni@adafruit.com>
---
 .pre-commit-config.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 1b9fadc..7467c1d 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -4,7 +4,7 @@
 
 repos:
 -   repo: https://github.com/python/black
-    rev: 20.8b1
+    rev: 22.3.0
     hooks:
     - id: black
 -   repo: https://github.com/fsfe/reuse-tool

From 971fbb482ab26d7e539f89831e56bed2e4db4b1c Mon Sep 17 00:00:00 2001
From: evaherrada <eva.herrada@adafruit.com>
Date: Thu, 21 Apr 2022 15:00:27 -0400
Subject: [PATCH 063/107] Updated gitignore

Signed-off-by: evaherrada <eva.herrada@adafruit.com>
---
 .gitignore | 48 ++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 40 insertions(+), 8 deletions(-)

diff --git a/.gitignore b/.gitignore
index 9647e71..544ec4a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,15 +1,47 @@
-# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
+# SPDX-FileCopyrightText: 2022 Kattni Rembor, written for Adafruit Industries
 #
-# SPDX-License-Identifier: Unlicense
+# SPDX-License-Identifier: MIT
 
+# Do not include files and directories created by your personal work environment, such as the IDE
+# you use, except for those already listed here. Pull requests including changes to this file will
+# not be accepted.
+
+# This .gitignore file contains rules for files generated by working with CircuitPython libraries,
+# including building Sphinx, testing with pip, and creating a virual environment, as well as the
+# MacOS and IDE-specific files generated by using MacOS in general, or the PyCharm or VSCode IDEs.
+
+# If you find that there are files being generated on your machine that should not be included in
+# your git commit, you should create a .gitignore_global file on your computer to include the
+# files created by your personal setup. To do so, follow the two steps below.
+
+# First, create a file called .gitignore_global somewhere convenient for you, and add rules for
+# the files you want to exclude from git commits.
+
+# Second, configure Git to use the exclude file for all Git repositories by running the
+# following via commandline, replacing "path/to/your/" with the actual path to your newly created
+# .gitignore_global file:
+# git config --global core.excludesfile path/to/your/.gitignore_global
+
+# CircuitPython-specific files
 *.mpy
-.idea
+
+# Python-specific files
 __pycache__
-_build
 *.pyc
+
+# Sphinx build-specific files
+_build
+
+# This file results from running `pip -e install .` in a local repository
+*.egg-info
+
+# Virtual environment-specific files
 .env
-bundles
+
+# MacOS-specific files
 *.DS_Store
-.eggs
-dist
-**/*.egg-info
+
+# IDE-specific files
+.idea
+.vscode
+*~

From bbc77ca31ab341235a26c682b7203d06c4e60cef Mon Sep 17 00:00:00 2001
From: evaherrada <eva.herrada@adafruit.com>
Date: Fri, 22 Apr 2022 15:59:00 -0400
Subject: [PATCH 064/107] Patch: Replaced discord badge image

---
 README.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.rst b/README.rst
index 4f4e545..f4506f0 100644
--- a/README.rst
+++ b/README.rst
@@ -5,7 +5,7 @@ Introduction
     :target: https://docs.circuitpython.org/projects/mlx90393/en/latest/
     :alt: Documentation Status
 
-.. image:: https://img.shields.io/discord/327254708534116352.svg
+.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Bundle/blob/main/badges/adafruit_discord.svg
     :target: https://adafru.it/discord
     :alt: Discord
 

From 923ea452293a776592a42a2e67b60230a71982f7 Mon Sep 17 00:00:00 2001
From: foamyguy <foamyguy@gmail.com>
Date: Sun, 24 Apr 2022 13:54:44 -0500
Subject: [PATCH 065/107] change discord badge

---
 README.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.rst b/README.rst
index f4506f0..518e458 100644
--- a/README.rst
+++ b/README.rst
@@ -5,7 +5,7 @@ Introduction
     :target: https://docs.circuitpython.org/projects/mlx90393/en/latest/
     :alt: Documentation Status
 
-.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Bundle/blob/main/badges/adafruit_discord.svg
+.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
     :target: https://adafru.it/discord
     :alt: Discord
 

From 607bcd72d4302b3e90136ff10c02ff29319ab7c6 Mon Sep 17 00:00:00 2001
From: Alec Delaney <tekktrik@gmail.com>
Date: Sun, 15 May 2022 12:48:31 -0400
Subject: [PATCH 066/107] Patch .pre-commit-config.yaml

---
 .pre-commit-config.yaml | 32 ++++++++++++++++----------------
 1 file changed, 16 insertions(+), 16 deletions(-)

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 7467c1d..3343606 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -3,40 +3,40 @@
 # SPDX-License-Identifier: Unlicense
 
 repos:
--   repo: https://github.com/python/black
+  - repo: https://github.com/python/black
     rev: 22.3.0
     hooks:
-    - id: black
--   repo: https://github.com/fsfe/reuse-tool
-    rev: v0.12.1
+      - id: black
+  - repo: https://github.com/fsfe/reuse-tool
+    rev: v0.14.0
     hooks:
-    - id: reuse
--   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.3.0
+      - id: reuse
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.2.0
     hooks:
-    -   id: check-yaml
-    -   id: end-of-file-fixer
-    -   id: trailing-whitespace
--   repo: https://github.com/pycqa/pylint
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/pycqa/pylint
     rev: v2.11.1
     hooks:
-    -   id: pylint
+      - id: pylint
         name: pylint (library code)
         types: [python]
         args:
           - --disable=consider-using-f-string
         exclude: "^(docs/|examples/|tests/|setup.py$)"
-    -   id: pylint
+      - id: pylint
         name: pylint (example code)
         description: Run pylint rules on "examples/*.py" files
         types: [python]
         files: "^examples/"
         args:
-        - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code
-    -   id: pylint
+          - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code
+      - id: pylint
         name: pylint (test code)
         description: Run pylint rules on "tests/*.py" files
         types: [python]
         files: "^tests/"
         args:
-        - --disable=missing-docstring,consider-using-f-string,duplicate-code
+          - --disable=missing-docstring,consider-using-f-string,duplicate-code

From 1dd419295ca2e287b6ad355414dd0f6589003700 Mon Sep 17 00:00:00 2001
From: Alec Delaney <tekktrik@gmail.com>
Date: Sun, 22 May 2022 00:18:55 -0400
Subject: [PATCH 067/107] Increase min lines similarity

Signed-off-by: Alec Delaney <tekktrik@gmail.com>
---
 .pylintrc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.pylintrc b/.pylintrc
index cfd1c41..f006a4a 100644
--- a/.pylintrc
+++ b/.pylintrc
@@ -252,7 +252,7 @@ ignore-docstrings=yes
 ignore-imports=yes
 
 # Minimum lines number of a similarity.
-min-similarity-lines=4
+min-similarity-lines=12
 
 
 [BASIC]

From 1aed7f5876ce5b9c02468cfe14de4bef606588cb Mon Sep 17 00:00:00 2001
From: Alec Delaney <tekktrik@gmail.com>
Date: Sun, 22 May 2022 00:18:23 -0400
Subject: [PATCH 068/107] Switch to inclusive terminology

Signed-off-by: Alec Delaney <tekktrik@gmail.com>
---
 .pylintrc | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/.pylintrc b/.pylintrc
index f006a4a..f772971 100644
--- a/.pylintrc
+++ b/.pylintrc
@@ -9,11 +9,11 @@
 # run arbitrary code
 extension-pkg-whitelist=
 
-# Add files or directories to the blacklist. They should be base names, not
+# Add files or directories to the ignore-list. They should be base names, not
 # paths.
 ignore=CVS
 
-# Add files or directories matching the regex patterns to the blacklist. The
+# Add files or directories matching the regex patterns to the ignore-list. The
 # regex matches against base names, not paths.
 ignore-patterns=
 

From 705bded870ebc7b35d28e4e1f3135e492ddced15 Mon Sep 17 00:00:00 2001
From: Alec Delaney <tekktrik@gmail.com>
Date: Mon, 30 May 2022 14:25:04 -0400
Subject: [PATCH 069/107] Set language to "en" for documentation

Signed-off-by: Alec Delaney <tekktrik@gmail.com>
---
 docs/conf.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/conf.py b/docs/conf.py
index 1f89f2b..ec5a3f3 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -68,7 +68,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

From 8f3a76add206851380df1a47702ec7c164153fc1 Mon Sep 17 00:00:00 2001
From: evaherrada <eva.herrada@adafruit.com>
Date: Tue, 7 Jun 2022 15:34:40 -0400
Subject: [PATCH 070/107] Added cp.org link to index.rst

---
 docs/index.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/docs/index.rst b/docs/index.rst
index 81c4c0c..e811ffe 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -33,7 +33,8 @@ Table of Contents
 .. toctree::
     :caption: Other Links
 
-    Download <https://github.com/adafruit/CircuitPython_Adafruit_CircuitPython_MLX90393/releases/latest>
+    Download from GitHub <https://github.com/adafruit/CircuitPython_Adafruit_CircuitPython_MLX90393/releases/latest>
+    Download Library Bundle <https://circuitpython.org/libraries>
     CircuitPython Reference Documentation <https://docs.circuitpython.org>
     CircuitPython Support Forum <https://forums.adafruit.com/viewforum.php?f=60>
     Discord Chat <https://adafru.it/discord>

From 3ff39dafb3782b761868cd44248c023c52d8a8c9 Mon Sep 17 00:00:00 2001
From: evaherrada <eva.herrada@adafruit.com>
Date: Fri, 22 Jul 2022 13:59:03 -0400
Subject: [PATCH 071/107] Changed .env to .venv in README.rst

---
 README.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/README.rst b/README.rst
index 518e458..4ad3204 100644
--- a/README.rst
+++ b/README.rst
@@ -47,8 +47,8 @@ To install in a virtual environment in your current project:
 .. code-block:: shell
 
     mkdir project-name && cd project-name
-    python3 -m venv .env
-    source .env/bin/activate
+    python3 -m venv .venv
+    source .venv/bin/activate
     pip3 install adafruit-circuitpython-mlx90939
 
 Usage Example

From b709a140c646fc736bedd5aadac37492f8345e5a Mon Sep 17 00:00:00 2001
From: evaherrada <eva.herrada@adafruit.com>
Date: Tue, 2 Aug 2022 17:00:51 -0400
Subject: [PATCH 072/107] Added Black formatting badge

---
 README.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/README.rst b/README.rst
index 4ad3204..4c189d8 100644
--- a/README.rst
+++ b/README.rst
@@ -13,6 +13,10 @@ Introduction
     :target: https://github.com/adafruit/Adafruit_CircuitPython_MLX90393/actions/
     :alt: Build Status
 
+.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
+    :target: https://github.com/psf/black
+    :alt: Code Style: Black
+
 Adafruit CircuitPython driver for the MLX90393 3-axis magnetometer.
 
 Dependencies

From 849e4e771d6d77c01a577e4cd6e6cd883d70efb1 Mon Sep 17 00:00:00 2001
From: Alec Delaney <tekktrik@gmail.com>
Date: Mon, 8 Aug 2022 22:05:53 -0400
Subject: [PATCH 073/107] Switched to pyproject.toml

---
 .github/workflows/build.yml   | 18 ++++++-----
 .github/workflows/release.yml | 17 +++++-----
 optional_requirements.txt     |  3 ++
 pyproject.toml                | 46 +++++++++++++++++++++++++++
 requirements.txt              |  2 +-
 setup.py                      | 58 -----------------------------------
 6 files changed, 70 insertions(+), 74 deletions(-)
 create mode 100644 optional_requirements.txt
 create mode 100644 pyproject.toml
 delete mode 100644 setup.py

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 474520d..22f6582 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -47,6 +47,8 @@ jobs:
         pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit
     - name: Library version
       run: git describe --dirty --always --tags
+    - name: Setup problem matchers
+      uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1
     - name: Pre-commit hooks
       run: |
         pre-commit run --all-files
@@ -60,16 +62,16 @@ jobs:
     - name: Build docs
       working-directory: docs
       run: sphinx-build -E -W -b html . _build/html
-    - name: Check For setup.py
+    - name: Check For pyproject.toml
       id: need-pypi
       run: |
-        echo ::set-output name=setup-py::$( find . -wholename './setup.py' )
+        echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' )
     - name: Build Python package
-      if: contains(steps.need-pypi.outputs.setup-py, 'setup.py')
+      if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml')
       run: |
-        pip install --upgrade setuptools wheel twine readme_renderer testresources
-        python setup.py sdist
-        python setup.py bdist_wheel --universal
+        pip install --upgrade build twine
+        for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do
+            sed -i -e "s/0.0.0-auto.0/1.2.3/" $file;
+        done;
+        python -m build
         twine check dist/*
-    - name: Setup problem matchers
-      uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index a65e5de..d1b4f8d 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -61,25 +61,28 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v1
-    - name: Check For setup.py
+    - name: Check For pyproject.toml
       id: need-pypi
       run: |
-        echo ::set-output name=setup-py::$( find . -wholename './setup.py' )
+        echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' )
     - name: Set up Python
-      if: contains(steps.need-pypi.outputs.setup-py, 'setup.py')
+      if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml')
       uses: actions/setup-python@v2
       with:
         python-version: '3.x'
     - name: Install dependencies
-      if: contains(steps.need-pypi.outputs.setup-py, 'setup.py')
+      if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml')
       run: |
         python -m pip install --upgrade pip
-        pip install setuptools wheel twine
+        pip install --upgrade build twine
     - name: Build and publish
-      if: contains(steps.need-pypi.outputs.setup-py, 'setup.py')
+      if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml')
       env:
         TWINE_USERNAME: ${{ secrets.pypi_username }}
         TWINE_PASSWORD: ${{ secrets.pypi_password }}
       run: |
-        python setup.py sdist
+        for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do
+            sed -i -e "s/0.0.0-auto.0/${{github.event.release.tag_name}}/" $file;
+        done;
+        python -m build
         twine upload dist/*
diff --git a/optional_requirements.txt b/optional_requirements.txt
new file mode 100644
index 0000000..d4e27c4
--- /dev/null
+++ b/optional_requirements.txt
@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense
diff --git a/pyproject.toml b/pyproject.toml
new file mode 100644
index 0000000..35689f7
--- /dev/null
+++ b/pyproject.toml
@@ -0,0 +1,46 @@
+# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+[build-system]
+requires = [
+    "setuptools",
+    "wheel",
+]
+
+[project]
+name = "adafruit-circuitpython-mlx90393"
+description = "CircuitPython driver for the MLX90393 3-axis magnetometer."
+version = "0.0.0-auto.0"
+readme = "README.rst"
+authors = [
+    {name = "Adafruit Industries", email = "circuitpython@adafruit.com"}
+]
+urls = {Homepage = "https://github.com/adafruit/Adafruit_CircuitPython_MLX90393"}
+keywords = [
+    "adafruit",
+    "three-axis",
+    "magnetometer",
+    "magnet",
+    "mlx90393",
+    "hardware",
+    "micropython",
+    "circuitpython",
+]
+license = {text = "MIT"}
+classifiers = [
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development :: Embedded Systems",
+    "Topic :: System :: Hardware",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+]
+dynamic = ["dependencies", "optional-dependencies"]
+
+[tool.setuptools]
+py-modules = ["adafruit_mlx90393"]
+
+[tool.setuptools.dynamic]
+dependencies = {file = ["requirements.txt"]}
+optional-dependencies = {optional = {file = ["optional_requirements.txt"]}}
diff --git a/requirements.txt b/requirements.txt
index 5955484..7d01776 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
+# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries
 #
 # SPDX-License-Identifier: Unlicense
 
diff --git a/setup.py b/setup.py
deleted file mode 100644
index 5e62bc4..0000000
--- a/setup.py
+++ /dev/null
@@ -1,58 +0,0 @@
-# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
-#
-# SPDX-License-Identifier: MIT
-
-"""A setuptools based setup module.
-
-See:
-https://packaging.python.org/en/latest/distributing.html
-https://github.com/pypa/sampleproject
-"""
-
-# Always prefer setuptools over distutils
-from setuptools import setup, find_packages
-
-# To use a consistent encoding
-from codecs import open
-from os import path
-
-here = path.abspath(path.dirname(__file__))
-
-# Get the long description from the README file
-with open(path.join(here, "README.rst"), encoding="utf-8") as f:
-    long_description = f.read()
-
-setup(
-    name="adafruit-circuitpython-mlx90393",
-    use_scm_version=True,
-    setup_requires=["setuptools_scm"],
-    description="CircuitPython driver for the MLX90393 3-axis magnetometer.",
-    long_description=long_description,
-    long_description_content_type="text/x-rst",
-    # The project's main homepage.
-    url="https://github.com/adafruit/Adafruit_CircuitPython_MLX90393",
-    # Author details
-    author="Adafruit Industries",
-    author_email="circuitpython@adafruit.com",
-    install_requires=[
-        "Adafruit-Blinka>=7.0.0",
-        "adafruit-circuitpython-busdevice",
-        "adafruit-circuitpython-typing",
-    ],
-    # Choose your license
-    license="MIT",
-    # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
-    classifiers=[
-        "Development Status :: 3 - Alpha",
-        "Intended Audience :: Developers",
-        "Topic :: Software Development :: Libraries",
-        "Topic :: System :: Hardware",
-        "License :: OSI Approved :: MIT License",
-        "Programming Language :: Python :: 3",
-    ],
-    # What does your project relate to?
-    keywords="adafruit three-axis magnetometer magnet mlx90393 hardware micropython circuitpython",
-    # You can just specify the packages manually here if your project is
-    # simple. Or you can use find_packages().
-    py_modules=["adafruit_mlx90393"],
-)

From 4b49693a90afdb7ce7bd8f05df58a9adfbfee461 Mon Sep 17 00:00:00 2001
From: Alec Delaney <tekktrik@gmail.com>
Date: Tue, 9 Aug 2022 12:03:54 -0400
Subject: [PATCH 074/107] Add setuptools-scm to build system requirements

Signed-off-by: Alec Delaney <tekktrik@gmail.com>
---
 pyproject.toml | 1 +
 1 file changed, 1 insertion(+)

diff --git a/pyproject.toml b/pyproject.toml
index 35689f7..06aa025 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -6,6 +6,7 @@
 requires = [
     "setuptools",
     "wheel",
+    "setuptools-scm",
 ]
 
 [project]

From 8d79c3d86e60d5383fdcc5d5ed21ca8c5e9166be Mon Sep 17 00:00:00 2001
From: Alec Delaney <tekktik@gmail.com>
Date: Tue, 16 Aug 2022 18:09:13 -0400
Subject: [PATCH 075/107] Update version string

---
 adafruit_mlx90393.py | 2 +-
 pyproject.toml       | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index c95eed8..4c15264 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -41,7 +41,7 @@
 except ImportError:
     pass
 
-__version__ = "0.0.0-auto.0"
+__version__ = "0.0.0+auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_MLX90393.git"
 
 _CMD_SB = const(0b00010000)  # Start burst mode
diff --git a/pyproject.toml b/pyproject.toml
index 06aa025..3f55237 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -12,7 +12,7 @@ requires = [
 [project]
 name = "adafruit-circuitpython-mlx90393"
 description = "CircuitPython driver for the MLX90393 3-axis magnetometer."
-version = "0.0.0-auto.0"
+version = "0.0.0+auto.0"
 readme = "README.rst"
 authors = [
     {name = "Adafruit Industries", email = "circuitpython@adafruit.com"}

From ecf9b7f6133c5c2ed85899f360739f34f7be7657 Mon Sep 17 00:00:00 2001
From: Alec Delaney <tekktik@gmail.com>
Date: Tue, 16 Aug 2022 21:09:13 -0400
Subject: [PATCH 076/107] Fix version strings in workflow files

---
 .github/workflows/build.yml   | 2 +-
 .github/workflows/release.yml | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 22f6582..cb2f60e 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -71,7 +71,7 @@ jobs:
       run: |
         pip install --upgrade build twine
         for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do
-            sed -i -e "s/0.0.0-auto.0/1.2.3/" $file;
+            sed -i -e "s/0.0.0+auto.0/1.2.3/" $file;
         done;
         python -m build
         twine check dist/*
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index d1b4f8d..f3a0325 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -82,7 +82,7 @@ jobs:
         TWINE_PASSWORD: ${{ secrets.pypi_password }}
       run: |
         for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do
-            sed -i -e "s/0.0.0-auto.0/${{github.event.release.tag_name}}/" $file;
+            sed -i -e "s/0.0.0+auto.0/${{github.event.release.tag_name}}/" $file;
         done;
         python -m build
         twine upload dist/*

From 68611d011f8c768fac04bb6db816189a99859b02 Mon Sep 17 00:00:00 2001
From: Alec Delaney <tekktik@gmail.com>
Date: Mon, 22 Aug 2022 21:36:30 -0400
Subject: [PATCH 077/107] Keep copyright up to date in documentation

---
 docs/conf.py | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/docs/conf.py b/docs/conf.py
index ec5a3f3..16e8708 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -6,6 +6,7 @@
 
 import os
 import sys
+import datetime
 
 sys.path.insert(0, os.path.abspath(".."))
 
@@ -51,7 +52,8 @@
 
 # General information about the project.
 project = "Adafruit MLX90393 Library"
-copyright = "2018 Kevin Townsend"
+current_year = str(datetime.datetime.now().year)
+copyright = current_year + " Kevin Townsend"
 author = "Kevin Townsend"
 
 # The version info for the project you're documenting, acts as replacement for

From f409c6a12f2596f81d5e691dcfd9a2a33a8998d7 Mon Sep 17 00:00:00 2001
From: Alec Delaney <tekktik@gmail.com>
Date: Tue, 23 Aug 2022 17:26:21 -0400
Subject: [PATCH 078/107] Use year duration range for copyright attribution

---
 docs/conf.py | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/docs/conf.py b/docs/conf.py
index 16e8708..669d50f 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -52,8 +52,14 @@
 
 # General information about the project.
 project = "Adafruit MLX90393 Library"
+creation_year = "2018"
 current_year = str(datetime.datetime.now().year)
-copyright = current_year + " Kevin Townsend"
+year_duration = (
+    current_year
+    if current_year == creation_year
+    else creation_year + " - " + current_year
+)
+copyright = year_duration + " Kevin Townsend"
 author = "Kevin Townsend"
 
 # The version info for the project you're documenting, acts as replacement for

From 72157035da6639d0b95112db8f12bc34710b9f24 Mon Sep 17 00:00:00 2001
From: Alec Delaney <89490472+tekktrik@users.noreply.github.com>
Date: Fri, 4 Nov 2022 00:02:49 -0400
Subject: [PATCH 079/107] Switching to composite actions

---
 .github/workflows/build.yml        | 67 +----------------------
 .github/workflows/release.yml      | 88 ------------------------------
 .github/workflows/release_gh.yml   | 14 +++++
 .github/workflows/release_pypi.yml | 14 +++++
 4 files changed, 30 insertions(+), 153 deletions(-)
 delete mode 100644 .github/workflows/release.yml
 create mode 100644 .github/workflows/release_gh.yml
 create mode 100644 .github/workflows/release_pypi.yml

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index cb2f60e..041a337 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -10,68 +10,5 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-    - name: Dump GitHub context
-      env:
-        GITHUB_CONTEXT: ${{ toJson(github) }}
-      run: echo "$GITHUB_CONTEXT"
-    - name: Translate Repo Name For Build Tools filename_prefix
-      id: repo-name
-      run: |
-        echo ::set-output name=repo-name::$(
-        echo ${{ github.repository }} |
-        awk -F '\/' '{ print tolower($2) }' |
-        tr '_' '-'
-        )
-    - name: Set up Python 3.x
-      uses: actions/setup-python@v2
-      with:
-        python-version: "3.x"
-    - name: Versions
-      run: |
-        python3 --version
-    - name: Checkout Current Repo
-      uses: actions/checkout@v1
-      with:
-        submodules: true
-    - name: Checkout tools repo
-      uses: actions/checkout@v2
-      with:
-        repository: adafruit/actions-ci-circuitpython-libs
-        path: actions-ci
-    - name: Install dependencies
-      # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.)
-      run: |
-        source actions-ci/install.sh
-    - name: Pip install Sphinx, pre-commit
-      run: |
-        pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit
-    - name: Library version
-      run: git describe --dirty --always --tags
-    - name: Setup problem matchers
-      uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1
-    - name: Pre-commit hooks
-      run: |
-        pre-commit run --all-files
-    - name: Build assets
-      run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location .
-    - name: Archive bundles
-      uses: actions/upload-artifact@v2
-      with:
-        name: bundles
-        path: ${{ github.workspace }}/bundles/
-    - name: Build docs
-      working-directory: docs
-      run: sphinx-build -E -W -b html . _build/html
-    - name: Check For pyproject.toml
-      id: need-pypi
-      run: |
-        echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' )
-    - name: Build Python package
-      if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml')
-      run: |
-        pip install --upgrade build twine
-        for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do
-            sed -i -e "s/0.0.0+auto.0/1.2.3/" $file;
-        done;
-        python -m build
-        twine check dist/*
+    - name: Run Build CI workflow
+      uses: adafruit/workflows-circuitpython-libs/build@main
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
deleted file mode 100644
index f3a0325..0000000
--- a/.github/workflows/release.yml
+++ /dev/null
@@ -1,88 +0,0 @@
-# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
-#
-# SPDX-License-Identifier: MIT
-
-name: Release Actions
-
-on:
-  release:
-    types: [published]
-
-jobs:
-  upload-release-assets:
-    runs-on: ubuntu-latest
-    steps:
-    - name: Dump GitHub context
-      env:
-        GITHUB_CONTEXT: ${{ toJson(github) }}
-      run: echo "$GITHUB_CONTEXT"
-    - name: Translate Repo Name For Build Tools filename_prefix
-      id: repo-name
-      run: |
-        echo ::set-output name=repo-name::$(
-        echo ${{ github.repository }} |
-        awk -F '\/' '{ print tolower($2) }' |
-        tr '_' '-'
-        )
-    - name: Set up Python 3.x
-      uses: actions/setup-python@v2
-      with:
-        python-version: "3.x"
-    - name: Versions
-      run: |
-        python3 --version
-    - name: Checkout Current Repo
-      uses: actions/checkout@v1
-      with:
-        submodules: true
-    - name: Checkout tools repo
-      uses: actions/checkout@v2
-      with:
-        repository: adafruit/actions-ci-circuitpython-libs
-        path: actions-ci
-    - name: Install deps
-      run: |
-        source actions-ci/install.sh
-    - name: Build assets
-      run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location .
-    - name: Upload Release Assets
-      # the 'official' actions version does not yet support dynamically
-      # supplying asset names to upload. @csexton's version chosen based on
-      # discussion in the issue below, as its the simplest to implement and
-      # allows for selecting files with a pattern.
-      # https://github.com/actions/upload-release-asset/issues/4
-      #uses: actions/upload-release-asset@v1.0.1
-      uses: csexton/release-asset-action@master
-      with:
-        pattern: "bundles/*"
-        github-token: ${{ secrets.GITHUB_TOKEN }}
-
-  upload-pypi:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v1
-    - name: Check For pyproject.toml
-      id: need-pypi
-      run: |
-        echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' )
-    - name: Set up Python
-      if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml')
-      uses: actions/setup-python@v2
-      with:
-        python-version: '3.x'
-    - name: Install dependencies
-      if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml')
-      run: |
-        python -m pip install --upgrade pip
-        pip install --upgrade build twine
-    - name: Build and publish
-      if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml')
-      env:
-        TWINE_USERNAME: ${{ secrets.pypi_username }}
-        TWINE_PASSWORD: ${{ secrets.pypi_password }}
-      run: |
-        for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do
-            sed -i -e "s/0.0.0+auto.0/${{github.event.release.tag_name}}/" $file;
-        done;
-        python -m build
-        twine upload dist/*
diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml
new file mode 100644
index 0000000..041a337
--- /dev/null
+++ b/.github/workflows/release_gh.yml
@@ -0,0 +1,14 @@
+# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+name: Build CI
+
+on: [pull_request, push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Run Build CI workflow
+      uses: adafruit/workflows-circuitpython-libs/build@main
diff --git a/.github/workflows/release_pypi.yml b/.github/workflows/release_pypi.yml
new file mode 100644
index 0000000..041a337
--- /dev/null
+++ b/.github/workflows/release_pypi.yml
@@ -0,0 +1,14 @@
+# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+name: Build CI
+
+on: [pull_request, push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Run Build CI workflow
+      uses: adafruit/workflows-circuitpython-libs/build@main

From 5c1978e4bddfc58c9e212f26f0b46a6846dcdedb Mon Sep 17 00:00:00 2001
From: Alec Delaney <89490472+tekktrik@users.noreply.github.com>
Date: Fri, 4 Nov 2022 00:46:59 -0400
Subject: [PATCH 080/107] Updated pylint version to 2.13.0

---
 .pre-commit-config.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 3343606..4c43710 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -18,7 +18,7 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/pycqa/pylint
-    rev: v2.11.1
+    rev: v2.13.0
     hooks:
       - id: pylint
         name: pylint (library code)

From 157f9c97d79fee7d07cd4f651a0553bf89a4331d Mon Sep 17 00:00:00 2001
From: Alec Delaney <89490472+tekktrik@users.noreply.github.com>
Date: Fri, 4 Nov 2022 08:15:19 -0400
Subject: [PATCH 081/107] Update pylint to 2.15.5

---
 .pre-commit-config.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 4c43710..0e5fccc 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -18,7 +18,7 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/pycqa/pylint
-    rev: v2.13.0
+    rev: v2.15.5
     hooks:
       - id: pylint
         name: pylint (library code)

From eea7a16dab63fac5532dbcdf51af82b26c87c5a7 Mon Sep 17 00:00:00 2001
From: Alec Delaney <89490472+tekktrik@users.noreply.github.com>
Date: Fri, 4 Nov 2022 09:12:44 -0400
Subject: [PATCH 082/107] Fix release CI files

---
 .github/workflows/release_gh.yml   | 14 +++++++++-----
 .github/workflows/release_pypi.yml | 15 ++++++++++-----
 2 files changed, 19 insertions(+), 10 deletions(-)

diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml
index 041a337..b8aa8d6 100644
--- a/.github/workflows/release_gh.yml
+++ b/.github/workflows/release_gh.yml
@@ -2,13 +2,17 @@
 #
 # SPDX-License-Identifier: MIT
 
-name: Build CI
+name: GitHub Release Actions
 
-on: [pull_request, push]
+on:
+  release:
+    types: [published]
 
 jobs:
-  test:
+  upload-release-assets:
     runs-on: ubuntu-latest
     steps:
-    - name: Run Build CI workflow
-      uses: adafruit/workflows-circuitpython-libs/build@main
+    - name: Run GitHub Release CI workflow
+      uses: adafruit/workflows-circuitpython-libs/release-gh@main
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/release_pypi.yml b/.github/workflows/release_pypi.yml
index 041a337..65775b7 100644
--- a/.github/workflows/release_pypi.yml
+++ b/.github/workflows/release_pypi.yml
@@ -2,13 +2,18 @@
 #
 # SPDX-License-Identifier: MIT
 
-name: Build CI
+name: PyPI Release Actions
 
-on: [pull_request, push]
+on:
+  release:
+    types: [published]
 
 jobs:
-  test:
+  upload-release-assets:
     runs-on: ubuntu-latest
     steps:
-    - name: Run Build CI workflow
-      uses: adafruit/workflows-circuitpython-libs/build@main
+    - name: Run PyPI Release CI workflow
+      uses: adafruit/workflows-circuitpython-libs/release-pypi@main
+      with:
+        pypi-username: ${{ secrets.pypi_username }}
+        pypi-password: ${{ secrets.pypi_password }}

From 7a566bb264309b228b8503c2b13c3c24ef4def12 Mon Sep 17 00:00:00 2001
From: Alec Delaney <89490472+tekktrik@users.noreply.github.com>
Date: Fri, 4 Nov 2022 18:34:32 -0400
Subject: [PATCH 083/107] Update .pylintrc for v2.15.5

---
 .pylintrc | 45 ++++-----------------------------------------
 1 file changed, 4 insertions(+), 41 deletions(-)

diff --git a/.pylintrc b/.pylintrc
index f772971..40208c3 100644
--- a/.pylintrc
+++ b/.pylintrc
@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
+# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
 #
 # SPDX-License-Identifier: Unlicense
 
@@ -26,7 +26,7 @@ jobs=1
 
 # List of plugins (as comma separated values of python modules names) to load,
 # usually to register additional checkers.
-load-plugins=
+load-plugins=pylint.extensions.no_self_use
 
 # Pickle collected data for later comparisons.
 persistent=yes
@@ -54,8 +54,8 @@ confidence=
 # --enable=similarities". If you want to run only the classes checker, but have
 # no Warning level messages displayed, use"--disable=all --enable=classes
 # --disable=W"
-# disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call
-disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation,unspecified-encoding
+# disable=import-error,raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,deprecated-str-translate-call
+disable=raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,import-error,pointless-string-statement,unspecified-encoding
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option
@@ -225,12 +225,6 @@ max-line-length=100
 # Maximum number of lines in a module
 max-module-lines=1000
 
-# List of optional constructs for which whitespace checking is disabled. `dict-
-# separator` is used to allow tabulation in dicts, etc.: {1  : 1,\n222: 2}.
-# `trailing-comma` allows a space between comma and closing bracket: (a, ).
-# `empty-line` allows space-only lines.
-no-space-check=trailing-comma,dict-separator
-
 # Allow the body of a class to be on the same line as the declaration if body
 # contains single statement.
 single-line-class-stmt=no
@@ -257,38 +251,22 @@ min-similarity-lines=12
 
 [BASIC]
 
-# Naming hint for argument names
-argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
 # Regular expression matching correct argument names
 argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
 
-# Naming hint for attribute names
-attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
 # Regular expression matching correct attribute names
 attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
 
 # Bad variable names which should always be refused, separated by a comma
 bad-names=foo,bar,baz,toto,tutu,tata
 
-# Naming hint for class attribute names
-class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
-
 # Regular expression matching correct class attribute names
 class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
 
-# Naming hint for class names
-# class-name-hint=[A-Z_][a-zA-Z0-9]+$
-class-name-hint=[A-Z_][a-zA-Z0-9_]+$
-
 # Regular expression matching correct class names
 # class-rgx=[A-Z_][a-zA-Z0-9]+$
 class-rgx=[A-Z_][a-zA-Z0-9_]+$
 
-# Naming hint for constant names
-const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$
-
 # Regular expression matching correct constant names
 const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
 
@@ -296,9 +274,6 @@ const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
 # ones are exempt.
 docstring-min-length=-1
 
-# Naming hint for function names
-function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
 # Regular expression matching correct function names
 function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
 
@@ -309,21 +284,12 @@ good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_
 # Include a hint for the correct naming format with invalid-name
 include-naming-hint=no
 
-# Naming hint for inline iteration names
-inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$
-
 # Regular expression matching correct inline iteration names
 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
 
-# Naming hint for method names
-method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
 # Regular expression matching correct method names
 method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
 
-# Naming hint for module names
-module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
-
 # Regular expression matching correct module names
 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
 
@@ -339,9 +305,6 @@ no-docstring-rgx=^_
 # to this list to register other decorators that produce valid properties.
 property-classes=abc.abstractproperty
 
-# Naming hint for variable names
-variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
 # Regular expression matching correct variable names
 variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
 

From 6e6c6ff26f55fc9360955716602d9e35f9069324 Mon Sep 17 00:00:00 2001
From: dherrada <dylan.herrada@adafruit.com>
Date: Fri, 18 Nov 2022 13:05:26 -0500
Subject: [PATCH 084/107] Added commented out board.STEMMA_I2C with explanation

---
 examples/mlx90393_simpletest.py | 1 +
 1 file changed, 1 insertion(+)

diff --git a/examples/mlx90393_simpletest.py b/examples/mlx90393_simpletest.py
index 47650a6..b160216 100755
--- a/examples/mlx90393_simpletest.py
+++ b/examples/mlx90393_simpletest.py
@@ -6,6 +6,7 @@
 import adafruit_mlx90393
 
 i2c = board.I2C()  # uses board.SCL and board.SDA
+# i2c = board.STEMMA_I2C()  # For using the built-in STEMMA QT connector on a microcontroller
 SENSOR = adafruit_mlx90393.MLX90393(i2c, gain=adafruit_mlx90393.GAIN_1X)
 
 while True:

From 629168278edf317d162f6965f3e5a2e17f4ffaaa Mon Sep 17 00:00:00 2001
From: Alec Delaney <89490472+tekktrik@users.noreply.github.com>
Date: Thu, 1 Sep 2022 20:16:31 -0400
Subject: [PATCH 085/107] Add .venv to .gitignore

Signed-off-by: Alec Delaney <89490472+tekktrik@users.noreply.github.com>
---
 .gitignore | 1 +
 1 file changed, 1 insertion(+)

diff --git a/.gitignore b/.gitignore
index 544ec4a..db3d538 100644
--- a/.gitignore
+++ b/.gitignore
@@ -37,6 +37,7 @@ _build
 
 # Virtual environment-specific files
 .env
+.venv
 
 # MacOS-specific files
 *.DS_Store

From 3a492b178605598f36bf6ededfa30ef960d6883d Mon Sep 17 00:00:00 2001
From: Alec Delaney <89490472+tekktrik@users.noreply.github.com>
Date: Thu, 19 Jan 2023 23:39:55 -0500
Subject: [PATCH 086/107] Add upload url to release action

Signed-off-by: Alec Delaney <89490472+tekktrik@users.noreply.github.com>
---
 .github/workflows/release_gh.yml | 1 +
 1 file changed, 1 insertion(+)

diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml
index b8aa8d6..9acec60 100644
--- a/.github/workflows/release_gh.yml
+++ b/.github/workflows/release_gh.yml
@@ -16,3 +16,4 @@ jobs:
       uses: adafruit/workflows-circuitpython-libs/release-gh@main
       with:
         github-token: ${{ secrets.GITHUB_TOKEN }}
+        upload-url: ${{ github.event.release.upload_url }}

From ba029a69004b93f8f6afb2056f8dca18056c6a19 Mon Sep 17 00:00:00 2001
From: jposada202020 <jquintana202020@gmail.com>
Date: Thu, 16 Feb 2023 08:12:56 -0500
Subject: [PATCH 087/107] adding temperature reading

---
 adafruit_mlx90393.py | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index 4c15264..1c7b27a 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -57,6 +57,7 @@
 _CMD_NOP = const(0x00)  # NOP
 
 _CMD_AXIS_ALL = const(0xE)  # X+Y+Z axis bits for commands
+_CMD_TEMP = const(0x01)  # Temperature bit for commands
 
 _CMD_REG_CONF1 = const(0x00)  # Gain
 _CMD_REG_CONF2 = const(0x01)  # Burst, comm mode
@@ -518,3 +519,31 @@ def magnetic(self) -> Tuple[float, float, float]:
         z *= _LSB_LOOKUP[hallconf_index][self._gain_current][self._res_z][1]
 
         return x, y, z
+
+    def read_temp(self):
+        """
+        Reads a single temperature sample from the magnetometer.
+        """
+        # Set conversion delay based on filter and oversampling
+        treference = self.read_reg(0x24)
+
+        # from maximum time of temperature conversion on the datasheet section 12. 1603 us
+        delay = 0.1
+
+        # Set the device to single measurement mode
+        self._transceive(bytes([_CMD_SM | _CMD_TEMP]))
+
+        time.sleep(delay)
+
+        # Read the 'temp' data
+        data = self._transceive(bytes([_CMD_RM | _CMD_TEMP]), 2)
+
+        # Unpack status and raw int values
+        self._status_last = data[0]
+
+        # from https://www.melexis.com/-/media/files/documents/
+        # application-notes/mlx90393-temperature-compensation-application-note-melexis.pdf
+        tvalue = struct.unpack(">H", data[1:3])[0]
+        temperature = 35 + ((tvalue - treference) / 45.2)  # See previous link
+
+        return temperature

From 5882d2b238de2759513f8acd6f52f321a78b4c2f Mon Sep 17 00:00:00 2001
From: jposada202020 <jquintana202020@gmail.com>
Date: Thu, 16 Feb 2023 17:18:13 -0500
Subject: [PATCH 088/107] adding temperature reading

---
 adafruit_mlx90393.py             | 13 ++++++++-----
 docs/examples.rst                |  9 +++++++++
 examples/mlx90393_temperature.py | 21 +++++++++++++++++++++
 3 files changed, 38 insertions(+), 5 deletions(-)
 create mode 100644 examples/mlx90393_temperature.py

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index 1c7b27a..e829e80 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -520,14 +520,17 @@ def magnetic(self) -> Tuple[float, float, float]:
 
         return x, y, z
 
-    def read_temp(self):
+    @property
+    def temperature(self) -> float:
         """
         Reads a single temperature sample from the magnetometer.
+        Temperature value in Celsius
         """
-        # Set conversion delay based on filter and oversampling
+        # Read the temperature reference from register 0x24
         treference = self.read_reg(0x24)
 
-        # from maximum time of temperature conversion on the datasheet section 12. 1603 us
+        # Value taken from maximum time of temperature conversion on the datasheet section 12.
+        # maximum time for temperature conversion = 1603 us
         delay = 0.1
 
         # Set the device to single measurement mode
@@ -544,6 +547,6 @@ def read_temp(self):
         # from https://www.melexis.com/-/media/files/documents/
         # application-notes/mlx90393-temperature-compensation-application-note-melexis.pdf
         tvalue = struct.unpack(">H", data[1:3])[0]
-        temperature = 35 + ((tvalue - treference) / 45.2)  # See previous link
+        # See previous link for conversion formula
 
-        return temperature
+        return 35 + ((tvalue - treference) / 45.2)
diff --git a/docs/examples.rst b/docs/examples.rst
index a9c23ee..e3eb8d9 100644
--- a/docs/examples.rst
+++ b/docs/examples.rst
@@ -6,3 +6,12 @@ Ensure your device works with this simple test.
 .. literalinclude:: ../examples/mlx90393_simpletest.py
     :caption: examples/mlx90393_simpletest.py
     :linenos:
+
+Temperature test
+-----------------
+
+Example showing how to measure temperature with the sensor
+
+.. literalinclude:: ../examples/mlx90393_temperature.py
+    :caption: examples/mlx90393_temperature.py
+    :linenos:
diff --git a/examples/mlx90393_temperature.py b/examples/mlx90393_temperature.py
new file mode 100644
index 0000000..942bc1c
--- /dev/null
+++ b/examples/mlx90393_temperature.py
@@ -0,0 +1,21 @@
+# SPDX-FileCopyrightText: 2023 Jose D. Montoya
+# SPDX-License-Identifier: MIT
+
+import time
+import board
+import adafruit_mlx90393
+
+i2c = board.I2C()  # uses board.SCL and board.SDA
+# i2c = board.STEMMA_I2C()  # For using the built-in STEMMA QT connector on a microcontroller
+SENSOR = adafruit_mlx90393.MLX90393(i2c, gain=adafruit_mlx90393.GAIN_1X)
+
+
+while True:
+    temp = SENSOR.temperature
+
+    print("Temperature: {} °C".format(temp))
+
+    # Display the status field if an error occurred, etc.
+    if SENSOR.last_status > adafruit_mlx90393.STATUS_OK:
+        SENSOR.display_status()
+    time.sleep(1.0)

From 8ca879fa939b891e02cd6cebabbd19f1a5b78a85 Mon Sep 17 00:00:00 2001
From: Tekktrik <tekktrik@gmail.com>
Date: Tue, 9 May 2023 20:26:25 -0400
Subject: [PATCH 089/107] Update pre-commit hooks

Signed-off-by: Tekktrik <tekktrik@gmail.com>
---
 .pre-commit-config.yaml | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 0e5fccc..70ade69 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -4,21 +4,21 @@
 
 repos:
   - repo: https://github.com/python/black
-    rev: 22.3.0
+    rev: 23.3.0
     hooks:
       - id: black
   - repo: https://github.com/fsfe/reuse-tool
-    rev: v0.14.0
+    rev: v1.1.2
     hooks:
       - id: reuse
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.2.0
+    rev: v4.4.0
     hooks:
       - id: check-yaml
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/pycqa/pylint
-    rev: v2.15.5
+    rev: v2.17.4
     hooks:
       - id: pylint
         name: pylint (library code)

From 9692c3413f3abb185f72fa8e6dfb32cf8402777e Mon Sep 17 00:00:00 2001
From: Tekktrik <tekktrik@gmail.com>
Date: Sun, 14 May 2023 13:00:32 -0400
Subject: [PATCH 090/107] Update .pylintrc, fix jQuery for docs

Signed-off-by: Tekktrik <tekktrik@gmail.com>
---
 .pylintrc             | 2 +-
 docs/conf.py          | 1 +
 docs/requirements.txt | 1 +
 3 files changed, 3 insertions(+), 1 deletion(-)

diff --git a/.pylintrc b/.pylintrc
index 40208c3..f945e92 100644
--- a/.pylintrc
+++ b/.pylintrc
@@ -396,4 +396,4 @@ min-public-methods=1
 
 # Exceptions that will emit a warning when being caught. Defaults to
 # "Exception"
-overgeneral-exceptions=Exception
+overgeneral-exceptions=builtins.Exception
diff --git a/docs/conf.py b/docs/conf.py
index 669d50f..11d353c 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -17,6 +17,7 @@
 # ones.
 extensions = [
     "sphinx.ext.autodoc",
+    "sphinxcontrib.jquery",
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
     "sphinx.ext.todo",
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 88e6733..797aa04 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -3,3 +3,4 @@
 # SPDX-License-Identifier: Unlicense
 
 sphinx>=4.0.0
+sphinxcontrib-jquery

From 1213c4244809d51568f1a20c8422df08947a53f4 Mon Sep 17 00:00:00 2001
From: foamyguy <foamyguy@gmail.com>
Date: Mon, 18 Sep 2023 16:17:09 -0500
Subject: [PATCH 091/107] "fix rtd theme "

---
 docs/conf.py | 17 ++++-------------
 1 file changed, 4 insertions(+), 13 deletions(-)

diff --git a/docs/conf.py b/docs/conf.py
index 11d353c..52f3182 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -109,19 +109,10 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-on_rtd = os.environ.get("READTHEDOCS", None) == "True"
-
-if not on_rtd:  # only import and set the theme if we're building docs locally
-    try:
-        import sphinx_rtd_theme
-
-        html_theme = "sphinx_rtd_theme"
-        html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
-    except:
-        html_theme = "default"
-        html_theme_path = ["."]
-else:
-    html_theme_path = ["."]
+import sphinx_rtd_theme
+
+html_theme = "sphinx_rtd_theme"
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

From 466e0c0d74f9391651fe29fb375037827865832c Mon Sep 17 00:00:00 2001
From: foamyguy <foamyguy@gmail.com>
Date: Mon, 16 Oct 2023 14:30:31 -0500
Subject: [PATCH 092/107] unpin sphinx and add sphinx-rtd-theme to docs reqs

Signed-off-by: foamyguy <foamyguy@gmail.com>
---
 docs/requirements.txt | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/docs/requirements.txt b/docs/requirements.txt
index 797aa04..979f568 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -2,5 +2,6 @@
 #
 # SPDX-License-Identifier: Unlicense
 
-sphinx>=4.0.0
+sphinx
 sphinxcontrib-jquery
+sphinx-rtd-theme

From 36695495ef8bb073f95b1b34dab3ab008c35f830 Mon Sep 17 00:00:00 2001
From: caternuson <caternuson@gmail.com>
Date: Wed, 27 Mar 2024 11:11:42 -0700
Subject: [PATCH 093/107] update read_reg()

---
 adafruit_mlx90393.py | 9 +++------
 1 file changed, 3 insertions(+), 6 deletions(-)

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index e829e80..4cc22f4 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -406,15 +406,12 @@ def read_reg(self, reg: int) -> int:
 
         :param int reg: The register to read
         """
-        # Write 'value' to the specified register
+        # Read register
         payload = bytes([_CMD_RR, reg << 2])
-        with self.i2c_device as i2c:
-            i2c.write(payload)
-
-        # Read the response (+1 to account for the mandatory status byte!)
         data = bytearray(3)
         with self.i2c_device as i2c:
-            i2c.readinto(data)
+            i2c.write_then_readinto(payload, data)
+
         # Unpack data (status byte, big-endian 16-bit register value)
         self._status_last, val = struct.unpack(">BH", data)
         if self._debug:

From 41eff1ef20dbef837dd1b4f30f00c3b81aca4203 Mon Sep 17 00:00:00 2001
From: purepani <pani0028@umn.edu>
Date: Sun, 7 Apr 2024 15:20:37 -0500
Subject: [PATCH 094/107] Adds temperature compensation

---
 adafruit_mlx90393.py | 37 +++++++++++++++++++++++++++++++++++--
 1 file changed, 35 insertions(+), 2 deletions(-)

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index 4cc22f4..141a0e3 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -28,6 +28,7 @@
   https://github.com/adafruit/Adafruit_CircuitPython_Register
 
 """
+
 import struct
 import time
 
@@ -36,8 +37,9 @@
 
 try:
     from typing import Tuple
-    from circuitpython_typing import ReadableBuffer
+
     from busio import I2C
+    from circuitpython_typing import ReadableBuffer
 except ImportError:
     pass
 
@@ -60,7 +62,7 @@
 _CMD_TEMP = const(0x01)  # Temperature bit for commands
 
 _CMD_REG_CONF1 = const(0x00)  # Gain
-_CMD_REG_CONF2 = const(0x01)  # Burst, comm mode
+_CMD_REG_CONF2 = const(0x01)  # Burst, comm mode, temperature compensation
 _CMD_REG_CONF3 = const(0x02)  # Oversampling, Filter, Resolution
 _CMD_REG_CONF4 = const(0x03)  # Sensitivity drift
 
@@ -209,6 +211,7 @@ def __init__(  # pylint: disable=too-many-arguments
         resolution: int = RESOLUTION_16,
         filt: int = FILTER_7,
         oversampling: int = OSR_3,
+        temperature_compensation: bool = False,
         debug: bool = False,
     ) -> None:
         self.i2c_device = I2CDevice(i2c_bus, address)
@@ -218,6 +221,7 @@ def __init__(  # pylint: disable=too-many-arguments
         self._filter = filt
         self._osr = oversampling
         self._gain_current = gain
+        self._temperature_compensation = temperature_compensation
 
         # Put the device in a known state to start
         self.reset()
@@ -235,6 +239,7 @@ def __init__(  # pylint: disable=too-many-arguments
 
         # Set gain to the supplied level
         self.gain = self._gain_current
+        self.temperature_compensation = self._temperature_compensation
 
     def _transceive(self, payload: ReadableBuffer, rxlen: int = 0) -> bytearray:
         """
@@ -383,6 +388,20 @@ def oversampling(self, level: int) -> None:
         self.write_reg(_CMD_REG_CONF3, reg)
         self._osr = level
 
+    @property
+    def temperature_compensation(self) -> bool:
+        """The temperature compensation setting"""
+        return self._temperature_compensation
+
+    @temperature_compensation.setter
+    def temperature_compensation(self, temperature_compensation: bool) -> None:
+        reg = self.read_reg(_CMD_REG_CONF2)
+        t_cmp_bit = 10
+        reg &= ~(1 << t_cmp_bit)
+        reg |= temperature_compensation << t_cmp_bit
+        self.write_reg(_CMD_REG_CONF2, reg)
+        self._temperature_compensation = temperature_compensation
+
     def display_status(self) -> None:
         """
         Prints out the content of the last status byte in a human-readable
@@ -459,6 +478,17 @@ def read_data(self) -> Tuple[int, int, int]:
         """
         Reads a single X/Y/Z sample from the magnetometer.
         """
+
+        resolutions = {self.resolution_x, self.resolution_y, self.resolution_z}
+        valid_tcomp_resolutions = {RESOLUTION_16, RESOLUTION_17}
+        if self._temperature_compensation and not resolutions.issubset(
+            valid_tcomp_resolutions
+        ):
+            resolutions_output = f"Current Resolutions:\n\tresolution_x: {self.resolution_x}\n\tresolution_y: {self.resolution_y}\n\tresolution_z: {self.resolution_z}"
+            raise ValueError(
+                f"All resolutions must be RESOLUTION_16 or RESOLUTION_17 if temperature compensation is enabled.\n {resolutions_output}"
+            )
+
         # Set conversion delay based on filter and oversampling
         delay = _TCONV_LOOKUP[self._filter][self._osr] / 1000  # per datasheet
         delay *= 1.1  # plus a little
@@ -490,6 +520,9 @@ def _unpack_axis_data(self, resolution: int, data: ReadableBuffer) -> int:
         elif resolution == RESOLUTION_18:
             (value,) = struct.unpack(">H", data)
             value -= 0x8000
+        elif self.temperature_compensation:
+            (value,) = struct.unpack(">H", data)
+            value -= 0x8000
         else:
             value = struct.unpack(">h", data)[0]
         return value

From 3580b01b5c2cc56c82a3a5ee2f3ab2fa50edb2e9 Mon Sep 17 00:00:00 2001
From: purepani <pani0028@umn.edu>
Date: Sun, 7 Apr 2024 20:09:07 -0500
Subject: [PATCH 095/107] Adds Exit Before reset

---
 adafruit_mlx90393.py | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index 4cc22f4..d0d530d 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -28,6 +28,7 @@
   https://github.com/adafruit/Adafruit_CircuitPython_Register
 
 """
+
 import struct
 import time
 
@@ -36,8 +37,9 @@
 
 try:
     from typing import Tuple
-    from circuitpython_typing import ReadableBuffer
+
     from busio import I2C
+    from circuitpython_typing import ReadableBuffer
 except ImportError:
     pass
 
@@ -446,6 +448,8 @@ def reset(self) -> None:
         if self._debug:
             print("Resetting sensor")
         time.sleep(2)
+        self._transceive(bytes([_CMD_EX]))
+        time.sleep(0.001)
         self._transceive(bytes([_CMD_RT]))
         # burn a read post reset
         try:

From aeaef30aeb94a7da1cbb971523b622a132ab87f8 Mon Sep 17 00:00:00 2001
From: purepani <pani0028@umn.edu>
Date: Sun, 7 Apr 2024 20:38:04 -0500
Subject: [PATCH 096/107] Moves exit command before sleep

---
 adafruit_mlx90393.py | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index d0d530d..78e2fa5 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -445,11 +445,10 @@ def reset(self) -> None:
         """
         Performs a software reset of the sensor.
         """
+        self._transceive(bytes([_CMD_EX]))
         if self._debug:
             print("Resetting sensor")
         time.sleep(2)
-        self._transceive(bytes([_CMD_EX]))
-        time.sleep(0.001)
         self._transceive(bytes([_CMD_RT]))
         # burn a read post reset
         try:

From c3d7c2ca62960e43bf2cc9166ab45a02e9a4ac51 Mon Sep 17 00:00:00 2001
From: foamyguy <foamyguy@gmail.com>
Date: Sun, 8 Sep 2024 08:31:51 -0500
Subject: [PATCH 097/107] code format

---
 adafruit_mlx90393.py | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index 141a0e3..d8b4b7e 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -484,9 +484,15 @@ def read_data(self) -> Tuple[int, int, int]:
         if self._temperature_compensation and not resolutions.issubset(
             valid_tcomp_resolutions
         ):
-            resolutions_output = f"Current Resolutions:\n\tresolution_x: {self.resolution_x}\n\tresolution_y: {self.resolution_y}\n\tresolution_z: {self.resolution_z}"
+            resolutions_output = (
+                f"Current Resolutions:\n\t"
+                f"resolution_x: {self.resolution_x}\n\t"
+                f"resolution_y: {self.resolution_y}\n\t"
+                f"resolution_z: {self.resolution_z}"
+            )
             raise ValueError(
-                f"All resolutions must be RESOLUTION_16 or RESOLUTION_17 if temperature compensation is enabled.\n {resolutions_output}"
+                f"All resolutions must be RESOLUTION_16 or RESOLUTION_17"
+                f" if temperature compensation is enabled.\n {resolutions_output}"
             )
 
         # Set conversion delay based on filter and oversampling

From 88a83c40e7bd21b03856a94fa69c7b694d1d3079 Mon Sep 17 00:00:00 2001
From: foamyguy <foamyguy@gmail.com>
Date: Sun, 8 Sep 2024 09:26:01 -0500
Subject: [PATCH 098/107] fix string syntax for mpy-cross

---
 adafruit_mlx90393.py | 13 ++++++-------
 1 file changed, 6 insertions(+), 7 deletions(-)

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index d8b4b7e..d11c071 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -484,14 +484,13 @@ def read_data(self) -> Tuple[int, int, int]:
         if self._temperature_compensation and not resolutions.issubset(
             valid_tcomp_resolutions
         ):
-            resolutions_output = (
-                f"Current Resolutions:\n\t"
-                f"resolution_x: {self.resolution_x}\n\t"
-                f"resolution_y: {self.resolution_y}\n\t"
-                f"resolution_z: {self.resolution_z}"
-            )
+            resolutions_output = f"""Current Resolutions:
+\tresolution_x: {self.resolution_x}
+\tresolution_y: {self.resolution_y}
+\tresolution_z: {self.resolution_z}"""
+
             raise ValueError(
-                f"All resolutions must be RESOLUTION_16 or RESOLUTION_17"
+                "All resolutions must be RESOLUTION_16 or RESOLUTION_17"
                 f" if temperature compensation is enabled.\n {resolutions_output}"
             )
 

From 773a84663c9677003d437cb561859862156bbaaf Mon Sep 17 00:00:00 2001
From: foamyguy <foamyguy@gmail.com>
Date: Mon, 7 Oct 2024 09:24:05 -0500
Subject: [PATCH 099/107] remove deprecated get_html_theme_path() call

Signed-off-by: foamyguy <foamyguy@gmail.com>
---
 docs/conf.py | 1 -
 1 file changed, 1 deletion(-)

diff --git a/docs/conf.py b/docs/conf.py
index 52f3182..ab51a5d 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -112,7 +112,6 @@
 import sphinx_rtd_theme
 
 html_theme = "sphinx_rtd_theme"
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

From d6f2ac6a36f304274a2246d294d4901318d3e1a4 Mon Sep 17 00:00:00 2001
From: brian-eng <brian-eng@users.noreply.github.com>
Date: Tue, 26 Nov 2024 15:09:23 -0500
Subject: [PATCH 100/107] Add Axis Offset Compensation

Required when temperature compensation is enabled
---
 adafruit_mlx90393.py | 52 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index 79d79be..180e8aa 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -65,6 +65,9 @@
 _CMD_REG_CONF2 = const(0x01)  # Burst, comm mode, temperature compensation
 _CMD_REG_CONF3 = const(0x02)  # Oversampling, Filter, Resolution
 _CMD_REG_CONF4 = const(0x03)  # Sensitivity drift
+_CMD_REG_CONF5 = const(0x04)  # X-axis Offset Correction
+_CMD_REG_CONF6 = const(0x05)  # Y-axis Offset Correction
+_CMD_REG_CONF7 = const(0x06)  # Z-axis Offset Correction
 
 # Gain settings
 GAIN_5X = 0x0
@@ -212,6 +215,7 @@ def __init__(  # pylint: disable=too-many-arguments
         filt: int = FILTER_7,
         oversampling: int = OSR_3,
         temperature_compensation: bool = False,
+        offset: int = 0,
         debug: bool = False,
     ) -> None:
         self.i2c_device = I2CDevice(i2c_bus, address)
@@ -222,6 +226,7 @@ def __init__(  # pylint: disable=too-many-arguments
         self._osr = oversampling
         self._gain_current = gain
         self._temperature_compensation = temperature_compensation
+        self._off_x = self._off_y = self._off_z = offset
 
         # Put the device in a known state to start
         self.reset()
@@ -241,6 +246,11 @@ def __init__(  # pylint: disable=too-many-arguments
         self.gain = self._gain_current
         self.temperature_compensation = self._temperature_compensation
 
+        # Set offsets to supplied level
+        self.offset_x = self._off_x
+        self.offset_y = self._off_y
+        self.offset_z = self._off_z
+
     def _transceive(self, payload: ReadableBuffer, rxlen: int = 0) -> bytearray:
         """
         Writes the specified 'payload' to the sensor
@@ -402,6 +412,48 @@ def temperature_compensation(self, temperature_compensation: bool) -> None:
         self.write_reg(_CMD_REG_CONF2, reg)
         self._temperature_compensation = temperature_compensation
 
+    @property
+    def offset_x(self) -> int:
+        """The X axis offset."""
+        return self._off_x
+
+    @offset_x.setter
+    def offset_x(self, offset: int) -> None:
+        self._set_offset(0, offset)
+        self._off_x = offset
+
+    @property
+    def offset_y(self) -> int:
+        """The Y axis offset."""
+        return self._off_y
+
+    @offset_y.setter
+    def offset_y(self, offset: int) -> None:
+        self._set_offset(1, offset)
+        self._off_y = offset
+
+    @property
+    def offset_z(self) -> int:
+        """The Z axis offset."""
+        return self._off_z
+
+    @offset_z.setter
+    def offset_z(self, offset: int) -> None:
+        self._set_offset(2, offset)
+        self._off_z = offset
+
+    def _set_offset(self, axis: int, offset: int) -> None:
+        if offset < 0x0000 or offset > 0xFFFF :
+            raise ValueError("Incorrect offset setting.")
+        if axis == 0:
+            self.write_reg(_CMD_REG_CONF5, offset)
+        elif axis == 1:
+            self.write_reg(_CMD_REG_CONF6, offset)
+        elif axis == 2:
+            self.write_reg(_CMD_REG_CONF7, offset)
+        else:
+            raise ValueError("Incorrect axis setting.")
+
     def display_status(self) -> None:
         """
         Prints out the content of the last status byte in a human-readable

From 0f2be0eca4ac37a53eb35d26e594ceadfc745e9a Mon Sep 17 00:00:00 2001
From: brian-eng <brian-eng@users.noreply.github.com>
Date: Tue, 26 Nov 2024 15:37:14 -0500
Subject: [PATCH 101/107] Update adafruit_mlx90393.py

Fix lint error
---
 adafruit_mlx90393.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index 180e8aa..e71785b 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -443,7 +443,7 @@ def offset_z(self, offset: int) -> None:
         self._off_z = offset
 
     def _set_offset(self, axis: int, offset: int) -> None:
-        if offset < 0x0000 or offset > 0xFFFF :
+        if offset < 0x0000 or offset > 0xFFFF:
             raise ValueError("Incorrect offset setting.")
         if axis == 0:
             self.write_reg(_CMD_REG_CONF5, offset)

From e1a048c1ed679abd0ae3d81768af41fc5f9b923d Mon Sep 17 00:00:00 2001
From: foamyguy <foamyguy@gmail.com>
Date: Mon, 30 Dec 2024 09:00:26 -0600
Subject: [PATCH 102/107] sleep 2ms instead of 2 seconds

---
 adafruit_mlx90393.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index 79d79be..996ee3f 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -465,7 +465,7 @@ def reset(self) -> None:
         self._transceive(bytes([_CMD_EX]))
         if self._debug:
             print("Resetting sensor")
-        time.sleep(2)
+        time.sleep(.002)
         self._transceive(bytes([_CMD_RT]))
         # burn a read post reset
         try:

From 28db9a3d7760fa9677fee25ef4355f3d62aa33da Mon Sep 17 00:00:00 2001
From: foamyguy <foamyguy@gmail.com>
Date: Mon, 30 Dec 2024 09:05:35 -0600
Subject: [PATCH 103/107] format

---
 adafruit_mlx90393.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index 996ee3f..1acc49c 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -465,7 +465,7 @@ def reset(self) -> None:
         self._transceive(bytes([_CMD_EX]))
         if self._debug:
             print("Resetting sensor")
-        time.sleep(.002)
+        time.sleep(0.002)
         self._transceive(bytes([_CMD_RT]))
         # burn a read post reset
         try:

From ea1cb8d51418c2a80405c672892068ea847e251a Mon Sep 17 00:00:00 2001
From: foamyguy <foamyguy@gmail.com>
Date: Tue, 14 Jan 2025 11:32:34 -0600
Subject: [PATCH 104/107] add sphinx configuration to rtd.yaml

Signed-off-by: foamyguy <foamyguy@gmail.com>
---
 .readthedocs.yaml | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index 33c2a61..88bca9f 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -8,6 +8,9 @@
 # Required
 version: 2
 
+sphinx:
+  configuration: docs/conf.py
+
 build:
   os: ubuntu-20.04
   tools:

From d03ab192285bf337cb2f905d66c882ea9bd13f5a Mon Sep 17 00:00:00 2001
From: brian-eng <brian-eng@users.noreply.github.com>
Date: Thu, 30 Jan 2025 11:31:29 -0500
Subject: [PATCH 105/107] Speed up temperature readings

No reason to read the trimmed temperature reference every single time as it never changes, instead just read it once when reset.
---
 adafruit_mlx90393.py | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index dffe2cb..a562e82 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -226,6 +226,8 @@ def __init__(  # pylint: disable=too-many-arguments
         self._osr = oversampling
         self._gain_current = gain
         self._temperature_compensation = temperature_compensation
+        # Typical value according the application note
+        self._tref = 0xB668
         self._off_x = self._off_y = self._off_z = offset
 
         # Put the device in a known state to start
@@ -519,6 +521,12 @@ def reset(self) -> None:
             print("Resetting sensor")
         time.sleep(0.002)
         self._transceive(bytes([_CMD_RT]))
+
+        # Read the temperature reference from register 0x24
+        self._tref = self.read_reg(0x24)
+        if self._debug:
+            print("Tref = {}".format(hex(self._tref)))
+
         # burn a read post reset
         try:
             self.magnetic
@@ -614,9 +622,6 @@ def temperature(self) -> float:
         Reads a single temperature sample from the magnetometer.
         Temperature value in Celsius
         """
-        # Read the temperature reference from register 0x24
-        treference = self.read_reg(0x24)
-
         # Value taken from maximum time of temperature conversion on the datasheet section 12.
         # maximum time for temperature conversion = 1603 us
         delay = 0.1
@@ -637,4 +642,4 @@ def temperature(self) -> float:
         tvalue = struct.unpack(">H", data[1:3])[0]
         # See previous link for conversion formula
 
-        return 35 + ((tvalue - treference) / 45.2)
+        return 35 + ((tvalue - self._tref) / 45.2)

From 9647753770c0c7543aff548648474f02290813b6 Mon Sep 17 00:00:00 2001
From: foamyguy <foamyguy@gmail.com>
Date: Wed, 12 Feb 2025 16:06:54 -0600
Subject: [PATCH 106/107] try new I2C address in examples

---
 examples/mlx90393_simpletest.py  | 7 ++++++-
 examples/mlx90393_temperature.py | 7 ++++++-
 2 files changed, 12 insertions(+), 2 deletions(-)

diff --git a/examples/mlx90393_simpletest.py b/examples/mlx90393_simpletest.py
index b160216..b329475 100755
--- a/examples/mlx90393_simpletest.py
+++ b/examples/mlx90393_simpletest.py
@@ -7,7 +7,12 @@
 
 i2c = board.I2C()  # uses board.SCL and board.SDA
 # i2c = board.STEMMA_I2C()  # For using the built-in STEMMA QT connector on a microcontroller
-SENSOR = adafruit_mlx90393.MLX90393(i2c, gain=adafruit_mlx90393.GAIN_1X)
+try:
+    SENSOR = adafruit_mlx90393.MLX90393(i2c, gain=adafruit_mlx90393.GAIN_1X)
+except ValueError:
+    SENSOR = adafruit_mlx90393.MLX90393(
+        i2c, gain=adafruit_mlx90393.GAIN_1X, address=0x18
+    )
 
 while True:
     MX, MY, MZ = SENSOR.magnetic
diff --git a/examples/mlx90393_temperature.py b/examples/mlx90393_temperature.py
index 942bc1c..871014d 100644
--- a/examples/mlx90393_temperature.py
+++ b/examples/mlx90393_temperature.py
@@ -7,7 +7,12 @@
 
 i2c = board.I2C()  # uses board.SCL and board.SDA
 # i2c = board.STEMMA_I2C()  # For using the built-in STEMMA QT connector on a microcontroller
-SENSOR = adafruit_mlx90393.MLX90393(i2c, gain=adafruit_mlx90393.GAIN_1X)
+try:
+    SENSOR = adafruit_mlx90393.MLX90393(i2c, gain=adafruit_mlx90393.GAIN_1X)
+except ValueError:
+    SENSOR = adafruit_mlx90393.MLX90393(
+        i2c, gain=adafruit_mlx90393.GAIN_1X, address=0x18
+    )
 
 
 while True:

From 8483825df2c815ad154f0772b56586036b5568d4 Mon Sep 17 00:00:00 2001
From: foamyguy <foamyguy@gmail.com>
Date: Wed, 14 May 2025 20:12:18 +0000
Subject: [PATCH 107/107] change to ruff

---
 .gitattributes                   |  11 +
 .pre-commit-config.yaml          |  43 +---
 .pylintrc                        | 399 -------------------------------
 README.rst                       |   6 +-
 adafruit_mlx90393.py             |  23 +-
 docs/api.rst                     |   3 +
 docs/conf.py                     |   8 +-
 examples/mlx90393_simpletest.py  |  14 +-
 examples/mlx90393_temperature.py |   8 +-
 ruff.toml                        | 105 ++++++++
 10 files changed, 156 insertions(+), 464 deletions(-)
 create mode 100644 .gitattributes
 delete mode 100644 .pylintrc
 create mode 100644 ruff.toml

diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 0000000..21c125c
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense
+
+.py text eol=lf
+.rst text eol=lf
+.txt text eol=lf
+.yaml text eol=lf
+.toml text eol=lf
+.license text eol=lf
+.md text eol=lf
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 70ade69..ff19dde 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -1,42 +1,21 @@
-# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò
+# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries
 #
 # SPDX-License-Identifier: Unlicense
 
 repos:
-  - repo: https://github.com/python/black
-    rev: 23.3.0
-    hooks:
-      - id: black
-  - repo: https://github.com/fsfe/reuse-tool
-    rev: v1.1.2
-    hooks:
-      - id: reuse
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
       - id: check-yaml
       - id: end-of-file-fixer
       - id: trailing-whitespace
-  - repo: https://github.com/pycqa/pylint
-    rev: v2.17.4
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.4
     hooks:
-      - id: pylint
-        name: pylint (library code)
-        types: [python]
-        args:
-          - --disable=consider-using-f-string
-        exclude: "^(docs/|examples/|tests/|setup.py$)"
-      - id: pylint
-        name: pylint (example code)
-        description: Run pylint rules on "examples/*.py" files
-        types: [python]
-        files: "^examples/"
-        args:
-          - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code
-      - id: pylint
-        name: pylint (test code)
-        description: Run pylint rules on "tests/*.py" files
-        types: [python]
-        files: "^tests/"
-        args:
-          - --disable=missing-docstring,consider-using-f-string,duplicate-code
+      - id: ruff-format
+      - id: ruff
+        args: ["--fix"]
+  - repo: https://github.com/fsfe/reuse-tool
+    rev: v3.0.1
+    hooks:
+      - id: reuse
diff --git a/.pylintrc b/.pylintrc
deleted file mode 100644
index f945e92..0000000
--- a/.pylintrc
+++ /dev/null
@@ -1,399 +0,0 @@
-# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
-#
-# SPDX-License-Identifier: Unlicense
-
-[MASTER]
-
-# A comma-separated list of package or module names from where C extensions may
-# be loaded. Extensions are loading into the active Python interpreter and may
-# run arbitrary code
-extension-pkg-whitelist=
-
-# Add files or directories to the ignore-list. They should be base names, not
-# paths.
-ignore=CVS
-
-# Add files or directories matching the regex patterns to the ignore-list. The
-# regex matches against base names, not paths.
-ignore-patterns=
-
-# Python code to execute, usually for sys.path manipulation such as
-# pygtk.require().
-#init-hook=
-
-# Use multiple processes to speed up Pylint.
-jobs=1
-
-# List of plugins (as comma separated values of python modules names) to load,
-# usually to register additional checkers.
-load-plugins=pylint.extensions.no_self_use
-
-# Pickle collected data for later comparisons.
-persistent=yes
-
-# Specify a configuration file.
-#rcfile=
-
-# Allow loading of arbitrary C extensions. Extensions are imported into the
-# active Python interpreter and may run arbitrary code.
-unsafe-load-any-extension=no
-
-
-[MESSAGES CONTROL]
-
-# Only show warnings with the listed confidence levels. Leave empty to show
-# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
-confidence=
-
-# Disable the message, report, category or checker with the given id(s). You
-# can either give multiple identifiers separated by comma (,) or put this
-# option multiple times (only on the command line, not in the configuration
-# file where it should appear only once).You can also use "--disable=all" to
-# disable everything first and then reenable specific checks. For example, if
-# you want to run only the similarities checker, you can use "--disable=all
-# --enable=similarities". If you want to run only the classes checker, but have
-# no Warning level messages displayed, use"--disable=all --enable=classes
-# --disable=W"
-# disable=import-error,raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,deprecated-str-translate-call
-disable=raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,import-error,pointless-string-statement,unspecified-encoding
-
-# Enable the message, report, category or checker with the given id(s). You can
-# either give multiple identifier separated by comma (,) or put this option
-# multiple time (only on the command line, not in the configuration file where
-# it should appear only once). See also the "--disable" option for examples.
-enable=
-
-
-[REPORTS]
-
-# Python expression which should return a note less than 10 (10 is the highest
-# note). You have access to the variables errors warning, statement which
-# respectively contain the number of errors / warnings messages and the total
-# number of statements analyzed. This is used by the global evaluation report
-# (RP0004).
-evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
-
-# Template used to display messages. This is a python new-style format string
-# used to format the message information. See doc for all details
-#msg-template=
-
-# Set the output format. Available formats are text, parseable, colorized, json
-# and msvs (visual studio).You can also give a reporter class, eg
-# mypackage.mymodule.MyReporterClass.
-output-format=text
-
-# Tells whether to display a full report or only the messages
-reports=no
-
-# Activate the evaluation score.
-score=yes
-
-
-[REFACTORING]
-
-# Maximum number of nested blocks for function / method body
-max-nested-blocks=5
-
-
-[LOGGING]
-
-# Logging modules to check that the string format arguments are in logging
-# function parameter format
-logging-modules=logging
-
-
-[SPELLING]
-
-# Spelling dictionary name. Available dictionaries: none. To make it working
-# install python-enchant package.
-spelling-dict=
-
-# List of comma separated words that should not be checked.
-spelling-ignore-words=
-
-# A path to a file that contains private dictionary; one word per line.
-spelling-private-dict-file=
-
-# Tells whether to store unknown words to indicated private dictionary in
-# --spelling-private-dict-file option instead of raising a message.
-spelling-store-unknown-words=no
-
-
-[MISCELLANEOUS]
-
-# List of note tags to take in consideration, separated by a comma.
-# notes=FIXME,XXX,TODO
-notes=FIXME,XXX
-
-
-[TYPECHECK]
-
-# List of decorators that produce context managers, such as
-# contextlib.contextmanager. Add to this list to register other decorators that
-# produce valid context managers.
-contextmanager-decorators=contextlib.contextmanager
-
-# List of members which are set dynamically and missed by pylint inference
-# system, and so shouldn't trigger E1101 when accessed. Python regular
-# expressions are accepted.
-generated-members=
-
-# Tells whether missing members accessed in mixin class should be ignored. A
-# mixin class is detected if its name ends with "mixin" (case insensitive).
-ignore-mixin-members=yes
-
-# This flag controls whether pylint should warn about no-member and similar
-# checks whenever an opaque object is returned when inferring. The inference
-# can return multiple potential results while evaluating a Python object, but
-# some branches might not be evaluated, which results in partial inference. In
-# that case, it might be useful to still emit no-member and other checks for
-# the rest of the inferred objects.
-ignore-on-opaque-inference=yes
-
-# List of class names for which member attributes should not be checked (useful
-# for classes with dynamically set attributes). This supports the use of
-# qualified names.
-ignored-classes=optparse.Values,thread._local,_thread._local
-
-# List of module names for which member attributes should not be checked
-# (useful for modules/projects where namespaces are manipulated during runtime
-# and thus existing member attributes cannot be deduced by static analysis. It
-# supports qualified module names, as well as Unix pattern matching.
-ignored-modules=board
-
-# Show a hint with possible names when a member name was not found. The aspect
-# of finding the hint is based on edit distance.
-missing-member-hint=yes
-
-# The minimum edit distance a name should have in order to be considered a
-# similar match for a missing member name.
-missing-member-hint-distance=1
-
-# The total number of similar names that should be taken in consideration when
-# showing a hint for a missing member.
-missing-member-max-choices=1
-
-
-[VARIABLES]
-
-# List of additional names supposed to be defined in builtins. Remember that
-# you should avoid to define new builtins when possible.
-additional-builtins=
-
-# Tells whether unused global variables should be treated as a violation.
-allow-global-unused-variables=yes
-
-# List of strings which can identify a callback function by name. A callback
-# name must start or end with one of those strings.
-callbacks=cb_,_cb
-
-# A regular expression matching the name of dummy variables (i.e. expectedly
-# not used).
-dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
-
-# Argument names that match this expression will be ignored. Default to name
-# with leading underscore
-ignored-argument-names=_.*|^ignored_|^unused_
-
-# Tells whether we should check for unused import in __init__ files.
-init-import=no
-
-# List of qualified module names which can have objects that can redefine
-# builtins.
-redefining-builtins-modules=six.moves,future.builtins
-
-
-[FORMAT]
-
-# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
-# expected-line-ending-format=
-expected-line-ending-format=LF
-
-# Regexp for a line that is allowed to be longer than the limit.
-ignore-long-lines=^\s*(# )?<?https?://\S+>?$
-
-# Number of spaces of indent required inside a hanging  or continued line.
-indent-after-paren=4
-
-# String used as indentation unit. This is usually "    " (4 spaces) or "\t" (1
-# tab).
-indent-string='    '
-
-# Maximum number of characters on a single line.
-max-line-length=100
-
-# Maximum number of lines in a module
-max-module-lines=1000
-
-# Allow the body of a class to be on the same line as the declaration if body
-# contains single statement.
-single-line-class-stmt=no
-
-# Allow the body of an if to be on the same line as the test if there is no
-# else.
-single-line-if-stmt=no
-
-
-[SIMILARITIES]
-
-# Ignore comments when computing similarities.
-ignore-comments=yes
-
-# Ignore docstrings when computing similarities.
-ignore-docstrings=yes
-
-# Ignore imports when computing similarities.
-ignore-imports=yes
-
-# Minimum lines number of a similarity.
-min-similarity-lines=12
-
-
-[BASIC]
-
-# Regular expression matching correct argument names
-argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-# Regular expression matching correct attribute names
-attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-# Bad variable names which should always be refused, separated by a comma
-bad-names=foo,bar,baz,toto,tutu,tata
-
-# Regular expression matching correct class attribute names
-class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
-
-# Regular expression matching correct class names
-# class-rgx=[A-Z_][a-zA-Z0-9]+$
-class-rgx=[A-Z_][a-zA-Z0-9_]+$
-
-# Regular expression matching correct constant names
-const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
-
-# Minimum line length for functions/classes that require docstrings, shorter
-# ones are exempt.
-docstring-min-length=-1
-
-# Regular expression matching correct function names
-function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-# Good variable names which should always be accepted, separated by a comma
-# good-names=i,j,k,ex,Run,_
-good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_
-
-# Include a hint for the correct naming format with invalid-name
-include-naming-hint=no
-
-# Regular expression matching correct inline iteration names
-inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
-
-# Regular expression matching correct method names
-method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-# Regular expression matching correct module names
-module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
-
-# Colon-delimited sets of names that determine each other's naming style when
-# the name regexes allow several styles.
-name-group=
-
-# Regular expression which should only match function or class names that do
-# not require a docstring.
-no-docstring-rgx=^_
-
-# List of decorators that produce properties, such as abc.abstractproperty. Add
-# to this list to register other decorators that produce valid properties.
-property-classes=abc.abstractproperty
-
-# Regular expression matching correct variable names
-variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-
-[IMPORTS]
-
-# Allow wildcard imports from modules that define __all__.
-allow-wildcard-with-all=no
-
-# Analyse import fallback blocks. This can be used to support both Python 2 and
-# 3 compatible code, which means that the block might have code that exists
-# only in one or another interpreter, leading to false positives when analysed.
-analyse-fallback-blocks=no
-
-# Deprecated modules which should not be used, separated by a comma
-deprecated-modules=optparse,tkinter.tix
-
-# Create a graph of external dependencies in the given file (report RP0402 must
-# not be disabled)
-ext-import-graph=
-
-# Create a graph of every (i.e. internal and external) dependencies in the
-# given file (report RP0402 must not be disabled)
-import-graph=
-
-# Create a graph of internal dependencies in the given file (report RP0402 must
-# not be disabled)
-int-import-graph=
-
-# Force import order to recognize a module as part of the standard
-# compatibility libraries.
-known-standard-library=
-
-# Force import order to recognize a module as part of a third party library.
-known-third-party=enchant
-
-
-[CLASSES]
-
-# List of method names used to declare (i.e. assign) instance attributes.
-defining-attr-methods=__init__,__new__,setUp
-
-# List of member names, which should be excluded from the protected access
-# warning.
-exclude-protected=_asdict,_fields,_replace,_source,_make
-
-# List of valid names for the first argument in a class method.
-valid-classmethod-first-arg=cls
-
-# List of valid names for the first argument in a metaclass class method.
-valid-metaclass-classmethod-first-arg=mcs
-
-
-[DESIGN]
-
-# Maximum number of arguments for function / method
-max-args=5
-
-# Maximum number of attributes for a class (see R0902).
-# max-attributes=7
-max-attributes=11
-
-# Maximum number of boolean expressions in a if statement
-max-bool-expr=5
-
-# Maximum number of branch for function / method body
-max-branches=12
-
-# Maximum number of locals for function / method body
-max-locals=15
-
-# Maximum number of parents for a class (see R0901).
-max-parents=7
-
-# Maximum number of public methods for a class (see R0904).
-max-public-methods=20
-
-# Maximum number of return / yield for function / method body
-max-returns=6
-
-# Maximum number of statements in function / method body
-max-statements=50
-
-# Minimum number of public methods for a class (see R0903).
-min-public-methods=1
-
-
-[EXCEPTIONS]
-
-# Exceptions that will emit a warning when being caught. Defaults to
-# "Exception"
-overgeneral-exceptions=builtins.Exception
diff --git a/README.rst b/README.rst
index 4c189d8..076f234 100644
--- a/README.rst
+++ b/README.rst
@@ -13,9 +13,9 @@ Introduction
     :target: https://github.com/adafruit/Adafruit_CircuitPython_MLX90393/actions/
     :alt: Build Status
 
-.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
-    :target: https://github.com/psf/black
-    :alt: Code Style: Black
+.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+    :target: https://github.com/astral-sh/ruff
+    :alt: Code Style: Ruff
 
 Adafruit CircuitPython driver for the MLX90393 3-axis magnetometer.
 
diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py
index a562e82..f0587b4 100755
--- a/adafruit_mlx90393.py
+++ b/adafruit_mlx90393.py
@@ -168,7 +168,7 @@
 )
 
 
-class MLX90393:  # pylint: disable=too-many-instance-attributes
+class MLX90393:
     """
     Driver for the MLX90393 magnetometer.
 
@@ -206,7 +206,7 @@ class MLX90393:  # pylint: disable=too-many-instance-attributes
 
     """
 
-    def __init__(  # pylint: disable=too-many-arguments
+    def __init__(
         self,
         i2c_bus: I2C,
         address: int = 0x0C,
@@ -287,7 +287,7 @@ def _transceive(self, payload: ReadableBuffer, rxlen: int = 0) -> bytearray:
         self._status_last = data[0]
         # Unpack data (status byte, big-endian 16-bit register value)
         if self._debug:
-            print("\t[{}]".format(time.monotonic()))
+            print(f"\t[{time.monotonic()}]")
             print("\t Writing :", [hex(b) for b in payload])
             print("\tResponse :", [hex(b) for b in data])
             print("\t  Status :", hex(data[0]))
@@ -312,7 +312,7 @@ def gain(self, value: int) -> None:
         if value > GAIN_1X or value < GAIN_5X:
             raise ValueError("Invalid GAIN setting")
         if self._debug:
-            print("\tSetting gain: {}".format(value))
+            print(f"\tSetting gain: {value}")
         self._gain_current = value
         self._transceive(
             bytes(
@@ -356,12 +356,12 @@ def resolution_z(self, resolution: int) -> None:
         self._res_z = resolution
 
     def _set_resolution(self, axis: int, resolution: int) -> None:
-        if resolution not in (
+        if resolution not in {
             RESOLUTION_16,
             RESOLUTION_17,
             RESOLUTION_18,
             RESOLUTION_19,
-        ):
+        }:
             raise ValueError("Incorrect resolution setting.")
         shift = (5, 7, 9)[axis]
         mask = (0xFF9F, 0xFE7F, 0xF9FF)[axis]
@@ -464,7 +464,7 @@ def display_status(self) -> None:
         avail = 0
         if self._status_last & 0b11 > 0:
             avail = 2 * (self._status_last & 0b11) + 2
-        print("STATUS register = 0x{0:02X}".format(self._status_last))
+        print(f"STATUS register = 0x{self._status_last:02X}")
         print("BURST Mode               :", (self._status_last & (1 << 7)) > 0)
         print("WOC Mode                 :", (self._status_last & (1 << 6)) > 0)
         print("SM Mode                  :", (self._status_last & (1 << 5)) > 0)
@@ -488,7 +488,7 @@ def read_reg(self, reg: int) -> int:
         # Unpack data (status byte, big-endian 16-bit register value)
         self._status_last, val = struct.unpack(">BH", data)
         if self._debug:
-            print("\t[{}]".format(time.monotonic()))
+            print(f"\t[{time.monotonic()}]")
             print("\t Writing :", [hex(b) for b in payload])
             print("\tResponse :", [hex(b) for b in data])
             print("\t  Status :", hex(data[0]))
@@ -525,7 +525,7 @@ def reset(self) -> None:
         # Read the temperature reference from register 0x24
         self._tref = self.read_reg(0x24)
         if self._debug:
-            print("Tref = {}".format(hex(self._tref)))
+            print(f"Tref = {hex(self._tref)}")
 
         # burn a read post reset
         try:
@@ -542,9 +542,7 @@ def read_data(self) -> Tuple[int, int, int]:
 
         resolutions = {self.resolution_x, self.resolution_y, self.resolution_z}
         valid_tcomp_resolutions = {RESOLUTION_16, RESOLUTION_17}
-        if self._temperature_compensation and not resolutions.issubset(
-            valid_tcomp_resolutions
-        ):
+        if self._temperature_compensation and not resolutions.issubset(valid_tcomp_resolutions):
             resolutions_output = f"""Current Resolutions:
 \tresolution_x: {self.resolution_x}
 \tresolution_y: {self.resolution_y}
@@ -577,7 +575,6 @@ def read_data(self) -> Tuple[int, int, int]:
         # Return the raw int values if requested
         return m_x, m_y, m_z
 
-    # pylint: disable=no-self-use
     def _unpack_axis_data(self, resolution: int, data: ReadableBuffer) -> int:
         # see datasheet
         if resolution == RESOLUTION_19:
diff --git a/docs/api.rst b/docs/api.rst
index 380a279..e00d06e 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -4,5 +4,8 @@
 .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py)
 .. use this format as the module name: "adafruit_foo.foo"
 
+API Reference
+#############
+
 .. automodule:: adafruit_mlx90393
    :members:
diff --git a/docs/conf.py b/docs/conf.py
index ab51a5d..372090f 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,12 +1,10 @@
-# -*- coding: utf-8 -*-
-
 # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
 #
 # SPDX-License-Identifier: MIT
 
+import datetime
 import os
 import sys
-import datetime
 
 sys.path.insert(0, os.path.abspath(".."))
 
@@ -56,9 +54,7 @@
 creation_year = "2018"
 current_year = str(datetime.datetime.now().year)
 year_duration = (
-    current_year
-    if current_year == creation_year
-    else creation_year + " - " + current_year
+    current_year if current_year == creation_year else creation_year + " - " + current_year
 )
 copyright = year_duration + " Kevin Townsend"
 author = "Kevin Townsend"
diff --git a/examples/mlx90393_simpletest.py b/examples/mlx90393_simpletest.py
index b329475..2a26f34 100755
--- a/examples/mlx90393_simpletest.py
+++ b/examples/mlx90393_simpletest.py
@@ -2,7 +2,9 @@
 # SPDX-License-Identifier: MIT
 
 import time
+
 import board
+
 import adafruit_mlx90393
 
 i2c = board.I2C()  # uses board.SCL and board.SDA
@@ -10,16 +12,14 @@
 try:
     SENSOR = adafruit_mlx90393.MLX90393(i2c, gain=adafruit_mlx90393.GAIN_1X)
 except ValueError:
-    SENSOR = adafruit_mlx90393.MLX90393(
-        i2c, gain=adafruit_mlx90393.GAIN_1X, address=0x18
-    )
+    SENSOR = adafruit_mlx90393.MLX90393(i2c, gain=adafruit_mlx90393.GAIN_1X, address=0x18)
 
 while True:
     MX, MY, MZ = SENSOR.magnetic
-    print("[{}]".format(time.monotonic()))
-    print("X: {} uT".format(MX))
-    print("Y: {} uT".format(MY))
-    print("Z: {} uT".format(MZ))
+    print(f"[{time.monotonic()}]")
+    print(f"X: {MX} uT")
+    print(f"Y: {MY} uT")
+    print(f"Z: {MZ} uT")
     # Display the status field if an error occured, etc.
     if SENSOR.last_status > adafruit_mlx90393.STATUS_OK:
         SENSOR.display_status()
diff --git a/examples/mlx90393_temperature.py b/examples/mlx90393_temperature.py
index 871014d..cefc9e5 100644
--- a/examples/mlx90393_temperature.py
+++ b/examples/mlx90393_temperature.py
@@ -2,7 +2,9 @@
 # SPDX-License-Identifier: MIT
 
 import time
+
 import board
+
 import adafruit_mlx90393
 
 i2c = board.I2C()  # uses board.SCL and board.SDA
@@ -10,15 +12,13 @@
 try:
     SENSOR = adafruit_mlx90393.MLX90393(i2c, gain=adafruit_mlx90393.GAIN_1X)
 except ValueError:
-    SENSOR = adafruit_mlx90393.MLX90393(
-        i2c, gain=adafruit_mlx90393.GAIN_1X, address=0x18
-    )
+    SENSOR = adafruit_mlx90393.MLX90393(i2c, gain=adafruit_mlx90393.GAIN_1X, address=0x18)
 
 
 while True:
     temp = SENSOR.temperature
 
-    print("Temperature: {} °C".format(temp))
+    print(f"Temperature: {temp} °C")
 
     # Display the status field if an error occurred, etc.
     if SENSOR.last_status > adafruit_mlx90393.STATUS_OK:
diff --git a/ruff.toml b/ruff.toml
new file mode 100644
index 0000000..36332ff
--- /dev/null
+++ b/ruff.toml
@@ -0,0 +1,105 @@
+# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+target-version = "py38"
+line-length = 100
+
+[lint]
+preview = true
+select = ["I", "PL", "UP"]
+
+extend-select = [
+  "D419",  # empty-docstring
+  "E501",  # line-too-long
+  "W291",  # trailing-whitespace
+  "PLC0414",  # useless-import-alias
+  "PLC2401",  # non-ascii-name
+  "PLC2801",  # unnecessary-dunder-call
+  "PLC3002",  # unnecessary-direct-lambda-call
+  "E999",  # syntax-error
+  "PLE0101",  # return-in-init
+  "F706",  # return-outside-function
+  "F704",  # yield-outside-function
+  "PLE0116",  # continue-in-finally
+  "PLE0117",  # nonlocal-without-binding
+  "PLE0241",  # duplicate-bases
+  "PLE0302",  # unexpected-special-method-signature
+  "PLE0604",  # invalid-all-object
+  "PLE0605",  # invalid-all-format
+  "PLE0643",  # potential-index-error
+  "PLE0704",  # misplaced-bare-raise
+  "PLE1141",  # dict-iter-missing-items
+  "PLE1142",  # await-outside-async
+  "PLE1205",  # logging-too-many-args
+  "PLE1206",  # logging-too-few-args
+  "PLE1307",  # bad-string-format-type
+  "PLE1310",  # bad-str-strip-call
+  "PLE1507",  # invalid-envvar-value
+  "PLE2502",  # bidirectional-unicode
+  "PLE2510",  # invalid-character-backspace
+  "PLE2512",  # invalid-character-sub
+  "PLE2513",  # invalid-character-esc
+  "PLE2514",  # invalid-character-nul
+  "PLE2515",  # invalid-character-zero-width-space
+  "PLR0124",  # comparison-with-itself
+  "PLR0202",  # no-classmethod-decorator
+  "PLR0203",  # no-staticmethod-decorator
+  "UP004",  # useless-object-inheritance
+  "PLR0206",  # property-with-parameters
+  "PLR0904",  # too-many-public-methods
+  "PLR0911",  # too-many-return-statements
+  "PLR0912",  # too-many-branches
+  "PLR0913",  # too-many-arguments
+  "PLR0914",  # too-many-locals
+  "PLR0915",  # too-many-statements
+  "PLR0916",  # too-many-boolean-expressions
+  "PLR1702",  # too-many-nested-blocks
+  "PLR1704",  # redefined-argument-from-local
+  "PLR1711",  # useless-return
+  "C416",  # unnecessary-comprehension
+  "PLR1733",  # unnecessary-dict-index-lookup
+  "PLR1736",  # unnecessary-list-index-lookup
+
+  # ruff reports this rule is unstable
+  #"PLR6301",  # no-self-use
+
+  "PLW0108",  # unnecessary-lambda
+  "PLW0120",  # useless-else-on-loop
+  "PLW0127",  # self-assigning-variable
+  "PLW0129",  # assert-on-string-literal
+  "B033",  # duplicate-value
+  "PLW0131",  # named-expr-without-context
+  "PLW0245",  # super-without-brackets
+  "PLW0406",  # import-self
+  "PLW0602",  # global-variable-not-assigned
+  "PLW0603",  # global-statement
+  "PLW0604",  # global-at-module-level
+
+  # fails on the try: import typing used by libraries
+  #"F401",  # unused-import
+
+  "F841",  # unused-variable
+  "E722",  # bare-except
+  "PLW0711",  # binary-op-exception
+  "PLW1501",  # bad-open-mode
+  "PLW1508",  # invalid-envvar-default
+  "PLW1509",  # subprocess-popen-preexec-fn
+  "PLW2101",  # useless-with-lock
+  "PLW3301",  # nested-min-max
+]
+
+ignore = [
+    "PLR2004", # magic-value-comparison
+    "UP030", # format literals
+    "PLW1514",  # unspecified-encoding
+    "PLR0913", # too-many-arguments
+    "PLR0915", # too-many-statements
+    "PLR0917", # too-many-positional-arguments
+    "PLR0904", # too-many-public-methods
+    "PLR0912", # too-many-branches
+    "PLR0916", # too-many-boolean-expressions
+]
+
+[format]
+line-ending = "lf"