chrome.bluetooth

Description

Utilisez l'API chrome.bluetooth pour vous connecter à un appareil Bluetooth. Toutes les fonctions signalent les échecs via chrome.runtime.lastError.

Disponibilité

ChromeOS uniquement

Fichier manifeste

Les clés suivantes doivent être déclarées dans le fichier manifeste pour utiliser cette API.

"bluetooth"

Types

AdapterState

Propriétés

  • adresse

    chaîne

    Adresse de l'adaptateur, au format "XX:XX:XX:XX:XX:XX".

  • disponible

    booléen

    Indique si l'adaptateur est disponible (c'est-à-dire activé) ou non.

  • découverte

    booléen

    Indique si l'adaptateur est actuellement en cours de découverte.

  • nom

    chaîne

    Nom de l'adaptateur lisible par l'humain.

  • alimenté

    booléen

    Indique si l'adaptateur est alimenté ou non.

BluetoothFilter

Chrome 67 ou version ultérieure

Propriétés

  • filterType

    FilterType facultatif

    Type de filtre à appliquer à la liste des appareils. La valeur par défaut est "all".

  • limite

    number facultatif

    Nombre maximal d'appareils Bluetooth à renvoyer. La valeur par défaut est 0 (aucune limite) si aucune valeur n'est spécifiée.

Device

Propriétés

  • adresse

    chaîne

    Adresse de l'appareil, au format "XX:XX:XX:XX:XX:XX".

  • batteryPercentage

    number facultatif

    Chrome 77 ou version ultérieure

    La batterie restante de l'appareil.

  • connectable

    boolean facultatif

    Chrome 48 ou version ultérieure

    Indique si l'appareil est connectable.

  • connecté

    boolean facultatif

    Indique si l'appareil est actuellement connecté au système.

  • correspondance

    boolean facultatif

    Chrome 48 ou version ultérieure

    Indique si l'appareil est en cours de connexion au système.

  • deviceClass

    number facultatif

    Classe de l'appareil, un champ de bits défini par http://www.bluetooth.org/en-us/specification/assigned-numbers/baseband.

  • deviceId

    number facultatif

  • inquiryRssi

    number facultatif

    Chrome 44 ou version ultérieure

    Intensité du signal reçu, en dBm. Ce champ n'est disponible et valide que lors de la découverte. En dehors de la découverte, sa valeur n'est pas spécifiée.

  • inquiryTxPower

    number facultatif

    Chrome 44 ou version ultérieure

    Niveau de puissance transmis. Ce champ n'est disponible que pour les appareils LE qui l'incluent dans AD. Il n'est disponible et valide que pendant la découverte.

  • nom

    chaîne facultatif

    Nom de l'appareil lisible par l'humain.

  • associé

    boolean facultatif

    Indique si l'appareil est associé au système ou non.

  • productId

    number facultatif

  • transport

    Transport facultatif

    Chrome 76 ou version ultérieure

    Type de transport de l'appareil Bluetooth.

  • type

    DeviceType facultatif

    Type d'appareil, s'il est reconnu par Chrome. Cette valeur est obtenue à partir du champ deviceClass et ne représente qu'une petite partie des types d'appareils possibles. En cas de doute, vous devez utiliser directement le champ deviceClass.

  • uuids

    string[] facultatif

    UUID des protocoles, profils et services annoncés par l'appareil. Pour les appareils Bluetooth classiques, cette liste est obtenue à partir des données EIR et des tables SDP. Pour les appareils à basse consommation, cette liste est obtenue à partir des services principaux AD et GATT. Pour les appareils bimodes, il peut être obtenu à partir des deux.

  • vendorId

    number facultatif

  • vendorIdSource

    VendorIdSource facultatif

    L'enregistrement de l'ID de l'appareil, le cas échéant.

DeviceType

Types d'appareils courants reconnus par Chrome.

Énumération

"computer"

"phone"

"modem"

"audio"

"carAudio"

"video"

"peripheral"

"joystick"

"gamepad"

"keyboard"

"mouse"

"tablet"

"keyboardMouseCombo"

FilterType

Chrome 67 ou version ultérieure

Types de filtrage des appareils Bluetooth.

Énumération

"all"

"known"

Transport

Chrome 76 ou version ultérieure

Type de transport de l'appareil Bluetooth.

Énumération

"invalid"

"classic"

"le"

"dual"

VendorIdSource

Autorités d'allocation pour les ID de fournisseur.

Énumération

"bluetooth"

"usb"

Méthodes

getAdapterState()

Promise 
chrome.bluetooth.getAdapterState(
  callback?: function,
): Promise<AdapterState>

Obtenez des informations sur l'adaptateur Bluetooth.

Paramètres

  • callback

    function facultatif

    Le paramètre callback se présente comme suit : 

    (adapterInfo: AdapterState) => void

    • adapterInfo

      AdapterState

      Objet contenant les informations sur l'adaptateur.

Renvoie

  • Promise<AdapterState>

    Chrome 91 ou version ultérieure

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

getDevice()

Promise 
chrome.bluetooth.getDevice(
  deviceAddress: string,
  callback?: function,
): Promise<Device>

Obtenez des informations sur un appareil Bluetooth connu du système.

Paramètres

  • deviceAddress

    chaîne

    Adresse de l'appareil à récupérer.

  • callback

    function facultatif

    Le paramètre callback se présente comme suit : 

    (deviceInfo: Device) => void

    • deviceInfo

      Appareil

      Objet contenant les informations sur l'appareil.

Renvoie

  • Promise<Device>

    Chrome 91 ou version ultérieure

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

getDevices()

Promise 
chrome.bluetooth.getDevices(
  filter?: BluetoothFilter,
  callback?: function,
): Promise<Device[]>

Obtenez la liste des appareils Bluetooth connus du système, y compris les appareils associés et récemment détectés.

Paramètres

  • filtre

    BluetoothFilter facultatif

    Chrome 67 ou version ultérieure

    Certains critères permettent de filtrer la liste des appareils Bluetooth renvoyés. Si le filtre n'est pas défini ou s'il est défini sur {}, la liste des appareils renvoyés contiendra tous les appareils Bluetooth. Pour le moment, cette fonctionnalité n'est disponible que sur ChromeOS. Pour les autres plates-formes, une liste complète est renvoyée.

  • callback

    function facultatif

    Le paramètre callback se présente comme suit : 

    (deviceInfos: Device[]) => void

    • deviceInfos

      Device[]

      Tableau d'objets contenant des informations sur l'appareil.

Renvoie

  • Promise<Device[]>

    Chrome 91 ou version ultérieure

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

startDiscovery()

Promise 
chrome.bluetooth.startDiscovery(
  callback?: function,
): Promise<void>

Lancer l'exploration. Les nouveaux appareils détectés seront renvoyés via l'événement onDeviceAdded. Les appareils déjà détectés et connus de l'adaptateur doivent être obtenus à l'aide de getDevices. Ils ne seront mis à jour à l'aide de l'événement onDeviceChanged que si les informations les concernant changent.

La découverte ne démarrera pas si cette application a déjà appelé startDiscovery. La découverte peut être gourmande en ressources : stopDiscovery doit être appelé dès que possible.

Paramètres

  • callback

    function facultatif

    Le paramètre callback se présente comme suit : 

    () => void

Renvoie

  • Promise<void>

    Chrome 91 ou version ultérieure

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

stopDiscovery()

Promise 
chrome.bluetooth.stopDiscovery(
  callback?: function,
): Promise<void>

Arrêter la découverte.

Paramètres

  • callback

    function facultatif

    Le paramètre callback se présente comme suit : 

    () => void

Renvoie

  • Promise<void>

    Chrome 91 ou version ultérieure

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

Événements

onAdapterStateChanged

chrome.bluetooth.onAdapterStateChanged.addListener(
  callback: function,
)

Se déclenche lorsque l'état de l'adaptateur Bluetooth change.

Paramètres

  • callback

    fonction

    Le paramètre callback se présente comme suit : 

    (state: AdapterState) => void

onDeviceAdded

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

Se déclenche lorsque des informations sur un nouvel appareil Bluetooth sont disponibles.

Paramètres

  • callback

    fonction

    Le paramètre callback se présente comme suit : 

    (device: Device) => void

onDeviceChanged

chrome.bluetooth.onDeviceChanged.addListener(
  callback: function,
)

Se déclenche lorsque les informations sur un appareil Bluetooth connu ont changé.

Paramètres

  • callback

    fonction

    Le paramètre callback se présente comme suit : 

    (device: Device) => void

onDeviceRemoved

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

Se déclenche lorsqu'un appareil Bluetooth précédemment détecté est hors de portée depuis suffisamment longtemps pour être considéré comme indisponible, et lorsqu'un appareil associé est supprimé.

Paramètres

  • callback

    fonction

    Le paramètre callback se présente comme suit : 

    (device: Device) => void