HelpSource/Classes/GeneralHIDDevice.schelp

   1 class:: GeneralHIDDevice
   2 summary:: A uniform class to an HID device
   3 related:: Classes/HIDDeviceService, Classes/LID, Classes/GeneralHID, Classes/GeneralHIDSpec
   4 categories:: External Control>HID
   5
   6 description::
   7 GeneralHID is a cross platform wrapper for accessing HID devices. Currently the MacOSX and Linux HID support has been wrapped. Some of the code is inspired by the GUI wrapper.
   8 A GeneralHIDDevice accesses one HID device, such as a mouse, joystick or gamepad. Devices are automatically created when a building the device list with link::Classes/GeneralHID::, so it is not necessary for a user to create a new device.
   9
  10 See link::Classes/GeneralHID:: for a complete explanation and an example of how to access an HID device.
  11
  12 note::
  13 It is advised to use this class instead of the platform specific classes: link::Classes/HIDDeviceService:: (on MacOSX) and link::Classes/LID:: (on Linux)
  14 ::
  15
  16 subsection::Some outstanding issues
  17 This class is not completely finished yet. Common slot numbers across platforms are not yet guaranteed. On Windows there is not yet a proper implementation available.
  18
  19 InstanceMethods::
  20
  21 method::isOpen
  22 Checks whether the device is open.
  23
  24 method::info
  25 Display information about the device, such as the name and vendor.
  26
  27 method::caps
  28 Display information about the capabilities of the device in a readable format.
  29
  30 method::slots
  31 Access to the slots of the device. See link::Classes/GeneralHIDSlot::.
  32
  33 method::makeGui
  34 Make a generic gui to see the data coming in on the slots.
  35
  36 method::close
  37 Closes the device.
  38
  39 method::grab
  40 Get exclusive access to the device (linux only). Be careful with this when it is the only keyboard, as you will have no way to get back control.
  41
  42 method::ungrab
  43 Give up exclusive access to the device (linux only).
  44
  45
  46 Examples::
  47
  48 See link::Classes/GeneralHID::. for a complete example of using an HID device.