tannewt / adafruit_circuitpython_l3gd20

Adafruit 3 Axis Gyroscope - L3GD20

Introduction

Adafruit 9-DOF Absolute Orientation IMU Fusion Breakout - L3GD20 Driver

Dependencies

This driver depends on:

• Adafruit CircuitPython
• Register

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Usage Example

Of course, you must import the library to use it:

import adafruit_l3gd20

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:

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:

sensor = adafruit_l3gd20.L3GD20_I2C(i2c)

And then you can start reading the measurements:

print(sensor.gyro)

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Building locally

Zip release files

To build this library locally you'll need to install the circuitpython-build-tools package.

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-l3gd20 --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):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

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.