explorepy

Main API

Bluetooth API

A module for bluetooth connection

class bt_client.BtClient(device_name=None, mac_address=None)

Bases: object

Responsible for Connecting and reconnecting explore devices via bluetooth

Initialize Bluetooth connection

Parameters:

• device_name (str) – Name of the device (either device_name or device address should be given)
• mac_address (str) – Devices MAC address

connect()

Connect to the device and return the socket

Returns:socket (bluetooth.socket)

reconnect()

Reconnect to the last used bluetooth socket.

This function reconnects to the the last bluetooth socket. If after 1 minute the connection doesn’t succeed, program will end.

disconnect()

Disconnect from the device

_find_mac_address()

_find_service()

read(n_bytes)

Read n_bytes from the socket

Parameters:n_bytes (int) – number of bytes to be read Returns:list of bytes

send(data)

Send data to the device

Parameters:data (bytearray) – Data to be sent

static _check_mac_address(device_name, mac_address)

Parser

This module contains all packet classes of Mentalab Explore device

class packet.PACKET_ID

Bases: enum.IntEnum

Packet ID enum

ORN = 13

ENV = 19

TS = 27

DISCONNECT = 111

INFO = 99

EEG94 = 144

EEG98 = 146

EEG99S = 30

EEG99 = 62

EEG94R = 208

EEG98R = 210

CMDRCV = 192

CMDSTAT = 193

MARKER = 194

CALIBINFO = 195

class packet.Packet(timestamp, payload)

Bases: object

An abstract base class for Explore packet

Gets the timestamp and payload and initializes the packet object

Parameters:payload (bytearray) – a byte array including binary data and fletcher

_convert(bin_data)

Read the binary data and convert it to real values

_check_fletcher(fletcher)

Checks if the fletcher is valid

__str__()

Print the data/info

static int24to32(bin_data)

Converts binary data to int32

Parameters:bin_data (list) – list of bytes with the structure of int24 Returns:np.ndarray of int values

class packet.EEG(timestamp, payload)

Bases: packet.Packet

EEG packet class

Gets the timestamp and payload and initializes the packet object

Parameters:payload (bytearray) – a byte array including binary data and fletcher

calculate_impedance(imp_calib_info)

calculate impedance with the help of impedance calibration info

Parameters:imp_calib_info (dict) – dictionary of impedance calibration info including slope, offset and noise level

get_data(exg_fs=None)

get time vector and data

If exg_fs is given, it returns time vector and data. If exg_fs is not given, it returns the timestamp of the packet alongside with the data

get_impedances()

get electrode impedances

get_ptp()

Get peak to peak value

__str__()

Print the data/info

_check_fletcher(fletcher)

Checks if the fletcher is valid

_convert(bin_data)

Read the binary data and convert it to real values

static int24to32(bin_data)

Converts binary data to int32

Parameters:bin_data (list) – list of bytes with the structure of int24 Returns:np.ndarray of int values

class packet.EEG94(timestamp, payload)

Bases: packet.EEG

EEG packet for 4 channel device

_convert(bin_data)

Read the binary data and convert it to real values

_check_fletcher(fletcher)

Checks if the fletcher is valid

calculate_impedance(imp_calib_info)

calculate impedance with the help of impedance calibration info

Parameters:imp_calib_info (dict) – dictionary of impedance calibration info including slope, offset and noise level

get_data(exg_fs=None)

get time vector and data

If exg_fs is given, it returns time vector and data. If exg_fs is not given, it returns the timestamp of the packet alongside with the data

get_impedances()

get electrode impedances

get_ptp()

Get peak to peak value

static int24to32(bin_data)

Converts binary data to int32

Parameters:bin_data (list) – list of bytes with the structure of int24 Returns:np.ndarray of int values

class packet.EEG98(timestamp, payload)

Bases: packet.EEG

EEG packet for 8 channel device

_convert(bin_data)

Read the binary data and convert it to real values

_check_fletcher(fletcher)

Checks if the fletcher is valid

calculate_impedance(imp_calib_info)

calculate impedance with the help of impedance calibration info

Parameters:imp_calib_info (dict) – dictionary of impedance calibration info including slope, offset and noise level

get_data(exg_fs=None)

get time vector and data

If exg_fs is given, it returns time vector and data. If exg_fs is not given, it returns the timestamp of the packet alongside with the data

get_impedances()

get electrode impedances

get_ptp()

Get peak to peak value

static int24to32(bin_data)

Converts binary data to int32

Parameters:bin_data (list) – list of bytes with the structure of int24 Returns:np.ndarray of int values

class packet.EEG99s(timestamp, payload)

Bases: packet.EEG

EEG packet for 8 channel device

_convert(bin_data)

Read the binary data and convert it to real values

_check_fletcher(fletcher)

Checks if the fletcher is valid

calculate_impedance(imp_calib_info)

calculate impedance with the help of impedance calibration info

Parameters:imp_calib_info (dict) – dictionary of impedance calibration info including slope, offset and noise level

get_data(exg_fs=None)

get time vector and data

If exg_fs is given, it returns time vector and data. If exg_fs is not given, it returns the timestamp of the packet alongside with the data

get_impedances()

get electrode impedances

get_ptp()

Get peak to peak value

static int24to32(bin_data)

Converts binary data to int32

Parameters:bin_data (list) – list of bytes with the structure of int24 Returns:np.ndarray of int values

class packet.EEG99(timestamp, payload)

Bases: packet.EEG

EEG packet for 8 channel device

_convert(bin_data)

Read the binary data and convert it to real values

_check_fletcher(fletcher)

Checks if the fletcher is valid

calculate_impedance(imp_calib_info)

calculate impedance with the help of impedance calibration info

Parameters:imp_calib_info (dict) – dictionary of impedance calibration info including slope, offset and noise level

get_data(exg_fs=None)

get time vector and data

If exg_fs is given, it returns time vector and data. If exg_fs is not given, it returns the timestamp of the packet alongside with the data

get_impedances()

get electrode impedances

get_ptp()

Get peak to peak value

static int24to32(bin_data)

Converts binary data to int32

Parameters:bin_data (list) – list of bytes with the structure of int24 Returns:np.ndarray of int values

class packet.Orientation(timestamp, payload)

Bases: packet.Packet

Orientation data packet

_convert(bin_data)

Read the binary data and convert it to real values

_check_fletcher(fletcher)

Checks if the fletcher is valid

get_data(srate=None)

Get orientation timestamp and data

compute_angle(matrix=None)

Compute physical angle

static int24to32(bin_data)

Converts binary data to int32

Parameters:bin_data (list) – list of bytes with the structure of int24 Returns:np.ndarray of int values

class packet.Environment(timestamp, payload)

Bases: packet.Packet

Environment data packet

_convert(bin_data)

Read the binary data and convert it to real values

_check_fletcher(fletcher)

Checks if the fletcher is valid

get_data()

Get environment data

static _volt_to_percent(voltage)

static int24to32(bin_data)

Converts binary data to int32

Parameters:bin_data (list) – list of bytes with the structure of int24 Returns:np.ndarray of int values

class packet.TimeStamp(timestamp, payload)

Bases: packet.Packet

Time stamp data packet

_convert(bin_data)

Read the binary data and convert it to real values

_check_fletcher(fletcher)

Checks if the fletcher is valid

static int24to32(bin_data)

Converts binary data to int32

Parameters:bin_data (list) – list of bytes with the structure of int24 Returns:np.ndarray of int values

class packet.EventMarker(timestamp, payload)

Bases: packet.Packet

Marker packet

_convert(bin_data)

Read the binary data and convert it to real values

_check_fletcher(fletcher)

Checks if the fletcher is valid

get_data(srate=None)

Get marker data :Parameters: srate – NOT USED. Only for compatibility purpose

static int24to32(bin_data)

Converts binary data to int32

Parameters:bin_data (list) – list of bytes with the structure of int24 Returns:np.ndarray of int values

class packet.Disconnect(timestamp, payload)

Bases: packet.Packet

Disconnect packet

_convert(bin_data)

Disconnect packet has no data

_check_fletcher(fletcher)

Checks if the fletcher is valid

static int24to32(bin_data)

Converts binary data to int32

Parameters:bin_data (list) – list of bytes with the structure of int24 Returns:np.ndarray of int values

class packet.DeviceInfo(timestamp, payload)

Bases: packet.Packet

Device information packet

_convert(bin_data)

Read the binary data and convert it to real values

_check_fletcher(fletcher)

Checks if the fletcher is valid

get_info()

Get device information as a dictionary

get_data()

Get firmware version

static int24to32(bin_data)

Converts binary data to int32

Parameters:bin_data (list) – list of bytes with the structure of int24 Returns:np.ndarray of int values

class packet.CommandRCV(timestamp, payload)

Bases: packet.Packet

Command Status packet

_convert(bin_data)

Read the binary data and convert it to real values

_check_fletcher(fletcher)

Checks if the fletcher is valid

static int24to32(bin_data)

Converts binary data to int32

Parameters:bin_data (list) – list of bytes with the structure of int24 Returns:np.ndarray of int values

class packet.CommandStatus(timestamp, payload)

Bases: packet.Packet

Command Status packet

_convert(bin_data)

Read the binary data and convert it to real values

_check_fletcher(fletcher)

Checks if the fletcher is valid

static int24to32(bin_data)

Converts binary data to int32

Parameters:bin_data (list) – list of bytes with the structure of int24 Returns:np.ndarray of int values

class packet.CalibrationInfo(timestamp, payload)

Bases: packet.Packet

Calibration Info packet

_convert(bin_data)

Read the binary data and convert it to real values

get_info()

Get calibration info

_check_fletcher(fletcher)

Checks if the fletcher is valid

static int24to32(bin_data)

Converts binary data to int32

Parameters:bin_data (list) – list of bytes with the structure of int24 Returns:np.ndarray of int values

Dashboard

Additional tools