adafruit-circuitpython-mlx90393 2.1.4__py3-none-any.whl → 2.2.0__py3-none-any.whl

{adafruit_circuitpython_mlx90393-2.1.4.dist-info → adafruit_circuitpython_mlx90393-2.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: adafruit-circuitpython-mlx90393
-Version: 2.1.4
+Version: 2.2.0
 Summary: CircuitPython driver for the MLX90393 3-axis magnetometer.
 Author-email: Adafruit Industries <circuitpython@adafruit.com>
 License: MIT
@@ -14,7 +14,7 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: Adafruit-Blinka >=7.0.0
+Requires-Dist: Adafruit-Blinka>=7.0.0
 Requires-Dist: adafruit-circuitpython-busdevice
 Requires-Dist: adafruit-circuitpython-typing
 Provides-Extra: optional

adafruit_circuitpython_mlx90393-2.2.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+adafruit_mlx90393.py,sha256=x01r3I_OliE3J9tt3Y_0LQswVOjCqI-mYmqusmwyixY,19835
+adafruit_circuitpython_mlx90393-2.2.0.dist-info/LICENSE,sha256=WeIXVkYWpdba3Boxrax8dB0s5qWg9GTxl7c5uTZQDUI,1105
+adafruit_circuitpython_mlx90393-2.2.0.dist-info/METADATA,sha256=wG-t6WHv4TEbnl3J9sx9iqjMUBCauluWJvauc9HIq8A,4084
+adafruit_circuitpython_mlx90393-2.2.0.dist-info/WHEEL,sha256=cVxcB9AmuTcXqmwrtPhNK88dr7IR_b6qagTj0UvIEbY,91
+adafruit_circuitpython_mlx90393-2.2.0.dist-info/top_level.txt,sha256=5RT_YbHfXFo2Y6zVvz8MXsZLIHm1OxrjFJrzRaCTdNY,18
+adafruit_circuitpython_mlx90393-2.2.0.dist-info/RECORD,,

{adafruit_circuitpython_mlx90393-2.1.4.dist-info → adafruit_circuitpython_mlx90393-2.2.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.43.0)
+Generator: setuptools (74.1.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

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.4"
+__version__ = "2.2.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_MLX90393.git"
 
 _CMD_SB = const(0b00010000)  # Start burst mode
@@ -60,7 +62,7 @@ _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
 
@@ -209,6 +211,7 @@ class MLX90393:  # pylint: disable=too-many-instance-attributes
         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 @@ class MLX90393:  # pylint: disable=too-many-instance-attributes
         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 @@ 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
 
     def _transceive(self, payload: ReadableBuffer, rxlen: int = 0) -> bytearray:
         """
@@ -383,6 +388,20 @@ 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
+
     def display_status(self) -> None:
         """
         Prints out the content of the last status byte in a human-readable
@@ -443,6 +462,7 @@ 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)
@@ -459,6 +479,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
@@ -490,6 +526,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.4.dist-info/RECORD

@@ -1,6 +0,0 @@
-adafruit_mlx90393.py,sha256=Eq_i3wioTBwNsQfr-Z-aeSkW5mvAx7GEWdXgK1c6VIc,18281
-adafruit_circuitpython_mlx90393-2.1.4.dist-info/LICENSE,sha256=WeIXVkYWpdba3Boxrax8dB0s5qWg9GTxl7c5uTZQDUI,1105
-adafruit_circuitpython_mlx90393-2.1.4.dist-info/METADATA,sha256=ES262PDC-d8JY8vvSwB8Wxp1Pvl9g9Fda3RJ2ksSbdw,4085
-adafruit_circuitpython_mlx90393-2.1.4.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-adafruit_circuitpython_mlx90393-2.1.4.dist-info/top_level.txt,sha256=5RT_YbHfXFo2Y6zVvz8MXsZLIHm1OxrjFJrzRaCTdNY,18
-adafruit_circuitpython_mlx90393-2.1.4.dist-info/RECORD,,