Python API for Mentalab biosignal aquisition devices
Project description
.. image:: logo.png :scale: 100 % :align: center
=========================
explorepy
overview
explorepy
is an open-source Python API designed to collect and process ExG data using Mentalab's Explore device. Amongst other things, explorepy
provides the following features:
- Real-time streaming of ExG, orientation and environmental data.
- Real-time visualization of ExG, orientation and environmental data.
- Data recording in CSV and BDF+ formats.
- Integration with LabStreaming Layer.
- Electrode impedance measurements.
- Explore device configuration.
Quick installation
For Windows users, the best way to install explorepy
is to download the latest explorepy
version from the release page <https://github.com/Mentalab-hub/explorepy/releases>
_. Please note that dependencies will install automatically from the release page.
For other operating systems, or to build the package manually on Windows, please refer to the information below.
Requirements
- Python 3.6 to Python 3.9.
- Visual Studio 2015 community edition (Windows only. For package building).
- Bluetooth header files (Linux only. Use:
sudo apt-get install libbluetooth-dev
).
Detailed installation instructions can be found on the installation page <https://explorepy.readthedocs.io/en/latest/installation.html>
_.
To install explorepy
from PyPI run:
::
pip install explorepy
To install the latest development version (git must be installed before running this command): ::
pip install git+https://github.com/Mentalab-hub/explorepy
Get started
CLI command
To check explorepy
is running use:
::
explorepy acquire -n Explore_XXXX
For help, use: :: explorepy -h
Python code
In Python you can connect to the Explore device and print data using:
::
import explorepy
explorer = explorepy.Explore()
explorer.connect(device_name="Explore_XXXX") # Put your device Bluetooth name
explorer.acquire()
You can also visualize the data in real-time.
::
import explorepy
explorer = explorepy.Explore()
explorer.connect(device_name="Explore_XXXX") # Put your device Bluetooth name
explorer.visualize(bp_freq=(.5, 30), notch_freq=50)
EEG:
.. image:: /images/Dashboard_EEG.jpg :width: 800 :alt: EEG Dashboard
ECG with heart beat detection:
.. image:: /images/Dashboard_ECG.jpg :width: 800 :alt: ECG Dashboard
Documentation
For full API documentation, visit: https://explorepy.readthedocs.io/.
Troubleshooting
If you are having problems, please check the troubleshooting <https://explorepy.readthedocs.io/en/latest/installation.html#troubleshooting>
_
section of the documentation.
If you are still having problems, send us your error log via Sentry (note: Explorepy will send the log automatically once you have provided permission), or send us the log file via email to contact@mentalab.com. The log file is usually found under:
- Windows:
<Windows Drive>:\Users\<USER_NAME>\AppData\Local\mentalab\explorepy\Logs\explorepy.log
- Ubuntu:
/home/<USER_NAME>/.cache/explorepy/log/explorepy.log
- Mac OS:
/Users/<USER_NAME>/Library/Logs/explorepy/explorepy.log
You can also create a new issue in the GitHub repository.
Authors
Mohamad Atayi
_Salman Rahman
_Andreas Gutsche
_Masooma Fazelian
_Philipp Jakovleski
_Florian Sesser
_Sebastian Herberger
_
.. _Mohamad Atayi: https://github.com/bmeatayi .. _Salman Rahman: https://github.com/salman2135 .. _Andreas Gutsche: https://github.com/andyman410 .. _Masooma Fazelian: https://github.com/fazelian .. _Philipp Jakovleski: https://github.com/philippjak .. _Florian Sesser : https://github.com/hacklschorsch .. _Sebastian Herberger: https://github.com/SHerberger
License
This project is licensed under the MIT <https://github.com/Mentalab-hub/explorepy/blob/master/LICENSE>
_ license. You can reach us at contact@mentalab.com.
Changelog
1.6.2 (7.09.2022)
- Change EDF file extension
- Add dataset export feature for EEGLab
- Bugfix recording
1.6.1 (14.06.2022)
- Improve EDF file timing with PyEDFlib
- Fix Bokeh import error
- Add custom analysis script for 4 channel P300 experiment
1.6.0 (23.11.2021)
- Remove dependency on Pybluez
- Add SSVEP offline experiment
- Add P300 example
- Update LSL stream names
- Fixing some bugs
1.5.2 (22.09.2021)
- Hotfix for impedance disable bug
1.5.1 (21.7.2021)
- Hotfix for installation bug
1.5.0 (20.7.2021)
- Push to LSL button in the GUI
- Search free port for initialization of the dashboard
- Update installation procedure for Windows
- Fixing some minor bugs
1.4.0 (31.03.2021)
- Baseline correction feature in the visualization
- Error logging system (Logging and Sentry)
- Fix a bug of SDK in MacOS
- Change the default Bluetooth interface to SDK
- Improved FFT visualization
- More precise local time in all OSes
1.3.0 (30-12-2020)
- GUI resizing for different screen resolutions
- Added event button to dashboard
- Improvement of impedance measurement
- Fixed minor bugs
1.2.0 (25-11-2020)
- Standalone installer for Windows OS
- Fix bugs in ExploreSDK
- Create new file on device settings change
1.1.0 (27-08-2020)
- MacOS support
- Fix bugs
- Add module disable/enable feature
- Enhanced user interface
- Add unique lsl stream names
1.0.0 (22-05-2020)
- Add ExploreSDK as the Bluetooth interface
- New dark theme
- Record module in dashboard
- Improvement in visualization perfrmance
- CLI migration to Click
0.6.0 (17-02-2020)
- EDF (BDF+) file writer
- Channel disable/enable feature
- Calibration of movement sensors
- Extraction of physical orientation (angle and rotation)
- Soft marker event
- Visualization performance enhancement
- Automatic number of channel and sampling rate detection
- Exception handling improvement
- Command for soft reset of Explore
- Marker visualization
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file explorepy-1.6.3.tar.gz
.
File metadata
- Download URL: explorepy-1.6.3.tar.gz
- Upload date:
- Size: 1.0 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.7.13
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | edf26e60d6aac5c8ce0bf9bd78363318b1811b7aef51b64dd8c4178c733ab6f6 |
|
MD5 | 6331ae742873e8f60549c3a1468ad029 |
|
BLAKE2b-256 | 6429a621c3cc3079bbf72e6fb97e1f62d256ad87f746beb4b3c26942c479d110 |
File details
Details for the file explorepy-1.6.3-cp37-cp37m-win_amd64.whl
.
File metadata
- Download URL: explorepy-1.6.3-cp37-cp37m-win_amd64.whl
- Upload date:
- Size: 125.9 kB
- Tags: CPython 3.7m, Windows x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.7.13
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4c98d5a38bf33d91fe3dcfa2ac375e2f690996e72718173a9602446d3c86cff5 |
|
MD5 | 319145efb31b875993c74a3dd4624abb |
|
BLAKE2b-256 | f2819292cfceb0b27493fae5acc18c0f7318bceca624615f44ad739fde6906fd |