Added comments to the examples files.

adafruit_l3gd20.py

@@ -68,7 +68,10 @@
 
 _L3GD20_REGISTER_CTRL_REG1 = const(0x20)
 _L3GD20_REGISTER_CTRL_REG4 = const(0x23)
-_L3GD20_REGISTER_OUT_X_L = const(0x28)
+
+# _L3GD20_REGISTER_OUT_X_L = const(0x28)
+_L3GD20_REGISTER_OUT_X_L_X80 = const(0xA8)
+_L3GD20_REGISTER_OUT_X_L_X40 = const(0x68)
 
 _ID_REGISTER = const(0x0F)
 
@@ -196,7 +199,7 @@ class L3GD20_I2C(L3GD20):
     :param address: the optional device address, 0x68 is the default address
     """
 
-    acceleration_raw = Struct((_L3GD20_REGISTER_OUT_X_L | 0x80), '<hhh')
+    acceleration_raw = Struct(_L3GD20_REGISTER_OUT_X_L_X80, '<hhh')
     """Gives the raw acceleration readings, in units of the scaled mdps."""
 
     def __init__(self, i2c, rng=L3DS20_RANGE_250DPS, address=0x6B):
@@ -288,5 +291,5 @@ def read_bytes(self, register, buffer):
     def acceleration_raw(self):
         """Gives the raw acceleration readings, in units of the scaled mdps."""
         buffer = self._spi_bytearray6
-        self.read_bytes((_L3GD20_REGISTER_OUT_X_L | 0x40), buffer)
+        self.read_bytes(_L3GD20_REGISTER_OUT_X_L_X40, buffer)
         return unpack('<hhh', buffer)

docs/conf.py

@@ -20,7 +20,8 @@
 # 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 = ["digitalio", "busio", "micropython", "adafruit_register",
+                        "struct", "ustruct"]
 
 
 intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'Register': ('https://circuitpython.readthedocs.io/projects/register/en/latest/', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}

docs/examples.rst

@@ -1,8 +1,14 @@
 Simple test
 ------------
 
-Ensure your device works with this simple test.
+For I2C communications, ensure your device works with this simple test.
 
 .. literalinclude:: ../examples/l3gd20_simpletest.py
     :caption: examples/l3gd20_simpletest.py
     :linenos:
+
+For SPI communications, ensure your device works with this simple test.
+
+  .. literalinclude:: ../examples/l3gd20_spi_simpletest.py
+      :caption: examples/l3gd20_spi_simpletest.py
+      :linenos:

docs/index.rst

@@ -23,15 +23,11 @@ Table of Contents
 .. toctree::
     :caption: Tutorials
 
-.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
+    Adafruit Triple Axis Gyro Breakout <https://learn.adafruit.com/adafruit-triple-axis-gyro-breakout>
 
 .. toctree::
     :caption: Related Products
 
-.. todo:: Add any product links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
-
 .. toctree::
     :caption: Other Links
 

examples/l3gd20_simpletest.py

@@ -3,7 +3,9 @@
 import busio
 import adafruit_l3gd20
 
+# define the I2C wires
 I2C = busio.I2C(SCL, SDA)
+# initialize the device
 SENSOR = adafruit_l3gd20.L3GD20_I2C(I2C)
 
 while True:

examples/l3gd20_spi_simpletest.py

@@ -4,8 +4,10 @@
 import adafruit_l3gd20
 import digitalio
 
+# define the spi conneciton
 CS = digitalio.DigitalInOut(D5)  # select pin is 5
 SPIB = busio.SPI(SCK, MOSI, MISO)
+# now initialize the device
 SENSOR = adafruit_l3gd20.L3GD20_SPI(SPIB, CS)
 
 while True:
@@ -14,4 +16,5 @@
 
     print()
 
+    #sleep for 1 second
     time.sleep(1)