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

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

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

adafruit_circuitpython_mlx90393-2.3.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+adafruit_mlx90393.py,sha256=LRvJwO5NoOGxFvHsZOm7RoL-2k5Uj4tWY2jXM2gPiMA,21409
+adafruit_circuitpython_mlx90393-2.3.0.dist-info/LICENSE,sha256=WeIXVkYWpdba3Boxrax8dB0s5qWg9GTxl7c5uTZQDUI,1105
+adafruit_circuitpython_mlx90393-2.3.0.dist-info/METADATA,sha256=2fwE481A0KquP94E2w_CYgMt2fskSfmbHqn0XWCpATc,4084
+adafruit_circuitpython_mlx90393-2.3.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+adafruit_circuitpython_mlx90393-2.3.0.dist-info/top_level.txt,sha256=5RT_YbHfXFo2Y6zVvz8MXsZLIHm1OxrjFJrzRaCTdNY,18
+adafruit_circuitpython_mlx90393-2.3.0.dist-info/RECORD,,

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

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

adafruit_mlx90393.py

@@ -43,7 +43,7 @@ try:
 except ImportError:
     pass
 
-__version__ = "2.2.0"
+__version__ = "2.3.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_MLX90393.git"
 
 _CMD_SB = const(0b00010000)  # Start burst mode
@@ -65,6 +65,9 @@ _CMD_REG_CONF1 = const(0x00)  # Gain
 _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 @@ class MLX90393:  # pylint: disable=too-many-instance-attributes
         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 @@ class MLX90393:  # pylint: disable=too-many-instance-attributes
         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 @@ class MLX90393:  # pylint: disable=too-many-instance-attributes
         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 @@ class MLX90393:  # pylint: disable=too-many-instance-attributes
         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

adafruit_circuitpython_mlx90393-2.2.0.dist-info/RECORD

@@ -1,6 +0,0 @@
-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,,