neurosky

README

Neurosky

NeuroSky delivers fully integrated, single chip EEG biosensors. NeuroSky enables its partners and developers to bring their brainwave application ideas to market with the shortest amount of time, and lowest end consumer price.

This package contains the Gobot adaptor and driver for the Neurosky Mindwave Mobile EEG.

How to Install

Installing Gobot with Neurosky support is pretty easy.

go get -d -u gobot.io/x/gobot/... && go install gobot.io/x/gobot/platforms/neurosky

How To Connect

OSX

In order to allow Gobot running on your Mac to access the Mindwave, go to "Bluetooth > Open Bluetooth Preferences > Sharing Setup" and make sure that "Bluetooth Sharing" is checked.

Now you must pair with the Mindwave. Open System Preferences > Bluetooth. Now with the Bluetooth devices windows open, hold the On/Pair button on the Mindwave towards the On/Pair text until you see "Mindwave" pop up as available devices. Pair with that device. Once paired your Mindwave will be accessable through the serial device similarly named as /dev/tty.MindWaveMobile-DevA

Ubuntu

Connecting to the Mindwave from Ubuntu or any other Linux-based OS can be done entirely from the command line using Gort CLI commands. Here are the steps.

Find the address of the Mindwave, by using:

gort scan bluetooth

Pair to Mindwave using this command (substituting the actual address of your Mindwave):

gort bluetooth pair <address>

Connect to the Mindwave using this command (substituting the actual address of your Mindwave):

gort bluetooth connect <address>

Windows

You should be able to pair your Mindwave using your normal system tray applet for Bluetooth, and then connect to the COM port that is bound to the device, such as COM3.

How to Use

This small program lets you connect the Neurosky an load data.

package main

import (
	"fmt"

	"gobot.io/x/gobot"
	"gobot.io/x/gobot/platforms/neurosky"
)

func main() {
	adaptor := neurosky.NewAdaptor("/dev/rfcomm0")
	neuro := neurosky.NewDriver(adaptor)

	work := func() {
		gobot.On(neuro.Event("extended"), func(data interface{}) {
			fmt.Println("Extended", data)
		})
		gobot.On(neuro.Event("signal"), func(data interface{}) {
			fmt.Println("Signal", data)
		})
		gobot.On(neuro.Event("attention"), func(data interface{}) {
			fmt.Println("Attention", data)
		})
		gobot.On(neuro.Event("meditation"), func(data interface{}) {
			fmt.Println("Meditation", data)
		})
		gobot.On(neuro.Event("blink"), func(data interface{}) {
			fmt.Println("Blink", data)
		})
		gobot.On(neuro.Event("wave"), func(data interface{}) {
			fmt.Println("Wave", data)
		})
		gobot.On(neuro.Event("eeg"), func(data interface{}) {
			eeg := data.(neurosky.EEG)
			fmt.Println("Delta", eeg.Delta)
			fmt.Println("Theta", eeg.Theta)
			fmt.Println("LoAlpha", eeg.LoAlpha)
			fmt.Println("HiAlpha", eeg.HiAlpha)
			fmt.Println("LoBeta", eeg.LoBeta)
			fmt.Println("HiBeta", eeg.HiBeta)
			fmt.Println("LoGamma", eeg.LoGamma)
			fmt.Println("MidGamma", eeg.MidGamma)
			fmt.Println("\n")
		})
	}

	robot := gobot.NewRobot("brainBot",
		[]gobot.Connection{adaptor},
		[]gobot.Device{neuro},
		work,
	)

	robot.Start()
}

Documentation

Overview

Package neurosky contains the Gobot adaptor and driver for the Neurosky Mindwave Mobile EEG.

Installing:

go get gobot.io/x/gobot/platforms/neurosky

Example:

package main

import (
	"fmt"

	"gobot.io/x/gobot"
	"gobot.io/x/gobot/platforms/neurosky"
)

func main() {
	adaptor := neurosky.NewAdaptor("/dev/rfcomm0")
	neuro := neurosky.NewDriver(adaptor)

	work := func() {
		neuro.On(neuro.Event("extended"), func(data interface{}) {
			fmt.Println("Extended", data)
		})
		neuro.On(neuro.Event("signal"), func(data interface{}) {
			fmt.Println("Signal", data)
		})
		neuro.On(neuro.Event("attention"), func(data interface{}) {
			fmt.Println("Attention", data)
		})
		neuro.On(neuro.Event("meditation"), func(data interface{}) {
			fmt.Println("Meditation", data)
		})
		neuro.On(neuro.Event("blink"), func(data interface{}) {
			fmt.Println("Blink", data)
		})
		neuro.On(neuro.Event("wave"), func(data interface{}) {
			fmt.Println("Wave", data)
		})
		neuro.On(neuro.Event("eeg"), func(data interface{}) {
			eeg := data.(neurosky.EEG)
			fmt.Println("Delta", eeg.Delta)
			fmt.Println("Theta", eeg.Theta)
			fmt.Println("LoAlpha", eeg.LoAlpha)
			fmt.Println("HiAlpha", eeg.HiAlpha)
			fmt.Println("LoBeta", eeg.LoBeta)
			fmt.Println("HiBeta", eeg.HiBeta)
			fmt.Println("LoGamma", eeg.LoGamma)
			fmt.Println("MidGamma", eeg.MidGamma)
			fmt.Println("\n")
		})
	}

	robot := gobot.NewRobot("brainBot",
		[]gobot.Connection{adaptor},
		[]gobot.Device{neuro},
		work,
	)

	robot.Start()
}

For further information refer to neuroky README: https://gobot.io/x/gobot/blob/master/platforms/neurosky/README.md

Package neurosky is the Gobot platform for the Neurosky Mindwave EEG

Index

• Constants
• type Adaptor
  • func NewAdaptor(port string) *Adaptor
  • func (n *Adaptor) Connect() error
  • func (n *Adaptor) Finalize() (err error)
  • func (n *Adaptor) Name() string
  • func (n *Adaptor) Port() string
  • func (n *Adaptor) SetName(name string)
• type Driver
  • func NewDriver(a *Adaptor) *Driver
  • func (n *Driver) Connection() gobot.Connection
  • func (n *Driver) Halt() (err error)
  • func (n *Driver) Name() string
  • func (n *Driver) SetName(name string)
  • func (n *Driver) Start() (err error)
• type EEGData

Constants

const (
	// BTSync is the sync code
	BTSync byte = 0xAA

	// CodeEx Extended code
	CodeEx byte = 0x55

	// CodeSignalQuality POOR_SIGNAL quality 0-255
	CodeSignalQuality byte = 0x02

	// CodeAttention ATTENTION eSense 0-100
	CodeAttention byte = 0x04

	// CodeMeditation MEDITATION eSense 0-100
	CodeMeditation byte = 0x05

	// CodeBlink BLINK strength 0-255
	CodeBlink byte = 0x16

	// CodeWave RAW wave value: 2-byte big-endian 2s-complement
	CodeWave byte = 0x80

	// CodeAsicEEG ASIC EEG POWER 8 3-byte big-endian integers
	CodeAsicEEG byte = 0x83

	// Extended event
	Extended = "extended"

	// Signal event
	Signal = "signal"

	// Attention event
	Attention = "attention"

	// Meditation event
	Meditation = "meditation"

	// Blink event
	Blink = "blink"

	// Wave event
	Wave = "wave"

	// EEG event
	EEG = "eeg"

	// Error event
	Error = "error"
)

Types

type Adaptor

type Adaptor struct {
	// contains filtered or unexported fields
}

Adaptor is the Gobot Adaptor for the Neurosky Mindwave

func NewAdaptor

func NewAdaptor(port string) *Adaptor

NewAdaptor creates a neurosky adaptor with specified port

func (*Adaptor) Connect

func (n *Adaptor) Connect() error

Connect returns true if connection to device is successful

func (*Adaptor) Finalize

func (n *Adaptor) Finalize() (err error)

Finalize returns true if device finalization is successful

func (*Adaptor) Name

func (n *Adaptor) Name() string

Name returns the Adaptor Name

func (*Adaptor) Port

func (n *Adaptor) Port() string

Port returns the Adaptor port

func (*Adaptor) SetName

func (n *Adaptor) SetName(name string)

SetName sets the Adaptor Name

type Driver

type Driver struct {
	gobot.Eventer
	// contains filtered or unexported fields
}

Driver is the Gobot Driver for the Mindwave

func NewDriver

func NewDriver(a *Adaptor) *Driver

NewDriver creates a Neurosky Driver and adds the following events:

extended - user's current extended level
signal - shows signal strength
attention - user's current attention level
meditation - user's current meditation level
blink - user's current blink level
wave - shows wave data
eeg - showing eeg data

func (*Driver) Connection

func (n *Driver) Connection() gobot.Connection

Connection returns the Driver's connection

func (*Driver) Halt

func (n *Driver) Halt() (err error)

Halt stops neurosky driver (void)

func (*Driver) Name

func (n *Driver) Name() string

Name returns the Driver name

func (*Driver) SetName

func (n *Driver) SetName(name string)

SetName sets the Driver name

func (*Driver) Start

func (n *Driver) Start() (err error)

Start creates a go routine to listen from serial port and parse buffer readings

type EEGData

type EEGData struct {
	Delta    int
	Theta    int
	LoAlpha  int
	HiAlpha  int
	LoBeta   int
	HiBeta   int
	LoGamma  int
	MidGamma int
}

EEGData is the EEG raw data returned from the Mindwave