bmm150 0.2.2

A pure python API for the bmm150 magnetic sensor

BMM150

A pure python API for the bmm150 magnetic sensor.

Note : Most code logic comes from one of the following repos : Seed-Studio/Grove_3_Axis_Compass_V2.0_BMM150 or BoschSensortec/BMM150-Sensor-API . This is mostly a transpilation and a python packaging of this code.

Installation

The easiest way to install this library is using pip:

pip install bmm150

Documentation

The documentation is built using sphinx and the readthedocs theme. You can find it on the readthedocs official website.

Usage

The following code initializes the sensor, and prints the magnetic field values for x, y and z. Then, using the atan2 function from the math standard library, it retrieves the heading of the sensor.

import bmm150
import math

device = bmm150.BMM150()  # Bus number will default to 1

x, y, z = device.read_mag_data()

heading_rads = math.atan2(x, y)

heading_degrees = math.degrees(heading_rads)

print(f"X : {x:.2f}µT")
print(f"Y : {y:.2f}µT")
print(f"Z : {z:.2f}µT")

print(f"Heading: {heading_degs:.2f}°")

Development

This library uses poetry as a development tool.

You can start development by running :

poetry install

Testing

You can test this library using :

poetry run pytest

Tox

You can test multiple python versions using tox :

poetry run tox