From 804a973afba3516e822dd47e359c5be8918fc6ec Mon Sep 17 00:00:00 2001 From: sommersoft Date: Thu, 1 Mar 2018 20:29:50 -0600 Subject: [PATCH 1/6] renamed example; 1 learn guide needs update --- examples/{simpletest.py => max31865_simpletest.py} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename examples/{simpletest.py => max31865_simpletest.py} (100%) diff --git a/examples/simpletest.py b/examples/max31865_simpletest.py similarity index 100% rename from examples/simpletest.py rename to examples/max31865_simpletest.py From 48f1772d5da232f6d3257e74af6ca909d6ebfdb0 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Thu, 1 Mar 2018 20:41:57 -0600 Subject: [PATCH 2/6] 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 | 51 +++++++++++++++++++++++++++++++++++++++ 5 files changed, 71 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 + + Adafruit PT100 RTD Temperature Sensor Amplifier - MAX31865 + + Adafruit PT1000 RTD Temperature Sensor Amplifier - MAX31865 + +.. 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 7bc53f1f8297d613f2a416cabce96255a712a7d7 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Thu, 1 Mar 2018 20:43:19 -0600 Subject: [PATCH 3/6] update .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 4f887e6..9fa9b2b 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_max31865.py - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py) - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-max31865 --library_location . + - cd docs && sphinx-build -E -W -b html . _build/html \ No newline at end of file From 724b4c63759d72af09e534721ca98634c413e1b7 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Thu, 1 Mar 2018 20:44:15 -0600 Subject: [PATCH 4/6] updated README --- README.rst | 51 +++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 45 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 493eb27..b1eaf0d 100644 --- a/README.rst +++ b/README.rst @@ -26,7 +26,7 @@ This is easily achieved by downloading Usage Example ============= -See examples/simpletest.py for a demo of the usage. +See examples/max31865_simpletest.py for a demo of the usage. Contributing ============ @@ -35,10 +35,49 @@ Contributions are welcome! Please read our `Code of Conduct `_ before contributing to help this project stay welcoming. -API Reference -============= +Building locally +================ -.. toctree:: - :maxdepth: 2 +To build this library locally you'll need to install the +`circuitpython-build-tools `_ package. - api +.. 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-max31865 --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 + +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 1b3997e21f0b1e03305dc6cdf050336f9b2f48d6 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Thu, 1 Mar 2018 20:53:02 -0600 Subject: [PATCH 5/6] updated info docstring; removed 'get/set/etc' --- adafruit_max31865.py | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/adafruit_max31865.py b/adafruit_max31865.py index 7c1f56a..c981af2 100644 --- a/adafruit_max31865.py +++ b/adafruit_max31865.py @@ -27,6 +27,26 @@ CircuitPython module for the MAX31865 platinum RTD temperature sensor. See examples/simpletest.py for an example of the usage. * Author(s): Tony DiCola + +Implementation Notes +-------------------- + +**Hardware:** + +* Adafruit `Universal Thermocouple Amplifier MAX31856 Breakout + `_ (Product ID: 3263) + +* Adafruit `PT100 RTD Temperature Sensor Amplifier - MAX31865 + `_ (Product ID: 3328) + +* Adafruit `PT1000 RTD Temperature Sensor Amplifier - MAX31865 + `_ (Product ID: 3648) + +**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 math import time @@ -118,7 +138,7 @@ class MAX31865: @property def bias(self): - """Get and set the boolean state of the sensor's bias (True/False).""" + """The state of the sensor's bias (True/False).""" return bool(self._read_u8(_MAX31865_CONFIG_REG) & _MAX31865_CONFIG_BIAS) @bias.setter @@ -132,7 +152,7 @@ class MAX31865: @property def auto_convert(self): - """Get and set the boolean state of the sensor's automatic conversion + """The state of the sensor's automatic conversion mode (True/False). """ return bool(self._read_u8(_MAX31865_CONFIG_REG) & _MAX31865_CONFIG_MODEAUTO) @@ -148,7 +168,7 @@ class MAX31865: @property def fault(self): - """Get the fault state of the sensor. Use `clear_faults` to clear the + """The fault state of the sensor. Use ``clear_faults()`` to clear the fault state. Returns a 6-tuple of boolean values which indicate if any faults are present: - HIGHTHRESH From 26d92fae14002ba3e63f2e6f2c789f05a56fb2b7 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Thu, 1 Mar 2018 20:57:50 -0600 Subject: [PATCH 6/6] sphinx fix --- adafruit_max31865.py | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/adafruit_max31865.py b/adafruit_max31865.py index c981af2..cdac0f4 100644 --- a/adafruit_max31865.py +++ b/adafruit_max31865.py @@ -171,12 +171,13 @@ class MAX31865: """The fault state of the sensor. Use ``clear_faults()`` to clear the fault state. Returns a 6-tuple of boolean values which indicate if any faults are present: - - HIGHTHRESH - - LOWTHRESH - - REFINLOW - - REFINHIGH - - RTDINLOW - - OVUV + + - HIGHTHRESH + - LOWTHRESH + - REFINLOW + - REFINHIGH + - RTDINLOW + - OVUV """ faults = self._read_u8(_MAX31865_FAULTSTAT_REG) #pylint: disable=bad-whitespace