Skip to main content

CircuitPython library for LIS2MDL 3-axis magnetometer.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_lis2mdl-2.1.27.tar.gz
Algorithm Hash digest
SHA256 81f5a713dcb9ad05a1001e23b724cbb0dc55316707cd900674572015709eb487
MD5 71a31d6dc57cbc6fd9fd39e67782fdcc
BLAKE2b-256 7e84ff2325a6287ddf486b729759f9f8abae4956e3f668509579986fb8b48207

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_lis2mdl-2.1.27-py3-none-any.whl
Algorithm Hash digest
SHA256 4d0b251c9da92cd2dc4d1d95bfb30609c22e41d870009469fa9ef79735099d3a
MD5 7da6c2e1bf70c9f53a62d53e643428e0
BLAKE2b-256 9a6ff5bd38b6166889c389d22353de7c4dbb648b1a8066c82fef263ab9d3395c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page