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.21.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-lsm303dlh-mag-1.1.21.tar.gz
Algorithm Hash digest
SHA256 316c3093c8bf4cf491fe7b452c0bcd0a4e29d6e64063af548ecfb90a81668b06
MD5 ecd89ede09eb7d1e5b64b9b095c291ec
BLAKE2b-256 a26fe818152f3bbebd804dd89c55c1d3a8e8fe031b7c853e7ca997e5854df636

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_lsm303dlh_mag-1.1.21-py3-none-any.whl
Algorithm Hash digest
SHA256 482d7e0e2d1febe2fcf71a69275e855d5516c0c9bbf234d6719f3b85666faa16
MD5 787eada07bab07ff057959d2ea25c6cd
BLAKE2b-256 404383f14774e1d0ee4212103b684f2d2bebab5594ea246f17be6a53aae9e6f5

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