Difference between revisions of "ButtonBoxes"

From TSG Doc
Jump to: navigation, search
 
(5 intermediate revisions by 2 users not shown)
Line 13: Line 13:
 
| caption        = 2013 Buttonbox
 
| caption        = 2013 Buttonbox
 
| downloads      = {{bulleted list
 
| downloads      = {{bulleted list
       | [https://surfdrive.surf.nl/files/index.php/s/72XEcu2XKSgzxjp Buttonbox 2013]
+
       | [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)
 
   }}
 
   }}
Line 223: Line 223:
 
=== 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:'''
Line 287: Line 289:
 
# make a buttonbox
 
# make a buttonbox
 
ser = serial.Serial("COM2", 115200, timeout = 0.10 )
 
ser = serial.Serial("COM2", 115200, timeout = 0.10 )
 +
ser = serial.Serial("/dev/ttyUSB0", 115200, timeout = 0.10 )
  
 
while True:
 
while True:
Line 336: Line 339:
  
 
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
function ret = buttonbox(cmd,varargin)
+
<br> Make sure to have this file in your Matlab path.
% to initialize connection: (omit 2nd argument if defaults apply)
+
<syntaxhighlight lang="matlab" line style="overflow:auto;">
%    define settings as structure with fields:
+
% At the start of your script, create the buttonbox serial object
%      bb.Device    = 'COM2';
+
bb = Bitsi("COM2");
%      bb.BaudRate  = 115200;
+
% other code
%      bb.DataBits  = 8;
+
        :
%      bb.StopBits  = 1;
+
</syntaxhighlight>
%      bb.Parity    = 'none';
 
% handle = buttonbox('open',bb)
 
%
 
% to run: (receiving incoming data, check code for own purposes)
 
% buttonbox('run');
 
%
 
% or
 
%
 
% to send a marker: (marker: a numeric value; Fs: sampling frequency device)
 
% buttonbox(marker,Fs)
 
%
 
% or
 
%
 
% to wait for a buttonpress:
 
% buttonbox('clear'); (make sure buttonbox buffer is emptied)
 
% key = buttonbox('wait_keypress')
 
%
 
% to close the connection:
 
% buttonbox('close');
 
  
persistent old_hdl % keep handle to COM object persistent
+
BITSI simple mode:
% set defaults
+
<syntaxhighlight lang="matlab" line style="overflow:auto;">
bb.Device    = 'COM2';
+
% This example is for an EEG system sampling at 500Hz samplerate.  
bb.BaudRate  = 115200;
+
% at the start of your script, reset marker
bb.DataBits  = 8;
+
samplerate = 500;
bb.StopBits  = 1;
+
pulseLen = 2000/samplerate;
bb.Parity    = 'none';
+
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>
  
if nargin < 1
+
BITSI extended mode:
  cmd = 'open';
+
<syntaxhighlight lang="matlab" line style="overflow:auto;">
end
+
samplerate = 500;
if nargin > 1 && isstruct(varargin{1})
+
pulseLen = 2000/samplerate;
  % user overwrites default settings
+
% select a function
  flds = fields(varargin{1});
+
bb.sendTrigger(uint8('X'));   % select pulse time
  for n = 1 : numel(flds)
+
bb.sendTrigger(pulseLen);            % set time of duration pulse to (2000/samplerate) ms
      bb.(flds{n}) = varargin{1}.(flds{n});
+
  end
+
val = 1;                                    % val: this is your marker code, range code 1-255
end
+
bb.sendTrigger(uint8('M')); % select marker out
if nargin==1 && isnumeric(cmd)
+
bb.sendTrigger(val);             % val: this is your marker code, range code 1-255
  error('Please also specify acquisition sampling frequency of device that receives the marker');
+
</syntaxhighlight>
end
 
if nargin > 1 && isnumeric(cmd)
 
  marker = cmd;
 
  cmd = 'marker';
 
  Fs = varargin{1};
 
end
 
  
if ~any(strcmp(cmd,{'open','close'}))
+
<syntaxhighlight lang="matlab" line style="overflow:auto;">
  if isempty(old_hdl)
+
% At the end of your script, close the buttonbox serial object
      help serial_buttonbox_common
+
    :
      error('Buttonbox not yet initialized');
+
bb.close();
  end
+
</syntaxhighlight>
  handle = old_hdl;
 
end
 
 
 
switch cmd
 
  case 'marker'
 
      fwrite(handle, uint8(marker));%IOPort('Write', handle, uint8(marker), 1); % last argument: blocking
 
      WaitSecs(2/Fs);
 
      fwrite(handle, uint8(0));%IOPort('Write', handle, uint8(0), 0); % last argument: blocking
 
      return
 
  case 'clear'
 
      while(handle.BytesAvailable)
 
        fread(handle, 1);
 
      end     
 
      ret = []; % meaningless
 
      return
 
  case 'open'
 
      % get handle to serial device
 
      handle = open_buttonbox(bb);
 
      ret = handle;
 
      return
 
  case 'close'
 
      if nargin > 1
 
        handle = varargin{1};
 
      else
 
        handle = old_hdl;
 
      end
 
      fclose(handle);
 
      delete(handle);
 
      ret = [];
 
      return
 
  case 'run'
 
      % read incoming data
 
      % code proceeds below ....
 
  case 'wait_keypress'
 
      % start polling for characters (indicating start of scan)
 
      while(1)
 
        data = [];
 
        while handle.BytesAvailable
 
            navailable = handle.BytesAvailable;
 
            % read incoming data
 
            [newdata, cnt] = fread(handle, navailable);
 
            % concatenate possible new data
 
            if cnt
 
              data = [data newdata(:)];
 
            end
 
        end
 
        if ~isempty(data)
 
            ret = data;
 
            return
 
        end
 
      end
 
  otherwise
 
      fprintf('Unknown option %s\n',cmd);
 
      ret = [];
 
      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)      WaitSecs(0.002); % just to load mex-file into memory
 
      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
 
end</syntaxhighlight>
 

Latest revision as of 14:12, 16 October 2020

Buttonbox (2018)
Buttonbox 2018 1.png
2018 Buttonbox
Downloads
Buttonbox
Buttonbox 03s.png
2013 Buttonbox
Downloads

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 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:

BITSI Simple
Signal/Button ASCII (rise/fall) 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.

BITSI Extended
Function Byte 1 (ASCII/code) 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

Port Settings

Trigger port

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.

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 Can Windows connect to Windows Update to search for software? select No, not this time. Click next.
  • Select Install from a list or specified location (Advanced) and click next.
  • Make sure that Search for the best driver in these locations is checked; uncheck Search removable media; check Include this location in the search and browse to the 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.
  • From the system properties window, go to the Hardware tab and click the Device Manager button.
  • 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.
  • If the Com Port is 10 or higher, you will have to change it to a lower port.
  • 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.
  • 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.
  • Click the OK button.

Always connect the usb device to the same port and your settings will be remembered.

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.

Buttonbox2.png

Testing Buttonbox

When pressing on the A button within the input channel tester. You will see the following ASCII code.

Testbuttonbox.png

Adding Marker

Output buttonbox1.png

Testing Markers (output)

Send code 1 for Button A

Output buttonbox2.png

Button A will light up.

ButtonboxledA.png

Send code 0 for clearing.

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 here

Python/PsychoPy

Download this site-package to use the buttonbox: rusocsci

or use in windows command 'pip install --upgrade rusocsci'

Example using buttons from the buttonbox in Python:

 1 #!/usr/bin/env python
 2 
 3 # import the rusocsci.buttonbox module
 4 from rusocsci import buttonbox 
 5 
 6 # make a buttonbox
 7 bb = buttonbox.Buttonbox()
 8 
 9 # wait for a single button press
10 b = bb.waitButtons()
11 
12 # print the button pressed
13 print("b: {}".format(b))

Example using markers with the buttonbox in Python:

 1 #!/usr/bin/env python
 2 
 3 # import the rusocsci.buttonbox module
 4 from rusocsci import buttonbox 
 5 
 6 # make a buttonbox
 7 bb = buttonbox.Buttonbox()
 8 
 9 # send a marker
10 bb.sendMarker(val=100)    #This is your marker code, range code 1-255

Example using BITSI extended in Python:

 1 #!/usr/bin/env python
 2 
 3 # import the rusocsci.buttonbox module
 4 from rusocsci import buttonbox 
 5 
 6 # make a buttonbox
 7 bb = buttonbox.Buttonbox()
 8 
 9 # select a function
10 bb.sendMarker(val=(ord(X)))    #select pulse time
11 bb.sendMarker(val=2)           #set time of dureation pulse to 2ms
12 
13 bb.sendMarker(val=(ord(M)))    #select marker out
14 bb.sendMarker(val=115)           #set marker value 115

Example using BITSI extended analog read in Python:

 1 #!/usr/bin/env python
 2 
 3 # import the rusocsci.buttonbox module
 4 import serial
 5 
 6 # make a buttonbox
 7 ser = serial.Serial("COM2", 115200, timeout = 0.10 )
 8 ser = serial.Serial("/dev/ttyUSB0", 115200, timeout = 0.10 )
 9 
10 while True:
11 	ser.write('A1')
12 	ser.flush()
13 	x = ser.readline()
14 	visual.TextStim(win, text=x).draw()
15 
16 	# black screen for 1000 ms
17 	win.flip()
18 
19 	key = event.getKeys()
20 	try:
21 		if key[0]=='escape':
22 			break
23 	except:
24 		continue


Example using the Buttonbox in PsychoPy:

 1 #!/usr/bin/env python
 2 
 3 # import psychopy and rusocsci
 4 from psychopy import core, visual 
 5 from rusocsci import buttonbox
 6 
 7 ## Setup Section
 8 win = visual.Window(monitor="testMonitor")
 9 bb = buttonbox.Buttonbox()
10 text = visual.TextStim(win, "Press a button on the buttonbox")
11 
12 ## Experiment Section
13 # show text
14 text.draw()
15 win.flip()
16 # wait for response
17 b = bb.waitButtons()
18 # show response
19 text.setText("you pressed: {}".format(b))
20 text.draw()
21 win.flip()
22 core.wait(5)
23 
24 ## Cleanup Section
25 core.quit()

For more documentation click here: http://pythonhosted.org//RuSocSci/index.html

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
Make sure to have this file in your Matlab path.

1 % At the start of your script, create the buttonbox serial object
2 bb = Bitsi("COM2");
3 % other code
4         :

BITSI simple mode:

 1 % This example is for an EEG system sampling at 500Hz samplerate.  
 2 % at the start of your script, reset marker
 3 samplerate = 500;
 4 pulseLen = 2000/samplerate;
 5 bb.sendTrigger(0);
 6 % send a marker
 7 val = 1;                                     % val: this is your marker code, range code 1-255
 8 bb.sendTrigger(val);
 9 java.lang.Thread.sleep(pulseLen);    % wait long enough for the EEG system to capture the trigger, i.e., 2000/samplerate ms
10 % reset marker
11 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.

BITSI extended mode:

1 samplerate = 500;
2 pulseLen = 2000/samplerate;
3 % select a function
4 bb.sendTrigger(uint8('X'));   % select pulse time
5 bb.sendTrigger(pulseLen);             % set time of duration pulse to (2000/samplerate) ms
6  
7 val = 1;                                     % val: this is your marker code, range code 1-255
8 bb.sendTrigger(uint8('M'));  % select marker out
9 bb.sendTrigger(val);              % val: this is your marker code, range code 1-255
1 % At the end of your script, close the buttonbox serial object
2     :
3 bb.close();