Package: explorepy
.. image:: logo.png
:scale: 100 %
:align: center=========================explorepyoverviewexplorepyis an open-source Python API designed to collect and process ExG data using Mentalab's Explore device. Amongst other things,explorepyprovides 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 installationFor Windows users, the best way to installexplorepyis to download the latestexplorepyversion from therelease 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.RequirementsPython 3.7 to Python 3.12.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 theinstallation page <https://explorepy.readthedocs.io/en/latest/installation.html>_.To installexplorepyfrom PyPI run:
::pip install explorepyTo install the latest development version (git must be installed before running this command):
::pip install git+https://github.com/Mentalab-hub/explorepyGet startedCLI commandTo checkexplorepyis running use:
::
explorepy acquire -n Explore_XXXXFor help, use:
::
explorepy -hPython codeIn 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 nameDocumentationFor full API documentation, visit:https://explorepy.readthedocs.io/.TroubleshootingIf you are having problems, please check thetroubleshooting <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 tocontact@mentalab.com. The log file is usually found under:Windows:<Windows Drive>:\Users\<USER_NAME>\AppData\Local\mentalab\explorepy\Logs\explorepy.logUbuntu:/home/<USER_NAME>/.cache/explorepy/log/explorepy.logMac OS:/Users/<USER_NAME>/Library/Logs/explorepy/explorepy.logYou can also create a new issue in the GitHub repository.AuthorsMohamad Atayi_Salman Rahman_Andrea Escartin_Sonja Stefani_Alex Platt_Andreas Gutsche_Masooma Fazelian_Philipp Jakovleski_Florian Sesser_Sebastian Herberger_.. _Mohamad Atayi:https://github.com/bmeatayi.. _Salman Rahman:https://github.com/salman2135.. _Andrea Escartin:https://github.com/andrea-escartin.. _Sonja Stefani:https://github.com/SonjaSt.. _Alex Platt:https://github.com/Nujanauss.. _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/SHerbergerLicenseThis project is licensed under theMIT <https://github.com/Mentalab-hub/explorepy/blob/master/LICENSE>_ license. You can reach us atcontact@mentalab.com.Changelog2.0.0 (5.1.2024)Add Mac OSX supportRemove browser based visualization supportUpdate build script for docs1.8.2 (28.8.2023)Improve explore mock deviceAdd yaml file for RTD build1.8.1 (11.7.2023)Bugfix record dataAdd dummy packets for CI/CD pipelineAdd mock device1.8.0 (27.2.2023)Add support for explore+ 16 ch deviceUnit test integration with CI/CDRepair CSV from binary dataSave current device settings on disconnection, restore them on demandReceive external triggers from LSL1.7.0 (21.12.2022)Add suppport for new explore+ 32 ch deviceSorted timestamps in CSVSettings file to preserve experiment settings1.6.3 (25.10.2022)Add new 8 channel Explore+ device1.6.2 (7.09.2022)Change EDF file extensionAdd dataset export feature for EEGLabBugfix recording1.6.1 (14.06.2022)Improve EDF file timing with PyEDFlibFix Bokeh import errorAdd custom analysis script for 4 channel P300 experiment1.6.0 (23.11.2021)Remove dependency on PybluezAdd SSVEP offline experimentAdd P300 exampleUpdate LSL stream namesFixing some bugs1.5.2 (22.09.2021)Hotfix for impedance disable bug1.5.1 (21.7.2021)Hotfix for installation bug1.5.0 (20.7.2021)Push to LSL button in the GUISearch free port for initialization of the dashboardUpdate installation procedure for WindowsFixing some minor bugs1.4.0 (31.03.2021)Baseline correction feature in the visualizationError logging system (Logging and Sentry)Fix a bug of SDK in MacOSChange the default Bluetooth interface to SDKImproved FFT visualizationMore precise local time in all OSes1.3.0 (30-12-2020)GUI resizing for different screen resolutionsAdded event button to dashboardImprovement of impedance measurementFixed minor bugs1.2.0 (25-11-2020)Standalone installer for Windows OSFix bugs in ExploreSDKCreate new file on device settings change1.1.0 (27-08-2020)MacOS supportFix bugsAdd module disable/enable featureEnhanced user interfaceAdd unique lsl stream names1.0.0 (22-05-2020)Add ExploreSDK as the Bluetooth interfaceNew dark themeRecord module in dashboardImprovement in visualization perfrmanceCLI migration to Click0.6.0 (17-02-2020)EDF (BDF+) file writerChannel disable/enable featureCalibration of movement sensorsExtraction of physical orientation (angle and rotation)Soft marker eventVisualization performance enhancementAutomatic number of channel and sampling rate detectionException handling improvementCommand for soft reset of ExploreMarker visualization0.5.0 (25-11-2019)Impedance measurementSend commands to deviceConfiguring device settingsUpdate push to lsl feature0.4.0 (09-09-2019)Added marker featureTimer based recordingFixed a bug in csv file writerFixed a bug in device reconnectImproved performance of dashboard visualization0.3.1 (28-05-2019)Fixed a bug in 8-channel ExG packet conversionFixed a minor bug in the record functionUpdated the documentation0.3.0 (10-05-2019)Explore dashboardReal-time visualization of ExG and orientation signalDevice information in DashboardEnvironmental data (battery, temperature and light)Real-time bandpass filterNew packet structures (ADS1294R & ADS1298R)Heart rate estimation and R-peaks detector in dashboard0.2.0 (2019-03-08)Added real-time recording featureAdded Command Line InterfaceAdded lsl integrationAdded new packet classesFixed reconnect issuesRemoved input requests inside functions0.1.0 (2019-01-18)First release on PyPI.