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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-lis3mdl-1.1.27.tar.gz
Algorithm Hash digest
SHA256 4df0033166d914dd798230f4bea419302d68e195fb1dbfc8905d48a47fc62527
MD5 307415405d684580055fb6421a3d504e
BLAKE2b-256 ed1202f5d21d803789da7e77acb5d1f6f64aea4230488b5e0d95c2f7f7042be9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_lis3mdl-1.1.27-py3-none-any.whl
Algorithm Hash digest
SHA256 56e20728597659a0df00b2f4093efd9a1fd8dcebdb5167da57172a2bfc57487b
MD5 18e4cae7e2d21534a3e9a85f719eef0f
BLAKE2b-256 04612563cc5a2b247179baa92ff5c68d30dfccabb952f871f48cb708dc56c46d

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