adafruit-circuitpython-bno08x-rvc


Nameadafruit-circuitpython-bno08x-rvc JSON
Version 1.0.17 PyPI version JSON
download
home_pageNone
SummaryA simple helper library for using the UART-RVC mode of the BNO08x IMUs
upload_time2024-10-07 21:38:27
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseMIT
keywords adafruit blinka circuitpython micropython bno08x_rvc imu rvc uart hillcrest laboratories sensor fusion heading ahrs
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-bno08x_rvc/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/bno08x_rvc/en/latest/
    :alt: Documentation Status

.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
    :target: https://adafru.it/discord
    :alt: Discord

.. image:: https://github.com/adafruit/Adafruit_CircuitPython_BNO08x_RVC/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_BNO08x_RVC/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

A simple helper library for using the UART-RVC mode of the BNO08x IMUs


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

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_

Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_.

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

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

.. code-block:: shell

    pip3 install adafruit-circuitpython-bno08x-rvc

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-bno08x-rvc

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name
    python3 -m venv .venv
    source .venv/bin/activate
    pip3 install adafruit-circuitpython-bno08x-rvc

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

.. code-block:: python3

    import time
    import board
    import busio
    from adafruit_bno08x_rvc import BNO08x_RVC

    uart = busio.UART(board.TX, board.RX, baudrate=115200, receiver_buffer_size=2048)
    rvc = BNO08x_RVC(uart)
    while True:
        roll, pitch, yaw, x_accel, y_accel, z_accel = rvc.heading
        print("Roll: %2.2f Pitch: %2.2f Yaw: %2.2f Degrees" % (roll, pitch, yaw))
        print("Acceleration X: %2.2f Y: %2.2f Z: %2.2f m/s^2" % (x_accel, y_accel, z_accel))
        print("")
        time.sleep(0.1)

Documentation
=============

API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/bno08x_rvc/en/latest/>`_.

For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.

Contributing
============

Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_BNO08x_RVC/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "adafruit-circuitpython-bno08x-rvc",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "adafruit, blinka, circuitpython, micropython, bno08x_rvc, IMU, RVC, UART, Hillcrest, Laboratories, Sensor, Fusion, Heading, AHRS",
    "author": null,
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/6b/77/a89d01a10c8ca77e085a28de9d3d6a54c5d6c7a131467549ce7bb449be3c/adafruit_circuitpython_bno08x_rvc-1.0.17.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-bno08x_rvc/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/bno08x_rvc/en/latest/\n    :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n    :target: https://adafru.it/discord\n    :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_BNO08x_RVC/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_BNO08x_RVC/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\nA simple helper library for using the UART-RVC mode of the BNO08x IMUs\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_.\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/adafruit-circuitpython-bno08x_rvc/>`_. To install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-bno08x-rvc\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-bno08x-rvc\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 .venv/bin/activate\n    pip3 install adafruit-circuitpython-bno08x-rvc\n\nUsage Example\n=============\n\n.. code-block:: python3\n\n    import time\n    import board\n    import busio\n    from adafruit_bno08x_rvc import BNO08x_RVC\n\n    uart = busio.UART(board.TX, board.RX, baudrate=115200, receiver_buffer_size=2048)\n    rvc = BNO08x_RVC(uart)\n    while True:\n        roll, pitch, yaw, x_accel, y_accel, z_accel = rvc.heading\n        print(\"Roll: %2.2f Pitch: %2.2f Yaw: %2.2f Degrees\" % (roll, pitch, yaw))\n        print(\"Acceleration X: %2.2f Y: %2.2f Z: %2.2f m/s^2\" % (x_accel, y_accel, z_accel))\n        print(\"\")\n        time.sleep(0.1)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/bno08x_rvc/en/latest/>`_.\n\nFor information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_BNO08x_RVC/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A simple helper library for using the UART-RVC mode of the BNO08x IMUs",
    "version": "1.0.17",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_BNO08x_RVC"
    },
    "split_keywords": [
        "adafruit",
        " blinka",
        " circuitpython",
        " micropython",
        " bno08x_rvc",
        " imu",
        " rvc",
        " uart",
        " hillcrest",
        " laboratories",
        " sensor",
        " fusion",
        " heading",
        " ahrs"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6a8c12c86872b7d7c9b9ba32c014cdbca9eb63ea46eec58fbe6da619f01ff3c8",
                "md5": "75054be567b3163b01ec32d2ce67dff4",
                "sha256": "0f391606d4a74fdcc5f0ab8008d6b2c671f42e7bffeb0bf08466893710e090a4"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_bno08x_rvc-1.0.17-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "75054be567b3163b01ec32d2ce67dff4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 5269,
            "upload_time": "2024-10-07T21:38:26",
            "upload_time_iso_8601": "2024-10-07T21:38:26.013405Z",
            "url": "https://files.pythonhosted.org/packages/6a/8c/12c86872b7d7c9b9ba32c014cdbca9eb63ea46eec58fbe6da619f01ff3c8/adafruit_circuitpython_bno08x_rvc-1.0.17-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6b77a89d01a10c8ca77e085a28de9d3d6a54c5d6c7a131467549ce7bb449be3c",
                "md5": "fc53ca419e2913f6780ebaa2ff9f6a4d",
                "sha256": "263a406fa83b7728249f1b43ae638f69b70597c80f623390604e1e0bbf895230"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_bno08x_rvc-1.0.17.tar.gz",
            "has_sig": false,
            "md5_digest": "fc53ca419e2913f6780ebaa2ff9f6a4d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 26342,
            "upload_time": "2024-10-07T21:38:27",
            "upload_time_iso_8601": "2024-10-07T21:38:27.167326Z",
            "url": "https://files.pythonhosted.org/packages/6b/77/a89d01a10c8ca77e085a28de9d3d6a54c5d6c7a131467549ce7bb449be3c/adafruit_circuitpython_bno08x_rvc-1.0.17.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-07 21:38:27",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_BNO08x_RVC",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "adafruit-circuitpython-bno08x-rvc"
}
        
Elapsed time: 0.53517s