跳过内容
Capgo - 实时更新 Capacitor 应用程序 Capgo

__CAPGO_KEEP_0__

GitHub

安装

标题为“安装”

您可以使用我们的 AI 助手设置来安装插件。使用以下命令将 Capgo 技能添加到您的 AI 工具中：

终端窗口
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

然后使用以下提示：

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-bluetooth-low-energy` plugin in my project.

如果您prefer Manual Setup，安装插件并运行以下命令并遵循以下平台特定说明：

终端窗口
bun add @capgo/capacitor-bluetooth-low-energy
bunx cap sync

导入

导入
import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';

API概述

API概述

initialize

初始化

初始化BLE插件。 必须在调用任何其他方法之前

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


await BluetoothLowEnergy.initialize({ mode: 'central' });

shimWebBluetooth

__CAPGO_KEEP_0__ Web Bluetooth shim

安装Capacitor Web Bluetooth shim navigator.bluetooth。 在Capacitor原生应用中使用Web Bluetooth API之前手动调用

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


BluetoothLowEnergy.shimWebBluetooth();

isAvailable

Section titled “isAvailable”

设备上是否可用蓝牙

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


const { available } = await BluetoothLowEnergy.isAvailable();

isEnabled

Section titled “isEnabled”

设备蓝牙是否已启用

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


const { enabled } = await BluetoothLowEnergy.isEnabled();

isLocationEnabled

Section titled “isLocationEnabled”

设备是否已启用位置服务（仅Android）

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


const { enabled } = await BluetoothLowEnergy.isLocationEnabled();

openAppSettings

Section titled “openAppSettings”

打开应用设置页面

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


await BluetoothLowEnergy.openAppSettings();

openBluetoothSettings

Section titled “openBluetoothSettings”

仅在 Android 设备上打开蓝牙设置页面。

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


await BluetoothLowEnergy.openBluetoothSettings();

openLocationSettings

Section titled “openLocationSettings”

仅在 Android 设备上打开位置设置页面。

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


await BluetoothLowEnergy.openLocationSettings();

checkPermissions

Section titled “checkPermissions”

检查当前权限状态。

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


const { bluetooth, location } = await BluetoothLowEnergy.checkPermissions();

requestPermissions

Section titled “requestPermissions”

请求蓝牙权限。

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


const { bluetooth, location } = await BluetoothLowEnergy.requestPermissions();

startScan

开始扫描

开始扫描BLE设备。

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


await BluetoothLowEnergy.startScan({
  services: ['180D'], // Heart Rate Service
  timeout: 10000
});

stopScan

停止扫描

停止扫描BLE设备。

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


await BluetoothLowEnergy.stopScan();

connect

连接BLE设备

复制到剪贴板

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


await BluetoothLowEnergy.connect({ deviceId: 'AA:BB:CC:DD:EE:FF' });

disconnect

复制到剪贴板

断开BLE设备

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


await BluetoothLowEnergy.disconnect({ deviceId: 'AA:BB:CC:DD:EE:FF' });

createBond

Section titled “createBond”

仅 Android 设备创建 BLE 设备的配对。

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


await BluetoothLowEnergy.createBond({ deviceId: 'AA:BB:CC:DD:EE:FF' });

isBonded

Section titled “isBonded”

仅 Android 设备检查设备是否配对。

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


const { bonded } = await BluetoothLowEnergy.isBonded({ deviceId: 'AA:BB:CC:DD:EE:FF' });

discoverServices

Section titled “discoverServices”

在已连接设备上发现服务。

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


await BluetoothLowEnergy.discoverServices({ deviceId: 'AA:BB:CC:DD:EE:FF' });

getServices

Section titled “getServices”

获取已发现设备的服务。

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


const { services } = await BluetoothLowEnergy.getServices({ deviceId: 'AA:BB:CC:DD:EE:FF' });

getConnectedDevices

Section titled “getConnectedDevices”

获取已连接设备的列表

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


const { devices } = await BluetoothLowEnergy.getConnectedDevices();

readCharacteristic

Section titled “readCharacteristic”

读取特征值

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


const { value } = await BluetoothLowEnergy.readCharacteristic({
  deviceId: 'AA:BB:CC:DD:EE:FF',
  service: '180D',
  characteristic: '2A37'
});

writeCharacteristic

Section titled “writeCharacteristic”

向特征写入值

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


await BluetoothLowEnergy.writeCharacteristic({
  deviceId: 'AA:BB:CC:DD:EE:FF',
  service: '180D',
  characteristic: '2A39',
  value: [0x01]
});

startCharacteristicNotifications

Section titled “startCharacteristicNotifications”

开始特征通知

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


await BluetoothLowEnergy.startCharacteristicNotifications({
  deviceId: 'AA:BB:CC:DD:EE:FF',
  service: '180D',
  characteristic: '2A37'
});

stopCharacteristicNotifications

《stopCharacteristicNotifications》

停止特征通知

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


await BluetoothLowEnergy.stopCharacteristicNotifications({
  deviceId: 'AA:BB:CC:DD:EE:FF',
  service: '180D',
  characteristic: '2A37'
});

readDescriptor

《readDescriptor》

读取描述符值

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


const { value } = await BluetoothLowEnergy.readDescriptor({
  deviceId: 'AA:BB:CC:DD:EE:FF',
  service: '180D',
  characteristic: '2A37',
  descriptor: '2902'
});

writeDescriptor

《writeDescriptor》

写入描述符值

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


await BluetoothLowEnergy.writeDescriptor({
  deviceId: 'AA:BB:CC:DD:EE:FF',
  service: '180D',
  characteristic: '2A37',
  descriptor: '2902',
  value: [0x01, 0x00]
});

readRssi

《readRssi》

读取连接设备的RSSI（信号强度）

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


const { rssi } = await BluetoothLowEnergy.readRssi({ deviceId: 'AA:BB:CC:DD:EE:FF' });

requestMtu

《requestMtu》

仅 Android 设备请求 MTU 大小更改。

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


const { mtu } = await BluetoothLowEnergy.requestMtu({
  deviceId: 'AA:BB:CC:DD:EE:FF',
  mtu: 512
});

requestConnectionPriority

《requestConnectionPriority》

仅 Android 设备请求连接优先级。

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


await BluetoothLowEnergy.requestConnectionPriority({
  deviceId: 'AA:BB:CC:DD:EE:FF',
  priority: 'high'
});

startAdvertising

《startAdvertising》

以 BLE 服务器模式启动广告。

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


await BluetoothLowEnergy.startAdvertising({
  name: 'MyDevice',
  services: ['180D']
});

stopAdvertising

《stopAdvertising》

停止广告。

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


await BluetoothLowEnergy.stopAdvertising();

startForegroundService

Section titled “startForegroundService”

开启前台服务以在后台维持BLE连接（仅Android）

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


await BluetoothLowEnergy.startForegroundService({
  title: 'BLE Connection',
  body: 'Maintaining connection...'
});

stopForegroundService

Section titled “stopForegroundService”

停止前台服务（仅Android）

import { BluetoothLowEnergy } from '@capgo/capacitor-bluetooth-low-energy';


await BluetoothLowEnergy.stopForegroundService();

Type Reference

Section titled “Type Reference”

InitializeOptions

Section titled “InitializeOptions”

插件初始化选项

export interface InitializeOptions {
  /**
   * The mode to initialize the plugin in.
   * - 'central': Act as a BLE central (client)
   * - 'peripheral': Act as a BLE peripheral (server)
   *
   * @default 'central'
   * @since 1.0.0
   */
  mode?: 'central' | 'peripheral';
}

IsAvailableResult

Section titled “IsAvailableResult”

isAvailable方法的结果。

export interface IsAvailableResult {
  /**
   * Whether Bluetooth is available on the device.
   *
   * @since 1.0.0
   */
  available: boolean;
}

IsEnabledResult

“IsEnabledResult”标题的部分

isEnabled方法的结果。

export interface IsEnabledResult {
  /**
   * Whether Bluetooth is enabled on the device.
   *
   * @since 1.0.0
   */
  enabled: boolean;
}

IsLocationEnabledResult

“IsLocationEnabledResult”标题的部分

isLocationEnabled方法的结果。

export interface IsLocationEnabledResult {
  /**
   * Whether location services are enabled on the device.
   *
   * @since 1.0.0
   */
  enabled: boolean;
}

PermissionStatus

“PermissionStatus”标题的部分

蓝牙和位置的权限状态。

export interface PermissionStatus {
  /**
   * Bluetooth permission status.
   *
   * @since 1.0.0
   */
  bluetooth: PermissionState;


  /**
   * Location permission status (Android only).
   *
   * @since 1.0.0
   */
  location: PermissionState;
}

StartScanOptions

“StartScanOptions”标题的部分

开始扫描的选项。

export interface StartScanOptions {
  /**
   * List of service UUIDs to filter by.
   * Only devices advertising these services will be returned.
   *
   * @since 1.0.0
   */
  services?: string[];


  /**
   * Scan timeout in milliseconds.
   * Set to 0 for no timeout.
   *
   * @default 0
   * @since 1.0.0
   */
  timeout?: number;


  /**
   * Whether to allow duplicate scan results.
   *
   * @default false
   * @since 1.0.0
   */
  allowDuplicates?: boolean;
}

ConnectOptions

连接选项部分

连接设备的选项。

export interface ConnectOptions {
  /**
   * The device ID (MAC address on Android, UUID on iOS).
   *
   * @since 1.0.0
   */
  deviceId: string;


  /**
   * Whether to automatically connect when the device becomes available.
   *
   * @default false
   * @since 1.0.0
   */
  autoConnect?: boolean;
}

DisconnectOptions

断开连接选项部分

断开设备连接的选项。

export interface DisconnectOptions {
  /**
   * The device ID to disconnect from.
   *
   * @since 1.0.0
   */
  deviceId: string;
}

CreateBondOptions

创建绑定选项部分

创建设备绑定的选项。

export interface CreateBondOptions {
  /**
   * The device ID to bond with.
   *
   * @since 1.0.0
   */
  deviceId: string;
}

IsBondedOptions

检查绑定选项部分

Options for checking bond status.

export interface IsBondedOptions {
  /**
   * The device ID to check.
   *
   * @since 1.0.0
   */
  deviceId: string;
}

IsBondedResult

Section titled “IsBondedResult”

Result of the isBonded method.

export interface IsBondedResult {
  /**
   * Whether the device is bonded.
   *
   * @since 1.0.0
   */
  bonded: boolean;
}

DiscoverServicesOptions

Section titled “DiscoverServicesOptions”

Options for discovering services.

export interface DiscoverServicesOptions {
  /**
   * The device ID to discover services on.
   *
   * @since 1.0.0
   */
  deviceId: string;
}

Source Of Truth

Section titled “Source Of Truth”

This page is generated from the plugin’s。重新同步公共__CAPGO_KEEP_0__时，重新运行上游。 src/definitions.ts. Re-run the sync when the public API changes upstream.

继续从 Getting Started

标题：继续从 Getting Started

如果您正在使用 Getting Started 来规划仪表板和 API 操作，连接它与 使用 @capgo/capacitor-低功耗蓝牙 对于在使用 @capgo/capacitor-低功耗蓝牙中的本地能力 API 概述 对于在 API 概述中的实现细节 介绍 对于在介绍中的实现细节 API 密钥 对于在 API Keys 中的实现细节， 设备 对于在设备中的实现细节，