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

开始使用

安装

标题为“安装”的部分
终端窗口
bun add @capgo/capacitor-bluetooth-low-energy
bunx cap sync

导入

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

API概述

API概述

initialize

__CAPGO_KEEP_0__初始化

初始化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

标题：isAvailable

检查设备上的蓝牙是否可用。

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


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

isEnabled

标题：isEnabled

检查设备上的蓝牙是否已启用。

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


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

isLocationEnabled

标题：isLocationEnabled

检查设备是否启用位置服务（仅限 Android）。

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


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

openAppSettings

标题：openAppSettings

打开应用设置页面。

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


await BluetoothLowEnergy.openAppSettings();

openBluetoothSettings

标题：打开蓝牙设置

仅限 Android，打开蓝牙设置页面。

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


await BluetoothLowEnergy.openBluetoothSettings();

openLocationSettings

标题：打开位置设置

仅限 Android，打开位置设置页面。

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


await BluetoothLowEnergy.openLocationSettings();

checkPermissions

标题：检查权限

检查当前权限状态。

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


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

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

标题：创建配对

仅限 Android，使用 BLE 设备创建一个配对。

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


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

isBonded

标题：检查配对

仅限 Android，检查设备是否已配对。

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


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

discoverServices

标题：发现服务

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

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


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

getServices

标题：获取服务

获取设备已发现的服务。

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


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

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

节标题“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

标题：请求MTU

仅限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

标题：请求连接优先级

仅限Android：请求连接优先级。

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


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

startAdvertising

标题：开始广告

作为BLE服务器开始广告。

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


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

stopAdvertising

标题：停止广告

停止广告。

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


await BluetoothLowEnergy.stopAdvertising();

startForegroundService

标题：“startForegroundService”

在后台（仅限 Android）维持 BLE 连接的前台服务。

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


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

stopForegroundService

标题：“stopForegroundService”

停止前台服务（仅限 Android）。

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


await BluetoothLowEnergy.stopForegroundService();

类型参考

标题：“类型参考”

InitializeOptions

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

“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

开始扫描选项

开始扫描的选项。

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

IsBondedOptions

查看债券状态选项

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

IsBondedResult

IsBondedResult

isBonded方法的结果

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

DiscoverServicesOptions

DiscoverServicesOptions

发现服务选项

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

Source Of Truth

本页面由插件生成

Source Of Truth src/definitions.ts. 当 API 公共资源发生变化时，请重新同步。