Status Output

Contents

  1. 1 Overview
    1. 1.1 bluetooth_mac
    2. 1.2 bluetooth_fw
    3. 1.3 serialNumber
    4. 1.4 lastpreset
    5. 1.5 outputFrequency
    6. 1.6 seroutMode
    7. 1.7 eegChannelLayout
    8. 1.8 eegChannelCount
    9. 1.9 adcFrequency
    10. 1.10 downsampleRate
    11. 1.11 afe_gain
    12. 1.12 filterEnabled
    13. 1.13 notch
    14. 1.14 accelMode
    15. 1.15 accelRateLimit
    16. 1.16 errorFlags
    17. 1.17 sendErrorFlags
    18. 1.18 sendBatteryData
    19. 1.19 sendDrlRef
    20. 1.20 freqDrlRef
    21. 1.21 soc
    22. 1.22 voltage

Overview

The status output(from the "?" command) shows the configuration of Muse. This defines how to read everything sent to the client from Muse.
It is a newline-separated list of key/value ASCII-encoded pairs. Don't rely on the order and expect there might be undocumented key value pairs in the future. Designing like that will make your parser protected against error if something changes. The format is meant to be both human and machine readable.
The current values are:

bluetooth_mac

MAC address of the bluetooth module.
12 hex digits

bluetooth_fw

Firmware version of the bluetooth module
String

serialNumber

Muse serial number, matches with the laser etched serial number on the right ear pod.
String (14 characters)

lastpreset

Last preset ID that was sent to the headset.
Hex Integer

outputFrequency

Frequency of the EEG samples you will receive. Due to downsampling and filtering they might actually be sampled on the Muse faster.
Integer base 10

seroutMode

EEG output mode, either compressed or uncompressed. 2 for compressed output, 3 for uncompressed output.
Hexidecimal

eegChannelLayout

Channel order in the EEG packets.
02: DRL
03: REF
06: TP10
07: FP1
08: BAT
09: RIGHT_AUX
0A: LEFT_AUX
0B: TP9
0C: FP2
Dynamic length array, 2 hex digits for each element. String length equals (eegChannelCount x 2).

eegChannelCount

Number of channels in one EEG sample.
Decimal Integer

adcFrequency

Actual sampling frequency of the analog digital converter(ADC). Multiply this by eegChannelCount to get the actual sample frequency as only one channel can be sampled at a time.
Integer base 10

downsampleRate

Amount of downsampling performed on samples read by the analog digital converter(ADC).
Integer base 10

afe_gain

Gain of the analog front end. As EEG signals are very weak they are amplified. This can be used to calculate the actual voltage level of the signal.
Integer base 10

filterEnabled

True if the internal Muse filters are used, false otherwise. Muse can filter EMI radiation at 50hz or 60hz.
0 - False
1 - True
Integer Boolean

notch

Selected notch filter ID. Only valid if "filterEnabled" is true.
  • "407C" for 60Hz filter
  • "408C" for 50Hz filter
Hex Integer

accelMode

True if accelerometer enabled.
0 - disabled
1 - enabled
Integer Boolean

accelRateLimit

Downsampling of the accelerometer to limit the output rate. Currently unused.
Integer base 10

errorFlags

Internal field with information about error modes.
Hex Integer

sendErrorFlags

True if error flag packets will be sent in the data stream.
0 - False
1 - True
Integer Boolean

sendBatteryData

True if battery packets will be sent in the data stream.
0 - False
1 - True
Integer Boolean

sendDrlRef

True if DRL/REF flag packets will be sent in the data stream.
0 - False
1 - True
Integer Boolean

freqDrlRef

Frequency of the DRL/REF packets.
Integer base 10

soc

State of charge of the battery in (percent * 100). This can be used to initialize the starting value of the battery readout prior to receiving updates in the data streaming. 
Integer base 10

voltage

Voltage of the battery in millivolts(mV).
Integer base 10



Comments