Descripción
Usa la API de chrome.hid
para interactuar con dispositivos HID conectados. Esta API proporciona acceso a operaciones HID desde el contexto de una app. Con esta API, las apps pueden funcionar como controladores para dispositivos de hardware. Los errores que genera esta API se informan configurando runtime.lastError
y ejecutando la devolución de llamada normal de la función. En este caso, los parámetros habituales de la devolución de llamada no estarán definidos.
Permisos
hid
Tipos
DeviceFilter
Propiedades
-
productId
número opcional
Es el ID del producto del dispositivo; solo se marca si el ID del proveedor coincide.
-
uso
número opcional
Es el identificador de uso de HID, que se verifica solo si la página de uso de HID coincide.
-
usagePage
número opcional
Es el identificador de la página de uso de HID.
-
vendorId
número opcional
Es el ID del proveedor del dispositivo.
GetDevicesOptions
Propiedades
-
filtros
DeviceFilter[] opcional
Se mostrará un dispositivo que coincida con cualquier filtro determinado. Si la lista de filtros está vacía, se mostrarán todos los dispositivos para los que la app tenga permiso.
-
productId
número opcional
ObsoletoEquivale a la configuración
DeviceFilter.productId
. -
vendorId
número opcional
ObsoletoEquivale a la configuración
DeviceFilter.vendorId
.
HidCollectionInfo
Propiedades
-
reportIds
número
Los ID de informes que pertenecen a la colección y a sus elementos secundarios
-
uso
número
Es el identificador de uso definido por la página.
-
usagePage
número
Es el identificador de la página de uso de HID.
HidConnectInfo
Propiedades
-
connectionId
número
Es el ID opaco que se usa para identificar esta conexión en todas las demás funciones.
HidDeviceInfo
Propiedades
-
colecciones
Colecciones de nivel superior de los descriptores de informes de este dispositivo.
-
deviceId
número
Es el ID de dispositivo opaco.
-
maxFeatureReportSize
número
Tamaño máximo del informe de funciones de la colección de nivel superior.
-
maxInputReportSize
número
Tamaño máximo del informe de entrada de la colección de nivel superior.
-
maxOutputReportSize
número
Tamaño máximo del informe de resultados de la colección de nivel superior.
-
productId
número
Es el ID del producto.
-
NombreProducto
string
Chrome 46 y versiones posterioresEs el nombre del producto que se lee en el dispositivo, si está disponible.
-
reportDescriptor
ArrayBuffer
Descriptor de informes de dispositivos sin procesar (no disponible en Windows).
-
serialNumber
string
Chrome 46 y versiones posterioresEs el número de serie que se lee en el dispositivo, si está disponible.
-
vendorId
número
ID del proveedor
Métodos
connect()
chrome.hid.connect(
deviceId: number,
callback?: function,
)
Abre una conexión con un dispositivo HID para la comunicación.
Parámetros
-
deviceId
número
El
HidDeviceInfo.deviceId
del dispositivo que se abrirá. -
callback
función opcional
El parámetro
callback
se ve de la siguiente manera:(connection: HidConnectInfo) => void
-
connection
-
Muestra
-
Promise<HidConnectInfo>
Chrome 117 y versiones posterioresLas promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.
disconnect()
chrome.hid.disconnect(
connectionId: number,
callback?: function,
)
Desconéctate de un dispositivo. Invocar operaciones en un dispositivo después de la llamada es segura, pero no tiene efecto.
Parámetros
-
connectionId
número
El
connectionId
que muestraconnect
. -
callback
función opcional
El parámetro
callback
se ve de la siguiente manera:() => void
Muestra
-
Promesa<void>
Chrome 117 y versiones posterioresLas promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.
getDevices()
chrome.hid.getDevices(
options: GetDevicesOptions,
callback?: function,
)
Enumerar los dispositivos HID conectados
Parámetros
-
opciones
Las propiedades que se buscarán en los dispositivos de destino.
-
callback
función opcional
El parámetro
callback
se ve de la siguiente manera:(devices: HidDeviceInfo[]) => void
-
dispositivos
-
Muestra
-
Promise<HidDeviceInfo[]>
Chrome 117 y versiones posterioresLas promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.
receive()
chrome.hid.receive(
connectionId: number,
callback: function,
)
Recibir el siguiente informe de entrada del dispositivo
Parámetros
-
connectionId
número
El
connectionId
que muestraconnect
. -
callback
función
El parámetro
callback
se ve de la siguiente manera:(reportId: number, data: ArrayBuffer) => void
-
ID de informe
número
El ID de informe o
0
si no hay ninguno. -
datos
ArrayBuffer
Se quitan los datos del informe, el prefijo de ID del informe (si está presente).
-
receiveFeatureReport()
chrome.hid.receiveFeatureReport(
connectionId: number,
reportId: number,
callback?: function,
)
Solicita un informe de funciones del dispositivo.
Parámetros
-
connectionId
número
El
connectionId
que muestraconnect
. -
ID de informe
número
El ID del informe o
0
si no hay ninguno. -
callback
función opcional
El parámetro
callback
se ve de la siguiente manera:(data: ArrayBuffer) => void
-
datos
ArrayBuffer
Los datos del informe, incluido un prefijo de ID del informe si el dispositivo envía uno.
-
Muestra
-
Promesa<ArrayBuffer>
Chrome 117 y versiones posterioresLas promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.
send()
chrome.hid.send(
connectionId: number,
reportId: number,
data: ArrayBuffer,
callback?: function,
)
Envía un informe de resultados al dispositivo.
Nota: No incluyas un prefijo de ID de informe en data
. Se agregará si es necesario.
Parámetros
-
connectionId
número
El
connectionId
que muestraconnect
. -
ID de informe
número
El ID de informe que se usará o
0
si no hay ninguno. -
datos
ArrayBuffer
Son los datos del informe.
-
callback
función opcional
El parámetro
callback
se ve de la siguiente manera:() => void
Muestra
-
Promesa<void>
Chrome 117 y versiones posterioresLas promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.
sendFeatureReport()
chrome.hid.sendFeatureReport(
connectionId: number,
reportId: number,
data: ArrayBuffer,
callback?: function,
)
Envía un informe de funciones al dispositivo.
Nota: No incluyas un prefijo de ID de informe en data
. Se agregará si es necesario.
Parámetros
-
connectionId
número
El
connectionId
que muestraconnect
. -
ID de informe
número
El ID de informe que se usará o
0
si no hay ninguno. -
datos
ArrayBuffer
Son los datos del informe.
-
callback
función opcional
El parámetro
callback
se ve de la siguiente manera:() => void
Muestra
-
Promesa<void>
Chrome 117 y versiones posterioresLas promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.
Eventos
onDeviceAdded
chrome.hid.onDeviceAdded.addListener(
callback: function,
)
Evento que se genera cuando se agrega un dispositivo al sistema. Los eventos solo se transmiten a las apps y extensiones que tienen permiso para acceder al dispositivo. Es posible que se haya otorgado el permiso en el momento de la instalación o cuando el usuario aceptó un permiso opcional (consulta permissions.request
).
Parámetros
-
callback
función
El parámetro
callback
se ve de la siguiente manera:(device: HidDeviceInfo) => void
-
dispositivo
-
onDeviceRemoved
chrome.hid.onDeviceRemoved.addListener(
callback: function,
)
Evento generado cuando se quita un dispositivo del sistema. Consulta onDeviceAdded
para saber qué eventos se publican.
Parámetros
-
callback
función
El parámetro
callback
se ve de la siguiente manera:(deviceId: number) => void
-
deviceId
número
-