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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-lis2mdl-2.1.19.tar.gz
Algorithm Hash digest
SHA256 4a57357bb6904de5fd1233532c23e7d103b16b9a8fd0b5c91230956ae75cfcef
MD5 b8af685a933479ad3b8a86b621d0ab36
BLAKE2b-256 48670fed64327e8180c7386a08ffd1045919c76eb3d69fd4c54d307547f29fff

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_lis2mdl-2.1.19-py3-none-any.whl
Algorithm Hash digest
SHA256 e1e01c2295969f6b621ed26b040e34d1c1132b7f02df289117b2b023b2e1a70e
MD5 b6ca526e717e2094c09d0652c25dc565
BLAKE2b-256 80f21d74eca1f484f8c872f0040df24520443a4995882f04e4aba8d5eab7b8b5

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