examples update

Author: fivesixzero

docs/examples.rst

@@ -3,35 +3,35 @@ Simple test
 
 Ensure your device works with this simple test.
 
-.. literalinclude:: ../examples/apds9960_color_simpletest.py
-    :caption: examples/apds9960_color_simpletest.py
+.. literalinclude:: ../examples/apds9960_simpletest.py
+    :caption: examples/apds9960_simpletest.py
     :linenos:
 
 
-Gesture Example
----------------
+Proximity Example
+-----------------
 
-Show how to use the device with simple gestures
+Example illustrating proximity detection
 
-.. literalinclude:: ../examples/apds9960_gesture_simpletest.py
-    :caption: examples/apds9960_gesture_simpletest.py
+.. literalinclude:: ../examples/apds9960_proximity_simpletest.py
+    :caption: examples/apds9960_proximity_simpletest.py
     :linenos:
 
 
-Proximity Example
------------------
+Gesture Example
+---------------
 
-Example showing proximity feature
+Example illustrating gesture detection
 
-.. literalinclude:: ../examples/apds9960_proximity_simpletest.py
-    :caption: examples/apds9960_proximity_simpletest.py
+.. literalinclude:: ../examples/apds9960_gesture_simpletest.py
+    :caption: examples/apds9960_gesture_simpletest.py
     :linenos:
 
 
 Color Example
 ---------------
 
-Example showing how to get RGB values
+Example illustrating color detection
 
 .. literalinclude:: ../examples/apds9960_color_simpletest.py
     :caption: examples/apds9960_color_simpletest.py

examples/apds9960_color_simpletest.py

@@ -12,8 +12,6 @@
 
 
 while True:
-    # create some variables to store the color data in
-
     # wait for color data to be ready
     while not apds.color_data_ready:
         time.sleep(0.005)

examples/apds9960_proximity_simpletest.py

@@ -7,12 +7,18 @@
 
 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
+# set the interrupt threshold to fire when proximity reading goes above 175
 apds.proximity_interrupt_threshold = (0, 175)
+
+# assert the interrupt pin when the proximity interrupt is triggered
 apds.enable_proximity_interrupt = True
 
+# enable the sensor's proximity engine
+apds.enable_proximity = True
+
 while True:
     # print the proximity reading when the interrupt pin goes low
     if not int_pin.value: