# Description
Python3 library to read data from Neurosky Mindwave Mobile 2 on linux using
pybluez2.
**Contents:**
- [Requirements](#requirements)
- [Pre-execution](#pre-execution)
- [Execution](#execution)
- [Command line interface](#command-line-interface)
- [Graphical user interface](#graphical-user-interface)
- [Importing library](#importing-library)
- [Acknowledgements](#acknowledgements)
- [License](#license)
# Requirements
- libbluetooth-dev
# Pre-execution
You can install dependencies via setup.py
```bash
$ python -m pip install .
$ python -m pip install .[gui] # to install gui dependencies
```
via python package index (PyPI)
```bash
$ python -m pip install neuropy3
$ python -m pip install neuropy3[gui] # to install gui dependencies
```
or manually
```bash
$ python -m pip install -r requirements.txt
$ python -m pip install -r gui_requirements.txt # to install gui dependencies
```
# Execution
## Command line interface
```bash
$ python -m neuropy3
$ python -m neuropy3 --address XX:YY:ZZ:AA:BB:CC
$ python -m neuropy3 --help
```
> Address argument helps speed up connection process, otherwise a neuropy3
> will run a scan of nearby bluetooth devices (which takes a lot).
## Graphical user interface
```bash
$ python -m neuropy3 --gui
$ python -m neuropy3 --address XX:YY:ZZ:AA:BB:CC --gui
```
> Note: requires neuropy3[gui] extra dependencies
<details>
<summary>Screenshots</summary>
<div align="center">
<img alt="gui" src="images/gui.png" width="75%"/>
</div>
<div align="center">
<img alt="raw" src="images/raw.png" width="75%"/>
</div>
</details>
## Importing library
```python
>>> from neuropy3.neuropy3 import MindWave
>>> mw = MindWave(address='XX:YY:ZZ:AA:BB:CC', autostart=False, verbose=3)
>>> # mw = MindWave(autostart=False, verbose=3) # Autoscan for MindWave Mobile
>>> mw.set_callback('eeg', lambda x: print(x))
>>> mw.set_callback('meditation', lambda x: print(x))
>>> mw.set_callback('attention', lambda x: print(x))
>>> mw.start()
>>> mw.unset_callback('eeg')
>>> mw.stop()
```
# Acknowledgements
**This work has been supported by National R&D Project TEC2017-84197-C4-1-R and by the
Comunidad de Madrid project CYNAMON P2018/TCS-4566 and co-financed by European Structural
Funds (ESF and FEDER)**
- Based on [lihas/NeuroPy](https://github.com/lihas/NeuroPy) library.
- Communication protocol from [neurosky](http://developer.neurosky.com/docs/doku.php?id=thinkgear_communications_protocol).
# License
neuropy3 Copyright (C) 2022-2023 Sergio Chica Manjarrez @ pervasive.it.uc3m.es.
Universidad Carlos III de Madrid.
This program comes with ABSOLUTELY NO WARRANTY; for details check below.
This is free software, and you are welcome to redistribute it
under certain conditions; check below for details.
[LICENSE](LICENSE)
Raw data
{
"_id": null,
"home_page": "https://gitlab.gast.it.uc3m.es/schica/neuropy3",
"name": "neuropy3",
"maintainer": "",
"docs_url": null,
"requires_python": ">= 3.8",
"maintainer_email": "",
"keywords": "eeg,neurosky,mindwave,neurosky mindwave mobile 2",
"author": "Sergio Chica",
"author_email": "sergio.chica@uc3m.es",
"download_url": "https://files.pythonhosted.org/packages/81/f3/2f5940364e7161ff2bd241a05005bd3df382adbc5b0b3cf5855ec21df5e7/neuropy3-1.0.4.tar.gz",
"platform": null,
"description": "# Description\nPython3 library to read data from Neurosky Mindwave Mobile 2 on linux using\npybluez2.\n\n**Contents:**\n - [Requirements](#requirements)\n - [Pre-execution](#pre-execution)\n - [Execution](#execution)\n - [Command line interface](#command-line-interface)\n - [Graphical user interface](#graphical-user-interface)\n - [Importing library](#importing-library)\n - [Acknowledgements](#acknowledgements)\n - [License](#license)\n\n# Requirements\n- libbluetooth-dev\n\n# Pre-execution\nYou can install dependencies via setup.py\n```bash\n$ python -m pip install .\n$ python -m pip install .[gui] # to install gui dependencies\n```\nvia python package index (PyPI)\n```bash\n$ python -m pip install neuropy3\n$ python -m pip install neuropy3[gui] # to install gui dependencies\n```\nor manually\n```bash\n$ python -m pip install -r requirements.txt\n$ python -m pip install -r gui_requirements.txt # to install gui dependencies\n```\n\n# Execution\n## Command line interface\n```bash\n$ python -m neuropy3\n$ python -m neuropy3 --address XX:YY:ZZ:AA:BB:CC\n$ python -m neuropy3 --help\n```\n> Address argument helps speed up connection process, otherwise a neuropy3\n> will run a scan of nearby bluetooth devices (which takes a lot).\n\n## Graphical user interface\n```bash\n$ python -m neuropy3 --gui\n$ python -m neuropy3 --address XX:YY:ZZ:AA:BB:CC --gui\n```\n> Note: requires neuropy3[gui] extra dependencies\n<details>\n <summary>Screenshots</summary>\n <div align=\"center\">\n <img alt=\"gui\" src=\"images/gui.png\" width=\"75%\"/>\n </div>\n <div align=\"center\">\n <img alt=\"raw\" src=\"images/raw.png\" width=\"75%\"/>\n </div>\n</details>\n\n## Importing library\n```python\n>>> from neuropy3.neuropy3 import MindWave\n>>> mw = MindWave(address='XX:YY:ZZ:AA:BB:CC', autostart=False, verbose=3)\n>>> # mw = MindWave(autostart=False, verbose=3) # Autoscan for MindWave Mobile\n>>> mw.set_callback('eeg', lambda x: print(x))\n>>> mw.set_callback('meditation', lambda x: print(x))\n>>> mw.set_callback('attention', lambda x: print(x))\n>>> mw.start()\n>>> mw.unset_callback('eeg')\n>>> mw.stop()\n```\n\n# Acknowledgements\n**This work has been supported by National R&D Project TEC2017-84197-C4-1-R and by the\nComunidad de Madrid project CYNAMON P2018/TCS-4566 and co-financed by European Structural\nFunds (ESF and FEDER)**\n\n- Based on [lihas/NeuroPy](https://github.com/lihas/NeuroPy) library.\n- Communication protocol from [neurosky](http://developer.neurosky.com/docs/doku.php?id=thinkgear_communications_protocol).\n\n# License\n neuropy3 Copyright (C) 2022-2023 Sergio Chica Manjarrez @ pervasive.it.uc3m.es.\n Universidad Carlos III de Madrid.\n This program comes with ABSOLUTELY NO WARRANTY; for details check below.\n This is free software, and you are welcome to redistribute it\n under certain conditions; check below for details.\n\n[LICENSE](LICENSE)\n",
"bugtrack_url": null,
"license": "GPLv3+",
"summary": "Python3 library to read data from Neurosky Mindwave Mobile 2 in linux.",
"version": "1.0.4",
"split_keywords": [
"eeg",
"neurosky",
"mindwave",
"neurosky mindwave mobile 2"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7f92121ceb3a48ff7855ef9e87927a389bb4385ea408600c9a524eccc9bdff59",
"md5": "c66516ac2ee2b572e0c817ce856ef614",
"sha256": "9ff4364738487f57cc0bfcf092758fed34ff42f877a4dfa5fae06af6151b65c2"
},
"downloads": -1,
"filename": "neuropy3-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c66516ac2ee2b572e0c817ce856ef614",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">= 3.8",
"size": 34236,
"upload_time": "2023-03-24T10:17:08",
"upload_time_iso_8601": "2023-03-24T10:17:08.627301Z",
"url": "https://files.pythonhosted.org/packages/7f/92/121ceb3a48ff7855ef9e87927a389bb4385ea408600c9a524eccc9bdff59/neuropy3-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "81f32f5940364e7161ff2bd241a05005bd3df382adbc5b0b3cf5855ec21df5e7",
"md5": "6d752bb9737197ba0cc4852bee90f9a8",
"sha256": "1c6d6b14f06a1111f9ac1ada404fcd063e8bc21cbcb8063f5342f7867672b5b2"
},
"downloads": -1,
"filename": "neuropy3-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "6d752bb9737197ba0cc4852bee90f9a8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">= 3.8",
"size": 32466,
"upload_time": "2023-03-24T10:17:11",
"upload_time_iso_8601": "2023-03-24T10:17:11.069510Z",
"url": "https://files.pythonhosted.org/packages/81/f3/2f5940364e7161ff2bd241a05005bd3df382adbc5b0b3cf5855ec21df5e7/neuropy3-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-24 10:17:11",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "neuropy3"
}
JSON