ButtonBox: Difference between revisions

Jump to navigation Jump to search
← Older edit
No edit summary
mNo edit summary
 
(26 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Infobox tsg
{{Infobox tsg
| name          = Buttonbox
| name          = Buttonbox (2018)
| image          = Buttonbox 03s.png
| image          = Buttonbox_2018_1.png
| caption        = 2018 Buttonbox
| caption        = 2018 Buttonbox
| downloads      = {{bulleted list
| downloads      = {{bulleted list
       | [[Media:buttonbox2018.pdf|Buttonbox 2018 Hardware Design]]
       | {{Surfdrive|https://surfdrive.surf.nl/s/KZzgpmC5oK5JBNr|Buttonbox 2018}}
      | [[Media:BITSI2018_Teensy36.zip|Code Template 2018 (Teensy 3.6)]]
      | [[Media:serial_install.zip|Driver Teensy 3.6]]
       | [https://pypi.python.org/pypi/RuSocSci RuSocSci] (Python package)
       | [https://pypi.python.org/pypi/RuSocSci RuSocSci] (Python package)
   }}
   }}
Line 15: Line 13:
| caption        = 2013 Buttonbox
| caption        = 2013 Buttonbox
| downloads      = {{bulleted list
| downloads      = {{bulleted list
       | [[Buttonbox 2013 Hardware|Buttonbox 2013 Hardware Design]]
       | {{Surfdrive|https://surfdrive.surf.nl/s/KZzgpmC5oK5JBNr|Buttonbox 2015}}
      | [[Media:BITSI_tempalte2015_duemilanove.zip|Code Template 2015 (Duemilanove)]]
       | [https://pypi.python.org/pypi/RuSocSci RuSocSci] (Python package)
       | [https://pypi.python.org/pypi/RuSocSci RuSocSci] (Python package)
   }}
   }}
Line 25: Line 22:
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.
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]].
⚠️ There is currently a [[ButtonBox/Microsoft Windows driver issue|Windows driver issue]].


== BITSI Protocol ==
== BITSI Protocol ==
Line 65: Line 62:
===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. '''[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.'''
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.
Line 226: 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 273: Line 272:


# select a function
# select a function
bb.sendMarker(val=(ord(X)))   #select pulse time
bb.sendMarker(val=(ord('X'))) #select pulse time
bb.sendMarker(val=2)          #set time of dureation pulse to 2ms
bb.sendMarker(val=2)          #set time of dureation pulse to 2ms


bb.sendMarker(val=(ord(M)))   #select marker out
bb.sendMarker(val=(ord('M'))) #select marker out
bb.sendMarker(val=115)           #set marker value 115
bb.sendMarker(val=115)         #set marker value 115
</syntaxhighlight>
</syntaxhighlight>


Line 290: 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 339: 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; % get pulse time length for a 2 samples delay
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. Another solution using a timer object instead of a simple delay is outlined below.
</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; % get pulse time length for a 2 samples delay
  % 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
Reset marker using a timer:
  case 'marker'
<syntaxhighlight lang="matlab" line style="overflow:auto;">
      fwrite(handle, uint8(marker));%IOPort('Write', handle, uint8(marker), 1); % last argument: blocking
% At the start of your script, define timer object and callback function
      WaitSecs(2/Fs);
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.
      fwrite(handle, uint8(0));%IOPort('Write', handle, uint8(0), 0); % last argument: blocking
resetMarker = timer('TimerFcn',@(x,y)bb.sendTrigger(0),'StartDelay',pulseTime);
      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


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% replace the code to send a marker with:
% only gets here when cmd = 'run' %
val = 1;                                    % val: this is your marker code, range code 1-255
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
bb.sendTrigger(val);
% Initialize output figure
resetMarker.start(); % this will call bb.sendTrigger(0) after pulseTime seconds (plus some additional overhead)
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


 
</syntaxhighlight>
 
  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>
Retrieved from "https://tsgdoc.socsci.ru.nl/index.php/ButtonBox"