1,658
edits
Changes
Jump to navigation
Jump to search
Line 1:
Line 1: − + + + + + + + + + + + + + + + + + + − + − {|+ − |- − | [[File:foto 1small.jpg|200px|Image: 200 pixels]] − | [[File:foto 2 small.jpg|200px|Image: 200 pixels]] − |} − 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. + − + − <u>'''Input'''</u>+ − + + + − | 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;" | − 7 − − | style="width:170px;height:22px;" | − G / g − − | style="width:180px;height:22px;" | − 71 / 103 − − + − 8 − − − H / h − − − 72 / 104 − − + − SoundKey − − − S / s − − − 83 / 115 − − | style="width:113px;height:22px;" | − VoiceKey − − | style="width:170px;height:22px;" | − V / v − − | style="width:180px;height:22px;" | − 86 / 118 − − + − <u>'''Output'''</u>+ − + − + − + − + − {| border="1" cellspacing="0" cellpadding="0" width="434" style="width:434px;"+ + + + + + + + + − + − '''Function''' − − − '''Byte 1 (ASCII / code)''' − − − '''Byte 2''' − − + − Marker out − − − M / 77 − − − Marker value − − + − − − − Y / 89 − − − − − + − Analog out 2 − − − Z / 90 − − − Analog output value − − + − Tone − − − T / 84 − − − Start tone − − + − − − − − − − S / 83 − − + − Detect Voice − − − D / − − − V / 83 − − + − − − − − − − S − − + − Calibrate Voice − − − C / − − − V − − + − − − − − − − 1 − − + − − − − − − − 2 − − + − − − − − − − 3 − − + − Analog in 4 − − − A / − − − 4 − − + − − − − − − − X − − + − − − − − − − I − − + − LEDs output − | style="width:161px;height:22px;" | + − L / − | style="width:151px;height:22px;" | + − O − + − <u>'''Trigger port settings'''</u>+ − [[File:Connector.png|300x300px|Connector.png]]+ − 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.+ − <u>'''Serial port settings'''</u>+ − Our hardware design allows to be connected to the computers USB and emulates a serial [[Port]].+ − + − + − + − '''Baudrate''' − − − 115200 − − + − '''Parity''' − − − none − − + − '''Data bits''' − − − 8 − − + − '''Stop bits''' − − − 1 − − | − '''Flow control''' − − | style="width:69px;" | − none − − + Line 391:
Line 176: − + − Find the hardware design here [[Buttonbox 2013 Hardware|Buttonbox_2013_Hardware]]+ − == TSG ButtonBox software 2013 ==+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + − Find the code here [[Media:BITSI_tempalte2013_duemilanove.zip]]+ − + + − The experiment files needs a few settings for the device to work:+ − * In the settings tab: port -> input port -> 1 must be the device that identifies itself as "Arduino Uno" in the device manager. Note that the port must have a number not higher than 10 (COM1-COM10). Use re-enumerate if it is higher.+ − * Rate must be set 115200, Parity to None, Data Bits to 8 and Stop Bits to 1, Uncheck FIFO Interrupt.+ + + + + − {|+ − |- − | [[File:Buttonbox1.png]] − |} − == Buttonbox in Python and PsychoPy ==+ − Download this site package to use the buttonbox: [https://pypi.python.org/pypi/RuSocSci rusocsci] − + − <nowiki>+ Line 428:
Line 242: − + + + + + + + + + + + + + + + + + + + − Example using markers with the buttonbox in Python:+ − <nowiki> Line 440:
Line 271: − + − + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + − + − <nowiki>+ Line 471:
Line 335: − + + − + + + + + − <nowiki>+ − ===================================================================================================+ − function handle = serial_buttonbox_common(cmd,varargin)+ − % to initialize connection:+ − + − % 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)); − − 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>
no edit summary
== General ==
{{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
| name = Buttonbox
| image = Buttonbox 03s.png
| caption = 2013 Buttonbox
| downloads = {{bulleted list
| [https://surfdrive.surf.nl/files/index.php/s/72XEcu2XKSgzxjp Buttonbox 2015]
| [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 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 ==
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.
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:
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="1" cellspacing="0" cellpadding="0" width="462" style="width:462px;"
{| class="wikitable"
|-
! scope="row" colspan="3" | BITSI Simple
|-
|-
! scope="row" width="120px" | Signal/Button
! scope="row" width="120px" | ASCII (rise/fall)
! scope="row" width="120px" | Code (rise/fall)
|-
|-
| style="width:113px;height:22px;" |
| 1 || A / a || 65 / 97
1
| style="width:170px;height:22px;" |
A / a
| style="width:180px;height:22px;" |
65 / 97
|-
|-
| style="width:113px;height:22px;" |
| 2 || B / b || 66 / 98
2
| style="width:170px;height:22px;" |
B / b
| style="width:180px;height:22px;" |
66 / 98
|-
|-
| style="width:113px;height:22px;" |
| 3 || C / c || 67 / 99
3
| style="width:170px;height:22px;" |
C / c
| style="width:180px;height:22px;" |
67 / 99
|-
|-
| style="width:113px;height:22px;" |
| 4 || D / d || 68 / 100
4
| style="width:170px;height:22px;" |
D / d
| style="width:180px;height:22px;" |
68 / 100
|-
|-
| style="width:113px;height:22px;" |
| 5 || E / e || 69 / 101
5
| style="width:170px;height:22px;" |
E / e
| style="width:180px;height:22px;" |
69 / 101
|-
|-
| style="width:113px;height:22px;" |
| 6 || F / f || 70 / 102
6
| style="width:170px;height:22px;" |
F / f
| style="width:180px;height:22px;" |
70 / 102
|-
|-
| style="width:113px;height:22px;" |
| 7 || G / g || 71 / 103
| style="width:170px;height:22px;" |
| style="width:180px;height:22px;" |
|-
|-
| style="width:113px;height:22px;" |
| 8 || H / h || 72 / 104
| style="width:170px;height:22px;" |
| style="width:180px;height:22px;" |
|-
|-
|}
|}
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.
This means that when signal 1 gets active(button press), a capital A will be sent to the serial port. A lowercase 'a' will be sent when the signal is deactivated(button release). 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.
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 '''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.
The '''extended''' protocol uses two bytes(or two characters), 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.
{| class="wikitable"
|-
! scope="row" colspan="3" | BITSI Extended
|-
! scope="row" width="120px" | Function
! scope="row" width="150px" | Byte 1 (ASCII/code)
! scope="row" width="150px" | Byte 2
|-
| Marker Out || M / 77 || Marker Value
|-
| Pulse Out || P / 80 || Marker Value
|-
|-
| style="width:122px;height:22px;" |
| Pulse Time || X / 88 || ms before pulse reset
| style="width:161px;height:22px;" |
| style="width:151px;height:22px;" |
|-
|-
| style="width:122px;height:22px;" |
| Analog Out 1 || Y / 89 || Analog Output Value
| style="width:161px;height:22px;" |
| style="width:151px;height:22px;" |
|-
|-
| style="width:122px;height:22px;" |
| Analog Out 2 || Z / 90 || Analog Output Value
Analog out 1
| style="width:161px;height:22px;" |
| style="width:151px;height:22px;" |
Analog output value
|-
|-
| style="width:122px;height:22px;" |
| Tone || T / 84 || Start Tone
| style="width:161px;height:22px;" |
| style="width:151px;height:22px;" |
|-
|-
| style="width:122px;height:22px;" |
| Detect Sound || D / || S / 83
| style="width:161px;height:22px;" |
| style="width:151px;height:22px;" |
|-
|-
| style="width:122px;height:22px;" |
| Detect Voice || D / || V / 83
Detect Sound
| style="width:161px;height:22px;" |
D
| style="width:151px;height:22px;" |
|-
|-
| style="width:122px;height:22px;" |
| Calibrate Sound || C / || S
| style="width:161px;height:22px;" |
| style="width:151px;height:22px;" |
|-
|-
| style="width:122px;height:22px;" |
| Calibrate Voice || C / || V
Calibrate Sound
| style="width:161px;height:22px;" |
C /
| style="width:151px;height:22px;" |
|-
|-
| style="width:122px;height:22px;" |
| Analog In 1 || A / || 1
| style="width:161px;height:22px;" |
| style="width:151px;height:22px;" |
|-
|-
| style="width:122px;height:22px;" |
| Analog In 2 || A / || 2
Analog in 1
| style="width:161px;height:22px;" |
A /
| style="width:151px;height:22px;" |
|-
|-
| style="width:122px;height:22px;" |
| Analog In 3 || A / || 3
Analog in 2
| style="width:161px;height:22px;" |
A /
| style="width:151px;height:22px;" |
|-
|-
| style="width:122px;height:22px;" |
| Analog In 4 || A / || 4
Analog in 3
| style="width:161px;height:22px;" |
A /
| style="width:151px;height:22px;" |
|-
|-
| style="width:122px;height:22px;" |
| LEDs Off || L / || X
| style="width:161px;height:22px;" |
| style="width:151px;height:22px;" |
|-
|-
| style="width:122px;height:22px;" |
| LEDs Input || L / || I
LEDs off
| style="width:161px;height:22px;" |
L /
| style="width:151px;height:22px;" |
|-
|-
| style="width:122px;height:22px;" |
| LEDs Output || L / || O
LEDs input
| style="width:161px;height:22px;" |
L /
| style="width:151px;height:22px;" |
|-
|-
| style="width:122px;height:22px;" |
|}
== Port Settings ==
===Trigger port ===
|}
[[File:Connector.png|thumb|300x300px|Schematic view of the 25 pins connector]]
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===
Our hardware design allows to be connected to the computers USB and emulates a serial communication Port.
{| class="wikitable"
|-
{| border="1" cellspacing="0" cellpadding="0"
| Baudrate || 115200
|-
|-
|
| Parity || None
| style="width:69px;" |
|-
|-
|
| Data bits || 8
| style="width:69px;" |
|-
|-
|
| Stop bits || 1
| style="width:69px;" |
|-
|-
|
| Flow control || None
| style="width:69px;" |
|-
|-
|}
|}
== USB-Com port settings ==
=== USB-Com port ===
1.Connect the BITSIbox to your computer using the USB cable.
1.Connect the BITSIbox to your computer using the USB cable.
Always connect the usb device to the same port and your settings will be remembered.
Always connect the usb device to the same port and your settings will be remembered.
== TSG ButtonBox hardware 2013 ==
== Software Settings ==
=== Neurobs Presentation ===
The experiment files needs a few settings for the device to work:
* In the settings tab: port -> input port -> 1 must be the device that identifies itself as "Arduino Uno" in the device manager. Note that the port must have a number not higher than 10 (COM1-COM10). Use re-enumerate if it is higher.
* Rate must be set 115200, Parity to None, Data Bits to 8 and Stop Bits to 1, Uncheck FIFO Interrupt.
[[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:'''
== Presentation Settings ==
#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 ===
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>
#!/usr/bin/env python
#!/usr/bin/env python
# print the button pressed
# print the button pressed
print("b: {}".format(b)) </nowiki>
print("b: {}".format(b))
</syntaxhighlight>
'''Example using markers with the buttonbox 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()
# send a marker
bb.sendMarker(val=100) #This is your marker code, range code 1-255
</syntaxhighlight>
'''Example using BITSI extended in Python:'''
<syntaxhighlight lang="python" line>
#!/usr/bin/env python
#!/usr/bin/env python
bb = buttonbox.Buttonbox()
bb = buttonbox.Buttonbox()
# wait for a single button press
# select a function
bb.sendMarker(100) #This is your marker code, range code 1-255 </nowiki>
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>
Example using the Buttonbox in PsychoPy:
<br/>'''Example using the Buttonbox in PsychoPy:'''
<syntaxhighlight lang="python" line>
#!/usr/bin/env python
#!/usr/bin/env python
## Cleanup Section
## Cleanup Section
core.quit() </nowiki>
core.quit()
</syntaxhighlight>
== Matlab Settings ==
For more documentation click here: http://pythonhosted.org//RuSocSci/index.html
<br>
<br>
=== Matlab ===
'''Example using markers with the Buttonbox in Matlab:'''
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
% handle = serial_buttonbox('open',se)
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;
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.
</syntaxhighlight>
BITSI extended mode:
<syntaxhighlight lang="matlab" line style="overflow:auto;">
samplerate = 500;
pulseLen = 2000/samplerate;
% select a function
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>
% get handle to serial device