== General ==

The buttonbox is used for time accurate(1ms) button press registration. We use it to register buttonpresses, soundkey, voicekey signals and to send tone onset, analog output, triggers with the BITSI protocol. It is suitable for Behavioral, EEG, MEG, and fMRI experiments. The buttonbox is connected to a computer with a usb connection.

The output connector has two binary eight bit ports: input and output. The two ports can be used for responses (input) and stimulus triggers (output). Two 8 bits analog outputs and three 8 bits analog inputs. The output connector has a sound and voicekey which triggers when a amplitude reaches a threshold. By using the serial port, the BITSI can be used platform independently: it works on Windows, Linux and Mac OSX. Most programming environments and stimulus packages support serial communication. 

== BITSI Protocol ==

BITSI stands for Bits to Serial Interface. Because the BITSI is designed to interface both in- and output signals, the 'protocol' is asymmetric: the input and output protocols differ. 

<u>'''Input'''</u>

The input port can be used to interface eight buttons maximally. Button presses are translated to serial output characters/bytes according to the following table:

{| border="0" cellspacing="0" cellpadding="0" width="462" style="width:462px;"
|-
| style="width:113px;height:22px;" |
'''Signal / Button'''

| style="width:170px;height:22px;" |
'''ASCII''' (rising / falling)

| style="width:180px;height:22px;" |
'''Code''' (rising / falling)

|-
| style="width:113px;height:22px;" |
1

| style="width:170px;height:22px;" |
A / a

| style="width:180px;height:22px;" |
65 / 97

|-
| style="width:113px;height:22px;" |
2

| style="width:170px;height:22px;" |
B / b

| style="width:180px;height:22px;" |
66 / 98

|-
| style="width:113px;height:22px;" |
3

| style="width:170px;height:22px;" |
C / c

| style="width:180px;height:22px;" |
67 / 99

|-
| style="width:113px;height:22px;" |
4

| style="width:170px;height:22px;" |
D / d

| style="width:180px;height:22px;" |
68 / 100

|-
| style="width:113px;height:22px;" |
5

| style="width:170px;height:22px;" |
E / e

| style="width:180px;height:22px;" |
69 / 101

|-
| style="width:113px;height:22px;" |
6

| style="width:170px;height:22px;" |
F / f

| style="width:180px;height:22px;" |
70 / 102

|-
| style="width:113px;height:22px;" |
7

| style="width:170px;height:22px;" |
G / g

| style="width:180px;height:22px;" |
71 / 103

|-
| style="width:113px;height:22px;" |
8

| style="width:170px;height:22px;" |
H / h

| style="width:180px;height:22px;" |
72 / 104

|-
| style="width:113px;height:22px;" |
SoundKey

| style="width:170px;height:22px;" |
S / s

| style="width:180px;height:22px;" |
83 / 115

|-
| style="width:113px;height:22px;" |
VoiceKey

| style="width:170px;height:22px;" |
V / v

| style="width:180px;height:22px;" |
86 / 118

|}

This means that when signal 1 gets /activated?, a capital A will be sent to the serial port. A lowercase 'a' will be sent when the signal is deactivated?. Mechanical buttons can be connected directly.

'''Output'''

Output knows two protocols: BITSI simple or BITSI extended. To enter a certain protocol two buttons have to be pressed when the BITSIbox is powered. Press button H and A for simple mode and H and B for extended mode.

If no button is pressed when powered it boots the last known protocol. In the simple protocol every byte sent to the BITSI over the serial port, is represented at the 8 bit output.

The '''extended''' protocol uses two bytes?, this combination can access two analog outputs and a tone generator. The first byte selects the output. The second byte determines the value written to this output.

{| border="1" cellspacing="0" cellpadding="0" width="434" style="width:434px;"
|-
| style="width:122px;height:22px;" |
'''Function'''

| style="width:161px;height:22px;" |
'''Byte 1 (ASCII / code)'''

| style="width:151px;height:22px;" |
'''Byte 2'''

|-
| style="width:122px;height:22px;" |
Marker out

| style="width:161px;height:22px;" |
M / 77

| style="width:151px;height:22px;" |
Marker value

|-
| style="width:122px;height:22px;" |
Analog out 1

| style="width:161px;height:22px;" |
Y / 89

| style="width:151px;height:22px;" |
Analog output value

|-
| style="width:122px;height:22px;" |
Analog out 2

| style="width:161px;height:22px;" |
Z / 90

| style="width:151px;height:22px;" |
Analog output value

|-
| style="width:122px;height:22px;" |
Tone

| style="width:161px;height:22px;" |
T / 84

| style="width:151px;height:22px;" |
Start tone

|-
| style="width:122px;height:22px;" |
Detect Sound

| style="width:161px;height:22px;" |
D

| style="width:151px;height:22px;" |
S / 83

|-
| style="width:122px;height:22px;" |
Detect Voice

| style="width:161px;height:22px;" |
D /

| style="width:151px;height:22px;" |
V / 83

|-
| style="width:122px;height:22px;" |
Calibrate Sound

| style="width:161px;height:22px;" |
C /

| style="width:151px;height:22px;" |
S

|-
| style="width:122px;height:22px;" |
Calibrate Voice

| style="width:161px;height:22px;" |
C /

| style="width:151px;height:22px;" |
V

|-
| style="width:122px;height:22px;" |
Analog in 1

| style="width:161px;height:22px;" |
A /

| style="width:151px;height:22px;" |
1

|-
| style="width:122px;height:22px;" |
Analog in 2

| style="width:161px;height:22px;" |
A /

| style="width:151px;height:22px;" |
2

|-
| style="width:122px;height:22px;" |
Analog in 3

| style="width:161px;height:22px;" |
A /

| style="width:151px;height:22px;" |
3

|-
| style="width:122px;height:22px;" |
Analog in 4

| style="width:161px;height:22px;" |
A /

| style="width:151px;height:22px;" |
4

|-
| style="width:122px;height:22px;" |
LEDs off

| style="width:161px;height:22px;" |
L /

| style="width:151px;height:22px;" |
X

|-
| style="width:122px;height:22px;" |
LEDs input

| style="width:161px;height:22px;" |
L /

| style="width:151px;height:22px;" |
I

|-
| style="width:122px;height:22px;" |
LEDs output

| style="width:161px;height:22px;" |
L /

| style="width:151px;height:22px;" |
O

|}

== '''Trigger port settings'''

[[File:]]

The 25 pins female connector has 8 inputs and 8 outputs, respectively 1-8 are inputs and 9-16 are outputs. Three analog input with an analog to digital convertor of 12 bit, pins 17,18,20 and 21. Two analog outputs with an digital to analog convertor of 12 bits on pins 22 and 23.

'''Serial port settings'''

Our hardware design allows to be connected to the computers USB and emulates a serial [[Port]].

{| border="0" cellpadding="0"
|-
|
'''Baudrate'''

| style="width:69px;" |
115200

|-
|
'''Parity'''

| style="width:69px;" |
none

|-
|
'''Data bits'''

| style="width:69px;" |
8

|-
|
'''Stop bits'''

| style="width:69px;" |
1

|-
|
'''Flow control'''

| style="width:69px;" |
none

|}

== ==

== USB-Com port settings ==

== TSG ButtonBox hardware 2013 ==

== TSG ButtonBox software 2013 ==

== Presentation Settings ==

{|
|-
| [[File:Buttonbox1.png]]
|}

== Psychopy Settings ==

<nowiki>
#!/usr/bin/env python

from psychopy import core, visual, event from rusocsci import buttonbox import logging, time

##Setup Section
#logging.getLogger().setLevel(logging.DEBUG) # use this for debug info

win = visual.Window([400,300], monitor="testMonitor") bb = buttonbox.Buttonbox()

##Experiment Section

b = bb.waitButtons(maxWait = 10.0, buttonList=['A']) print("b: {}".format(b))

##Cleanup Section

core.quit() The following script lights the LEDs under the buttons pressed.

#!/usr/bin/env python
#from __future__ import print_function

import logging, time, sys from rusocsci import buttonbox

##Setup Section

led = [False]*8

##Experiment Section

bb = buttonbox.Buttonbox() while True:

buttons = bb.getButtons()
if len(buttons):
for c in buttons:
if ord(c) >= ord('a') and ord(c) < ord('a')+8:
led[ord(c) - ord('a')] = False
elif ord(c) >= ord('A') and ord(c) < ord('A')+8:
led[ord(c) - ord('A')] = True
bb.setLeds(led)
#print("buttons ({:3d}): {}{}".format(len(buttons), buttons, " "*50), end="\r")
#sys.stdout.flush()</nowiki>

== Matlab Settings ==

<nowiki>
===================================================================================================
function handle = serial_buttonbox_common(cmd,varargin)
% to initialize connection:
% handle = serial_buttonbox('open',se)
% settings (se):
% define settings as a structure, i.e.:
% se.Device = 'COM1';
% se.BaudRate = 115200;
% se.DataBits = 8;
% se.StopBits = 1;
% se.Parity = 0;
% se.PTBPath = 'c:\MyToolboxes\PsychToolbox'
%
% to close the connection:
% serial_buttonbox('close',handle);

persistent old_hdl

% set defaults
se.Device = 'COM1';
se.BaudRate = 115200;
se.DataBits = 8;
se.StopBits = 1;
se.Parity = 0;
se.PTBPath = 'c:\Pgrogram Files\PsychToolbox';

if nargin < 1
cmd = 'open';
end
if nargin > 1
% user overwrites default settings
flds = fields(varargin{1});
for n = 1 : numel(flds)
se.(flds{n}) = varargin{1}.(flds{n});
end
end

switch cmd
case 'open'
addpath(genpath(se.PTBPath));
% get handle to serial device
handle = open_buttonbox(se.Device);
return
case 'close'
handle = varargin{1};
IOPort('close',handle);
return
case 'run'
% read incoming data
if isempty(old_hdl)
help serial_buttonbox_common
error('Buttonbox not yet initialized');
end
handle = old_hdl;
otherwise
fprintf('Unknown option %s\n',cmd);
return
end

% only gets here when cmd = 'run'
while 1
% start polling for characters (indicating start of scan)
navailable = IOPort('BytesAvailable', handle);
if navailable
data = [];
while navailable
% read incoming data
[newdata, ~, err] = IOPort('Read', handle, 0, navailable);
if ~isempty(err), disp(err); end
data = [data newdata];
%pause(0.001); % if possible just add a small pause to not claim entire core
navailable = IOPort('BytesAvailable', handle);
end
if numel(data)>1
fprintf('\nReceived characters: %d\n',numel(data));
end
for n = 1 : numel(data)
% disp(char(data(n)));
fprintf('incoming: %d\t%s\n',data(n),char(data(n)));
end
end

end %while 1

function hdl = open_buttonbox(device)
% open handle to serial device (mini buttonbox)
try
hdl = IOPort('OpenSerialPort',device,['BaudRate=' num2str(se.BaudRate)]);
catch
if ~isempty(old_hdl)
IOPort('close',old_hdl);
end
hdl = IOPort('OpenSerialPort',device,['BaudRate=' num2str(se.BaudRate)]);
end
old_hdl = hdl;

fprintf('Wait for device buttonbox....\n');
tic
while ~IOPort('BytesAvailable', hdl) && toc<10
% wait for welcome message device
end
pause(0.5);

% clear buffer
%IOPort('flush', hdl);
IOPort('purge', hdl);
end

end</nowiki>

== Inquisit Settings ==

Work in progress

== E-Prime ==

Work in progress

ButtonBox

2014-04-28T13:33:51Z

131.174.110.254:

== General ==

The buttonbox is used for time accurate(1ms) button press registration. We use it to register buttonpresses, soundkey, voicekey signals and to send tone onset, analog output, triggers with the BITSI protocol. It is suitable for Behavioral, EEG, MEG, and fMRI experiments. The buttonbox is connected to a computer with a usb connection.

The output connector has two binary eight bit ports: input and output. The two ports can be used for responses (input) and stimulus triggers (output). Two 8 bits analog outputs and three 8 bits analog inputs. The output connector has a sound and voicekey which triggers when a amplitude reaches a threshold. By using the serial port, the BITSI can be used platform independently: it works on Windows, Linux and Mac OSX. Most programming environments and stimulus packages support serial communication. 

== BITSI Protocol ==

BITSI stands for Bits to Serial Interface. Because the BITSI is designed to interface both in- and output signals, the 'protocol' is asymmetric: the input and output protocols differ. 

'''Input'''

The input port can be used to interface eight buttons maximally. Button presses are translated to serial output characters/bytes according to the following table:

{| border="0" cellspacing="0" cellpadding="0" width="462" style="width:462px;"
|-
| style="width:113px;height:22px;" |
'''Signal / Button'''

| style="width:170px;height:22px;" |
'''ASCII''' (rising / falling)

| style="width:180px;height:22px;" |
'''Code''' (rising / falling)

|-
| style="width:113px;height:22px;" |
1

| style="width:170px;height:22px;" |
A / a

| style="width:180px;height:22px;" |
65 / 97

|-
| style="width:113px;height:22px;" |
2

| style="width:170px;height:22px;" |
B / b

| style="width:180px;height:22px;" |
66 / 98

|-
| style="width:113px;height:22px;" |
3

| style="width:170px;height:22px;" |
C / c

| style="width:180px;height:22px;" |
67 / 99

|-
| style="width:113px;height:22px;" |
4

| style="width:170px;height:22px;" |
D / d

| style="width:180px;height:22px;" |
68 / 100

|-
| style="width:113px;height:22px;" |
5

| style="width:170px;height:22px;" |
E / e

| style="width:180px;height:22px;" |
69 / 101

|-
| style="width:113px;height:22px;" |
6

| style="width:170px;height:22px;" |
F / f

| style="width:180px;height:22px;" |
70 / 102

|-
| style="width:113px;height:22px;" |
7

| style="width:170px;height:22px;" |
G / g

| style="width:180px;height:22px;" |
71 / 103

|-
| style="width:113px;height:22px;" |
8

| style="width:170px;height:22px;" |
H / h

| style="width:180px;height:22px;" |
72 / 104

|-
| style="width:113px;height:22px;" |
SoundKey

| style="width:170px;height:22px;" |
S / s

| style="width:180px;height:22px;" |
83 / 115

|-
| style="width:113px;height:22px;" |
VoiceKey

| style="width:170px;height:22px;" |
V / v

| style="width:180px;height:22px;" |
86 / 118

|}

This means that when signal 1 gets /activated?, a capital A will be sent to the serial port. A lowercase 'a' will be sent when the signal is deactivated?. Mechanical buttons can be connected directly.

'''Output'''

Output knows two protocols: BITSI simple or BITSI extended. To enter a certain protocol two buttons have to be pressed when the BITSIbox is powered. Press button H and A for simple mode and H and B for extended mode.

If no button is pressed when powered it boots the last known protocol. In the simple protocol every byte sent to the BITSI over the serial port, is represented at the 8 bit output.

The '''extended''' protocol uses two bytes?, this combination can access two analog outputs and a tone generator. The first byte selects the output. The second byte determines the value written to this output.

{| border="1" cellspacing="0" cellpadding="0" width="434" style="width:434px;"
|-
| style="width:122px;height:22px;" |
'''Function'''

| style="width:161px;height:22px;" |
'''Byte 1 (ASCII / code)'''

| style="width:151px;height:22px;" |
'''Byte 2'''

|-
| style="width:122px;height:22px;" |
Marker out

| style="width:161px;height:22px;" |
M / 77

| style="width:151px;height:22px;" |
Marker value

|-
| style="width:122px;height:22px;" |
Analog out 1

| style="width:161px;height:22px;" |
Y / 89

| style="width:151px;height:22px;" |
Analog output value

|-
| style="width:122px;height:22px;" |
Analog out 2

| style="width:161px;height:22px;" |
Z / 90

| style="width:151px;height:22px;" |
Analog output value

|-
| style="width:122px;height:22px;" |
Tone

| style="width:161px;height:22px;" |
T / 84

| style="width:151px;height:22px;" |
Start tone

|-
| style="width:122px;height:22px;" |
Detect Sound

| style="width:161px;height:22px;" |
D

| style="width:151px;height:22px;" |
S / 83

|-
| style="width:122px;height:22px;" |
Detect Voice

| style="width:161px;height:22px;" |
D /

| style="width:151px;height:22px;" |
V / 83

|-
| style="width:122px;height:22px;" |
Calibrate Sound

| style="width:161px;height:22px;" |
C /

| style="width:151px;height:22px;" |
S

|-
| style="width:122px;height:22px;" |
Calibrate Voice

| style="width:161px;height:22px;" |
C /

| style="width:151px;height:22px;" |
V

|-
| style="width:122px;height:22px;" |
Analog in 1

| style="width:161px;height:22px;" |
A /

| style="width:151px;height:22px;" |
1

|-
| style="width:122px;height:22px;" |
Analog in 2

| style="width:161px;height:22px;" |
A /

| style="width:151px;height:22px;" |
2

|-
| style="width:122px;height:22px;" |
Analog in 3

| style="width:161px;height:22px;" |
A /

| style="width:151px;height:22px;" |
3

|-
| style="width:122px;height:22px;" |
Analog in 4

| style="width:161px;height:22px;" |
A /

| style="width:151px;height:22px;" |
4

|-
| style="width:122px;height:22px;" |
LEDs off

| style="width:161px;height:22px;" |
L /

| style="width:151px;height:22px;" |
X

|-
| style="width:122px;height:22px;" |
LEDs input

| style="width:161px;height:22px;" |
L /

| style="width:151px;height:22px;" |
I

|-
| style="width:122px;height:22px;" |
LEDs output

| style="width:161px;height:22px;" |
L /

| style="width:151px;height:22px;" |
O

|}

==
'''Trigger port settings'''

[[File:]]

The 25 pins female connector has 8 inputs and 8 outputs, respectively 1-8 are inputs and 9-16 are outputs. Three analog input with an analog to digital convertor of 12 bit, pins 17,18,20 and 21. Two analog outputs with an digital to analog convertor of 12 bits on pins 22 and 23.

'''Serial port settings'''

Our hardware design allows to be connected to the computers USB and emulates a serial [[port]][[File:file:///Z:/DCC-003-TD/pdwater/project/2013/Buttonbox2013/BITSIExtendedDocumentation2013_editmir.docx#_msocom_1|[mk1]]] .

{| border="0" cellpadding="0"
|-
|
'''Baudrate'''

| style="width:69px;" |
115200

|-
|
'''Parity'''

| style="width:69px;" |
none

|-
|
'''Data bits'''

| style="width:69px;" |
8

|-
|
'''Stop bits'''

| style="width:69px;" |
1

|-
|
'''Flow control'''

| style="width:69px;" |
none

|}

 
'''Presentation settings'''<div>
----
<div><div id="_com_1" uage="JavaScript">
 [[File:file:///Z:/DCC-003-TD/pdwater/project/2013/Buttonbox2013/BITSIExtendedDocumentation2013_editmir.docx#_msoanchor_1|[mk1]]]Nog invoegen waar je dit instelt/checkt?
</div></div></div> ==

== ==

== USB-Com port settings ==

== TSG ButtonBox hardware 2013 ==

== TSG ButtonBox software 2013 ==

== Presentation Settings ==

{|
|-
| [[File:Buttonbox1.png]]
|}

== Psychopy Settings ==

<nowiki>
#!/usr/bin/env python

from psychopy import core, visual, event from rusocsci import buttonbox import logging, time

##Setup Section
#logging.getLogger().setLevel(logging.DEBUG) # use this for debug info

win = visual.Window([400,300], monitor="testMonitor") bb = buttonbox.Buttonbox()

##Experiment Section

b = bb.waitButtons(maxWait = 10.0, buttonList=['A']) print("b: {}".format(b))

##Cleanup Section

core.quit() The following script lights the LEDs under the buttons pressed.

#!/usr/bin/env python
#from __future__ import print_function

import logging, time, sys from rusocsci import buttonbox

##Setup Section

led = [False]*8

##Experiment Section

bb = buttonbox.Buttonbox() while True:

buttons = bb.getButtons()
if len(buttons):
for c in buttons:
if ord(c) >= ord('a') and ord(c) < ord('a')+8:
led[ord(c) - ord('a')] = False
elif ord(c) >= ord('A') and ord(c) < ord('A')+8:
led[ord(c) - ord('A')] = True
bb.setLeds(led)
#print("buttons ({:3d}): {}{}".format(len(buttons), buttons, " "*50), end="\r")
#sys.stdout.flush()</nowiki>

== Matlab Settings ==

<nowiki>
===================================================================================================
function handle = serial_buttonbox_common(cmd,varargin)
% to initialize connection:
% handle = serial_buttonbox('open',se)
% settings (se):
% define settings as a structure, i.e.:
% se.Device = 'COM1';
% se.BaudRate = 115200;
% se.DataBits = 8;
% se.StopBits = 1;
% se.Parity = 0;
% se.PTBPath = 'c:\MyToolboxes\PsychToolbox'
%
% to close the connection:
% serial_buttonbox('close',handle);

persistent old_hdl

% set defaults
se.Device = 'COM1';
se.BaudRate = 115200;
se.DataBits = 8;
se.StopBits = 1;
se.Parity = 0;
se.PTBPath = 'c:\Pgrogram Files\PsychToolbox';

if nargin < 1
cmd = 'open';
end
if nargin > 1
% user overwrites default settings
flds = fields(varargin{1});
for n = 1 : numel(flds)
se.(flds{n}) = varargin{1}.(flds{n});
end
end

switch cmd
case 'open'
addpath(genpath(se.PTBPath));
% get handle to serial device
handle = open_buttonbox(se.Device);
return
case 'close'
handle = varargin{1};
IOPort('close',handle);
return
case 'run'
% read incoming data
if isempty(old_hdl)
help serial_buttonbox_common
error('Buttonbox not yet initialized');
end
handle = old_hdl;
otherwise
fprintf('Unknown option %s\n',cmd);
return
end

% only gets here when cmd = 'run'
while 1
% start polling for characters (indicating start of scan)
navailable = IOPort('BytesAvailable', handle);
if navailable
data = [];
while navailable
% read incoming data
[newdata, ~, err] = IOPort('Read', handle, 0, navailable);
if ~isempty(err), disp(err); end
data = [data newdata];
%pause(0.001); % if possible just add a small pause to not claim entire core
navailable = IOPort('BytesAvailable', handle);
end
if numel(data)>1
fprintf('\nReceived characters: %d\n',numel(data));
end
for n = 1 : numel(data)
% disp(char(data(n)));
fprintf('incoming: %d\t%s\n',data(n),char(data(n)));
end
end

end %while 1

function hdl = open_buttonbox(device)
% open handle to serial device (mini buttonbox)
try
hdl = IOPort('OpenSerialPort',device,['BaudRate=' num2str(se.BaudRate)]);
catch
if ~isempty(old_hdl)
IOPort('close',old_hdl);
end
hdl = IOPort('OpenSerialPort',device,['BaudRate=' num2str(se.BaudRate)]);
end
old_hdl = hdl;

fprintf('Wait for device buttonbox....\n');
tic
while ~IOPort('BytesAvailable', hdl) && toc<10
% wait for welcome message device
end
pause(0.5);

% clear buffer
%IOPort('flush', hdl);
IOPort('purge', hdl);
end

end</nowiki>

== Inquisit Settings ==

Work in progress

== E-Prime ==

Work in progress

ButtonBox

2014-04-28T13:28:54Z

131.174.110.254: