circuitpython-rm3100 1.0.1

Driver for the RM3100 megnetometer by PNI Corp

Introduction

Driver for the RM3100 magnetometer by PNI Sensor Corporation

Dependencies

This driver depends on:

• Adafruit CircuitPython

• Bus Device

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

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 circuitpython-rm3100

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

sudo pip3 install circuitpython-rm3100

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install circuitpython-rm3100

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install rm3100

Or the following command to update an existing version:

circup update

Usage Examples

# Example using I2C and single measurement readings, no DRDY pin

import time
import board
import rm3100

i2c = board.I2C()
rm = rm3100.RM3100_I2C(i2c, i2c_address=0x23)

while True:
    rm.start_single_reading()
    time.sleep(rm.get_measurement_time())
    print(rm.get_next_reading())

# Example using SPI and a DRDY pin, using continuous readings

import board
import digitalio
import rm3100

spi = board.SPI()
drdy_pin = digitalio.DigitalInOut(board.D3)
drdy_pin.direction = digitalio.Direction.INPUT

cs_pin = digitalio.DigitalInOut(board.D4)
cs_pin.direction = digitalio.Direction.OUTPUT
cs_pin.value = True
rm = rm3100.RM3100_SPI(spi, chip_select=cs_pin, drdy_pin=drdy_pin)


rm.start_continuous_reading(1.2)  # start continuous reading at 1.2Hz
for i in range(20):
    print(rm.get_next_reading())
rm.stop()

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.