@doubao-apps/ai 0.0.35-rc.0 → 0.0.35

package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/14-/350/223/235/347/211/231.md

@@ -43,6 +43,10 @@ import { openBluetoothAdapter } from '@doubao-apps/framework/api';
 await openBluetoothAdapter({ mode: 'central' });
 ```
 
+## 注意事项
+
+蓝牙流程入口。
+
 ## 入参
 
 |参数名|类型|必填|说明|
@@ -71,6 +75,10 @@ await openBluetoothAdapter();
 await startBluetoothDevicesDiscovery({ allowDuplicatesKey: false });
 ```
 
+## 注意事项
+
+通常先调用 openBluetoothAdapter。
+
 ## 入参
 
 |参数名|类型|必填|说明|
@@ -152,6 +160,10 @@ const { devices } = await getBluetoothDevices();
 console.log(devices.map((device) => device.name));
 ```
 
+## 注意事项
+
+通常先调用 startBluetoothDevicesDiscovery。
+
 ## 入参
 
 无入参。
@@ -270,6 +282,10 @@ import { closeBluetoothAdapter } from '@doubao-apps/framework/api';
 await closeBluetoothAdapter();
 ```
 
+## 注意事项
+
+会关闭蓝牙模块。
+
 ## 入参
 
 无入参。
@@ -294,6 +310,10 @@ await createBLEConnection({
 });
 ```
 
+## 注意事项
+
+需要传入 deviceId。
+
 ## 入参
 
 |参数名|类型|必填|说明|
@@ -343,6 +363,10 @@ const { services } = await getBLEDeviceServices({ deviceId: 'device-id' });
 console.log(services);
 ```
 
+## 注意事项
+
+通常先调用 createBLEConnection。
+
 ## 入参
 
 |参数名|类型|必填|说明|
@@ -377,6 +401,10 @@ const { characteristics } = await getBLEDeviceCharacteristics({
 console.log(characteristics);
 ```
 
+## 注意事项
+
+通常先获取 BLE 服务列表。
+
 ## 入参
 
 |参数名|类型|必填|说明|
@@ -481,6 +509,10 @@ await notifyBLECharacteristicValueChange({
 });
 ```
 
+## 注意事项
+
+订阅指定特征值变化。
+
 ## 入参
 
 |参数名|类型|必填|说明|
@@ -516,6 +548,10 @@ await readBLECharacteristicValue({
 });
 ```
 
+## 注意事项
+
+需要传入 serviceId 和 characteristicId。
+
 ## 入参
 
 |参数名|类型|必填|说明|
@@ -559,7 +595,7 @@ console.log(mtu);
 
 |字段名|类型|说明|
 |---|---|---|
-|mtu|`string \| number`|最终协商得到的 MTU。|
+|mtu|`string | number`|最终协商得到的 MTU。|
 
 <a id="writeblecharacteristicvalue"></a>
 ### writeBLECharacteristicValue()
@@ -579,6 +615,10 @@ await writeBLECharacteristicValue({
 });
 ```
 
+## 注意事项
+
+value 需要是 ArrayBuffer。
+
 ## 入参
 
 |参数名|类型|必填|说明|
@@ -596,3 +636,174 @@ await writeBLECharacteristicValue({
 ## 返回值
 
 返回 `Promise<object>`。
+
+## 相关类型
+
+<a id="bluetoothadaptermode"></a>
+### BluetoothAdapterMode
+
+蓝牙适配器模式。
+
+#### Type
+
+`'central' | 'peripheral'`
+
+<a id="bluetoothpowerlevel"></a>
+### BluetoothPowerLevel
+
+蓝牙扫描功耗等级。
+
+#### Type
+
+`'low' | 'medium' | 'high'`
+
+<a id="getbluetoothadapterstateresult"></a>
+### GetBluetoothAdapterStateResult
+
+蓝牙适配器状态。
+
+#### Properties
+
+• **available**: `boolean` - 蓝牙适配器是否可用
+• **discovering**: `boolean` - 是否正在搜索蓝牙设备
+
+<a id="bluetoothdevice"></a>
+### BluetoothDevice
+
+蓝牙设备信息。
+
+#### Properties
+
+• **deviceId**: `string` - 设备 ID
+• **name**: `string` - 设备名称
+• **localName**: `string` - 广播中的本地名称
+• **rssi**: `number` - RSSI 信号强度，单位 dBm
+• **advertisingData**: `ArrayBuffer` - 广播二进制数据
+• **advertisingServiceUuids**: `string[]` - 广播中的服务 UUID 列表
+• **serviceData**: `Record<string, unknown>` - 广播中的服务数据
+• **connectable?**: `boolean` - 是否可连接
+
+<a id="getbluetoothdevicesresult"></a>
+### GetBluetoothDevicesResult
+
+获取蓝牙设备列表的返回结果。
+
+#### Properties
+
+• **devices**: `BluetoothDevice[]` - 当前蓝牙模块已发现的设备列表
+
+<a id="connectedbluetoothdevice"></a>
+### ConnectedBluetoothDevice
+
+已连接蓝牙设备信息。
+
+#### Properties
+
+• **deviceId**: `string` - 设备 ID
+• **name**: `string` - 设备名称
+
+<a id="getconnectedbluetoothdevicesresult"></a>
+### GetConnectedBluetoothDevicesResult
+
+获取已连接蓝牙设备的返回结果。
+
+#### Properties
+
+• **devices**: `ConnectedBluetoothDevice[]` - 已连接设备列表
+
+<a id="bluetoothservice"></a>
+### BluetoothService
+
+蓝牙服务信息。
+
+#### Properties
+
+• **uuid**: `string` - 服务 UUID
+• **isPrimary**: `boolean` - 是否为主服务
+
+<a id="getbledeviceservicesresult"></a>
+### GetBLEDeviceServicesResult
+
+获取 BLE 服务列表的返回结果。
+
+#### Properties
+
+• **services**: `BluetoothService[]` - 设备服务列表
+
+<a id="bluetoothcharacteristicproperties"></a>
+### BluetoothCharacteristicProperties
+
+蓝牙特征值支持的能力。
+
+#### Properties
+
+• **indicate**: `boolean` - 是否支持 indicate
+• **notify**: `boolean` - 是否支持 notify
+• **read**: `boolean` - 是否支持 read
+• **write**: `boolean` - 是否支持 write
+• **writeNoResponse**: `boolean` - 是否支持无响应写入
+• **writeDefault**: `boolean` - 是否支持带响应写入
+
+<a id="bluetoothcharacteristic"></a>
+### BluetoothCharacteristic
+
+蓝牙特征值信息。
+
+#### Properties
+
+• **uuid**: `string` - 特征值 UUID
+• **properties**: `BluetoothCharacteristicProperties` - 特征值能力
+
+<a id="getbledevicecharacteristicsresult"></a>
+### GetBLEDeviceCharacteristicsResult
+
+获取 BLE 特征值列表的返回结果。
+
+#### Properties
+
+• **characteristics**: `BluetoothCharacteristic[]` - 特征值列表
+
+<a id="getbledevicerssiresult"></a>
+### GetBLEDeviceRSSIResult
+
+获取 BLE RSSI 的返回结果。
+
+#### Properties
+
+• **rssi**: `number` - RSSI 信号强度，单位 dBm
+
+<a id="bluetoothwritetype"></a>
+### BluetoothWriteType
+
+蓝牙写入模式。
+
+#### Type
+
+`'write' | 'writeNoResponse'`
+
+<a id="getblemturesult"></a>
+### GetBLEMTUResult
+
+获取 BLE MTU 的返回结果。
+
+#### Properties
+
+• **mtu**: `number` - 当前 MTU
+
+<a id="bluetoothnotifytype"></a>
+### BluetoothNotifyType
+
+蓝牙特征值订阅类型。
+
+#### Type
+
+`'notification' | 'indication'`
+
+<a id="setblemturesult"></a>
+### SetBLEMTUResult
+
+设置 BLE MTU 的返回结果。
+
+#### Properties
+
+• **mtu**: `number | string` - 最终协商得到的 MTU

package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/15-wi-fi.md

@@ -8,42 +8,16 @@ Wi-Fi 模块能力；通常先 startWifi，再获取列表或连接。
 
 | API | 说明 |
 | --- | --- |
-| [WifiConnectedListener](#wificonnectedlistener) | Wi-Fi 连接事件监听函数。<br><br>返回 void，不是 Promise。 |
 | [startWifi](#startwifi) | 初始化 Wi-Fi 模块。 |
 | [stopWifi](#stopwifi) | 关闭 Wi-Fi 模块。 |
 | [setWifiList](#setwifilist) | 设置 Wi-Fi 预设列表（iOS 特有）。 |
 | [connectWifi](#connectwifi) | 连接指定 Wi-Fi。 |
 | [getConnectedWifi](#getconnectedwifi) | 获取当前已连接 Wi-Fi 信息。 |
 | [getWifiList](#getwifilist) | 获取 Wi-Fi 列表。 |
+| [onWifiConnected](#onwificonnected) | 监听连接上 Wi-Fi 的事件。 |
 
 ## API 详情
 
-<a id="wificonnectedlistener"></a>
-### WifiConnectedListener()
-
-Wi-Fi 连接事件监听函数。
-
-## 代码示例
-
-```typescript
-// 暂无代码示例
-```
-
-## 入参
-
-|参数名|类型|必填|说明|
-|---|---|---|---|
-|wifi|`WifiInfo`|是|已连接的 Wi-Fi 信息。|
-|wifi.bssid|`string`|否|Wi-Fi BSSID。|
-|wifi.frequency|`number`|否|频段，单位 MHz。|
-|wifi.secure|`boolean`|否|Wi-Fi 是否安全。|
-|wifi.signalStrength|`number`|否|信号强度。|
-|wifi.ssid|`string`|是|Wi-Fi SSID。|
-
-## 返回值
-
-返回 `void`。
-
 <a id="startwifi"></a>
 ### startWifi()
 
@@ -57,6 +31,10 @@ import { startWifi } from '@doubao-apps/framework/api';
 await startWifi();
 ```
 
+## 注意事项
+
+Wi-Fi 流程入口。
+
 ## 入参
 
 无入参。
@@ -101,6 +79,10 @@ await setWifiList({
 });
 ```
 
+## 注意事项
+
+该接口为 iOS 特有，用于预设 Wi-Fi 列表。
+
 ## 入参
 
 |参数名|类型|必填|说明|
@@ -128,6 +110,10 @@ await startWifi();
 await connectWifi({ ssid: 'Office-WiFi', password: 'password' });
 ```
 
+## 注意事项
+
+通常先调用 startWifi。
+
 ## 入参
 
 |参数名|类型|必填|说明|
@@ -192,6 +178,10 @@ const { wifiList } = await getWifiList();
 console.log(wifiList.map((wifi) => wifi.ssid));
 ```
 
+## 注意事项
+
+通常先调用 startWifi。
+
 ## 入参
 
 无入参。
@@ -208,3 +198,90 @@ console.log(wifiList.map((wifi) => wifi.ssid));
 |wifiList[].secure|`boolean`|Wi-Fi 是否安全。|
 |wifiList[].signalStrength|`number`|信号强度。|
 |wifiList[].ssid|`string`|Wi-Fi SSID。|
+
+<a id="onwificonnected"></a>
+### onWifiConnected()
+
+监听连接上 Wi-Fi 的事件。
+
+## 代码示例
+
+```ts
+import { onWifiConnected } from '@doubao-apps/framework/api';
+
+const off = onWifiConnected(({ wifi }) => {
+  console.log(wifi.ssid);
+});
+
+off();
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|handler|`Function`|是|-|
+|handler.event|`WifiConnectedEvent`|是|-|
+|handler.event.wifi|`WifiInfo`|是|已连接的 Wi-Fi 信息。|
+|handler.event.wifi.bssid|`string`|否|Wi-Fi BSSID。|
+|handler.event.wifi.frequency|`number`|否|频段，单位 MHz。|
+|handler.event.wifi.secure|`boolean`|否|Wi-Fi 是否安全。|
+|handler.event.wifi.signalStrength|`number`|否|信号强度。|
+|handler.event.wifi.ssid|`string`|是|Wi-Fi SSID。|
+
+## 返回值
+
+返回取消当前监听函数的函数。
+
+## 相关类型
+
+<a id="wifilistitem"></a>
+### WifiListItem
+
+预设 Wi-Fi 条目。
+
+#### Properties
+
+• **ssid?**: `string` - Wi-Fi SSID
+• **bssid?**: `string` - Wi-Fi BSSID
+• **password?**: `string` - Wi-Fi 密码
+
+<a id="wifiinfo"></a>
+### WifiInfo
+
+Wi-Fi 信息。
+
+#### Properties
+
+• **ssid**: `string` - Wi-Fi SSID
+• **bssid?**: `string` - Wi-Fi BSSID
+• **secure?**: `boolean` - Wi-Fi 是否安全
+• **signalStrength?**: `number` - 信号强度
+• **frequency?**: `number` - 频段，单位 MHz
+
+<a id="getconnectedwifiresult"></a>
+### GetConnectedWifiResult
+
+获取当前已连接 Wi-Fi 的返回结果。
+
+#### Properties
+
+• **wifi**: `WifiInfo` - 当前连接的 Wi-Fi 信息
+
+<a id="getwifilistresult"></a>
+### GetWifiListResult
+
+获取 Wi-Fi 列表的返回结果。
+
+#### Properties
+
+• **wifiList**: `WifiInfo[]` - 当前获取到的 Wi-Fi 列表
+
+<a id="wificonnectedevent"></a>
+### WifiConnectedEvent
+
+Wi-Fi 连接事件。
+
+#### Properties
+
+• **wifi**: `WifiInfo` - 已连接的 Wi-Fi 信息

package/dist/public/skills/doubao-apps-dev/references/reference/open-api/16-/345/212/240/351/200/237/345/272/246/350/256/241.md

@@ -0,0 +1,122 @@
+# Open API: 加速度计
+
+加速度计监听能力。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [startAccelerometer](#startaccelerometer) | 开始监听加速度。 |
+| [stopAccelerometer](#stopaccelerometer) | 停止监听加速度。 |
+| [onAccelerometerChange](#onaccelerometerchange) | 监听加速度数据变化事件。 |
+
+## API 详情
+
+<a id="startaccelerometer"></a>
+### startAccelerometer()
+
+开始监听加速度。
+
+## 代码示例
+
+```typescript
+import { startAccelerometer } from '@doubao-apps/framework/api';
+
+await startAccelerometer({ interval: 'normal' });
+```
+
+## 注意事项
+
+需配对调用 stopAccelerometer。
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|interval|`SensorInterval`|否|监听频率。|
+
+**类型说明**
+
+- `SensorInterval`: `"game" | "ui" | "normal"`
+
+## 返回值
+
+返回 `Promise<object>`。
+
+<a id="stopaccelerometer"></a>
+### stopAccelerometer()
+
+停止监听加速度。
+
+## 代码示例
+
+```typescript
+import { stopAccelerometer } from '@doubao-apps/framework/api';
+
+await stopAccelerometer();
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回 `Promise<object>`。
+
+<a id="onaccelerometerchange"></a>
+### onAccelerometerChange()
+
+监听加速度数据变化事件。
+
+## 代码示例
+
+```ts
+import { onAccelerometerChange } from '@doubao-apps/framework/api';
+
+const off = onAccelerometerChange(({ x, y, z, timestamp }) => {
+  console.log(x, y, z, timestamp);
+});
+
+off();
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|handler|`Function`|是|-|
+|handler.event|`AccelerometerChangeEvent`|是|-|
+|handler.event.timestamp|`number`|是|数据采集时间戳，单位纳秒。|
+|handler.event.x|`number`|是|X 轴加速度，单位 m/s²。|
+|handler.event.y|`number`|是|Y 轴加速度，单位 m/s²。|
+|handler.event.z|`number`|是|Z 轴加速度，单位 m/s²。|
+
+## 返回值
+
+返回取消当前监听函数的函数。
+
+## 相关类型
+
+<a id="sensorinterval"></a>
+### SensorInterval
+
+传感器监听频率。
+
+#### Type
+
+`'game' | 'ui' | 'normal'`
+
+<a id="accelerometerchangeevent"></a>
+### AccelerometerChangeEvent
+
+加速度数据变化事件。
+
+#### Properties
+
+• **x**: `number` - X 轴加速度，单位 m/s²
+• **y**: `number` - Y 轴加速度，单位 m/s²
+• **z**: `number` - Z 轴加速度，单位 m/s²
+• **timestamp**: `number` - 数据采集时间戳，单位纳秒

package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/17-ibeacon.md

@@ -27,6 +27,10 @@ import { startBeaconDiscovery } from '@doubao-apps/framework/api';
 await startBeaconDiscovery({ uuids: ['FDA50693-A4E2-4FB1-AFCF-C6EB07647825'] });
 ```
 
+## 注意事项
+
+需配对调用 stopBeaconDiscovery。
+
 ## 入参
 
 |参数名|类型|必填|说明|
@@ -95,3 +99,37 @@ console.log(beacons);
 **类型说明**
 
 - `BeaconProximity`: `0 | 1 | 2 | 3`
+
+## 相关类型
+
+<a id="beaconproximity"></a>
+### BeaconProximity
+
+iBeacon 距离等级。
+
+#### Type
+
+`0 | 1 | 2 | 3`
+
+<a id="beaconinfo"></a>
+### BeaconInfo
+
+iBeacon 设备信息。
+
+#### Properties
+
+• **uuid**: `string` - Beacon UUID
+• **major**: `string` - 主 ID
+• **minor**: `string` - 次 ID
+• **proximity**: `BeaconProximity` - 距离等级
+• **accuracy**: `number` - 距离，单位米
+• **rssi**: `number` - RSSI 信号强度，单位 dBm
+
+<a id="getbeaconsresult"></a>
+### GetBeaconsResult
+
+获取 iBeacon 列表的返回结果。
+
+#### Properties
+
+• **beacons**: `BeaconInfo[]` - 当前搜到的 iBeacon 列表

package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/18-/347/275/227/347/233/230.md

@@ -8,33 +8,12 @@
 
 | API | 说明 |
 | --- | --- |
-| [CompassChangeListener](#compasschangelistener) | 罗盘数据变化事件监听函数。<br><br>返回 void，不是 Promise。 |
 | [startCompass](#startcompass) | 开始监听罗盘。 |
 | [stopCompass](#stopcompass) | 停止监听罗盘。 |
+| [onCompassChange](#oncompasschange) | 监听罗盘数据变化事件。 |
 
 ## API 详情
 
-<a id="compasschangelistener"></a>
-### CompassChangeListener()
-
-罗盘数据变化事件监听函数。
-
-## 代码示例
-
-```typescript
-// 暂无代码示例
-```
-
-## 入参
-
-|参数名|类型|必填|说明|
-|---|---|---|---|
-|direction|`number`|是|面对的方向度数，范围 0 到 360。|
-
-## 返回值
-
-返回 `void`。
-
 <a id="startcompass"></a>
 ### startCompass()
 
@@ -48,6 +27,10 @@ import { startCompass } from '@doubao-apps/framework/api';
 await startCompass();
 ```
 
+## 注意事项
+
+需配对调用 stopCompass。
+
 ## 入参
 
 无入参。
@@ -76,3 +59,43 @@ await stopCompass();
 ## 返回值
 
 返回 `Promise<object>`。
+
+<a id="oncompasschange"></a>
+### onCompassChange()
+
+监听罗盘数据变化事件。
+
+## 代码示例
+
+```ts
+import { onCompassChange } from '@doubao-apps/framework/api';
+
+const off = onCompassChange(({ direction }) => {
+  console.log(direction);
+});
+
+off();
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|handler|`Function`|是|-|
+|handler.event|`CompassChangeEvent`|是|-|
+|handler.event.direction|`number`|是|面对的方向度数，范围 0 到 360。|
+
+## 返回值
+
+返回取消当前监听函数的函数。
+
+## 相关类型
+
+<a id="compasschangeevent"></a>
+### CompassChangeEvent
+
+罗盘数据变化事件。
+
+#### Properties
+
+• **direction**: `number` - 面对的方向度数，范围 0 到 360