protocol.send_msg_headers— Send message headers

Overview

TODO

Implementation

class pybpodapi.com.protocol.send_msg_headers.SendMessageHeader[source]

Define names for message headers sent to the Bpod device.

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

HANDSHAKE = '6'

Request initialization handshake

FIRMWARE_VERSION = 'F'

Request firmware build number

RESET_CLOCK = '*'

Reset session clock

PAUSE_TRIAL = '$'

Pause ongoing trial (We recommend using computer-side pauses between trials, to keep data uniform)

GET_TIMESTAMP_TRANSMISSION = 'G'

Return timestamp transmission scheme

HARDWARE_DESCRIPTION = 'H'

Request hardware configuration

ENABLE_PORTS = 'E'

Request enable input ports

SYNC_CHANNEL_MODE = 'K'

Set sync channel and sync mode

NEW_STATE_MATRIX = 'C'

Send new compressed state matrix

RUN_STATE_MACHINE = 'R'

Request to run state matrix now

LOAD_SERIAL_MESSAGE = 'L'

Load serial message

RESET_SERIAL_MESSAGES = '>'

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

OVERRIDE_DIGITAL_HW_STATE = 'O'

Override digital hardware state

SEND_TO_HW_SERIAL = 'U'

Send byte to hardware serial channel 1-3

DISCONNECT = 'Z'

Request end of connection now

GET_MODULES = 'M'

Get the modules connected to bpod

SET_MODULE_RELAY = 'J'

Set module relay

WRITE_TO_MODULE = 'T'

Write to the module

ECHO_SOFTCODE = 'S'

Echo soft code

MANUAL_OVERRIDE_EXEC_EVENT = 'V'

Manual override: execute virtual event

TRIGGER_SOFTCODE = '~'

Trigger soft code

EXIT_AND_RETURN = 'X'

Exit state matrix and return data