@doubao-apps/ai 0.0.33 → 0.0.34

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

@@ -0,0 +1,210 @@
+# Open API: Wi-Fi
+
+Wi-Fi 模块能力；通常先 startWifi，再获取列表或连接。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| 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 列表。 |
+
+## 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()
+
+初始化 Wi-Fi 模块。
+
+## 代码示例
+
+```typescript
+import { startWifi } from '@doubao-apps/framework/api';
+
+await startWifi();
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回 `Promise<object>`。
+
+<a id="stopwifi"></a>
+### stopWifi()
+
+关闭 Wi-Fi 模块。
+
+## 代码示例
+
+```typescript
+import { stopWifi } from '@doubao-apps/framework/api';
+
+await stopWifi();
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回 `Promise<object>`。
+
+<a id="setwifilist"></a>
+### setWifiList()
+
+设置 Wi-Fi 预设列表（iOS 特有）。
+
+## 代码示例
+
+```typescript
+import { setWifiList } from '@doubao-apps/framework/api';
+
+await setWifiList({
+  wifiList: [{ ssid: 'Office-WiFi', password: 'password' }]
+});
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|wifiList|`WifiListItem[]`|是|预设的 Wi-Fi 列表。|
+|wifiList[].bssid|`string`|否|Wi-Fi BSSID。|
+|wifiList[].password|`string`|否|Wi-Fi 密码。|
+|wifiList[].ssid|`string`|否|Wi-Fi SSID。|
+
+## 返回值
+
+返回 `Promise<object>`。
+
+<a id="connectwifi"></a>
+### connectWifi()
+
+连接指定 Wi-Fi。
+
+## 代码示例
+
+```typescript
+import { connectWifi, startWifi } from '@doubao-apps/framework/api';
+
+await startWifi();
+await connectWifi({ ssid: 'Office-WiFi', password: 'password' });
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|bssid|`string`|否|Wi-Fi BSSID。|
+|manual|`boolean`|否|是否跳转到系统设置页连接。|
+|partialInfo|`boolean`|否|是否仅返回部分 Wi-Fi 信息。|
+|password|`string`|是|Wi-Fi 密码。|
+|ssid|`string`|是|Wi-Fi SSID。|
+
+## 返回值
+
+返回 `Promise<object>`。
+
+<a id="getconnectedwifi"></a>
+### getConnectedWifi()
+
+获取当前已连接 Wi-Fi 信息。
+
+## 代码示例
+
+```typescript
+import { getConnectedWifi } from '@doubao-apps/framework/api';
+
+const { wifi } = await getConnectedWifi({ partialInfo: true });
+
+console.log(wifi.ssid);
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|partialInfo|`boolean`|否|是否只返回部分 Wi-Fi 信息。|
+
+## 返回值
+
+返回 `Promise<GetConnectedWifiResult>`。
+
+|字段名|类型|说明|
+|---|---|---|
+|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。|
+
+<a id="getwifilist"></a>
+### getWifiList()
+
+获取 Wi-Fi 列表。
+
+## 代码示例
+
+```typescript
+import { getWifiList, startWifi } from '@doubao-apps/framework/api';
+
+await startWifi();
+const { wifiList } = await getWifiList();
+
+console.log(wifiList.map((wifi) => wifi.ssid));
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回 `Promise<GetWifiListResult>`。
+
+|字段名|类型|说明|
+|---|---|---|
+|wifiList|`WifiInfo[]`|当前获取到的 Wi-Fi 列表。|
+|wifiList[].bssid|`string`|Wi-Fi BSSID。|
+|wifiList[].frequency|`number`|频段，单位 MHz。|
+|wifiList[].secure|`boolean`|Wi-Fi 是否安全。|
+|wifiList[].signalStrength|`number`|信号强度。|
+|wifiList[].ssid|`string`|Wi-Fi SSID。|

package/dist/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,87 @@
+# Open API: 加速度计
+
+加速度计监听能力。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [AccelerometerChangeListener](#accelerometerchangelistener) | 加速度数据变化事件监听函数。<br><br>返回 void，不是 Promise。 |
+| [startAccelerometer](#startaccelerometer) | 开始监听加速度。 |
+| [stopAccelerometer](#stopaccelerometer) | 停止监听加速度。 |
+
+## API 详情
+
+<a id="accelerometerchangelistener"></a>
+### AccelerometerChangeListener()
+
+加速度数据变化事件监听函数。
+
+## 代码示例
+
+```typescript
+// 暂无代码示例
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|timestamp|`number`|是|数据采集时间戳，单位纳秒。|
+|x|`number`|是|X 轴加速度，单位 m/s²。|
+|y|`number`|是|Y 轴加速度，单位 m/s²。|
+|z|`number`|是|Z 轴加速度，单位 m/s²。|
+
+## 返回值
+
+返回 `void`。
+
+<a id="startaccelerometer"></a>
+### startAccelerometer()
+
+开始监听加速度。
+
+## 代码示例
+
+```typescript
+import { startAccelerometer } from '@doubao-apps/framework/api';
+
+await startAccelerometer({ interval: 'normal' });
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|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>`。

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

@@ -0,0 +1,97 @@
+# Open API: iBeacon
+
+iBeacon 搜索和结果读取能力。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [startBeaconDiscovery](#startbeacondiscovery) | 开始搜索附近的 iBeacon。 |
+| [stopBeaconDiscovery](#stopbeacondiscovery) | 停止搜索附近的 iBeacon。 |
+| [getBeacons](#getbeacons) | 获取已搜索到的 iBeacon 列表。 |
+
+## API 详情
+
+<a id="startbeacondiscovery"></a>
+### startBeaconDiscovery()
+
+开始搜索附近的 iBeacon。
+
+## 代码示例
+
+```typescript
+import { startBeaconDiscovery } from '@doubao-apps/framework/api';
+
+await startBeaconDiscovery({ uuids: ['FDA50693-A4E2-4FB1-AFCF-C6EB07647825'] });
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|ignoreBluetoothAvailable|`boolean`|否|iOS 下是否忽略蓝牙可用性校验。|
+|uuids|`string[]`|是|要搜索的 iBeacon UUID 列表。|
+
+## 返回值
+
+返回 `Promise<object>`。
+
+<a id="stopbeacondiscovery"></a>
+### stopBeaconDiscovery()
+
+停止搜索附近的 iBeacon。
+
+## 代码示例
+
+```typescript
+import { stopBeaconDiscovery } from '@doubao-apps/framework/api';
+
+await stopBeaconDiscovery();
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回 `Promise<object>`。
+
+<a id="getbeacons"></a>
+### getBeacons()
+
+获取已搜索到的 iBeacon 列表。
+
+## 代码示例
+
+```typescript
+import { getBeacons } from '@doubao-apps/framework/api';
+
+const { beacons } = await getBeacons();
+
+console.log(beacons);
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回 `Promise<GetBeaconsResult>`。
+
+|字段名|类型|说明|
+|---|---|---|
+|beacons|`BeaconInfo[]`|当前搜到的 iBeacon 列表。|
+|beacons[].accuracy|`number`|距离，单位米。|
+|beacons[].major|`string`|主 ID。|
+|beacons[].minor|`string`|次 ID。|
+|beacons[].proximity|`BeaconProximity`|距离等级。|
+|beacons[].rssi|`number`|RSSI 信号强度，单位 dBm。|
+|beacons[].uuid|`string`|Beacon UUID。|
+
+**类型说明**
+
+- `BeaconProximity`: `0 | 1 | 2 | 3`

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

@@ -0,0 +1,78 @@
+# Open API: 罗盘
+
+罗盘监听能力。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [CompassChangeListener](#compasschangelistener) | 罗盘数据变化事件监听函数。<br><br>返回 void，不是 Promise。 |
+| [startCompass](#startcompass) | 开始监听罗盘。 |
+| [stopCompass](#stopcompass) | 停止监听罗盘。 |
+
+## API 详情
+
+<a id="compasschangelistener"></a>
+### CompassChangeListener()
+
+罗盘数据变化事件监听函数。
+
+## 代码示例
+
+```typescript
+// 暂无代码示例
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|direction|`number`|是|面对的方向度数，范围 0 到 360。|
+
+## 返回值
+
+返回 `void`。
+
+<a id="startcompass"></a>
+### startCompass()
+
+开始监听罗盘。
+
+## 代码示例
+
+```typescript
+import { startCompass } from '@doubao-apps/framework/api';
+
+await startCompass();
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回 `Promise<object>`。
+
+<a id="stopcompass"></a>
+### stopCompass()
+
+停止监听罗盘。
+
+## 代码示例
+
+```typescript
+import { stopCompass } from '@doubao-apps/framework/api';
+
+await stopCompass();
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回 `Promise<object>`。

package/dist/skills/doubao-apps-dev/references/reference/open-api/19-/350/256/276/345/244/207/346/226/271/345/220/221.md

@@ -0,0 +1,86 @@
+# Open API: 设备方向
+
+设备方向监听能力。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [DeviceMotionChangeListener](#devicemotionchangelistener) | 设备方向变化事件监听函数。<br><br>返回 void，不是 Promise。 |
+| [startDeviceMotionListening](#startdevicemotionlistening) | 开始监听设备方向变化。 |
+| [stopDeviceMotionListening](#stopdevicemotionlistening) | 停止监听设备方向变化。 |
+
+## API 详情
+
+<a id="devicemotionchangelistener"></a>
+### DeviceMotionChangeListener()
+
+设备方向变化事件监听函数。
+
+## 代码示例
+
+```typescript
+// 暂无代码示例
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|alpha|`number`|是|当手机坐标 X/Y 和地球坐标 X/Y 重合时，绕 Z 轴转动的夹角。<br>范围为 [0, 2π)，逆时针转动为正。|
+|beta|`number`|是|当手机坐标 Y/Z 和地球坐标 Y/Z 重合时，绕 X 轴转动的夹角。<br>范围为 [-π, π)。|
+|gamma|`number`|是|当手机坐标 X/Z 和地球坐标 X/Z 重合时，绕 Y 轴转动的夹角。<br>范围为 [-π/2, π/2)。|
+
+## 返回值
+
+返回 `void`。
+
+<a id="startdevicemotionlistening"></a>
+### startDeviceMotionListening()
+
+开始监听设备方向变化。
+
+## 代码示例
+
+```typescript
+import { startDeviceMotionListening } from '@doubao-apps/framework/api';
+
+await startDeviceMotionListening({ interval: 'normal' });
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|interval|`SensorInterval`|否|监听频率。|
+
+**类型说明**
+
+- `SensorInterval`: `"game" | "ui" | "normal"`
+
+## 返回值
+
+返回 `Promise<object>`。
+
+<a id="stopdevicemotionlistening"></a>
+### stopDeviceMotionListening()
+
+停止监听设备方向变化。
+
+## 代码示例
+
+```typescript
+import { stopDeviceMotionListening } from '@doubao-apps/framework/api';
+
+await stopDeviceMotionListening();
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回 `Promise<object>`。

package/dist/skills/doubao-apps-dev/references/reference/open-api/20-/351/231/200/350/236/272/344/273/252.md

@@ -0,0 +1,87 @@
+# Open API: 陀螺仪
+
+陀螺仪监听能力。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [GyroscopeChangeListener](#gyroscopechangelistener) | 陀螺仪数据变化事件监听函数。<br><br>返回 void，不是 Promise。 |
+| [startGyroscope](#startgyroscope) | 开始监听陀螺仪。 |
+| [stopGyroscope](#stopgyroscope) | 停止监听陀螺仪。 |
+
+## API 详情
+
+<a id="gyroscopechangelistener"></a>
+### GyroscopeChangeListener()
+
+陀螺仪数据变化事件监听函数。
+
+## 代码示例
+
+```typescript
+// 暂无代码示例
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|timestamp|`number`|是|数据采集时间戳，单位纳秒。|
+|x|`number`|是|绕 X 轴旋转的角速度，单位 rad/s。|
+|y|`number`|是|绕 Y 轴旋转的角速度，单位 rad/s。|
+|z|`number`|是|绕 Z 轴旋转的角速度，单位 rad/s。|
+
+## 返回值
+
+返回 `void`。
+
+<a id="startgyroscope"></a>
+### startGyroscope()
+
+开始监听陀螺仪。
+
+## 代码示例
+
+```typescript
+import { startGyroscope } from '@doubao-apps/framework/api';
+
+await startGyroscope({ interval: 'normal' });
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|interval|`SensorInterval`|否|监听频率。|
+
+**类型说明**
+
+- `SensorInterval`: `"game" | "ui" | "normal"`
+
+## 返回值
+
+返回 `Promise<object>`。
+
+<a id="stopgyroscope"></a>
+### stopGyroscope()
+
+停止监听陀螺仪。
+
+## 代码示例
+
+```typescript
+import { stopGyroscope } from '@doubao-apps/framework/api';
+
+await stopGyroscope();
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回 `Promise<object>`。