Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 120 lines (83 sloc) 3.091 kb
d3c96f7 @qdot Moved python files into a subdirectory to clean up the root
qdot authored
1 Emokit
2 ======
3
32199ae @qdot Updating the readme. Promoting myself to coauthor because it makes me fe...
qdot authored
4 By Cody Brocious and Kyle Machulis
d3c96f7 @qdot Moved python files into a subdirectory to clean up the root
qdot authored
5
6 Contributions by
7
8 * Severin Lemaignan (Base C Library and mcrypt functionality)
9
10 Description
11 ===========
12
397a914 @qdot Renamed epocd to emokitd
qdot authored
13 Emokit is a set of language for user space access to the raw stream
14 data from the Emotiv EPOC headset. Note that this will not give you
15 processed data (i.e. anything available in the Emo Suites in the
16 software), just the raw sensor data.
d3c96f7 @qdot Moved python files into a subdirectory to clean up the root
qdot authored
17
ef554d2 @qdot More README updates
qdot authored
18 The C library is currently supported on:
19
20 * OS X/Linux - Via libusb-1.0
32199ae @qdot Updating the readme. Promoting myself to coauthor because it makes me fe...
qdot authored
21 * Windows - via Win32 HID calls
ef554d2 @qdot More README updates
qdot authored
22
23 The Python library is currently supported on:
24
25 * Linux - udev rules and file system access (no special library required)
26 * Windows - pywinhid
27 * OS X - Coming soon (via pyusb)
28
29 Required Libraries
30 ==================
31
32 Python
33 ------
34
35 * pywinhid (Windows Only) - http://code.google.com/p/pywinusb/
32199ae @qdot Updating the readme. Promoting myself to coauthor because it makes me fe...
qdot authored
36 * pyusb (OS X, Optional for Linux) - http://sourceforge.net/projects/pyusb/
ef554d2 @qdot More README updates
qdot authored
37
397a914 @qdot Renamed epocd to emokitd
qdot authored
38 C Language
39 ----------
ef554d2 @qdot More README updates
qdot authored
40
41 * CMake (Required on all platforms) - http://www.cmake.org
42 * WDK (Windows Only) - http://www.microsoft.com/whdc/devtools/WDK/default.mspx
43 * libusb-1.0 (All non-windows platforms) - http://www.libusb.org
44 * libmcrypt (Required on all platforms) - https://sourceforge.net/projects/mcrypt/
45
096bdc5 @daeken Huge regression in sensor naming.
daeken authored
46 Usage
47 =====
48
d3c96f7 @qdot Moved python files into a subdirectory to clean up the root
qdot authored
49 C library
50 ---------
51
52 See epocd.c example
53
096bdc5 @daeken Huge regression in sensor naming.
daeken authored
54 Python library
55 --------------
56
d3c96f7 @qdot Moved python files into a subdirectory to clean up the root
qdot authored
57 import emotiv
58 headset = emotiv.Emotiv()
59 try:
60 while True:
61 for packet in headset.dequeue():
62 print packet.gyroX, packet.gyroY
63 finally:
64 headset.close()
65
66 Platform Specifics
67 ==================
68
69 OS X
70 ----
096bdc5 @daeken Huge regression in sensor naming.
daeken authored
71
397a914 @qdot Renamed epocd to emokitd
qdot authored
72 You will need to install the EmotivNullDriver.kext on OS X for
73 software to be able to access the EPOC. To do this, copy the
74 osx/EmotivNullDriver.kext directory to /System/Library/Extensions/.
75 Once this is done, from the terminal, run
d3c96f7 @qdot Moved python files into a subdirectory to clean up the root
qdot authored
76
77 sudo kextutil /System/Library/Extensions/EmotivNullDriver.kext
78
397a914 @qdot Renamed epocd to emokitd
qdot authored
79 Or else just reboot. This will blacklist the emotiv from the HID
80 Manager so it can be read by Emokit. No telling what this will do in
81 conjunction with the Emotiv OS X drivers, I haven't tested that yet.
d3c96f7 @qdot Moved python files into a subdirectory to clean up the root
qdot authored
82
83 Linux
84 -----
85
86 There are two ways to run Emokit on Linux
87
397a914 @qdot Renamed epocd to emokitd
qdot authored
88 * Copy the udev rules to /etc/udev/rules and restart udev, in which
89 case you'll have access to /dev/hidrawX, where X is probably 0 and
90 1. You're interested in whatever the higher number is.
91 * Use the libusb driver, which will detach from the HID Manager as
92 long as you run whatever you need in sudo. Otherwise, you'll need to
93 blacklist the VID/PID pair out of the kernel
d3c96f7 @qdot Moved python files into a subdirectory to clean up the root
qdot authored
94
95 Windows
96 -------
97
32199ae @qdot Updating the readme. Promoting myself to coauthor because it makes me fe...
qdot authored
98 No platform specifics. Should just work.
d3c96f7 @qdot Moved python files into a subdirectory to clean up the root
qdot authored
99
100 Credits - Cody
101 ==============
096bdc5 @daeken Huge regression in sensor naming.
daeken authored
102
397a914 @qdot Renamed epocd to emokitd
qdot authored
103 Huge thanks to everyone who donated to the fund drive that got the
104 hardware into my hands to build this.
105
106 Thanks to Bryan Bishop and the other guys in #hplusroadmap on Freenode
107 for your help and support.
108
109 And as always, thanks to my friends and family for supporting me and
110 suffering through my obsession of the week.
d3c96f7 @qdot Moved python files into a subdirectory to clean up the root
qdot authored
111
112 Credits - Kyle
113 ==============
114
397a914 @qdot Renamed epocd to emokitd
qdot authored
115 Kyle would like to thank Cody for doing the hard part.
116
117 He would also like to thank emotiv for putting emo on the front of
118 everything because it's god damn hilarious. I mean, really, Emo
119 Suites? Saddest hotel EVER.
Something went wrong with that request. Please try again.