Metadata-Version: 2.1
Name: adafruit-circuitpython-bno055
Version: 3.0.4
Summary: CircuitPython library for BNO055 9-DOF absolute orientation sensor.
Home-page: https://github.com/adafruit/Adafruit_CircuitPython_BNO055
Author: Radomir Dopieralski
Author-email: circuitpython@adafruit.com
License: MIT
Description: Introduction
        ============
        
        .. image:: https://readthedocs.org/projects/adafruit-circuitpython-bno055/badge/?version=latest
            :target: https://circuitpython.readthedocs.io/projects/bno055/en/latest/
            :alt: Documentation Status
        
        .. image :: https://img.shields.io/discord/327254708534116352.svg
            :target: https://adafru.it/discord
            :alt: Discord
        
        .. image:: https://travis-ci.org/adafruit/Adafruit_CircuitPython_BNO055.svg?branch=master
            :target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_BNO055
            :alt: Build Status
        
        
        Dependencies
        =============
        
        This driver depends on the `Register
        <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_ and `Bus Device
        <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_ libraries.
        Please ensure they are also available on the CircuitPython filesystem.  This is
        easily achieved by downloading `a library and driver bundle
        <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
        
        Usage Notes
        ===========
        
        Of course, you must import the library to use it:
        
        .. code:: python
        
            import adafruit_bno055
        
        
        This driver takes an instantiated and active I2C object (from the `busio` or
        the `bitbangio` library) as an argument to its constructor.  The way to create
        an I2C object depends on the board you are using. For boards with labeled SCL
        and SDA pins, you can:
        
        .. code:: python
        
            from busio import I2C
            from board import SDA, SCL
        
            i2c = I2C(SCL, SDA)
        
        Once you have the I2C object, you can create the sensor object:
        
        .. code:: python
        
            sensor = adafruit_bno055.BNO055(i2c)
        
        
        And then you can start reading the measurements:
        
        .. code:: python
        
            print(sensor.temperature)
            print(sensor.euler)
            print(sensor.gravity)
        
        
        Contributing
        ============
        
        Contributions are welcome! Please read our `Code of Conduct
        <https://github.com/adafruit/Adafruit_CircuitPython_bno055/blob/master/CODE_OF_CONDUCT.md>`_
        before contributing to help this project stay welcoming.
        
        
        Building locally
        ================
        
        To build this library locally you'll need to install the
        `circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
        
        .. code-block:: shell
        
            python3 -m venv .env
            source .env/bin/activate
            pip install circuitpython-build-tools
        
        Once installed, make sure you are in the virtual environment:
        
        .. code-block:: shell
        
            source .env/bin/activate
        
        Then run the build:
        
        .. code-block:: shell
        
            circuitpython-build-bundles --filename_prefix adafruit-circuitpython-bno055 --library_location .
        
        Sphinx documentation
        -----------------------
        
        Sphinx is used to build the documentation based on rST files and comments in the code. First,
        install dependencies (feel free to reuse the virtual environment from above):
        
        .. code-block:: shell
        
            python3 -m venv .env
            source .env/bin/activate
            pip install Sphinx sphinx-rtd-theme
        
        Now, once you have the virtual environment activated:
        
        .. code-block:: shell
        
            cd docs
            sphinx-build -E -W -b html . _build/html
        
        This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
        view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
        locally verify it will pass.
Keywords: adafruit 9-dof absolute orientation accelerometer velocity temperature gravitymagnetic breakout hardware micropython circuitpython
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: System :: Hardware
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Description-Content-Type: text/x-rst
