https://github.com/jposada202020/circuitpython_kx132

CircuitPython Driver for the Kionix KX132 Accelerometer
https://github.com/jposada202020/circuitpython_kx132

accelerometer circuitpython kionix kx132

Last synced: about 1 month ago
JSON representation

CircuitPython Driver for the Kionix KX132 Accelerometer

• Host: GitHub
• URL: https://github.com/jposada202020/circuitpython_kx132
• Owner: jposada202020
• License: mit
• Created: 2023-06-07T15:53:12.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-06-09T00:53:58.000Z (over 1 year ago)
• Last Synced: 2024-11-13T11:43:23.898Z (about 1 month ago)
• Topics: accelerometer, circuitpython, kionix, kx132
• Language: Python
• Homepage:
• Size: 36.1 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Introduction

============

.. image:: https://readthedocs.org/projects/circuitpython-kx132/badge/?version=latest

    :target: https://circuitpython-kx132.readthedocs.io/

    :alt: Documentation Status

.. image:: https://img.shields.io/pypi/v/circuitpython-kx132.svg

    :alt: latest version on PyPI

    :target: https://pypi.python.org/pypi/circuitpython-kx132

.. image:: https://static.pepy.tech/personalized-badge/circuitpython-kx132?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-kx132

.. image:: https://github.com/jposada202020/CircuitPython_KX132/workflows/Build%20CI/badge.svg

    :target: https://github.com/jposada202020/CircuitPython_KX132/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

CircuitPython Driver for the Kionix KX132 Accelerometer

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-kx132

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

.. code-block:: shell

    sudo pip3 install circuitpython-kx132

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-kx132

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 kx132

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 `_.