Skip to main content

CircuitPython helper library for the LIS3MDL 3-axis magnetometer

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

CircuitPython helper library for the LIS3MDL 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-lis3mdl

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-lis3mdl

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-lis3mdl

Usage Example

import time
import board
import adafruit_lis3mdl

i2c = board.I2C()  # uses board.SCL and board.SDA
sensor = adafruit_lis3mdl.LIS3MDL(i2c)

while True:
    mag_x, mag_y, mag_z = sensor.magnetic

    print('X:{0:10.2f}, Y:{1:10.2f}, Z:{2:10.2f} uT'.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_lis3mdl-1.2.4.tar.gz (26.6 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit_circuitpython_lis3mdl-1.2.4.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_lis3mdl-1.2.4.tar.gz
Algorithm Hash digest
SHA256 90223dd71cc602acbf3b5c968fb20a05e10e39091773f51055efad378e972d86
MD5 1e6a9ca9a5cd0c9f6a0800343e34ccbe
BLAKE2b-256 17d4cf6a4b0bfb43e81a6783c594356b978042e4b5f3ec1e89997d86d7ad6388

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_lis3mdl-1.2.4-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_lis3mdl-1.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f1511272ae58b6e13fd4c77627a2a30ec17c4af63a37f0d3de29e89fa7313837
MD5 99fac87877298673ffe47c402b7c4edd
BLAKE2b-256 c5124fa2746b98fb258b4bd3689aa3fc4de5fd7e4fbe6445e3e90ae4bf512c54

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