SendMessageHeader

class SendMessageHeader

Bases: object

Define names for message headers sent to the Bpod device.

The message header is the first byte (character) on a message sent.

__init__()

Methods

__init__()

Attributes

DISCONNECT	Request end of connection now
ECHO_SOFTCODE	Echo soft code
ENABLE_PORTS	Request enable input ports
EXIT_AND_RETURN	Exit state matrix and return data
FIRMWARE_VERSION	Request firmware build number
GET_MODULES	Get the modules connected to bpod
GET_TIMESTAMP_TRANSMISSION	Return timestamp transmission scheme
HANDSHAKE	Request initialization handshake
HARDWARE_DESCRIPTION	Request hardware configuration
LOAD_SERIAL_MESSAGE	Load serial message
MANUAL_OVERRIDE_EXEC_EVENT	execute virtual event
NEW_STATE_MATRIX	Send new compressed state matrix
OVERRIDE_DIGITAL_HW_STATE	Override digital hardware state
PAUSE_TRIAL
RESET_CLOCK	Reset session clock
RESET_SERIAL_MESSAGES	Reset serial messages to equivalent byte codes (i.e. message# 4 = one byte, 0x4).
RUN_STATE_MACHINE	Request to run state matrix now
SEND_TO_HW_SERIAL	Send byte to hardware serial channel 1-3
SET_MODULE_RELAY	Set module relay
SYNC_CHANNEL_MODE	Set sync channel and sync mode
TRIGGER_SOFTCODE	Trigger soft code
WRITE_TO_MODULE	Write to the module

DISCONNECT = 'Z'

Request end of connection now

ECHO_SOFTCODE = 'S'

Echo soft code

ENABLE_PORTS = 'E'

Request enable input ports

EXIT_AND_RETURN = 'X'

Exit state matrix and return data

FIRMWARE_VERSION = 'F'

Request firmware build number

GET_MODULES = 'M'

Get the modules connected to bpod

GET_TIMESTAMP_TRANSMISSION = 'G'

Return timestamp transmission scheme

HANDSHAKE = '6'

Request initialization handshake

HARDWARE_DESCRIPTION = 'H'

Request hardware configuration

LOAD_SERIAL_MESSAGE = 'L'

Load serial message

MANUAL_OVERRIDE_EXEC_EVENT = 'V'

execute virtual event

Type:

Manual override

NEW_STATE_MATRIX = 'C'

Send new compressed state matrix

OVERRIDE_DIGITAL_HW_STATE = 'O'

Override digital hardware state

RESET_CLOCK = '*'

Reset session clock

RESET_SERIAL_MESSAGES = '>'

Reset serial messages to equivalent byte codes (i.e. message# 4 = one byte, 0x4)

RUN_STATE_MACHINE = 'R'

Request to run state matrix now

SEND_TO_HW_SERIAL = 'U'

Send byte to hardware serial channel 1-3

SET_MODULE_RELAY = 'J'

Set module relay

SYNC_CHANNEL_MODE = 'K'

Set sync channel and sync mode

TRIGGER_SOFTCODE = '~'

Trigger soft code

WRITE_TO_MODULE = 'T'

Write to the module