Dec 11, 2017 Emotiv SDK - Community Edition End Of Life ? Today we are announcing the end of life (EOL) for the Emotiv SDK Community Edition. Version 3.5 will be the last major release. The planned final day will be 31st December 2018.
This API document will help you to use the Emotiv SDK to build software that is compatible with Emotiv headsets.
For examples and latest releases please check out the Github repository. There are some sample programs that demonstrate these concepts and serve as a tutorial to help you get started with the Emotiv API.
Introduction to the Emotiv SDK and EmoEngine
The Emotiv SDK is exposed as an ANSI C interface that is declared in 11 header files (Iedk.h, IEmoStateDLL.h, IedkErrorCode.h, FacialExpressionDetection.h, MentalCommandDetection.h, EdfData.h, EmotivCloudClient.h, EmotivLicense.h, IEegData.h, IEmoStatePerformanceMetric.h,IEmotivProfile.h). Applications that use the Emotiv API simply include Iedk.h and link with platform dependent library files.
The Emotiv EmoEngine refers to the logical abstraction of the functionality that Emotiv provides in the run-time library. The EmoEngine communicates with the Emotiv headset, receives preprocessed EEG and gyroscope data, manages user-specific or application-specific settings, performs post-processing, and translates the Emotiv detection results into an easy-to-use structure called an EmoState. Emotiv API functions that modify or retrieve EmoEngine settings are prefixed with IEE_.
Integrating the Emotiv SDK with an application
An EmoState is an opaque data structure that contains the current state of the Emotiv detections, which, in turn, reflect the user’s facial, emotional and cognitive state. EmoState data is retrieved by Emotiv API functions that are prefixed with IS_. EmoStates and other Emotiv API data structures are typically referenced through opaque handles (e.g. EmoStateHandle and EmoEngineEventHandle). These data structures and their handles are allocated and freed using the appropriate Emotiv API functions (i.e. IEE_EmoEngineEventCreate() and IEE_EmoEngineEventFree()).
During initialization, and prior to calling Emotiv API functions, your application must establish a connection to the EmoEngine by calling IEE_EngineConnect() or IEE_EngineRemoteConnect(). Use IEE_EngineConnect() when you wish to communicate directly with an Emotiv headset. Use IEE_EngineRemoteConnect() if you wish to connect your application to EmoComposer or Emotiv Control Panel.
The EmoEngine communicates with your application by publishing events that can be retrieved by calling IEE_EngineGetNextEvent(). For near real-time responsiveness, most applications should poll for new EmoStates at least 10-15 times per second. This is typically done in an application’s main event loop or, in the case of most videogames, when other input devices are periodically queried. Before your application terminates, the connection to EmoEngine should be explicitly closed by calling IEE_EngineDisconnect().
There are three main categories of EmoEngine events that your application should handle:
- Hardware-related events: Events that communicate when users connect or disconnect Emotiv input devices to the computer (e.g. IEE_UserAdded, IEE_UserRemoved).
- New EmoState events: Events that communicate changes in the user’s FacialExpression and MentalCommands state. You can retrieve the updated EmoState by calling IEE_EmoEngineEventGetEmoState(). (e.g. IEE_EmoStateUpdated).
- Suite-specific events: Events related to training and configuring the FacialExpression and MentalCommands detection suites (e.g. IEE_MentalCommandEvent_t).
![Emotiv Research Edition Emotiv Research Edition](/uploads/1/2/6/3/126322660/432260654.jpg)
Most API functions are declared to return a value of type int. The return value should be checked to verify the correct operation of the API function call. Most Emotiv API functions return EDK_OK if they succeed. Error codes are defined in IedkErrorCode.h.
Development scenarios supported by IEE_EngineRemoteConnect
The IEE_EngineRemoteConnect() API should be used in place of IEE_EngineConnect() in the following circumstances:
- The application is being developed with Emotiv SDK Lite. This version of the SDK does not communicate with an Emotiv headset, so all Emotiv API function calls communicate with EmoComposer - the EmoEngine emulator that is described here. EmoComposer listens on port 1726 so an application that wishes to connect to an instance of emulator running on the same computer must call IEE_EngineRemoteConnect(“127.0.0.1”, 1726).
- The developer wishes to test his application’s behavior in a deterministic fashion by manually selecting which Emotiv detection results to send to the application. In this case, the developer should connect to EmoComposer as described previously.
- The developer wants to speed up the development process by beginning his application integration with the EmoEngine and the Emotiv headset without having to construct all of the UI and application logic required to support detection tuning, training, profile management and headset contact quality feedback. In this case, Emotiv Control Panel can act as a proxy for either the real, headset-integrated EmoEngine or EmoComposer. Control Panel listens on port 3008 so an application that wishes to connect to Control Panel must call IEE_EngineRemoteConnect(“127.0.0.1”, 3008).
Supported devices
You can use the API IEE_HardwareGetVersion() to check the current hardware version of the headset and dongle (if applicable) for a particular user.
- OzGIS 14.7Data collected from field level sources can be inserted and analyzed so that you can present it on the reports.
- 2Printer 5.5Enables you to print any type documents or files in bath mode one after another specifying the paper size and without any...
- Vivaldi for MacOS 2.9No ad browser and uses minimum memory, takes very less time to load, some unique features added like notes containing...
- Win PDF Editor 3.6.3Editing PDF documents was like nightmare for me but when I am suggested by one of colleagues I tried this and found that...
- Serial to Ethernet Connector 7.1It can successfully turn your computer to a terminal server so that any device connected to the com port will be...
- ShutUp10 1.4.1388This software will let you take the full control over your windows 10 and decide which program to start automatically or...
- TeraCopy 3.26Copies files seamlessly from source to target location, also detects errors while transferring and rectifies it.
- Ulysses for Windows 2.7.11Writing application with most of useful features that a standard word processor may offer like markdown, emerging to...
- InjuredPixels 4.0It will repair the damaged pixels of the display unit so that it can still be usable for some more days instead of buying...
- DrvInfo 1.2.0.2016.0The software will show you the details of a drive as soon as it is inserted into the port whether it is a floppy, flash...
Development / Other / Emotiv Research Edition SDK 1.0
Advertisement
Emotiv Research Edition SDK 1.0 Description
The Research Edition SDK is a single user license for independent researchers (individuals, companies or incorporated entities that had a turnover less than US$100,000 in their last fiscal year), wishing to conduct EEG research leveraging the Emotiv
The Research Edition SDK is a single user license for independent researchers (individuals, companies or incorporated entities that had a turnover less than US$100,000 in their last fiscal year), wishing to conduct EEG research leveraging the Emotiv EPOC technology. The license is registered to the individual and is not transferable. The resulting applications, whether free or commercial will be distributed exclusively through our online application store. The Research Edition SDK includes a research headset: a 14 channel (plus CMS/DRL references, P3/P4 locations) high resolution, neuro-signal acquisition and processing wireless neuroheadset. Channel names based on the International 10-20 locations are: AF3, F7, F3, FC5, T7, P7, O1, O2, P8, T8, FC6, F4, F8, AF4. TestBench™ software included in the Research Edition SDK provides: - Real-time display of the Emotiv headset data stream, including EEG, contact quality, FFT, gyro, wireless packet acquisition/loss display, marker events, headset battery level. - Record and replay files in binary EEGLAB format1. Command line file converter included to produce .csv format. - Define and insert timed markers into the data stream, including on-screen buttons and defined serial port events. Markers are stored in EEG data file - Marker definitions can be saved and reloaded. Markers are displayed in real time and playback modes. - Export screenshot for documentation
OS: Windows
Emotiv
210
License Type:
Size:
10 May, 2012
$750.00
Tags:Emotiv - EPOC - Home
User Reviews of Emotiv Research Edition SDK
More Software from Author of Emotiv Research Edition SDK
- Emotiv Development Kit 1.0 The Emotiv Software Development Kit includes a high resolution, neuro-signal neuro-signal wireless neuroheadset and our proprietary software toolkit that exposes our APIs and detection libraries. It includes EmotivControlPanel.exe, EmotivComposer... Download