Merge pull request #15 from jposada202020/improving_docs

improving_docs

Author: jposada202020

.gitignore

@@ -7,3 +7,4 @@ _build
 *.pyc
 .env
 bundles
+.idea

README.rst

@@ -54,22 +54,21 @@ To install in a virtual environment in your current project:
 Usage Example
 =============
 
-.. code-block:: python
+.. code-block:: python3
 
-	import time
-	import board
-	import busio
-	import adafruit_mprls
+    import time
+    import board
+    import adafruit_mprls
 
-	i2c = busio.I2C(board.SCL, board.SDA)
+    i2c = board.I2C()
 
-	# Simplest use, connect to default over I2C
-	mpr = adafruit_mprls.MPRLS(i2c, psi_min=0, psi_max=25)
+    # Simplest use, connect to default over I2C
+    mpr = adafruit_mprls.MPRLS(i2c, psi_min=0, psi_max=25)
 
+    while True:
+        print((mpr.pressure,))
+        time.sleep(1)
 
-	while True:
-	    print((mpr.pressure,))
-	    time.sleep(1)
 
 Contributing
 ============

adafruit_mprls.py

@@ -15,10 +15,13 @@
 
 **Hardware:**
 
+* Adafruit `Adafruit MPRLS Ported Pressure Sensor Breakout
+  <https://www.adafruit.com/product/3965>`_ (Product ID: 3965)
+
 **Software and Dependencies:**
 
 * Adafruit CircuitPython firmware for the supported boards:
-  https://github.com/adafruit/circuitpython/releases
+  https://circuitpython.org/downloads
 
 * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
 
@@ -41,12 +44,38 @@
 class MPRLS:
     """
     Driver base for the MPRLS pressure sensor
-    :param i2c_bus: The `busio.I2C` object to use. This is the only required parameter.
-    :param int addr: The optional I2C address, defaults to 0x18
-    :param microcontroller.Pin reset_pin: Optional digitalio pin for hardware resetting
-    :param microcontroller.Pin eoc_pin: Optional digitalio pin for getting End Of Conversion signal
-    :param float psi_min: The minimum pressure in PSI, defaults to 0
-    :param float psi_max: The maximum pressure in PSI, defaults to 25
+
+    :param ~busio.I2C i2c_bus: The I2C bus the MPRLS is connected to
+    :param int addr: The I2C device address. Defaults to :const:`0x18`
+    :param ~microcontroller.Pin reset_pin: Optional ``digitalio.pin`` for hardware resetting
+    :param ~microcontroller.Pin eoc_pin: Optional ``digitalio pin``
+                                         for getting End Of Conversion signal
+    :param float psi_min: The minimum pressure in PSI, defaults to :const:`0`
+    :param float psi_max: The maximum pressure in PSI, defaults to :const:`25`
+
+    **Quickstart: Importing and using the MPRLS**
+
+        Here is an example of using the :class:`MPRLS` class.
+        First you will need to import the libraries to use the sensor
+
+        .. code-block:: python
+
+            import board
+            import adafruit_mprls
+
+        Once this is done you can define your `board.I2C` object and define your sensor object
+
+        .. code-block:: python
+
+            i2c = board.I2C()  # uses board.SCL and board.SDA
+            mpr = adafruit_mprls.MPRLS(i2c, psi_min=0, psi_max=25)
+
+        Now you have access to the :attr:`pressure` attribute
+
+        .. code-block:: python
+
+            pressure = mpr.pressure
+
     """
 
     def __init__(

docs/index.rst

@@ -23,9 +23,13 @@ Table of Contents
 .. toctree::
     :caption: Tutorials
 
+    Adafruit MPRLS Ported Pressure Sensor Breakout - 0 to 25 PSI Learning Guide <https://learn.adafruit.com/adafruit-mprls-ported-pressure-sensor-breakout>
+
 .. toctree::
     :caption: Related Products
 
+    Adafruit MPRLS Ported Pressure Sensor Breakout - 0 to 25 PSI <https://www.adafruit.com/product/3965>
+
 .. toctree::
     :caption: Other Links
 

examples/mprls_simpletest.py

@@ -3,10 +3,9 @@
 
 import time
 import board
-import busio
 import adafruit_mprls
 
-i2c = busio.I2C(board.SCL, board.SDA)
+i2c = board.I2C()
 
 # Simplest use, connect to default over I2C
 mpr = adafruit_mprls.MPRLS(i2c, psi_min=0, psi_max=25)