Skip to main content

CircuitPython library for LSM303DLH's 3-axis magnetometer.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

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

adafruit_circuitpython_lsm303dlh_mag-1.1.25.tar.gz (24.1 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit_circuitpython_lsm303dlh_mag-1.1.25.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_lsm303dlh_mag-1.1.25.tar.gz
Algorithm Hash digest
SHA256 f9ba30166f9ed361ac070ec6b33484d58f86d5f2570712d308d74c9a2f4e3b3f
MD5 cf2dca035580c89065e55e6fad39c4a9
BLAKE2b-256 4ccc8763e26a005320966535a10de9184880f240cf00dcec4871732c54822993

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_lsm303dlh_mag-1.1.25-py3-none-any.whl
Algorithm Hash digest
SHA256 826e0eb46c55c7245bc18587635eeafb368932fcf475ad4ce3defdc83061b2cc
MD5 69ae1edd4eeb547c32b25f5bbfc0af6d
BLAKE2b-256 46cbad55bbea7ae6d6209877e3dec3ffa4aa17d4997cca3359dfa7a20e512bcb

See more details on using hashes here.

Supported by

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