From d2cedce1a428f61f80caa79447c8dee36949eeb9 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Mon, 26 Feb 2018 21:43:55 -0600 Subject: [PATCH 1/7] renamed example; didn't find any learn guides needing update --- examples/{main.py => irremote_simpletest.py} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename examples/{main.py => irremote_simpletest.py} (100%) diff --git a/examples/main.py b/examples/irremote_simpletest.py similarity index 100% rename from examples/main.py rename to examples/irremote_simpletest.py From 69e1dbd8f53177c6349843025ba3c949a4f0e91c Mon Sep 17 00:00:00 2001 From: sommersoft Date: Mon, 26 Feb 2018 21:47:57 -0600 Subject: [PATCH 2/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 | 47 +++++++++++++++++++++++++++++++++++++++ 5 files changed, 67 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 + +.. 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 e31562e23b6768f3adabf28ab744467e536db127 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Mon, 26 Feb 2018 21:49:26 -0600 Subject: [PATCH 3/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 f9390c4..d180ad0 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_irremote.py - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py) - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-irremote --library_location . + - cd docs && sphinx-build -E -W -b html . _build/html \ No newline at end of file From 5df0d9d1608c20f644bdc214cbc0cd48b2dfb0ae Mon Sep 17 00:00:00 2001 From: sommersoft Date: Mon, 26 Feb 2018 23:01:56 -0600 Subject: [PATCH 4/7] update README --- README.rst | 78 +++++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 68 insertions(+), 10 deletions(-) diff --git a/README.rst b/README.rst index 6a1a61d..cbc10bf 100644 --- a/README.rst +++ b/README.rst @@ -6,11 +6,17 @@ Introduction :target: https://circuitpython.readthedocs.io/projects/irremote/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 -TODO +CircuitPython driver for use with IR Receivers. + +Examples of products to use this library with: + +* `CircuitPlayground Express `_ + +* `IR Receiver Sensor `_ Dependencies ============= @@ -25,7 +31,20 @@ This is easily achieved by downloading Usage Example ============= -TODO +.. code-block:: python + + # CircuitPlayground Express Demo Code + # Adjust the pulseio 'board.PIN' if using something else + import pulseio + import board + import adafruit_irremote + + with pulseio.PulseIn(board.REMOTEIN, maxlen=120, idle_state=True) as p: + d = adafruit_irremote.GenericDecode() + code = bytearray(4) + while True: + d.decode(p, code) + print(code) Contributing ============ @@ -34,10 +53,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-irremote --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. From 9e7f2e8b0d1c9dbfad6e295a75ea28077c21c346 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Mon, 26 Feb 2018 23:02:17 -0600 Subject: [PATCH 5/7] updated info docstring --- adafruit_irremote.py | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/adafruit_irremote.py b/adafruit_irremote.py index 908aeb3..2bfdb68 100644 --- a/adafruit_irremote.py +++ b/adafruit_irremote.py @@ -23,7 +23,7 @@ `adafruit_irremote` ==================================================== -Demo code for upcoming CircuitPlayground Express: +Demo code for CircuitPlayground Express: .. code-block: python @@ -39,6 +39,21 @@ print(code) * Author(s): Scott Shawcroft + +Implementation Notes +-------------------- + +**Hardware:** + +* `CircuitPlayground Express `_ + +* `IR Receiver Sensor `_ + +**Software and Dependencies:** + +* Adafruit CircuitPython firmware for the ESP8622 and M0-based boards: + https://github.com/adafruit/circuitpython/releases + """ # Pretend self matter because we may add object level config later. From 3c673b8f9621326436c65f6f360e5c6076906e02 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Mon, 26 Feb 2018 23:03:27 -0600 Subject: [PATCH 6/7] added IR Sensor to Related Products --- docs/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/index.rst b/docs/index.rst index 66ad922..33d2b49 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -27,6 +27,7 @@ Table of Contents :caption: Related Products CircuitPlayground Express + IR Receiver Sensor .. toctree:: :caption: Other Links From b05c09125638a7df51622c0e738902f9a2d5ecca Mon Sep 17 00:00:00 2001 From: sommersoft Date: Tue, 27 Feb 2018 18:07:55 -0600 Subject: [PATCH 7/7] formatting update --- README.rst | 4 ++-- adafruit_irremote.py | 2 +- docs/index.rst | 2 +- examples/irremote_simpletest.py | 2 ++ 4 files changed, 6 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index cbc10bf..44979a8 100644 --- a/README.rst +++ b/README.rst @@ -14,7 +14,7 @@ CircuitPython driver for use with IR Receivers. Examples of products to use this library with: -* `CircuitPlayground Express `_ +* `Circuit Playground Express `_ * `IR Receiver Sensor `_ @@ -33,7 +33,7 @@ Usage Example .. code-block:: python - # CircuitPlayground Express Demo Code + # Circuit Playground Express Demo Code # Adjust the pulseio 'board.PIN' if using something else import pulseio import board diff --git a/adafruit_irremote.py b/adafruit_irremote.py index 2bfdb68..bfdd30a 100644 --- a/adafruit_irremote.py +++ b/adafruit_irremote.py @@ -23,7 +23,7 @@ `adafruit_irremote` ==================================================== -Demo code for CircuitPlayground Express: +Demo code for Circuit Playground Express: .. code-block: python diff --git a/docs/index.rst b/docs/index.rst index 33d2b49..b6b6c27 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -26,7 +26,7 @@ Table of Contents .. toctree:: :caption: Related Products - CircuitPlayground Express + Circuit Playground Express IR Receiver Sensor .. toctree:: diff --git a/examples/irremote_simpletest.py b/examples/irremote_simpletest.py index 536be44..c4d7238 100644 --- a/examples/irremote_simpletest.py +++ b/examples/irremote_simpletest.py @@ -1,3 +1,5 @@ +# Circuit Playground Express Demo Code +# Adjust the pulseio 'board.PIN' if using something else import pulseio import board import adafruit_irremote