1 of 1

Headset object

Some methods of the API return one or more headset objects, for example queryHeadsets. A session object also includes a headset object.

Description

A headset object include these fields:

Name

Status

When you want to work with a headset, it is important to check its status.

Settings

The settings object include these fields:

For an Epoc+ headset, the mode can be "EPOC" or "EPOCPLUS", depending on its configuration. See 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.

Flex Mapping

Currently, the flexMappings object contains a single field. It may include more fields in the future.

Examples

Insight

Epoc+

Virtual MN8

Headset object

Some methods of the API return one or more headset objects, for example queryHeadsets. A session object also includes a headset object.

Description

A headset object include these fields:

Name

Status

When you want to work with a headset, it is important to check its status.

Settings

The settings object include these fields:

A motion rate of zero means that the motion sensors are disabled.

Flex Mapping

Currently, the flexMappings object contains a single field. It may include more fields in the future.

Examples

Insight

Epoc+

Virtual MN8

memsRes

number

The motion data resolution, in bits.

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

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.

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" }

{
  "id": "INSIGHT-AAAA0000",
  "status": "connected",
  "connectedBy": "dongle",
  "customName": "",
  "dongle": "6ff",
  "firmware": "930",
  "motionSensors": [
    "Q0",
    "Q1",
    "Q2",
    "Q3",
    "ACCX",
    "ACCY",
    "ACCZ",
    "MAGX",
    "MAGY",
    "MAGZ"
  ],
  "sensors": [
    "AF3",
    "T7",
    "Pz",
    "T8",
    "AF4"
  ],
  "settings": {
    "eegRate": 128,
    "eegRes": 14,
    "memsRate": 64,
    "memsRes": 14,
    "mode": "INSIGHT"
  },
  "isVirtual": false
}

{
    "id": "EPOCPLUS-3B9AXXXX",
    "status": "connected",
    "connectedBy": "dongle",
    "customName": "",
    "dongle": "6ff",
    "firmware": "625",
    "motionSensors": [
        "GYROX",
        "GYROY",
        "GYROZ",
        "ACCX",
        "ACCY",
        "ACCZ",
        "MAGX",
        "MAGY",
        "MAGZ"
    ],
    "sensors": [
        "AF3",
        "F7",
        "F3",
        "FC5",
        "T7",
        "P7",
        "O1",
        "O2",
        "P8",
        "T8",
        "FC6",
        "F4",
        "F8",
        "AF4"
    ],
    "settings": {
        "eegRate": 256,
        "eegRes": 16,
        "memsRate": 64,
        "memsRes": 16,
        "mode": "EPOCPLUS"
    },
    "isVirtual": false
}

{
  "id": 1,
  "jsonrpc": "2.0",
  "result": [
    {
      "connectedBy": "bluetooth",
      "customName": "virtual mn8",
      "dfuTypes": ["dfuNone"],
      "dongle": "0",
      "firmware": "23",
      "firmwareDisplay": "0x23",
      "headbandPosition": null,
      "id": "MN8-2DC3C2D9",
      "isDfuMode": false,
      "isVirtual": true,
      "motionSensors": ["Q0", "Q1", "Q2", "Q3"],
      "sensors": ["T7", "T8"],
      "settings": {
        "eegRate": 128,
        "eegRes": 14,
        "memsRate": 6,
        "memsRes": 10,
        "mode": "MN8"
      },
      "status": "connected",
      "virtualHeadsetId": "2dc3c2d9-cfe1-461b-983b-f187437b91e0"
    }
  ]
}

{
  "id": "INSIGHT-AAAA0000",
  "status": "connected",
  "connectedBy": "dongle",
  "customName": "",
  "dongle": "6ff",
  "firmware": "930",
  "motionSensors": [
    "Q0",
    "Q1",
    "Q2",
    "Q3",
    "ACCX",
    "ACCY",
    "ACCZ",
    "MAGX",
    "MAGY",
    "MAGZ"
  ],
  "sensors": [
    "AF3",
    "T7",
    "Pz",
    "T8",
    "AF4"
  ],
  "settings": {
    "eegRate": 128,
    "eegRes": 14,
    "memsRate": 64,
    "memsRes": 14,
    "mode": "INSIGHT"
  },
  "isVirtual": false
}

{
    "id": "EPOCPLUS-3B9AXXXX",
    "status": "connected",
    "connectedBy": "dongle",
    "customName": "",
    "dongle": "6ff",
    "firmware": "625",
    "motionSensors": [
        "GYROX",
        "GYROY",
        "GYROZ",
        "ACCX",
        "ACCY",
        "ACCZ",
        "MAGX",
        "MAGY",
        "MAGZ"
    ],
    "sensors": [
        "AF3",
        "F7",
        "F3",
        "FC5",
        "T7",
        "P7",
        "O1",
        "O2",
        "P8",
        "T8",
        "FC6",
        "F4",
        "F8",
        "AF4"
    ],
    "settings": {
        "eegRate": 256,
        "eegRes": 16,
        "memsRate": 64,
        "memsRes": 16,
        "mode": "EPOCPLUS"
    },
    "isVirtual": false
}

{
  "id": 1,
  "jsonrpc": "2.0",
  "result": [
    {
      "connectedBy": "bluetooth",
      "customName": "virtual mn8",
      "dfuTypes": ["dfuNone"],
      "dongle": "0",
      "firmware": "23",
      "firmwareDisplay": "0x23",
      "headbandPosition": null,
      "id": "MN8-2DC3C2D9",
      "isDfuMode": false,
      "isVirtual": true,
      "motionSensors": ["Q0", "Q1", "Q2", "Q3"],
      "sensors": ["T7", "T8"],
      "settings": {
        "eegRate": 128,
        "eegRes": 14,
        "memsRate": 6,
        "memsRes": 10,
        "mode": "MN8"
      },
      "status": "connected",
      "virtualHeadsetId": "2dc3c2d9-cfe1-461b-983b-f187437b91e0"
    }
  ]
}

Headset object

hashtagDescription

hashtagStatus

hashtagSettings

hashtagFlex Mapping

hashtagExamples

hashtagInsight

hashtagEpoc+

hashtagVirtual MN8

Headset object

hashtagDescription

hashtagStatus

hashtagSettings

hashtagFlex Mapping

hashtagExamples

hashtagInsight

hashtagEpoc+

hashtagVirtual MN8

Description

Status

Settings

Flex Mapping

Examples

Insight

Epoc+

Virtual MN8

Description

Status

Settings

Flex Mapping

Examples

Insight

Epoc+

Virtual MN8