Skip to content

improving_docs #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 13, 2021
Merged

improving_docs #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f09e5e3
improving_docs
jposada202020 Apr 27, 2021
541788a
improving_docs
jposada202020 May 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 36 additions & 3 deletions adafruit_bno08x_rvc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,14 @@

**Hardware:**

* `Adafruit BNO08x Breakout <https:www.adafruit.com/products/4754>`_
* `Adafruit 9-DOF Orientation IMU Fusion Breakout - BNO085 (BNO080)
<https://www.adafruit.com/product/4754>`_ (Product ID: 4754)


**Software and Dependencies:**

* Adafruit CircuitPython firmware for the supported boards:
https://github.com/adafruit/circuitpython/releases
https://circuitpython.org/downloads

"""
import time
Expand All @@ -33,7 +35,38 @@ class RVCReadTimeoutError(Exception):


class BNO08x_RVC:
"""A simple class for reading heading from the BNO08x IMUs using the UART-RVC mode"""
"""A simple class for reading heading from the BNO08x IMUs using the UART-RVC mode

:param uart: The UART device the BNO08x_RVC is connected to.
:param float timeout: time to wait for readings. Defaults to :const:`1.0`


**Quickstart: Importing and using the device**

Here is an example of using the :class:`BNO08X_UART` class.
First you will need to import the libraries to use the sensor

.. code-block:: python

import board
import busio
from adafruit_bno08x_rvc import BNO08x_RVC

Once this is done you can define your `busio.UART` object and define your sensor object

.. code-block:: python

uart = busio.UART(board.TX, board.RX, baudrate=3000000, receiver_buffer_size=2048)
rvc = BNO08X_UART(uart)


Now you have access to the :attr:`heading` attribute

.. code-block:: python

yaw, pitch, roll, x_accel, y_accel, z_accel = rvc.heading

"""

def __init__(self, uart, timeout=1.0):
self._uart = uart
Expand Down
1 change: 1 addition & 0 deletions docs/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@

.. automodule:: adafruit_bno08x_rvc
:members:
:exclude-members: RVCReadTimeoutError
4 changes: 4 additions & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,13 @@ Table of Contents
.. toctree::
:caption: Tutorials

Adafruit 9-DOF Orientation IMU Fusion Breakout - BNO085 (BNO080) Learning Guide <https://learn.adafruit.com/adafruit-9-dof-orientation-imu-fusion-breakout-bno085/>

.. toctree::
:caption: Related Products

Adafruit 9-DOF Orientation IMU Fusion Breakout - BNO085 (BNO080) <https://www.adafruit.com/product/4754>

.. toctree::
:caption: Other Links

Expand Down