tools_icon MuseIO | Command Line Options

Basic Options

  --help                 Produce help message.

  --version              Print out version and exit.

  --available-presets    Print out details of preset configurations.

Renaming Your Device

  --rename-device arg    Set the bluetooth device name, requires --device 
                         <name>.

Change the Bluetooth name, 2-30 characters, may consist of alphanumeric and “-_.”

Connecting to a Muse

  --device arg           Case-insensitive bluetooth MAC or device name to 
                         connect to.

  --device-search arg    Case-insensitive bluetooth MAC or device name search 
                         pattern (e.g 'muse').

  --com arg              Windows-only option for connecting to the Windows COM 
                         port that is created by pairing.  This may work if 
                         Bluetooth does not.

Example: To use the com port option to connect to com4 it would be like:

muse-io.exe –com 4 

  --no-retry             Exit instead of immediately attempting a new bluetooth
                         connection when the current session completes.

Muse-IO will usually try to reconnect if the connection is lost. This option will cause Muse-IO to only try to connect once and then exit.

  --preset arg           Set the state of the Muse.

Click here for the list of available presets.

Filtering Electrical Noise

  --50hz                 digital filters, when enabled, will use a 50Hz notch

  --60hz                 digital filters, when enabled, will use a 60Hz notch

Algorithm Options

  --dsp                  Enable processing algorithms (default).

This will output Muse Element processed values as described on this page.

  --no-dsp               Disable processing algorithms.

Disable processing of Muse Element algorithm values.

OSC Options

  --osc arg              Output all data types(EEG/ACC/Status/Battery) to OSC. 
                         Multiple URLs can be specified, comma delimited. Do 
                         not include a path.
                         e.g. 'osc.tcp://localhost:4444,...'

  --osc-status arg       Number of seconds between emitting status and config 
                         messages, default is ten seconds.

  --osc-acc-urls arg     Output accelerometer to OSC. Multiple URLs can be specified, comma delimited, with a path.
                         e.g. ‘osc.tcp://localhost:4444/dsp/ac,…’

  --osc-status-urls arg  Output status messages to OSC. Multiple URLs can be 
                         specified, comma delimited, with a path.
                         e.g. 'osc.tcp://localhost:4444/stat/muse1,...'

  --osc-config-urls arg  Output configuration state messages to OSC. Multiple 
                         URLs can be specified, comma delimited, with a path.
                         e.g. 'osc.tcp://localhost:4444/cfg/muse1,...'

  --osc-battery-urls arg Output battery messages to OSC. Multiple URLs can be 
                         specified, comma delimited, with a path.
                         e.g. 'osc.tcp://localhost:4444/batt/muse1,...'

  --osc-drlref-urls arg  Output compression quantization messages to OSC. 
                         Multiple URLs can be specified, comma delimited, with a path.
                         e.g. 'osc.tcp://localhost:4444/dsp/eeg,...'

  --osc-eeg-urls arg     Output EEG messages to OSC. Multiple URLs can be 
                         specified, comma delimited, with a path.
                         e.g. 'osc.tcp://localhost:4444/dsp/eeg,...'

  --osc-quant-urls arg   Output EEG messages to OSC. Multiple URLs can be 
                         specified, comma delimited, with a path.
                         e.g. 'osc.tcp://localhost:4444/dsp/eeg,...'

  --osc-eeg-path arg     OSC EEG message path.

  --osc-acc-path arg     OSC accelerometer message path.

  --osc-status-path arg  OSC status message path.

  --osc-battery-path arg OSC battery message path.

  --osc-drlref-path arg  OSC drlref message path.

  --osc-bp-urls arg      Output MuseElements messages to OSC. Multiple URLs can be
                         specified, comma delimited, with a path.
                         e.g. 'osc.tcp://localhost:4444/dsp/bp,...'

  --osc-bp-path arg      OSC MuseElements DSP messages path.

  --osc-enable-dropped   Output dropped sample information. This will append 
                         '/dropped' to the OSC paths specified.

  --osc-int              OSC samples will be output as fixed point values rather then the default floating point.

  --osc-cmd-port arg     OSC listen port for incoming Muse commands. These 
                         commands will be sent to the Muse.

  --osc-quant-path arg   Output quantization magnitude from compression protocol.

  --osc-timestamp        OSC messages will include a timetag as the last 
                         argument

LSL Options

  --lsl-eeg arg          Output EEG to Lab Streaming Layer using this label.
                         e.g. 'EEG'

  --lsl-acc arg          Output accelerometer data to Lab Streaming Layer using this label.
                         e.g. 'AC'

Options you will probably never use

These are used primarily for internal testing at Interaxon.

  --no-scale             Disable scaling EEG values to nanovolts. Transmit data using proprietary data.

  --upgrade-hex arg      Path to a headset upgrade image.

This is an internal tool for updating Muse firmware. It is not currently usable by the public. The only way to upgrade Muse firmware is through the Muse application.

  --cmds arg             additional headset commands to send after the preset

  --no-ansi              Do not mark-up status text with ansi codes.

  --verbose              Enable extra state and debug print outs.

  --tty arg              TTY device file to open.