Skip to main content

Introduction

Documentation Status Discord Build Status Code Style: Ruff

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.

Release files for adafruit-circuitpython-lis3mdl 1.2.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for adafruit-circuitpython-lis3mdl 1.2.8
File Size Uploaded
adafruit_circuitpython_lis3mdl-1.2.8.tar.gz 26.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for adafruit-circuitpython-lis3mdl 1.2.8
File Interpreter ABI Platform
adafruit_circuitpython_lis3mdl-1.2.8-py3-none-any.whl Python 3 none any Details

Total release size: 33.6 kB

Release files / adafruit_circuitpython_lis3mdl-1.2.8.tar.gz

Download URL adafruit_circuitpython_lis3mdl-1.2.8.tar.gz
Size 26.7 kB
Tags Source
SHA-256 checksum
How to use checksums
e4ba8dbf93c0763279090584d36b80361e95ee92ea97c473ade8282c2e81bb94
BLAKE2b-256 checksum
How to use checksums
b43ceb1bcaa675277cb55d9395195eba7e8836cd74a7dd5721ad59c49650d03a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.15

Release files / adafruit_circuitpython_lis3mdl-1.2.8-py3-none-any.whl

Download URL adafruit_circuitpython_lis3mdl-1.2.8-py3-none-any.whl
Size 6.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
26652b0871392cddb74626834f2c35c4d62dbe1f3ad55d6de915433c376a2f01
BLAKE2b-256 checksum
How to use checksums
f597412b4f2d1f091a817a26ae0d292c337accd4266fb36c93498111a0df4e44
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.15

Release history Release notifications | RSS feed

This release

1.2.8 This release

2 release files

1.2.7

2 release files

1.2.6

2 release files

1.2.5

2 release files

1.2.4

2 release files

1.2.3

2 release files

1.2.2

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.25

2 release files

1.1.24

2 release files

1.1.23

2 release files

1.1.22

2 release files

1.1.20

2 release files

1.1.19

2 release files

1.1.17

1 release file

1.1.16

1 release file

1.1.15

1 release file

1.1.14

1 release file

1.1.13

1 release file

1.1.12

1 release file

1.1.11

1 release file

1.1.10

1 release file

1.1.9

1 release file

1.1.8

1 release file

1.1.7

1 release file

1.1.6

1 release file

1.1.5

1 release file

1.1.4

1 release file

1.1.3

1 release file

1.1.2

1 release file

1.1.1

1 release file

1.1.0

1 release file

1.0.3

1 release file

1.0.2

1 release file

1.0.1

1 release file

1.0.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page