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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-lis3mdl-1.1.18.tar.gz
Algorithm Hash digest
SHA256 b065608a6e93c431dfc30328b9a274d45cd74a90a460fcb3e5afcc0d1aafeb4b
MD5 a59211a0b2a992c72102e61c3c3498cb
BLAKE2b-256 1c0a2a1a4da235003b8a6758d19f72f14dc365315b2670d5de195c0332ee8210

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_lis3mdl-1.1.18-py3-none-any.whl
Algorithm Hash digest
SHA256 1810b047e85c55f397081b5a25988d4ff259c82d6ef211e1269a154e1f1a9ece
MD5 32a546a35434f7527104ae49f107497d
BLAKE2b-256 8ca70d25e9157b4dbef29950889b74f4717a692486542de42239e3477ddf5720

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