/iohub_docs/iohub/api_and_manual/device_details/keyboard.rst

https://github.com/smathot/psychopy · ReStructuredText · 49 lines · 36 code · 13 blank · 0 comment · 0 complexity · ee356a42b822265ce31848a03df4d673 MD5 · raw file 

    

  1. ###########################
    2. 

  2. The ioHub Keyboard Device
    3. 

  3. ###########################
    4. 

  4. 

  5. **Platforms:** Windows, OS X, Linux
    6. 

  6. 

  7. .. autoclass:: psychopy.iohub.devices.keyboard.Keyboard
    8. 

  8.     :exclude-members: ALL_EVENT_CLASSES, CLASS_ATTRIBUTE_NAMES, DEVICE_BUFFER_LENGTH_INDEX, DEVICE_CLASS_NAME_INDEX, DEVICE_MAX_ATTRIBUTE_INDEX, DEVICE_TIMEBASE_TO_SEC, DEVICE_TYPE_ID, DEVICE_TYPE_ID_INDEX, DEVICE_TYPE_STRING, DEVICE_USER_LABEL_INDEX, NUMPY_DTYPE, e, DEVICE_FIRMWARE_VERSION_INDEX, DEVICE_HARDWARE_VERSION_INDEX,DEVICE_MANUFACTURER_NAME_INDEX,DEVICE_MODEL_NAME_INDEX, DEVICE_MODEL_NUMBER_INDEX, DEVICE_NUMBER_INDEX, DEVICE_SERIAL_NUMBER_INDEX, DEVICE_SOFTWARE_VERSION_INDEX, EVENT_CLASS_NAMES, WH_KEYBOARD, WH_KEYBOARD_LL, WH_MAX, WIN32_KEYBOARD_PRESS_EVENT_TYPES, WM_CHAR, WM_DEADCHAR, WM_KEYDOWN, WM_KEYFIRST, WM_KEYLAST, WM_KEYUP, WM_SYSCHAR, WM_SYSDEADCHAR, WM_SYSKEYDOWN, WM_SYSKEYUP
    9. 

  9.     :member-order: bysource
    10. 

  10. 

  11. Keyboard Device Configuration Settings
    12. 

  12. ########################################
    13. 

  13. 

  14. 

  15. .. literalinclude:: default_yaml_configs/default_keyboard.yaml
    16. 

  16.     :language: yaml
    17. 

  17. 

  18. 

  19. Keyboard Event Types
    20. 

  20. #####################
    21. 

  21. 

  22. .. autoclass:: psychopy.iohub.devices.keyboard.KeyboardInputEvent
    23. 

  23.     :members: 
    24. 

  24.     :inherited-members:
    25. 

  25.     :exclude-members: DEVICE_ID_INDEX, filter_id, device_id, NUMPY_DTYPE, BASE_EVENT_MAX_ATTRIBUTE_INDEX, CLASS_ATTRIBUTE_NAMES, EVENT_CONFIDENCE_INTERVAL_INDEX, EVENT_DELAY_INDEX, EVENT_DEVICE_TIME_INDEX, EVENT_EXPERIMENT_ID_INDEX, EVENT_FILTER_ID_INDEX, EVENT_HUB_TIME_INDEX, EVENT_ID_INDEX, EVENT_LOGGED_TIME_INDEX, EVENT_SESSION_ID_INDEX, EVENT_TYPE_ID, EVENT_TYPE_ID_INDEX, EVENT_TYPE_STRING, IOHUB_DATA_TABLE, PARENT_DEVICE, createEventAsClass, createEventAsDict, createEventAsNamedTuple, e, namedTupleClass
    26. 

  26.     :member-order: bysource
    27. 

  27. 

  28. .. autoclass:: psychopy.iohub.devices.keyboard.KeyboardPressEvent
    29. 

  29.     :members: 
    30. 

  30.     :inherited-members:
    31. 

  31.     :exclude-members: DEVICE_ID_INDEX, filter_id, device_id, NUMPY_DTYPE, BASE_EVENT_MAX_ATTRIBUTE_INDEX, CLASS_ATTRIBUTE_NAMES, EVENT_CONFIDENCE_INTERVAL_INDEX, EVENT_DELAY_INDEX, EVENT_DEVICE_TIME_INDEX, EVENT_EXPERIMENT_ID_INDEX, EVENT_FILTER_ID_INDEX, EVENT_HUB_TIME_INDEX, EVENT_ID_INDEX, EVENT_LOGGED_TIME_INDEX, EVENT_SESSION_ID_INDEX, EVENT_TYPE_ID, EVENT_TYPE_ID_INDEX, EVENT_TYPE_STRING, IOHUB_DATA_TABLE, PARENT_DEVICE, createEventAsClass, createEventAsDict, createEventAsNamedTuple, e, namedTupleClass
    32. 

  32.     :member-order: bysource
    33. 

  33. 

  34. .. autoclass:: psychopy.iohub.devices.keyboard.KeyboardReleaseEvent
    35. 

  35.     :members: 
    36. 

  36.     :inherited-members:
    37. 

  37.     :exclude-members: DEVICE_ID_INDEX, filter_id, device_id, NUMPY_DTYPE, BASE_EVENT_MAX_ATTRIBUTE_INDEX, CLASS_ATTRIBUTE_NAMES, EVENT_CONFIDENCE_INTERVAL_INDEX, EVENT_DELAY_INDEX, EVENT_DEVICE_TIME_INDEX, EVENT_EXPERIMENT_ID_INDEX, EVENT_FILTER_ID_INDEX, EVENT_HUB_TIME_INDEX, EVENT_ID_INDEX, EVENT_LOGGED_TIME_INDEX, EVENT_SESSION_ID_INDEX, EVENT_TYPE_ID, EVENT_TYPE_ID_INDEX, EVENT_TYPE_STRING, IOHUB_DATA_TABLE, PARENT_DEVICE, createEventAsClass, createEventAsDict, createEventAsNamedTuple, e, namedTupleClass
    38. 

  38.     :member-order: bysource
    39. 

  39. 

  40. .. autoclass:: psychopy.iohub.devices.keyboard.KeyboardCharEvent
    41. 

  41.     :members: 
    42. 

  42.     :inherited-members:
    43. 

  43.     :exclude-members: DEVICE_ID_INDEX, filter_id, device_id, NUMPY_DTYPE, BASE_EVENT_MAX_ATTRIBUTE_INDEX, CLASS_ATTRIBUTE_NAMES, EVENT_CONFIDENCE_INTERVAL_INDEX, EVENT_DELAY_INDEX, EVENT_DEVICE_TIME_INDEX, EVENT_EXPERIMENT_ID_INDEX, EVENT_FILTER_ID_INDEX, EVENT_HUB_TIME_INDEX, EVENT_ID_INDEX, EVENT_LOGGED_TIME_INDEX, EVENT_SESSION_ID_INDEX, EVENT_TYPE_ID, EVENT_TYPE_ID_INDEX, EVENT_TYPE_STRING, IOHUB_DATA_TABLE, PARENT_DEVICE, createEventAsClass, createEventAsDict, createEventAsNamedTuple, e, namedTupleClass
    44. 

  44.     :member-order: bysource
    45. 

  45.     
    46. 

  46. Notes and Considerations
    47. 

  47. ###########################
    48. 

  48. 

  49. None at this time.
    50.