From 36d03dd5f73f5120b2d2510c61acaa38bf34991b Mon Sep 17 00:00:00 2001 From: sommersoft Date: Thu, 1 Mar 2018 19:33:18 -0600 Subject: [PATCH 1/8] renamed example; 1 learn guide will need updated --- examples/{simpletest.py => lsm9ds1_simpletest.py} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename examples/{simpletest.py => lsm9ds1_simpletest.py} (100%) diff --git a/examples/simpletest.py b/examples/lsm9ds1_simpletest.py similarity index 100% rename from examples/simpletest.py rename to examples/lsm9ds1_simpletest.py From 8aa6fc13c72e4032aa1c7a73b6f321585885ac98 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Thu, 1 Mar 2018 19:37:05 -0600 Subject: [PATCH 2/8] 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 623f86ac43a3678fdb408f1659f1588d35a4339a Mon Sep 17 00:00:00 2001 From: sommersoft Date: Thu, 1 Mar 2018 19:38:49 -0600 Subject: [PATCH 3/8] 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 bf9153f..7b99a22 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_lsm9ds1.py - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py) - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-lsm9ds1 --library_location . + - cd docs && sphinx-build -E -W -b html . _build/html From e90a737b9d491cb1f9fc2d9f170bf94d8f0165f9 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Thu, 1 Mar 2018 19:41:30 -0600 Subject: [PATCH 4/8] updated README --- README.rst | 52 ++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 46 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index d799edd..ab06338 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/lsm9ds1_simpletest.py for a demo of the usage. Contributing ============ @@ -35,10 +35,50 @@ 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-lsm9ds1 --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 -.. toctree:: - :maxdepth: 2 +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. - api From 12858a88e122004c0654e1c96b6634e8f4eec02d Mon Sep 17 00:00:00 2001 From: sommersoft Date: Thu, 1 Mar 2018 19:43:05 -0600 Subject: [PATCH 5/8] updated info docstring --- adafruit_lsm9ds1.py | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/adafruit_lsm9ds1.py b/adafruit_lsm9ds1.py index bc851a1..c4ab47f 100644 --- a/adafruit_lsm9ds1.py +++ b/adafruit_lsm9ds1.py @@ -30,6 +30,20 @@ See examples/simpletest.py for a demo of the usage. * Author(s): Tony DiCola + +Implementation Notes +-------------------- + +**Hardware:** + +* Adafruit `9-DOF Accel/Mag/Gyro+Temp Breakout Board - LSM9DS1 + `_ (Product ID: 3387) + +**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 """ __version__ = "0.0.0-auto.0" From 697d958bee657ff214d00b1df280a57e05579600 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Thu, 1 Mar 2018 19:51:50 -0600 Subject: [PATCH 6/8] sphinx fix --- adafruit_lsm9ds1.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_lsm9ds1.py b/adafruit_lsm9ds1.py index c4ab47f..d7f6f2a 100644 --- a/adafruit_lsm9ds1.py +++ b/adafruit_lsm9ds1.py @@ -25,7 +25,7 @@ CircuitPython module for the LSM9DS1 accelerometer, magnetometer, gyroscope. Based on the driver from: - https://github.com/adafruit/Adafruit_LSM9DS1 +https://github.com/adafruit/Adafruit_LSM9DS1 See examples/simpletest.py for a demo of the usage. From 195dc2ef78ac3f3889d6097e47edcb0c30ccedfe Mon Sep 17 00:00:00 2001 From: sommersoft Date: Thu, 1 Mar 2018 19:55:16 -0600 Subject: [PATCH 7/8] remove 'get/set' docstring statements; finally remembered to look --- adafruit_lsm9ds1.py | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/adafruit_lsm9ds1.py b/adafruit_lsm9ds1.py index d7f6f2a..59b08cd 100644 --- a/adafruit_lsm9ds1.py +++ b/adafruit_lsm9ds1.py @@ -180,7 +180,7 @@ def __init__(self): @property def accel_range(self): - """Get and set the accelerometer range. Must be a value of: + """The accelerometer range. Must be a value of: - ACCELRANGE_2G - ACCELRANGE_4G - ACCELRANGE_8G @@ -208,7 +208,7 @@ def accel_range(self, val): @property def mag_gain(self): - """Get and set the magnetometer gain. Must be a value of: + """The magnetometer gain. Must be a value of: - MAGGAIN_4GAUSS - MAGGAIN_8GAUSS - MAGGAIN_12GAUSS @@ -236,7 +236,7 @@ def mag_gain(self, val): @property def gyro_scale(self): - """Get and set the gyroscope scale. Must be a value of: + """The gyroscope scale. Must be a value of: - GYROSCALE_245DPS - GYROSCALE_500DPS - GYROSCALE_2000DPS @@ -272,7 +272,7 @@ def read_accel_raw(self): @property def accelerometer(self): - """Get the accelerometer X, Y, Z axis values as a 3-tuple of + """Returns the accelerometer X, Y, Z axis values as a 3-tuple of m/s^2 values. """ raw = self.read_accel_raw() @@ -293,7 +293,7 @@ def read_mag_raw(self): @property def magnetometer(self): - """Get the magnetometer X, Y, Z axis values as a 3-tuple of + """Returns the magnetometer X, Y, Z axis values as a 3-tuple of gauss values. """ raw = self.read_mag_raw() @@ -313,7 +313,7 @@ def read_gyro_raw(self): @property def gyroscope(self): - """Get the gyroscope X, Y, Z axis values as a 3-tuple of + """Returns the gyroscope X, Y, Z axis values as a 3-tuple of degrees/second values. """ raw = self.read_mag_raw() @@ -332,7 +332,7 @@ def read_temp_raw(self): @property def temperature(self): - """Get the temperature of the sensor in degrees Celsius.""" + """Returns the temperature of the sensor in degrees Celsius.""" # This is just a guess since the starting point (21C here) isn't documented :( # See discussion from: # https://github.com/kriswiner/LSM9DS1/issues/3 From f466ac22572ac36b998516159ce8f4add6bce777 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Tue, 6 Mar 2018 20:43:33 -0600 Subject: [PATCH 8/8] updated docstrings; removed 'returns' --- adafruit_lsm9ds1.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/adafruit_lsm9ds1.py b/adafruit_lsm9ds1.py index 59b08cd..a224859 100644 --- a/adafruit_lsm9ds1.py +++ b/adafruit_lsm9ds1.py @@ -272,7 +272,7 @@ def read_accel_raw(self): @property def accelerometer(self): - """Returns the accelerometer X, Y, Z axis values as a 3-tuple of + """The accelerometer X, Y, Z axis values as a 3-tuple of m/s^2 values. """ raw = self.read_accel_raw() @@ -293,7 +293,7 @@ def read_mag_raw(self): @property def magnetometer(self): - """Returns the magnetometer X, Y, Z axis values as a 3-tuple of + """The magnetometer X, Y, Z axis values as a 3-tuple of gauss values. """ raw = self.read_mag_raw() @@ -313,7 +313,7 @@ def read_gyro_raw(self): @property def gyroscope(self): - """Returns the gyroscope X, Y, Z axis values as a 3-tuple of + """The gyroscope X, Y, Z axis values as a 3-tuple of degrees/second values. """ raw = self.read_mag_raw() @@ -332,7 +332,7 @@ def read_temp_raw(self): @property def temperature(self): - """Returns the temperature of the sensor in degrees Celsius.""" + """The temperature of the sensor in degrees Celsius.""" # This is just a guess since the starting point (21C here) isn't documented :( # See discussion from: # https://github.com/kriswiner/LSM9DS1/issues/3