Merge pull request #16 from jposada202020/verifying_references

Improving_docs

Author: evaherrada

README.rst

@@ -64,10 +64,9 @@ Usage Example
 
     import time
     import board
-    import busio
     from adafruit_emc2101 import EMC2101
 
-    i2c = busio.I2C(board.SCL, board.SDA)
+    i2c = board.I2C()  # uses board.SCL and board.SDA
 
     emc = EMC2101(i2c)
     print("Setting fan speed to 25%")

adafruit_emc2101/__init__.py

@@ -15,14 +15,20 @@
 
 **Hardware:**
 
-* `Adafruit EMC2101 Breakout <https://adafruit.com/product/4808>`_
+* `Adafruit EMC2101 Breakout
+  <https://adafruit.com/product/4808>`_ (Product ID: 4808)
 
 **Software and Dependencies:**
 
 * Adafruit CircuitPython firmware for the supported boards:
-  https://github.com/adafruit/circuitpython/releases
-* Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
-* Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register
+  https://circuitpython.org/downloads
+
+* Adafruit's Bus Device library:
+  https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
+
+* Adafruit's Register library:
+  https://github.com/adafruit/Adafruit_CircuitPython_Register
+
 """
 
 from micropython import const
@@ -136,6 +142,34 @@ class EMC2101:  # pylint: disable=too-many-instance-attributes
 
     :param ~busio.I2C i2c_bus: The I2C bus the EMC is connected to.
 
+
+    **Quickstart: Importing and using the device**
+
+        Here is an example of using the :class:`EMC2101` class.
+        First you will need to import the libraries to use the sensor
+
+        .. code-block:: python
+
+            import board
+            from adafruit_emc2101.emc2101_lut import EMC2101_LUT as EMC2101
+
+        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
+            emc = EMC2101(i2c)
+
+        Now you have access to the :attr:`manual_fan_speed` attribute to setup the
+        desired fanspeed
+
+        .. code-block:: python
+
+            emc.manual_fan_speed = 25
+
+
+
+
     If you need control over PWM frequency and the controller's built in temperature/speed
     look-up table (LUT), you will need :class:`emc2101_lut.EMC2101_LUT` which extends this
     class to add those features, at the cost of increased memory usage.
@@ -282,7 +316,7 @@ def spinup_time(self, spin_time):
 
     @property
     def spinup_drive(self):
-        """The drive strengh of the fan on spinup in % max RPM"""
+        """The drive strength of the fan on spinup in % max RPM"""
         return self._spin_drive
 
     @spinup_drive.setter

adafruit_emc2101/emc2101_lut.py

@@ -15,15 +15,19 @@
 
 **Hardware:**
 
-* `Adafruit EMC2101 Breakout <https://adafruit.com/product/4808>`_
+* `Adafruit EMC2101 Breakout <https://adafruit.com/product/4808>`_ (Product ID: 4808)
 
 **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
+
+* Adafruit's Register library:
+  https://github.com/adafruit/Adafruit_CircuitPython_Register
 
-* Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
-* Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register
 
 The class defined here may be used instead of :class:`adafruit_emc2101.EMC2101`,
 if your device has enough RAM to support it. This class adds LUT control

docs/index.rst

@@ -23,10 +23,12 @@ Table of Contents
 .. toctree::
     :caption: Tutorials
 
+    EMC2101 Fan Controller and Temperature sensor Learning Guide <https://learn.adafruit.com/emc2101-fan-controller-and-temperature-sensor>
 
 .. toctree::
     :caption: Related Products
 
+    EMC2101 Fan Controller and Temperature sensor <https://www.adafruit.com/product/4808>
 
 .. toctree::
     :caption: Other Links

examples/emc2101_lut_example.py

@@ -3,10 +3,9 @@
 # SPDX-License-Identifier: MIT
 import time
 import board
-import busio
 from adafruit_emc2101.emc2101_lut import EMC2101_LUT as EMC2101
 
-i2c = busio.I2C(board.SCL, board.SDA)
+i2c = board.I2C()  # uses board.SCL and board.SDA
 
 FAN_MAX_RPM = 1700
 emc = EMC2101(i2c)

examples/emc2101_set_pwm_freq.py

@@ -3,10 +3,9 @@
 # SPDX-License-Identifier: MIT
 import time
 import board
-import busio
 from adafruit_emc2101.emc2101_lut import EMC2101_LUT as EMC2101
 
-i2c = busio.I2C(board.SCL, board.SDA)
+i2c = board.I2C()  # uses board.SCL and board.SDA
 
 emc = EMC2101(i2c)
 emc.set_pwm_clock(use_preset=False)

examples/emc2101_simpletest.py

@@ -3,11 +3,9 @@
 # SPDX-License-Identifier: MIT
 import time
 import board
-import busio
 from adafruit_emc2101 import EMC2101
 
-i2c = busio.I2C(board.SCL, board.SDA)
-
+i2c = board.I2C()  # uses board.SCL and board.SDA
 emc = EMC2101(i2c)
 while True:
     print("Setting fan speed to 25%")