mentalCommandActiveAction

This method is to get or set the active actions for the mental command detection.
If an action is inactive, then the mental command detection won't detect it anymore. Deactivate an action do not erase its trainings from the profile.
Check out adding new commands and deactivating commands in our BCI app.
Parameters
Name
Type
Required
Description
cortexToken
string
yes
A token returned by authorize.
status
string
yes
Must be "set" or "get".
profile
string
no
A profile name.
session
string
no
A session id returned by createSession.
actions
array of string
no
If the status is "set", this parameter is the list of actions to activate.
You can't activate more than 4 actions. This doesn't include "neutral".
You must set one of these 2 parameters: profile or session. Read this for details.
Result
If the status is "get", then the result is an array of strings that is the list of active actions. 
If the status is "set", then the result is an object with these fields:
Name
Type
Description
actions
array of strings
The active actions.
message
string
A success message.
Examples
Get
Request
Response
{
    "id": 544314,
    "jsonrpc": "2.0",
    "method": "mentalCommandActiveAction",
    "params": {
        "cortexToken": "xxx",
        "profile": "cortex-v2-example",
        "status": "get"
    }
}
{
    "id": 544314,
    "jsonrpc": "2.0",
    "result": [
        "neutral",
        "push",
        "pull"
    ]
}
Set
Request
Response
{
    "id": 411114,
    "jsonrpc": "2.0",
    "method": "mentalCommandActiveAction",
    "params": {
        "actions": [
            "push"
        ],
        "cortexToken": "xxx",
        "session": "1d5d3655-d570-4731-9faf-967bc5440dc5",
        "status": "set"
    }
}
{
    "id": 411114,
    "jsonrpc": "2.0",
    "result": {
        "actions": [
            "push"
        ],
        "message": "Set MentalCommand active actions successfully"
    }
}

facialExpressionThreshold

mentalCommandBrainMap

Last modified 2yr ago

Name	Type	Required	Description
cortexToken	`string`	yes	A token returned by authorize.
status	`string`	yes	Must be "set" or "get".
profile	`string`	no	A profile name.
session	`string`	no	A session id returned by createSession.
actions	`array of string`	no	If the status is "set", this parameter is the list of actions to activate. You can't activate more than 4 actions. This doesn't include "neutral".