chrome.hid

Descripción

Usa la API de chrome.hid para interactuar con dispositivos HID conectados. Esta API proporciona acceso a operaciones de HID desde el contexto de una app. Con esta API, las apps pueden funcionar como controladores de dispositivos de hardware. Los errores generados por esta API se informan configurando runtime.lastError y ejecutando la devolución de llamada normal de la función. Los parámetros regulares de la devolución de llamada no se definirán en este caso.

Permisos

hid

Tipos

DeviceFilter

Propiedades

  • productId

    número opcional

    ID del producto del dispositivo. Solo se verifica si el ID del proveedor coincide.

  • uso

    número opcional

    Es el identificador de uso de HID, que se marca solo si coincide la página de uso de HID.

  • usagePage

    número opcional

    Es el identificador de la página de uso de HID.

  • vendorId

    número opcional

    ID del proveedor del dispositivo.

GetDevicesOptions

Propiedades

  • filtros

    DeviceFilter[] opcional

    Se mostrará un dispositivo que coincida con cualquiera de los filtros. Una lista de filtros vacía mostrará todos los dispositivos para los que la app tiene permiso.

  • productId

    número opcional

    Obsoleto

    Equivale a la configuración DeviceFilter.productId.

  • vendorId

    número opcional

    Obsoleto

    Equivale a la configuración DeviceFilter.vendorId.

HidCollectionInfo

Propiedades

  • reportIds

    número

    Los IDs 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

    El ID opaco que se usa para identificar esta conexión en todas las demás funciones.

HidDeviceInfo

Propiedades

  • colecciones

    HidCollectionInfo.

    Colecciones de nivel superior de los descriptores de informes de este dispositivo.

  • deviceId

    número

    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 salida de la colección de nivel superior.

  • productId

    número

    Es el ID del producto.

  • productName

    cadena

    Chrome 46 y versiones posteriores

    Es el nombre del producto que se leyó en el dispositivo, si está disponible.

  • reportDescriptor

    ArrayBuffer

    Descriptor de informes de dispositivos sin procesar (no disponible en Windows).

  • serialNumber

    cadena

    Chrome 46 y versiones posteriores

    Es el número de serie leído del dispositivo, si está disponible.

  • vendorId

    número

    ID del proveedor.

Métodos

connect()

Promesa 
chrome.hid.connect(
  deviceId: number,
  callback?: function,
)

Abre una conexión con un dispositivo HID para la comunicación.

Parámetros

Devuelve

  • Promise<HidConnectInfo>

    Chrome 117 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

disconnect()

Promesa 
chrome.hid.disconnect(
  connectionId: number,
  callback?: function,
)

Desconéctate de un dispositivo. La invocación de operaciones en un dispositivo después de llamarla es segura, pero no tiene ningún efecto.

Parámetros

  • connectionId

    número

    La connectionId que muestra connect.

  • callback

    Función opcional

    El parámetro callback se ve de la siguiente manera: 

    ()=>void

Devuelve

  • Promise<void>

    Chrome 117 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

getDevices()

Promesa 
chrome.hid.getDevices(
  options: GetDevicesOptions,
  callback?: function,
)

Permite enumerar los dispositivos HID conectados.

Parámetros

  • 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

Devuelve

  • Promise<HidDeviceInfo[]>

    Chrome 117 y versiones posteriores

    Las 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

    La connectionId que muestra connect.

  • callback

    la función

    El parámetro callback se ve de la siguiente manera: 

    (reportId: number,data: ArrayBuffer)=>void

    • reportId

      número

      El ID de informe o 0, en caso de que no haya ninguno.

    • datos

      ArrayBuffer

      Con los datos del informe, se quita el prefijo de ID del informe (si está presente).

receiveFeatureReport()

Promesa 
chrome.hid.receiveFeatureReport(
  connectionId: number,
  reportId: number,
  callback?: function,
)

Solicita un informe de funciones del dispositivo.

Parámetros

  • connectionId

    número

    La connectionId que muestra connect.

  • reportId

    número

    El ID de 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 de informe, si el dispositivo envía uno.

Devuelve

  • Promise<ArrayBuffer>

    Chrome 117 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

send()

Promesa 
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

    La connectionId que muestra connect.

  • reportId

    número

    El ID de informe que se usará o 0 si no hay ninguno.

  • datos

    ArrayBuffer

    Los datos del informe

  • callback

    Función opcional

    El parámetro callback se ve de la siguiente manera: 

    ()=>void

Devuelve

  • Promise<void>

    Chrome 117 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

sendFeatureReport()

Promesa 
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

    La connectionId que muestra connect.

  • reportId

    número

    El ID de informe que se usará o 0 si no hay ninguno.

  • datos

    ArrayBuffer

    Los datos del informe

  • callback

    Función opcional

    El parámetro callback se ve de la siguiente manera: 

    ()=>void

Devuelve

  • Promise<void>

    Chrome 117 y versiones posteriores

    Las 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 generado cuando se agrega un dispositivo al sistema Los eventos solo se transmiten a las aplicaciones y extensiones que tienen permiso para acceder al dispositivo. El permiso se puede haber otorgado en el momento de la instalación o cuando el usuario aceptó un permiso opcional (consulta permissions.request).

Parámetros

  • callback

    la función

    El parámetro callback se ve de la siguiente manera: 

    (device: HidDeviceInfo)=>void

onDeviceRemoved

chrome.hid.onDeviceRemoved.addListener(
  callback: function,
)

Es el evento que se genera cuando se quita un dispositivo del sistema. Consulta onDeviceAdded para saber qué eventos se publican.

Parámetros

  • callback

    la función

    El parámetro callback se ve de la siguiente manera: 

    (deviceId: number)=>void

    • deviceId

      número