Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Moved python files into a subdirectory to clean up the root

Updated README
  • Loading branch information...
commit d3c96f77058791b3c85d42242235f7aeb52fb53a 1 parent 9e47742
@qdot qdot authored
View
71 README.md
@@ -1,21 +1,72 @@
+Emokit
+======
+
+By Cody Brocious
+
+Contributions by
+
+* Severin Lemaignan (Base C Library and mcrypt functionality)
+* Kyle Machulis (libusb communications in C, C library updates, special epoc key, OS X Compatibility work)
+
+Description
+===========
+
+Emokit is a set of language for user space access to the raw stream data from the Emotiv EPOC headset. Note that this will not give you processed data (i.e. anything available in the Emo Suites in the software), just the raw sensor data.
+
Usage
=====
+C library
+---------
+
+See epocd.c example
+
Python library
--------------
- import emotiv
- headset = emotiv.Emotiv()
- try:
- while True:
- for packet in headset.dequeue():
- print packet.gyroX, packet.gyroY
- finally:
- headset.close()
+ import emotiv
+ headset = emotiv.Emotiv()
+ try:
+ while True:
+ for packet in headset.dequeue():
+ print packet.gyroX, packet.gyroY
+ finally:
+ headset.close()
+
+Platform Specifics
+==================
+
+OS X
+----
-Credits
-=======
+You will need to install the EmotivNullDriver.kext on OS X for software to be able to access the EPOC. To do this, copy the osx/EmotivNullDriver.kext directory to /System/Library/Extensions/. Once this is done, from the terminal, run
+
+sudo kextutil /System/Library/Extensions/EmotivNullDriver.kext
+
+Or else just reboot. This will blacklist the emotiv from the HID Manager so it can be read by Emokit. No telling what this will do in conjunction with the Emotiv OS X drivers, I haven't tested that yet.
+
+Linux
+-----
+
+There are two ways to run Emokit on Linux
+
+* Copy the udev rules to /etc/udev/rules and restart udev, in which case you'll have access to /dev/hidrawX, where X is probably 0 and 1. You're interested in whatever the higher number is.
+* Use the libusb driver, which will detach from the HID Manager as long as you run whatever you need in sudo. Otherwise, you'll need to blacklist the VID/PID pair out of the kernel
+
+Windows
+-------
+
+Should "just work", since it uses the Win32 HID layer. How often does that happen, eh?
+
+Credits - Cody
+==============
Huge thanks to everyone who donated to the fund drive that got the hardware into my hands to build this.
Thanks to Bryan Bishop and the other guys in #hplusroadmap on Freenode for your help and support.
And as always, thanks to my friends and family for supporting me and suffering through my obsession of the week.
+
+Credits - Kyle
+==============
+
+Kyle would like to thank Cody for doing the hard part.
+He would also like to thank emotiv for putting emo on the front of everything because it's god damn hilarious. I mean, really, Emo Suites? Saddest hotel EVER.
View
0  aes.py → python/aes.py
File renamed without changes
View
0  emotiv.py → python/emotiv.py
File renamed without changes
View
0  mouse_control.py → python/mouse_control.py
File renamed without changes
View
0  read.py → python/read.py
File renamed without changes
View
0  render.py → python/render.py
File renamed without changes
Please sign in to comment.
Something went wrong with that request. Please try again.