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 functioneren 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.

Machtigingen

hid

Soorten

DeviceFilter

Eigenschappen

  • productId

    nummer optioneel

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

  • gebruik

    nummer optioneel

    HID-gebruiksidentificatie, alleen gecontroleerd als de HID-gebruikspagina overeenkomt.

  • gebruikPagina

    nummer optioneel

    HID-gebruikspagina-ID.

  • leverancierId

    nummer optioneel

    Leveranciers-ID van apparaat.

GetDevicesOptions

Eigenschappen

  • filters

    DeviceFilter [] 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

    Afgekeurd

    Gelijk aan het instellen van DeviceFilter.productId .

  • leverancierId

    nummer optioneel

    Afgekeurd

    Gelijk aan het instellen van DeviceFilter.vendorId .

HidCollectionInfo

Eigenschappen

  • rapportIds

    nummer[]

    Rapporteer ID's die bij de collectie en de onderliggende elementen horen.

  • gebruik

    nummer

    Door pagina gedefinieerde gebruiks-ID.

  • gebruikPagina

    nummer

    HID-gebruikspagina-ID.

HidConnectInfo

Eigenschappen

  • verbindingId

    nummer

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

HidDeviceInfo

Eigenschappen

  • collecties

    HidCollectionInfo []

    Verzamelingen op het hoogste niveau van de rapportbeschrijvingen van dit apparaat.

  • apparaatID

    nummer

    Ondoorzichtige apparaat-ID.

  • maxFeatureReportSize

    nummer

    Maximale functierapportgrootte van de verzameling op het hoogste niveau.

  • maxInputReportSize

    nummer

    Maximale invoerrapportgrootte van de verzameling op het hoogste niveau.

  • maxOutputReportSize

    nummer

    Maximale uitvoerrapportgrootte van de verzameling op het hoogste niveau.

  • productId

    nummer

    Product-ID.

  • productnaam

    snaar

    Chroom 46+

    De productnaam die van het apparaat wordt gelezen, indien beschikbaar.

  • rapportDescriptor

    ArrayBuffer

    Ruwe apparaatrapportdescriptor (niet beschikbaar in Windows).

  • serienummer

    snaar

    Chroom 46+

    Het serienummer dat van het apparaat wordt gelezen, indien beschikbaar.

  • leverancierId

    nummer

    Leverancier-ID.

Methoden

connect()

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

Open een verbinding met een HID-apparaat voor communicatie.

Parameters

Retouren

  • Beloof < HidConnectInfo >

    Chroom 117+

    Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

disconnect()

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

De verbinding met een apparaat verbreken. Het aanroepen van bewerkingen op een apparaat nadat u dit hebt aangeroepen, is veilig maar heeft geen effect.

Parameters

  • verbindingId

    nummer

    De connectionId die wordt geretourneerd door connect .

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Chroom 117+

    Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

getDevices()

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

Inventariseer aangesloten HID-apparaten.

Parameters

Retouren

  • Beloof < HidDeviceInfo []>

    Chroom 117+

    Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

receive()

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

Ontvang het volgende invoerrapport van het apparaat.

Parameters

  • verbindingId

    nummer

    De connectionId die wordt geretourneerd door connect .

  • terugbellen

    functie

    De callback parameter ziet er als volgt uit: 

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

    • rapportId

      nummer

      De rapport-ID of 0 als er geen is.

    • gegevens

      ArrayBuffer

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

receiveFeatureReport()

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

Vraag een functierapport aan vanaf het apparaat.

Parameters

  • verbindingId

    nummer

    De connectionId die wordt geretourneerd door connect .

  • rapportId

    nummer

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

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (data: ArrayBuffer) => void

    • gegevens

      ArrayBuffer

      De rapportgegevens, inclusief een rapport-ID-voorvoegsel als dit door het apparaat wordt verzonden.

Retouren

  • Belofte<ArrayBuffer>

    Chroom 117+

    Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

send()

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

Stuur een uitvoerrapport naar het apparaat.

Opmerking: Neem geen rapport-ID-voorvoegsel op in data . Indien nodig zal dit worden toegevoegd.

Parameters

  • verbindingId

    nummer

    De connectionId die wordt geretourneerd door connect .

  • rapportId

    nummer

    De rapport-ID die moet worden gebruikt, of 0 als er geen is.

  • gegevens

    ArrayBuffer

    De rapportgegevens.

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Chroom 117+

    Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

sendFeatureReport()

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

Stuur een functierapport naar het apparaat.

Opmerking: Neem geen rapport-ID-voorvoegsel op in data . Indien nodig zal dit worden toegevoegd.

Parameters

  • verbindingId

    nummer

    De connectionId die wordt geretourneerd door connect .

  • rapportId

    nummer

    De rapport-ID die moet worden gebruikt, of 0 als er geen is.

  • gegevens

    ArrayBuffer

    De rapportgegevens.

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Chroom 117+

    Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

Evenementen

onDeviceAdded

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

Gebeurtenis gegenereerd wanneer een apparaat aan het systeem wordt toegevoegd. Gebeurtenissen worden alleen uitgezonden naar apps en extensies die toestemming hebben om toegang te krijgen tot het apparaat. 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,
)

Gebeurtenis gegenereerd wanneer een apparaat uit het systeem wordt verwijderd. Zie onDeviceAdded voor welke evenementen worden geleverd.

Parameters

  • terugbellen

    functie

    De callback parameter ziet er als volgt uit: 

    (deviceId: number) => void

    • apparaatID

      nummer