From 1a28cc11d1bd04ddd446c914de8399cd30ef0bc2 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sun, 25 Feb 2018 23:00:31 -0600 Subject: [PATCH 1/7] renamed example --- examples/get_current.py | 21 --------------------- 1 file changed, 21 deletions(-) delete mode 100644 examples/get_current.py diff --git a/examples/get_current.py b/examples/get_current.py deleted file mode 100644 index fb95269..0000000 --- a/examples/get_current.py +++ /dev/null @@ -1,21 +0,0 @@ -import time - -from board import SCL, SDA -import busio - -import adafruit_ina219 - -i2c_bus = busio.I2C(SCL, SDA) - -ina219 = adafruit_ina219.INA219(i2c_bus) - -print("ina219 test") - -while True: - print("Bus Voltage: {} V".format(ina219.bus_voltage)) - print("Shunt Voltage: {} mV".format(ina219.shunt_voltage / 1000)) - print("Load Voltage: {} V".format(ina219.bus_voltage + ina219.shunt_voltage)) - print("Current: {} mA".format(ina219.current)) - print("") - - time.sleep(2) From c828a6e052747cd570a5f1af074e72474e14780c Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sun, 25 Feb 2018 23:01:18 -0600 Subject: [PATCH 2/7] renamed example; forgot 'git add'...again --- examples/ina219_simpletest.py | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 examples/ina219_simpletest.py diff --git a/examples/ina219_simpletest.py b/examples/ina219_simpletest.py new file mode 100644 index 0000000..fb95269 --- /dev/null +++ b/examples/ina219_simpletest.py @@ -0,0 +1,21 @@ +import time + +from board import SCL, SDA +import busio + +import adafruit_ina219 + +i2c_bus = busio.I2C(SCL, SDA) + +ina219 = adafruit_ina219.INA219(i2c_bus) + +print("ina219 test") + +while True: + print("Bus Voltage: {} V".format(ina219.bus_voltage)) + print("Shunt Voltage: {} mV".format(ina219.shunt_voltage / 1000)) + print("Load Voltage: {} V".format(ina219.bus_voltage + ina219.shunt_voltage)) + print("Current: {} mA".format(ina219.current)) + print("") + + time.sleep(2) From 2c4ca2e342f87c2cfdf9d8b9de575e756ec5900e Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sun, 25 Feb 2018 23:05:46 -0600 Subject: [PATCH 3/7] setup docs folder --- docs/_static/favicon.ico | Bin 0 -> 4414 bytes api.rst => docs/api.rst | 0 conf.py => docs/conf.py | 15 +++++++++--- docs/examples.rst | 8 +++++++ docs/index.rst | 49 +++++++++++++++++++++++++++++++++++++++ 5 files changed, 69 insertions(+), 3 deletions(-) create mode 100644 docs/_static/favicon.ico rename api.rst => docs/api.rst (100%) rename conf.py => docs/conf.py (90%) create mode 100644 docs/examples.rst create mode 100644 docs/index.rst diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..5aca98376a1f7e593ebd9cf41a808512c2135635 GIT binary patch literal 4414 zcmd^BX;4#F6n=SG-XmlONeGrD5E6J{RVh+e928U#MG!$jWvO+UsvWh`x&VqGNx*en zx=qox7Dqv{kPwo%fZC$dDwVpRtz{HzTkSs8QhG0)%Y=-3@Kt!4ag|JcIo?$-F|?bXVS9UDUyev>MVZQ(H8K4#;BQW-t2CPorj8^KJrMX}QK zp+e<;4ldpXz~=)2GxNy811&)gt-}Q*yVQpsxr@VMoA##{)$1~=bZ1MmjeFw?uT(`8 z^g=09<=zW%r%buwN%iHtuKSg|+r7HkT0PYN*_u9k1;^Ss-Z!RBfJ?Un4w(awqp2b3 z%+myoFis_lTlCrGx2z$0BQdh+7?!JK#9K9@Z!VrG zNj6gK5r(b4?YDOLw|DPRoN7bdP{(>GEG41YcN~4r_SUHU2hgVtUwZG@s%edC;k7Sn zC)RvEnlq~raE2mY2ko64^m1KQL}3riixh?#J{o)IT+K-RdHae2eRX91-+g!y`8^># z-zI0ir>P%Xon)!@xp-BK2bDYUB9k613NRrY6%lVjbFcQc*pRqiK~8xtkNPLxt}e?&QsTB}^!39t_%Qb)~Ukn0O%iC;zt z<&A-y;3h++)>c1br`5VFM~5(83!HKx$L+my8sW_c#@x*|*vB1yU)_dt3vH;2hqPWx zAl^6@?ipx&U7pf`a*>Yq6C85nb+B=Fnn+(id$W#WB^uHAcZVG`qg;rWB}ubvi(Y>D z$ei>REw$#xp0SHAd^|1hq&9HJ=jKK8^zTH~nk)G?yUcmTh9vUM6Y0LMw4(gYVY$D$ zGl&WY&H<)BbJ&3sYbKjx1j^=3-0Q#f^}(aP1?8^`&FUWMp|rmtpK)bLQ1Zo?^s4jqK=Lfg*9&geMGVQ z#^-*!V`fG@;H&{M9S8%+;|h&Qrxym0Ar>WT4BCVLR8cGXF=JmEYN(sNT(9vl+S|%g z8r7nXQ(95i^`=+XHo|){$vf2$?=`F$^&wFlYXyXg$B{a>$-Fp+V}+D;9k=~Xl~?C4 zAB-;RKXdUzBJE{V&d&%R>aEfFe;vxqI$0@hwVM}gFeQR@j}a>DDxR+n+-*6|_)k%% z*mSpDV|=5I9!&VC&9tD%fcVygWZV!iIo2qFtm#!*(s|@ZT33*Ad;+<|3^+yrp*;oH zBSYLV(H1zTU?2WjrCQoQW)Z>J2a=dTriuvezBmu16`tM2fm7Q@d4^iqII-xFpwHGI zn9CL}QE*1vdj2PX{PIuqOe5dracsciH6OlAZATvE8rj6ykqdIjal2 z0S0S~PwHb-5?OQ-tU-^KTG@XNrEVSvo|HIP?H;7ZhYeZkhSqh-{reE!5di;1zk$#Y zCe7rOnlzFYJ6Z#Hm$GoidKB=2HBCwm`BbZVeZY4ukmG%1uz7p2URs6c9j-Gjj^oQV zsdDb3@k2e`C$1I5ML5U0Qs0C1GAp^?!*`=|Nm(vWz3j*j*8ucum2;r0^-6Aca=Gv) zc%}&;!+_*S2tlnnJnz0EKeRmw-Y!@9ob!XQBwiv}^u9MkaXHvM=!<3YX;+2#5Cj5pp?FEK750S3BgeSDtaE^ zXUM@xoV6yBFKfzvY20V&Lr0yC + + Adafruit INA219 FeatherWing + +.. toctree:: + :caption: Other Links + + Download + CircuitPython Reference Documentation + CircuitPython Support Forum + Discord Chat + Adafruit Learning System + Adafruit Blog + Adafruit Store + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` From ef8023ac28861fee15d0d667f82351135f7a1f86 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sun, 25 Feb 2018 23:07:14 -0600 Subject: [PATCH 4/7] updated .travis & .readthedocs yml --- readthedocs.yml => .readthedocs.yml | 0 .travis.yml | 6 ++++-- 2 files changed, 4 insertions(+), 2 deletions(-) rename readthedocs.yml => .readthedocs.yml (100%) diff --git a/readthedocs.yml b/.readthedocs.yml similarity index 100% rename from readthedocs.yml rename to .readthedocs.yml diff --git a/.travis.yml b/.travis.yml index ece679b..1a52638 100644 --- a/.travis.yml +++ b/.travis.yml @@ -16,15 +16,17 @@ deploy: provider: releases api_key: $GITHUB_TOKEN file_glob: true - file: bundles/* + file: $TRAVIS_BUILD_DIR/bundles/* skip_cleanup: true + overwrite: true on: tags: true install: - - pip install pylint circuitpython-build-tools + - pip install pylint circuitpython-build-tools Sphinx sphinx-rtd-theme script: - pylint adafruit_ina219.py - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py) - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-ina219 --library_location . + - cd docs && sphinx-build -E -W -b html . _build/html From cb6894ed98eae2b654cecbb08ba46b825dbf76cb Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sun, 25 Feb 2018 23:08:37 -0600 Subject: [PATCH 5/7] updated README --- README.rst | 51 +++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 45 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 2004d3c..a1eb023 100644 --- a/README.rst +++ b/README.rst @@ -26,7 +26,7 @@ This is easily achieved by downloading Usage Example ============= -see `example `_ +see `example `_ Contributing ============ @@ -35,10 +35,49 @@ Contributions are welcome! Please read our `Code of Conduct `_ before contributing to help this project stay welcoming. -API Reference -============= +Building locally +================ + +To build this library locally you'll need to install the +`circuitpython-build-tools `_ package. + +.. code-block:: shell + + python3 -m venv .env + source .env/bin/activate + pip install circuitpython-build-tools + +Once installed, make sure you are in the virtual environment: + +.. code-block:: shell + + source .env/bin/activate + +Then run the build: + +.. code-block:: shell + + circuitpython-build-bundles --filename_prefix adafruit-circuitpython-ina219 --library_location . + +Sphinx documentation +----------------------- + +Sphinx is used to build the documentation based on rST files and comments in the code. First, +install dependencies (feel free to reuse the virtual environment from above): + +.. code-block:: shell + + python3 -m venv .env + source .env/bin/activate + pip install Sphinx sphinx-rtd-theme + +Now, once you have the virtual environment activated: + +.. code-block:: shell -.. toctree:: - :maxdepth: 2 + cd docs + sphinx-build -E -W -b html . _build/html - api +This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to +view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to +locally verify it will pass. \ No newline at end of file From 245f63d3568298fd5e7aba2b358084b700627c70 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sun, 25 Feb 2018 23:11:13 -0600 Subject: [PATCH 6/7] updated info docstring --- adafruit_ina219.py | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/adafruit_ina219.py b/adafruit_ina219.py index 31e0ec1..1e75ecb 100644 --- a/adafruit_ina219.py +++ b/adafruit_ina219.py @@ -23,9 +23,24 @@ `adafruit_ina219` ==================================================== -CircuitPython driver for the `INA219 current sensor `_. +CircuitPython driver for the INA219 current sensor. * Author(s): Dean Miller + +Implementation Notes +-------------------- + +**Hardware:** + +* `Adafruit INA219 High Side DC Current Sensor Breakout `_ + +* `Adafruit INA219 FeatherWing `_ + +**Software and Dependencies:** + +* Adafruit CircuitPython firmware (2.2.0+) for the ESP8622 and M0-based boards: + https://github.com/adafruit/circuitpython/releases +* Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice """ from micropython import const From 5bfbd53e4c126b82f85407d9227506c4e04134b2 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sun, 25 Feb 2018 23:14:04 -0600 Subject: [PATCH 7/7] sphinx fix --- adafruit_ina219.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_ina219.py b/adafruit_ina219.py index 1e75ecb..a465ae5 100644 --- a/adafruit_ina219.py +++ b/adafruit_ina219.py @@ -118,7 +118,7 @@ def _to_signed(num): return num class INA219: - """Driver for the `INA219 current sensor""" + """Driver for the INA219 current sensor""" def __init__(self, i2c_bus, addr=0x40): self.i2c_device = I2CDevice(i2c_bus, addr)