LibMuse 6.0.3
Classes | Public Member Functions | List of all members
com.choosemuse.libmuse.MuseConfiguration Class Referenceabstract

Public Member Functions

abstract MusePreset getPreset ()
 
abstract String getHeadbandName ()
 
abstract String getMicrocontrollerId ()
 
abstract int getEegChannelCount ()
 
abstract int getAfeGain ()
 
abstract int getDownsampleRate ()
 
abstract int getSeroutMode ()
 
abstract int getOutputFrequency ()
 
abstract int getAdcFrequency ()
 
abstract boolean getNotchFilterEnabled ()
 
abstract NotchFrequency getNotchFilter ()
 
abstract int getAccelerometerSampleFrequency ()
 
abstract boolean getBatteryDataEnabled ()
 
abstract boolean getDrlRefEnabled ()
 
abstract int getDrlRefFrequency ()
 
abstract double getBatteryPercentRemaining ()
 
abstract String getBluetoothMac ()
 
abstract String getSerialNumber ()
 
abstract MuseModel getModel ()
 

Detailed Description

Encapsulates the configuration information of the Muse headband.

You must connect to the headband at least once to before this information is available. Once you have connected once the information will remain available, even after you disconnect.

Member Function Documentation

§ getAccelerometerSampleFrequency()

abstract int com.choosemuse.libmuse.MuseConfiguration.getAccelerometerSampleFrequency ( )
abstract

Returns accelerometer sample frequency in Hz.

Returns
The frequency of accelerometer samples.

§ getAdcFrequency()

abstract int com.choosemuse.libmuse.MuseConfiguration.getAdcFrequency ( )
abstract

The sample frequency of EEG packets (ADC) in Hz. A value of -1 means "unknown".

Returns
The ADC frequency of the headband.

§ getAfeGain()

abstract int com.choosemuse.libmuse.MuseConfiguration.getAfeGain ( )
abstract

Gain to apply to incoming EEG samples.

Returns
The gain that should be applied to incoming EEG samples.

§ getBatteryDataEnabled()

abstract boolean com.choosemuse.libmuse.MuseConfiguration.getBatteryDataEnabled ( )
abstract

Provides information about battery data transmission state (on/off).

Returns
true if the battery data transmission is enabled. false if it is not.

§ getBatteryPercentRemaining()

abstract double com.choosemuse.libmuse.MuseConfiguration.getBatteryPercentRemaining ( )
abstract

Returns battery charge remaining in percent.

Returns
The percentage of battery remaining.

§ getBluetoothMac()

abstract String com.choosemuse.libmuse.MuseConfiguration.getBluetoothMac ( )
abstract

Bluetooth MAC address reported by device.

Returns
The MAC address of the headband.

§ getDownsampleRate()

abstract int com.choosemuse.libmuse.MuseConfiguration.getDownsampleRate ( )
abstract

EEG downsampling rate. A value of -1 means "unknown".

Returns
The EEG downsampling rate.

§ getDrlRefEnabled()

abstract boolean com.choosemuse.libmuse.MuseConfiguration.getDrlRefEnabled ( )
abstract

Provides information about DRL/REF transmission state (on/off).

Returns
true if the DRL/REF data transmission is enabled. false if it is not.

§ getDrlRefFrequency()

abstract int com.choosemuse.libmuse.MuseConfiguration.getDrlRefFrequency ( )
abstract

DRL/REF data output frequency in Hz. 0 if DRL/REF is not enabled.

Returns
The frequency at which DRL/REF packets are transmitted.

§ getEegChannelCount()

abstract int com.choosemuse.libmuse.MuseConfiguration.getEegChannelCount ( )
abstract

Number of channels currently active.

Returns
The number of EEG channels currently active.

§ getHeadbandName()

abstract String com.choosemuse.libmuse.MuseConfiguration.getHeadbandName ( )
abstract

The name of the headband. This is only available on Muse 2016 ( MU_02 ).

Returns
The name of the headband.

§ getMicrocontrollerId()

abstract String com.choosemuse.libmuse.MuseConfiguration.getMicrocontrollerId ( )
abstract

Unique 96 bit ID identifying the microcontroller on the headband. This is only available on Muse 2016 ( MU_02 ).

Returns
The id of the microcontroller.

§ getModel()

abstract MuseModel com.choosemuse.libmuse.MuseConfiguration.getModel ( )
abstract

The headband model

Returns
The model of the headband.

§ getNotchFilter()

abstract NotchFrequency com.choosemuse.libmuse.MuseConfiguration.getNotchFilter ( )
abstract

Provides information about notch filter frequency (50Hz/60Hz).

Returns
The frequency of the notch filter.

§ getNotchFilterEnabled()

abstract boolean com.choosemuse.libmuse.MuseConfiguration.getNotchFilterEnabled ( )
abstract

Provides information about notch filter state (on/off).

Returns
true if the notch filter is enabled. false if it is not.

§ getOutputFrequency()

abstract int com.choosemuse.libmuse.MuseConfiguration.getOutputFrequency ( )
abstract

The output frequency of EEG packets in Hz.

Returns
The output frequency of EEG packets.

§ getPreset()

abstract MusePreset com.choosemuse.libmuse.MuseConfiguration.getPreset ( )
abstract

Provides access to current preset.

§ getSerialNumber()

abstract String com.choosemuse.libmuse.MuseConfiguration.getSerialNumber ( )
abstract

Serial number reported by device.

Returns
The device serial number.

§ getSeroutMode()

abstract int com.choosemuse.libmuse.MuseConfiguration.getSeroutMode ( )
abstract

Serial output mode. The relates to the size of the EEG packets transmitted from the headband. A value of 2 indicates that the packet data is compressed (10 bits). A value of 3 indicates that the packet data is uncompressed (16 bits). A value of -1 means "unknown".

Returns
2 if the data is compressed, 3 if the data is uncompressed or -1 if this value is unknown.
The documentation for this class was generated from the following file: