Skip to main content

Python API for Mentalab biosignal aquisition devices

Project description

logo.png

Explorepy overview

Explorepy is an open-source Python-based biosignal acquisition API for Mentalab’s Explore device. It provides users the following features:

  • Real-time streaming of ExG, orientation and environmental data

  • Real-time visualization

  • Data recording

  • LSL integration

  • Impedance measurement

  • Explore device configuration

Quick installation

Requirements

To install explorepy from PyPI run:

pip install explorepy

To install the latest development version run:

pip install git+https://github.com/Mentalab-hub/explorepy

For a more detailed installation guide please see Installation page

Get started

CLI command

explorepy acquire -n Explore_XXXX

Enter explorepy -h for help.

Python code

The following code connects to the Explore device and prints the data.

import explorepy
explorer = explorepy.Explore()
explorer.connect(device_name="Explore_XXXX")  # Put your device Bluetooth name
explorer.acquire()

You can also visualize signal in real-time.

import explorepy
explorer = explorepy.Explore()
explorer.connect(device_name="Explore_XXXX")  # Put your device Bluetooth name
explorer.visualize(n_chan=4, bp_freq=(1, 30), notch_freq=50)  # Give the number of channels, frequencies of bandpass and notch filter

EEG:

EEG Dashboard

ECG with heart beat detection:

ECG Dashboard

Documentation

To see full documentation of the API, visit: https://explorepy.readthedocs.io/

Authors

License

This project is licensed under the MIT license.

Changelog

0.5.0 (25-11-2019)

  • Impedance measurement

  • Send commands to device

  • Configuring device settings

  • Update push to lsl feature

0.4.0 (09-09-2019)

  • Added marker feature

  • Timer based recording

  • Fixed a bug in csv file writer

  • Fixed a bug in device reconnect

  • Improved performance of dashboard visualization

0.3.1 (28-05-2019)

  • Fixed a bug in 8-channel ExG packet conversion

  • Fixed a minor bug in the record function

  • Updated the documentation

0.3.0 (10-05-2019)

  • Explore dashboard

  • Real-time visualization of ExG and orientation signal

  • Device information in Dashboard

  • Environmental data (battery, temperature and light)

  • Real-time bandpass filter

  • New packet structures (ADS1294R & ADS1298R)

  • Heart rate estimation and R-peaks detector in dashboard

0.2.0 (2019-03-08)

  • Added real-time recording feature

  • Added Command Line Interface

  • Added lsl integration

  • Added new packet classes

  • Fixed reconnect issues

  • Removed input requests inside functions

0.1.0 (2019-01-18)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

explorepy-0.5.0.tar.gz (286.9 kB view hashes)

Uploaded Source

Built Distribution

explorepy-0.5.0-py2.py3-none-any.whl (16.7 MB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page