From fd756be7e07dd4db47977aa32f697c64377ab7da Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sat, 24 Feb 2018 19:52:04 -0600 Subject: [PATCH 1/7] added simpletest example --- examples/dht_simpletest.py | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 examples/dht_simpletest.py diff --git a/examples/dht_simpletest.py b/examples/dht_simpletest.py new file mode 100644 index 0000000..1947174 --- /dev/null +++ b/examples/dht_simpletest.py @@ -0,0 +1,18 @@ +import time +import adafruit_dht +from board import D2 + +#initial the dht device +dhtDevice = adafruit_dht.DHT22(D2) + +while True: + try: + # show the values to the serial port + temperature = dhtDevice.temperature*9/5+32 + humidity = dhtDevice.humidity + print("Temp: {:.1f} F Humidity: {}% ".format(temperature, humidity)) + + except RuntimeError as error: + print(error.args) + + time.sleep(2.0) From d8e0222d6a5e26ba809017587c36a39381daf2bc Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sat, 24 Feb 2018 19:54:09 -0600 Subject: [PATCH 2/7] renamed led display example --- examples/{dhttoleddisplay.py => dht_to_led_display.py} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename examples/{dhttoleddisplay.py => dht_to_led_display.py} (100%) diff --git a/examples/dhttoleddisplay.py b/examples/dht_to_led_display.py similarity index 100% rename from examples/dhttoleddisplay.py rename to examples/dht_to_led_display.py From 70479e9850458e2c90fea79b619f45cb62350799 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sat, 24 Feb 2018 20:00:22 -0600 Subject: [PATCH 3/7] setup docs folder --- api.rst | 6 ----- docs/_static/favicon.ico | Bin 0 -> 4414 bytes docs/api.rst | 5 ++++ conf.py => docs/conf.py | 15 +++++++++--- docs/examples.rst | 8 +++++++ docs/index.rst | 49 +++++++++++++++++++++++++++++++++++++++ 6 files changed, 74 insertions(+), 9 deletions(-) delete mode 100644 api.rst create mode 100644 docs/_static/favicon.ico create mode 100644 docs/api.rst rename conf.py => docs/conf.py (90%) create mode 100644 docs/examples.rst create mode 100644 docs/index.rst diff --git a/api.rst b/api.rst deleted file mode 100644 index e69910e..0000000 --- a/api.rst +++ /dev/null @@ -1,6 +0,0 @@ - -DHT Libary Documentation -============================ - -.. automodule:: adafruit_dht - :members: 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 + + DHT22 basic temperature-humidity sensor + extras + +.. 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 662fe4528733985c935c1462db5d19e99f11ba21 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sat, 24 Feb 2018 20:02:23 -0600 Subject: [PATCH 4/7] updated .travis & .readthedocs yml --- readthedocs.yml => .readthedocs.yml | 2 ++ .travis.yml | 5 +++-- 2 files changed, 5 insertions(+), 2 deletions(-) rename readthedocs.yml => .readthedocs.yml (61%) diff --git a/readthedocs.yml b/.readthedocs.yml similarity index 61% rename from readthedocs.yml rename to .readthedocs.yml index a3a16c1..78a4671 100644 --- a/readthedocs.yml +++ b/.readthedocs.yml @@ -1,2 +1,4 @@ +python: + version: 3 requirements_file: requirements.txt diff --git a/.travis.yml b/.travis.yml index 65862d3..36ca9b5 100644 --- a/.travis.yml +++ b/.travis.yml @@ -16,15 +16,16 @@ deploy: provider: releases api_key: $GITHUB_TOKEN file_glob: true - file: bundles/* + file: $TRAVIS_BUILD_DIR/bundles/* skip_cleanup: true on: tags: true install: - - pip install pylint circuitpython-build-tools + - pip install pylint circuitpython-build-tools Sphinx sphinx-rtd-theme script: - pylint adafruit_dht.py - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py) - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-dht --library_location . + - cd docs && sphinx-build -E -W -b html . _build/html From fecbbfa2b9300d73ff2d5435e252bfb425e9af7b Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sat, 24 Feb 2018 20:04:35 -0600 Subject: [PATCH 5/7] updated README --- README.rst | 57 ++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 49 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index 08f601d..9afb920 100644 --- a/README.rst +++ b/README.rst @@ -6,9 +6,10 @@ Introduction :target: https://circuitpython.readthedocs.io/projects/dht/en/latest/ :alt: Documentation Status -.. image :: https://badges.gitter.im/adafruit/circuitpython.svg - :target: https://gitter.im/adafruit/circuitpython?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge - :alt: Gitter + +.. image :: https://img.shields.io/discord/327254708534116352.svg + :target: https://discord.gg/nBQh6qu + :alt: Discord CircuitPython support for the DHT11 and DHT22 temperature and humidity devices. @@ -79,10 +80,50 @@ 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-veml6070 --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 + + cd docs + sphinx-build -E -W -b html . _build/html -.. toctree:: - :maxdepth: 2 +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. - api From 49db26f432c93563c7a657f94d66590aa726cb2b Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sat, 24 Feb 2018 20:08:23 -0600 Subject: [PATCH 6/7] sphinx fix; README --- README.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 9afb920..5748e01 100644 --- a/README.rst +++ b/README.rst @@ -24,17 +24,17 @@ This is easily achieved by downloading `the Adafruit library and driver bundle `_. Usage Example -============= +============== Hardware Set-up ---------------- +---------------- The DHT11 and DHT22 devices both need a pull-resistor on the data signal wire. This resistor is in the range of 1k to 5k. Please check your device datasheet for the appropriate value. Basics ------- +------- Of course, you must import the library to use it: @@ -61,7 +61,7 @@ OR initialize the DHT22 device: dht_device = adafruit_dht.DHT22() Read temperature and humidity ----------------------------- +------------------------------ Now get the temperature and humidity values From b5d59b39691bea5a147a5cd9e5c2fae0825270ba Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sat, 24 Feb 2018 20:35:09 -0600 Subject: [PATCH 7/7] updated examples; requested change in PR #4 --- examples/dht_simpletest.py | 2 +- examples/dht_to_led_display.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/dht_simpletest.py b/examples/dht_simpletest.py index 1947174..ef2e81c 100644 --- a/examples/dht_simpletest.py +++ b/examples/dht_simpletest.py @@ -8,7 +8,7 @@ while True: try: # show the values to the serial port - temperature = dhtDevice.temperature*9/5+32 + temperature = dhtDevice.temperature * (9 / 5) + 32 humidity = dhtDevice.humidity print("Temp: {:.1f} F Humidity: {}% ".format(temperature, humidity)) diff --git a/examples/dht_to_led_display.py b/examples/dht_to_led_display.py index b3b7335..de7bed1 100644 --- a/examples/dht_to_led_display.py +++ b/examples/dht_to_led_display.py @@ -25,7 +25,7 @@ while True: try: # show the values to the serial port - temperature = dhtDevice.temperature*9/5+32 + temperature = dhtDevice.temperature * (9 / 5) + 32 humidity = dhtDevice.humidity #print("Temp: {:.1f} F Humidity: {}% ".format(temperature, humidity))