@doubao-apps/create 0.0.25 → 0.0.27

package/dist/template-starter/.ai/reference/open-api/09-/350/256/276/345/244/207-/350/223/235/347/211/231.md

@@ -0,0 +1,961 @@
+# Open API: 设备 / 蓝牙
+
+蓝牙和 BLE 能力；通常先打开适配器，再扫描、连接和读写。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [openBluetoothAdapter](#openbluetoothadapter) | 打开蓝牙适配器。<br><br>蓝牙流程入口。 |
+| [startBluetoothDevicesDiscovery](#startbluetoothdevicesdiscovery) | 开始搜索附近的蓝牙设备。<br><br>通常先调用 openBluetoothAdapter。 |
+| [stopBluetoothDevicesDiscovery](#stopbluetoothdevicesdiscovery) | 停止搜索附近的蓝牙设备。 |
+| [getBluetoothAdapterState](#getbluetoothadapterstate) | 获取蓝牙适配器状态。 |
+| [getBluetoothDevices](#getbluetoothdevices) | 获取当前蓝牙模块发现的设备列表。<br><br>通常先调用 startBluetoothDevicesDiscovery。 |
+| [getConnectedBluetoothDevices](#getconnectedbluetoothdevices) | 获取已连接的蓝牙设备列表。 |
+| [makeBluetoothPair](#makebluetoothpair) | 发起蓝牙配对。 |
+| [isBluetoothDevicePaired](#isbluetoothdevicepaired) | 查询蓝牙设备是否已经配对。 |
+| [closeBluetoothAdapter](#closebluetoothadapter) | 关闭蓝牙适配器。<br><br>会关闭蓝牙模块。 |
+| [createBLEConnection](#createbleconnection) | 创建 BLE 连接。<br><br>需要传入 deviceId。 |
+| [closeBLEConnection](#closebleconnection) | 关闭 BLE 连接。 |
+| [getBLEDeviceServices](#getbledeviceservices) | 获取 BLE 服务列表。<br><br>通常先调用 createBLEConnection。 |
+| [getBLEDeviceCharacteristics](#getbledevicecharacteristics) | 获取 BLE 特征值列表。<br><br>通常先获取 BLE 服务列表。 |
+| [getBLEDeviceRSSI](#getbledevicerssi) | 获取 BLE 设备 RSSI。 |
+| [getBLEMTU](#getblemtu) | 获取 BLE MTU。 |
+| [notifyBLECharacteristicValueChange](#notifyblecharacteristicvaluechange) | 订阅 BLE 特征值变化。<br><br>订阅指定特征值变化。 |
+| [readBLECharacteristicValue](#readblecharacteristicvalue) | 读取 BLE 特征值。<br><br>需要传入 serviceId 和 characteristicId。 |
+| [setBLEMTU](#setblemtu) | 设置 BLE MTU。 |
+| [writeBLECharacteristicValue](#writeblecharacteristicvalue) | 写入 BLE 特征值。<br><br>value 需要是 ArrayBuffer。 |
+
+## API 详情
+
+<a id="openbluetoothadapter"></a>
+### openBluetoothAdapter()
+
+> **openBluetoothAdapter**(`params`?): `Promise`\<`object`\>
+
+打开蓝牙适配器。
+
+#### Parameters
+
+• **params?**: [`OpenBluetoothAdapterParams`](#openbluetoothadapterparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+蓝牙流程入口。
+
+<a id="startbluetoothdevicesdiscovery"></a>
+### startBluetoothDevicesDiscovery()
+
+> **startBluetoothDevicesDiscovery**(`params`?): `Promise`\<`object`\>
+
+开始搜索附近的蓝牙设备。
+
+#### Parameters
+
+• **params?**: [`StartBluetoothDevicesDiscoveryParams`](#startbluetoothdevicesdiscoveryparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+通常先调用 openBluetoothAdapter。
+
+<a id="stopbluetoothdevicesdiscovery"></a>
+### stopBluetoothDevicesDiscovery()
+
+> **stopBluetoothDevicesDiscovery**(`params`?): `Promise`\<`object`\>
+
+停止搜索附近的蓝牙设备。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="getbluetoothadapterstate"></a>
+### getBluetoothAdapterState()
+
+> **getBluetoothAdapterState**(`params`?): `Promise`\<[`GetBluetoothAdapterStateResult`](#getbluetoothadapterstateresult)\>
+
+获取蓝牙适配器状态。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<[`GetBluetoothAdapterStateResult`](#getbluetoothadapterstateresult)\>
+
+<a id="getbluetoothdevices"></a>
+### getBluetoothDevices()
+
+> **getBluetoothDevices**(`params`?): `Promise`\<[`GetBluetoothDevicesResult`](#getbluetoothdevicesresult)\>
+
+获取当前蓝牙模块发现的设备列表。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<[`GetBluetoothDevicesResult`](#getbluetoothdevicesresult)\>
+
+#### Remarks
+
+通常先调用 startBluetoothDevicesDiscovery。
+
+<a id="getconnectedbluetoothdevices"></a>
+### getConnectedBluetoothDevices()
+
+> **getConnectedBluetoothDevices**(`params`): `Promise`\<[`GetConnectedBluetoothDevicesResult`](#getconnectedbluetoothdevicesresult)\>
+
+获取已连接的蓝牙设备列表。
+
+#### Parameters
+
+• **params**: [`GetConnectedBluetoothDevicesParams`](#getconnectedbluetoothdevicesparams)
+
+#### Returns
+
+`Promise`\<[`GetConnectedBluetoothDevicesResult`](#getconnectedbluetoothdevicesresult)\>
+
+<a id="makebluetoothpair"></a>
+### makeBluetoothPair()
+
+> **makeBluetoothPair**(`params`): `Promise`\<`object`\>
+
+发起蓝牙配对。
+
+#### Parameters
+
+• **params**: [`MakeBluetoothPairParams`](#makebluetoothpairparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="isbluetoothdevicepaired"></a>
+### isBluetoothDevicePaired()
+
+> **isBluetoothDevicePaired**(`params`): `Promise`\<`object`\>
+
+查询蓝牙设备是否已经配对。
+
+#### Parameters
+
+• **params**: [`IsBluetoothDevicePairedParams`](#isbluetoothdevicepairedparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="closebluetoothadapter"></a>
+### closeBluetoothAdapter()
+
+> **closeBluetoothAdapter**(`params`?): `Promise`\<`object`\>
+
+关闭蓝牙适配器。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+会关闭蓝牙模块。
+
+<a id="createbleconnection"></a>
+### createBLEConnection()
+
+> **createBLEConnection**(`params`): `Promise`\<`object`\>
+
+创建 BLE 连接。
+
+#### Parameters
+
+• **params**: [`CreateBLEConnectionParams`](#createbleconnectionparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+需要传入 deviceId。
+
+<a id="closebleconnection"></a>
+### closeBLEConnection()
+
+> **closeBLEConnection**(`params`): `Promise`\<`object`\>
+
+关闭 BLE 连接。
+
+#### Parameters
+
+• **params**: [`CloseBLEConnectionParams`](#closebleconnectionparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="getbledeviceservices"></a>
+### getBLEDeviceServices()
+
+> **getBLEDeviceServices**(`params`): `Promise`\<[`GetBLEDeviceServicesResult`](#getbledeviceservicesresult)\>
+
+获取 BLE 服务列表。
+
+#### Parameters
+
+• **params**: [`GetBLEDeviceServicesParams`](#getbledeviceservicesparams)
+
+#### Returns
+
+`Promise`\<[`GetBLEDeviceServicesResult`](#getbledeviceservicesresult)\>
+
+#### Remarks
+
+通常先调用 createBLEConnection。
+
+<a id="getbledevicecharacteristics"></a>
+### getBLEDeviceCharacteristics()
+
+> **getBLEDeviceCharacteristics**(`params`): `Promise`\<[`GetBLEDeviceCharacteristicsResult`](#getbledevicecharacteristicsresult)\>
+
+获取 BLE 特征值列表。
+
+#### Parameters
+
+• **params**: [`GetBLEDeviceCharacteristicsParams`](#getbledevicecharacteristicsparams)
+
+#### Returns
+
+`Promise`\<[`GetBLEDeviceCharacteristicsResult`](#getbledevicecharacteristicsresult)\>
+
+#### Remarks
+
+通常先获取 BLE 服务列表。
+
+<a id="getbledevicerssi"></a>
+### getBLEDeviceRSSI()
+
+> **getBLEDeviceRSSI**(`params`): `Promise`\<[`GetBLEDeviceRSSIResult`](#getbledevicerssiresult)\>
+
+获取 BLE 设备 RSSI。
+
+#### Parameters
+
+• **params**: [`GetBLEDeviceRSSIParams`](#getbledevicerssiparams)
+
+#### Returns
+
+`Promise`\<[`GetBLEDeviceRSSIResult`](#getbledevicerssiresult)\>
+
+<a id="getblemtu"></a>
+### getBLEMTU()
+
+> **getBLEMTU**(`params`): `Promise`\<[`GetBLEMTUResult`](#getblemturesult)\>
+
+获取 BLE MTU。
+
+#### Parameters
+
+• **params**: [`GetBLEMTUParams`](#getblemtuparams)
+
+#### Returns
+
+`Promise`\<[`GetBLEMTUResult`](#getblemturesult)\>
+
+<a id="notifyblecharacteristicvaluechange"></a>
+### notifyBLECharacteristicValueChange()
+
+> **notifyBLECharacteristicValueChange**(`params`): `Promise`\<`object`\>
+
+订阅 BLE 特征值变化。
+
+#### Parameters
+
+• **params**: [`NotifyBLECharacteristicValueChangeParams`](#notifyblecharacteristicvaluechangeparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+订阅指定特征值变化。
+
+<a id="readblecharacteristicvalue"></a>
+### readBLECharacteristicValue()
+
+> **readBLECharacteristicValue**(`params`): `Promise`\<`object`\>
+
+读取 BLE 特征值。
+
+#### Parameters
+
+• **params**: [`ReadBLECharacteristicValueParams`](#readblecharacteristicvalueparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+需要传入 serviceId 和 characteristicId。
+
+<a id="setblemtu"></a>
+### setBLEMTU()
+
+> **setBLEMTU**(`params`): `Promise`\<[`SetBLEMTUResult`](#setblemturesult)\>
+
+设置 BLE MTU。
+
+#### Parameters
+
+• **params**: [`SetBLEMTUParams`](#setblemtuparams)
+
+#### Returns
+
+`Promise`\<[`SetBLEMTUResult`](#setblemturesult)\>
+
+<a id="writeblecharacteristicvalue"></a>
+### writeBLECharacteristicValue()
+
+> **writeBLECharacteristicValue**(`params`): `Promise`\<`object`\>
+
+写入 BLE 特征值。
+
+#### Parameters
+
+• **params**: [`WriteBLECharacteristicValueParams`](#writeblecharacteristicvalueparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+value 需要是 ArrayBuffer。
+
+## 相关类型
+
+<a id="openbluetoothadapterparams"></a>
+### OpenBluetoothAdapterParams
+
+打开蓝牙适配器的请求参数。
+
+#### Properties
+
+##### mode?
+
+> `optional` **mode**: [`BluetoothAdapterMode`](#bluetoothadaptermode)
+
+蓝牙模式。
+
+<a id="bluetoothadaptermode"></a>
+### BluetoothAdapterMode
+
+> **BluetoothAdapterMode**: `"central"` \| `"peripheral"`
+
+蓝牙适配器模式。
+
+<a id="startbluetoothdevicesdiscoveryparams"></a>
+### StartBluetoothDevicesDiscoveryParams
+
+开始搜索蓝牙设备的请求参数。
+
+#### Properties
+
+##### allowDuplicatesKey?
+
+> `optional` **allowDuplicatesKey**: `boolean`
+
+是否允许重复上报同一设备。
+
+##### interval?
+
+> `optional` **interval**: `number`
+
+上报设备的间隔，单位毫秒。
+
+##### powerLevel?
+
+> `optional` **powerLevel**: [`BluetoothPowerLevel`](#bluetoothpowerlevel)
+
+扫描功耗等级。
+
+##### services?
+
+> `optional` **services**: `string`[]
+
+按主服务 UUID 过滤搜索范围。
+
+<a id="bluetoothpowerlevel"></a>
+### BluetoothPowerLevel
+
+> **BluetoothPowerLevel**: `"low"` \| `"medium"` \| `"high"`
+
+蓝牙扫描功耗等级。
+
+<a id="getbluetoothadapterstateresult"></a>
+### GetBluetoothAdapterStateResult
+
+蓝牙适配器状态。
+
+#### Properties
+
+##### available
+
+> **available**: `boolean`
+
+蓝牙适配器是否可用。
+
+##### discovering
+
+> **discovering**: `boolean`
+
+是否正在搜索蓝牙设备。
+
+<a id="getbluetoothdevicesresult"></a>
+### GetBluetoothDevicesResult
+
+获取蓝牙设备列表的返回结果。
+
+#### Properties
+
+##### devices
+
+> **devices**: [`BluetoothDevice`](#bluetoothdevice)[]
+
+当前蓝牙模块已发现的设备列表。
+
+<a id="bluetoothdevice"></a>
+### BluetoothDevice
+
+蓝牙设备信息。
+
+#### Properties
+
+##### advertisingData
+
+> **advertisingData**: `ArrayBuffer`
+
+广播二进制数据。
+
+##### advertisingServiceUuids
+
+> **advertisingServiceUuids**: `string`[]
+
+广播中的服务 UUID 列表。
+
+##### connectable?
+
+> `optional` **connectable**: `boolean`
+
+是否可连接。
+
+##### deviceId
+
+> **deviceId**: `string`
+
+设备 ID。
+
+##### localName
+
+> **localName**: `string`
+
+广播中的本地名称。
+
+##### name
+
+> **name**: `string`
+
+设备名称。
+
+##### rssi
+
+> **rssi**: `number`
+
+RSSI 信号强度，单位 dBm。
+
+##### serviceData
+
+> **serviceData**: `Record`\<`string`, `unknown`\>
+
+广播中的服务数据。
+
+<a id="getconnectedbluetoothdevicesparams"></a>
+### GetConnectedBluetoothDevicesParams
+
+获取已连接蓝牙设备的请求参数。
+
+#### Properties
+
+##### services
+
+> **services**: `string`[]
+
+蓝牙主服务 UUID 列表。
+
+<a id="getconnectedbluetoothdevicesresult"></a>
+### GetConnectedBluetoothDevicesResult
+
+获取已连接蓝牙设备的返回结果。
+
+#### Properties
+
+##### devices
+
+> **devices**: [`ConnectedBluetoothDevice`](#connectedbluetoothdevice)[]
+
+已连接设备列表。
+
+<a id="connectedbluetoothdevice"></a>
+### ConnectedBluetoothDevice
+
+已连接蓝牙设备信息。
+
+#### Properties
+
+##### deviceId
+
+> **deviceId**: `string`
+
+设备 ID。
+
+##### name
+
+> **name**: `string`
+
+设备名称。
+
+<a id="makebluetoothpairparams"></a>
+### MakeBluetoothPairParams
+
+蓝牙配对请求参数。
+
+#### Properties
+
+##### deviceId
+
+> **deviceId**: `string`
+
+蓝牙设备 ID。
+
+##### pin
+
+> **pin**: `string`
+
+配对 PIN 码。
+
+##### timeout?
+
+> `optional` **timeout**: `number`
+
+超时时间，单位毫秒。
+
+<a id="isbluetoothdevicepairedparams"></a>
+### IsBluetoothDevicePairedParams
+
+查询蓝牙设备配对状态的请求参数。
+
+#### Properties
+
+##### deviceId
+
+> **deviceId**: `string`
+
+蓝牙设备 ID。
+
+<a id="createbleconnectionparams"></a>
+### CreateBLEConnectionParams
+
+创建 BLE 连接的请求参数。
+
+#### Properties
+
+##### deviceId
+
+> **deviceId**: `string`
+
+蓝牙设备 ID。
+
+##### timeout?
+
+> `optional` **timeout**: `number`
+
+超时时间，单位毫秒。
+
+<a id="closebleconnectionparams"></a>
+### CloseBLEConnectionParams
+
+关闭 BLE 连接的请求参数。
+
+#### Properties
+
+##### deviceId
+
+> **deviceId**: `string`
+
+蓝牙设备 ID。
+
+<a id="getbledeviceservicesparams"></a>
+### GetBLEDeviceServicesParams
+
+获取 BLE 服务列表的请求参数。
+
+#### Properties
+
+##### deviceId
+
+> **deviceId**: `string`
+
+蓝牙设备 ID。
+
+<a id="getbledeviceservicesresult"></a>
+### GetBLEDeviceServicesResult
+
+获取 BLE 服务列表的返回结果。
+
+#### Properties
+
+##### services
+
+> **services**: [`BluetoothService`](#bluetoothservice)[]
+
+设备服务列表。
+
+<a id="bluetoothservice"></a>
+### BluetoothService
+
+蓝牙服务信息。
+
+#### Properties
+
+##### isPrimary
+
+> **isPrimary**: `boolean`
+
+是否为主服务。
+
+##### uuid
+
+> **uuid**: `string`
+
+服务 UUID。
+
+<a id="getbledevicecharacteristicsparams"></a>
+### GetBLEDeviceCharacteristicsParams
+
+获取 BLE 特征值列表的请求参数。
+
+#### Properties
+
+##### deviceId
+
+> **deviceId**: `string`
+
+蓝牙设备 ID。
+
+##### serviceId
+
+> **serviceId**: `string`
+
+服务 ID。
+
+<a id="getbledevicecharacteristicsresult"></a>
+### GetBLEDeviceCharacteristicsResult
+
+获取 BLE 特征值列表的返回结果。
+
+#### Properties
+
+##### characteristics
+
+> **characteristics**: [`BluetoothCharacteristic`](#bluetoothcharacteristic)[]
+
+特征值列表。
+
+<a id="bluetoothcharacteristicproperties"></a>
+<a id="bluetoothcharacteristic"></a>
+### BluetoothCharacteristic
+
+蓝牙特征值信息。
+
+#### Properties
+
+##### properties
+
+> **properties**: [`BluetoothCharacteristicProperties`](#bluetoothcharacteristicproperties)
+
+特征值能力。
+
+##### uuid
+
+> **uuid**: `string`
+
+特征值 UUID。
+
+<a id="bluetoothcharacteristicproperties"></a>
+### BluetoothCharacteristicProperties
+
+蓝牙特征值支持的能力。
+
+#### Properties
+
+##### indicate
+
+> **indicate**: `boolean`
+
+是否支持 indicate。
+
+##### notify
+
+> **notify**: `boolean`
+
+是否支持 notify。
+
+##### read
+
+> **read**: `boolean`
+
+是否支持 read。
+
+##### write
+
+> **write**: `boolean`
+
+是否支持 write。
+
+##### writeDefault
+
+> **writeDefault**: `boolean`
+
+是否支持带响应写入。
+
+##### writeNoResponse
+
+> **writeNoResponse**: `boolean`
+
+是否支持无响应写入。
+
+<a id="getbledevicerssiparams"></a>
+### GetBLEDeviceRSSIParams
+
+获取 BLE RSSI 的请求参数。
+
+#### Properties
+
+##### deviceId
+
+> **deviceId**: `string`
+
+蓝牙设备 ID。
+
+<a id="getbledevicerssiresult"></a>
+### GetBLEDeviceRSSIResult
+
+获取 BLE RSSI 的返回结果。
+
+#### Properties
+
+##### rssi
+
+> **rssi**: `number`
+
+RSSI 信号强度，单位 dBm。
+
+<a id="getblemtuparams"></a>
+### GetBLEMTUParams
+
+获取 BLE MTU 的请求参数。
+
+#### Properties
+
+##### deviceId
+
+> **deviceId**: `string`
+
+蓝牙设备 ID。
+
+##### writeType?
+
+> `optional` **writeType**: [`BluetoothWriteType`](#bluetoothwritetype)
+
+写入模式。
+
+<a id="getblemturesult"></a>
+### GetBLEMTUResult
+
+获取 BLE MTU 的返回结果。
+
+#### Properties
+
+##### mtu
+
+> **mtu**: `number`
+
+当前 MTU。
+
+<a id="bluetoothwritetype"></a>
+### BluetoothWriteType
+
+> **BluetoothWriteType**: `"write"` \| `"writeNoResponse"`
+
+蓝牙写入模式。
+
+<a id="notifyblecharacteristicvaluechangeparams"></a>
+### NotifyBLECharacteristicValueChangeParams
+
+订阅 BLE 特征值变化的请求参数。
+
+#### Properties
+
+##### characteristicId
+
+> **characteristicId**: `string`
+
+特征值 ID。
+
+##### deviceId
+
+> **deviceId**: `string`
+
+蓝牙设备 ID。
+
+##### serviceId
+
+> **serviceId**: `string`
+
+服务 ID。
+
+##### state
+
+> **state**: `boolean`
+
+是否启用订阅。
+
+##### type?
+
+> `optional` **type**: [`BluetoothNotifyType`](#bluetoothnotifytype)
+
+订阅类型。
+
+<a id="bluetoothnotifytype"></a>
+### BluetoothNotifyType
+
+> **BluetoothNotifyType**: `"notification"` \| `"indication"`
+
+蓝牙特征值订阅类型。
+
+<a id="readblecharacteristicvalueparams"></a>
+### ReadBLECharacteristicValueParams
+
+读取 BLE 特征值的请求参数。
+
+#### Properties
+
+##### characteristicId
+
+> **characteristicId**: `string`
+
+特征值 ID。
+
+##### deviceId
+
+> **deviceId**: `string`
+
+蓝牙设备 ID。
+
+##### serviceId
+
+> **serviceId**: `string`
+
+服务 ID。
+
+<a id="setblemtuparams"></a>
+### SetBLEMTUParams
+
+设置 BLE MTU 的请求参数。
+
+#### Properties
+
+##### deviceId
+
+> **deviceId**: `string`
+
+蓝牙设备 ID。
+
+##### mtu
+
+> **mtu**: `number`
+
+目标 MTU。
+
+<a id="setblemturesult"></a>
+### SetBLEMTUResult
+
+设置 BLE MTU 的返回结果。
+
+#### Properties
+
+##### mtu
+
+> **mtu**: `string` \| `number`
+
+最终协商得到的 MTU。
+
+<a id="writeblecharacteristicvalueparams"></a>
+### WriteBLECharacteristicValueParams
+
+写入 BLE 特征值的请求参数。
+
+#### Properties
+
+##### characteristicId
+
+> **characteristicId**: `string`
+
+特征值 ID。
+
+##### deviceId
+
+> **deviceId**: `string`
+
+蓝牙设备 ID。
+
+##### serviceId
+
+> **serviceId**: `string`
+
+服务 ID。
+
+##### value
+
+> **value**: `ArrayBuffer`
+
+要写入的二进制数据。
+
+##### writeType?
+
+> `optional` **writeType**: [`BluetoothWriteType`](#bluetoothwritetype)
+
+写入模式。