Introduction
============
.. image:: https://readthedocs.org/projects/circuitpython-bma423/badge/?version=latest
:target: https://circuitpython-bma423.readthedocs.io/
:alt: Documentation Status
.. image:: https://img.shields.io/pypi/v/circuitpython-bma423.svg
:alt: latest version on PyPI
:target: https://pypi.python.org/pypi/circuitpython-bma423
.. image:: https://static.pepy.tech/personalized-badge/circuitpython-bma423?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-bma423
.. image:: https://github.com/jposada202020/CircuitPython_BMA423/workflows/Build%20CI/badge.svg
:target: https://github.com/jposada202020/CircuitPython_BMA423/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 Bosch BMA423 accelerometer included in the lilygo watch
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Community Bundle library and driver bundle <https://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/circuitpython-bma423/>`_.
To install for current user:
.. code-block:: shell
pip3 install circuitpython-bma423
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install circuitpython-bma423
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-bma423
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 bma423
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 <https://circuitpython-bma423.readthedocs.io/>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/jposada202020/CircuitPython_/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "circuitpython-bma423",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "sensor,blinka,circuitpython,micropython,bma423,sensor,accelerometer,BMA423,steps,running,lilygo",
"author": "",
"author_email": "\"Jose D. Montoya\" <jlib@mailmeto.mozmail.com>",
"download_url": "https://files.pythonhosted.org/packages/0f/96/4e3fc1327a1910b3b88d1173d7288a0b2547c299a2361e9d666714311f7f/circuitpython-bma423-0.1.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/circuitpython-bma423/badge/?version=latest\n :target: https://circuitpython-bma423.readthedocs.io/\n :alt: Documentation Status\n\n\n.. image:: https://img.shields.io/pypi/v/circuitpython-bma423.svg\n :alt: latest version on PyPI\n :target: https://pypi.python.org/pypi/circuitpython-bma423\n\n.. image:: https://static.pepy.tech/personalized-badge/circuitpython-bma423?period=total&units=international_system&left_color=grey&right_color=blue&left_text=Pypi%20Downloads\n :alt: Total PyPI downloads\n :target: https://pepy.tech/project/circuitpython-bma423\n\n.. image:: https://github.com/jposada202020/CircuitPython_BMA423/workflows/Build%20CI/badge.svg\n :target: https://github.com/jposada202020/CircuitPython_BMA423/actions\n :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nCircuitPython Driver for the Bosch BMA423 accelerometer included in the lilygo watch\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Community Bundle library and driver bundle <https://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\n\nInstalling from PyPI\n=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/circuitpython-bma423/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install circuitpython-bma423\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install circuitpython-bma423\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .env/bin/activate\n pip3 install circuitpython-bma423\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install bma423\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\nTake a look at the examples directory\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://circuitpython-bma423.readthedocs.io/>`_.\n\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/jposada202020/CircuitPython_/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython Driver for the Bosch BMA423 accelerometer included in the lilygo watch",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/jposada202020/CircuitPython_BMA423"
},
"split_keywords": [
"sensor",
"blinka",
"circuitpython",
"micropython",
"bma423",
"sensor",
"accelerometer",
"bma423",
"steps",
"running",
"lilygo"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c4f4a81fb74da2cf83d0f24a810e1b964872246f36098c8e82144b269115b514",
"md5": "dc0d29e633f2676d9c722f7cebae7035",
"sha256": "1810a3caa9d72d2c01b733dedf6506fd710daaa85233c5f5b1da8039b34c14d7"
},
"downloads": -1,
"filename": "circuitpython_bma423-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dc0d29e633f2676d9c722f7cebae7035",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6146,
"upload_time": "2023-05-07T18:16:04",
"upload_time_iso_8601": "2023-05-07T18:16:04.784581Z",
"url": "https://files.pythonhosted.org/packages/c4/f4/a81fb74da2cf83d0f24a810e1b964872246f36098c8e82144b269115b514/circuitpython_bma423-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0f964e3fc1327a1910b3b88d1173d7288a0b2547c299a2361e9d666714311f7f",
"md5": "b625baeb2a15ca47d301ca0afcb74ae0",
"sha256": "3ff11e94b2450ec3f860fdae45de05877901907bf09de2a5ea292b7896c352e8"
},
"downloads": -1,
"filename": "circuitpython-bma423-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "b625baeb2a15ca47d301ca0afcb74ae0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 22335,
"upload_time": "2023-05-07T18:16:07",
"upload_time_iso_8601": "2023-05-07T18:16:07.819806Z",
"url": "https://files.pythonhosted.org/packages/0f/96/4e3fc1327a1910b3b88d1173d7288a0b2547c299a2361e9d666714311f7f/circuitpython-bma423-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-07 18:16:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jposada202020",
"github_project": "CircuitPython_BMA423",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "circuitpython-bma423"
}
JSON
