Skip to content

D
Docs

OpenHarmony / Docs
11 个月 前同步成功

通知 159
Star 292
Fork 28
D
Docs

体验新版 GitCode，发现更多精彩内容 >>

未验证 提交 0de08836 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!1582 update docs 

Merge pull request !1582 from zengyawen/master
上级 b803f6d4 3626d124
隐藏空白更改
内联 并排
Showing with 137 addition and 139 deletion
en/application-dev/Readme-EN.md
浏览文件 @ 0de08836
......@@ -12,7 +12,7 @@
- [Background Task Management ](background-task-management/Readme-EN.md)
- [Media](media/Readme-EN.md)
- [Security](security/Readme-EN.md)
- [IPC & RPC](connectivity/ipc-rpc.md)
- [Connectivity](connectivity/Readme-EN.md)
- [Data Management](database/Readme-EN.md)
- [USB Service](usb/Readme-EN.md)
- [DFX](dfx/Readme-EN.md)
......
en/application-dev/reference/apis/js-apis-bluetooth.md
浏览文件 @ 0de08836
# Bluetooth
> **Note:**
> ![icon-note.gif](public_sys-resources/icon-note.gif) **Note：**
> The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.
>
> The Bluetooth module provides Classic Bluetooth capabilities and Bluetooth Low Energy (BLE) scan and advertising.
The Bluetooth module provides Classic Bluetooth capabilities and Bluetooth Low Energy (BLE) scan and advertising.
## Modules to Import
......@@ -2193,7 +2192,7 @@ Defines the SPP configuration parameters.
| -------- | -------- | -------- | -------- | -------- |
| uuid | string | Yes | Yes | UUID of the SPP. |
| isPrimary | boolean | Yes | Yes | Whether it is a secure channel. |
| type | [ERROR:Invalid link:en-us_topic_0000001193344974.xml#xref2575mcpsimp,link:#SppType](#SppType) | Yes | Yes | Type of the SPP link. |
| type | [SppType](#SppType) | Yes | Yes | Type of the SPP link. |
## SppType
......@@ -2213,8 +2212,8 @@ Defines the GATT service API parameters.
| -------- | -------- | -------- | -------- | -------- |
| serviceUuid | string | Yes | Yes | UUID of the service, for example, **00001888-0000-1000-8000-00805f9b34fb**. |
| isPrimary | boolean | Yes | Yes | Whether the service is a primary service. The value **true** means a primary service. |
| characteristics | Array<[ERROR:Invalid link:en-us_topic_0000001193344974.xml#xref2628mcpsimp,link:#BLECharacteristic](#BLECharacteristic)> | Yes | Yes | List of characteristics of the service. |
| includeServices | Array<[ERROR:Invalid link:en-us_topic_0000001193344974.xml#xref2635mcpsimp,link:#GattService](#GattService)> | Yes | Yes | Services on which the service depends. |
| characteristics | Array<[BLECharacteristic](#BLECharacteristic)> | Yes | Yes | List of characteristics of the service. |
| includeServices | Array<[GattService](#GattService)> | Yes | Yes | Services on which the service depends. |
## BLECharacteristic
......@@ -2226,7 +2225,7 @@ Defines the characteristic API parameters.
| serviceUuid | string | Yes | Yes | UUID of the service, for example, **00001888-0000-1000-8000-00805f9b34fb**. |
| characteristicUuid | string | Yes | Yes | UUID of the characteristic, for example, **00002a11-0000-1000-8000-00805f9b34fb**. |
| characteristicValue | ArrayBuffer | Yes | Yes | Binary value of the characteristic. |
| descriptors | Array<[ERROR:Invalid link:en-us_topic_0000001193344974.xml#xref2677mcpsimp,link:#BLEDescriptor](#BLEDescriptor)> | Yes | Yes | List of descriptors of the characteristic. |
| descriptors | Array<[BLEDescriptor](#BLEDescriptor)> | Yes | Yes | List of descriptors of the characteristic. |
## BLEDescriptor
......@@ -2331,7 +2330,7 @@ Defines the parameters of **BLEConnectChangedState**.
| Name | Type | Readable | Writable | Description |
| -------- | -------- | -------- | -------- | -------- |
| deviceId | string | Yes | No | Address of the peer device, for example, **8F:8F:8E:8E:6D:6D**. |
| state | [ERROR:Invalid link:en-us_topic_0000001193344974.xml#xref3060mcpsimp,link:#ProfileConnectionState](#ProfileConnectionState) | Yes | Yes | BLE connection state. |
| state | [ProfileConnectionState](#ProfileConnectionState) | Yes | Yes | BLE connection state. |
## ProfileConnectionState
......@@ -2364,8 +2363,8 @@ Defines the scan configuration parameters.
| Name | Type | Readable | Writable | Description |
| -------- | -------- | -------- | -------- | -------- |
| interval | number | Yes | Yes | Delay in reporting the scan result. The default value is **0**. |
| dutyMode | [ERROR:Invalid link:en-us_topic_0000001193344974.xml#xref3154mcpsimp,link:#ScanDuty](#ScanDuty) | Yes | Yes | Scan duty. The default value is **SCAN_MODE_LOW_POWER**. |
| matchMode | [ERROR:Invalid link:en-us_topic_0000001193344974.xml#xref3161mcpsimp,link:#MatchMode](#MatchMode) | Yes | Yes | Hardware match mode for BLE scan filters. The default value is **MATCH_MODE_AGGRESSIVE**. |
| dutyMode | [ScanDuty](#ScanDuty) | Yes | Yes | Scan duty. The default value is **SCAN_MODE_LOW_POWER**. |
| matchMode | [MatchMode](#MatchMode) | Yes | Yes | Hardware match mode for BLE scan filters. The default value is **MATCH_MODE_AGGRESSIVE**. |
## ScanDuty
......@@ -2433,8 +2432,8 @@ Defines the content of a BLE advertisement packet.
| Name | Type | Readable | Writable | Description |
| -------- | -------- | -------- | -------- | -------- |
| serviceUuids | Array<string> | Yes | Yes | List of service UUIDs to be broadcasted. |
| manufactureData | Array<[ERROR:Invalid link:en-us_topic_0000001193344974.xml#xref3348mcpsimp,link:#ManufactureData](#ManufactureData)> | Yes | Yes | List of manufacturers to be broadcasted. |
| serviceData | Array<[ERROR:Invalid link:en-us_topic_0000001193344974.xml#xref3355mcpsimp,link:#ServiceData](#ServiceData)> | Yes | Yes | List of service data to be broadcasted. |
| manufactureData | Array<[ManufactureData](#ManufactureData)> | Yes | Yes | List of manufacturers to be broadcasted. |
| serviceData | Array<[ServiceData](#ServiceData)> | Yes | Yes | List of service data to be broadcasted. |
## ManufactureData
......
zh-cn/application-dev/Readme-CN.md
浏览文件 @ 0de08836
......@@ -12,7 +12,7 @@
- [后台任务管理](background-task-management/Readme-CN.md)
- [媒体](media/Readme-CN.md)
- [安全](security/Readme-CN.md)
- [IPC与RPC通信](connectivity/ipc-rpc.md)
- [网络与连接](connectivity/Readme-CN.md)
- [数据管理](database/Readme-CN.md)
- [USB服务](usb/Readme-CN.md)
- [DFX](dfx/Readme-CN.md)
......
zh-cn/application-dev/reference/apis/js-apis-bluetooth.md
浏览文件 @ 0de08836
# Bluetooth
> **说明：**
>
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
> 蓝牙模块提供了基础的传统蓝牙能力以及BLE的扫描、广播等功能。
蓝牙模块提供了基础的传统蓝牙能力以及BLE的扫描、广播等功能。
## 导入模块
......@@ -24,6 +22,8 @@ ohos.permission.DISCOVER_BLUETOOTH
ohos.permission.LOCATION
## bluetooth.enableBluetooth
enableBluetooth(): boolean
......@@ -2200,7 +2200,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
| -------- | -------- | -------- | -------- | -------- |
| uuid | string | 是 | 是 | spp单据的uuid。 |
| isPrimary | boolean | 是 | 是 | 是否是安全通道。 |
| type | [ERROR:Invalid link:zh-cn_topic_0000001193344974.xml#xref2575mcpsimp,link:#SppType](#SppType) | 是 | 是 | Spp链路类型。 |
| type | [SppType](#SppType) | 是 | 是 | Spp链路类型。 |
## SppType
......@@ -2220,8 +2220,8 @@ let rssi = gattClient.getRssiValue().then((data) => {
| -------- | -------- | -------- | -------- | -------- |
| serviceUuid | string | 是 | 是 | 特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。 |
| isPrimary | boolean | 是 | 是 | 如果是主服务设置为true，否则设置为false。 |
| characteristics | Array<[ERROR:Invalid link:zh-cn_topic_0000001193344974.xml#xref2628mcpsimp,link:#BLECharacteristic](#BLECharacteristic)> | 是 | 是 | 当前服务包含的特征列表。 |
| includeServices | Array<[ERROR:Invalid link:zh-cn_topic_0000001193344974.xml#xref2635mcpsimp,link:#GattService](#GattService)> | 是 | 是 | 当前服务依赖的其它服务。 |
| characteristics | Array<[BLECharacteristic](#BLECharacteristic)> | 是 | 是 | 当前服务包含的特征列表。 |
| includeServices | Array<[GattService](#GattService)> | 是 | 是 | 当前服务依赖的其它服务。 |
## BLECharacteristic
......@@ -2233,7 +2233,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
| serviceUuid | string | 是 | 是 | 特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。 |
| characteristicUuid | string | 是 | 是 | 特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。 |
| characteristicValue | ArrayBuffer | 是 | 是 | 特征对应的二进制值。 |
| descriptors | Array<[ERROR:Invalid link:zh-cn_topic_0000001193344974.xml#xref2677mcpsimp,link:#BLEDescriptor](#BLEDescriptor)> | 是 | 是 | 特定特征的描述符列表。 |
| descriptors | Array<[BLEDescriptor](#BLEDescriptor)> | 是 | 是 | 特定特征的描述符列表。 |
## BLEDescriptor
......@@ -2338,7 +2338,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| deviceId | string | 是 | 否 | 表示远端设备地址，例如："8F:8F:8E:8E:6D:6D"。 |
| state | [ERROR:Invalid link:zh-cn_topic_0000001193344974.xml#xref3060mcpsimp,link:#ProfileConnectionState](#ProfileConnectionState) | 是 | 是 | 表示BLE连接状态的枚举。 |
| state | [ProfileConnectionState](#ProfileConnectionState) | 是 | 是 | 表示BLE连接状态的枚举。 |
## ProfileConnectionState
......@@ -2371,8 +2371,8 @@ let rssi = gattClient.getRssiValue().then((data) => {
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| interval | number | 是 | 是 | 表示扫描结果上报延迟时间，默认值为0。 |
| dutyMode | [ERROR:Invalid link:zh-cn_topic_0000001193344974.xml#xref3154mcpsimp,link:#ScanDuty](#ScanDuty) | 是 | 是 | 表示扫描模式，默认值为SCAN_MODE_LOW_POWER。 |
| matchMode | [ERROR:Invalid link:zh-cn_topic_0000001193344974.xml#xref3161mcpsimp,link:#MatchMode](#MatchMode) | 是 | 是 | 表示硬件的过滤匹配模式，默认值为MATCH_MODE_AGGRESSIVE。 |
| dutyMode | [ScanDuty](#ScanDuty) | 是 | 是 | 表示扫描模式，默认值为SCAN_MODE_LOW_POWER。 |
| matchMode | [MatchMode](#MatchMode) | 是 | 是 | 表示硬件的过滤匹配模式，默认值为MATCH_MODE_AGGRESSIVE。 |
## ScanDuty
......@@ -2440,8 +2440,8 @@ let rssi = gattClient.getRssiValue().then((data) => {
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| serviceUuids | Array<string> | 是 | 是 | 表示要广播的服务 UUID 列表。 |
| manufactureData | Array<[ERROR:Invalid link:zh-cn_topic_0000001193344974.xml#xref3348mcpsimp,link:#ManufactureData](#ManufactureData)> | 是 | 是 | 表示要广播的广播的制造商信息列表。 |
| serviceData | Array<[ERROR:Invalid link:zh-cn_topic_0000001193344974.xml#xref3355mcpsimp,link:#ServiceData](#ServiceData)> | 是 | 是 | 表示要广播的服务数据列表。 |
| manufactureData | Array<[ManufactureData](#ManufactureData)> | 是 | 是 | 表示要广播的广播的制造商信息列表。 |
| serviceData | Array<[ServiceData](#ServiceData)> | 是 | 是 | 表示要广播的服务数据列表。 |
## ManufactureData
......
zh-cn/application-dev/ui/Readme-CN.md
浏览文件 @ 0de08836
# UI
- 方舟开发框架（ArkUI）
- [方舟开发框架概述](arkui-overview.md)
- 基于JS扩展的类Web开发范式
- [概述](ui-js-overview.md)
- 框架说明
- [文件组织](js-framework-file.md)
- [js标签配置](js-framework-js-tag.md)
- [app.js](js-framework-js-file.md)
- 语法
- [HML语法参考](js-framework-syntax-hml.md)
- [CSS语法参考](js-framework-syntax-css.md)
- [JS语法参考](js-framework-syntax-js.md)
- [生命周期](js-framework-lifecycle.md)
- [资源限定与访问](js-framework-resource-restriction.md)
- [多语言支持](js-framework-multiple-languages.md)
- 构建用户界面
- [组件介绍](ui-js-building-ui-component.md)
- 构建布局
- [布局说明](ui-js-building-ui-layout-intro.md)
- [添加标题行和文本区域](ui-js-building-ui-layout-text.md)
- [添加图片区域](ui-js-building-ui-layout-image.md)
- [添加留言区域](ui-js-building-ui-layout-comment.md)
- [添加容器](ui-js-building-ui-layout-external-container.md)
- [添加交互](ui-js-building-ui-interactions.md)
- [动画](ui-js-building-ui-animation.md)
- [事件](ui-js-building-ui-event.md)
- [页面路由](ui-js-building-ui-routes.md)
- 常见组件开发指导
- [Text](ui-js-components-text.md)
- [Input](ui-js-components-input.md)
- [Button](ui-js-components-button.md)
- [List](ui-js-components-list.md)
- [Picker](ui-js-components-picker.md)
- [Dialog](ui-js-components-dialog.md)
- [Form](ui-js-components-form.md)
- [Stepper](ui-js-components-stepper.md)
- [Tabs](ui-js-component-tabs.md)
- [Image](ui-js-components-images.md)
- 动效开发指导
- CSS动画
- [属性样式动画](ui-js-animate-attribute-style.md)
- [transform样式动画](ui-js-animate-transform.md)
- [background-position样式动画](ui-js-animate-background-position-style.md)
- JS动画
- [组件动画](ui-js-animate-component.md)
- 插值器动画
- [动画动效](ui-js-animate-dynamic-effects.md)
- [动画帧](ui-js-animate-frame.md)
- [自定义组件](ui-js-custom-components.md)
- 基于TS扩展的声明式开发范式
- [概述](ui-ts-overview.md)
- 框架说明
- 文件组织
- [目录结构](ts-framework-directory.md)
- [应用代码文件访问规则](ts-framework-file-access-rules.md)
- [js标签配置](ts-framework-js-tag.md)
- 资源访问
- [媒体资源类型说明](ts-media-resource-type.md)
- [像素单位](ts-pixel-units.md)
- [类型定义](ts-types.md)
- 声明式语法
- [描述规范使用说明](ts-syntax-intro.md)
- 通用UI描述规范
- [基本概念](ts-general-ui-concepts.md)
- 声明式UI描述规范
- [无构造参数配置](ts-parameterless-configuration.md)
- [必选参数构造配置](ts-configuration-with-mandatory-parameters.md)
- [属性配置](ts-attribution-configuration.md)
- [事件配置](ts-event-configuration.md)
- [子组件配置](ts-child-component-configuration.md)
- 组件化
- [@Component](ts-component-based-component.md)
- [@Entry](ts-component-based-entry.md)
- [@Preview](ts-component-based-preview.md)
- [@Builder](ts-component-based-builder.md)
- [@Extend](ts-component-based-extend.md)
- [@CustomDialog](ts-component-based-customdialog.md)
- UI状态管理
- [基本概念](ts-ui-state-mgmt-concepts.md)
- 管理组件拥有的状态
- [@State](ts-component-states-state.md)
- [@Prop](ts-component-states-prop.md)
- [@Link](ts-component-states-link.md)
- 管理应用程序的状态
- [应用程序的数据存储](ts-application-states-appstorage.md)
- [持久化数据管理](ts-application-states-apis-persistentstorage.md)
- [环境变量](ts-application-states-apis-environment.md)
- 其他类目的状态管理
- [Observed和ObjectLink数据管理](ts-other-states-observed-objectlink.md)
- [@Consume和@Provide数据管理](ts-other-states-consume-provide.md)
- [@Watch](ts-other-states-watch.md)
- 渲染控制语法
- [条件渲染](ts-rending-control-syntax-if-else.md)
- [循环渲染](ts-rending-control-syntax-foreach.md)
- [数据懒加载](ts-rending-control-syntax-lazyforeach.md)
- 深入理解组件化
- [build函数](ts-function-build.md)
- [自定义组件初始化](ts-custom-component-initialization.md)
- [自定义组件生命周期回调函数](ts-custom-component-lifecycle-callbacks.md)
- [组件创建和重新初始化示例](ts-component-creation-re-initialization.md)
- [语法糖](ts-syntactic-sugar.md)
- 体验声明式UI
- [创建声明式UI工程](ui-ts-creating-project.md)
- [初识Component](ui-ts-components.md)
- [创建简单视图](ui-ts-creating-simple-page.md)
- 页面布局与连接
- [构建食物数据模型](ui-ts-building-data-model.md)
- [构建食物列表List布局](ui-ts-building-category-list-layout.md)
- [构建食物分类Grid布局](ui-ts-building-category-grid-layout.md)
- [页面跳转与数据传递](ui-ts-page-redirection-data-transmission.md)
- [方舟开发框架（ArkUI）概述](arkui-overview.md)
- 基于JS扩展的类Web开发范式
- [概述](ui-js-overview.md)
- 框架说明
- [文件组织](js-framework-file.md)
- [js标签配置](js-framework-js-tag.md)
- [app.js](js-framework-js-file.md)
- 语法
- [HML语法参考](js-framework-syntax-hml.md)
- [CSS语法参考](js-framework-syntax-css.md)
- [JS语法参考](js-framework-syntax-js.md)
- [生命周期](js-framework-lifecycle.md)
- [资源限定与访问](js-framework-resource-restriction.md)
- [多语言支持](js-framework-multiple-languages.md)
- 构建用户界面
- [组件介绍](ui-js-building-ui-component.md)
- 构建布局
- [布局说明](ui-js-building-ui-layout-intro.md)
- [添加标题行和文本区域](ui-js-building-ui-layout-text.md)
- [添加图片区域](ui-js-building-ui-layout-image.md)
- [添加留言区域](ui-js-building-ui-layout-comment.md)
- [添加容器](ui-js-building-ui-layout-external-container.md)
- [添加交互](ui-js-building-ui-interactions.md)
- [动画](ui-js-building-ui-animation.md)
- [事件](ui-js-building-ui-event.md)
- [页面路由](ui-js-building-ui-routes.md)
- 常见组件开发指导
- [Text](ui-js-components-text.md)
- [Input](ui-js-components-input.md)
- [Button](ui-js-components-button.md)
- [List](ui-js-components-list.md)
- [Picker](ui-js-components-picker.md)
- [Dialog](ui-js-components-dialog.md)
- [Form](ui-js-components-form.md)
- [Stepper](ui-js-components-stepper.md)
- [Tabs](ui-js-component-tabs.md)
- [Image](ui-js-components-images.md)
- 动效开发指导
- CSS动画
- [属性样式动画](ui-js-animate-attribute-style.md)
- [transform样式动画](ui-js-animate-transform.md)
- [background-position样式动画](ui-js-animate-background-position-style.md)
- JS动画
- [组件动画](ui-js-animate-component.md)
- 插值器动画
- [动画动效](ui-js-animate-dynamic-effects.md)
- [动画帧](ui-js-animate-frame.md)
- [自定义组件](ui-js-custom-components.md)
- 基于TS扩展的声明式开发范式
- [概述](ui-ts-overview.md)
- 框架说明
- 文件组织
- [目录结构](ts-framework-directory.md)
- [应用代码文件访问规则](ts-framework-file-access-rules.md)
- [js标签配置](ts-framework-js-tag.md)
- 资源访问
- [媒体资源类型说明](ts-media-resource-type.md)
- [像素单位](ts-pixel-units.md)
- [类型定义](ts-types.md)
- 声明式语法
- [描述规范使用说明](ts-syntax-intro.md)
- 通用UI描述规范
- [基本概念](ts-general-ui-concepts.md)
- 声明式UI描述规范
- [无构造参数配置](ts-parameterless-configuration.md)
- [必选参数构造配置](ts-configuration-with-mandatory-parameters.md)
- [属性配置](ts-attribution-configuration.md)
- [事件配置](ts-event-configuration.md)
- [子组件配置](ts-child-component-configuration.md)
- 组件化
- [@Component](ts-component-based-component.md)
- [@Entry](ts-component-based-entry.md)
- [@Preview](ts-component-based-preview.md)
- [@Builder](ts-component-based-builder.md)
- [@Extend](ts-component-based-extend.md)
- [@CustomDialog](ts-component-based-customdialog.md)
- UI状态管理
- [基本概念](ts-ui-state-mgmt-concepts.md)
- 管理组件拥有的状态
- [@State](ts-component-states-state.md)
- [@Prop](ts-component-states-prop.md)
- [@Link](ts-component-states-link.md)
- 管理应用程序的状态
- [应用程序的数据存储](ts-application-states-appstorage.md)
- [持久化数据管理](ts-application-states-apis-persistentstorage.md)
- [环境变量](ts-application-states-apis-environment.md)
- 其他类目的状态管理
- [Observed和ObjectLink数据管理](ts-other-states-observed-objectlink.md)
- [@Consume和@Provide数据管理](ts-other-states-consume-provide.md)
- [@Watch](ts-other-states-watch.md)
- 渲染控制语法
- [条件渲染](ts-rending-control-syntax-if-else.md)
- [循环渲染](ts-rending-control-syntax-foreach.md)
- [数据懒加载](ts-rending-control-syntax-lazyforeach.md)
- 深入理解组件化
- [build函数](ts-function-build.md)
- [自定义组件初始化](ts-custom-component-initialization.md)
- [自定义组件生命周期回调函数](ts-custom-component-lifecycle-callbacks.md)
- [组件创建和重新初始化示例](ts-component-creation-re-initialization.md)
- [语法糖](ts-syntactic-sugar.md)
- 体验声明式UI
- [创建声明式UI工程](ui-ts-creating-project.md)
- [初识Component](ui-ts-components.md)
- [创建简单视图](ui-ts-creating-simple-page.md)
- 页面布局与连接
- [构建食物数据模型](ui-ts-building-data-model.md)
- [构建食物列表List布局](ui-ts-building-category-list-layout.md)
- [构建食物分类Grid布局](ui-ts-building-category-grid-layout.md)
- [页面跳转与数据传递](ui-ts-page-redirection-data-transmission.md)
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或