chroom.hid

Beschrijving

Gebruik de chrome.hid API om te communiceren met aangesloten HID-apparaten. Deze API biedt toegang tot HID-bewerkingen vanuit de context van een app. Met behulp van deze API kunnen apps fungeren als stuurprogramma's voor hardwareapparaten. Fouten die door deze API worden gegenereerd, worden gerapporteerd door runtime.lastError in te stellen en de reguliere callback van de functie uit te voeren. De reguliere parameters van de callback zijn in dit geval niet gedefinieerd.

Toestemmingen

hid

Soorten

DeviceFilter

Eigenschappen

  • productId

    nummer optioneel

    Apparaatproduct-ID, wordt alleen gecontroleerd als de leveranciers-ID overeenkomt.

  • gebruik

    nummer optioneel

    HID-gebruiksidentificatiecode, wordt alleen gecontroleerd als de HID-gebruikspagina overeenkomt.

  • gebruikspagina

    nummer optioneel

    HID-gebruikspagina-identificatie.

  • leveranciers-ID

    nummer optioneel

    Apparaatleveranciers-ID.

GetDevicesOptions

Eigenschappen

  • filters

    Apparaatfilter [] optioneel

    Een apparaat dat aan een bepaald filter voldoet, wordt geretourneerd. Een lege filterlijst retourneert alle apparaten waarvoor de app toestemming heeft.

  • productId

    nummer optioneel

    Verouderd

    Gelijkwaardig aan het instellen DeviceFilter.productId .

  • leveranciers-ID

    nummer optioneel

    Verouderd

    Gelijkwaardig aan het instellen DeviceFilter.vendorId .

HidCollectionInfo

Eigenschappen

  • rapport-ID's

    nummer[]

    Rapporteer de ID's die bij de collectie en de daaraan gerelateerde collecties horen.

  • gebruik

    nummer

    Paginaspecifieke gebruiksidentificatie.

  • gebruikspagina

    nummer

    HID-gebruikspagina-identificatie.

HidConnectInfo

Eigenschappen

  • verbindings-ID

    nummer

    De ondoorzichtige ID wordt gebruikt om deze verbinding in alle andere functies te identificeren.

HidDeviceInfo

Eigenschappen

  • Collecties op het hoogste niveau uit de rapportbeschrijvingen van dit apparaat.

  • apparaat-ID

    nummer

    Onzichtbare apparaat-ID.

  • maxFeatureReportSize

    nummer

    Maximale omvang van een functierapport op het hoogste niveau van een collectie.

  • maxInputReportSize

    nummer

    Maximale rapportgrootte voor invoer op het hoogste niveau van de collectie.

  • maxOutputReportSize

    nummer

    Maximale rapportgrootte voor de uitvoer van een collectie op het hoogste niveau.

  • productId

    nummer

    Product-ID.

  • productName

    snaar

    Chrome 46+

    De productnaam, afgelezen van het apparaat, indien beschikbaar.

  • rapportbeschrijving

    ArrayBuffer

    Beschrijving van het onbewerkte apparaatrapport (niet beschikbaar op Windows).

  • serienummer

    snaar

    Chrome 46+

    Het serienummer dat van het apparaat is afgelezen, indien beschikbaar.

  • leveranciers-ID

    nummer

    Leveranciers-ID.

Methoden

connect()

Belofte
chrome.hid.connect(
  deviceId: number,
  callback?: function,
): Promise<HidConnectInfo>

Maak een verbinding met een HID-apparaat voor communicatie.

Parameters

Retourneert

  • Promise< HiddenConnectInfo >

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

disconnect()

Belofte
chrome.hid.disconnect(
  connectionId: number,
  callback?: function,
): Promise<void>

De verbinding met een apparaat verbreken. Het uitvoeren van bewerkingen op een apparaat na het aanroepen van deze functie is veilig, maar heeft geen effect.

Parameters

  • verbindings-ID

    nummer

    De connectionId die door connect wordt geretourneerd.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retourneert

  • Promise<void>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

getDevices()

Belofte
chrome.hid.getDevices(
  options: GetDevicesOptions,
  callback?: function,
): Promise<HidDeviceInfo[]>

Maak een lijst van aangesloten HID-apparaten.

Parameters

Retourneert

  • Promise< HiddenDeviceInfo []>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

receive()

chrome.hid.receive(
  connectionId: number,
  callback: function,
): void

Ontvang het volgende invoerrapport van het apparaat.

Parameters

  • verbindings-ID

    nummer

    De connectionId die door connect wordt geretourneerd.

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

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

    • rapport-ID

      nummer

      Het rapport-ID of 0 als er geen is.

    • gegevens

      ArrayBuffer

      De rapportgegevens, inclusief het rapport-ID-voorvoegsel (indien aanwezig), worden verwijderd.

receiveFeatureReport()

Belofte
chrome.hid.receiveFeatureReport(
  connectionId: number,
  reportId: number,
  callback?: function,
): Promise<ArrayBuffer>

Vraag een functierapport aan vanaf het apparaat.

Parameters

  • verbindings-ID

    nummer

    De connectionId die door connect wordt geretourneerd.

  • rapport-ID

    nummer

    Het rapport-ID, of 0 als er geen is.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (data: ArrayBuffer) => void

    • gegevens

      ArrayBuffer

      De rapportgegevens, inclusief een rapport-ID-prefix indien deze door het apparaat wordt verzonden.

Retourneert

  • Promise<ArrayBuffer>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

send()

Belofte
chrome.hid.send(
  connectionId: number,
  reportId: number,
  data: ArrayBuffer,
  callback?: function,
): Promise<void>

Stuur een uitvoerrapport naar het apparaat.

Let op: Voeg geen rapport-ID-prefix toe aan data . Deze wordt indien nodig toegevoegd.

Parameters

  • verbindings-ID

    nummer

    De connectionId die door connect wordt geretourneerd.

  • rapport-ID

    nummer

    Het rapport-ID dat moet worden gebruikt, of 0 als er geen is.

  • gegevens

    ArrayBuffer

    De rapportgegevens.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retourneert

  • Promise<void>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

sendFeatureReport()

Belofte
chrome.hid.sendFeatureReport(
  connectionId: number,
  reportId: number,
  data: ArrayBuffer,
  callback?: function,
): Promise<void>

Stuur een functierapport naar het apparaat.

Let op: Voeg geen rapport-ID-prefix toe aan data . Deze wordt indien nodig toegevoegd.

Parameters

  • verbindings-ID

    nummer

    De connectionId die door connect wordt geretourneerd.

  • rapport-ID

    nummer

    Het rapport-ID dat moet worden gebruikt, of 0 als er geen is.

  • gegevens

    ArrayBuffer

    De rapportgegevens.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retourneert

  • Promise<void>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

Evenementen

onDeviceAdded

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

Deze gebeurtenis wordt gegenereerd wanneer een apparaat aan het systeem wordt toegevoegd. Gebeurtenissen worden alleen verzonden naar apps en extensies die toestemming hebben om toegang tot het apparaat te krijgen. Toestemming kan zijn verleend tijdens de installatie of toen de gebruiker een optionele toestemming accepteerde (zie permissions.request ).

Parameters

onDeviceRemoved

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

Deze gebeurtenis wordt gegenereerd wanneer een apparaat uit het systeem wordt verwijderd. Zie onDeviceAdded voor een overzicht van de gebeurtenissen die worden weergegeven.

Parameters

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

    (deviceId: number) => void

    • apparaat-ID

      nummer

,

Beschrijving

Gebruik de chrome.hid API om te communiceren met aangesloten HID-apparaten. Deze API biedt toegang tot HID-bewerkingen vanuit de context van een app. Met behulp van deze API kunnen apps fungeren als stuurprogramma's voor hardwareapparaten. Fouten die door deze API worden gegenereerd, worden gerapporteerd door runtime.lastError in te stellen en de reguliere callback van de functie uit te voeren. De reguliere parameters van de callback zijn in dit geval niet gedefinieerd.

Toestemmingen

hid

Soorten

DeviceFilter

Eigenschappen

  • productId

    nummer optioneel

    Apparaatproduct-ID, wordt alleen gecontroleerd als de leveranciers-ID overeenkomt.

  • gebruik

    nummer optioneel

    HID-gebruiksidentificatiecode, wordt alleen gecontroleerd als de HID-gebruikspagina overeenkomt.

  • gebruikspagina

    nummer optioneel

    HID-gebruikspagina-identificatie.

  • leveranciers-ID

    nummer optioneel

    Apparaatleveranciers-ID.

GetDevicesOptions

Eigenschappen

  • filters

    Apparaatfilter [] optioneel

    Een apparaat dat aan een bepaald filter voldoet, wordt geretourneerd. Een lege filterlijst retourneert alle apparaten waarvoor de app toestemming heeft.

  • productId

    nummer optioneel

    Verouderd

    Gelijkwaardig aan het instellen DeviceFilter.productId .

  • leveranciers-ID

    nummer optioneel

    Verouderd

    Gelijkwaardig aan het instellen DeviceFilter.vendorId .

HidCollectionInfo

Eigenschappen

  • rapport-ID's

    nummer[]

    Rapporteer de ID's die bij de collectie en de daaraan gerelateerde collecties horen.

  • gebruik

    nummer

    Paginaspecifieke gebruiksidentificatie.

  • gebruikspagina

    nummer

    HID-gebruikspagina-identificatie.

HidConnectInfo

Eigenschappen

  • verbindings-ID

    nummer

    De ondoorzichtige ID wordt gebruikt om deze verbinding in alle andere functies te identificeren.

HidDeviceInfo

Eigenschappen

  • Collecties op het hoogste niveau uit de rapportbeschrijvingen van dit apparaat.

  • apparaat-ID

    nummer

    Onzichtbare apparaat-ID.

  • maxFeatureReportSize

    nummer

    Maximale omvang van een functierapport op het hoogste niveau van een collectie.

  • maxInputReportSize

    nummer

    Maximale rapportgrootte voor invoer op het hoogste niveau van de collectie.

  • maxOutputReportSize

    nummer

    Maximale rapportgrootte voor de uitvoer van een collectie op het hoogste niveau.

  • productId

    nummer

    Product-ID.

  • productName

    snaar

    Chrome 46+

    De productnaam, afgelezen van het apparaat, indien beschikbaar.

  • rapportbeschrijving

    ArrayBuffer

    Beschrijving van het onbewerkte apparaatrapport (niet beschikbaar op Windows).

  • serienummer

    snaar

    Chrome 46+

    Het serienummer dat van het apparaat is afgelezen, indien beschikbaar.

  • leveranciers-ID

    nummer

    Leveranciers-ID.

Methoden

connect()

Belofte
chrome.hid.connect(
  deviceId: number,
  callback?: function,
): Promise<HidConnectInfo>

Maak een verbinding met een HID-apparaat voor communicatie.

Parameters

Retourneert

  • Promise< HiddenConnectInfo >

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

disconnect()

Belofte
chrome.hid.disconnect(
  connectionId: number,
  callback?: function,
): Promise<void>

De verbinding met een apparaat verbreken. Het uitvoeren van bewerkingen op een apparaat na het aanroepen van deze functie is veilig, maar heeft geen effect.

Parameters

  • verbindings-ID

    nummer

    De connectionId die door connect wordt geretourneerd.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retourneert

  • Promise<void>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

getDevices()

Belofte
chrome.hid.getDevices(
  options: GetDevicesOptions,
  callback?: function,
): Promise<HidDeviceInfo[]>

Maak een lijst van aangesloten HID-apparaten.

Parameters

Retourneert

  • Promise< HiddenDeviceInfo []>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

receive()

chrome.hid.receive(
  connectionId: number,
  callback: function,
): void

Ontvang het volgende invoerrapport van het apparaat.

Parameters

  • verbindings-ID

    nummer

    De connectionId die door connect wordt geretourneerd.

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

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

    • rapport-ID

      nummer

      Het rapport-ID of 0 als er geen is.

    • gegevens

      ArrayBuffer

      De rapportgegevens, inclusief het rapport-ID-voorvoegsel (indien aanwezig), worden verwijderd.

receiveFeatureReport()

Belofte
chrome.hid.receiveFeatureReport(
  connectionId: number,
  reportId: number,
  callback?: function,
): Promise<ArrayBuffer>

Vraag een functierapport aan vanaf het apparaat.

Parameters

  • verbindings-ID

    nummer

    De connectionId die door connect wordt geretourneerd.

  • rapport-ID

    nummer

    Het rapport-ID, of 0 als er geen is.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (data: ArrayBuffer) => void

    • gegevens

      ArrayBuffer

      De rapportgegevens, inclusief een rapport-ID-prefix indien deze door het apparaat wordt verzonden.

Retourneert

  • Promise<ArrayBuffer>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

send()

Belofte
chrome.hid.send(
  connectionId: number,
  reportId: number,
  data: ArrayBuffer,
  callback?: function,
): Promise<void>

Stuur een uitvoerrapport naar het apparaat.

Let op: Voeg geen rapport-ID-prefix toe aan data . Deze wordt indien nodig toegevoegd.

Parameters

  • verbindings-ID

    nummer

    De connectionId die door connect wordt geretourneerd.

  • rapport-ID

    nummer

    Het rapport-ID dat moet worden gebruikt, of 0 als er geen is.

  • gegevens

    ArrayBuffer

    De rapportgegevens.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retourneert

  • Promise<void>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

sendFeatureReport()

Belofte
chrome.hid.sendFeatureReport(
  connectionId: number,
  reportId: number,
  data: ArrayBuffer,
  callback?: function,
): Promise<void>

Stuur een functierapport naar het apparaat.

Let op: Voeg geen rapport-ID-prefix toe aan data . Deze wordt indien nodig toegevoegd.

Parameters

  • verbindings-ID

    nummer

    De connectionId die door connect wordt geretourneerd.

  • rapport-ID

    nummer

    Het rapport-ID dat moet worden gebruikt, of 0 als er geen is.

  • gegevens

    ArrayBuffer

    De rapportgegevens.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retourneert

  • Promise<void>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

Evenementen

onDeviceAdded

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

Deze gebeurtenis wordt gegenereerd wanneer een apparaat aan het systeem wordt toegevoegd. Gebeurtenissen worden alleen verzonden naar apps en extensies die toestemming hebben om toegang tot het apparaat te krijgen. Toestemming kan zijn verleend tijdens de installatie of toen de gebruiker een optionele toestemming accepteerde (zie permissions.request ).

Parameters

onDeviceRemoved

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

Deze gebeurtenis wordt gegenereerd wanneer een apparaat uit het systeem wordt verwijderd. Zie onDeviceAdded voor een overzicht van de gebeurtenissen die worden weergegeven.

Parameters

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

    (deviceId: number) => void

    • apparaat-ID

      nummer