Skip to main content

CircuitPython library for LIS2MDL 3-axis magnetometer.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

Adafruit CircuitPython module for the LIS2MDL 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-lis2mdl

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

sudo pip3 install adafruit-circuitpython-lis2mdl

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-lis2mdl

Usage Example

import time
import board
import adafruit_lis2mdl

i2c = board.I2C()  # uses board.SCL and board.SDA
sensor = adafruit_lis2mdl.LIS2MDL(i2c)

while True:
    mag_x, mag_y, mag_z = sensor.magnetic
    print('Magnetometer (uT): ({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_lis2mdl-2.1.23.tar.gz (28.8 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit_circuitpython_lis2mdl-2.1.23.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_lis2mdl-2.1.23.tar.gz
Algorithm Hash digest
SHA256 60e88e6ca6093c6e32843256386aeb5a06ffadbdead7ff6bc8985f7274c7083c
MD5 e8f6a33e2976701cfe0cf78a9ac6ce09
BLAKE2b-256 932effa256bafb334a951b2118e6e02de5a788882a2570c721436290562ba93b

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_lis2mdl-2.1.23-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_lis2mdl-2.1.23-py3-none-any.whl
Algorithm Hash digest
SHA256 130be51d808687fe963302bdec9229bcf64c903023548f8112c2604fc25c4a0d
MD5 bce70646c52a686cb34392977798fab3
BLAKE2b-256 6cb0f771de054f7991e1bab13125ae07ed588def5f2e0f0fefc0b603867d26be

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