Skip to content
Adafruit CircuitPython module for the LIS3DH accelerometer.
Branch: master
Clone or download
makermelissa Merge pull request #50 from dherrada/master
Added module name to beginning of example filename and updated docs to reflect this
Latest commit f5892e2 May 10, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Updated docs to reflect filename changes May 10, 2019
examples Added module name to example filename May 10, 2019
.gitignore PyPi setup. Aug 1, 2018
.pylintrc Update .pylintrc to ignore board Aug 12, 2018
.readthedocs.yml updated .travis & .readthedocs yml Feb 28, 2018
.travis.yml
CODE_OF_CONDUCT.md updated CoC Aug 1, 2018
LICENSE
README.rst change 'travis-ci.org' to 'travis-ci.com' Dec 21, 2018
adafruit_lis3dh.py fix for pylint SPI complaint bug Aug 29, 2018
requirements.txt fix missing busdevice dependancy Aug 29, 2018
setup.py PyPi setup. Aug 1, 2018

README.rst

Introduction

Documentation Status Discord Build Status

Adafruit CircuitPython module for the LIS3DH accelerometer.

Note this module is made to work with CircuitPython and not MicroPython APIs.

Usage Example

See the guide at: https://learn.adafruit.com/circuitpython-hardware-lis3dh-accelerometer

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Building locally

To build this library locally you'll need to install the circuitpython-travis-build-tools package.

Once installed, make sure you are in the virtual environment:

Then run the build:

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):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

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.

You can’t perform that action at this time.