diff --git a/LICENSE b/LICENSE new file mode 100755 index 0000000000000000000000000000000000000000..4a459866a57c25462afad17f3fe0b50d440da080 --- /dev/null +++ b/LICENSE @@ -0,0 +1,177 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS \ No newline at end of file diff --git a/README.en.md b/README.en.md deleted file mode 100644 index fc466aa99062aa99df1c1e6d1f49b1c414d07a21..0000000000000000000000000000000000000000 --- a/README.en.md +++ /dev/null @@ -1,36 +0,0 @@ -# device_profile_core - -#### Description -{**When you're done, you can delete the content in this README and update the file with details for others getting started with your repository**} - -#### Software Architecture -Software architecture description - -#### Installation - -1. xxxx -2. xxxx -3. xxxx - -#### Instructions - -1. xxxx -2. xxxx -3. xxxx - -#### Contribution - -1. Fork the repository -2. Create Feat_xxx branch -3. Commit your code -4. Create Pull Request - - -#### Gitee Feature - -1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md -2. Gitee blog [blog.gitee.com](https://blog.gitee.com) -3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore) -4. The most valuable open source project [GVP](https://gitee.com/gvp) -5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help) -6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) diff --git a/README.md b/README.md old mode 100644 new mode 100755 index bdf743b7fe1300b4343b603dfed29cd10b950764..b5eb942c08f2e2039392369ea04120ab94688c9f --- a/README.md +++ b/README.md @@ -1,39 +1,195 @@ -# device_profile_core +# 介绍 -#### 介绍 -{**以下是 Gitee 平台说明,您可以替换此简介** -Gitee 是 OSCHINA 推出的基于 Git 的代码托管平台(同时支持 SVN)。专为开发者提供稳定、高效、安全的云端软件开发协作平台 -无论是个人、团队、或是企业,都能够用 Gitee 实现代码托管、项目管理、协作开发。企业项目请看 [https://gitee.com/enterprises](https://gitee.com/enterprises)} +- [简介](#section11660541593) +- [目录](#section1464106163817) +- [约束](#section1718733212019) +- [使用](#section10729231131110) +- [涉及仓](#section176111311166) -#### 软件架构 -软件架构说明 +## 简介 +DeviceProfile是设备硬件能力和系统软件特征的管理器,典型的Profile有设备类型、设备名称、设备OS类型、OS版本号等。DeviceProfile提供快速访问本地和远端设备Profile的能力,是发起分布式业务的基础。主要功能如下: -#### 安装教程 +- 本地设备Profile的插入、删除、查询。 +- 远程设备Profile的查询。 +- 订阅远程Profile变化的通知。 +- 跨设备同步Profile。 -1. xxxx -2. xxxx -3. xxxx +DeviceProfile模块组成如下图所示: -#### 使用说明 +## 系统架构 -1. xxxx -2. xxxx -3. xxxx +![](figures/dp-architecture_zh.png) -#### 参与贡献 +**图 1** DeviceProfile组件架构图 -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request +## 目录 +DeviceProfile主要代码目录结构如下: -#### 特技 +``` +├── interfaces +│   └── innerkits +│   └── distributeddeviceprofile // innerkits接口 +├── ohos.build +├── sa_profile // said声明文件 +│   ├── 6001.xml +│   └── BUILD.gn +├── services +│   └── distributeddeviceprofile +│   ├── BUILD.gn +│   ├── include +│   │   ├── contentsensor // CS数据采集头文件 +│   │   ├── dbstorage // 数据库操作头文件 +│   │   ├── devicemanager // 设备管理头文件 +│   │   └── subscribemanager // 订阅管理头文件 +│   ├── src +│   │   ├── contentsensor // CS数据采集实现 +│   │   ├── dbstorage // 数据库操作实现 +│   │   ├── devicemanager // 设备管理实现 +│   │   ├── subscribemanager // 订阅管理实现 +│   └── test // 测试用例 +└── tools + └── dp // 辅助测试工具 +``` -1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md -2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com) -3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目 -4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目,是综合评定出的优秀开源项目 -5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) -6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +## 约束 + +- 组网设备需在同一局域网中。 +- 组网之前,需先完成设备绑定,绑定流程参见安全子系统中说明。 + +## 使用 + +### 查询Profile信息 + +* GetDeviceProfile参数描述 + +| 名称 | 类型 | 必填 | 描述 | +| --------- | ---------------------------- | ---- | ----------------------------------- | +| deviceId | std::string | 是 | 查询指定设备的profile,空值表示查询本地 | +| serviceId | std::string | 是 | 查询的service id | +| profile | ServiceCharacteristicProfile | 是 | 返回值 | + +* 代码示例 + +```c++ +// 声明返回值 +ServiceCharacteristicProfile profile; +// 执行查询接口GetDeviceProfile +DistributedDeviceProfileClient::GetInstance().GetDeviceProfile(deviceId, serviceId, profile); +std::string jsonData = profile.GetCharacteristicProfileJson(); +result.append("jsonData:" + jsonData + "\n"); +``` + +### 插入Profile信息 + +* PutDeviceProfile参数描述 + +| 名称 | 类型 | 必填 | 描述 | +| --------- | ---------------------------- | ---- | ----------------------------------- | +| profile | ServiceCharacteristicProfile | 是 | 需要插入的profile信息 | + +* 代码示例 + +```c++ +// 声明并填充插入数据 +ServiceCharacteristicProfile profile; +profile.SetServiceId(serviceId); +profile.SetServiceType(serviceType); +nlohmann::json j; +j["testVersion"] = "3.0.0"; +j["testApiLevel"] = API_LEVEL; +profile.SetCharacteristicProfileJson(j.dump()); +// 执行插入接口PutDeviceProfile +DistributedDeviceProfileClient::GetInstance().PutDeviceProfile(profile); +``` + +### 删除Profile信息 + +* DeleteDeviceProfile参数描述 + +| 名称 | 类型 | 必填 | 描述 | +| --------- | ---------------------------- | ---- | ----------------------------------- | +| serviceId | std::string | 是 | 删除特定serviceid的记录 | + +* 代码示例 + +```c++ +// 声明并填充插入数据 +std::string serviceId = "test"; +// DeleteDeviceProfile +DistributedDeviceProfileClient::GetInstance().DeleteDeviceProfile(serviceId); +``` + +### 同步Profile信息 + +* SyncDeviceProfile参数描述 + +| 名称 | 类型 | 必填 | 描述 | +| --------- | ---------------------------- | ---- | ----------------------------------- | +| syncOption| SyncOption | 是 | 指定同步范围和模式 | +| syncCb | IProfileEventCallback | 是 | 同步结果回调 | + +* 代码示例 + +```c++ +// 定义同步模式和范围 +SyncOptions syncOption; +syncOption.SetSyncMode((OHOS::DistributedKv::SyncMode)atoi(mode.c_str())); +for (const auto& deviceId : deviceIds) { + syncOption.AddDevice(deviceId); +} +// 执行同步接口 +DistributedDeviceProfileClient::GetInstance().SyncDeviceProfile(syncOption, + std::make_shared()); +``` + +### 订阅Profile事件(同步、变更事件) + +* SubscribeProfileEvents参数描述 + +| 名称 | 类型 | 必填 | 描述 | +| -------------- | ---------------------------- | ---- | ----------------------------------- | +| subscribeInfos | SubscribeInfo | 是 | 指定订阅的事件类型 | +| eventCb | IProfileEventCallback | 是 | 订阅事件回调 | +| failedEvents | ProfileEvent | 是 | 失败事件 | + +* 代码示例 + +```c++ +auto callback = std::make_shared(); +std::list subscribeInfos; +ExtraInfo extraInfo; +extraInfo["deviceId"] = deviceId; +extraInfo["serviceIds"] = serviceIds; + +// 订阅EVENT_PROFILE_CHANGED事件 +SubscribeInfo info1; +info1.profileEvent = ProfileEvent::EVENT_PROFILE_CHANGED; +info1.extraInfo = std::move(extraInfo); +subscribeInfos.emplace_back(info1); + +// 订阅EVENT_SYNC_COMPLETED事件 +SubscribeInfo info2; +info2.profileEvent = ProfileEvent::EVENT_SYNC_COMPLETED; +info2.extraInfo = std::move(extraInfo); +subscribeInfos.emplace_back(info2); + +std::list failedEvents; +// 执行订阅接口 +DistributedDeviceProfileClient::GetInstance().SubscribeProfileEvents(subscribeInfos, + callback, failedEvents); +sleep(SUBSCRIBE_SLEEP_TIME); +std::list profileEvents; +profileEvents.emplace_back(ProfileEvent::EVENT_PROFILE_CHANGED); +failedEvents.clear(); +// 解除订阅 +DistributedDeviceProfileClient::GetInstance().UnsubscribeProfileEvents(profileEvents, + callback, failedEvents); +``` + +## 涉及仓 + +**[DeviceProfile子系统](zh-cn_topic_0000001115719369.md)** + +[device\_profile\_core](https://gitee.com/openharmony-sig/device_profile_core) \ No newline at end of file diff --git a/README_zh.md b/README_zh.md new file mode 100755 index 0000000000000000000000000000000000000000..b5eb942c08f2e2039392369ea04120ab94688c9f --- /dev/null +++ b/README_zh.md @@ -0,0 +1,195 @@ +# 介绍 + +- [简介](#section11660541593) +- [目录](#section1464106163817) +- [约束](#section1718733212019) +- [使用](#section10729231131110) +- [涉及仓](#section176111311166) + +## 简介 + +DeviceProfile是设备硬件能力和系统软件特征的管理器,典型的Profile有设备类型、设备名称、设备OS类型、OS版本号等。DeviceProfile提供快速访问本地和远端设备Profile的能力,是发起分布式业务的基础。主要功能如下: + +- 本地设备Profile的插入、删除、查询。 +- 远程设备Profile的查询。 +- 订阅远程Profile变化的通知。 +- 跨设备同步Profile。 + +DeviceProfile模块组成如下图所示: + +## 系统架构 + +![](figures/dp-architecture_zh.png) + +**图 1** DeviceProfile组件架构图 + +## 目录 + +DeviceProfile主要代码目录结构如下: + +``` +├── interfaces +│   └── innerkits +│   └── distributeddeviceprofile // innerkits接口 +├── ohos.build +├── sa_profile // said声明文件 +│   ├── 6001.xml +│   └── BUILD.gn +├── services +│   └── distributeddeviceprofile +│   ├── BUILD.gn +│   ├── include +│   │   ├── contentsensor // CS数据采集头文件 +│   │   ├── dbstorage // 数据库操作头文件 +│   │   ├── devicemanager // 设备管理头文件 +│   │   └── subscribemanager // 订阅管理头文件 +│   ├── src +│   │   ├── contentsensor // CS数据采集实现 +│   │   ├── dbstorage // 数据库操作实现 +│   │   ├── devicemanager // 设备管理实现 +│   │   ├── subscribemanager // 订阅管理实现 +│   └── test // 测试用例 +└── tools + └── dp // 辅助测试工具 +``` + +## 约束 + +- 组网设备需在同一局域网中。 +- 组网之前,需先完成设备绑定,绑定流程参见安全子系统中说明。 + +## 使用 + +### 查询Profile信息 + +* GetDeviceProfile参数描述 + +| 名称 | 类型 | 必填 | 描述 | +| --------- | ---------------------------- | ---- | ----------------------------------- | +| deviceId | std::string | 是 | 查询指定设备的profile,空值表示查询本地 | +| serviceId | std::string | 是 | 查询的service id | +| profile | ServiceCharacteristicProfile | 是 | 返回值 | + +* 代码示例 + +```c++ +// 声明返回值 +ServiceCharacteristicProfile profile; +// 执行查询接口GetDeviceProfile +DistributedDeviceProfileClient::GetInstance().GetDeviceProfile(deviceId, serviceId, profile); +std::string jsonData = profile.GetCharacteristicProfileJson(); +result.append("jsonData:" + jsonData + "\n"); +``` + +### 插入Profile信息 + +* PutDeviceProfile参数描述 + +| 名称 | 类型 | 必填 | 描述 | +| --------- | ---------------------------- | ---- | ----------------------------------- | +| profile | ServiceCharacteristicProfile | 是 | 需要插入的profile信息 | + +* 代码示例 + +```c++ +// 声明并填充插入数据 +ServiceCharacteristicProfile profile; +profile.SetServiceId(serviceId); +profile.SetServiceType(serviceType); +nlohmann::json j; +j["testVersion"] = "3.0.0"; +j["testApiLevel"] = API_LEVEL; +profile.SetCharacteristicProfileJson(j.dump()); +// 执行插入接口PutDeviceProfile +DistributedDeviceProfileClient::GetInstance().PutDeviceProfile(profile); +``` + +### 删除Profile信息 + +* DeleteDeviceProfile参数描述 + +| 名称 | 类型 | 必填 | 描述 | +| --------- | ---------------------------- | ---- | ----------------------------------- | +| serviceId | std::string | 是 | 删除特定serviceid的记录 | + +* 代码示例 + +```c++ +// 声明并填充插入数据 +std::string serviceId = "test"; +// DeleteDeviceProfile +DistributedDeviceProfileClient::GetInstance().DeleteDeviceProfile(serviceId); +``` + +### 同步Profile信息 + +* SyncDeviceProfile参数描述 + +| 名称 | 类型 | 必填 | 描述 | +| --------- | ---------------------------- | ---- | ----------------------------------- | +| syncOption| SyncOption | 是 | 指定同步范围和模式 | +| syncCb | IProfileEventCallback | 是 | 同步结果回调 | + +* 代码示例 + +```c++ +// 定义同步模式和范围 +SyncOptions syncOption; +syncOption.SetSyncMode((OHOS::DistributedKv::SyncMode)atoi(mode.c_str())); +for (const auto& deviceId : deviceIds) { + syncOption.AddDevice(deviceId); +} +// 执行同步接口 +DistributedDeviceProfileClient::GetInstance().SyncDeviceProfile(syncOption, + std::make_shared()); +``` + +### 订阅Profile事件(同步、变更事件) + +* SubscribeProfileEvents参数描述 + +| 名称 | 类型 | 必填 | 描述 | +| -------------- | ---------------------------- | ---- | ----------------------------------- | +| subscribeInfos | SubscribeInfo | 是 | 指定订阅的事件类型 | +| eventCb | IProfileEventCallback | 是 | 订阅事件回调 | +| failedEvents | ProfileEvent | 是 | 失败事件 | + +* 代码示例 + +```c++ +auto callback = std::make_shared(); +std::list subscribeInfos; +ExtraInfo extraInfo; +extraInfo["deviceId"] = deviceId; +extraInfo["serviceIds"] = serviceIds; + +// 订阅EVENT_PROFILE_CHANGED事件 +SubscribeInfo info1; +info1.profileEvent = ProfileEvent::EVENT_PROFILE_CHANGED; +info1.extraInfo = std::move(extraInfo); +subscribeInfos.emplace_back(info1); + +// 订阅EVENT_SYNC_COMPLETED事件 +SubscribeInfo info2; +info2.profileEvent = ProfileEvent::EVENT_SYNC_COMPLETED; +info2.extraInfo = std::move(extraInfo); +subscribeInfos.emplace_back(info2); + +std::list failedEvents; +// 执行订阅接口 +DistributedDeviceProfileClient::GetInstance().SubscribeProfileEvents(subscribeInfos, + callback, failedEvents); +sleep(SUBSCRIBE_SLEEP_TIME); +std::list profileEvents; +profileEvents.emplace_back(ProfileEvent::EVENT_PROFILE_CHANGED); +failedEvents.clear(); +// 解除订阅 +DistributedDeviceProfileClient::GetInstance().UnsubscribeProfileEvents(profileEvents, + callback, failedEvents); +``` + +## 涉及仓 + +**[DeviceProfile子系统](zh-cn_topic_0000001115719369.md)** + +[device\_profile\_core](https://gitee.com/openharmony-sig/device_profile_core) \ No newline at end of file diff --git a/figures/dp-architecture_zh.png b/figures/dp-architecture_zh.png new file mode 100755 index 0000000000000000000000000000000000000000..58009df7a4cbee4664985e24a0f0f00ed60f88ed Binary files /dev/null and b/figures/dp-architecture_zh.png differ