added range setting

Author: siddacious

adafruit_lis3mdl.py

@@ -43,7 +43,7 @@
 * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
 * Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register
 """
-
+from time import sleep
 from micropython import const
 import adafruit_bus_device.i2c_device as i2c_device
 from adafruit_register.i2c_struct import ROUnaryStruct, Struct
@@ -73,13 +73,36 @@
 
 _GAUSS_TO_MT = 0.1 #1 Gauss [G] =   0.1 Millitesla [mT]
 
-# /** The magnetometer ranges */
-# typedef enum {
-#   LIS3MDL_RANGE_4_GAUSS = 0b00,  ///< +/- 4g (default value)
-#   LIS3MDL_RANGE_8_GAUSS = 0b01,  ///< +/- 8g
-#   LIS3MDL_RANGE_12_GAUSS = 0b10, ///< +/- 12g
-#   LIS3MDL_RANGE_16_GAUSS = 0b11, ///< +/- 16g
-# } lis3mdl_range_t;
+class CV:
+    """struct helper"""
+
+    @classmethod
+    def add_values(cls, value_tuples):
+        "creates CV entires"
+        cls.string = {}
+        cls.lsb = {}
+
+        for value_tuple in value_tuples:
+            name, value, string, lsb = value_tuple
+            setattr(cls, name, value)
+            cls.string[value] = string
+            cls.lsb[value] = lsb
+
+    @classmethod
+    def is_valid(cls, value):
+        "Returns true if the given value is a member of the CV"
+        return value in cls.string
+
+class Range(CV):
+    """Options for ``accelerometer_range``"""
+    pass #pylint: disable=unnecessary-pass
+
+Range.add_values((
+    ('RANGE_4_GAUSS', 0, 4, 6842),
+    ('RANGE_8_GAUSS', 1, 8, 3421),
+    ('RANGE_12_GAUSS', 2, 12, 2281),
+    ('RANGE_16_GAUSS', 3, 16, 1711)
+))
 
 
 # lis3mdl_range_t range = getRange();
@@ -93,7 +116,6 @@
 # if (range == LIS3MDL_RANGE_4_GAUSS)
 #     scale = 6842;
 
-
 # /** The magnetometer data rate, includes FAST_ODR bit */
 # typedef enum {
 #   LIS3MDL_DATARATE_0_625_HZ = 0b0000, ///<  0.625 Hz
@@ -155,27 +177,56 @@ def __init__(self, i2c_bus, address=_LIS3MDL_DEFAULT_ADDRESS):
         # // 155Hz default rate
         # setDataRate(LIS3MDL_DATARATE_155_HZ);
 
-        # // lowest range
-        # setRange(LIS3MDL_RANGE_4_GAUSS);
-        self._range = 0
+
+        self.range = Range.RANGE_4_GAUSS #pylint: disable=no-member
 
         # setOperationMode(LIS3MDL_CONTINUOUSMODE);
-        self._operation_mode = 0
+        self._operation_mode = 0 # enable, take out of shutdown
+        sleep(0.010)
     def reset(self): #pylint: disable=no-self-use
         """Reset the sensor to the default state set by the library"""
 
-        print("reeeset")
+        print("called reset")
+        # reset
+        # sleep(0.010)
 
     @property
     def magnetic(self):
         """How do they even work?!"""
 
         raw_mag_data = self._raw_mag_data
-        x = self._scale_mag_data(raw_mag_data[0]) * _GAUSS_TO_MT
-        y = self._scale_mag_data(raw_mag_data[1]) * _GAUSS_TO_MT
-        z = self._scale_mag_data(raw_mag_data[2]) * _GAUSS_TO_MT
+        x = self._scale_mag_data(raw_mag_data[0])
+        y = self._scale_mag_data(raw_mag_data[1])
+        z = self._scale_mag_data(raw_mag_data[2])
+
         return(x, y, z)
+
     def _scale_mag_data(self, raw_measurement): #pylint: disable=no-self-use
+        return (raw_measurement / Range.lsb[self.range]) * _GAUSS_TO_MT
 
-        scale = 6842
-        return raw_measurement/scale
+    @property
+    def range(self):
+        """The measurement range for the magnetic sensor. Must be a ``Range``"""
+        return self._range
+
+    @range.setter
+    def range(self, value):
+        if not Range.is_valid(value):
+            raise AttributeError("``range`` must be a ``Range``")
+
+        self._range = value
+
+        sleep(0.010)
+
+    # @property
+    # def data_rate(self):
+    #     """The rate at which the sensor takes measurements. Must be a ``Rate``"""
+    #     return self._data_rate
+
+    # @data_rate.setter
+    # def data_rate(self, value):
+    #     check value is valid
+    #     set performance mode
+    #     sleep(0.010)
+    #
+    #     self._data_rate = value

examples/lis3mdl_range_test.py

@@ -0,0 +1,23 @@
+""" Test Each range """
+#pylint: disable=no-member
+import time
+import board
+import busio
+from adafruit_lis3mdl import LIS3MDL, Range
+
+i2c = busio.I2C(board.SCL, board.SDA)
+sensor = LIS3MDL(i2c)
+
+while True:
+
+    for mag_range in [Range.RANGE_4_GAUSS,
+                      Range.RANGE_8_GAUSS,
+                      Range.RANGE_12_GAUSS,
+                      Range.RANGE_16_GAUSS]:
+        sensor.range = mag_range
+        print("Range: %d Gauss" % Range.string[sensor.range])
+        mag_x, mag_y, mag_z = sensor.magnetic
+
+        print('X:{0:10.2f}, Y:{1:10.2f}, Z:{2:10.2f} uT'.format(mag_x, mag_y, mag_z))
+        print('')
+        time.sleep(0.3)