chrome.bluetoothLowEnergy

Description

L'API chrome.bluetoothLowEnergy permet de communiquer avec les appareils Bluetooth Smart (basse consommation) à l'aide du profil d'attribut générique (GATT).

Disponibilité

ChromeOS uniquement

Fichier manifeste

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

"bluetooth"

Types

Advertisement

Chrome 47 ou version ultérieure

Propriétés

  • manufacturerData

    ManufacturerData[] facultatif

    Liste des données spécifiques au fabricant à inclure dans les champs "Données spécifiques au fabricant" des données publicitaires.

  • serviceData

    ServiceData[] facultatif

    Liste des données de service à inclure dans les champs "Données de service" des données publicitaires.

  • serviceUuids

    string[] facultatif

    Liste des UUID à inclure dans le champ "UUID de service" des données publicitaires. Ces UUID peuvent être au format 16 bits, 32 bits ou 128 bits.

  • solicitUuids

    string[] facultatif

    Liste des UUID à inclure dans le champ "Solicit UUIDs" (UUID sollicités) des données publicitaires. Ces UUID peuvent être au format 16 bits, 32 bits ou 128 bits.

  • Type de publicité.

AdvertisementType

Chrome 47 ou version ultérieure

Type de publicité. Si l'option "broadcast" est choisie, le type d'annonce envoyé sera ADV_NONCONN_IND et l'appareil diffusera avec une adresse MAC aléatoire. Si la valeur est définie sur "peripheral", le type d'annonce sera ADV_IND ou ADV_SCAN_IND, et l'appareil diffusera l'annonce avec l'adresse MAC de l'adaptateur Bluetooth réel.

Énumération

"broadcast"

"peripheral"

Characteristic

Propriétés

  • instanceId

    chaîne facultatif

    Renvoie l'identifiant attribué à cette caractéristique. Utilisez l'ID d'instance pour distinguer les caractéristiques d'un périphérique ayant le même UUID et pour effectuer des appels de fonction qui acceptent un identifiant de caractéristique. Présent, si cette instance représente une caractéristique distante.

  • propriétés

    Propriétés de cette caractéristique.

  • service

    Service facultatif

    Service GATT auquel appartient cette caractéristique.

  • uuid

    chaîne

    UUID de la caractéristique, par exemple 00002a37-0000-1000-8000-00805f9b34fb.

  • valeur

    ArrayBuffer facultatif

    Valeur de caractéristique actuellement mise en cache. Cette valeur est mise à jour lorsque la valeur de la caractéristique est lue ou mise à jour via une notification ou une indication.

CharacteristicProperty

Valeurs représentant les propriétés possibles d'une caractéristique. Les autorisations de caractéristique sont déduites de ces propriétés. Veuillez consulter la spécification Bluetooth 4.x pour connaître la signification de chaque propriété.

Énumération

"broadcast"

"read"

"writeWithoutResponse"

"write"

"notify"

"indicate"

"authenticatedSignedWrites"

"extendedProperties"

"reliableWrite"

"writableAuxiliaries"

"encryptRead"

"encryptWrite"

"encryptAuthenticatedRead"

"encryptAuthenticatedWrite"

ConnectProperties

Propriétés

  • persistant

    booléen

    Indicateur précisant si une connexion à l'appareil reste ouverte lorsque la page d'événement de l'application est déchargée (voir Gérer le cycle de vie de l'application). La valeur par défaut est false..

Descriptor

Propriétés

  • caractéristique

    Caractéristique (facultatif)

    Caractéristique GATT à laquelle appartient ce descripteur.

  • instanceId

    chaîne facultatif

    Renvoie l'identifiant attribué à ce descripteur. Utilisez l'ID d'instance pour distinguer les descripteurs d'un périphérique ayant le même UUID et pour effectuer des appels de fonction qui acceptent un identifiant de descripteur. Présent, si cette instance représente une caractéristique distante.

  • autorisations
    Chrome 52 ou version ultérieure

    Autorisations de ce descripteur.

  • uuid

    chaîne

    UUID du descripteur de caractéristique, par exemple 00002902-0000-1000-8000-00805f9b34fb.

  • valeur

    ArrayBuffer facultatif

    Valeur du descripteur actuellement mise en cache. Cette valeur est mise à jour lorsque la valeur du descripteur est lue.

DescriptorPermission

Chrome 52 ou version ultérieure

Valeurs représentant les autorisations possibles pour un descripteur. Veuillez consulter les spécifications Bluetooth 4.x pour connaître la signification de chaque autorisation.

Énumération

"read"

"write"

"encryptedRead"

"encryptedWrite"

"encryptedAuthenticatedRead"

"encryptedAuthenticatedWrite"

Device

Chrome 52 ou version ultérieure

Propriétés

  • adresse

    chaîne

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

  • deviceClass

    number facultatif

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

  • nom

    chaîne facultatif

    Nom de l'appareil lisible par l'humain.

ManufacturerData

Chrome 47 ou version ultérieure

Propriétés

  • données

    number[]

  • id

    nombre

Notification

Chrome 52 ou version ultérieure

Propriétés

  • shouldIndicate

    boolean facultatif

    Option facultative permettant d'envoyer une indication au lieu d'une notification.

  • valeur

    ArrayBuffer

    Nouvelle valeur de la caractéristique.

NotificationProperties

Propriétés

  • persistant

    booléen

    Indicateur précisant si l'application doit recevoir des notifications lorsque la page d'événement de l'application est déchargée (voir Gérer le cycle de vie de l'application). La valeur par défaut est false.

Request

Chrome 52 ou version ultérieure

Propriétés

  • appareil

    Appareil qui a envoyé cette requête.

  • requestId

    nombre

    Identifiant unique de cette requête. Utilisez cet ID lorsque vous répondez à cette demande.

  • valeur

    ArrayBuffer facultatif

    Valeur à écrire (s'il s'agit d'une requête d'écriture).

Response

Chrome 52 ou version ultérieure

Propriétés

  • isError

    booléen

    S'il s'agit d'une réponse d'erreur, la valeur doit être "true".

  • requestId

    nombre

    ID de la requête à laquelle il s'agit d'une réponse.

  • valeur

    ArrayBuffer facultatif

    Valeur de la réponse. Les requêtes d'écriture et les réponses d'erreur ignoreront ce paramètre.

Service

Propriétés

  • deviceAddress

    chaîne facultatif

    Adresse de l'appareil du périphérique distant auquel appartient le service GATT. Présent si cette instance représente un service distant.

  • instanceId

    chaîne facultatif

    Renvoie l'identifiant attribué à ce service. Utilisez l'ID d'instance pour distinguer les services d'un périphérique ayant le même UUID et pour effectuer des appels de fonction qui acceptent un identifiant de service. Présent si cette instance représente un service distant.

  • isPrimary

    booléen

    Indique si le type de ce service est principal ou secondaire.

  • uuid

    chaîne

    UUID du service, par exemple 0000180d-0000-1000-8000-00805f9b34fb.

ServiceData

Chrome 47 ou version ultérieure

Propriétés

  • données

    number[]

  • uuid

    chaîne

Méthodes

connect()

Promise
chrome.bluetoothLowEnergy.connect(
  deviceAddress: string,
  properties?: ConnectProperties,
  callback?: function,
)
: Promise<void>

Établit une connexion entre l'application et l'appareil avec l'adresse indiquée. Un appareil peut déjà être connecté et ses services GATT disponibles sans appeler connect. Toutefois, une application qui souhaite accéder aux services GATT d'un appareil doit appeler cette fonction pour s'assurer que la connexion à l'appareil est maintenue. Si l'appareil n'est pas connecté, tous ses services GATT seront détectés après un appel réussi à connect.

Paramètres

  • deviceAddress

    chaîne

    Adresse Bluetooth de l'appareil distant auquel une connexion GATT doit être ouverte.

  • propriétés

    ConnectProperties facultatif

    Propriétés de connexion (facultatif).

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

createCharacteristic()

Promise Chrome 52 et versions ultérieures
chrome.bluetoothLowEnergy.createCharacteristic(
  characteristic: Characteristic,
  serviceId: string,
  callback?: function,
)
: Promise<string>

Créez une caractéristique GATT hébergée localement. Cette caractéristique doit être hébergée sous un service valide. Si l'ID de service n'est pas valide, lastError sera défini. Cette fonction n'est disponible que si les autorisations bluetooth:low_energy et bluetooth:peripheral sont définies sur "true" dans l'application. Il est possible que l'autorisation d'accès aux périphériques ne soit pas disponible pour toutes les applications.

Paramètres

  • caractéristique

    Caractéristique à créer.

  • ID du service

    chaîne

    ID du service pour lequel créer cette caractéristique.

  • callback

    function facultatif

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

    (characteristicId: string) => void

    • characteristicId

      chaîne

Renvoie

  • Promise<string>

    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.

createDescriptor()

Promise Chrome 52 et versions ultérieures
chrome.bluetoothLowEnergy.createDescriptor(
  descriptor: Descriptor,
  characteristicId: string,
  callback?: function,
)
: Promise<string>

Créez un descripteur GATT hébergé localement. Ce descripteur doit être hébergé sous une caractéristique valide. Si l'ID de caractéristique n'est pas valide, lastError sera défini. Cette fonction n'est disponible que si les autorisations bluetooth:low_energy et bluetooth:peripheral sont définies sur "true" dans l'application. Il est possible que l'autorisation d'accès aux périphériques ne soit pas disponible pour toutes les applications.

Paramètres

  • descripteur

    Descripteur à créer.

  • characteristicId

    chaîne

    ID de la caractéristique pour laquelle créer ce descripteur.

  • callback

    function facultatif

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

    (descriptorId: string) => void

    • descriptorId

      chaîne

Renvoie

  • Promise<string>

    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.

createService()

Promise Chrome 52 et versions ultérieures
chrome.bluetoothLowEnergy.createService(
  service: Service,
  callback?: function,
)
: Promise<string>

Créez un service GATT hébergé localement. Ce service peut être enregistré pour être disponible sur un serveur GATT local. Cette fonction n'est disponible que si les autorisations bluetooth:low_energy et bluetooth:peripheral sont définies sur "true" dans l'application. Il est possible que l'autorisation d'accès aux périphériques ne soit pas disponible pour toutes les applications.

Paramètres

  • service

    Service à créer.

  • callback

    function facultatif

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

    (serviceId: string) => void

    • ID du service

      chaîne

Renvoie

  • Promise<string>

    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.

disconnect()

Promise
chrome.bluetoothLowEnergy.disconnect(
  deviceAddress: string,
  callback?: function,
)
: Promise<void>

Ferme la connexion de l'application à l'appareil avec l'adresse indiquée. Notez que cela ne détruira pas toujours le lien physique lui-même, car d'autres applications peuvent avoir des connexions ouvertes.

Paramètres

  • deviceAddress

    chaîne

    Adresse Bluetooth de l'appareil distant.

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

getCharacteristic()

Promise
chrome.bluetoothLowEnergy.getCharacteristic(
  characteristicId: string,
  callback?: function,
)
: Promise<Characteristic>

Obtenez la caractéristique GATT avec l'ID d'instance donné qui appartient au service GATT donné, si la caractéristique existe.

Paramètres

  • characteristicId

    chaîne

    ID d'instance de la caractéristique GATT demandée.

  • callback

    function facultatif

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

    (result: Characteristic) => void

Renvoie

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

getCharacteristics()

Promise
chrome.bluetoothLowEnergy.getCharacteristics(
  serviceId: string,
  callback?: function,
)
: Promise<Characteristic[]>

Obtenez la liste de toutes les caractéristiques GATT découvertes qui appartiennent au service donné.

Paramètres

  • ID du service

    chaîne

    ID d'instance du service GATT dont les caractéristiques doivent être renvoyées.

  • callback

    function facultatif

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

    (result: Characteristic[]) => void

Renvoie

  • Promise<Characteristic[]>

    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.

getDescriptor()

Promise
chrome.bluetoothLowEnergy.getDescriptor(
  descriptorId: string,
  callback?: function,
)
: Promise<Descriptor>

Récupère le descripteur de caractéristique GATT avec l'ID d'instance donné.

Paramètres

  • descriptorId

    chaîne

    ID d'instance du descripteur de caractéristique GATT demandé.

  • callback

    function facultatif

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

    (result: Descriptor) => void

Renvoie

  • Promise<Descriptor>

    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.

getDescriptors()

Promise
chrome.bluetoothLowEnergy.getDescriptors(
  characteristicId: string,
  callback?: function,
)
: Promise<Descriptor[]>

Obtenez la liste des descripteurs de caractéristiques GATT appartenant à la caractéristique donnée.

Paramètres

  • characteristicId

    chaîne

    ID d'instance de la caractéristique GATT dont les descripteurs doivent être renvoyés.

  • callback

    function facultatif

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

    (result: Descriptor[]) => void

Renvoie

  • Promise<Descriptor[]>

    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.

getIncludedServices()

Promise
chrome.bluetoothLowEnergy.getIncludedServices(
  serviceId: string,
  callback?: function,
)
: Promise<Service[]>

Obtenez la liste des services GATT inclus dans le service donné.

Paramètres

  • ID du service

    chaîne

    ID d'instance du service GATT dont les services inclus doivent être renvoyés.

  • callback

    function facultatif

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

    (result: Service[]) => void

Renvoie

  • Promise<Service[]>

    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.

getService()

Promise
chrome.bluetoothLowEnergy.getService(
  serviceId: string,
  callback?: function,
)
: Promise<Service>

Récupère le service GATT avec l'ID d'instance donné.

Paramètres

  • ID du service

    chaîne

    ID d'instance du service GATT demandé.

  • callback

    function facultatif

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

    (result: Service) => void

Renvoie

  • Promise<Service>

    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.

getServices()

Promise
chrome.bluetoothLowEnergy.getServices(
  deviceAddress: string,
  callback?: function,
)
: Promise<Service[]>

Obtenez tous les services GATT découverts sur l'appareil distant avec l'adresse d'appareil indiquée.

Remarque : Si la découverte des services n'est pas encore terminée sur l'appareil, cette API renvoie un sous-ensemble (éventuellement vide) de services. Pour contourner ce problème, vous pouvez ajouter un délai basé sur le temps et/ou appeler de manière répétée jusqu'à ce que le nombre attendu de services soit renvoyé.

Paramètres

  • deviceAddress

    chaîne

    Adresse Bluetooth de l'appareil distant dont les services GATT doivent être renvoyés.

  • callback

    function facultatif

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

    (result: Service[]) => void

Renvoie

  • Promise<Service[]>

    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.

notifyCharacteristicValueChanged()

Promise Chrome 52 et versions ultérieures
chrome.bluetoothLowEnergy.notifyCharacteristicValueChanged(
  characteristicId: string,
  notification: Notification,
  callback?: function,
)
: Promise<void>

Envoyer une notification à un appareil distant concernant une nouvelle valeur pour une caractéristique. Si l'indicateur "shouldIndicate" de l'objet de notification est défini sur "true", une indication est envoyée au lieu d'une notification. Notez que la caractéristique doit définir correctement la propriété "notify" ou "indicate" lors de la création pour que cet appel aboutisse. Cette fonction n'est disponible que si les autorisations bluetooth:low_energy et bluetooth:peripheral sont définies sur "true" dans l'application. Il est possible que l'autorisation d'accès aux périphériques ne soit pas disponible pour toutes les applications.

Paramètres

  • characteristicId

    chaîne

    Caractéristique pour laquelle envoyer la notification.

  • notification
  • 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.

readCharacteristicValue()

Promise
chrome.bluetoothLowEnergy.readCharacteristicValue(
  characteristicId: string,
  callback?: function,
)
: Promise<Characteristic>

Récupérez la valeur d'une caractéristique spécifiée à partir d'un périphérique distant.

Paramètres

  • characteristicId

    chaîne

    ID d'instance de la caractéristique GATT dont la valeur doit être lue à partir de l'appareil distant.

  • callback

    function facultatif

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

    (result: Characteristic) => void

Renvoie

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

readDescriptorValue()

Promise
chrome.bluetoothLowEnergy.readDescriptorValue(
  descriptorId: string,
  callback?: function,
)
: Promise<Descriptor>

Récupérez la valeur d'un descripteur de caractéristique spécifié à partir d'un périphérique distant.

Paramètres

  • descriptorId

    chaîne

    ID d'instance du descripteur de caractéristique GATT dont la valeur doit être lue à partir de l'appareil distant.

  • callback

    function facultatif

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

    (result: Descriptor) => void

Renvoie

  • Promise<Descriptor>

    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.

registerAdvertisement()

Promise Chrome 47 et versions ultérieures
chrome.bluetoothLowEnergy.registerAdvertisement(
  advertisement: Advertisement,
  callback?: function,
)
: Promise<number>

Créez une annonce et enregistrez-la pour la diffuser. Pour appeler cette fonction, l'application doit disposer des autorisations bluetooth:low_energy et bluetooth:peripheral définies sur "true". De plus, cette API n'est disponible que pour les applications lancées automatiquement en mode Kiosque ou en définissant le commutateur de ligne de commande "--enable-ble-advertising-in-apps". Consultez https://developer.chrome.com/apps/manifest/bluetooth. Remarque : Sur certains matériels, les modes central et périphérique sont compatibles simultanément, mais sur les matériels qui ne sont pas compatibles, cet appel fait passer l'appareil en mode périphérique. Si le matériel n'est pas compatible avec les modes central et périphérique, toute tentative d'utilisation de l'appareil dans les deux modes entraînera un comportement indéfini ou empêchera d'autres applications de rôle central de fonctionner correctement (y compris la détection d'appareils Bluetooth à basse consommation).

Paramètres

  • publicité

    Annonce à diffuser.

  • callback

    function facultatif

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

    (advertisementId: number) => void

    • advertisementId

      nombre

Renvoie

  • Promise<number>

    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.

registerService()

Promise Chrome 52 et versions ultérieures
chrome.bluetoothLowEnergy.registerService(
  serviceId: string,
  callback?: function,
)
: Promise<void>

Enregistrez le service donné auprès du serveur GATT local. Si l'ID de service n'est pas valide, lastError sera défini. Cette fonction n'est disponible que si les autorisations bluetooth:low_energy et bluetooth:peripheral sont définies sur "true" dans l'application. Il est possible que l'autorisation d'accès aux périphériques ne soit pas disponible pour toutes les applications.

Paramètres

  • ID du service

    chaîne

    Identifiant unique d'un service créé.

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

removeService()

Promise Chrome 52 et versions ultérieures
chrome.bluetoothLowEnergy.removeService(
  serviceId: string,
  callback?: function,
)
: Promise<void>

Supprime le service spécifié et annule son enregistrement s'il était enregistré. Si l'ID de service n'est pas valide, lastError sera défini. Cette fonction n'est disponible que si les autorisations bluetooth:low_energy et bluetooth:peripheral sont définies sur "true" dans l'application. Il est possible que l'autorisation d'accès aux périphériques ne soit pas disponible pour toutes les applications.

Paramètres

  • ID du service

    chaîne

    Identifiant unique d'un service enregistré actuel.

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

resetAdvertising()

Promise Chrome 61 et versions ultérieures
chrome.bluetoothLowEnergy.resetAdvertising(
  callback?: function,
)
: Promise<void>

Réinitialise la publicité sur l'appareil actuel. Il annule l'enregistrement et arrête toutes les annonces existantes.

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.

sendRequestResponse()

Chrome 52 ou version ultérieure
chrome.bluetoothLowEnergy.sendRequestResponse(
  response: Response,
)
: void

Envoie une réponse à une requête de lecture/écriture de caractéristique ou de descripteur. Cette fonction n'est disponible que si les autorisations bluetooth:low_energy et bluetooth:peripheral sont définies sur "true" dans l'application. Il est possible que l'autorisation d'accès aux périphériques ne soit pas disponible pour toutes les applications.

Paramètres

  • réponse

    Réponse à la requête.

setAdvertisingInterval()

Promise Chrome 55 et versions ultérieures
chrome.bluetoothLowEnergy.setAdvertisingInterval(
  minInterval: number,
  maxInterval: number,
  callback?: function,
)
: Promise<void>

Définit l'intervalle entre deux annonces consécutives. Remarque : Cette opération est effectuée dans la mesure du possible. L'intervalle réel peut varier de manière non négligeable par rapport aux intervalles demandés. Sur certains matériels, l'intervalle minimal est de 100 ms. Les valeurs minimale et maximale ne peuvent pas dépasser la plage autorisée par la spécification Bluetooth 4.2.

Paramètres

  • minInterval

    nombre

    Intervalle minimal entre les annonces (en millisecondes). Cette valeur ne peut pas être inférieure à 20 ms (conformément aux spécifications).

  • maxInterval

    nombre

    Intervalle maximal entre les annonces (en millisecondes). Cette valeur ne peut pas dépasser 10 240 ms (conformément aux spécifications).

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

startCharacteristicNotifications()

Promise
chrome.bluetoothLowEnergy.startCharacteristicNotifications(
  characteristicId: string,
  properties?: NotificationProperties,
  callback?: function,
)
: Promise<void>

Activez les notifications/indications de valeur de la caractéristique spécifiée. Une fois activée, une application peut écouter les notifications à l'aide de l'événement onCharacteristicValueChanged.

Paramètres

  • characteristicId

    chaîne

    ID d'instance de la caractéristique GATT sur laquelle les notifications doivent être activées.

  • propriétés

    Propriétés de la session de notification (facultatif).

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

stopCharacteristicNotifications()

Promise
chrome.bluetoothLowEnergy.stopCharacteristicNotifications(
  characteristicId: string,
  callback?: function,
)
: Promise<void>

Désactivez les notifications/indications de valeur de la caractéristique spécifiée. Une fois l'appel réussi, l'application cessera de recevoir des notifications/indications de cette caractéristique.

Paramètres

  • characteristicId

    chaîne

    ID d'instance de la caractéristique GATT sur laquelle la session de notification de cette application doit être arrêtée.

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

unregisterAdvertisement()

Promise Chrome 47 et versions ultérieures
chrome.bluetoothLowEnergy.unregisterAdvertisement(
  advertisementId: number,
  callback?: function,
)
: Promise<void>

Annule l'enregistrement d'une annonce et arrête sa diffusion. Si l'annonce ne parvient pas à se désinscrire, la seule façon d'arrêter l'annonce peut être de redémarrer l'appareil.

Paramètres

  • advertisementId

    nombre

    ID de l'annonce à désenregistrer.

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

unregisterService()

Promise Chrome 52 et versions ultérieures
chrome.bluetoothLowEnergy.unregisterService(
  serviceId: string,
  callback?: function,
)
: Promise<void>

Désenregistre le service donné auprès du serveur GATT local. Si l'ID de service n'est pas valide, lastError sera défini. Cette fonction n'est disponible que si les autorisations bluetooth:low_energy et bluetooth:peripheral sont définies sur "true" dans l'application. Il est possible que l'autorisation d'accès aux périphériques ne soit pas disponible pour toutes les applications.

Paramètres

  • ID du service

    chaîne

    Identifiant unique d'un service enregistré actuel.

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

writeCharacteristicValue()

Promise
chrome.bluetoothLowEnergy.writeCharacteristicValue(
  characteristicId: string,
  value: ArrayBuffer,
  callback?: function,
)
: Promise<void>

Écrivez la valeur d'une caractéristique spécifiée à partir d'un périphérique distant.

Paramètres

  • characteristicId

    chaîne

    ID d'instance de la caractéristique GATT dont la valeur doit être écrite.

  • valeur

    ArrayBuffer

    Valeur à envoyer à la caractéristique distante dans le cadre de la requête d'écriture.

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

writeDescriptorValue()

Promise
chrome.bluetoothLowEnergy.writeDescriptorValue(
  descriptorId: string,
  value: ArrayBuffer,
  callback?: function,
)
: Promise<void>

Écrivez la valeur d'un descripteur de caractéristique spécifié à partir d'un périphérique distant.

Paramètres

  • descriptorId

    chaîne

    ID d'instance du descripteur de caractéristique GATT dont la valeur doit être écrite.

  • valeur

    ArrayBuffer

    Valeur à envoyer au descripteur distant dans le cadre de la requête d'écriture.

  • 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

onCharacteristicReadRequest

Chrome 52 ou version ultérieure
chrome.bluetoothLowEnergy.onCharacteristicReadRequest.addListener(
  callback: function,
)

Se déclenche lorsqu'un appareil central connecté demande à lire la valeur d'une caractéristique enregistrée sur le serveur GATT local. Si vous ne répondez pas à cette demande pendant un certain temps, vous risquez d'être déconnecté. Cet événement n'est disponible que si les autorisations bluetooth:low_energy et bluetooth:peripheral sont définies sur "true" dans l'application. Il est possible que l'autorisation d'accès aux périphériques ne soit pas disponible pour toutes les applications.

Paramètres

  • callback

    fonction

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

    (request: Request, characteristicId: string) => void

    • request
    • characteristicId

      chaîne

onCharacteristicValueChanged

chrome.bluetoothLowEnergy.onCharacteristicValueChanged.addListener(
  callback: function,
)

Déclenché lorsque la valeur d'une caractéristique GATT distante change, soit à la suite d'une requête de lecture, soit à la suite d'une notification/indication de changement de valeur. Cet événement n'est envoyé que si l'application a activé les notifications en appelant startCharacteristicNotifications.

Paramètres

onCharacteristicWriteRequest

Chrome 52 ou version ultérieure
chrome.bluetoothLowEnergy.onCharacteristicWriteRequest.addListener(
  callback: function,
)

Se déclenche lorsqu'un appareil central connecté demande à écrire la valeur d'une caractéristique enregistrée sur le serveur GATT local. Si vous ne répondez pas à cette demande pendant un certain temps, vous risquez d'être déconnecté. Cet événement n'est disponible que si les autorisations bluetooth:low_energy et bluetooth:peripheral sont définies sur "true" dans l'application. Il est possible que l'autorisation d'accès aux périphériques ne soit pas disponible pour toutes les applications.

Paramètres

  • callback

    fonction

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

    (request: Request, characteristicId: string) => void

    • request
    • characteristicId

      chaîne

onDescriptorReadRequest

Chrome 52 ou version ultérieure
chrome.bluetoothLowEnergy.onDescriptorReadRequest.addListener(
  callback: function,
)

Déclenché lorsqu'un appareil central connecté demande à lire la valeur d'un descripteur enregistré sur le serveur GATT local. Si vous ne répondez pas à cette demande pendant un certain temps, vous risquez d'être déconnecté. Cet événement n'est disponible que si les autorisations bluetooth:low_energy et bluetooth:peripheral sont définies sur "true" dans l'application. Il est possible que l'autorisation d'accès aux périphériques ne soit pas disponible pour toutes les applications.

Paramètres

  • callback

    fonction

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

    (request: Request, descriptorId: string) => void

    • request
    • descriptorId

      chaîne

onDescriptorValueChanged

chrome.bluetoothLowEnergy.onDescriptorValueChanged.addListener(
  callback: function,
)

Déclenché lorsque la valeur d'un descripteur de caractéristique GATT distant change, généralement à la suite d'une requête de lecture. Cet événement existe principalement pour des raisons de commodité et sera toujours envoyé après un appel réussi à readDescriptorValue.

Paramètres

  • callback

    fonction

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

    (descriptor: Descriptor) => void

onDescriptorWriteRequest

Chrome 52 ou version ultérieure
chrome.bluetoothLowEnergy.onDescriptorWriteRequest.addListener(
  callback: function,
)

Se déclenche lorsqu'un appareil central connecté demande à écrire la valeur d'un descripteur enregistré sur le serveur GATT local. Si vous ne répondez pas à cette demande pendant un certain temps, vous risquez d'être déconnecté. Cet événement n'est disponible que si les autorisations bluetooth:low_energy et bluetooth:peripheral sont définies sur "true" dans l'application. Il est possible que l'autorisation d'accès aux périphériques ne soit pas disponible pour toutes les applications.

Paramètres

  • callback

    fonction

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

    (request: Request, descriptorId: string) => void

    • request
    • descriptorId

      chaîne

onServiceAdded

chrome.bluetoothLowEnergy.onServiceAdded.addListener(
  callback: function,
)

Déclenché lorsqu'un nouveau service GATT a été détecté sur un appareil distant.

Paramètres

  • callback

    fonction

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

    (service: Service) => void

onServiceChanged

chrome.bluetoothLowEnergy.onServiceChanged.addListener(
  callback: function,
)

Déclenché lorsque l'état d'un service GATT distant change. Cela inclut toutes les caractéristiques et/ou descripteurs ajoutés ou supprimés du service, ainsi que les notifications "ServiceChanged" de l'appareil distant.

Paramètres

  • callback

    fonction

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

    (service: Service) => void

onServiceRemoved

chrome.bluetoothLowEnergy.onServiceRemoved.addListener(
  callback: function,
)

Se déclenche lorsqu'un service GATT précédemment découvert sur un appareil distant a été supprimé.

Paramètres

  • callback

    fonction

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

    (service: Service) => void