Metadata-Version: 2.1
Name: micropython-lis3dh
Version: 0.1.1
Summary: LIS3DH MicroPython Driver
Author-email: "Jose D. Montoya" <lis3dh@mailmeto.mozmail.com>
License: MIT
Project-URL: Homepage, https://github.com/jposada202020/MicroPython_LIS3DH
Keywords: micropython,lis3dh,sernsor,acceleration,tap,movement,sensor
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Embedded Systems
Classifier: Topic :: System :: Hardware
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: Implementation :: MicroPython
Description-Content-Type: text/x-rst
License-File: LICENSE

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


.. image:: https://img.shields.io/badge/micropython-Ok-purple.svg
    :target: https://micropython.org
    :alt: micropython

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

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

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


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

LIS3DH MicroPython Driver. Work is based in:
    * https://github.com/adafruit/Adafruit_CircuitPython_LIS3DH/
    * https://github.com/adafruit/Adafruit_CircuitPython_Register


Installing with mip
====================

To install using mpremote

.. code-block:: shell

    mpremote mip install github:jposada202020/MicroPython_LIS3DH

To install directly using a WIFI capable board

.. code-block:: shell

    mip install github:jposada202020/MicroPython_LIS3DH


Installing Library Examples
============================

If you want to install library examples:

.. code-block:: shell

    mpremote mip install github:jposada202020/MicroPython_LIS3DH/examples.json

To install directly using a WIFI capable board

.. code-block:: shell

    mip install github:jposada202020/MicroPython_LIS3DH/examples.json



Installation
=============

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/micropython-lis3dh/>`_.
To install for current user:

.. code-block:: shell

    pip3 install micropython-lis3dh

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

.. code-block:: shell

    sudo pip3 install micropython-lis3dh

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 micropython-lis3dh
