expose read_data() to user and add values property

Author: jfurcean

adafruit_nunchuk.py

@@ -26,6 +26,7 @@
 * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
 """
 import time
+from collections import namedtuple
 from adafruit_bus_device.i2c_device import I2CDevice
 
 __version__ = "0.0.0-auto.0"
@@ -60,26 +61,37 @@ def __init__(self, i2c, address=0x52, i2c_read_delay=0.002):
             time.sleep(_I2C_INIT_DELAY)
             i2c_dev.write(b"\xFB\x00")
 
+    @property
+    def values(self):
+        """Return named tuple of all the input values."""
+        self.read_data()
+        (sx, sy), bc, bz, (ax, ay, az) = (  # pylint: disable=invalid-name
+            self.joystick,
+            self.button_C,
+            self.button_Z,
+            self.acceleration,
+        )
+        Values = namedtuple("Values", "sx sy bc bz ax ay az")
+        return Values(sx, sy, bc, bz, ax, ay, az)
+
     @property
     def joystick(self):
         """Return tuple of current joystick position."""
-        self._read_data()
         return self.buffer[0], self.buffer[1]
 
     @property
     def button_C(self):  # pylint: disable=invalid-name
         """Return current pressed state of button C."""
-        return not bool(self._read_data()[5] & 0x02)
+        return not bool(self.buffer[5] & 0x02)
 
     @property
     def button_Z(self):  # pylint: disable=invalid-name
         """Return current pressed state of button Z."""
-        return not bool(self._read_data()[5] & 0x01)
+        return not bool(self.buffer[5] & 0x01)
 
     @property
     def acceleration(self):
         """Return 3 tuple of accelerometer reading."""
-        self._read_data()
         x = (self.buffer[5] & 0xC0) >> 6
         x |= self.buffer[2] << 2
         y = (self.buffer[5] & 0x30) >> 4
@@ -88,7 +100,8 @@ def acceleration(self):
         z |= self.buffer[4] << 2
         return x, y, z
 
-    def _read_data(self):
+    def read_data(self):
+        """Reads all of the raw input data from i2c."""
         return self._read_register(b"\x00")
 
     def _read_register(self, address):

docs/conf.py

@@ -25,7 +25,7 @@
 # Uncomment the below if you use native CircuitPython modules such as
 # digitalio, micropython and busio. List the modules you use. Without it, the
 # autodoc module docs will fail to generate with a warning.
-# autodoc_mock_imports = ["digitalio", "busio"]
+autodoc_mock_imports = ["adafruit_bus_device"]
 
 
 intersphinx_mapping = {

examples/nunchuk_accel_mouse.py

@@ -27,6 +27,7 @@
 #    print((0 if nc.button_C else 1, 0 if nc.button_Z else 1))
 
 while True:
+    nc.read_data()
     accel = nc.acceleration
     #    print(accel)
     #    x, y = nc.joystick

examples/nunchuk_analog_mouse.py

@@ -27,6 +27,7 @@
 #    print((0 if nc.button_C else 1, 0 if nc.button_Z else 1))
 
 while True:
+    nc.read_data()
     x, y = nc.joystick
     # Eliminate spurious reads
     if x == 255 or y == 255:

examples/nunchuk_mouse.py

@@ -12,6 +12,7 @@
 nc = adafruit_nunchuk.Nunchuk(board.I2C())
 
 while True:
+    nc.read_data()
     x, y = nc.joystick
     x = (x - 128) // 2
     y = (128 - y) // 2

examples/nunchuk_simpletest.py

@@ -8,12 +8,11 @@
 nc = adafruit_nunchuk.Nunchuk(board.I2C())
 
 while True:
-    x, y = nc.joystick
-    ax, ay, az = nc.acceleration
-    print("joystick = {},{}".format(x, y))
-    print("accceleration ax={}, ay={}, az={}".format(ax, ay, az))
-    if nc.button_C:
+    values = nc.values
+    print("joystick = {},{}".format(values.sx, values.sy))
+    print("accceleration ax={}, ay={}, az={}".format(values.ax, values.ay, values.az))
+    if values.bc:
         print("button C")
-    if nc.button_Z:
+    if values.bz:
         print("button Z")
     time.sleep(0.5)