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

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

File metadata

File hashes

Hashes for adafruit-circuitpython-lsm303dlh-mag-1.1.14.tar.gz
Algorithm Hash digest
SHA256 41d9e9dbcaef7b5180b13d6ae05b85f2b5f659599def54f84cc7e536df5892bd
MD5 b617d0b829ffa978c574abd77f9c8d39
BLAKE2b-256 82950aeeeb13a231d7982dba6b93a44ff86acd68de75c11a109eef4c87e76dcd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_lsm303dlh_mag-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 293fdcc324099a539db44cf3b2cd67a5267ec610daf5d276b6cdd8e606ce3019
MD5 4ec1f9b35f8e4126fa8e2cd8a7870c25
BLAKE2b-256 35d0dcfa0a961284e1f4af7a5d2b43616e5daca260a472b8865d00d41d8dc8c6

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