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

File metadata

File hashes

Hashes for adafruit-circuitpython-lsm303dlh-mag-1.1.18.tar.gz
Algorithm Hash digest
SHA256 c6863e93a23d075d57bb3c9fdd91fa4d2f5d871937a3523f29c6a8c26205a73d
MD5 ba2e264f7a1c5dca4ab4a239d6293bd1
BLAKE2b-256 96f48166a15e866cda36b63c4906f920eb307542b9fa2e2dcf7a0055e85e12d7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_lsm303dlh_mag-1.1.18-py3-none-any.whl
Algorithm Hash digest
SHA256 779c3e9d532551d13dc29458b72b1fe245894d398a38dffaa80dd68ed3bb7302
MD5 49cb5bc494c9696b7ca7f27edfcc955a
BLAKE2b-256 fab9ce1b1d5c13fd836cc39c3a0ad9025c6409e1830dfc2be9444052a854c785

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