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.18.tar.gz (30.4 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit-circuitpython-lis2mdl-2.1.18.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-lis2mdl-2.1.18.tar.gz
Algorithm Hash digest
SHA256 d442fcaeda59d5383fae83774ec8cd40b095fc5a1d8c44f295d4ca6ffad80337
MD5 401a7dd46c63841d85476f65bbd562b4
BLAKE2b-256 307d1b7a75c55d8567f14a7ae742288ccaa3551f22146be857d123c3b6ddfe23

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_lis2mdl-2.1.18-py3-none-any.whl
Algorithm Hash digest
SHA256 2f10a8900c7204b8d7f78fd41aefae0c5ca98cd0dab9cd09ff54822ff2f929c9
MD5 2307e33e76d3519623f3588549977313
BLAKE2b-256 32d2dfc4e6186a5819887cc95ecdd39e455fed12e27535c4691c3504fa5c5ad7

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