Headset object
Last updated
Last updated
Some methods of the API return one or more headset objects, for example queryHeadsets. A session object also includes a headset object.
A headset object include these fields:
When you want to work with a headset, it is important to check its status.
The settings object include these fields:
For an Epoc+ headset, the mode can be "EPOC" or "EPOCPLUS", depending on its configuration. See updateHeadset for details. For an Insight or Epoc headset, the mode is always "EPOC". For an Epoc Flex headset, the mode is always "EPOCFLEX".
A motion rate of zero means that the motion sensors are disabled.
Currently, the flexMappings object contains a single field. It may include more fields in the future.
Name
Type
Description
id
string
The id of this headset.
status
string
Can be "discovered", "connecting", or "connected".
connectedBy
string
Can be "bluetooth", "dongle", "usb cable", or "extender".
dongle
string
The version of the dongle firmware.
firmware
string
The version of the headset firmware.
motionSensors
array of strings
The names of the motion sensors of this headset.
sensors
array of strings
The names of the EEG sensors of this headset. Use the international 10-20 system.
settings
object
An object containing the configuration of the EEG and motion data of this headset.
flexMappings
object
If the headset is an EPOC Flex, then this field is an object containing information about the mapping of the EEG channels.
headbandPosition
string
If the headset is an EPOC X, then this field tells you the position of the headband of this headset. Can be "back" or "top". If the headset is not an EPOC X, then this field is null. See updateHeadsetCustomInfo for details.
This field was added in Cortex 2.4
customName
string
The custom name of the headset. The user can set it in EMOTIV App.
This field was added in Cortex 2.4
Status
Description
discovered
Cortex has detected the headset, but it is not connected. You cannot create a session for a discovered headset. You can call controlDevice to connect the headset.
connecting
Cortex is trying to connect to this headset. This can take a few seconds.
connected
Cortex is connected to and receives data from this headset. You can call createSession and start working with this headset.
You can call controlDevice to disconnect the headset.
Name
Type
Description
mode
string
Can be "EPOC", "EPOCPLUS", or "EPOCFLEX"
eegRate
number
The EEG sample rate, in hertz.
eegRes
number
The EEG resolution, in bits.
memsRate
number
The motion data sample rate, in hertz.
memsRes
number
The motion data resolution, in bits.
Name
Type
Description
mappings
object
Describe which EEG channel is mapped to which physical connector of EPOC Flex device. The keys are the names of the connectors, the values are the names of the EEG channels.
Example: { "CMS": "TP8", "DRL": "P6", "RM": "TP10", "RN": "P4", "RO": "P8" }