Changes

Jump to navigation Jump to search

ButtonBoxes (view source)

Revision as of 14:12, 16 October 2020

8,536 bytes added ,  14:12, 16 October 2020
no edit summary
Line 1: Line 1: −
== 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)
 +
  }}
 +
}}
   −
== TSG ButtonBox hardware 2013 ==
+
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.
   −
== TSG ButtonBox software 2013 ==
+
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]].
   −
== Presentation Settings ==
+
== 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:
 +
 
 +
{| 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)
 +
|-
 +
| 1 || A / a || 65 / 97
 +
|-
 +
| 2 || B / b || 66 / 98
 +
|-
 +
| 3 || C / c || 67 / 99
 +
|-
 +
| 4 || D / d || 68 / 100
 +
|-
 +
| 5 || E / e || 69 / 101
 +
|-
 +
| 6 || F / f || 70 / 102
 +
|-
 +
| 7 || G / g || 71 / 103
 +
|-
 +
| 8 || H / h || 72 / 104
 +
|-
 +
|}
 +
 
 +
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 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.
 +
 
 +
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
 +
|-
 +
| 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
 +
|-
 +
| LEDs Input || L / || I
 +
|-
 +
| LEDs Output || L / || O
 
|-
 
|-
−
| [[File:Buttonbox1.png]]
   
|}
 
|}
   −
== Psychopy Settings ==
+
== Port Settings ==
   −
<nowiki>
+
===Trigger port ===
−
#!/usr/bin/env python
     −
from psychopy import core, visual, event from rusocsci import buttonbox import logging, time
+
[[File:Connector.png|thumb|300x300px|Schematic view of the 25 pins connector]]
   −
##Setup Section
+
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.
−
#logging.getLogger().setLevel(logging.DEBUG) # use this for debug info
     −
win = visual.Window([400,300], monitor="testMonitor") bb = buttonbox.Buttonbox()
+
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.
   −
##Experiment Section
+
===Serial port===
   −
b = bb.waitButtons(maxWait = 10.0, buttonList=['A']) print("b: {}".format(b))
+
Our hardware design allows to be connected to the computers USB and emulates a serial communication Port.
   −
##Cleanup Section
+
{| class="wikitable"
 +
|-
 +
| Baudrate || 115200
 +
|-
 +
| Parity || None
 +
|-
 +
| Data bits || 8
 +
|-
 +
| Stop bits || 1
 +
|-
 +
| Flow control || None
 +
|-
 +
|}
 +
 
 +
=== USB-Com port ===
 +
 
 +
1.Connect the BITSIbox to your computer using the USB cable.
 +
 
 +
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).
 +
 
 +
3.On Windows Vista/7, the driver should be automatically downloaded and installed.
 +
 
 +
4.On Windows XP, the Add New Hardware wizard will open:
 +
 
 +
*When asked&nbsp;'''Can Windows connect to Windows Update to search for software?'''&nbsp;select&nbsp;'''No, not this time'''. Click next.
 +
*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!)'''
 +
 
 +
*From the Start menu, open the '''Control Panel'''.
 +
 
 +
*From the control panel, open the '''System window'''.
   −
core.quit() The following script lights the LEDs under the buttons pressed.
+
*From the system properties window, go to the '''Hardware tab''' and click the '''Device Manager''' button.
   −
#!/usr/bin/env python
+
*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.
−
#from __future__ import print_function
     −
import logging, time, sys from rusocsci import buttonbox
+
*If the Com Port is 10 or higher, you will have to change it to a lower port.
   −
##Setup Section
+
*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.
   −
led = [False]*8
+
*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.
   −
##Experiment Section
+
*Click the OK button.
   −
bb = buttonbox.Buttonbox() while True:
+
Always connect the usb device to the same port and your settings will be remembered.
   −
  buttons = bb.getButtons()
+
== Software Settings ==
−
  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 ==
+
=== Neurobs Presentation ===
   −
  <nowiki>
+
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.
−
function handle = serial_buttonbox_common(cmd,varargin)
+
* Rate must be set 115200, Parity to None, Data Bits to 8 and Stop Bits to 1, Uncheck FIFO Interrupt.
−
% to initialize connection:
+
 
−
% handle = serial_buttonbox('open',se)
+
[[File:Buttonbox2.png]]
−
%    settings (se):
+
 
−
%      define settings as a structure, i.e.:
+
'''Testing Buttonbox'''
−
%      se.Device    = 'COM1';
+
 
−
%      se.BaudRate  = 115200;
+
When pressing on the A button within the input channel tester. You will see the following ASCII code.
−
%      se.DataBits  = 8;
+
 
−
%      se.StopBits  = 1;
+
[[file:testbuttonbox.png]]
−
%      se.Parity    = 0;
+
 
−
%      se.PTBPath  = 'c:\MyToolboxes\PsychToolbox'
+
'''Adding Marker'''
−
%
+
 
−
  % to close the connection:
+
[[file:output_buttonbox1.png | 800px]]
−
  % serial_buttonbox('close',handle);
+
 
−
+
'''Testing Markers (output)'''
−
persistent old_hdl
+
 
−
+
Send code 1 for Button A
−
% set defaults
+
 
−
se.Device    = 'COM1';
+
[[file:output_buttonbox2.png]]
−
  se.BaudRate  = 115200;
+
 
−
se.DataBits  = 8;
+
Button A will light up.
−
se.StopBits  = 1;
+
 
−
se.Parity    = 0;
+
[[file:buttonboxledA.png | 200px]]
−
se.PTBPath  = 'c:\Pgrogram Files\PsychToolbox';
+
 
−
+
Send code 0 for clearing.
−
if nargin < 1
+
 
−
    cmd = 'open';
+
[[file:output_buttonbox3.png]]
−
end
+
 
−
if nargin > 1
+
'''Example PCL code you can program a handle to send a marker:'''
−
    % user overwrites default settings
+
 
−
    flds = fields(varargin{1});
+
  #handle:
−
    for n = 1 : numel(flds)
+
  output_port OutputPort = output_port_manager.get_port( 1 );
−
      se.(flds{n}) = varargin{1}.(flds{n});
+
 
−
    end
+
'''Example to send a marker:'''
−
end
+
  OutputPort.send_code(100); #create a marker
−
+
 
−
+
 
−
switch cmd
+
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]
−
    case 'open'
+
 
−
      addpath(genpath(se.PTBPath));
+
=== Python/PsychoPy ===
−
      % get handle to serial device
+
 
−
      handle = open_buttonbox(se.Device);
+
Download this site-package to use the buttonbox: [https://pypi.python.org/pypi/RuSocSci rusocsci]
−
      return
+
 
−
    case 'close'
+
or use in windows command 'pip install --upgrade rusocsci'
−
      handle = varargin{1};
+
 
−
      IOPort('close',handle);
+
'''Example using buttons from the buttonbox in Python:'''
−
      return
+
 
−
    case 'run'
+
<syntaxhighlight lang="python" line>
−
      % read incoming data
+
#!/usr/bin/env python
−
      if isempty(old_hdl)
+
 
−
          help serial_buttonbox_common
+
# import the rusocsci.buttonbox module
−
          error('Buttonbox not yet initialized');
+
from rusocsci import buttonbox
−
      end
+
 
−
      handle = old_hdl;
+
# make a buttonbox
−
    otherwise
+
bb = buttonbox.Buttonbox()
−
      fprintf('Unknown option %s\n',cmd);
+
 
−
      return
+
# wait for a single button press
−
end
+
b = bb.waitButtons()
−
+
 
−
% only gets here when cmd = 'run'
+
# print the button pressed
−
while 1 
+
print("b: {}".format(b))  
−
    % start polling for characters (indicating start of scan)
+
</syntaxhighlight>
−
    navailable = IOPort('BytesAvailable', handle);
+
 
−
    if navailable
+
'''Example using markers with the buttonbox in Python:'''
−
      data = [];
+
 
−
      while navailable
+
<syntaxhighlight lang="python" line>
−
          % read incoming data
+
#!/usr/bin/env python
−
          [newdata, ~, err] = IOPort('Read', handle, 0, navailable);
+
 
−
          if ~isempty(err), disp(err); end
+
# import the rusocsci.buttonbox module
−
          data = [data newdata];
+
from rusocsci import buttonbox
−
          %pause(0.001); % if possible just add a small pause to not claim entire core
+
 
−
          navailable = IOPort('BytesAvailable', handle);
+
# make a buttonbox
−
      end
+
bb = buttonbox.Buttonbox()
−
      if numel(data)>1
+
 
−
          fprintf('\nReceived characters: %d\n',numel(data));
+
# send a marker
−
      end
+
bb.sendMarker(val=100)    #This is your marker code, range code 1-255
−
      for n = 1 : numel(data)
+
</syntaxhighlight>
−
%        disp(char(data(n)));
+
 
−
          fprintf('incoming: %d\t%s\n',data(n),char(data(n)));
+
'''Example using BITSI extended in Python:'''
−
      end
+
 
−
    end
+
<syntaxhighlight lang="python" line>
−
 
+
#!/usr/bin/env python
−
 
+
 
−
end %while 1
+
# import the rusocsci.buttonbox module
−
+
from rusocsci import buttonbox
−
    function hdl = open_buttonbox(device)
+
 
−
      % open handle to serial device (mini buttonbox)
+
# make a buttonbox
−
      try
+
bb = buttonbox.Buttonbox()
−
          hdl = IOPort('OpenSerialPort',device,['BaudRate=' num2str(se.BaudRate)]);
+
 
−
      catch
+
# select a function
−
          if ~isempty(old_hdl)
+
bb.sendMarker(val=(ord(X)))    #select pulse time
−
            IOPort('close',old_hdl);
+
bb.sendMarker(val=2)          #set time of dureation pulse to 2ms
−
          end
+
 
−
          hdl = IOPort('OpenSerialPort',device,['BaudRate=' num2str(se.BaudRate)]);
+
bb.sendMarker(val=(ord(M)))   #select marker out
−
      end
+
bb.sendMarker(val=115)          #set marker value 115
−
      old_hdl = hdl;
+
</syntaxhighlight>
−
     
+
 
−
      fprintf('Wait for device buttonbox....\n');
+
'''Example using BITSI extended analog read in Python:'''
−
      tic
+
 
−
      while ~IOPort('BytesAvailable', hdl) && toc<10
+
<syntaxhighlight lang="python" line>
−
          % wait for welcome message device
+
#!/usr/bin/env python
−
      end
+
 
−
      pause(0.5);
+
# import the rusocsci.buttonbox module
−
+
import serial
−
      % clear buffer
+
 
−
      %IOPort('flush', hdl);
+
# make a buttonbox
−
      IOPort('purge', hdl);
+
ser = serial.Serial("COM2", 115200, timeout = 0.10 )
−
    end
+
ser = serial.Serial("/dev/ttyUSB0", 115200, timeout = 0.10 )
−
 
+
 
−
end</nowiki>
+
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>
 +
#!/usr/bin/env python
 +
 
 +
# import psychopy and rusocsci
 +
from psychopy import core, visual
 +
from rusocsci import buttonbox
 +
 
 +
## Setup Section
 +
win = visual.Window(monitor="testMonitor")
 +
bb = buttonbox.Buttonbox()
 +
text = visual.TextStim(win, "Press a button on the buttonbox")
 +
 
 +
## 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)
 +
 
 +
## Cleanup Section
 +
core.quit()
 +
</syntaxhighlight>
 +
 
 +
For more documentation click here: http://pythonhosted.org//RuSocSci/index.html
 +
<br>
 +
<br>
 +
=== Matlab ===
 +
'''Example using markers with the Buttonbox in Matlab:'''
   −
== Inquisit Settings ==
+
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>
   −
Work in progress
+
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>
   −
== E-Prime ==
+
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>
   −
Work in progress
+
<syntaxhighlight lang="matlab" line style="overflow:auto;">
 +
% At the end of your script, close the buttonbox serial object
 +
    :
 +
bb.close();
 +
</syntaxhighlight>
Retrieved from "http://tsgdoc.socsci.ru.nl/index.php/Special:MobileDiff/208...5168"

Navigation menu