usbhidemulator

12 min

El usbhidemulator le permite emular dispositivos HID USB. Los teclados USB son actualmente el único tipo de dispositivo compatible.

Los reproductores BrightSign con USB-C (excepto LS3 y LS4) pueden usar este objeto.

IDL de usbhidemulator

[                                                                                                                                                                                                                                
    constructor(String path, String type)                                                                            
] interface UsbHidEmulator {                                                                                               
    Promise<void> enable();                                                                                                
    Promise<void> disable();                                                                                               
    Promise<void> clear();                                                                                                 
    Promise<void> keyDown(int keycode);  
	Promise<void> keyPress(int keycode);                                                                                  
    Promise<void> keyUp(int keycode);                                                                                      
    Promise<LedState> getLedState();                                                                                       
    Promise<ModifierState> getModifierState();                                                                             
    Promise<void> setModifierState(ModifierState)                                                                          
};

interface LedState {
    [optional] attribute bool numLock;
    [optional] attribute bool capsLock;
    [optional] attribute bool scrollLock;
};

interface ModifierState {
    [optional] attribute bool leftCtrl;
    [optional] attribute bool leftShift;
    [optional] attribute bool leftAlt;
    [optional] attribute bool leftGui;
    [optional] attribute bool rightCtrl;
    [optional] attribute bool rightShift;
    [optional] attribute bool rightAlt;
    [optional] attribute bool rightGui;
};

Creación de objetos

Para crear un objeto usbhidemulator, primero cargue el módulo @brightsign/usbhidemulator usando el método require().

keyem = require('@brightsign/usbhidemulator')
kbd = new keyem()

UsbHideEmulator

Use esta interfaz para configurar una interfaz usbhidemulator. La clase usbhidemulator también genera eventos "ledupdate" que se pueden escuchar con AddEventListener().

enable()

Promise<void> enable()

Habilita el dispositivo HID.

disable()

Promise<void> disable()

Deshabilita el dispositivo HID. Este método no es actualmente compatible.

clear()

Clears all active keystrokes and modifiers.

Borra todas las pulsaciones de teclas y modificadores activos.

keyDown()

Promise<void> keyDown(int keycode)

Envía un evento keydown para el código de tecla USB especificado.

keyPress()

Promise<void> keyPress(int keycode)

Esto es lo mismo que keyDown() seguido de keyUp().

keyUp()

Promise<void> keyUp(int keycode)

Envía un evento keyup para el código de tecla USB especificado.

getLedState()

Promise<LedState> getLedState()

Devuelve una matriz asociativa con el estado actual de todos los estados LED del teclado.

getModifierState()

Promise<ModifierState> getModifierState()

Devuelve una matriz asociativa con el estado actual de todos los modificadores (como shift, alt y ctrl).

setModifierState()

Promise<ModifierState> setModifierState(ModifierState)

Establece el estado actual del modificador según lo especificado por un arreglo asociativo. Solo los modificadores que se enumeran provocarán que el estado cambie.

Código de tecla

Esta interfaz contiene el código de tecla USB.

keycode int

Los códigos de teclado USB HID están en la sección 10 de www.usb.org/sites/default/files/documents/hut1_12v2.pdf.

Estado LED

Esta interfaz envía un cambio de estado LED si se presiona number lock, capital lock o scroll lock.

Bloq Num bool opcional
capsLock bool opcional
scrollLock bool opcional

Estado del modificador

Los modificadores enumerados provocarán que el estado cambie.

leftCtrl bool opcional
leftShift bool opcional
leftAlt bool opcional
leftGui bool opcional
rightCtrl bool opcional
rightShift bool opcional
rightAlt bool opcional
rightGui bool opcional

Ejemplo

keyem = require('@brightsign/usbhidemulator')
kbd = new keyem()
kbd.addEventListener("ledupdate", function f(e) { console.log(e);})
kbd.enable()

kbd.keyPress(4)