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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-lis3mdl-1.1.24.tar.gz
Algorithm Hash digest
SHA256 d57463bd92d8be0fdad6172ef12694a8fb4bba5d3ed0282d39236a5cdbcc3e79
MD5 8f9e6c1fb8ebe6435b280bf5494cef27
BLAKE2b-256 9ce6cd60e0028dbbb81e7225c583482fb53fed09c1a6c5c1601d380e02d9c3c2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_lis3mdl-1.1.24-py3-none-any.whl
Algorithm Hash digest
SHA256 86ce38c5cde89beab3729755053757c1402d550894d0ff9013cf14d266a8f412
MD5 f003ab0350e1cbacbd7d780954c55289
BLAKE2b-256 3e8d490c132a60f1b256c227ae6d5ec4831bd43d686de927224cc8c1cf215857

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