ButtonBox: Difference between revisions

Jump to navigation Jump to search
← Older edit
No edit summary
mNo edit summary
 
(132 intermediate revisions by 8 users not shown)
Line 1: Line 1:
== General ==
{{Infobox tsg
| name          = Buttonbox (2018)
| image          = Buttonbox_2018_1.png
| caption        = 2018 Buttonbox
| downloads      = {{bulleted list
      | {{Surfdrive|https://surfdrive.surf.nl/s/KZzgpmC5oK5JBNr|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
      | {{Surfdrive|https://surfdrive.surf.nl/s/KZzgpmC5oK5JBNr|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 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 [[ButtonBox/Microsoft Windows driver issue|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.


<u>'''Input'''</u>
===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="0" cellspacing="0" cellpadding="0" width="462" style="width:462px;"
{| class="wikitable"  
|-
! scope="row" colspan="3" | BITSI Simple
|-
|-
| style="width:113px;height:22px;" |  
! scope="row" width="120px" | Signal/Button
'''Signal / Button'''
! scope="row" width="120px" | ASCII (rise/fall)
 
! scope="row" width="120px" | Code (rise/fall)
| style="width:170px;height:22px;" |  
'''ASCII''' (rising / falling)
 
| style="width:180px;height:22px;" |  
'''Code''' (rising / falling)
 
|-
|-
| 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
7
 
| style="width:170px;height:22px;" |  
G / g
 
| style="width:180px;height:22px;" |  
71 / 103
 
|-
|-
| style="width:113px;height:22px;" |
| 8 || H / h || 72 / 104
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.
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.


<u>'''Output'''</u>
===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" 
 
|-
{| border="1" cellspacing="0" cellpadding="0" width="434" style="width:434px;"
! 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
|-
| Pulse Time || X / 88 || ms before pulse reset
|-
| Analog Out 1 || Y / 89 || Analog Output Value
|-
| Analog Out 2 || Z / 90 || Analog Output Value
|-
| Tone || T / 84 || Start Tone
|-
| Detect Sound || D / || S / 83
|-
| Detect Voice || D / || V / 83
|-
| Calibrate Sound || C / || S
|-
| Calibrate Voice || C / || V
|-
| Analog In 1 || A / || 1
|-
| Analog In 2 || A / || 2
|-
| Analog In 3 || A / || 3
|-
| Analog In 4 || A / || 4
|-
| LEDs Off || L / || X
|-
|-
| style="width:122px;height:22px;" |  
| LEDs Input || L / || I
'''Function'''
 
| style="width:161px;height:22px;" |
'''Byte 1 (ASCII / code)'''
 
| style="width:151px;height:22px;" |  
'''Byte 2'''
 
|-
|-
| style="width:122px;height:22px;" |  
| LEDs Output || L / || O
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;" |
== Port Settings ==
Y / 89


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


|-
[[File:Connector.png|thumb|300x300px|Schematic view of the 25 pins connector]]
| style="width:122px;height:22px;" |  
Analog out 2


| style="width:161px;height:22px;" |
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.
Z / 90
 
| style="width:151px;height:22px;" |
Analog output value


|-
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.
| style="width:122px;height:22px;" |
Tone


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


| style="width:151px;height:22px;" |
Our hardware design allows to be connected to the computers USB and emulates a serial communication Port.
Start tone


{| class="wikitable"
|-
|-
| style="width:122px;height:22px;" |  
| Baudrate || 115200
Detect Sound
 
| style="width:161px;height:22px;" |
D
 
| style="width:151px;height:22px;" |
S / 83
 
|-
|-
| style="width:122px;height:22px;" |  
| Parity || None
Detect Voice
 
| style="width:161px;height:22px;" |
D /
 
| style="width:151px;height:22px;" |
V / 83
 
|-
|-
| style="width:122px;height:22px;" |  
| Data bits || 8
Calibrate Sound
 
| style="width:161px;height:22px;" |
C /
 
| style="width:151px;height:22px;" |
S
 
|-
|-
| style="width:122px;height:22px;" |  
| Stop bits || 1
Calibrate Voice
 
| style="width:161px;height:22px;" |
C /
 
| style="width:151px;height:22px;" |
V
 
|-
|-
| style="width:122px;height:22px;" |  
| Flow control || None
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;" |
=== USB-Com port ===
A /


| style="width:151px;height:22px;" |
1.Connect the BITSIbox to your computer using the USB cable.
2


|-
2.When you connect the BITSIbox, Windows should initiate the driver installation process (if you haven't used the computer with an BITSIbox board before).
| style="width:122px;height:22px;" |
Analog in 3


| style="width:161px;height:22px;" |
3.On Windows Vista/7, the driver should be automatically downloaded and installed.
A /


| style="width:151px;height:22px;" |
4.On Windows XP, the Add New Hardware wizard will open:
3


|-
*When asked&nbsp;'''Can Windows connect to Windows Update to search for software?'''&nbsp;select&nbsp;'''No, not this time'''. Click next.
| style="width:122px;height:22px;" |
*Select&nbsp;'''Install from a list or specified location (Advanced)'''&nbsp;and click next.
Analog in 4
*Make sure that&nbsp;'''Search for the best driver in these locations'''&nbsp;is checked; uncheck&nbsp;'''Search removable media'''; check&nbsp;'''Include this location in the search'''&nbsp;and browse to the&nbsp;'''c:/beheer/arduino/drivers '''directory.
*The wizard will search for the driver and then tell you that a "USB Serial Converter" was found. Click finish.
*The new hardware wizard will appear again. Go through the same steps and select the same options and location to search. This time, a "USB Serial Port" will be found.


| style="width:161px;height:22px;" |
'''How to Check the Com Port settings(important!)'''
A /


| style="width:151px;height:22px;" |
*From the Start menu, open the '''Control Panel'''.
4


|-
*From the control panel, open the '''System window'''.
| style="width:122px;height:22px;" |
LEDs off


| style="width:161px;height:22px;" |
*From the system properties window, go to the '''Hardware tab''' and click the '''Device Manager''' button.
L /


| style="width:151px;height:22px;" |
*From the Device Manager window, click '''Ports (Com&LPT).''' You should now be able to see which Com Port the USB adapter is assigned to.
X


|-
*If the Com Port is 10 or higher, you will have to change it to a lower port.
| style="width:122px;height:22px;" |
LEDs input


| style="width:161px;height:22px;" |
*From the Device Manager window, click on '''USB Serial Port (Com#).''' Click the '''Port Settings tab''' of the USB Serial Port Properties window, and then click the '''Advanced''' button.
L /


| style="width:151px;height:22px;" |
*In the Advanced Settings window, use the scroll input to select a '''Com Port''' (select 10 or lower). Change '''Receive (bytes)''' and '''Transmit (bytes)''' to 64. Change the '''Latency Timer''' to 1.
I


|-
*Click the OK button.
| style="width:122px;height:22px;" |
LEDs output


| style="width:161px;height:22px;" |
Always connect the usb device to the same port and your settings will be remembered.
L /


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


|}
=== Neurobs Presentation ===


<u>'''Trigger port settings'''</u>
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:Connector.png|300x300px]]
[[File:Buttonbox2.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.
'''Testing Buttonbox'''


<u>'''Serial port settings'''</u>
When pressing on the A button within the input channel tester. You will see the following ASCII code.


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


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


| style="width:69px;" |  
[[file:output_buttonbox1.png | 800px]]
115200


|-
'''Testing Markers (output)'''
|
'''Parity'''


| style="width:69px;" |
Send code 1 for Button A
none


|-
[[file:output_buttonbox2.png]]
|
'''Data bits'''


| style="width:69px;" |
Button A will light up.
8


|-
[[file:buttonboxledA.png | 200px]]
|
'''Stop bits'''


| style="width:69px;" |
Send code 0 for clearing.
1


|-
[[file:output_buttonbox3.png]]
|
'''Flow control'''


| style="width:69px;" |
'''Example PCL code you can program a handle to send a marker:'''
none


|}
#handle:
output_port OutputPort = output_port_manager.get_port( 1 );


== ==
'''Example to send a marker:'''
  OutputPort.send_code(100); #create a marker


== USB-Com port settings ==


1.Connect the BITSIbox to your computer using the USB cable.
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]


2.When you connect the BITSIbox, Windows should initiate the driver installation process (if you haven't used the computer with an BITSIbox board before).
=== Python/PsychoPy ===


3.On Windows Vista/7, the driver should be automatically downloaded and installed.
Download this site-package to use the buttonbox: [https://pypi.python.org/pypi/RuSocSci rusocsci]


4.On Windows XP, the Add New Hardware wizard will open:
or use in windows command 'pip install --upgrade rusocsci'


*When asked&nbsp;'''Can Windows connect to Windows Update to search for software?'''&nbsp;select&nbsp;'''No, not this time'''. Click next.
'''Example using buttons from the buttonbox in Python:'''
*Select&nbsp;'''Install from a list or specified location (Advanced)'''&nbsp;and click next.
*Make sure that&nbsp;'''Search for the best driver in these locations'''&nbsp;is checked; uncheck&nbsp;'''Search removable media'''; check&nbsp;'''Include this location in the search'''&nbsp;and browse to the&nbsp;'''c:/beheer/arduino/drivers '''directory.
*The wizard will search for the driver and then tell you that a "USB Serial Converter" was found. Click finish.
*The new hardware wizard will appear again. Go through the same steps and select the same options and location to search. This time, a "USB Serial Port" will be found.


'''How to Check the Com Port settings(important!)'''
<syntaxhighlight lang="python" line>
#!/usr/bin/env python


* From the Start menu, open the '''Control Panel'''.
# import the rusocsci.buttonbox module
from rusocsci import buttonbox


* From the control panel, open the '''System window'''.
# make a buttonbox
bb = buttonbox.Buttonbox()


* From the system properties window, go to the '''Hardware tab''' and click the '''Device Manager''' button.
# wait for a single button press
b = bb.waitButtons()


* From the Device Manager window, click '''Ports (Com&LPT).''' You should now be able to see which Com Port the USB adapter is assigned to.
# print the button pressed
print("b: {}".format(b))  
</syntaxhighlight>


* If the Com Port is 10 or higher, you will have to change it to a lower port.
'''Example using markers with the buttonbox in Python:'''


* From the Device Manager window, click on '''USB Serial Port (Com#).''' Click the '''Port Settings tab''' of the USB Serial Port Properties window, and then click the '''Advanced''' button.
<syntaxhighlight lang="python" line>
#!/usr/bin/env python


* In the Advanced Settings window, use the scroll input to select a '''Com Port''' (select 10 or lower). Change '''Receive (bytes)''' and '''Transmit (bytes)''' to 64. Change the '''Latency Timer''' to 1.
# import the rusocsci.buttonbox module
from rusocsci import buttonbox


* Click the OK button.
# make a buttonbox
bb = buttonbox.Buttonbox()


Always connect the usb device to the same port and your settings will be remembered.
# send a marker
bb.sendMarker(val=100)    #This is your marker code, range code 1-255
</syntaxhighlight>


== TSG ButtonBox hardware 2013 ==
'''Example using BITSI extended in Python:'''


== TSG ButtonBox software 2013 ==
<syntaxhighlight lang="python" line>
#!/usr/bin/env python


Find the code #REDIRECT[[Buttonbox_2013_Software|Buttonbox_2013_Software]]
# import the rusocsci.buttonbox module
from rusocsci import buttonbox


== Presentation Settings ==
# make a buttonbox
bb = buttonbox.Buttonbox()


<span lang="EN-US" style="font-size: 12pt; line-height: 115%; font-family: Arial, sans-serif; background-position: initial initial; background-repeat: initial initial;">The experiment files needs a few settings for the device to work:</span><br/><span lang="EN-US" style="font-size: 12pt; line-height: 115%; font-family: Arial, sans-serif;">- In the settings tab:&nbsp; 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.<br/>-<span class="apple-converted-space">&nbsp;</span>''Rate<span class="apple-converted-space">&nbsp;</span>''must be set 115200,<span class="apple-converted-space">&nbsp;</span>''Parity<span class="apple-converted-space">&nbsp;</span>''to None,<span class="apple-converted-space">&nbsp;</span>''Data Bits''<span class="apple-converted-space">&nbsp;</span>to 8 and<span class="apple-converted-space">&nbsp;</span>''Stop Bits''<span class="apple-converted-space">&nbsp;</span>to 1, Uncheck<span class="apple-converted-space">&nbsp;</span>''FIFO Interrupt''.<br/><!--[if !supportLineBreakNewLine]--><br/><!--[endif]--></span>
# 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
| [[File:Buttonbox1.png]]
</syntaxhighlight>
|}


== Psychopy Settings ==
'''Example using BITSI extended analog read in Python:'''


<nowiki>
<syntaxhighlight lang="python" line>
#!/usr/bin/env python
#!/usr/bin/env python


from psychopy import core, visual, event from rusocsci import buttonbox import logging, time
# import the rusocsci.buttonbox module
import serial


##Setup Section
# make a buttonbox
#logging.getLogger().setLevel(logging.DEBUG) # use this for debug info
ser = serial.Serial("COM2", 115200, timeout = 0.10 )
ser = serial.Serial("/dev/ttyUSB0", 115200, timeout = 0.10 )


win = visual.Window([400,300], monitor="testMonitor") bb = buttonbox.Buttonbox()
while True:
ser.write('A1')
ser.flush()
x = ser.readline()
visual.TextStim(win, text=x).draw()


##Experiment Section
# black screen for 1000 ms
win.flip()


b = bb.waitButtons(maxWait = 10.0, buttonList=['A']) print("b: {}".format(b))
key = event.getKeys()
try:
if key[0]=='escape':
break
except:
continue
</syntaxhighlight>


##Cleanup Section
<br/>'''Example using the Buttonbox in PsychoPy:'''


core.quit() The following script lights the LEDs under the buttons pressed.
<syntaxhighlight lang="python" line>
#!/usr/bin/env python


#!/usr/bin/env python
# import psychopy and rusocsci
#from __future__ import print_function
from psychopy import core, visual
from rusocsci import buttonbox


import logging, time, sys from rusocsci import buttonbox
## Setup Section
win = visual.Window(monitor="testMonitor")
bb = buttonbox.Buttonbox()
text = visual.TextStim(win, "Press a button on the buttonbox")


##Setup Section
## Experiment Section
# show text
text.draw()
win.flip()
# wait for response
b = bb.waitButtons()
# show response
text.setText("you pressed: {}".format(b))
text.draw()
win.flip()
core.wait(5)


led = [False]*8
## Cleanup Section
core.quit()
</syntaxhighlight>


##Experiment Section
For more documentation click here: http://pythonhosted.org//RuSocSci/index.html
<br>
<br>


bb = buttonbox.Buttonbox() while True:
=== Matlab ===
'''Example using markers with the Buttonbox in Matlab:'''


  buttons = bb.getButtons()
Download the file Bitsi.m from the DCCN website: https://intranet.donders.ru.nl/index.php?id=bitsim0
  if len(buttons):
<br> Make sure to have this file in your Matlab path.
  for c in buttons:
<syntaxhighlight lang="matlab" line style="overflow:auto;">
  if ord(c) >= ord('a') and ord(c) < ord('a')+8:
% At the start of your script, create the buttonbox serial object
  led[ord(c) - ord('a')] = False
bb = Bitsi("COM2");
  elif ord(c) >= ord('A') and ord(c) < ord('A')+8:
% other code
  led[ord(c) - ord('A')] = True
        :
  bb.setLeds(led)
</syntaxhighlight>
  #print("buttons ({:3d}): {}{}".format(len(buttons), buttons, " "*50), end="\r")
  #sys.stdout.flush()</nowiki>


== Matlab Settings ==
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>


<nowiki>
BITSI extended mode:
===================================================================================================
<syntaxhighlight lang="matlab" line style="overflow:auto;">
function handle = serial_buttonbox_common(cmd,varargin)
samplerate = 500;
% to initialize connection:
pulseLen = 2000/samplerate; % get pulse time length for a 2 samples delay
% handle = serial_buttonbox('open',se)
% select a function
%    settings (se):
bb.sendTrigger(uint8('X'));   % select pulse time
%      define settings as a structure, i.e.:
bb.sendTrigger(pulseLen);             % set time of duration pulse to (2000/samplerate) ms
%      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
val = 1;                                    % val: this is your marker code, range code 1-255
      %IOPort('flush', hdl);
bb.sendTrigger(uint8('M')); % select marker out
      IOPort('purge', hdl);
bb.sendTrigger(val);             % val: this is your marker code, range code 1-255
    end
</syntaxhighlight>
 
end</nowiki>


== Inquisit Settings ==
<syntaxhighlight lang="matlab" line style="overflow:auto;">
% At the end of your script, close the buttonbox serial object
    :
bb.close();
</syntaxhighlight>


Work in progress
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);


== E-Prime ==
% 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)


Work in progress
</syntaxhighlight>
Retrieved from "https://tsgdoc.socsci.ru.nl/index.php/ButtonBox"