Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jposada202020/circuitpython_lps28

CircuitPython driver for the LPS28 pressure sensor
https://github.com/jposada202020/circuitpython_lps28

circuitpython lps28 pressure sensor

Last synced: about 1 month ago
JSON representation

CircuitPython driver for the LPS28 pressure sensor

Awesome Lists containing this project

README

        

Introduction
============

.. image:: https://readthedocs.org/projects/circuitpython-lps28/badge/?version=latest
:target: https://circuitpython-lps28.readthedocs.io/
:alt: Documentation Status

.. image:: https://img.shields.io/pypi/v/circuitpython-lps28.svg
:alt: latest version on PyPI
:target: https://pypi.python.org/pypi/circuitpython-lps28

.. image:: https://static.pepy.tech/personalized-badge/circuitpython-lps28?period=total&units=international_system&left_color=grey&right_color=blue&left_text=Pypi%20Downloads
:alt: Total PyPI downloads
:target: https://pepy.tech/project/circuitpython-lps28

.. image:: https://github.com/jposada202020/CircuitPython_LPS28/workflows/Build%20CI/badge.svg
:target: https://github.com/jposada202020/CircuitPython_LPS28/actions
:alt: Build Status

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black

LPS28 pressure sensor drive for CircuitPython

Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython `_
* `Bus Device `_
* `Register `_

Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Community Bundle library and driver bundle `_
or individual libraries can be installed using
`circup `_.

Installing from PyPI
=====================

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI `_.
To install for current user:

.. code-block:: shell

pip3 install circuitpython-lps28

To install system-wide (this may be required in some cases):

.. code-block:: shell

sudo pip3 install circuitpython-lps28

To install in a virtual environment in your current project:

.. code-block:: shell

mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install circuitpython-lps28

Installing to a Connected CircuitPython Device with Circup
==========================================================

Make sure that you have ``circup`` installed in your Python environment.
Install it with the following command if necessary:

.. code-block:: shell

pip3 install circup

With ``circup`` installed and your CircuitPython device connected use the
following command to install:

.. code-block:: shell

circup install lps28

Or the following command to update an existing version:

.. code-block:: shell

circup update

Usage Example
=============

Take a look at the examples directory

Documentation
=============
API documentation for this library can be found on `Read the Docs `_.