Page History: HID Input Element
Compare Page Revisions
Page Revision: 2015/01/16 09:50
|
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 | Attributes | Value Type |
|---|
| Control |
| Input device | Defines the monitored HID device. | Design-time action | String |
| 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. | Design-time action | Int32 |
| Triggering Mode | Defines the triggering mode for button. The First Press Only mode is recommended for response time measurements. | | enButtonTriggeringMode |
| Runtime status |
| 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 selected button is currently in the down state. | R, Read-only | Boolean |
| Triggering time | Stores a local event time (in ms) of the last button triggering.
The value can be used a direct measure of the response time. | | UInt64 |
| Is triggered | Stores a local event time (in ms) of the last button triggering.
The value can be used a direct measure of the response time | | UInt64 |
+=== 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 |
|
The HID Input element allows receiving and decoding an input of
HID (Human Interface Devices). The HID protocol is supported by a broad range of USB computer input devices, like keyboards, mouses, joysticks and response boxes. The HID Input element is capable of reading both device's button states and analog axis.
The element collects timing statistics and, therefore is a suitable for recording of participant responses. The element allows using multiple input devices in parallel.
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.)))