From a122be215f3db8f86f582e72cd43f4b1f0712ce0 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Fri, 2 Mar 2018 16:52:52 -0600 Subject: [PATCH 1/5] renamed example; 2 learn guides found do not need updates --- examples/{simpletest.py => pca9685_simpletest.py} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename examples/{simpletest.py => pca9685_simpletest.py} (100%) diff --git a/examples/simpletest.py b/examples/pca9685_simpletest.py similarity index 100% rename from examples/simpletest.py rename to examples/pca9685_simpletest.py From 4d546ad841cefe58647c4b74baee234e1c06b869 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Fri, 2 Mar 2018 16:58:52 -0600 Subject: [PATCH 2/5] 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 | 16 +++++++++++++ docs/index.rst | 47 +++++++++++++++++++++++++++++++++++++++ 5 files changed, 75 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 1eb1f150df8ce2c0ba61364c681481ab1aa5ab55 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Fri, 2 Mar 2018 16:59:56 -0600 Subject: [PATCH 3/5] 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 024a8c3..234851c 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_pca9685.py - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py) - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-pca9685 --library_location . + - cd docs && sphinx-build -E -W -b html . _build/html From bb69d5a32c309ffdb8964f420a8762c06ec3df8f Mon Sep 17 00:00:00 2001 From: sommersoft Date: Fri, 2 Mar 2018 17:02:33 -0600 Subject: [PATCH 4/5] updated README --- README.rst | 53 +++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 47 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 291b341..5be4c63 100644 --- a/README.rst +++ b/README.rst @@ -17,6 +17,8 @@ Dependencies This driver depends on: * `Adafruit CircuitPython `_ +* `Bus Device `_ +* `Register `_ Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading @@ -25,7 +27,7 @@ This is easily achieved by downloading Usage Example ============= -TODO +See examples/pca9685_simpletest.py for a demo of the usage. Contributing ============ @@ -34,10 +36,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-pca9685 --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 d03375797e56b57fbef1de7cde0fffdab6f49a5a Mon Sep 17 00:00:00 2001 From: sommersoft Date: Fri, 2 Mar 2018 17:06:01 -0600 Subject: [PATCH 5/5] updated info docstring; slight docstring formatting --- adafruit_pca9685.py | 32 ++++++++++++++++++++++++-------- 1 file changed, 24 insertions(+), 8 deletions(-) diff --git a/adafruit_pca9685.py b/adafruit_pca9685.py index d3dd685..2d40501 100755 --- a/adafruit_pca9685.py +++ b/adafruit_pca9685.py @@ -31,6 +31,21 @@ outputs for specific uses instead of generic duty_cycle adjustments. * Author(s): Scott Shawcroft + +Implementation Notes +-------------------- + +**Hardware:** + +* Adafruit `16-Channel 12-bit PWM/Servo Driver - I2C interface - PCA9685 + `_ (Product ID: 815) + +**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 +* Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register """ __version__ = "0.0.0-auto.0" @@ -89,16 +104,17 @@ def __getitem__(self, index): return self._channels[index] class PCA9685: - """Initialise the PCA9685 chip at ``address`` on ``i2c_bus``. + """ + Initialise the PCA9685 chip at ``address`` on ``i2c_bus``. - The internal reference clock is 25mhz but may vary slightly with environmental conditions and - manufacturing variances. Providing a more precise ``reference_clock_speed`` can improve the - accuracy of the frequency and duty_cycle computations. See the ``calibration.py`` example for - how to derive this value by measuring the resulting pulse widths. + The internal reference clock is 25mhz but may vary slightly with environmental conditions and + manufacturing variances. Providing a more precise ``reference_clock_speed`` can improve the + accuracy of the frequency and duty_cycle computations. See the ``calibration.py`` example for + how to derive this value by measuring the resulting pulse widths. - :param ~busio.I2C i2c_bus: The I2C bus which the PCA9685 is connected to. - :param int address: The I2C address of the PCA9685. - :param int reference_clock_speed: The frequency of the internal reference clock in Herz. + :param ~busio.I2C i2c_bus: The I2C bus which the PCA9685 is connected to. + :param int address: The I2C address of the PCA9685. + :param int reference_clock_speed: The frequency of the internal reference clock in Herz. """ # Registers: mode1_reg = UnaryStruct(0x00, '