Guide
Comment utiliser le Bluetooth Low Energy dans Capacitor
Utiliser @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 code natif du plugin dans vos projets natifs. Relancez-l’après chaque mise à jour du plugin.
Importer
import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';
Aperçu de API
| Méthode | Description |
|---|---|
initialize |
Initialiser le plugin BLE. À appeler avant toute autre méthode. |
shimWebBluetooth |
Installer le shim Web Bluetooth Capacitor sur navigator.bluetooth. Appelez ceci manuellement avant d'utiliser l’API Web Bluetooth depuis une application native Capacitor. |
isAvailable |
Vérifier si le Bluetooth est disponible sur l'appareil. |
isEnabled |
Vérifier si le Bluetooth est activé sur l'appareil. |
isLocationEnabled |
Vérifier si les services de localisation sont activés (Android uniquement). |
openAppSettings |
Ouvrir la page des paramètres de l'application. |
openBluetoothSettings |
Ouvrir la page des paramètres Bluetooth (Android uniquement). |
openLocationSettings |
Ouvrir la page des paramètres de localisation (Android uniquement). |
checkPermissions |
Vérifier le statut actuel des permissions. |
requestPermissions |
Demander les permissions Bluetooth. |
startScan |
Lancer la recherche d'appareils BLE. |
stopScan |
Arrêter la recherche d'appareils BLE. |
connect |
Se connecter à un appareil BLE. |
disconnect |
Se déconnecter d'un appareil BLE. |
createBond |
Créer un appairage avec un appareil BLE (Android uniquement). |
isBonded |
Vérifier si un appareil est appairé (Android uniquement). |
discoverServices |
Découvrir les services sur un appareil connecté. |
getServices |
Récupérer les services découverts pour un appareil. |
getConnectedDevices |
Récupérer la liste des appareils connectés. |
readCharacteristic |
Lire la valeur d'une caractéristique. |
writeCharacteristic |
Écrire une valeur dans une caractéristique. |
startCharacteristicNotifications |
Activer les notifications pour une caractéristique. |
stopCharacteristicNotifications |
Arrêter les notifications pour une caractéristique. |
readDescriptor |
Lire la valeur d'un descripteur. |
writeDescriptor |
Écrire une valeur dans un descripteur. |
readRssi |
Lire le RSSI (force du signal) d'un appareil connecté. |
requestMtu |
Demander un changement de taille MTU (Android uniquement). |
requestConnectionPriority |
Demander une priorité de connexion (Android uniquement). |
startAdvertising |
Lancer l'advertising en tant que périphérique (serveur BLE). |
stopAdvertising |
Arrêter l'advertising. |
addGattService |
Ajoutez un service GATT avec des caractéristiques au serveur GATT local. Doit être appelé en mode périphérique avant de lancer l'advertising. |
removeGattService |
Supprimez un service GATT du serveur GATT local. |
setGattCharacteristicValue |
Définissez la valeur d'une caractéristique GATT locale. |
notifyGattCharacteristicChanged |
Notifiez les centrales connectées qu'une valeur de caractéristique GATT locale a changé. |
startForegroundService |
Démarrer un service de premier plan pour maintenir les connexions BLE en arrière-plan (Android uniquement). |
stopForegroundService |
Arrêter le service de premier plan (Android uniquement). |
Exemples
initialize()
Initialiser le plugin BLE. À appeler 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. Appelez ceci manuellement avant d'utiliser l’API Web Bluetooth depuis une application native Capacitor.
import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';
BluetoothLowEnergy.shimWebBluetooth();
isAvailable()
Vérifier si le Bluetooth est disponible sur l'appareil.
import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';
const { available } = await BluetoothLowEnergy.isAvailable();
isEnabled()
Vérifier si le Bluetooth est activé sur l'appareil.
import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';
const { enabled } = await BluetoothLowEnergy.isEnabled();
isLocationEnabled()
Vérifier si les services de localisation sont activés (Android uniquement).
import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';
const { enabled } = await BluetoothLowEnergy.isLocationEnabled();
openAppSettings()
Ouvrir la page des paramètres de l'application.
import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';
await BluetoothLowEnergy.openAppSettings();
Le tableau ci-dessus liste les 36 méthodes principales. Les helpers de listener et de version, ainsi que le contrat complet de chaque méthode, sont documentés dans la dépôt GitHub.
Écouter les événements
addListener renvoie un handle. Appelez handle.remove() lors du démontage de l'écran, ou BluetoothLowEnergy.removeAllListeners() pour supprimer tous les listeners.
Référence complète
Continuez à partir de Using @capgo/capacitor-bluetooth-low-energy
Si vous utilisez Utiliser @capgo/capacitor-bluetooth-low-energy pour planifier le travail sur les plugins natifs, connectez-l’à @capgo/capacitor-bluetooth-low-energy pour les détails d'implémentation dans @capgo/capacitor-bluetooth-low-energy, Prise en main pour les détails d'implémentation dans Getting Started Capgo Répertoire des plugins pour le workflow produit dans Capgo Plugin Directory, Plugins Capacitor par Capgo pour les détails d'implémentation dans les plugins Capacitor par Capgo, et Ajouter ou mettre à jour des plugins pour les détails d'implémentation dans Adding or Updating Plugins.