Page History: HID Input Element
Compare Page Revisions
Page Revision: 2015/01/16 11:11
|
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 |
|
| 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 on
HID (Human Interface Devices) and monitors changes in device's analog axis. The HID devices include the keyboards, mouses, joysticks, gamepad and some response boxes. If you need to record keys on primary input devices, e.g. on the system mouse, use the
Button element for slightly better timing.
The HID Input element collects accurate timing statistics of key presses and releases and changes in analog axis, hence, it can be used for recording reaction time of participant responses. Multiple HID Input elements can be used 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 and return local timing statistics, e.g. a press time as the number of milliseconds since the onset of the parent event.
Description
Snapshots
 Snapshot 1
| Snapshot 2 |
Practical use
The typical usage for the button element is detection of particular participant responses. However, you can use the button elements to provide operator's feedback to an experiment (for example, adjusting the experimental parameters with a keyboard at the runtime)
Note
The default settings allow detection only of the first button press. The following presses will be ignored. Change properties in the BEHAVIOUR group according to your requirements.)))