adafruit-circuitpython-lis3mdl

CircuitPython helper library for the LIS3MDL 3-axis magnetometer


Keywords
adafruit, blinka, circuitpython, micropython, lis3mdl, magnetometer, LSM6DS33, IMU
License
MIT
Install
pip install adafruit-circuitpython-lis3mdl==1.1.10

Documentation

Introduction

Documentation Status Discord Build Status

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 .env
source .env/bin/activate
pip3 install adafruit-circuitpython-lis3mdl

Usage Example

import time
import board
import busio
import adafruit_lis3mdl

i2c = busio.I2C(board.SCL, 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)

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Documentation

For information on building library documentation, please check out this guide.