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

开始使用

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.

如果您更喜欢手动设置，请按照以下命令安装插件并遵循以下平台特定的说明：

终端窗口
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

标题为“shimWebBluetooth”的部分

安装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

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设备的配对（Android only）。

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


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

isBonded

标题："isBonded"

仅限 Android 设备，检查设备是否已绑定。

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


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

discoverServices

标题："discoverServices"

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

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


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

getServices

标题："getServices"

获取已发现的设备服务。

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


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

getConnectedDevices

标题："getConnectedDevices"

获取已连接的设备列表。

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


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

readCharacteristic

名为“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

名为“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

名为“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

标题：读取描述符

读取描述符值。

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

读取连接设备的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 服务器开始广告 (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

标题：启动前台服务

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

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


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

stopForegroundService

标题：停止前台服务

仅限 Android，停止前台服务。

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


await BluetoothLowEnergy.stopForegroundService();

类型参考

标题：类型参考

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

标题：是否可用结果

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

检查配对状态选项

检查配对状态的选项。

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;
}

真实数据来源

《真实数据来源》

本页面由插件生成， src/definitions.ts当公共API上游更改时，请重新运行同步。

继续从开始

《继续从开始》

如果您正在使用 入门 来规划仪表板和API操作，连接它 使用@capgo/capacitor-低功耗蓝牙 在使用@capgo/capacitor-低功耗蓝牙中 API概述 在API概述中 介绍 在介绍中 API密钥 在API密钥中 设备 __CAPGO_KEEP_0__的实现细节在Devices中.