Emotiv SDK - Community Edition

Here is the repository of the Emotiv SDK Community Edition, along with code examples and other development tools.

• Supports EPOC (over Emotiv USB dongle)
• Supports Insight and EPOC+ (over BTLE and Emotiv USB dongle)
• Supports Win32/64, Mac, Linux, Android, iOS

If you have questions or have knowledge to share, please visit our forum which is the hub for our developer community.

To get the SDK you can either:

• clone this repository with git command line tool or a GUI client like SourceTree; or
• click on the "Download ZIP" button (above, on the right) to get the zip archive of the latest version; or
• go to releases and download the archive of a particular release

Table of Contents

1. Latest Release
2. Supported Platforms
3. Connecting Your Insight
4. API Documentation
5. Apps and Tools
6. Support

Latest Release

Version 3.3.1

• Available for Windows, Mac, iOS and Android; other platforms to follow
• New features and improvement:
  • Improved BTLE connection on all platforms
  • Improved noise tolerance for Mental Commands with Insight
  • Added IEE_GetHeadsetSettings and IEE_SetHeadsetSettings for EPOC+
  • Added EC_ReconnectEngine and EC_DisconnectEngine in EmotivCloudClient.h
  • Added FE_LAUGH, FE_SMIRK_LEFT, FE_SMIRK_RIGHT into detection list of Facial Expression
  • Added IS_FacialExpressionIsLookingLeft, IS_FacialExpressionIsLookingRight for EPOC/EPOC+.
  • Removed param profileName from EC_UpdateUserProfile
  • Added IEE_GetInsightDeviceState and IEE_GetEpocPlusDeviceState (Mac, iOS, Android)
  • Added multi-app support (Mac, iOS, Android)
• Bug fixes:
  • Fixed bug when uploading/downloading profile on 64-bit platform
  • Fixed incorrect battery level display with Insight (require new firmware )
  • Fixed bug with Surprise and Frown detections
  • Fixed motion data values retrieved from EPOC+
  • Fixed bug that prevent Insight to work with Extender on Mac
  • Fixed bug that prevent connecting to headset via BTLE on Linux
  • Swapped Gyro Y and Z in motion data with Insight
• Known Issues:
  • EPOC+ motion data may have packet lost on Android
  • EPOC+ only works with dongle version 0x06ff, not with 0x1fff or 0x0565
  • Changing the settings on EPOC+ with firmware 0x610 may fail and eventually turns the headset into a brick (!). Please contact [email protected] to arrange for a firmware upgrade

Version 3.3.0

• Supports saving/loading profile to Emotiv Cloud (see EmotivCloudClient.h)
• New API IEE_GetAverageBandPowers to get average band powers for:
  • theta (4-8 Hz)
  • alpha (8-12 Hz)
  • low-beta (12-16 Hz)
  • high-beta (16-25 Hz)
  • gamma (25-45 Hz)
• Supports Ubuntu 14.04 64-bit

Supported Platforms

• Insight with Bluetooth SMART (Bluetooth 4.0 or Bluetooth Low Energy) connection currently works with the SDK under:

  • Windows 8 or above
  • Windows 7, only with Bluetooth adaptor that uses Broadcom BCM20702 chipset (recommended one: Plugable USB 2.0 Bluetooth Adapter, http://plugable.com/products/usb-bt4le)
  • Mac OS X 10.10 or above (check if Bluetooth LMP Version is 0x6 from System Report)
  • Android 4.4.3 or above
  • Ubuntu 14.04 64-bit (see [Ubuntu BTLE with BlueZ](doc/Ubuntu BTLE with BlueZ.md))

• Insight with Emotiv Universal USB Receiver currently works with the SDK under:

  • Windows 7 or above
  • Mac OS X 10.8 or above
  • Android 4.4.3 or above
  • Ubuntu 14.04 64-bit

Connecting Your Insight

• Windows: Turn on Bluetooth on both Insight and PC, then pair your Insight with Windows built-in Bluetooth service first
• Mac, Android and iOS: Turn on Bluetooth on both Insight and Mac/Android device, then start Emotiv app to use (without first pairing)

API Documentation

The API reference can be found here:

http://emotiv.com/api/3.3.1/

Apps and Tools

Xavier EmoComposer

• Xavier Composer allows you to send user-defined EmoStates to Emotiv SDK, Xavier EmoKey, or any other application that makes use of the Emotiv API, and simulate the events that could be sent from Emotiv SDK with a real device.
• Available for Windows 7 or above and Mac OS X 10.8 or above

Xavier EmoKey

• Xavier EmoKey translates Emotiv detection results to predefined sequences of keystrokes according to logical rules defined by the user.
• Available for Windows 7 or above and Mac OS X 10.8 or above

CPanel

A web-based Emotiv Control Panel:

https://cpanel.emotivinsight.com

Compatible with Insight / EPOC / EPOC+ via:

• BTLE:
  • Windows 8 or above, with Firefox 43.0
  • Mac OS X 10.10 or above, with Safari 9.0 / Firefox 43.0 / Opera 34.0
• Emotiv USB Universal Receiver:
  • Windows 7 or above, with Firefox 43.0
  • Mac OS X 10.8 or above, with Safari 9.0 / Firefox 43.0 / Opera 34.0

Please follow the instructions to install the Emotiv browser plugin before using the CPanel.

Insight App for Android

Requires Android 4.4 or later

https://play.google.com/store/apps/details?id=com.emotiv.insightapp

Insight App for iOS

Requires iOS 8.0 or later, except iOS 8.3/8.4 due to BTLE data transmission limitation in those versions

https://itunes.apple.com/us/app/emotiv-insight/id1031805596

Support

Please check out the topic Insight on Emotiv Help Centre:

https://emotiv.zendesk.com/hc/en-us/categories/200100495-Insight

Our knowledge base is a good source for further reading:

https://emotiv.zendesk.com/hc/en-us

Please also visit our forum for bug reports and feature requests.

Happy coding!

The Emotiv Team