CircuitPython library for Honeywell MPR pressure sensors
Clone or download
Latest commit 4a97704 Dec 21, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs pypi Sep 26, 2018
examples lint Sep 9, 2018
.gitignore cookie Sep 8, 2018
.pylintrc cookie Sep 8, 2018
.readthedocs.yml cookie Sep 8, 2018
.travis.yml .travis.yml: s/adafruit-python/adafruit-travis/ Sep 26, 2018
CODE_OF_CONDUCT.md cookie Sep 8, 2018
LICENSE cookie Sep 8, 2018
README.rst change 'travis-ci.org' to 'travis-ci.com' Dec 21, 2018
adafruit_mprls.py we're only getting better & better! Sep 9, 2018
requirements.txt re-add blinka requirement Sep 9, 2018
setup.py pypi Sep 26, 2018

README.rst

Introduction

Documentation Status Discord Build Status

CircuitPython library to support Honeywell MPRLS digital pressure sensors.

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.

Usage Example

import time
import board
import busio
import adafruit_mprls

i2c = busio.I2C(board.SCL, board.SDA)

# Simplest use, connect to default over I2C
mpr = adafruit_mprls.MPRLS(i2c, psi_min=0, psi_max=25)


while True:
    print((mpr.pressure,))
    time.sleep(1)

Contributing

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

Building locally

Zip release files

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

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

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

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-mprls --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):

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.