Merge branch 'i2cdevice-next'

Author: Gadgetoid

examples/bargraph.py

@@ -1,7 +1,9 @@
 import time
 import os
 import sys
-import as7262
+from as7262 import AS7262
+
+as7262 = AS7262()
 
 BAR_CHAR = u'\u2588'
 
@@ -14,7 +16,6 @@
 MAX_VALUE = 14000.0
 BAR_WIDTH = 25
 
-as7262.soft_reset()
 as7262.set_gain(64)
 as7262.set_integration_time(17.857)
 as7262.set_measurement_mode(2)

examples/spectrum.py

@@ -1,6 +1,7 @@
-import as7262
+from as7262 import AS7262
+
+as7262 = AS7262()
 
-as7262.soft_reset()
 as7262.set_gain(64)
 as7262.set_integration_time(17.857)
 as7262.set_measurement_mode(2)

library/CHANGELOG.txt

@@ -1,3 +1,9 @@
+0.1.0
+-----
+
+* Port to new i2cdevice API
+* Breaking change from singleton module to AS7262 class
+
 0.0.2
 -----
 

library/as7262/__init__.py

@@ -2,11 +2,10 @@
 import time
 import struct
 
-import smbus
 from i2cdevice import Device, Register, BitField, _int_to_bytes
 from i2cdevice.adapter import Adapter, LookupAdapter
 
-__version__ = '0.0.2'
+__version__ = '0.1.0'
 
 
 class as7262VirtualRegisterBus():
@@ -19,13 +18,17 @@ class as7262VirtualRegisterBus():
 
     """
 
-    def __init__(self, bus=1):
+    def __init__(self, i2c_dev=None):
         """Initialise virtual register class.
 
         :param bus: SMBus bus ID
 
         """
-        self._i2c_bus = smbus.SMBus(bus)
+        if i2c_dev is None:
+            import smbus
+            self._i2c_bus = smbus.SMBus(1)
+        else:
+            self._i2c_bus = i2c_dev
 
     def get_status(self, address):
         """Return the AS7262 status register."""
@@ -86,82 +89,6 @@ def _encode(self, value):
         return int(value * 2.8) & 0xff
 
 
-_as7262 = Device(0x49, i2c_dev=as7262VirtualRegisterBus(1), bit_width=8, registers=(
-    Register('VERSION', 0x00, fields=(
-        BitField('hw_type', 0xFF000000),
-        BitField('hw_version', 0x00FF0000),
-        BitField('fw_version', 0x0000FFFF, adapter=FWVersionAdapter()),
-    ), bit_width=32, read_only=True),
-    Register('CONTROL', 0x04, fields=(
-        BitField('reset', 0b10000000),
-        BitField('interrupt', 0b01000000),
-        BitField('gain_x', 0b00110000, adapter=LookupAdapter({
-            1: 0b00, 3.7: 0b01, 16: 0b10, 64: 0b11
-        })),
-        BitField('measurement_mode', 0b00001100),
-        BitField('data_ready', 0b00000010),
-    )),
-    Register('INTEGRATION_TIME', 0x05, fields=(
-        BitField('ms', 0xFF, adapter=IntegrationTimeAdapter()),
-    )),
-    Register('TEMPERATURE', 0x06, fields=(
-        BitField('degrees_c', 0xFF),
-    )),
-    Register('LED_CONTROL', 0x07, fields=(
-        BitField('illumination_current_limit_ma', 0b00110000, adapter=LookupAdapter({
-            12.5: 0b00, 25: 0b01, 50: 0b10, 100: 0b11
-        })),
-        BitField('illumination_enable', 0b00001000),
-        BitField('indicator_current_limit_ma', 0b00000110, adapter=LookupAdapter({
-            1: 0b00, 2: 0b01, 4: 0b10, 8: 0b11
-        })),
-        BitField('indicator_enable', 0b00000001),
-    )),
-    Register('DATA', 0x08, fields=(
-        BitField('v', 0xFFFF00000000000000000000),
-        BitField('b', 0x0000FFFF0000000000000000),
-        BitField('g', 0x00000000FFFF000000000000),
-        BitField('y', 0x000000000000FFFF00000000),
-        BitField('o', 0x0000000000000000FFFF0000),
-        BitField('r', 0x00000000000000000000FFFF),
-    ), bit_width=96),
-    Register('CALIBRATED_DATA', 0x14, fields=(
-        BitField('v', 0xFFFFFFFF << (32 * 5), adapter=FloatAdapter()),
-        BitField('b', 0xFFFFFFFF << (32 * 4), adapter=FloatAdapter()),
-        BitField('g', 0xFFFFFFFF << (32 * 3), adapter=FloatAdapter()),
-        BitField('y', 0xFFFFFFFF << (32 * 2), adapter=FloatAdapter()),
-        BitField('o', 0xFFFFFFFF << (32 * 1), adapter=FloatAdapter()),
-        BitField('r', 0xFFFFFFFF << (32 * 0), adapter=FloatAdapter()),
-    ), bit_width=192),
-))
-
-# TODO : Integrate into i2cdevice so that LookupAdapter fields can always be exported to constants
-# Iterate through all register fields and export their lookup tables to constants
-for register in _as7262.registers:
-    register = _as7262.registers[register]
-    for field in register.fields:
-        field = register.fields[field]
-        if isinstance(field.adapter, LookupAdapter):
-            for key in field.adapter.lookup_table:
-                value = field.adapter.lookup_table[key]
-                name = 'AS7262_{register}_{field}_{key}'.format(
-                    register=register.name,
-                    field=field.name,
-                    key=key
-                ).upper()
-                locals()[name] = key
-
-
-def soft_reset():
-    """Set the soft reset register bit of the AS7262."""
-    _as7262.CONTROL.set_reset(1)
-    # Polling for the state of the reset flag does not work here
-    # since the fragile virtual register state machine cannot
-    # respond while in a soft reset condition
-    # So, just wait long enough for it to reset fully...
-    time.sleep(2.0)
-
-
 class CalibratedValues:
     """Store the 6 band spectral values."""
 
@@ -178,88 +105,149 @@ def __iter__(self):  # noqa D107
             yield getattr(self, colour)
 
 
-def get_calibrated_values(timeout=10):
-    """Return an instance of CalibratedValues containing the 6 spectral bands."""
-    t_start = time.time()
-    while _as7262.CONTROL.get_data_ready() == 0 and (time.time() - t_start) <= timeout:
-        pass
-    with _as7262.CALIBRATED_DATA as DATA:
-        return CalibratedValues(DATA.get_r(),
-                                DATA.get_o(),
-                                DATA.get_y(),
-                                DATA.get_g(),
-                                DATA.get_b(),
-                                DATA.get_v())
-
-
-def set_gain(gain):
-    """Set the gain amount of the AS7262.
-
-    :param gain: gain multiplier, one of 1, 3.7, 16 or 64
-
-    """
-    _as7262.CONTROL.set_gain_x(gain)
-
-
-def set_measurement_mode(mode):
-    """Set the AS7262 measurement mode.
-
-    :param mode: 0-3
-
-    """
-    _as7262.CONTROL.set_measurement_mode(mode)
-
-
-def set_integration_time(time_ms):
-    """Set the AS7262 sensor integration time in milliseconds.
+class AS7262:
+    def __init__(self, i2c_dev=None):
+        self._as7262 = Device(0x49, i2c_dev=as7262VirtualRegisterBus(i2c_dev=i2c_dev), bit_width=8, registers=(
+            Register('VERSION', 0x00, fields=(
+                BitField('hw_type', 0xFF000000),
+                BitField('hw_version', 0x00FF0000),
+                BitField('fw_version', 0x0000FFFF, adapter=FWVersionAdapter()),
+            ), bit_width=32, read_only=True),
+            Register('CONTROL', 0x04, fields=(
+                BitField('reset', 0b10000000),
+                BitField('interrupt', 0b01000000),
+                BitField('gain_x', 0b00110000, adapter=LookupAdapter({
+                    1: 0b00, 3.7: 0b01, 16: 0b10, 64: 0b11
+                })),
+                BitField('measurement_mode', 0b00001100),
+                BitField('data_ready', 0b00000010),
+            )),
+            Register('INTEGRATION_TIME', 0x05, fields=(
+                BitField('ms', 0xFF, adapter=IntegrationTimeAdapter()),
+            )),
+            Register('TEMPERATURE', 0x06, fields=(
+                BitField('degrees_c', 0xFF),
+            )),
+            Register('LED_CONTROL', 0x07, fields=(
+                BitField('illumination_current_limit_ma', 0b00110000, adapter=LookupAdapter({
+                    12.5: 0b00, 25: 0b01, 50: 0b10, 100: 0b11
+                })),
+                BitField('illumination_enable', 0b00001000),
+                BitField('indicator_current_limit_ma', 0b00000110, adapter=LookupAdapter({
+                    1: 0b00, 2: 0b01, 4: 0b10, 8: 0b11
+                })),
+                BitField('indicator_enable', 0b00000001),
+            )),
+            Register('DATA', 0x08, fields=(
+                BitField('v', 0xFFFF00000000000000000000),
+                BitField('b', 0x0000FFFF0000000000000000),
+                BitField('g', 0x00000000FFFF000000000000),
+                BitField('y', 0x000000000000FFFF00000000),
+                BitField('o', 0x0000000000000000FFFF0000),
+                BitField('r', 0x00000000000000000000FFFF),
+            ), bit_width=96),
+            Register('CALIBRATED_DATA', 0x14, fields=(
+                BitField('v', 0xFFFFFFFF << (32 * 5), adapter=FloatAdapter()),
+                BitField('b', 0xFFFFFFFF << (32 * 4), adapter=FloatAdapter()),
+                BitField('g', 0xFFFFFFFF << (32 * 3), adapter=FloatAdapter()),
+                BitField('y', 0xFFFFFFFF << (32 * 2), adapter=FloatAdapter()),
+                BitField('o', 0xFFFFFFFF << (32 * 1), adapter=FloatAdapter()),
+                BitField('r', 0xFFFFFFFF << (32 * 0), adapter=FloatAdapter()),
+            ), bit_width=192),
+        ))
+
+        # TODO : Integrate into i2cdevice so that LookupAdapter fields can always be exported to constants
+        # Iterate through all register fields and export their lookup tables to constants
+        for register in self._as7262.registers:
+            register = self._as7262.registers[register]
+            for field in register.fields:
+                field = register.fields[field]
+                if isinstance(field.adapter, LookupAdapter):
+                    for key in field.adapter.lookup_table:
+                        value = field.adapter.lookup_table[key]
+                        name = 'AS7262_{register}_{field}_{key}'.format(
+                            register=register.name,
+                            field=field.name,
+                            key=key
+                        ).upper()
+                        locals()[name] = key
+
+        self.soft_reset()
+
+    def soft_reset(self):
+        """Set the soft reset register bit of the AS7262."""
+        self._as7262.set('CONTROL', reset=1)
+        # Polling for the state of the reset flag does not work here
+        # since the fragile virtual register state machine cannot
+        # respond while in a soft reset condition
+        # So, just wait long enough for it to reset fully...
+        time.sleep(2.0)
+
+    def get_calibrated_values(self, timeout=10):
+        """Return an instance of CalibratedValues containing the 6 spectral bands."""
+        t_start = time.time()
+        while self._as7262.get('CONTROL').data_ready == 0 and (time.time() - t_start) <= timeout:
+            pass
+        data = self._as7262.get('CALIBRATED_DATA')
+        return CalibratedValues(data.r, data.o, data.y, data.g, data.b, data.v)
+
+    def set_gain(self, gain):
+        """Set the gain amount of the AS7262.
+
+        :param gain: gain multiplier, one of 1, 3.7, 16 or 64
 
-    :param time_ms: Time in milliseconds from 0 to ~91
+        """
+        self._as7262.set('CONTROL', gain_x=gain)
 
-    """
-    _as7262.INTEGRATION_TIME.set_ms(time_ms)
+    def set_measurement_mode(self, mode):
+        """Set the AS7262 measurement mode.
 
+        :param mode: 0-3
 
-def set_illumination_led_current(current):
-    """Set the AS7262 illumination LED current in milliamps.
+        """
+        self._as7262.set('CONTROL', measurement_mode=mode)
 
-    :param current: Value in milliamps, one of 12.5, 25, 50 or 100
+    def set_integration_time(self, time_ms):
+        """Set the AS7262 sensor integration time in milliseconds.
 
-    """
-    _as7262.LED_CONTROL.set_illumination_current_limit_ma(current)
+        :param time_ms: Time in milliseconds from 0 to ~91
 
+        """
+        self._as7262.set('INTEGRATION_TIME', ms=time_ms)
 
-def set_indicator_led_current(current):
-    """Set the AS7262 indicator LED current in milliamps.
-
-    :param current: Value in milliamps, one of 1, 2, 4 or 8
+    def set_illumination_led_current(self, current):
+        """Set the AS7262 illumination LED current in milliamps.
 
-    """
-    _as7262.LED_CONTROL.set_indicator_current_limit_ma(current)
+        :param current: Value in milliamps, one of 12.5, 25, 50 or 100
 
+        """
+        self._as7262.set('LED_CONTROL', illumination_current_limit_ma=current)
 
-def set_illumination_led(state):
-    """Set the AS7262 illumination LED state.
+    def set_indicator_led_current(self, current):
+        """Set the AS7262 indicator LED current in milliamps.
 
-    :param state: True = On, False = Off
+        :param current: Value in milliamps, one of 1, 2, 4 or 8
 
-    """
-    _as7262.LED_CONTROL.set_illumination_enable(state)
+        """
+        self._as7262.set('LED_CONTROL', indicator_current_limit_ma=current)
 
+    def set_illumination_led(self, state):
+        """Set the AS7262 illumination LED state.
 
-def set_indicator_led(state):
-    """Set the AS7262 indicator LED state.
+        :param state: True = On, False = Off
 
-    :param state: True = On, False = Off
+        """
+        self._as7262.set('LED_CONTROL', illumination_enable=state)
 
-    """
-    _as7262.LED_CONTROL.set_indicator_enable(state)
+    def set_indicator_led(self, state):
+        """Set the AS7262 indicator LED state.
 
+        :param state: True = On, False = Off
 
-def get_version():
-    """Get the hardware type, version and firmware version from the AS7262."""
-    with _as7262.VERSION as VERSION:
-        fw_version = VERSION.get_fw_version()
-        hw_version = VERSION.get_hw_version()
-        hw_type = VERSION.get_hw_type()
+        """
+        self._as7262.set('LED_CONTROL', indicator_enable=state)
 
-    return hw_type, hw_version, fw_version
+    def get_version(self):
+        """Get the hardware type, version and firmware version from the AS7262."""
+        version = self._as7262.get('VERSION')
+        return version.hw_type, version.hw_version, version.fw_version

library/setup.py

@@ -39,7 +39,7 @@
 
 setup(
     name='as7262',
-    version='0.0.2',
+    version='0.1.0',
     author='Philip Howard',
     author_email='phil@pimoroni.com',
     description="""Python library for the spectral sensor""",
@@ -50,5 +50,5 @@
     project_urls={'GitHub': 'https://www.github.com/pimoroni/as7262-python'},
     classifiers=classifiers,
     packages=['as7262'],
-    install_requires=['i2cdevice']
+    install_requires=['i2cdevice>=0.0.6']
 )

library/tests/test_features.py

@@ -9,7 +9,8 @@ def _setup():
     smbus = mock.Mock()
     smbus.SMBus = SMBusFakeAS7262
     sys.modules['smbus'] = smbus
-    import as7262
+    from as7262 import AS7262
+    as7262 = AS7262()
 
 
 def test_set_integration_time():