adafruit-circuitpython-mlx90393 2.1.3__tar.gz → 2.3.2__tar.gz

{adafruit-circuitpython-mlx90393-2.1.3 → adafruit_circuitpython_mlx90393-2.3.2}/.readthedocs.yaml

@@ -8,6 +8,9 @@
 # Required
 version: 2
 
+sphinx:
+  configuration: docs/conf.py
+
 build:
   os: ubuntu-20.04
   tools:

{adafruit-circuitpython-mlx90393-2.1.3 → adafruit_circuitpython_mlx90393-2.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: adafruit-circuitpython-mlx90393
-Version: 2.1.3
+Version: 2.3.2
 Summary: CircuitPython driver for the MLX90393 3-axis magnetometer.
 Author-email: Adafruit Industries <circuitpython@adafruit.com>
 License: MIT

{adafruit-circuitpython-mlx90393-2.1.3 → adafruit_circuitpython_mlx90393-2.3.2}/adafruit_circuitpython_mlx90393.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: adafruit-circuitpython-mlx90393
-Version: 2.1.3
+Version: 2.3.2
 Summary: CircuitPython driver for the MLX90393 3-axis magnetometer.
 Author-email: Adafruit Industries <circuitpython@adafruit.com>
 License: MIT

{adafruit-circuitpython-mlx90393-2.1.3 → adafruit_circuitpython_mlx90393-2.3.2}/adafruit_mlx90393.py

@@ -28,6 +28,7 @@ Implementation Notes
   https://github.com/adafruit/Adafruit_CircuitPython_Register
 
 """
+
 import struct
 import time
 
@@ -36,12 +37,13 @@ from micropython import const
 
 try:
     from typing import Tuple
-    from circuitpython_typing import ReadableBuffer
+
     from busio import I2C
+    from circuitpython_typing import ReadableBuffer
 except ImportError:
     pass
 
-__version__ = "2.1.3"
+__version__ = "2.3.2"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_MLX90393.git"
 
 _CMD_SB = const(0b00010000)  # Start burst mode
@@ -60,9 +62,12 @@ _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
+_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
@@ -209,6 +214,8 @@ class MLX90393:  # pylint: disable=too-many-instance-attributes
         resolution: int = RESOLUTION_16,
         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)
@@ -218,6 +225,8 @@ class MLX90393:  # pylint: disable=too-many-instance-attributes
         self._filter = filt
         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()
@@ -235,6 +244,12 @@ class MLX90393:  # pylint: disable=too-many-instance-attributes
 
         # Set gain to the supplied level
         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:
         """
@@ -383,6 +398,62 @@ class MLX90393:  # pylint: disable=too-many-instance-attributes
         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
+
+    @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
@@ -406,15 +477,12 @@ class MLX90393:  # pylint: disable=too-many-instance-attributes
 
         :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:
@@ -446,9 +514,10 @@ class MLX90393:  # pylint: disable=too-many-instance-attributes
         """
         Performs a software reset of the sensor.
         """
+        self._transceive(bytes([_CMD_EX]))
         if self._debug:
             print("Resetting sensor")
-        time.sleep(2)
+        time.sleep(0.002)
         self._transceive(bytes([_CMD_RT]))
         # burn a read post reset
         try:
@@ -462,6 +531,22 @@ class MLX90393:  # pylint: disable=too-many-instance-attributes
         """
         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:
+\tresolution_x: {self.resolution_x}
+\tresolution_y: {self.resolution_y}
+\tresolution_z: {self.resolution_z}"""
+
+            raise ValueError(
+                "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
         delay = _TCONV_LOOKUP[self._filter][self._osr] / 1000  # per datasheet
         delay *= 1.1  # plus a little
@@ -493,6 +578,9 @@ class MLX90393:  # pylint: disable=too-many-instance-attributes
         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

{adafruit-circuitpython-mlx90393-2.1.3 → adafruit_circuitpython_mlx90393-2.3.2}/docs/conf.py

@@ -112,7 +112,6 @@ napoleon_numpy_docstring = False
 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,

{adafruit-circuitpython-mlx90393-2.1.3 → adafruit_circuitpython_mlx90393-2.3.2}/pyproject.toml

@@ -12,7 +12,7 @@ requires = [
 [project]
 name = "adafruit-circuitpython-mlx90393"
 description = "CircuitPython driver for the MLX90393 3-axis magnetometer."
-version = "2.1.3"
+version = "2.3.2"
 readme = "README.rst"
 authors = [
     {name = "Adafruit Industries", email = "circuitpython@adafruit.com"}