From a7a2bec2729d78231f96c8dc638859c26678aed4 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sat, 3 Mar 2018 19:10:52 -0600 Subject: [PATCH 1/7] renamed example; 1 learn guide will need links updated --- examples/{simpletest.py => tcs34725_simpletest.py} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename examples/{simpletest.py => tcs34725_simpletest.py} (100%) diff --git a/examples/simpletest.py b/examples/tcs34725_simpletest.py similarity index 100% rename from examples/simpletest.py rename to examples/tcs34725_simpletest.py From 5eb30e9e3faa199fb387584f278e6e2a15503d7a Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sat, 3 Mar 2018 19:13:54 -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 | 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 + + Flora Color Sensor with White Illumination LED - TCS34725 + +.. 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 5c0210b66dae2e5e74d8da9e93530825ce5ee7b5 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sat, 3 Mar 2018 19:15:11 -0600 Subject: [PATCH 3/7] updated .travis & .readthedocs yml --- readthedocs.yml => .readthedocs.yml | 0 .travis.yml | 7 +++++-- 2 files changed, 5 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 ed186a1..0176e0d 100644 --- a/.travis.yml +++ b/.travis.yml @@ -16,15 +16,18 @@ 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_tcs34725.py - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py) - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-tcs34725 --library_location . + - cd docs && sphinx-build -E -W -b html . _build/html + From ab70b9ed1f2e777c763cfb68d999175945bfbdd8 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sat, 3 Mar 2018 19:18:28 -0600 Subject: [PATCH 4/7] updated README --- README.rst | 55 ++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 49 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index e713c41..4b03cbc 100644 --- a/README.rst +++ b/README.rst @@ -10,6 +10,10 @@ Introduction :target: https://discord.gg/nBQh6qu :alt: Discord +.. image:: https://travis-ci.org/adafruit/Adafruit_CircuitPython_TCS34725.svg?branch=master + :target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_TCS34725 + :alt: Build Status + CircuitPython module for the TCS34725 color sensor. Dependencies @@ -26,7 +30,7 @@ This is easily achieved by downloading Usage Example ============= -See examples/simpletest.py for an example of the module's usage. +See examples/tcs34725_simpletest.py for an example of the module's usage. Contributing ============ @@ -35,10 +39,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-tcs34725 --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 1b2603379aa4dde32ad04a294a25405cc72efde7 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sat, 3 Mar 2018 19:22:14 -0600 Subject: [PATCH 5/7] updated info docstring; removed 'get/set' from docstrings --- adafruit_tcs34725.py | 33 +++++++++++++++++++++++++-------- 1 file changed, 25 insertions(+), 8 deletions(-) diff --git a/adafruit_tcs34725.py b/adafruit_tcs34725.py index 6118ee3..ba0e498 100644 --- a/adafruit_tcs34725.py +++ b/adafruit_tcs34725.py @@ -27,9 +27,26 @@ micropython-adafruit-tcs34725 module by Radomir Dopieralski: https://github.com/adafruit/micropython-adafruit-tcs34725 -See examples/simpletest.py for an example of the usage. +See examples/tcs34725_simpletest.py for an example of the usage. * Author(s): Tony DiCola + +Implementation Notes +-------------------- + +**Hardware:** + +* Adafruit `RGB Color Sensor with IR filter and White LED - TCS34725 + `_ (Product ID: 1334) + +* Flora `Color Sensor with White Illumination LED - TCS34725 + `_ (Product ID: 1356) + +**Software and Dependencies:** + +* Adafruit CircuitPython firmware 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 """ import time @@ -127,7 +144,7 @@ def _write_u16(self, address, val): @property def active(self): - """Get and set the active state of the sensor. Boolean value that will + """The active state of the sensor. Boolean value that will enable/activate the sensor with a value of True and disable with a value of False. """ @@ -150,7 +167,7 @@ def active(self, val): @property def integration_time(self): - """Get and set the integration time of the sensor in milliseconds.""" + """The integration time of the sensor in milliseconds.""" return self._integration_time @integration_time.setter @@ -162,7 +179,7 @@ def integration_time(self, val): @property def gain(self): - """Get and set the gain of the sensor. Should be a value of 1, 4, 16, + """The gain of the sensor. Should be a value of 1, 4, 16, or 60. """ return _GAINS[self._read_u8(_REGISTER_CONTROL)] @@ -174,7 +191,7 @@ def gain(self, val): @property def interrupt(self): - """Get and clear the interrupt of the sensor. Returns a bool that's + """Return and clear the interrupt of the sensor. Returns a bool that's True if the interrupt is set. Can be set to False (and only False) to clear the interrupt. """ @@ -235,7 +252,7 @@ def lux(self): @property def cycles(self): - """Get and set the persistence cycles of the sensor.""" + """The persistence cycles of the sensor.""" if self._read_u8(_REGISTER_ENABLE) & _ENABLE_AIEN: return _CYCLES[self._read_u8(_REGISTER_APERS) & 0x0f] return -1 @@ -252,7 +269,7 @@ def cycles(self, val): @property def min_value(self): - """Get and set the minimum threshold value (AILT register) of the + """The minimum threshold value (AILT register) of the sensor as a 16-bit unsigned value. """ return self._read_u16(_REGISTER_AILT) @@ -263,7 +280,7 @@ def min_value(self, val): @property def max_value(self): - """Get and set the minimum threshold value (AIHT register) of the + """The minimum threshold value (AIHT register) of the sensor as a 16-bit unsigned value. """ return self._read_u16(_REGISTER_AIHT) From c5b76038c2e0616ba9ef5fe0d3a1cdc080308ff6 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sat, 3 Mar 2018 19:25:54 -0600 Subject: [PATCH 6/7] sphinx fix --- adafruit_tcs34725.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_tcs34725.py b/adafruit_tcs34725.py index ba0e498..48cea7f 100644 --- a/adafruit_tcs34725.py +++ b/adafruit_tcs34725.py @@ -25,7 +25,7 @@ CircuitPython module for the TCS34725 color sensor. Ported from the micropython-adafruit-tcs34725 module by Radomir Dopieralski: - https://github.com/adafruit/micropython-adafruit-tcs34725 +https://github.com/adafruit/micropython-adafruit-tcs34725 See examples/tcs34725_simpletest.py for an example of the usage. From 97304972a75ca7e545bbde178e25edb1b1307df3 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Tue, 6 Mar 2018 20:50:51 -0600 Subject: [PATCH 7/7] updated docstring --- adafruit_tcs34725.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/adafruit_tcs34725.py b/adafruit_tcs34725.py index 48cea7f..daf12d4 100644 --- a/adafruit_tcs34725.py +++ b/adafruit_tcs34725.py @@ -191,8 +191,7 @@ def gain(self, val): @property def interrupt(self): - """Return and clear the interrupt of the sensor. Returns a bool that's - True if the interrupt is set. Can be set to False (and only False) + """True if the interrupt is set. Can be set to False (and only False) to clear the interrupt. """ return bool(self._read_u8(_REGISTER_STATUS) & _ENABLE_AIEN)