当前仓库属于关闭状态,部分功能使用受限,详情请查阅 仓库状态说明
6 Star 10 Fork 4

OpenHarmony / developtools_hdc_standard
关闭

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

HDC-OpenHarmony设备连接器

简介

HDC(OpenHarmony Device Connector) 是为开发人员提供的用于设备连接调试的命令行工具,pc端开发机使用命令行工具hdc_std(为方便起见,下文统称hdc),该工具需支持部署在Windows/Linux/Mac等系统上与OpenHarmony设备(或模拟器)进行连接调试通信。PC端hdc工具需要针对以上开发机操作系统平台分别发布相应的版本,设备端hdc daemon需跟随设备镜像发布包括对模拟器进行支持。下文将介绍hdc的常用命令及使用举例。

架构

hdc主要有三部分组成:

  1. hdc client部分:运行于开发机上的客户端,用户可以在开发机命令终端(windows cmd/linux shell)下请求执行相应的hdc命令,运行于开发机器,其它的终端调试IDE也包含hdc client。

  2. hdc server部分:作为后台进程也运行于开发机器,server管理client和设备端daemon之间通信包括连接的复用、数据通信包的收发,以及个别本地命令的直接处理。

  3. hdc daemon部分:daemon部署于OpenHarmony设备端作为守护进程来按需运行,负责处理来自client端的请求。

目录

/developtools
├── hdc               # hdc代码目录
│   └── src
│       ├── common    # 设备端和host端公用的代码目录
│       ├── daemon    # 设备端的代码目录 
│       ├── host      # host端的代码目录
│       └── test      # 测试用例的代码目录  

pc端编译说明

hdc pc端可执行文件编译步骤:

  1. 编译命令:编译sdk命令 请参考https://gitee.com/openharmony/build/blob/master/README_zh.md 仓编译sdk说明, 执行其指定的sdk编译命令来编译整个sdk, hdc会被编译打包到里面。

  2. 编译:在目标开发机上运行上面调整好的sdk编译命令, 正常编译hdc_std会输出到sdk平台相关目录下; 注意: ubuntu环境下只能编译windows/linux版本工具,mac版需要在macos开发机上编译。

pc端获取说明

1.下载sdk获取(建议)

通过访问本社区网站下载dailybuilds或正式发布的sdk压缩包,从中根据自己平台到相应的目录toolchain下解压提取

2.自行编译

编译请参考上面单独小节,本项目仓prebuilt目录下不再提供预制

3.支持运行环境

linux版本建议ubuntu 18.04以上 64位,其他相近版本也可;libc++.so引用错误请使用ldd/readelf等命令检查库引用 windows版本建议windows10 64位,如果低版本windows winusb库缺失,请使用zadig更新库。

Linux端USB设备权限说明

在Linux下在非root权限下使用hdc会出现无法找到设备的情况,此问题原因为用户USB操作权限问题,解决方法如下:

  1. 开启非root用户USB设备操作权限 该操作方法简单易行,但是可能存在潜在安全问题,请根据使用场景自行评估

    sudo chmod -R 777 /dev/bus/usb/
  2. 永久修改 USB 设备权限 1)使用lsusb命令找出USB设备的vendorID和productID 2)创建一个新的udev规则

    编辑UDEV加载规则,用设备的"idVendor"和"idProduct"来替换默认值。MODE="0666"表示USB设备的权限 GROUP代表用户组,要确保此时登录的系统用户在该用户组中 可用 "usermod -a -G username groupname" 将用户添加到用户组中

    sudo vim /etc/udev/rules.d/90-myusb.rules
    SUBSYSTEMS=="usb", ATTRS{idVendor}=="067b", ATTRS{idProduct}=="2303", GROUP="users", MODE="0666"

    重启电脑或重新加载 udev 规则

    sudo udevadm control --reload
  3. su 切换到root用户下运行测试程序

    sudo hdc_std list targets

命令帮助

hdc当前常用命令如下,未尽命令使用hdc -h或者hdc --help查看:

表 1 hdc常用命令列表

Option

Description

-t key

用于指定连接该指定设备识Key

举例:hdc -t *****(设备id) shell

-s socket

用于指定服务监听的socket配置

举例:hdc -s ip:port

-h/help -v/version

用于显示hdc相关的帮助、版本信息

list targets[-v]

显示所有已经连接的目标设备列表,-v选项显示详细信息

举例: hdc list targets

target mount

以读写模式挂载/vendor、/data等分区,因为安全性问题,需要挂在根目录或者/system分区请单独使用'hdc_std shell mount -o rw,remount /'等命令

举例: hdc target mount

smode [off]

授予后台服务进程root权限, 使用off参数取消授权

举例: hdc smode

kill [-r]

终止hdc服务进程, -r选项会触发再次重启hdc server

举例: hdc kill

start [-r]

启动hdc服务进程, -r选项会触发重启hdc server

举例: hdc start

tconn host[:port][-remove]

通过【ip地址:端口号】来指定连接的设备

使用TCP模式连接设备,需在USB模式工作下使用tmode tcp切换至TCP工作模式,或者在
系统属性值中设置persist.hdc.mode属性值为tcp,如果需要监听固定TCP端口需要再设置
persist.hdc.port的端口号,反之则TCP监听端口随机

举例: hdc tconn 192.168.0.100:10178

tmode usb

执行后设备端对应daemon进程重启,并首先选用usb连接方式

tmode port port-number

执行后设备端对应daemon进程重启,并优先使用网络方式连接设备,如果连接设备再选择usb连接

file send local remote

从host端发送文件至设备

举例: hdc file send E:\a.txt /data/local/tmp/a.txt

file recv [-a] remote local

从设备端拉出文件至本地host端

举例: hdc file recv /data/local/tmp/a.txt ./a.txt

install [-r/-d/-g] package

安装OpenHarmony package

举例: hdc install E:\***.hap

uninstall [-k] package

卸载OpenHarmony应用

hilog

支持查看抓取hilog调试信息

举例: hdc hilog

shell [command]

远程执行命令或进入交互命令环境

举例: hdc shell

以下是常用hdc命令示例,供开发者参考:

  • 查看设备连接信息

    hdc list targets
  • 往设备中推送文件

    hdc file send  E:\a.txt  /data/local/tmp/a.txt
  • 从设备中拉取文件

    hdc file recv  /data/local/tmp/a.txt   ./a.txt
  • 安装应用

    hdc install E:\***.hap
  • 查看日志

    hdc hilog
  • 进入命令行交互模式

    hdc shell
  • TCP网络连接。

    hdc tconn 192.168.0.100:10178

使用问题自查说明

工具使用过程中碰到问题,可以参考如下流程自助排查:

  • step1: 先检查pc(host)端hdc_std 和L2设备端hdcd版本是否一致(-v 查看版本):
    • step1a: 版本不一致请更新使用一致版本再验证;
    • step1b: 版本一致请继续下面排查step2步骤;
  • step2: 检查pc(host)端设备管理器设备信息是否正常(设备是否正常加载显示、驱动、id是否正常):
    • step2a: 设备管理器设备异常或无设备, 请结合板测试设备端串口下确认下usb部分设备枚举上报是否异常;
    • step2b: 设备管理器设备正常时, 1)list targets 是否正常;2)hdc_std kill 后重试是否正常;

注意:客户端和设备端版本保持一致(hdc_std -v,hdcd -v参数查看版本)!

FAQ

    1. list targets无设备:
    请参考上面《使用问题自查说明》小节 1)检查设备是否连接正常;2)host端设备管理器设备信息是否正常;3)两端工具版本是否一致;4)设备端hdcd是否启动正常;
    如果仍然无法解决问题,请尝试下面两种方法进行恢复 1)执行命令hdc_std kill来重启pc侧hdc服务;2)重启端侧设备;
    1. 同样版本windows下正常,linux下无设备:
    同问题1同样排查步骤,另外注意在root权限下执行;
    如果server进程起不来,请先sudo rm /tmp/*.pid 然后再使用sudo 执行list targets看看是否正常显示设备列表
    1. windows版本工具无法执行报错:
    1)从dailybuild或正式发布的sdk压缩包,重新解压提取工具;2)检查文件大小和版本、校验哈希值; 3)本工具是控制台命令行下执行即可,适配平台下无任何组件和驱动依赖,不需要安装,不要尝试双击运行;
    1. system分区推文件报错 [Fail]Error opening file: read-only file system:
    推送文件前参考执行如下命令:
    hdc_std smode
    hdc_std shell mount -o rw,remount /
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

简介

Device debug connector that provides the device connection capability and a command line tool | 设备调试连接器,提供了连接设备的能力,并提供了对外的命令行工具 展开 收起
C++ 等 3 种语言
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/openharmony/developtools_hdc_standard.git
git@gitee.com:openharmony/developtools_hdc_standard.git
openharmony
developtools_hdc_standard
developtools_hdc_standard
master

搜索帮助

14c37bed 8189591 565d56ea 8189591