Skip to main content

CircuitPython library for LSM303DLH's 3-axis magnetometer.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

Adafruit CircuitPython module for the LSM303DLH’s 3-axis magnetometer

Note that this is specifically intended for the LSM303DLHC, as opposed to the LSM303DLH proper, which has the magnetic Y and Z orientations swapped.

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.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-lsm303dlh_mag

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

sudo pip3 install adafruit-circuitpython-lsm303dlh_mag

To install in a virtual environment in your current project:

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

Usage Example

import time
import board
import adafruit_lsm303dlh_mag

i2c = board.I2C()  # uses board.SCL and board.SDA
sensor = adafruit_lsm303dlh_mag.LSM303DLH_Mag(i2c)

while True:
    mag_x, mag_y, mag_z = sensor.magnetic

    print('Magnetometer (gauss): ({0:10.3f}, {1:10.3f}, {2:10.3f})'.format(mag_x, mag_y, mag_z))
    print('')
    time.sleep(1.0)

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

File details

Details for the file adafruit-circuitpython-lsm303dlh-mag-1.1.17.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-lsm303dlh-mag-1.1.17.tar.gz
Algorithm Hash digest
SHA256 e9c31114090d7335c70043197ae3436b00b307a9cb9b74cd67bad1d56cbd03d3
MD5 d0b5658c3900810be129c04d23547036
BLAKE2b-256 7ac5c9fdd1b15aee4d8f99795803274ad52ce2ff23035124b2f2756c0bf865dc

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_lsm303dlh_mag-1.1.17-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_lsm303dlh_mag-1.1.17-py3-none-any.whl
Algorithm Hash digest
SHA256 86100f55404848a2d82fe72552a2af6e9fd97cbc9fd17c729062fcea42a400b2
MD5 33b5916a27d47d19a212273fbceae3a8
BLAKE2b-256 706b3eb399518fa1460cb4d09439eeaa7c7d984ddb28e365325ef3b810e3fb29

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page