Skip to content

Latest commit

 

History

History
147 lines (91 loc) · 3.91 KB

MindwaveController.md

File metadata and controls

147 lines (91 loc) · 3.91 KB
Raw

Mindwave Unity - Controller

The MindwaveController makes the binding from Mindwave device and your app. It gets data from the socket (provided by ThinkGear Connector), and emit events for transmitting these informations.

Preview

MindwaveController preview from Unity's inspector

Usage

Integration

Using the MindwaveManager

You can just drag and drop the "MindwaveManager" prefab (at Plugins/MindwaveUnity/Utilities/MindwaveManager.prefab). MindwaveController is already correctly set.

You can also put the MindwaveManager component on a GameObject. An instance of MindwaveController will automatically be added to that GameObject.

Integration without MindwaveManager

Put this component on a GameObject. It's already ready to work.

Change the settings as you need.

Settings

Connection settings

The data are sent by ThinkGear Connector, and can be get from a web socket. MindwaveController uses System.Net.Sockets.TcpClient to connect and listen to this socket.

  • TCP Hostname: The hostname of TCP client. Default is 127.0.0.1.
  • TCP Port: The port of TCP client. Default is 13854.

Data stream settings

  • Try Connect At Start: Initializes the headset connection at the game start. Note: The connection with the headset will make your game drop some frames... You better initialize the connection to the Mindwave device in a dedicated lobby or loading screen.
  • Connection Timeout: Defines the timing before the connection to the headset should stop if unsuccessful.
  • Update Stream Rate: Defines the interval between each data update from the headset.

Debug settings

  • Show Data Packets: Displays in console the raw JSON packets' content from the headset.
  • Show Stream Errors: Displays in console the JSON packets' parsing errors. Errors usually happens because of incomplete JSON strings from ThinkGear Connector.

Scripting

Events

// public delegate void VoidDelegate()
public event VoidDelegate OnConnectMindwave

Triggered when the connection to Mindwave device is established.

// public delegate void VoidDelegate()
public event VoidDelegate OnDisconnectMindwave

Triggered when the connection to Mindwave device is lost (or Disconnect() has been called).

// public delegate void VoidDelegate()
public event VoidDelegate OnConnectionTimeout

Triggered when the connection to Mindwave device timeouts.

// public delegate void MindwaveDataDelegate(MidwaveDataModel)
public event MindwaveDataDelegate OnUpdateMindwaveData

Triggered when data are get from the Mindwave device.

// public delegate void IntValueDelegate(int)
public event IntValueDelegate OnUpdateRawEEG

Triggered when raw EEG (Electroencephalogram) data are get from the Mindwave device.

// public delegate void IntValueDelegate(int)
public event IntValueDelegate OnUpdateBlink

Triggered when blink strength info is get from the Mindwave device.

Methods

public void Connect()

Initializes the connection with the headset.

public void Disconnect()

Disconnects from the headset.

public bool IsConnecting { get; }

Checks if MindwaveController has initialized a connection to the headset.

public bool IsConnected { get; }

Checks if MindwaveController is connected to the headset.

public float TimeoutTimer { get; }

Gets the current timeout timer.

public float ConnectionTimeoutDelay { get; }

Gets the connection timeout delay.