Skip to content
CircuitPython driver for the LSM303 accelerometer/magnetometer.
Branch: master
Clone or download
makermelissa Merge pull request #12 from dherrada/master
Added module name to beginning of example filenames & updated docs to match
Latest commit 63ef37e May 11, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Updated docs to reflect this May 10, 2019
examples
.gitignore PyPi setup. Aug 5, 2018
.pylintrc ignore the board module imports in .pylintrc Aug 25, 2018
.readthedocs.yml updated .travis & .readthedocs.yml Mar 15, 2018
.travis.yml Made travis stop searching for folders in the examples folder May 11, 2019
CODE_OF_CONDUCT.md updated CoC Aug 1, 2018
LICENSE Initial version Dec 28, 2017
README.rst change 'travis-ci.org' to 'travis-ci.com' Dec 21, 2018
adafruit_lsm303.py
requirements.txt PyPi setup. Aug 5, 2018
setup.py

README.rst

Introduction

Documentation Status Discord Build Status

Adafruit CircuitPython module for the LSM303 6-DoF with 3-axis accelerometer and magnetometer

Dependencies

This driver depends on:

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

Usage Example

import time
import board
import busio

import adafruit_lsm303

i2c = busio.I2C(board.SCL, board.SDA)
sensor = adafruit_lsm303.LSM303(i2c)

while True:
        raw_accel_x, raw_accel_y, raw_accel_z = sensor.raw_acceleration
        accel_x, accel_y, accel_z = sensor.acceleration
        raw_mag_x, raw_mag_y, raw_mag_z = sensor.raw_magnetic
        mag_x, mag_y, mag_z = sensor.magnetic

        print('Acceleration raw: ({0:6d}, {1:6d}, {2:6d}), (m/s^2): ({3:10.3f}, {4:10.3f}, {5:10.3f})'.format(raw_accel_x, raw_accel_y, raw_accel_z, accel_x, accel_y, accel_z))
        print('Magnetometer raw: ({0:6d}, {1:6d}, {2:6d}), (gauss): ({3:10.3f}, {4:10.3f}, {5:10.3f})'.format(raw_mag_x, raw_mag_y, raw_mag_z, mag_x, mag_y, mag_z))
        print('')
        time.sleep(1.0)

Contributing

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

Building locally

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-lsm303 --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.

You can’t perform that action at this time.