Skip to content

CircuitPython helper library for using the Adafruit MLX90395 tri-Axis magnetometer breakout

License

Notifications You must be signed in to change notification settings

adafruit/Adafruit_CircuitPython_MLX90395

Repository files navigation

Introduction

Documentation Status Discord Build Status Code Style: Black

CircuitPython helper library for using the Adafruit MLX90395 tri-Axis magnetometer breakout

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

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

sudo pip3 install adafruit-circuitpython-mlx90395

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

Usage Example

from time import sleep
import board
import busio
from adafruit_mlx90395 import MLX90395, OSR

i2c = busio.I2C(board.SCL, board.SDA)
sensor = MLX90395(i2c)
while True:
    mag_x, mag_y, mag_z = sensor.magnetic

    print("X1:{0:10.2f}, Y:{1:10.2f}, Z:{2:10.2f} uT".format(mag_x, mag_y, mag_z))
    print("")

    sleep(0.5)

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.

About

CircuitPython helper library for using the Adafruit MLX90395 tri-Axis magnetometer breakout

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages