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 (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-lis2mdl-2.1.16.tar.gz (30.2 kB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-lis2mdl-2.1.16.tar.gz
Algorithm Hash digest
SHA256 b47e3fb3f677b8edf1405100dd4e16be43d1dfc9623e4abbf5bc1449c6a899e1
MD5 cf58ba7f12ba384a79a4c8010f2339b0
BLAKE2b-256 d7c811d6a380e604ad736f58e9249c0f159fe11c11e2c4e4b8997fb6841e431e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_lis2mdl-2.1.16-py3-none-any.whl
Algorithm Hash digest
SHA256 476c049d50b88834762d9a7b60e7cfbdc9f7c8008f6f37d8e1e8720141475408
MD5 6619ee04f33bc33310a7fe67eb79084d
BLAKE2b-256 e81c07cb299dfdbb9d2f2be9dacf7758599593cc7d60cf51f4d8e7a005bfcf32

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