Vertical Sync sensor: Difference between revisions

Jump to navigation Jump to search
← Older edit
mNo edit summary
 
(33 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Infobox tsg
{{Infobox tsg
| name          = Buttonbox (2018)
| name          = Vertical Sync sensor
| image          = Buttonbox_2018_1.png
| image          = sensorPic.jpg
| caption        = 2018 Buttonbox
| caption        = Vertical Sync sensor
}}
{{Infobox tsg
| name          = Seeed Studio XIAO SAMD21
| image          = Seeeduino_XIAO.JPG
| caption        = Seeed Studio XIAO SAMD21
| downloads      = {{bulleted list
      | [https://wiki.seeedstudio.com/Seeeduino-XIAO/ XIAO SAMD21 product page]
  }}
}}
{{Infobox tsg
| name          = TEMT6000 Licht Sensor Module
| image          = temt6000.jpg
| caption        = TEMT6000 Licht Sensor Module
| downloads      = {{bulleted list
| downloads      = {{bulleted list
       | [https://surfdrive.surf.nl/files/index.php/s/PPTKCyrjLkN4XUO Buttonbox 2018]
       | {{Surfdrive|https://surfdrive.surf.nl/s/ZC2axMNWjYaTYFG|TEMT6000 Datasheet}}
      | [https://pypi.python.org/pypi/RuSocSci RuSocSci] (Python package)
   }}
   }}
}}
}}


The Vertical Sync sensor is used on a computer/laptop monitor for time accurate visual presentation. The sensor measures screen brightness. It generates a BITSI trigger("A" = ON/light, "a" = OFF/noLight) when the amount of light is higher than the (customizable) threshold, which means that the exact onset of any visual stimulus can be marked. It can easily be attached to any screen with a pincher. The Vertical Sync sensor is connected to a computer with a usb connection.
The Vertical Sync sensor is used on a computer/laptop monitor for time accurate visual presentation. The sensor measures screen brightness. It generates a BITSI trigger to the com-port("A" = ON/light, "a" = OFF/noLight) when the amount of light is higher than the (customizable) threshold. This means that the onset of visual stimulus on screen can be marked. It can easily be attached with a pincher to the screen. The Vertical Sync sensor is connected to a computer with a usb connection, a serial port is emulated. You may want to read about [[presentation modes]] in order to decide how to use the sync sensor.


== BITSI Protocol ==
== BITSI Protocol ==
Line 26: Line 38:
|}
|}


This means that when light falls on the sensor, a capital A will be sent to the serial port. A lowercase 'a' will be sent when the signal is deactivated(no light).
Meaning when light falls on the sensor, a capital A will be sent to the serial port. A lowercase 'a' will be sent when the signal is deactivated(no light).


===Output===
===Output===


The treshold for OFF is customizable and can be specified by sending a code Send code to specify the value for screen OFF.  
The treshold for monitor OFF is customizable and can be specified by sending a byte to specify the value for screen OFF. Any byte satisfies, see example code.
 
EDIT howto


== Port Settings ==
== Port Settings ==
Line 81: Line 91:


== Software Settings ==
== 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]]
'''Adding Marker'''
[[file:output_buttonbox1.png | 800px]]
'''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 treshold callibration:'''
OutputPort.send_code(100); #create a marker


=== Python/PsychoPy ===
=== Python/PsychoPy ===


Download this site-package to use the buttonbox: [https://pypi.python.org/pypi/RuSocSci rusocsci]
<br/>'''The basics using the Vertical Sync sensor in PsychoPy:'''
 
or use in windows command 'pip install --upgrade rusocsci'
 
'''Example using buttons from the buttonbox in Python:'''


<syntaxhighlight lang="python" line>
<syntaxhighlight lang="python" line>
#!/usr/bin/env python
# initialize treshold for OFF by sending a code
ser.write(b'1')


# import the rusocsci.buttonbox module
visual.Rect(win, .15, .25, pos=(-1, 1),fillColor="white", units="norm").draw()
from rusocsci import buttonbox
win.flip()
 
# wait for a sync square
# make a buttonbox
b = ser.read()
bb = buttonbox.Buttonbox()
 
# wait for a single button press
b = bb.waitButtons()
 
# print the button pressed
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
 
# import the rusocsci.buttonbox module
from rusocsci import buttonbox
 
# make a buttonbox
bb = buttonbox.Buttonbox()
 
# 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
</syntaxhighlight>
</syntaxhighlight>


'''Example using BITSI extended analog read in Python:'''
<br/>'''Example script using the Vertical Sync sensor in PsychoPy:'''
 
<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>
 
<br/>'''Example using the Buttonbox in PsychoPy:'''


<syntaxhighlight lang="python" line>
<syntaxhighlight lang="python" line>
Line 196: Line 113:
# import psychopy and rusocsci
# import psychopy and rusocsci
from psychopy import core, visual  
from psychopy import core, visual  
from rusocsci import buttonbox
import serial
import time


## Setup Section
## Setup Section
win = visual.Window(monitor="testMonitor")
win = visual.Window([400,400], fullscr=True, winType = "pyglet", monitor="testMonitor",color=(-1, -1, -1), waitBlanking=True)
bb = buttonbox.Buttonbox()
# connect to Vertical Sync sensor, find correct com port number
text = visual.TextStim(win, "Press a button on the buttonbox")
ser = serial.Serial('com3', 115200, timeout=1.0)
# create sync box left corner
rect = visual.Rect(win, .15, .25, pos=(-1, 1),fillColor="white", units="norm")
 
# wait 5 sec for python to become stabel
core.wait(5)
ser.flushInput()
# define screen OFF by sending a code
ser.write(b'1')


## Experiment Section
## Experiment Section
# show text
# show sync box left corner
text.draw()
rect.draw()
win.flip()
# wait for response
b = bb.waitButtons()
# show response
text.setText("you pressed: {}".format(b))
text.draw()
win.flip()
win.flip()
core.wait(5)
tik = time.perf_counter()
# wait for a sync square
b = ser.read()
tok = time.perf_counter()
# show delay after a flip
print("your timing after a flip: {}s".format(tok-tik))
# as a remark 60Hz/~0.016s 120Hz/~0.008s


## Cleanup Section
## Cleanup Section
Line 219: Line 145:
</syntaxhighlight>
</syntaxhighlight>


For more documentation click here: http://pythonhosted.org//RuSocSci/index.html
<br>
<br>
=== Matlab ===
=== Matlab ===
'''Example using markers with the Buttonbox in Matlab:'''
'''Example using markers with the Buttonbox in Matlab:'''
Line 247: Line 170:
% reset marker
% 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.
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>
</syntaxhighlight>
Retrieved from "https://tsgdoc.socsci.ru.nl/index.php/Vertical_Sync_sensor"