emokit-java

Open Source Java driver to access raw data from the Emotiv EPOC EEG headset.

(click image for a video of the demonstration data acquisition application)

Applications using EmoKit

• Neurofiction

Demo

Several Java Swing GUI widgets are provided for use in your applications, as demonstrated in the bundled Zoku data acquisition application. To run Zoku, you must have a PostgreSQL server running on localhost with a database called zoku (this sounds like a pain, but it makes integration with R much easier).

• run postgresql on localhost, username postgres
• create a database called zoku
• mvn compile
• mvn exec:java

Raw access is through the com.github.fommil.emokit.Emotiv class:

Emotiv emotiv = new Emotiv();
for (Packet packet : emotiv) {
    ...
}

the special Iterator will continue until the EEG device is disconnected, or there are IO problems. If that happens, a new Emotiv instance can be obtained and polled.

Installation

Snapshots are distributed on Sonatype's Snapshot Repository:

<dependency>
  <groupId>com.github.fommil</groupId>
  <artifactId>emokit</artifactId>
  <version>1.0-SNAPSHOT</version>
</dependency>

If the above fails, ensure you have the following in your pom.xml:

    <repositories>
        <repository>
            <id>sonatype-snapshots</id>
            <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
            <releases>
                <enabled>false</enabled>
            </releases>
            <snapshots>
                <enabled>true</enabled>
            </snapshots>
        </repository>
    </repositories>

Donations

Please consider supporting the maintenance of this open source project with a donation:

Licence

Copyright (C) 2012 Samuel Halliday

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/

Contributing

Contributors are encouraged to fork this repository and issue pull requests. Contributors implicitly agree to assign an unrestricted licence to Sam Halliday, but retain the copyright of their code (this means we both have the freedom to update the licence for those contributions).

History

This is a port and extension of emokit.

Thanks go to the following for reverse engineering, original code and assistance:

• Cody Brocious
• Kyle Machulis
• Bill Schumacher