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

开始使用

安装

标题为“安装”的部分
终端窗口
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。 在使用 Capacitor Web Bluetooth 时，手动调用此方法。 navigator.bluetooth. Call this manually before using the Web Bluetooth API from a Capacitor native app.

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


BluetoothLowEnergy.shimWebBluetooth();

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

Section titled “startScan”

开始扫描BLE设备。

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


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

stopScan

Section titled “stopScan”

停止BLE设备扫描。

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


await BluetoothLowEnergy.stopScan();

connect

Section titled “connect”

连接BLE设备。

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


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

disconnect

Section titled “disconnect”

断开与BLE设备的连接。

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


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

createBond

Section titled “createBond”

与BLE设备建立配对（仅Android）。

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

读取特性值

读取特性值

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

写入特性值

写入特性值

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

开始特性通知

复制到剪贴板

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


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

stopCharacteristicNotifications

复制到剪贴板

读取特性值

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


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

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

写入描述符值

写入描述符值

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

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

复制到剪贴板

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


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

requestMtu

复制到剪贴板

复制到剪贴板

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


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

requestConnectionPriority

Section titled “requestConnectionPriority”

仅在 Android 上请求连接优先级。

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


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

startAdvertising

Section titled “startAdvertising”

以 BLE 服务器的形式开始广告（仅限 Android）。

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


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

stopAdvertising

Section titled “stopAdvertising”

停止广告。

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


await BluetoothLowEnergy.stopAdvertising();

startForegroundService

Section titled “startForegroundService”

在 Android 上启动前台服务以在后台维持 BLE 连接。

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();

类型参考

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

Section titled “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

标题：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

标题：检查绑定状态选项

检查绑定状态的选项。

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

IsBondedResult

标题：检查绑定状态结果

isBonded方法的结果。

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

DiscoverServicesOptions

发现服务选项

发现服务选项

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

真实数据来源

真实数据来源

该页面是由插件生成的。 src/definitions.ts当公共API在上游发生变化时，请重新运行同步。