Skip to main content

CircuitPython library for LIS2MDL 3-axis magnetometer.

Project description

Introduction

Documentation Status Discord Build Status

Adafruit CircuitPython module for the LIS2MDL 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-lis2mdl

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-lis2mdl

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-lis2mdl

Usage Example

import time
import board
import busio
import adafruit_lis2mdl

i2c = busio.I2C(board.SCL, board.SDA)
sensor = adafruit_lis2mdl.LIS2MDL(i2c)

while True:
    mag_x, mag_y, mag_z = sensor.magnetic

    print('Magnetometer (gauss): ({0:10.3f}, {1:10.3f}, {2:10.3f})'.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.

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-lis2mdl-2.1.6.tar.gz (28.6 kB view details)

Uploaded Source

File details

Details for the file adafruit-circuitpython-lis2mdl-2.1.6.tar.gz.

File metadata

  • Download URL: adafruit-circuitpython-lis2mdl-2.1.6.tar.gz
  • Upload date:
  • Size: 28.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1

File hashes

Hashes for adafruit-circuitpython-lis2mdl-2.1.6.tar.gz
Algorithm Hash digest
SHA256 5d67a5f03f1345175eb17db6967d8c7df2a6a50eaddfb007fe20fc19c31895ef
MD5 aaa1da4c5bdfa8ddf429de2c5d14af3c
BLAKE2b-256 071164be0f51b3f93ae4ad967bfc66f1d86ac591005ae9bb29cf73f95ca8e779

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