Guide
Comment utiliser Bluetooth Low Energy dans Capacitor
Utilisation de @capgo/capacitor-bluetooth-low-energy
Plugin Capacitor Bluetooth Low Energy pour la communication BLE
Installer
bun add @capgo/capacitor-bluetooth-low-energy
bunx cap sync
bunx cap sync copie le plugin natif code dans vos projets natifs. Exécutez-l’à nouveau après chaque mise à niveau du plugin.
Importer
import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';
API en un coup d'œil
| Méthode | Description |
|---|---|
initialize |
Initialisez le plugin BLE. Cette méthode doit être appelée avant toute autre méthode. |
shimWebBluetooth |
Installez le shim Web Bluetooth Capacitor sur navigator.bluetoothAppelez cette méthode manuellement avant d'utiliser le shim Web Bluetooth API dans une application native Capacitor. |
isAvailable |
Vérifiez si le Bluetooth est disponible sur le dispositif. |
isEnabled |
Vérifiez si le Bluetooth est activé sur le dispositif. |
isLocationEnabled |
Vérifiez si les services de localisation sont activés (seulement sur Android). |
openAppSettings |
Ouvrez la page de paramètres de l'application. |
openBluetoothSettings |
Ouvrez la page de paramètres Bluetooth (seulement sur Android). |
openLocationSettings |
Ouvrez la page de paramètres de localisation (seulement Android). |
checkPermissions |
Vérifiez l'état actuel des autorisations. |
requestPermissions |
Demandez les autorisations Bluetooth. |
startScan |
Démarrer la recherche de périphériques BLE. |
stopScan |
Arrêtez la recherche de périphériques BLE. |
connect |
Connectez-vous à un périphérique BLE. |
disconnect |
Déconnectez-vous d'un périphérique BLE. |
createBond |
Créez un lien avec un périphérique BLE (seulement Android). |
isBonded |
Vérifiez si un appareil est lié (seulement Android). |
discoverServices |
Découvrez les services sur un appareil connecté. |
getServices |
Obtenez les services découverts pour un appareil. |
getConnectedDevices |
Obtenez la liste des appareils connectés. |
readCharacteristic |
Lire une valeur de caractéristique. |
writeCharacteristic |
Écrire une valeur dans une caractéristique. |
startCharacteristicNotifications |
Démarrer les notifications pour une caractéristique. |
stopCharacteristicNotifications |
Arrêter les notifications pour une caractéristique. |
readDescriptor |
Lire une valeur de déscripteur. |
writeDescriptor |
Écrire une valeur dans un déscripteur. |
readRssi |
Lire la force signal de l'appareil connecté. |
requestMtu |
Request MTU size change (Android only). |
requestConnectionPriority |
Demander une priorité de connexion (seulement Android). |
startAdvertising |
Démarrer la publicité en tant que périphérique (serveur BLE). |
stopAdvertising |
Arrêter la publicité. |
addGattService |
Ajouter un service GATT avec des caractéristiques au serveur GATT local. Doit être appelé en mode périphérique avant de démarrer la publicité. |
removeGattService |
Supprimer un service GATT du serveur GATT local. |
setGattCharacteristicValue |
Définir la valeur d'une caractéristique GATT locale. |
notifyGattCharacteristicChanged |
Notifier les centrals connectées que la valeur d'une caractéristique GATT locale a changé. |
startForegroundService |
Démarrer un service de fond pour maintenir les connexions BLE en arrière-plan (seulement sur Android). |
stopForegroundService |
Arrêter le service de fond (seulement sur Android). |
Exemples de code
initialize()
Initialiser le plugin BLE. Doit être appelé avant toute autre méthode.
import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';
await BluetoothLowEnergy.initialize({ mode: 'central' });
shimWebBluetooth()
Installer le shim Web Bluetooth Capacitor sur navigator.bluetooth. Appeler cela manuellement avant d'utiliser le Web Bluetooth API à partir d'une application native Capacitor.
import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';
BluetoothLowEnergy.shimWebBluetooth();
isAvailable()
Vérifier si le Bluetooth est disponible sur le dispositif.
import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';
const { available } = await BluetoothLowEnergy.isAvailable();
isEnabled()
Vérifier si le Bluetooth est activé sur le dispositif.
import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';
const { enabled } = await BluetoothLowEnergy.isEnabled();
isLocationEnabled()
Vérifier si les services de localisation sont activés (seulement sur Android).
import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';
const { enabled } = await BluetoothLowEnergy.isLocationEnabled();
openAppSettings()
Ouvrez la page de paramètres de l'application.
import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';
await BluetoothLowEnergy.openAppSettings();
La table ci-dessus liste les 36 méthodes de base. Les aides aux écouteurs et aux versions, ainsi que le contrat complet de chaque méthode, sont documentés dans le répertoire GitHub.
Écoutez les événements
addListener renvoie un gestionnaire. Appelez handle.remove() lorsque l'écran est démonté, ou BluetoothLowEnergy.removeAllListeners() pour supprimer tous les écouteurs.
Référence complète
Continuez à partir de l'utilisation de @capgo/capacitor-bluetooth-low-energy
If vous utilisez Utilisation de @capgo/capacitor-low-energy-bluetooth pour planifier le travail du plugin natif, connectez-l’avec @capgo/capacitor-low-energy-bluetooth pour les détails d'implémentation dans @capgo/capacitor-low-energy-bluetooth, Prise en main pour les détails d'implémentation dans Prise en main, Répertoire des plugins Capgo pour le flux de travail du produit dans Répertoire des plugins Capgo, Plugins Capacitor par Capgo pour les détails d'implémentation dans Plugins Capacitor par Capgo, et Ajouter ou mettre à jour les plugins pour les détails d'implémentation dans l'ajout ou la mise à jour des plugins.