From aa919696afb09232e939e6c385291037533fe02c Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sat, 24 Feb 2018 20:41:59 -0600 Subject: [PATCH 1/7] renamed example --- examples/{simpletest.py => drv2605_simpletest.py} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename examples/{simpletest.py => drv2605_simpletest.py} (100%) diff --git a/examples/simpletest.py b/examples/drv2605_simpletest.py similarity index 100% rename from examples/simpletest.py rename to examples/drv2605_simpletest.py From 38e4b646f6bc6915c4207b248f9d0f5574412329 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sat, 24 Feb 2018 20:45:59 -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 684b3d3d5c15d386acd5cc217436c9589dd9f57d Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sat, 24 Feb 2018 20:47:35 -0600 Subject: [PATCH 3/7] updated .travis & .readthedocs yml --- readthedocs.yml => .readthedocs.yml | 0 .travis.yml | 5 +++-- 2 files changed, 3 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 91d4215..13429b4 100644 --- a/.travis.yml +++ b/.travis.yml @@ -16,16 +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_drv2605.py - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py) - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-drv2605 --library_location . + - cd docs && sphinx-build -E -W -b html . _build/html From 1ba00d61a69525fdaea7dba46742aeeaf0cb3dc6 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sat, 24 Feb 2018 20:48:34 -0600 Subject: [PATCH 4/7] updated README --- README.rst | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/README.rst b/README.rst index 192272e..5326f40 100644 --- a/README.rst +++ b/README.rst @@ -26,15 +26,7 @@ This is easily achieved by downloading Usage Example ============= -See examples/simpletest.py for a demo of the usage. - -API Reference -============= - -.. toctree:: - :maxdepth: 2 - - api +See examples/drv2605_simpletest.py for a demo of the usage. Contributing ============ From dc935ca00017b3486c2fe5c349ba5570dcceb7f8 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sat, 24 Feb 2018 20:52:00 -0600 Subject: [PATCH 5/7] sphinx fixes --- adafruit_drv2605.py | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/adafruit_drv2605.py b/adafruit_drv2605.py index e5a285e..610a0a4 100644 --- a/adafruit_drv2605.py +++ b/adafruit_drv2605.py @@ -148,7 +148,9 @@ def stop(self): @property def mode(self): - """Get and set the mode of the chip. Should be a value of: + """ + Get and set the mode of the chip. Should be a value of: + - MODE_INTTRIG: Internal triggering, vibrates as soon as you call play(). Default mode. - MODE_EXTTRIGEDGE: External triggering, edge mode. @@ -158,6 +160,7 @@ def mode(self): - MODE_REALTIME: Real-time playback mode. - MODE_DIAGNOS: Diagnostics mode. - MODE_AUTOCAL: Auto-calibration mode. + See the datasheet for the meaning of modes beyond MODE_INTTRIG. """ return self._read_u8(_DRV2605_REG_MODE) @@ -169,8 +172,10 @@ def mode(self, val): @property def library(self): - """Get and set the library selected for waveform playback. Should be + """ + Get and set the library selected for waveform playback. Should be a value of: + - LIBRARY_EMPTY: Empty - LIBRARY_TS2200A: TS2200 library A (the default) - LIBRARY_TS2200B: TS2200 library B @@ -178,6 +183,7 @@ def library(self): - LIBRARY_TS2200D: TS2200 library D - LIBRARY_TS2200E: TS2200 library E - LIBRARY_LRA: LRA library + See the datasheet for the meaning and description of effects in each library. """ From 072c8de51be524e1fc4f93538da989a172778d94 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sat, 24 Feb 2018 20:55:19 -0600 Subject: [PATCH 6/7] pylint/sphinx fixes --- adafruit_drv2605.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/adafruit_drv2605.py b/adafruit_drv2605.py index 610a0a4..9509599 100644 --- a/adafruit_drv2605.py +++ b/adafruit_drv2605.py @@ -20,7 +20,7 @@ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. """ -`Adafruit_DRV2605` +`adafruit_drv2605` ==================================================== CircuitPython module for the DRV2605 haptic feedback motor driver. See @@ -160,7 +160,7 @@ def mode(self): - MODE_REALTIME: Real-time playback mode. - MODE_DIAGNOS: Diagnostics mode. - MODE_AUTOCAL: Auto-calibration mode. - + See the datasheet for the meaning of modes beyond MODE_INTTRIG. """ return self._read_u8(_DRV2605_REG_MODE) @@ -183,7 +183,7 @@ def library(self): - LIBRARY_TS2200D: TS2200 library D - LIBRARY_TS2200E: TS2200 library E - LIBRARY_LRA: LRA library - + See the datasheet for the meaning and description of effects in each library. """ From ae370fbdbae5f40024cd58478b9c9b19232aded5 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sun, 25 Feb 2018 20:26:39 -0600 Subject: [PATCH 7/7] updated docstrings; removed 'get/set' --- adafruit_drv2605.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_drv2605.py b/adafruit_drv2605.py index 9509599..4d95796 100644 --- a/adafruit_drv2605.py +++ b/adafruit_drv2605.py @@ -149,7 +149,7 @@ def stop(self): @property def mode(self): """ - Get and set the mode of the chip. Should be a value of: + The mode of the chip. Should be a value of: - MODE_INTTRIG: Internal triggering, vibrates as soon as you call play(). Default mode. @@ -173,7 +173,7 @@ def mode(self, val): @property def library(self): """ - Get and set the library selected for waveform playback. Should be + The library selected for waveform playback. Should be a value of: - LIBRARY_EMPTY: Empty