Merge pull request #39 from fivesixzero/cleanup-and-doc

Gesture refactor, memory optimization, major doc updates

Author: FoamyGuy

README.rst

@@ -14,10 +14,17 @@ Introduction
     :target: https://github.com/adafruit/Adafruit_CircuitPython_APDS9960/actions/
     :alt: Build Status
 
-The APDS9960 is a specialized chip that detects hand gestures, proximity
-and ambient light color over I2C. Its available on
-`Adafruit as a breakout <https://www.adafruit.com/product/3595>`_.
+The APDS-9960 is a specialized chip that detects hand gestures, proximity
+and ambient light color over I2C. Its available from
+`Adafruit as a breakout <https://www.adafruit.com/product/3595>`_ and as a built-in sensor on
+several Adafruit development boards.
 
+* `Adafruit CLUE <https://www.adafruit.com/product/4500>`_
+* `Adafruit Feather nRF52840 Sense <https://www.adafruit.com/product/4516>`_
+* `Adafruit Proximity Trinkey <https://www.adafruit.com/product/5022>`_
+
+This driver provides easy access to proximity, gesture and color data from the APDS-9960 sensor
+with a minimal footprint to allow it to work on all CircuitPython platforms.
 
 Installation and Dependencies
 =============================
@@ -26,13 +33,16 @@ This driver depends on:
 * `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
 
 Please ensure all dependencies are available on the CircuitPython filesystem.
+
 This is easily achieved by downloading
 `the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
 
 Installing from PyPI
 --------------------
 
-On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from PyPI <https://pypi.org/project/adafruit-circuitpython-apds9960/>`_. To install for current user:
+On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from PyPI <https://pypi.org/project/adafruit-circuitpython-apds9960/>`_.
+
+To install for current user:
 
 .. code-block:: shell
 
@@ -64,98 +74,165 @@ Usage Example
 
     i2c = board.I2C()
     int_pin = digitalio.DigitalInOut(board.D5)
+    int_pin.switch_to_input(pull=digitalio.Pull.UP)
     apds = APDS9960(i2c)
 
-    apds.enable_proximity = True
-    apds.proximity_interrupt_threshold = (0, 175)
     apds.enable_proximity_interrupt = True
+    apds.proximity_interrupt_threshold = (0, 175)
+    apds.enable_proximity = True
 
     while True:
+        if not int_pin.value:
             print(apds.proximity)
             apds.clear_interrupt()
 
 Hardware Set-up
 ---------------
 
-Connect Vin to 3.3 V or 5 V power source, GND to ground, SCL and SDA to the appropriate pins.
+If you're using a board with a built-in APDS-9960, no hardware setup will be required.
+
+If you're using a breakout board via the pin header, connect ``Vin`` to a 3.3 V or 5 V power source,
+connect ``GND`` to ground, then connect ``SCL`` and ``SDA`` to the appropriate pins.
+
+Optionally, if you'd like to use the sensor's interrupt pin connect ``INT`` to any available
+digital I/O pin.
 
 Basics
 ------
 
-Of course, you must import i2c bus device, board pins, and the library:
+To get started, import ``board`` and, and this library:
 
 .. code:: python3
 
 
-  import board
-  from adafruit_apds9960.apds9960 import APDS9960
-  import digitalio
+    import board
+    from adafruit_apds9960.apds9960 import APDS9960
 
-To set-up the device to gather data, initialize the I2CDevice using SCL
-and SDA pins.   Then initialize the library.  Optionally provide an interrupt
-pin for proximity detection.
+To set up the sensor to gather data, initialize the I2C bus via ``board.I2C()``
+then initialize the APDS-9960 library.
 
 .. code:: python3
 
-  int_pin = digitalio.DigitalInOut(board.A1)
-  i2c = board.I2C()
-  apds = APDS9960(i2c)
+    i2c = board.I2C()
+    apds = APDS9960(i2c)
+
+Proximity
+---------
+
+To get a proximity result, enable the proximity engine then read the `proximity` value.
+
+This will return a value between 0 and 255, with higher values indicating that something is close
+to the sensor.
+
+.. code:: python3
+
+    apds.enable_proximity = True
+
+    while True:
+      print(apds.proximity)
 
 Gestures
 --------
 
-To get a gesture, see if a gesture is available first, then get the gesture Code
+First, enable both the proximity and gesture engines. The gesture engine relies on the proximity
+engine to determine when to start itself up and, as a result, proximity readings won't be reliable
+while the gesture engine is enabled.
+
+To get a gesture, use the `gesture()` function to see if a gesture has been detected. If a value
+greater than 0 is returned, a gesture has been detected.
 
 .. code:: python3
 
-  gesture = apds.gesture()
-  if gesture == 1:
-    print("up")
-  if gesture == 2:
-    print("down")
-  if gesture == 3:
-    print("left")
-  if gesture == 4:
-    print("right")
+    # Uncomment and set the rotation if depending on how your sensor is mounted.
+    # apds.rotation = 270 # 270 for CLUE
 
-Color Measurement
------------------
+    apds.enable_proximity = True
+    apds.enable_gesture = True
 
-To get a color measure, enable color measures, wait for color data,
-then get the color data.
+    while True:
+      gesture = apds.gesture()
+      if gesture == 1:
+        print("up")
+      if gesture == 2:
+        print("down")
+      if gesture == 3:
+        print("left")
+      if gesture == 4:
+        print("right")
+
+Color/Light Measurement
+-----------------------
+
+To get a color measurement, first enable the color/light engine, wait for color data to arrive,
+then read the `color_data` values.
 
 .. code:: python3
 
-  apds.enable_color = True
+    apds.enable_color = True
+
+    while True:
+        while not apds.color_data_ready:
+            time.sleep(0.005)
+
+        r, g, b, c = apds.color_data
+        print("r: {}, g: {}, b: {}, c: {}".format(r, g, b, c))
 
-  while not apds.color_data_ready:
-      time.sleep(0.005)
+Interrupt Pin
+-------------
 
-  r, g, b, c = apds.color_data
-  print("r: {}, g: {}, b: {}, c: {}".format(r, g, b, c))
+This sensor has an interrupt pin can be asserted (pulled low) if proximity is detected outside of a
+specified window of values.
+
+For boards with a built-in APDS-9960 this interupt pin will already be defined. For example, on the
+Clue and Feather nRF52840 Sense boards this pin is mapped to ``board.PROXIMITY_LIGHT_INTERRUPT``
+and on the Proximity Trinkey it is mapped to ``board.INTERRUPT``.
+
+.. code:: python3
+
+    int_pin = digitalio.DigitalInOut(board.D5)
+    int_pin.switch_to_input(pull=digitalio.Pull.UP)
 
 Proximity Detection
----------------------
+-------------------
+
+With the interrupt pin set up we can define a threshold and enable the assertion of the sensor's
+interrupt pin by the proximity engine before enabling the proximity engine itself.
 
-To check for a object in proximity, see if a gesture is available first, then get the gesture Code
+In this configuration, the sensor's interrupt pin will be asserted when an object is close to the
+sensor. After checking on the interrupt it can be cleared using `clear_interrupt()`
 
 .. code:: python3
 
-  apds.enable_proximity = True
+    apds.enable_proximity = True
+
+    # set the interrupt threshold to fire when proximity reading goes above 175
+    apds.proximity_interrupt_threshold = (0, 175)
 
-  # set the interrupt threshold to fire when proximity reading goes above 175
-  apds.proximity_interrupt_threshold = (0, 175)
+    # assert interrupt pin on internal proximity interrupt
+    apds.enable_proximity_interrupt = True
 
-  # enable the proximity interrupt
-  apds.enable_proximity_interrupt = True
+    # enable the sensor's proximity engine
+    apds.enable_proximity = True
 
-  while True:
-    if not interrupt_pin.value:
-      print(apds.proximity)
+    while True:
+      if not interrupt_pin.value:
+        print(apds.proximity)
+
+        # clear the interrupt
+        apds.clear_interrupt()
+
+Initiaization Options
+----------------------
 
-      # clear the interrupt
-      apds.clear_interrupt()
+By default, when the driver is initialized, the APDS-9960 sensor's internal settings are reset and
+sensible defaults are applied to several low-level settings that should work well for most use cases.
+
+If either the "reset" or "set defaults" behaviors (or both) aren't desired, they can be individually
+disabled via init kwargs.
+
+.. code:: python3
 
+    apds = APDS9960(i2c, reset=False, set_defaults=False)
 
 Documentation
 =============