Skip to main content

CircuitPython helper library for the LIS3MDL 3-axis magnetometer

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

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

Uploaded Source

Built Distribution

File details

Details for the file adafruit-circuitpython-lis3mdl-1.1.20.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-lis3mdl-1.1.20.tar.gz
Algorithm Hash digest
SHA256 e6c2019d67493a54e5fb1776cbfa65998abefab2adb3291d219162509e0c3833
MD5 d7bff81678caedbcae273748e4d70f32
BLAKE2b-256 03813f52f4b74de7dd48db465baab1ef3ec1f89b81c5f6db0aed0d9deb25f943

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_lis3mdl-1.1.20-py3-none-any.whl
Algorithm Hash digest
SHA256 682d70d1b43398cd9a5e9591c52962720b90bba6cb71b02ff4c88e55401fad5a
MD5 0a52bab9339564f240313a430fb54e01
BLAKE2b-256 9055ca3cb29271705cee74d28923944694da75b5f25cb15a240b6e3d7e262067

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