Skip to content

Commit 6e10a05

Browse files
author
William Schumacher
committed
Updated documentation.
1 parent 0d84705 commit 6e10a05

File tree

3 files changed

+16
-8
lines changed

3 files changed

+16
-8
lines changed

README.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Contributions by
1010

1111
* Severin Lemaignan - Base C Library and mcrypt functionality
1212
* Sharif Olorin (http://github.com/fractalcat) - hidapi support
13-
* Bill Schumacher (http://github.com/bschumacher) - Fixed the python library, well almost.
13+
* Bill Schumacher (http://github.com/bschumacher) - Fixed the Python library
1414

1515
Description
1616
===========
@@ -23,8 +23,6 @@ software), just the raw sensor data.
2323
The C library is backed by hidapi, and should work on any platform
2424
that hidapi also works on.
2525

26-
The Python library is currently broken. Fix it!
27-
2826
Information
2927
===========
3028

@@ -70,12 +68,19 @@ Python library
7068
--------------
7169

7270
import emotiv
71+
7372
headset = emotiv.Emotiv()
73+
7474
try:
75+
7576
while True:
77+
7678
for packet in headset.dequeue():
79+
7780
print packet.gyroX, packet.gyroY
81+
7882
finally:
83+
7984
headset.close()
8085

8186
Platform Specifics Issues
@@ -90,6 +95,9 @@ for each. We've tried to cover both (as based on hidapi's example udev
9095
file), but your mileage may vary. If you have problems, please post
9196
them to the github issues page (http://github.com/openyou/emokit/issues).
9297

98+
Your kernel may not support /dev/hidraw devices by default, such as an RPi.
99+
To fix that re-comiple your kernel with /dev/hidraw support
100+
93101
Credits - Cody
94102
==============
95103

doc/Announcement.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The code is available on github on the [daeken/Emokit](http://github.com/daeken/
1515
Where things are right now
1616
==========================
1717

18-
You can access raw EEG data from the Emotiv EPOC on Windows, Linux, and OS X from Python. While it's not known exactly which sensors are which in the data (read below for more info), it's close to being useful already. Word of warning: this project is less than 48 hours old (I just got hardware in my hands Saturday night) and has only been run by me on Windows due to a dead Linux box. It's very much alpha quality right now -- don't trust it.
18+
You can access raw EEG data from the Emotiv EPOC on Windows, Linux, and OS X from Python. Sensor locations can be found at https://github.com/bschumacher/emokit-1/wiki/Sensor-Locations. Word of warning: this project is less than 48 hours old (I just got hardware in my hands Saturday night) and has only been run by me on Windows due to a dead Linux box. It's very much alpha quality right now -- don't trust it.
1919

2020
How it happened
2121
===============

doc/emotiv_protocol.asciidoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -127,23 +127,23 @@ An Overview of the 256-bit Packet Layout:
127127
| 0:7 | Counter/Battery
128128
| 8:21 | F3 Data
129129
| 22:35 | FC5 Data
130-
| 36:49 | AF7 Data
130+
| 36:49 | AF3 Data
131131
| 50:63 | F7 Data
132132
| 64:77 | T7 Data
133133
| 78:91 | P7 Data
134134
| 92:105 | O1 Data
135135
| 107:120 | Connection Quality (Rotating)
136-
| 121:133 | TP7 Data
136+
| 121:133 | ?
137137
| 134:147 | O2 Data
138138
| 148:161 | P8 Data
139139
| 162:175 | T8 Data
140140
| 176:189 | F8 Data
141-
| 190:203 | AF8 Data
141+
| 190:203 | AF4 Data
142142
| 204:217 | FC6 Data
143143
| 218:231 | F4 Data
144144
| 233:239 | Gyro X
145145
| 240:247 | Gyro Y
146-
| 248:255 | TP8 Data
146+
| 248:255 | ?
147147
|=============================
148148

149149
=== Counter and Battery

0 commit comments

Comments
 (0)