CreaTe-M8-BME / CreaTeBME

Python Package for interfacing the bluetooth IMU module for CreaTe M8 BME.
GNU General Public License v3.0
0 stars 2 forks source link

CreaTeBME

Build PyPI

Python Package for interfacing the bluetooth IMU module for CreaTe M8 BME.

Installation

To install the latest stable version simply run this in your terminal. If you are using PyCharm then you can open the terminal on the bottom left of the screen.

pip install CreaTeBME

Example

A simple example to connect to a sensor and read and print the data indefinitely. The package automatically connects to the device, so you do not have to connect to it manually.

from CreaTeBME import SensorManager

# Create a sensor manager for the given sensor names using the given callback
manager = SensorManager(['0BE6'])

# Start the sensor manager
manager.start()

while True:
    measurements = manager.get_measurements()
    for sensor, data in measurements.items():
        if len(data) > 0:
            print(sensor, data)

# Stop the sensor manager
manager.stop()

Usage

SensorManager (asyncio wrapper)

This package uses Bleak for the bluetooth communication. Bleak uses asyncio, thus this package has to use this too. To ease usage, a wrapper has been made for people not experienced with asyncio. This wrapper also automates the connection of the sensors over bluetooth.

To connect to the sensors, simply initialize a SensorManager object with the sensor names.

from CreaTeBME import SensorManager

manager = SensorManager(['A1B2', 'C3D4'])

Then start reading data from the sensors by calling the start method of the SensorManager.

manager.start()

To get the IMU measurements the `get_measurements()' method can be used. This returns the measurements received since the last time this method was called.

measurements = manager.get_measurements()

The data returned by this method is a dictionary containing a list for each sensor with the received measurements. A single measurement is a list of 6 floats. The measurements are structured like this

Finally, make sure to also call the stop method when exiting your program.

manager.stop()

Manual Connection

⚠️Understanding of asyncio required⚠️

Another way of connecting IMU sensors is to manually create ImuSensor objects. This can be done by specifying the BLE device that should be connected as a sensor.

from CreaTeBME import ImuSensor

sensor = ImuSensor(device)

The device has to be a Bleak BLEDevice object that can be acquired using the discover method of BleakScanner.

from bleak import BleakScanner
from CreaTeBME import ImuSensor

async def connect():
    devices = await BleakScanner.discover(return_adv=True)
    sensor = ImuSensor(devices[0])

API reference

For the API reference look here