NeuroSkyPy

NeuroSkyPy library written in python3.7 to connect, interact, get, save and plot data from NeuroSky's MindWave EEG headset, the first one ( black ).

This library is based on the mindwave mindset communication protocol published by Neurosky and is tested with Neurosky Mindwave EEG headset. Where It's readen the data in hex, after that it's decoded.

Installation

Source file

Download the source file from github
Unzip and navigate to the folder containing setup.py and other files
Run the following command: python setup.py install

Pip

    pip3 install NeuroSkyPy

Usage

A test-script which is used as experiment it's left in order to check and learn how to use the class. The basic steps to use the class are:

Importing the module: from NeuroPy import NeuroPy
Initializing: neuropy = NeuroPy()
After initializing, either the callbacks can be set or just extract data from the object as it's done in test-script.
Then call neuropy.start() method, it will start fetching data from mindwave.
To stop call neuropy.stop().

Obtaining Data from Device

Obtaining value: attention = neuropy.attention #to get value of attention_

Other Variable attention, meditation, rawValue, delta, theta, lowAlpha, highAlpha, lowBeta, highBeta, lowGamma, midGamma, poorSignal and blinkStrength
Setting callback: A call back can be associated with all the above variables so that a function is called when the variable is updated. Syntax:
```
setCallBack("[variable]",callback_function)
```
for eg. to set a callback for attention data the syntax will be
```
setCallBack("attention",callback_function)
```
Other Variables: attention, meditation, rawValue, delta, theta, lowAlpha, highAlpha, lowBeta, highBeta, lowGamma, midGamma, poorSignal and blinkStrength

Sample Program 1 (Access via callback)

from NeuroPy import NeuroPy
from time import sleep

neuropy = NeuroPy() 

def attention_callback(attention_value):
    """this function will be called everytime NeuroPy has a new value for attention"""
    print ("Value of attention is: ", attention_value)
    return None

neuropy.setCallBack("attention", attention_callback)
neuropy.start()

try:
    while True:
        sleep(0.2)
finally:
    neuropy.stop()

Sample Program 2 (Access via object)

from NeuroPy import NeuroPy
from time import sleep

neuropy = NeuroPy() 
neuropy.start()

while True:
    if neuropy.meditation > 70: # Access data through object
        neuropy.stop() 
    sleep(0.2) # Don't eat the CPU cycles

Python Compatibility

Python - v3.7

Note

This library comes from the libraries NeuroPy and mindwave-python. The library is tested and comes with extracted data.

Jor-G-ete / NeuroSkyPy