{"type":"doc","content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"usbhidemulator","type":"text","marks":[{"type":"em"}]},{"text":" allows you to emulate USB HID devices. USB keyboards are currently the only supported device type. ","type":"text"}]},{"type":"paragraph","content":[{"text":"BrightSign players with USB-C (except for LS3 and LS4) can use this object.","type":"text"}]},{"type":"paragraph","content":[{"text":"usbhidemulator IDL","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"[ \n constructor(String path, String type) \n] interface UsbHidEmulator { \n Promise enable(); \n Promise disable(); \n Promise clear(); \n Promise keyDown(int keycode); \n\tPromise keyPress(int keycode); \n Promise keyUp(int keycode); \n Promise getLedState(); \n Promise getModifierState(); \n Promise setModifierState(ModifierState) \n};\n\ninterface LedState {\n [optional] attribute bool numLock;\n [optional] attribute bool capsLock;\n [optional] attribute bool scrollLock;\n};\n\ninterface ModifierState {\n [optional] attribute bool leftCtrl;\n [optional] attribute bool leftShift;\n [optional] attribute bool leftAlt;\n [optional] attribute bool leftGui;\n [optional] attribute bool rightCtrl;\n [optional] attribute bool rightShift;\n [optional] attribute bool rightAlt;\n [optional] attribute bool rightGui;\n}; \n ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Object Creation","type":"text"}]},{"type":"paragraph","content":[{"text":"To create a ","type":"text"},{"text":"usbhidemulator","type":"text","marks":[{"type":"em"}]},{"text":" object, first load the ","type":"text"},{"text":"@brightsign/usbhidemulator","type":"text","marks":[{"type":"em"}]},{"text":" module using the ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]},{"text":"require()","type":"text","marks":[{"type":"em"}]},{"text":" method.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"keyem = require('@brightsign/usbhidemulator')\nkbd = new keyem()","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"UsbHideEmulator","type":"text"}]},{"type":"paragraph","content":[{"text":"Use this interface to configure a ","type":"text"},{"text":"usbhidemulator","type":"text","marks":[{"type":"em"}]},{"text":" interface.","type":"text"},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#3d3d3d"}}]},{"text":"The ","type":"text"},{"text":"usbhidemulator","type":"text","marks":[{"type":"em"}]},{"text":" class also generates \"ledupdate\" events which can be listened for with ","type":"text"},{"text":"AddEventListener().","type":"text","marks":[{"type":"em"}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"enable()","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"Promise enable()","type":"text"}]},{"type":"paragraph","content":[{"text":"Enables the HID device.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"disable()","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"Promise disable()","type":"text"}]},{"type":"paragraph","content":[{"text":"Disables the HID device. This method is not currently supported.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"clear()","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"Promise clear()","type":"text"}]},{"type":"paragraph","content":[{"text":"Clears all active keystrokes and modifiers.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"keyDown()","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"Promise keyDown(int keycode)","type":"text"}]},{"type":"paragraph","content":[{"text":"Sends a keydown event for the specified USB key code.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"keyPress()","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"Promise keyPress(int keycode)","type":"text"}]},{"type":"paragraph","content":[{"text":"This is the same as keyDown() followed by keyUp().","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"keyUp()","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"Promise keyUp(int keycode)","type":"text"}]},{"type":"paragraph","content":[{"text":"Sends a keyup event for the specified USB key code.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"getLedState()","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"Promise getLedState()","type":"text"}]},{"type":"paragraph","content":[{"text":"R","type":"text"},{"text":"eturns an associative array with the current state of all LED states on the keyboard.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"getModifierState()","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"Promise getModifierState()","type":"text"}]},{"type":"paragraph","content":[{"text":"R","type":"text"},{"text":"eturns an associative array with the current state of all modifiers (such as, shift, alt, ctrl).","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"setModifierState()","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"Promise setModifierState(ModifierState)","type":"text"}]},{"type":"paragraph","content":[{"text":"Sets the current modifier state as specified by an associative array. Only modifiers that are listed will cause the state to change.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Keycode","type":"text"}]},{"type":"paragraph","content":[{"text":"This interface contains the USB key code. ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"keycode","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"int","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]}]}]}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"USB HID keyboard codes are in section 10 of ","type":"text"},{"text":"www.usb.org/sites/default/files/documents/hut1_12v2.pdf","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}},{"type":"link","attrs":{"href":"https://www.usb.org/sites/default/files/documents/hut1_12v2.pdf"}}]},{"text":".","type":"text","marks":[{"type":"textColor","attrs":{"color":"#172b4d"}}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"LedState","type":"text"}]},{"type":"paragraph","content":[{"text":"This interface ","type":"text"},{"text":"sends an LED state change if number lock, capital lock, or scroll lock is pressed.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"numLock","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"bool","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"capsLock","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"bool","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"scrollLock","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"bool","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"ModifierState","type":"text"}]},{"type":"paragraph","content":[{"text":"Listed modifiers will cause the state to change.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"leftCtrl","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"bool","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"leftShift","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"bool","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"leftAlt","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"bool","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"leftGui","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"bool","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"rightCtrl","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"bool","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"rightShift","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"bool","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"rightAlt","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"bool","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"rightGui","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"bool","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Example","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"keyem = require('@brightsign/usbhidemulator')\nkbd = new keyem()\nkbd.addEventListener(\"ledupdate\", function f(e) { console.log(e);})\nkbd.enable()\n\nkbd.keyPress(4)","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}],"version":1}

Browser not supported