libmushu.driver package

Submodules

libmushu.driver.emotiv module

class libmushu.driver.emotiv.Epoc

Bases: libmushu.amplifier.Amplifier

Methods

configure(**kwargs)	Configure the amplifier.
decrypt(raw)	Decrypt a raw package.
generate_key(sn[, research])	Generate the encryption key.
get_channels()	Return the list of channel names.
get_data()
get_sampling_frequency()	Return the sampling frequency.
is_available()
parse_raw(raw)	Parse raw data.
start()	Make the amplifier ready for delivering data.
stop()	Stop the amplifier.

decrypt(raw)

Decrypt a raw package.

generate_key(sn, research=True)

Generate the encryption key.

The key is based on the serial number of the device and the information weather it is a research- or consumer device.

get_data()

static is_available()

parse_raw(raw)

Parse raw data.

libmushu.driver.fsm module

class libmushu.driver.fsm.FSM(state_transition_table, current_state)

Bases: object

Methods

transition(transition)

transition(transition)

class libmushu.driver.fsm.Input

Bases: object

class libmushu.driver.fsm.State(name)

Bases: object

Finite-State Machine.

class libmushu.driver.fsm.Transition

Bases: object

Methods

transition(input)

transition(input)

libmushu.driver.gtec module

exception libmushu.driver.gtec.AmpError

Bases: exceptions.Exception

class libmushu.driver.gtec.GUSBamp

Bases: libmushu.amplifier.Amplifier

Methods

calculate_impedance(u_measured[, u_applied])
configure(**kwargs)	Configure the amplifier.
get_channels()
get_data()	Get data.
get_sampling_frequency()	Return the sampling frequency.
is_available()
set_calibration_mode(mode)
set_common_ground([a, b, c, d])	Set common ground for the electrodes.
set_common_reference([a, b, c, d])	Set common reference for the electrodes.
set_mode(mode)	Set mode, ‘impedance’, ‘data’.
set_sampling_ferquency(fs, channels, ...)	Set the sampling frequency and filters for individual channels.
set_slave_mode(slave)	Set amp into slave or master mode.
start()
stop()

calculate_impedance(u_measured, u_applied=10000.0)

get_channels()

get_data()

Get data.

static is_available()

set_calibration_mode(mode)

set_common_ground(a=False, b=False, c=False, d=False)

Set common ground for the electrodes.

Parameters:

a, b, c, d – correspond to the groups on the amp, either of them

can be true or false

set_common_reference(a=False, b=False, c=False, d=False)

Set common reference for the electrodes.

Parameters:

a, b, c, d – correspond to the groups on the amp, either of them

can be true or false

set_mode(mode)

Set mode, ‘impedance’, ‘data’.

set_sampling_ferquency(fs, channels, bpfilter, notchfilter)

Set the sampling frequency and filters for individual channels.

Parameters: fs – sampling frequency channels – list of booleans: channels[0] == True: enable filter for channel 0 bpfilter – tuple: parameters for the band pass filter (hp, lp, fs, order) or None notchfilter – tuple: parameters for the band stop filter (hp, lp, fs, order) or None

set_slave_mode(slave)

Set amp into slave or master mode.

Parameters:

slave – if true, set into slave mode, set to master otherwise

start()

stop()

libmushu.driver.gtec.main()

libmushu.driver.labstreaminglayer module

libmushu.driver.randomamp module

class libmushu.driver.randomamp.RandomAmp

Bases: libmushu.amplifier.Amplifier

An amplifier that produces random data.

Methods

configure(fs, channels)
get_channels()
get_data()
get_sampling_frequency()
is_available()
start()
stop()	Stop the amplifier.

configure(fs, channels)

elapsed

get_channels()

get_data()

get_sampling_frequency()

static is_available()

sample_len

start()

libmushu.driver.replayamp module

class libmushu.driver.replayamp.ReplayAmp

Bases: libmushu.amplifier.Amplifier

Methods

configure(data, marker, channels, fs)
get_channels()
get_data()	Returns:
get_sampling_frequency()
is_available()
start()
stop()

configure(data, marker, channels, fs)

get_channels()

get_data()

Returns:

chunk, markers: Markers is time in ms since relative to the :

first sample of that block. :

get_sampling_frequency()

static is_available()

start()

stop()

libmushu.driver.sinusamp module

class libmushu.driver.sinusamp.SinusAmp

Bases: libmushu.amplifier.Amplifier

An amplifier that produces sinus data.

Methods

configure(f, fs, channels)
get_channels()
get_data()
get_sampling_frequency()
is_available()
start()	Make the amplifier ready for delivering data.
stop()	Stop the amplifier.

configure(f, fs, channels)

elapsed

get_channels()

get_data()

get_sampling_frequency()

static is_available()

sample_len

Module contents

This package contains the low-level drivers for various amplifiers.

As a user, you’ll probably not deal with them directly but with their decorated counterparts via libmushu.__init__.get_amp().

If you want to use the low level drivers directly you can use it like this:

from libmushu.driver.randomamp import RandomAmp
amp = RandomAmp()

TODO: Add a ‘writing your own drivers’ section or tutorial.