Page History: HID Input Element
Compare Page Revisions
Page Revision: 2015/01/16 13:43
|
HID Input element
|
Info |
Category: |
Behaviour Control |
|
AddIn: |
Base Elements |
Creator: |
OkazoLab Team |
|
Scope: |
Parent Event |
Owns Snippets: |
no |
|
Usage: |
Input, Snippets |
Actions aligned with epochs of the parent event
Epoch | Actions |
---|
After Onset | The element starts monitoring buttons and axis |
Control Loop step | Triggered snippet is invoked, if the button (not axis!) state changes according to the selected triggering mode. |
Before Offset | The element stops monitoring buttons and axis |
Properties
Generic properties
Name | Description | Constraints | Value Type | Upon Change |
---|
Control |
Input device | Defines the monitored HID device. | | enum |
|
Monitored Button | Defines a button monitored by the element. If 'Any Button' selected, the element monitors all buttons on the selected input device. In this case, a name of the pressed button is returned by the Triggering Button property at runtime. | | String |
|
Triggering Mode | Defines the triggering mode for button. The First Press Only mode is recommended for response time measurements. | | enum |
|
Axes Scaling | Defines whether the physical axis values are automatically scaled into the device's defined logical range. If false, the physical axis values are returned. | | Boolaen |
|
Device Info |
Button Number | Returns the total number of buttons on the selected HID device | | Int32 |
|
Axis Number | Returns the total number of analog axis on the selected HID device | | Int32 |
|
Runtime status |
Triggering Time | Returns a local event time (in ms) of the last button triggering. The value can be used an accurate measure of the response time | | clTime |
|
Is Triggered | Indicates whether a button has been triggered at least once since the onset of the parent event. The property resets on each onset of the parent event. This property can be naturally used to gate switching between events. | | Boolean |
|
Triggered Button | Returns a name of the triggered button (pressed or released depending on the Triggering Mode). The keyboard symbol buttons are indicated by capital letters, whereas mouse and gamepad buttons have names like 'Button 1' and so on. | | String |
|
Is Down | Indicates whether the monitored button is currently in the down state | | Boolean |
|
+=== Properties inherited from clElement ===
Inherited properties of clElement
Name | Description | Constraints | Value Type | Upon Change |
---|
Control |
Is Enabled | If set to false the element is completely omitted when the experiment is run. | | Boolean |
|
Title | Title of the element. | | String |
|
HID Input element detects button presses/releases and monitors changes in analog axis on
HID (Human Interface Devices). Typical examples of the HID devices include keyboards, mice, joysticks, gamepads and some response boxes. If you need to record keys on primary input devices, e.g. on the system mouse, use the
Button element, which can provide slightly better timing than the HID Input element.
The HID Input element collects accurate timing statistics of key presses/releases and changes in analog axis, hence, it can be used for recording response times of a participant. Multiple HID Input elements can be used in EventIDE to record for one or several input devices in parallel. The HID Input element monitors an input device only within a scope of it's parent event. The element collects timing statistics, e.g. a press time as the number of milliseconds since the onset of the parent event.
Selection of the monitored button
The HID Input element can monitor either one specific button, or all buttons in the same time (when 'Any Button' is selected in the
Monitored Button property). In many experimental tasks, e.g.
2AFC, there are two response buttons for a participant. Given flexibility of the HID Input element, for the 2ADC tasks you can use different design patterns:
- Create two button elements, each monitoring one of the predefined response buttons
- Create one button element monitoring 'Any' button and write a code that checks, what button is pressed. The name of the pressed button is returned by the Triggered Button property
The first pattern allows to automatically ignore presses of irrelevant buttons. The second pattern is more convenient for collecting a reaction time in trial, because you can get from a single
proxy variable link to the
Triggering Time property of the button element.
Triggering modes for buttons
When monitoring buttons, the HID Input element is not limited to registering just button presses. There are 5 'triggering' modes for buttons, in which the HID Input element can operate. You need to select the triggering mode in advance, according to your requirements:
- First Press Only
- First Release Only
- Multiple Presses
- Multiple Releases
- Holding Down
Depending on the working mode, the element becomes 'triggered' when a specific input pattern is detected. The
First Press Only mode is the default choice for registering the fastest reaction time, because in this mode the element ignores all successive presses. Other modes are self-explanatory, save for the holding down mode, which detects continuously presses, common in the game-like activities.
HID Button Names
The HID Input element uses the button naming defined by an HID device. For example, the keyboard number buttons in the horizontal row are denoted as 'D1','D2'..'D0'. Other HID devices name their buttons as: 'Button 1', 'Button 2' and so on. Be aware that you need to maintain capital letter in the button names, when operating with them in C# code.
You can easily find out the actual button name, using the design-time press detector on the HID Input element. Open an editor for the
Monitored Button property and move the mouse cursor over the picture with a web. Then, press the desired button and check its name in the top row:
Using the press detector to set the monitored button or find out the button name |
Triggered Snippet
The HID Input element can invoke custom user code each time, when it becomes triggered (e.g. on a button press). To engage the triggering snippet, open it via the snippet panel and write your code there. Note that the triggered snippet is invoked only once, on the first press, when the 'First Press Only' triggering mode is selected. The triggered snippet can be used for checking a name of the pressed button:
if (TriggeringButton=="NumPad4")
Positon.X=PositionX-1;
if (TriggeringButton=="NumPad6")
Positon.X=PositionX+1;
Monitoring the analog axis