The hemokit package

[Tags:library, mit, program]

This package allows reading raw data from the Emotiv EPOC EEG devices.

It is inspired and based on the code of the Emokit project (https://github.com/openyou/emokit), but entirely written in Haskell.

It contains an extensive, well-documented library for connecting to devices, decrypting the stream, and parsing the relevant data out.

Data can be read from a given device via HIDAPI-hidraw or a dump file; reading from multiple devices is supported and when only one EEG is to be used, the correct device is automatically selected.

There is also an executable, hemokit-dump, that can print out

in both their plain form and as JSON, and optionally serve any of this via Websockets.


[Skip to Readme]

Properties

Versions 0.4.0, 0.4.1, 0.4.2, 0.5, 0.5.1, 0.6.0, 0.6.1, 0.6.2, 0.6.3, 0.6.4, 0.6.5, 0.6.6
Dependencies aeson (>=0.6.1.0), base (==4.*), base64-bytestring (>=1.0.0.1), bytestring (>=0.9.2.1), cairo (>=0.12.4), cipher-aes (>=0.2.0), conduit (>=1), deepseq (>=1.2), deepseq-generics (>=0.1), gtk (>=0.12.4), hemokit, hidapi (>=0.1.2), mtl (>=2.1.2), network-simple (>=0.4.0.2), optparse-applicative (>=0.11), pretty-show (>=1.0), robot (>=1.3.0.1), split (>=0.2.2), svgcairo (>=0.12.1.1), text (>=0.11.1.1), time (>=1.4), transformers (>=0.3.0.0), vector (>=0.9), vector-fftw (>=0.1.3.1), websockets (>=0.8.0.0) [details]
License MIT
Copyright 2013 Niklas Hambüchen <mail@nh2.me>, Patrick Chilton <chpatrick@gmail.com>
Author Niklas Hambüchen <mail@nh2.me>, Patrick Chilton <chpatrick@gmail.com>
Maintainer Niklas Hambüchen <mail@nh2.me>
Stability experimental
Category Bioinformatics
Home page https://github.com/nh2/hemokit
Bug tracker https://github.com/nh2/hemokit/issues
Source repository head: git clone git://github.com/nh2/hemokit.git
Uploaded Wed Aug 19 03:36:56 UTC 2015 by NiklasHambuechen
Distributions NixOS:0.6.6
Downloads 2048 total (29 in the last 30 days)
Votes
0 []
Status Docs available [build log]
Last success reported on 2015-08-19 [all 1 reports]

Modules

[Index]

Flags

NameDescriptionDefaultType
fftEnable apps that use FFT. Needs fftw installed.EnabledAutomatic
headmapBuild the headmap. Needs GUI libraries installed.EnabledAutomatic
mouseBuild the app that controls the mouse with the gyroscope. Needs Xorg and related libraries installed (so it only works on Linux for now).EnabledAutomatic

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for hemokit

Readme for hemokit-0.6.6

hemokit

Haskell library and tool suite for the Emotiv Epoc EEG, inspired by the Emokit code.

It currently only works on Linux and Windows - patches for other platforms are welcome, they should be trivial.

Download

You can download pre-built binaries here, or build it yourself via cabal install hemokit.

Library Features

  • device discovery via hidapi
  • decryption of the raw data (one-to-one port from from Emokit)
  • convenient access to sensor values, gyro, qualities, battery, and raw data

Programs

Hemokit comes with example programs to

  • hemokit-dump print out the current EEG data
  • hemokit-mouse move the cursor using the gyro

Note that we have to use sudo in most of the cases because the HIDAP-hidraw implementation reads directly from a device file.

hemokit-dump - Examples

hemokit-dump can print EEG data, format it as JSON, serve it via TCP or Websockets, and read from real devices and dump files.

  • Output EEG cumulative state for an automatically found device:

    sudo hemokit-dump
    
  • Select one of many connected EEGs by serial number:

    sudo hemokit-dump --serial SN...GM
    
  • Output only the data the device sends (no cumulative state), and format the output as JSON:

    sudo hemokit-dump --mode packets --format json
    

    The --format flag allows you to change the way the output is printed. The output of --mode state --format spaced is especially easy to work with.

  • Instead of from a real device, read data recorded to a file, and serve it via JSON over a TCP server on port 1234:

    sudo cat /dev/hidraw1 > encrypted.dump  # Dump data to a file
    sudo hemokit-dump --from-file encrypted.dump --serial SN...GM --serve 0.0.0.0:1234 --format json
    

    Here you have to specify the serial since HIDAPI is not used to obtain it automatically.

    If you prefer a Websockets server over a raw TCP server, use ws://0.0.0.0:1234 instead.

  • Output decrypted raw data to stdout:

    sudo hemokit-dump --mode raw
    
  • Both print the data from the EEG and store the original data for later use:

    sudo cat /dev/hidraw1 | tee >(hemokit-dump --from-file - --serial SN...GM --format json) > encrypted.dump
    

    We use tee and shell process substitution to duplicate the data stream, and tell hemokit-dump to read from - (stdin).

Connecting with other Programs

  • To use Hemokit as a data source from OpenVibe, check out the corresponding entry in the Wiki
  • To read Hemokit data from Matlab, I recommend publishing the data on a local socket in text format using hemokit-dump --format spaced --serve 127.0.0.1:1234. Then you can read it with code like:
t = tcpip('127.0.0.1', 1234);
fopen(t)
data = fscanf(t, '%d');