INA219 featherwing (#2)

INA219 FeatherWing library, example, docs, image

Author: kattni

_static/ina219_featherwing/ina219_featherwing.jpg

@@ -0,0 +1,137 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2018 Kattni Rembor for Adafruit Industries LLC
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+"""
+`adafruit_featherwing.ina219_featherwing`
+====================================================
+
+Helper for using the `INA219 FeatherWing <https://www.adafruit.com/product/3650>`_.
+
+* Author(s): Kattni Rembor
+"""
+
+__version__ = "0.0.0-auto.0"
+__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_FeatherWing.git"
+
+import adafruit_ina219
+from adafruit_featherwing import shared
+
+
+class INA219FeatherWing:
+    """Class representing an `Adafruit INA219 FeatherWing
+       <https://www.adafruit.com/product/3650>`_.
+
+       Automatically uses the feather's I2C bus."""
+    def __init__(self):
+        self._ina219 = adafruit_ina219.INA219(shared.I2C_BUS)
+
+    @property
+    def bus_voltage(self):
+        """Bus voltage returns volts.
+
+            .. image :: /_static/ina219_featherwing/ina219_featherwing.jpg
+              :alt: INA219 Featherwing
+
+            This example prints the bus voltage with the appropriate units.
+
+            .. code-block:: python
+
+                from adafruit_featherwing import ina219_featherwing
+                import time
+
+                ina219 = ina219_featherwing.INA219FeatherWing()
+
+                while True:
+                    print("Bus Voltage: {} V".format(ina219.bus_voltage))
+                    time.sleep(0.5)
+
+        """
+        return self._ina219.bus_voltage
+
+    @property
+    def shunt_voltage(self):
+        """Shunt voltage returns volts.
+
+            .. image :: /_static/ina219_featherwing/ina219_featherwing.jpg
+              :alt: INA219 Featherwing
+
+            This example prints the shunt voltage with the appropriate units.
+
+            .. code-block:: python
+
+                from adafruit_featherwing import ina219_featherwing
+                import time
+
+                ina219 = ina219_featherwing.INA219FeatherWing()
+
+                while True:
+                    print("Shunt Voltage: {} V".format(ina219.shunt_voltage))
+                    time.sleep(0.5)
+
+        """
+        return self._ina219.shunt_voltage
+
+    @property
+    def voltage(self):
+        """Voltage, known as load voltage, is bus voltage plus shunt voltage. Returns volts.
+
+            .. image :: /_static/ina219_featherwing/ina219_featherwing.jpg
+              :alt: INA219 Featherwing
+
+            This example prints the voltage with the appropriate units.
+
+            .. code-block:: python
+
+                from adafruit_featherwing import ina219_featherwing
+                import time
+
+                ina219 = ina219_featherwing.INA219FeatherWing()
+
+                while True:
+                    print("Voltage: {} V".format(ina219.voltage))
+                    time.sleep(0.5)
+
+        """
+        voltage = self._ina219.bus_voltage + self._ina219.shunt_voltage
+        return voltage
+
+    @property
+    def current(self):
+        """Current returns mA.
+
+            .. image :: /_static/ina219_featherwing/ina219_featherwing.jpg
+              :alt: INA219 Featherwing
+
+            This example prints the current with the appropriate units.
+
+            .. code-block:: python
+
+                from adafruit_featherwing import ina219_featherwing
+                import time
+
+                ina219 = ina219_featherwing.INA219FeatherWing()
+
+                while True:
+                    print("Current: {} mA".format(ina219.current))
+                    time.sleep(0.5)
+
+        """
+        return self._ina219.current

adafruit_featherwing/ina219_featherwing.py

@@ -2,4 +2,5 @@
 .. If you created a package, create one automodule per module in the package.
 
 .. automodule:: adafruit_featherwing.motor_featherwing
+.. automodule:: adafruit_featherwing.ina219_featherwing
    :members:

api.rst

@@ -18,7 +18,7 @@
 # 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 = ["adafruit_motor", "adafruit_pca9685", "board", "busio"]
+autodoc_mock_imports = ["adafruit_motor", "adafruit_pca9685", "board", "busio", "adafruit_ina219"]
 
 intersphinx_mapping = {
     'python': ('https://docs.python.org/3.4', None),

conf.py

@@ -0,0 +1,13 @@
+""" Example to print out the voltage and current using the INA219 """
+import time
+from adafruit_featherwing import ina219_featherwing
+
+INA219 = ina219_featherwing.INA219FeatherWing()
+
+while True:
+    print("Bus Voltage:   {} V".format(INA219.bus_voltage))
+    print("Shunt Voltage: {} V".format(INA219.shunt_voltage))
+    print("Voltage:       {} V".format(INA219.voltage))
+    print("Current:       {} mA".format(INA219.current))
+    print("")
+    time.sleep(0.5)