1,668
edits
Changes
Jump to navigation
Jump to search
Line 1:
Line 1: + + + + + + + + + − + − + − | [[Media:BITSI_tempalte2015_duemilanove.zip|Code Template 2015 (Duemilanove)]] Line 12:
Line 20: − + + + Line 45:
Line 55: − |- − | Soundkey || S / s || 83 / 115 − |- − | Voicekey || V / v || 86 / 118 Line 56:
Line 62: − + Line 113:
Line 119: + + Line 176:
Line 184: − + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + − + + + − + Line 200:
Line 245: − + Line 211:
Line 256: − + − + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Line 246:
Line 339: + + + − + − function handle = buttonbox(cmd,varargin)+ − % to initialize connection:+ − % define settings as structure with fields:+ − % bb.Device = 'COM2';+ − % bb.BaudRate = 115200;+ − % bb.DataBits = 8;+ − % bb.StopBits = 1;+ − % bb.Parity = 'none'; − % handle = buttonbox('open',bb) − % − % to run: − % buttonbox('run',handle); − − % to close the connection: − % buttonbox('close',handle); − persistent old_hdl % keep handle to COM object persistent+ + + + + + + + + + + + + + − + − + − + − bb.DataBits = 8;+ − + − + + + + + + + − if nargin < 1+ − cmd = 'open';+ − end+ − if nargin > 1+ − % user overwrites default settings+ − flds = fields(varargin{1}); − for n = 1 : numel(flds) − bb.(flds{n}) = varargin{1}.(flds{n}); − end − end + + + + + − switch cmd+ − case 'open'+ − % get handle to serial device+ − handle = open_buttonbox(bb);+ − return − case 'close' − if nargin > 0 − handle = varargin{1}; − else − handle = old_hdl; − end − fclose(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' − % Initialize output figure − win = list_output(' ',[]); − while 1 − % Exit if user closed output figure − if ~ishandle(win) − return − end − % start polling for characters (indicating start of scan) − navailable = handle.BytesAvailable; − if navailable − data = []; − while navailable − % read incoming data − [newdata, cnt] = fread(handle, navailable); − % concatenate possible new data − if cnt − data = [data newdata(:)]; − end − % check if any more data left − navailable = handle.BytesAvailable; − end − % output info about which button was pressed − for n = 1 : numel(data) − line = sprintf('incoming: %03d %s',data(n),char(data(n))); − list_output(line,win); − end − end − pause(0.01); − end %while 1 − − function hdl = open_buttonbox(device) − % open handle to serial device (mini buttonbox) − try − hdl = serial(device.Device, 'Baudrate', device.BaudRate, 'DataBits', device.DataBits, 'StopBits', device.StopBits, 'Parity', device.Parity); − fopen(hdl); − catch − if ~isempty(old_hdl) − fclose(old_hdl); − delete(old_hdl); − end − hdl = serial(device.Device, 'Baudrate', device.BaudRate, 'DataBits', device.DataBits, 'StopBits', device.StopBits, 'Parity', device.Parity); − fopen(hdl); − end − old_hdl = hdl; − − fprintf('Wait for device buttonbox....\n'); − tic − while hdl.BytesAvailable && toc<10 − navailable = bbox.BytesAvailable; − % wait for welcome message device − fread(hdl, navailable); − end − pause(0.5); − end − − function win = list_output(line,win) − persistent ptr − persistent lines − persistent edt − Maxlines = 40; − − if isempty(win) − % initialize listbox output figure − lines = cell(1,Maxlines); − [lines(1:end)]=deal({''}); − ptr=Maxlines; − lines(ptr) = {'Buttonbox output:'}; − idxs = mod(ptr:ptr+Maxlines-1,Maxlines)+1; − − win = figure(); − % initialize figure to hold output text − edt = uicontrol('Parent',win,'Style','ListBox','HorizontalAlignment','left', ... − 'Max',Maxlines,'BackgroundColor',[1 1 1],'Visible','on','String',lines(idxs), ... − 'FontSize',12,'Value',Maxlines); − pos = get(win,'Position'); − set(edt,'Position',[1 1 pos(3) pos(4)]); − end − ptr = mod(ptr,Maxlines)+1; % start − lines{ptr} = line; − idxs = mod(ptr:ptr+Maxlines-1,Maxlines)+1; − set(edt,'String',lines(idxs),'Value',Maxlines); − drawnow; − end − − end − − ==Markers== − − ===Presentation=== − − See chapter 8 in the presentation workshop by clicking [[http://tsgdoc.socsci.ru.nl/images/9/9e/Programming_with_Presentation_2013.pdf here]]
no edit summary
{{Infobox tsg
| name = Buttonbox (2018)
| image = Buttonbox_2018_1.png
| caption = 2018 Buttonbox
| downloads = {{bulleted list
| [https://surfdrive.surf.nl/files/index.php/s/PPTKCyrjLkN4XUO Buttonbox 2018]
| [https://pypi.python.org/pypi/RuSocSci RuSocSci] (Python package)
}}
}}
{{Infobox tsg
{{Infobox tsg
| name = Buttonbox
| name = Buttonbox
| image = foto 1small.jpg
| image = Buttonbox 03s.png
| caption = 2013 Buttonbox
| caption = 2013 Buttonbox
| downloads = {{bulleted list
| downloads = {{bulleted list
| [[Buttonbox 2013 Hardware|Buttonbox 2013 Hardware Design]]
| [https://surfdrive.surf.nl/files/index.php/s/72XEcu2XKSgzxjp Buttonbox 2015]
| [https://pypi.python.org/pypi/RuSocSci RuSocSci] (Python package)
| [https://pypi.python.org/pypi/RuSocSci RuSocSci] (Python package)
}}
}}
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 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.
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 12 bits analog outputs and three 12 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.
There is currently a [[Microsoft Windows driver issue]].
== BITSI Protocol ==
== BITSI Protocol ==
|-
|-
| 8 || H / h || 72 / 104
| 8 || H / h || 72 / 104
|-
|-
|}
|}
===Output===
===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.'''
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 or com port opens. '''[2015]Press button H and A for simple mode and H and B for extended mode. [2018]Press button E and A for simple mode and E 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.
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 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.
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.
The inputs 1-8 will be pulled down from 5V to GND when the buttons are pressed. The outputs 9-16 will be pulled up from GND to 5V when the output is activated.
===Serial port===
===Serial port===
* Rate must be set 115200, Parity to None, Data Bits to 8 and Stop Bits to 1, Uncheck FIFO Interrupt.
* Rate must be set 115200, Parity to None, Data Bits to 8 and Stop Bits to 1, Uncheck FIFO Interrupt.
[[File:Buttonbox1.png]]
[[File:Buttonbox2.png]]
'''Testing Buttonbox'''
When pressing on the A button within the input channel tester. You will see the following ASCII code.
[[file:testbuttonbox.png]]
'''Adding Marker'''
[[file:output_buttonbox1.png | 800px]]
'''Testing Markers (output)'''
Send code 1 for Button A
[[file:output_buttonbox2.png]]
Button A will light up.
[[file:buttonboxledA.png | 200px]]
Send code 0 for clearing.
[[file:output_buttonbox3.png]]
'''Example PCL code you can program a handle to send a marker:'''
#handle:
output_port OutputPort = output_port_manager.get_port( 1 );
'''Example to send a marker:'''
OutputPort.send_code(100); #create a marker
for more information see chapter 8 in the presentation course by clicking [http://tsgdoc.socsci.ru.nl/images/9/9e/Programming_with_Presentation_2013.pdf here]
=== Python/PsychoPy ===
=== Python/PsychoPy ===
Download this site package to use the buttonbox: [https://pypi.python.org/pypi/RuSocSci rusocsci]
Download this site-package to use the buttonbox: [https://pypi.python.org/pypi/RuSocSci rusocsci]
or use in windows command 'pip install --upgrade rusocsci'
Example using buttons from the buttonbox in Python:
'''Example using buttons from the buttonbox in Python:'''
<syntaxhighlight lang="python" line>
<syntaxhighlight lang="python" line>
</syntaxhighlight>
</syntaxhighlight>
Example using markers with the buttonbox in Python:
'''Example using markers with the buttonbox in Python:'''
<syntaxhighlight lang="python" line>
<syntaxhighlight lang="python" line>
bb = buttonbox.Buttonbox()
bb = buttonbox.Buttonbox()
# wait for a single button press
# send a marker
bb.sendMarker(val=100) #This is your marker code, range code 1-255
bb.sendMarker(val=100) #This is your marker code, range code 1-255
</syntaxhighlight>
</syntaxhighlight>
<br/>Example using the Buttonbox in PsychoPy:
'''Example using BITSI extended in Python:'''
<syntaxhighlight lang="python" line>
#!/usr/bin/env python
# import the rusocsci.buttonbox module
from rusocsci import buttonbox
# make a buttonbox
bb = buttonbox.Buttonbox()
# select a function
bb.sendMarker(val=(ord('X'))) #select pulse time
bb.sendMarker(val=2) #set time of dureation pulse to 2ms
bb.sendMarker(val=(ord('M'))) #select marker out
bb.sendMarker(val=115) #set marker value 115
</syntaxhighlight>
'''Example using BITSI extended analog read in Python:'''
<syntaxhighlight lang="python" line>
#!/usr/bin/env python
# import the rusocsci.buttonbox module
import serial
# make a buttonbox
ser = serial.Serial("COM2", 115200, timeout = 0.10 )
ser = serial.Serial("/dev/ttyUSB0", 115200, timeout = 0.10 )
while True:
ser.write('A1')
ser.flush()
x = ser.readline()
visual.TextStim(win, text=x).draw()
# black screen for 1000 ms
win.flip()
key = event.getKeys()
try:
if key[0]=='escape':
break
except:
continue
</syntaxhighlight>
<br/>'''Example using the Buttonbox in PsychoPy:'''
<syntaxhighlight lang="python" line>
<syntaxhighlight lang="python" line>
For more documentation click here: http://pythonhosted.org//RuSocSci/index.html
For more documentation click here: http://pythonhosted.org//RuSocSci/index.html
<br>
<br>
=== Matlab ===
=== Matlab ===
'''Example using markers with the Buttonbox in Matlab:'''
<syntaxhighlight lang="matlab" line style="height:50em; overflow:auto;">
Download the file Bitsi.m from the DCCN website: https://intranet.donders.ru.nl/index.php?id=bitsim0
<br> Make sure to have this file in your Matlab path.
<syntaxhighlight lang="matlab" line style="overflow:auto;">
% At the start of your script, create the buttonbox serial object
bb = Bitsi("COM2");
% other code
:
</syntaxhighlight>
%
BITSI simple mode:
<syntaxhighlight lang="matlab" line style="overflow:auto;">
% This example is for an EEG system sampling at 500Hz samplerate.
% at the start of your script, reset marker
samplerate = 500;
pulseLen = 2000/samplerate; % get pulse time length for a 2 samples delay
bb.sendTrigger(0);
% send a marker
val = 1; % val: this is your marker code, range code 1-255
bb.sendTrigger(val);
java.lang.Thread.sleep(pulseLen); % wait long enough for the EEG system to capture the trigger, i.e., 2000/samplerate ms
% reset marker
bb.sendTrigger(0) % Note: if resetting the marker is not possible at this moment in code, you can decide to do this later as long as it has taken place long enough before the next marker has to be sent. Another solution using a timer object instead of a simple delay is outlined below.
</syntaxhighlight>
% set defaults
BITSI extended mode:
bb.Device = 'COM2';
<syntaxhighlight lang="matlab" line style="overflow:auto;">
bb.BaudRate = 115200;
samplerate = 500;
pulseLen = 2000/samplerate; % get pulse time length for a 2 samples delay
bb.StopBits = 1;
% select a function
bb.Parity = 'none';
bb.sendTrigger(uint8('X')); % select pulse time
bb.sendTrigger(pulseLen); % set time of duration pulse to (2000/samplerate) ms
val = 1; % val: this is your marker code, range code 1-255
bb.sendTrigger(uint8('M')); % select marker out
bb.sendTrigger(val); % val: this is your marker code, range code 1-255
</syntaxhighlight>
<syntaxhighlight lang="matlab" line style="overflow:auto;">
% At the end of your script, close the buttonbox serial object
:
bb.close();
</syntaxhighlight>
Reset marker using a timer:
<syntaxhighlight lang="matlab" line style="overflow:auto;">
% At the start of your script, define timer object and callback function
pulseTime = 0.004; % trigger pulse duration in s. NB: extra time will be added due to overhead in calling Matlab functions related to the timer event.
resetMarker = timer('TimerFcn',@(x,y)bb.sendTrigger(0),'StartDelay',pulseTime);
% replace the code to send a marker with:
val = 1; % val: this is your marker code, range code 1-255
bb.sendTrigger(val);
resetMarker.start(); % this will call bb.sendTrigger(0) after pulseTime seconds (plus some additional overhead)
</syntaxhighlight>
</syntaxhighlight>