Skip to content

Latest commit

 

History

History
86 lines (59 loc) · 3.3 KB

README.md

File metadata and controls

86 lines (59 loc) · 3.3 KB
Raw

Cortex

CI pytest pre-commit.ci status formatter | docformatter style | google

cortex is an API for communicating with your Emotiv EEG device via websockets.

Emotiv Insight Headset Source: Emotiv

Before you start

To run the existing example you will need to do a few things.

  1. You will need an EMOTIV headset. You can purchase a headset in an online store

  2. Next, download and install the Cortex service. Please note that currently, the Cortex service is only available for Windows and macOS.

  3. We have updated our Terms of Use, Privacy Policy and EULA to comply with GDPR. Please login via the EMOTIV Launcher to read and accept our latest policies in order to proceed using the following examples.

  4. Next, to get a client id and a client secret, you must connect to your Emotiv account on emotiv.com and create a Cortex app. If you don't have a EmotivID, you can register here.

  5. Then, if you have not already, you will need to login with your Emotiv id in the EMOTIV Launcher.

  6. Finally, the first time you run these examples, you also need to authorize them in the EMOTIV Launcher.

Getting Started

To get started, you will need to install the cortex package. You should check out some examples to get you started.

poetry install

For testing and development, you can install the package with the test and dev flags respectively.

poetry install --with test,dev

You'll also need to set your client id and client secret as environment variables.

export EMOTIV_CLIENT_ID="your-client-id"
export EMOTIV_CLIENT_SECRET="your-client-secret"

Contribution

You are very welcome to modify and use them in your own projects.

Please keep a link to the original repository. If you have made a fork with substantial modifications that you feel may be useful, then please open a new issue on GitHub with a link and short description.

License (MIT)

This project is opened under the MIT which allows very broad use for both private and commercial purposes.

A few of the images used for demonstration purposes may be under copyright. These images are included under the "fair usage" laws.