@capgo/电容-蓝牙-低能

从 Capacitor app 中与 Bluetooth 低能设备交谈:扫描,连接,读取和写入特性,并订阅iOS,Android和网络上的通知. 在iOS和Android上也可以作为外围广告.

🤖 建筑与AI编码代理? 安装 Capgo 技能 所以克劳德代码,代码,光标,副驾驶,或双子座CLI知道如何安装和使用 @capgo/capacitor-bluetooth-low-energy 在您的电容应用程序中: npx skills add Cap-go/capgo-skills。然后问你的经纪人: 添加@capgo/电容-蓝牙-低能 代理设置指南 • 妇女 主机磁共振

主要特点

• 扫描数字 : startScan() 财务报告和审定财务报表 stopScan() 带有 deviceScanned 活动.
• 连接数字 : connect(), (中文(简体) ), disconnect(), (中文(简体) ), getConnectedDevices() 财务报告和审定财务报表 deviceConnected 或者说 deviceDisconnected 事件.
• 关贸总协定准入数字 : discoverServices(), (中文(简体) ), getServices(), (中文(简体) ), readCharacteristic() 财务报告和审定财务报表 writeCharacteristic()。 。 。 .
• 通知数字 : startCharacteristicNotifications() 与 characteristicChanged 活动.
• 周边模式数字 : startAdvertising() 将设备转换为 BLE 服务器,包含读写请求事件. 在网上不可用.
• 设置助手数字 : isAvailable(), (中文(简体) ), isEnabled(),权限,以及Android连接和设置快捷键.
• 平台:iOS,Android和Web. iOS使用Core Bluetooth,Android使用Bluetooth LE APIs,Web使用浏览器支持它的Web Bluetooth.

为什么是蓝牙公司低能?

综合的, 免费,以及 强力 BLE 插件 :

• 全面支助 - 扫描、连接、阅读、写作和接收通知
• 周边模式 - 作为BLE服务器和广告服务(Android/iOS)
• 服务发现 - 自动发现服务、特征和说明
• 背景支持 - Android的展望服务,iOS的背景模式
• 权限处理 - Android 12+和iOS的内置许可管理
• 现代软件包管理 - 支持Swift软件包管理器(SPM)和CocoaPods
• 跨平台 - 在iOS、Android和Web(Chrome Web Bluetooth API)上工作
• 网络蓝牙 shim - 让浏览器风格的 BLE 代码继续使用 navigator.bluetooth 在本地 Capacitor 应用程序内, 使用一个手动调用

适合IOT应用,可穿戴,健康设备,智能家庭,以及任何BLE连接的外围设备.

文档

这里有最完整的医生: https://capgo.app/docs/plugins/蓝牙-低能/

兼容性

说明: 此插件的主要版本沿用了Capacitor的主要版本. 使用匹配您的 Capacitor 安装的版本( 如 Capacitor 8 的插件 v8) 。 只有最新的主要版本得到积极维护.

安装

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

npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

然后使用下列提示:

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

如果您更喜欢手动设置,请通过运行以下命令来安装插件,并遵循下面的平台特定指令:

npm install @capgo/capacitor-bluetooth-low-energy
npx cap sync

iOS系统

在您的 Info.plist数字 :

<key>NSBluetoothAlwaysUsageDescription</key>
<string>This app uses Bluetooth to communicate with BLE devices.</string>
<key>NSBluetoothPeripheralUsageDescription</key>
<string>This app uses Bluetooth to communicate with BLE devices.</string>

对于背景的 BLE 支持,请在您的 Info.plist数字 :

<key>UIBackgroundModes</key>
<array>
    <string>bluetooth-central</string>
    <string>bluetooth-peripheral</string>
</array>

机器人

工作在盒子内。 插件会自动添加您所需的权限 AndroidManifest.xml。对于Android 12+,您可能需要在使用 BLE 特性之前请求运行时间权限:

await BluetoothLowEnergy.requestPermissions();

网页

使用Web Bluetooth API在Chrome和Chromium的浏览器中工作. 注意Web Bluetooth需要HTTPS和用户交互扫描设备.

网络蓝牙 shim

在Capacitor本地语境中,呼叫 BluetoothLowEnergy.shimWebBluetooth() 在使用前 navigator.bluetooth安装 JS shim , 这样应用程序代码就可以继续使用Web Bluetooth API, 而电话被传送到本地的 BLE 执行中.

BluetoothLowEnergy.shimWebBluetooth();

const device = await navigator.bluetooth.requestDevice({
  acceptAllDevices: true,
});

const server = await device.gatt.connect();
const service = await server.getPrimaryService('180d');

Shim住在插件 JS 捆绑中,自动初始化了中央模式的插件,并将关贸总协定通过Capacitor桥来读取,写出,描述和通知.

当前本地限制 : requestDevice() 解决第一个匹配的扫描设备,而不是打开浏览器选择器 UI。 如果您需要自定义拾取器或外围模式流,请继续使用直接插件 API.

API 密码

• initialize(...)
• shimWebBluetooth()
• isAvailable()
• isEnabled()
• isLocationEnabled()
• openAppSettings()
• openBluetoothSettings()
• openLocationSettings()
• checkPermissions()
• requestPermissions()
• startScan(...)
• stopScan()
• connect(...)
• disconnect(...)
• createBond(...)
• isBonded(...)
• discoverServices(...)
• getServices(...)
• getConnectedDevices()
• readCharacteristic(...)
• writeCharacteristic(...)
• startCharacteristicNotifications(...)
• stopCharacteristicNotifications(...)
• readDescriptor(...)
• writeDescriptor(...)
• readRssi(...)
• requestMtu(...)
• requestConnectionPriority(...)
• startAdvertising(...)
• stopAdvertising()
• addGattService(...)
• removeGattService(...)
• setGattCharacteristicValue(...)
• notifyGattCharacteristicChanged(...)
• startForegroundService(...)
• stopForegroundService()
• getPluginVersion()
• addListener('deviceScanned', ...)
• addListener('deviceConnected', ...)
• addListener('deviceDisconnected', ...)
• addListener('characteristicChanged', ...)
• addListener('centralConnected', ...)
• addListener('centralDisconnected', ...)
• addListener('gattCharacteristicReadRequest', ...)
• addListener('gattCharacteristicWriteRequest', ...)
• removeAllListeners()
• 接口
• 类型异名

蓝牙低能插件用于BLE通信.

初始化(...)

initialize(options?: InitializeOptions | undefined) => Promise<void>

初始化 BLE 插件 . 一定要在任何其他方法之前叫出来.

自: 1.0.0 (单位:千美元)

shimWeb 蓝牙 ()

shimWebBluetooth() => void

安装 Capacitor 网络蓝牙 shim navigator.bluetooth。 。 。 . 在使用来自 Capacitor 本地应用程序的Web Bluetooth API之前,手动调用此功能 .

自: 1.0.0 (单位:千美元)

易读 ()

isAvailable() => Promise<IsAvailableResult>

检查设备是否有蓝牙可用 .

回返情况: Promise<IsAvailableResult>

自: 1.0.0 (单位:千美元)

已启用

isEnabled() => Promise<IsEnabledResult>

检查设备是否启用了蓝牙 .

回返情况: Promise<IsEnabledResult>

自: 1.0.0 (单位:千美元)

isLocation 启用( )

isLocationEnabled() => Promise<IsLocationEnabledResult>

检查位置服务是否启用( 只有Android) .

回返情况: Promise<IsLocationEnabledResult>

自: 1.0.0 (单位:千美元)

打开 AppSettings ()

openAppSettings() => Promise<void>

打开应用程序设置页面 .

自: 1.0.0 (单位:千美元)

打开蓝牙设置( C)

openBluetoothSettings() => Promise<void>

打开蓝牙设置页面(只有Android).

自: 1.0.0 (单位:千美元)

开放位置设置( C)

openLocationSettings() => Promise<void>

打开位置设置页面( 只有Android) .

自: 1.0.0 (单位:千美元)

检查( )

checkPermissions() => Promise<PermissionStatus>

检查当前权限状态 .

回返情况: Promise<PermissionStatus>

自: 1.0.0 (单位:千美元)

请求( )

requestPermissions() => Promise<PermissionStatus>

请求蓝牙权限 .

回返情况: Promise<PermissionStatus>

自: 1.0.0 (单位:千美元)

启动扫描(...)

startScan(options?: StartScanOptions | undefined) => Promise<void>

开始扫描BLE设备 .

自: 1.0.0 (单位:千美元)

停止扫描( C)

stopScan() => Promise<void>

停止扫描 BLE 设备 .

自: 1.0.0 (单位:千美元)

连接(...)

connect(options: ConnectOptions) => Promise<void>

连接到 BLE 设备 .

自: 1.0.0 (单位:千美元)

断开(...)

disconnect(options: DisconnectOptions) => Promise<void>

与 BLE 设备断开连接 .

自: 1.0.0 (单位:千美元)

创建Bond(...)

createBond(options: CreateBondOptions) => Promise<void>

与 BLE 设备创建连接( 只有Android) .

自: 1.0.0 (单位:千美元)

为 Bonded (...)

isBonded(options: IsBondedOptions) => Promise<IsBondedResult>

请检查date=中的日期值 (帮助) Android.

回返情况: Promise<IsBondedResult>

自: 1.0.0 (单位:千美元)

发现服务(...)

discoverServices(options: DiscoverServicesOptions) => Promise<void>

在连接的设备上发现服务 .

自: 1.0.0 (单位:千美元)

获取服务(...)

getServices(options: GetServicesOptions) => Promise<GetServicesResult>

获取设备的发现服务 .

回返情况: Promise<GetServicesResult>

自: 1.0.0 (单位:千美元)

获取连接设备( )

getConnectedDevices() => Promise<GetConnectedDevicesResult>

获取连接设备列表 .

回返情况: Promise<GetConnectedDevicesResult>

自: 1.0.0 (单位:千美元)

读取变异性(...)

readCharacteristic(options: ReadCharacteristicOptions) => Promise<ReadCharacteristicResult>

读取特性值.

回返情况: Promise<ReadCharacteristicResult>

自: 1.0.0 (单位:千美元)

写入特征(...)

writeCharacteristic(options: WriteCharacteristicOptions) => Promise<void>

写一个值到一个特性.

自: 1.0.0 (单位:千美元)

切换性通知(...)

startCharacteristicNotifications(options: StartCharacteristicNotificationsOptions) => Promise<void>

启动特性通知 .

自: 1.0.0 (单位:千美元)

通知(...)

stopCharacteristicNotifications(options: StopCharacteristicNotificationsOptions) => Promise<void>

停止一个特征的通知 .

自: 1.0.0 (单位:千美元)

已读描述器(...)

readDescriptor(options: ReadDescriptorOptions) => Promise<ReadDescriptorResult>

读取描述值 .

回返情况: Promise<ReadDescriptorResult>

自: 1.0.0 (单位:千美元)

写入描述符(...)

writeDescriptor(options: WriteDescriptorOptions) => Promise<void>

写一个值给描述符 .

自: 1.0.0 (单位:千美元)

读取 Rssi (...)

readRssi(options: ReadRssiOptions) => Promise<ReadRssiResult>

读取连接设备的RSSI(信号强度).

回返情况: Promise<ReadRssiResult>

自: 1.0.0 (单位:千美元)

请求Mtu (...)

requestMtu(options: RequestMtuOptions) => Promise<RequestMtuResult>

请求更改 MTU 大小( 只有Android) .

回返情况: Promise<RequestMtuResult>

自: 1.0.0 (单位:千美元)

请求优先级(...)

requestConnectionPriority(options: RequestConnectionPriorityOptions) => Promise<void>

请求连接优先级(只有Android).

自: 1.0.0 (单位:千美元)

开始广告(...)

startAdvertising(options: StartAdvertisingOptions) => Promise<void>

开始广告作为外围(BLE服务器).

自: 1.0.0 (单位:千美元)

停止广告 ()

stopAdvertising() => Promise<void>

停止广告.

自: 1.0.0 (单位:千美元)

添加 Gatt 服务(...)

addGattService(options: AddGattServiceOptions) => Promise<void>

在本地的关贸总协定服务器上添加具有特性的关贸总协定服务. 在开始广告前, 必须在外围模式下呼叫 .

自: 8.2.0 (中文(简体) )

删除 GattService (...)

removeGattService(options: RemoveGattServiceOptions) => Promise<void>

从本地关贸总协定服务器中删除关贸总协定服务.

自: 8.2.0 (中文(简体) )

设置GattCharacteristic Vale (...)

setGattCharacteristicValue(options: SetGattCharacteristicValueOptions) => Promise<void>

设定本地关贸总协定特征的值.

自: 8.2.0 (中文(简体) )

通知 Gatt 变换(...)

notifyGattCharacteristicChanged(options: NotifyGattCharacteristicChangedOptions) => Promise<void>

通知连接的中心,关贸总协定的当地特征价值发生了变化.

自: 8.2.0 (中文(简体) )

启动前景服务(...)

startForegroundService(options: StartForegroundServiceOptions) => Promise<void>

启动一个前景服务,以维护背景中的 BLE 连接(仅Android).

自: 1.0.0 (单位:千美元)

站点前端服务( C)

stopForegroundService() => Promise<void>

停止前景服务(仅限Android).

自: 1.0.0 (单位:千美元)

获取 PluginVersion ()

getPluginVersion() => Promise<GetPluginVersionResult>

获取本地 Capacitor 插件版本 .

回返情况: Promise<GetPluginVersionResult>

自: 1.0.0 (单位:千美元)

添加倾听器( “ 扫描” )..

addListener(eventName: 'deviceScanned', listenerFunc: (event: DeviceScannedEvent) => void) => Promise<PluginListenerHandle>

为设备扫描事件添加一个听众 .

回返情况: Promise<PluginListenerHandle>

自: 1.0.0 (单位:千美元)

添加倾听器( “ 已连接 ” )..

addListener(eventName: 'deviceConnected', listenerFunc: (event: DeviceConnectedEvent) => void) => Promise<PluginListenerHandle>

为设备连接的事件添加一个收听器 .

回返情况: Promise<PluginListenerHandle>

自: 1.0.0 (单位:千美元)

添加倾听器( “ 已断开 ” )..

addListener(eventName: 'deviceDisconnected', listenerFunc: (event: DeviceDisconnectedEvent) => void) => Promise<PluginListenerHandle>

添加设备断开事件的收听器 .

回返情况: Promise<PluginListenerHandle>

自: 1.0.0 (单位:千美元)

添加倾听器( “ 特征变化 ” ,...)

addListener(eventName: 'characteristicChanged', listenerFunc: (event: CharacteristicChangedEvent) => void) => Promise<PluginListenerHandle>

为特性变化的事件添加一个收听器 .

回返情况: Promise<PluginListenerHandle>

自: 1.0.0 (单位:千美元)

添加倾听器( “ 中央连接” ,...)

addListener(eventName: 'centralConnected', listenerFunc: (event: CentralConnectedEvent) => void) => Promise<PluginListenerHandle>

为中央连接的事件(周边模式)添加一个收听器.

回返情况: Promise<PluginListenerHandle>

自: 8.2.0 (中文(简体) )

添加倾听器( “ 中央断开连接 ” ,...)

addListener(eventName: 'centralDisconnected', listenerFunc: (event: CentralDisconnectedEvent) => void) => Promise<PluginListenerHandle>

为中央断开的事件添加一个收听器(周边模式).

回返情况: Promise<PluginListenerHandle>

自: 8.2.0 (中文(简体) )

添加倾听器( “ gartCharacteristic Read request ” ,...)

addListener(eventName: 'gattCharacteristicReadRequest', listenerFunc: (event: GattCharacteristicReadRequestEvent) => void) => Promise<PluginListenerHandle>

增加关贸总协定特征的收听器为请求(周边模式).

回返情况: Promise<PluginListenerHandle>

自: 8.2.0 (中文(简体) )

添加倾听器( “ gattCharacteristic Write request ” ,...)

addListener(eventName: 'gattCharacteristicWriteRequest', listenerFunc: (event: GattCharacteristicWriteRequestEvent) => void) => Promise<PluginListenerHandle>

为 GATT 特性写请求(周边模式)添加一个收听器.

回返情况: Promise<PluginListenerHandle>

自: 8.2.0 (中文(简体) )

删除所有收听器( )

removeAllListeners() => Promise<void>

删除此插件的所有听众 .

自: 1.0.0 (单位:千美元)

接口

初始化选项

插件的初始化选项 .

易伤性结果

由可操作方法产生.

已启用结果

可用方法的结果.

启用结果

异能方法的结果.

权限状态

蓝牙和位置的授权状态 .

开始扫描选项

开始扫描的选项 .

连接选项

连接设备的选项 .

断开选项

从设备中断开的选项 .

创建 Bond 选项

创建债券的选项 .

是Bonded结果

结果是 Bonded 方法.

是Bonded选项

检查债券状态的选项 .

发现服务选项

发现服务的选项.

获取服务

获取服务方法的结果.

服务

一个BLE服务.

分解主义

一个BLE特征.

特征

BLE特性的属性.

描述符

BLE描述器.

获取服务选项

获得服务的选项.

获取连接Devices 结果

获得ConnectedDevices方法的结果.

布莱德维采

一个BLE设备.

读取特征结果

阅读一个特征的结果.

读取特性选项

读取特性的选项 .

写入特性选项

写入特性的选项 .

选择

启动特征通知的备选方案.

选择

停止特征通知的选项.

阅读描述器结果

读出一个描述符的结果.

阅读描述符选项

读取描述符的选项 .

书面描述选项

写入描述符的选项 .

读取Rssi结果

阅读RSSI的结果.

读取 Rssi 选项

阅读 RSSI 的选项 .

请求Mtu结果

请求MTU的结果.

请求Mtu 选项

请求 MTU 的选项 .

请求连接优先选项

请求连接优先级的选项 .

开始广告选项

开始广告的选项.

添加 Gatt 服务选项

增加关贸总协定服务的选择.

定义

当地关贸总协定服务器的关贸总协定特征定义.

Gatt 描述定义

关贸总协定对当地关贸总协定服务器的描述定义.

删除 Gatt 服务选项

取消关贸总协定服务的选择.

SetGatt 特征变量

设定当地关贸总协定特征值的选项.

通知 Gatt 变换式

通知连接中心特性变化的选项.

启动前景服务选项

启动前景服务选项 .

获取 PluginVersion 结果

获取PluginVersion的结果.

插件听筒

设备扫描事件

设备扫描时发射的事件 .

设备连接事件

设备连接时释放的事件 .

设备断开连接事件

设备断开时发生事件 .

特性变化后事件

当特性值变化时会释放出事件 .

中央连接事件

当中央连接到当地关贸总协定服务器时,事件会释放出.

中央断开事件

当中央与本地关贸总协定服务器断开时,事件会释放出.

读取请求

当中心读取关贸总协定的当地特征时,即引起事件.

GattCharcteristic Write 请求事件

中央写给当地关贸总协定特征时引发的事件.

类型异名

权限状态

'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'