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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-lis2mdl-2.1.14.tar.gz
Algorithm Hash digest
SHA256 59d54fbfc489e72e774ecd51a3ccf13a5e62fcb8bd22bf4850bc3721b1570073
MD5 aedc8d77ed399cce969c70ce0218b537
BLAKE2b-256 ea3f767821bbc9cce66e4b7f94e354bbd540b8d631695f87e1465f2c36b57df9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_lis2mdl-2.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 7fc910d4353319a2ff8fc56a916c9406e14fb1f612ac93fc5c16678b72b28aab
MD5 394e55b1c9175115d113b1c0df0cae82
BLAKE2b-256 bdb4c50985d7c403229698c2e3bd2082668cc95390168b5a49bd4999687e21c2

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