Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
提交 37cc208b 编写于 作者: Y yangni 提交者： wenjun
浏览文件
操作

Description: update docs 20210107 

CommitID:90b0e9d610bad9ad7014d889110e055e29599d6d
上级 7958dbc6
隐藏空白更改
内联 并排
Showing with 13766 addition and 324 deletion
Readme-CN.md
浏览文件 @ 37cc208b
...@@ -9,10 +9,11 @@ ...@@ -9,10 +9,11 @@
- quick-start：[快速入门](quick-start/Readme-CN.md) - quick-start：[快速入门](quick-start/Readme-CN.md)
- get-code：[获取源码/获取工具](get-code/Readme-CN.md) - get-code：[获取源码/获取工具](get-code/Readme-CN.md)
- docker：[Docker镜像构建](docker/README.md) - docker：[Docker镜像构建](docker/README.md)
- driver：[驱动](driver/Readme-CN.md)
- kernel：[内核](kernel/Readme-CN.md) - kernel：[内核](kernel/Readme-CN.md)
- driver：[驱动](driver/Readme-CN.md)
- subsystems：[子系统](subsystems/Readme-CN.md) - subsystems：[子系统](subsystems/Readme-CN.md)
- bundles：[组件开发](bundles/Readme-CN.md) - bundles：[组件开发](bundles/Readme-CN.md)
- porting：[三方库移植](porting/Readme-CN.md)
- guide：[设备开发](guide/Readme-CN.md) - guide：[设备开发](guide/Readme-CN.md)
- security：[安全](security/Readme-CN.md) - security：[安全](security/Readme-CN.md)
- api-LinkIoT：[联接类模组API](api/api-LinkIoT/Readme-CN.md) - api-LinkIoT：[联接类模组API](api/api-LinkIoT/Readme-CN.md)
......
bundles/HPM介绍.md 0 → 100644
浏览文件 @ 37cc208b
# HPM介绍<a name="ZH-CN_TOPIC_0000001071487274"></a>
随着OpenHarmony正式开源，HPM包管理器也应运而生。HPM全称HarmonyOS Package Manager，是OpenHarmony组件包的管理和分发工具。HPM主要是面向设备开发者，用于获取/定制OpenHarmony源码，执行安装、编译、打包、升级等操作的工具集。本文档将向开发者介绍如何使用HPM工具进行OpenHarmony组件的安装、编译、打包等操作。
bundles/Readme-CN.md
浏览文件 @ 37cc208b
...@@ -13,3 +13,8 @@ ...@@ -13,3 +13,8 @@
- [准备工作](准备工作.md) - [准备工作](准备工作.md)
- [组件开发](组件开发.md) - [组件开发](组件开发.md)
- [组件开发示例](组件开发示例.md)
- [HPM介绍](HPM介绍.md)
- [环境准备](环境准备.md)
- [操作实例](操作实例.md)
bundles/准备工作.md
浏览文件 @ 37cc208b
...@@ -23,9 +23,7 @@ ...@@ -23,9 +23,7 @@
推荐安装 [Node.js](https://nodejs.org/) 12.x \(包含 npm 6.14.4\)或更高版本 \(推荐 12.13.0+\)。 推荐安装 [Node.js](https://nodejs.org/) 12.x \(包含 npm 6.14.4\)或更高版本 \(推荐 12.13.0+\)。
2. 通过Node.js自带的npm安装hpm-cli命令行工具。 2. 通过Node.js自带的npm安装hpm-cli命令行工具。执行以下命令：
打开CMD，执行以下命令：
``` ```
npm install -g @ohos/hpm-cli npm install -g @ohos/hpm-cli
......
bundles/操作实例.md 0 → 100644
浏览文件 @ 37cc208b
# 操作实例<a name="ZH-CN_TOPIC_0000001072143838"></a>
环境准备好后，接下来本文以Hi3861平台为例，演示如何利用HPM进行组件的安装、编译和打包。
1. 执行以下命令，初始化安装目录（目录名可自行设置）：
```
mkdir test3861
cd test3861
hpm init -t dist
```
初始化成功则显示：
```
Initialization finished.
```
2. 安装wifi\_iot发行版。
```
hpm install @ohos/wifi_iot
```
安装成功则显示：
```
Installed.
```
>![](public_sys-resources/icon-note.gif) **说明：**
>Hi3516平台采用下述命令：
>```
>hpm install @ohos/ip_camera_hi3516dv300
>```
>Hi3518平台采用下述命令：
>```
>hpm install @ohos/ip_camera_hi3518ev300
>```
3. 编译打包
```
hpm dist
```
编译成功会显示：
```
{{name}}: distribution building completed.
```
4. 上述所有命令执行成功后，在 ./out 目录下会生成编译结果，开发者可以将编译结果烧录到对应的开发板上进行测试。
bundles/环境准备.md 0 → 100644
浏览文件 @ 37cc208b
# 环境准备<a name="ZH-CN_TOPIC_0000001071315859"></a>
- [linux服务器](#section20979554791)
- [安装Node.js](#section9954105413153)
- [安装HPM](#section15937194904819)
- [安装python环境](#section1621819180417)
- [安装文件打包工具](#section77617165913)
- [安装SCons](#section20558439191516)
## linux服务器<a name="section20979554791"></a>
准备一台装有Ubuntu 16.04 及以上 64 位系统的linux服务器（hpm是支持windows的，但是目前鸿蒙开源的Hi3861、Hi3516、Hi3518三个解决方案都只支持Ubuntu）。
将linux shell改为bash：
```
ls -l $(which sh)
# 如果指向的不是bash，则按以下方式修改：
# 方法一：执行以下命令，然后选择no
dpkg-reconfigure dash
# 方法二：先删除sh，再重新创建软连接
rm -f /bin/sh
ln -s bash /bin/sh
```
## 安装Node.js<a name="section9954105413153"></a>
推荐安装 Node.js 12.x （包含 npm 6.14.4）或更高版本（推荐 12.13.0+）：
```
sudo apt-get install nodejs
sudo apt-get install npm
```
查看版本：
```
node --version # 查看nodejs版本
npm --version # 查看npm版本
```
补充：如果配置的源的nodejs版本太低，可以执行以下语句后再执行apt-get install：
```
curl -L https://deb.nodesource.com/setup_12.x | bash
```
## 安装HPM<a name="section15937194904819"></a>
通过 Node.js 自带的 npm（使用默认的源 https://registry.npmjs.org/ ）安装 hpm-cli 命令行工具：
```
npm install -g @ohos/hpm-cli
```
安装完hpm-cli命令行工具后，执行以下命令可以查看hpm配置：
```
hpm config
```
上述命令执行后将会显示hpm的默认配置，您可以根据自己的喜好对默认配置进行修改，以下是hpm的常用配置：
```
registry = https://hpm.harmonyos.com # hpm注册中心地址，下载组件必须
strictSsl = true # 通过https连接时，是否需要校验证书
http_proxy = http://your-proxy-server:port # 配置HTTP代理
https_proxy = http://your-proxy-server:port # 配置HTTPS代理
```
hpm-cli的命令介绍可以参考：[hpm操作命令](组件管理.md#table10510164515371)
## 安装python环境<a name="section1621819180417"></a>
需使用python3.7以上版本，采用以下命令进行安装：
```
sudo apt-get install python3.8
sudo apt-get install python3-pip
sudo pip3 install setuptools
sudo pip3 install kconfiglib # 建议安装kconfiglib 13.2.0+版本
```
>![](public_sys-resources/icon-note.gif) **说明：**
>上述方式适用Hi3518和Hi3516两种平台，针对Hi3861平台采用以下方式安装python环境：
>```
>sudo apt-get install python3.8
>sudo apt-get install python3-pip
>sudo pip3 install setuptools
>sudo pip3 install kconfiglib # 建议安装kconfiglib 13.2.0+版本
>sudo pip3 install pycryptodome
>sudo pip3 install six --upgrade --ignore-installed six
>sudo pip3 install ecdsa
>```
如果当前系统中既存在python2又存在python3，参考以下方法将默认python修改为python3：
```
ll `which python`
rm /usr/bin/python
ln -s python3.8 /usr/bin/python
```
## 安装文件打包工具<a name="section77617165913"></a>
采用以下命令进行安装：
```
which mkfs.vfat # 如果没找到，执行以下命令安装
sudo apt-get install dosfstools
which mcopy # 如果没找到，执行以下命令安装
sudo apt-get install mtools
```
>![](public_sys-resources/icon-note.gif) **说明：**
>Hi3518和Hi3516两种平台需要安装打包工具，Hi3861平台不需要。
## 安装SCons<a name="section20558439191516"></a>
采用下述命令安装SCons：
```
sudo apt-get install scons # 推荐SCons版本是3.0.4+
```
>![](public_sys-resources/icon-note.gif) **说明：**
>Hi3861平台需要安装SCons，Hi3518和Hi3516两种平台不需要。
bundles/组件开发示例.md 0 → 100644
浏览文件 @ 37cc208b
# 组件开发示例<a name="ZH-CN_TOPIC_0000001074472258"></a>
- **[HPM介绍](HPM介绍.md)**
- **[环境准备](环境准备.md)**
- **[操作实例](操作实例.md)**
docs-en/Readme-EN.md
浏览文件 @ 37cc208b
# WELCOME-TO-OPEN-HARMONY # WELCOME TO OPENHARMONY
OpenHarmony is an open-source project launched by the OpenAtom Foundation and serves as an open-source, distributed operating system (OS) that is intended to address all conceivable usage scenarios. OpenHarmony is an open-source version of HarmonyOS. OpenHarmony is an open-source project launched by the OpenAtom Foundation and serves as an open-source, distributed operating system that is intended to address all conceivable usage scenarios. OpenHarmony is an open-source version of HarmonyOS.
HarmonyOS is a future-proof distributed operating system open to you as part of the initiatives for the all-scenario strategy, adaptable to a mobile office, fitness and health, social communication, and media entertainment, and so on. Unlike a legacy operating system that runs on a standalone device, HarmonyOS is built on a distributed architecture designed based on a set of system capabilities. It is able to run on a wide range of device forms, including smartphones, wearables, tablets, PCs, smart TVs, AI speakers, head units, earphones, and AR/VR glasses. HarmonyOS is a future-proof distributed operating system open to you as part of the initiatives for the all-scenario strategy. It is adaptable to mobile office, fitness and health, social communication, entertainment, and many other scenarios. Unlike any legacy operating system that runs on a standalone device, HarmonyOS is built on a distributed architecture designed based on a set of system capabilities. It is able to run on a wide range of device forms, including smartphones, wearables, tablets, PCs, smart TVs, AI speakers, head units, earphones, and AR/VR glasses.
## Motivation ## Motivation
The traditional OSs are limited to a specific type of device, OpenHarmony provides distributed features that are compatible with a wide range of different devices. The first version supports devices with 128 KB to 128 MB of memory. Join us as we keep updating OpenHarmony versions. Traditional OSs are limited to a specific type of device, while OpenHarmony provides distributed features that are compatible with a wide range of different devices. The first version supports devices with 128 KB to 128 MB of memory. Join us as we keep updating OpenHarmony versions.
For device developers, OpenHarmony utilizes a component-based design to tailor its features to better suit specific devices, based on each device's capabilities and service characteristics. OpenHarmony can run on devices with limited resources and wearables with hundreds of KB of memory, as well as more powerful devices, such as smart home cameras and dashcams with hundreds of MB of memory. For device developers, OpenHarmony utilizes a component-based design to tailor its features to better suit specific devices, based on each device's capabilities and service characteristics. OpenHarmony can run on devices with limited resources and wearables with hundreds of KB of memory, as well as more powerful devices, such as smart home cameras and dashcams with hundreds of MB of memory.
[中文版本](/Readme-CN.md) [中文版本](/Readme-CN.md)
## OpenHarmony Documentation ## OpenHarmony Documentation
- [Getting Started](https://gitee.com/openharmony/docs/blob/master/docs-en/quick-start/Readme-EN.md) - [Getting Started](https://gitee.com/openharmony/docs/blob/master/docs-en/quick-start/Readme-EN.md)
- [Source Code Acquisition/Tool Acquisition](https://gitee.com/openharmony/docs/blob/master/docs-en/get-code/source-code-acquisition.md)) - [Source Code Acquisition/Tool Acquisition](https://gitee.com/openharmony/docs/blob/master/docs-en/get-code/source-code-acquisition.md)
- [Device Development Guidelines](https://gitee.com/openharmony/docs/blob/master/docs-en/driver/Readme-EN.md)
- [Kernel Usage Guidelines](https://gitee.com/openharmony/docs/blob/master/docs-en/kernel/Readme-EN.md) - [Kernel Usage Guidelines](https://gitee.com/openharmony/docs/blob/master/docs-en/kernel/Readme-EN.md)
- [Driver Usage Guidelines](https://gitee.com/openharmony/docs/blob/master/docs-en/driver/Readme-EN.md)
- [Subsystem Development Guidelines](https://gitee.com/openharmony/docs/blob/master/docs-en/subsystems/Readme-EN.md) - [Subsystem Development Guidelines](https://gitee.com/openharmony/docs/blob/master/docs-en/subsystems/Readme-EN.md)
- [Bundle Development](https://gitee.com/openharmony/docs/blob/master/docs-en/bundles/Readme-EN.md) - [Bundle Development Guidelines](https://gitee.com/openharmony/docs/blob/master/docs-en/bundles/Readme-EN.md)
- [Device Development Guidelines](https://gitee.com/openharmony/docs/blob/master/docs-en/guide/Readme-EN.md)
- [Third-Party Library Porting Guidelines](https://gitee.com/openharmony/docs/blob/master/docs-en/porting/Readme-EN.md)
- [Privacy and Security](https://gitee.com/openharmony/docs/blob/master/docs-en/security/Readme-EN.md) - [Privacy and Security](https://gitee.com/openharmony/docs/blob/master/docs-en/security/Readme-EN.md)
- [LinkIoT Modules API](https://gitee.com/openharmony/docs/blob/master/docs-en/api/api-LinkIoT/Readme-EN.md) - [LinkIoT Modules API](https://gitee.com/openharmony/docs/blob/master/docs-en/api/api-LinkIoT/Readme-EN.md)
- [SmartVision Devices API](https://gitee.com/openharmony/docs/blob/master/docs-en/api/api-SmartVision-Devices/Readme-EN.md) - [SmartVision Devices API](https://gitee.com/openharmony/docs/blob/master/docs-en/api/api-SmartVision-Devices/Readme-EN.md)
- [Glossary](https://gitee.com/openharmony/docs/blob/master/docs-en/term/glossary.md) - [Glossary](https://gitee.com/openharmony/docs/blob/master/docs-en/term/glossary.md)
## Start Contributing ## Start Contributing
OpenHarmony is an Open Source Community and encourages everyone in the community to submit the patches directly to the project. You can either contribute to the code or documentation. OpenHarmony is an open-source community and encourages everyone in the community to submit patches directly to the project. You can contribute either to the code or documentation.
- [Contributing to the Code](https://gitee.com/openharmony/docs/blob/master/docs-en/contribute/contributing-code.md) - [Contributing to the Code](https://gitee.com/openharmony/docs/blob/master/docs-en/contribute/contributing-code.md)
- [Contributing to the Documentation](https://gitee.com/openharmony/docs/blob/master/docs-en/contribute/documentation-contribution.md) - [Contributing to the Documentation](https://gitee.com/openharmony/docs/blob/master/docs-en/contribute/documentation-contribution.md)
For more details on Contribution, see [Contributing Documents](https://gitee.com/openharmony/docs/tree/master/docs-en/contibute) For more details on how to contribute, see [Contributing Documents](https://gitee.com/openharmony/docs/tree/master/docs-en/contibute).
## Get Source Code and Tools ## Get Source Code and Tools
To download the source code and tools required for the project, click the following links. To download the source code and tools required for the project, click the following links:
- [Source Code Acquisition](https://gitee.com/openharmony/docs/blob/master/docs-en/get-code/source-code-acquisition.md) - [Source Code Acquisition](https://gitee.com/openharmony/docs/blob/master/docs-en/get-code/source-code-acquisition.md)
- [Tool Acquisition](https://gitee.com/openharmony/docs/blob/master/docs-en/get-code/tool-acquisition.md) - [Tool Acquisition](https://gitee.com/openharmony/docs/blob/master/docs-en/get-code/tool-acquisition.md)
## Where to Turn for Help ## Where to Turn for Help
You can subscribe to the mailing list to get constant updates on new features, release road maps, and community activities. For Subscribing to the mailing list or any other support, see [Communication in Community](https://gitee.com/openharmony/docs/tree/master/docs-en/contribute/communication-in-community.md). You can subscribe to the mailing list to get constant updates on new features, released road maps, and community activities. For how to subscribe to the mailing list or get any other support, see [Communication in Community](https://gitee.com/openharmony/docs/tree/master/docs-en/contribute/communication-in-community.md).
## Code of Conduct ## Code of Conduct
OpenHarmony is committed to providing a welcoming and inspiring community for all. In order to maintain a collaborative environment, we recommend you to read and follow the community [Code of Conduct](https://gitee.com/openharmony/docs/blob/master/docs-en/contribute/code-of-conduct.md). OpenHarmony is committed to providing a welcoming and inspiring community for all. In order to maintain a collaborative environment, we recommend you read and follow the community [Code of Conduct](https://gitee.com/openharmony/docs/blob/master/docs-en/contribute/code-of-conduct.md).
## Contributors & Acknowledgements ## Contributors & Acknowledgements
A great Open source project wouldn't exist without the hard work of its many contributors. We'd like to invite anyone from around the world to participate in this exciting journey. And we're grateful for your time, passion, and efforts! A great open-source project wouldn't be possible without the hard work of many contributors. We'd like to invite anyone from around the world to participate in this exciting journey, and we're grateful for your time, passion, and efforts!
## Release ## Release
In order to provide new features and bug fixes, the community constantly updates the code and provides new releases. For details on Release, see Release. In order to provide new features and bug fixes, the community constantly updates code and provides new releases.
docs-en/bundles/Readme-EN.md
浏览文件 @ 37cc208b
...@@ -13,3 +13,8 @@ ...@@ -13,3 +13,8 @@
- [Preparations](preparations.md) - [Preparations](preparations.md)
- [Bundle Development](bundle-development.md) - [Bundle Development](bundle-development.md)
- [HPM User Guide](hpm-user-guide.md)
- [Introduction](introduction.md)
- [Preparations](preparations-1.md)
- [Development Example](development-example.md)
docs-en/bundles/development-example.md 0 → 100644
浏览文件 @ 37cc208b
# Development Example<a name="EN-US_TOPIC_0000001072143838"></a>
This following uses the Hi3861 platform as an example to describe how to install, compile, and package components by using HPM.
1. Run the following commands to initialize the installation directory \(whose name can be customized\):
```
mkdir test3861
cd test3861
hpm init -t dist
```
If the following information is displayed, the initialization is successful:
```
Initialization finished.
```
2. Run the following command to install the **wifi\_iot** distribution:
```
hpm install @ohos/wifi_iot
```
If the following information is displayed, the installation is successful:
```
Installed.
```
>![](public_sys-resources/icon-note.gif) **NOTE:**
>Run the following command for the Hi3516 platform:
>```
>hpm install @ohos/ip_camera_hi3516dv300
>```
>Run the following command for the Hi3518 platform:
>```
>hpm install @ohos/ip_camera_hi3518ev300
>```
3. Run the following command to build and package components:
```
hpm dist
```
If the building is successful, the following information is displayed:
```
{{name}}: distribution building completed.
```
4. Check the result in the **./out** directory. You can burn the distribution into the corresponding development board for testing.
docs-en/bundles/environment-variables.md
浏览文件 @ 37cc208b
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
During bundle compilation, system-provided environment variables are required to define the output and link the required binary files. These variables are injected into the context for executing scripts based on service requirements. Therefore, their values can be directly obtained from the scripts. Currently, there are global and fixed environment variables in the system. During bundle compilation, system-provided environment variables are required to define the output and link the required binary files. These variables are injected into the context for executing scripts based on service requirements. Therefore, their values can be directly obtained from the scripts. Currently, there are global and fixed environment variables in the system.
Global variables are defined by the** envs** attribute in **bundle.json**. All dependent bundles can obtain the values of global variables. Global variables are defined by the **envs** attribute in **bundle.json**. All dependent bundles can obtain the values of global variables.
``` ```
{ {
......
docs-en/bundles/hpm-user-guide.md 0 → 100644
浏览文件 @ 37cc208b
# HPM User Guide<a name="EN-US_TOPIC_0000001074472258"></a>
- **[Introduction](introduction.md)**
- **[Preparations](preparations-1.md)**
- **[Development Example](development-example.md)**
docs-en/bundles/introduction.md 0 → 100644
浏览文件 @ 37cc208b
# Introduction<a name="EN-US_TOPIC_0000001071487274"></a>
HarmonyOS Package Manager \(HPM\) manages and distributes OpenHarmony component packages. It offers you a tool set to obtain and customize OpenHarmony source code and perform operations such as installation, compilation, packaging, and upgrade.
This document describes how to use HPM to install, compile, and package OpenHarmony components.
docs-en/bundles/preparations-1.md 0 → 100644
浏览文件 @ 37cc208b
# Preparations<a name="EN-US_TOPIC_0000001071315859"></a>
- [Linux Server](#section20979554791)
- [Node.js](#section9954105413153)
- [HPM](#section15937194904819)
- [Python Environment](#section1621819180417)
- [File Packaging Tool](#section77617165913)
- [SCons](#section20558439191516)
## Linux Server<a name="section20979554791"></a>
Prepare a 64-bit Linux server running Ubuntu 16.04 or later. HPM supports Windows Server, but the open-source Hi3861, Hi3516, and Hi3518 solutions support only Ubuntu.
Configure Ubuntu to use bash as the Linux system shell, by performing the following:
```
ls -l $(which sh)
# If the file does not point to bash, modify the file using either of the provided methods.
# Method 1: Run the following command and select no:
dpkg-reconfigure dash
# Method 2: Run the following commands to delete /bin/sh and then create a new symbolic link to bash:
rm -f /bin/sh
ln -s bash /bin/sh
```
## Node.js<a name="section9954105413153"></a>
You are advised to install Node.js 12.x \(including npm 6.14.4\) or a later version \(12.13.0 or later is recommended\).
```
sudo apt-get install nodejs
sudo apt-get install npm
```
Run the following commands to view Node.js and NPM versions:
```
node --version # Check the Node.js version.
npm --version # Check the NPM version.
```
Note: If the Node.js version of the source is outdated, run the following command before running **apt-get install**:
```
curl -L https://deb.nodesource.com/setup_12.x | bash
```
## HPM<a name="section15937194904819"></a>
Install the **hpm-cli** command line tool by using the NPM \(default source: https://registry.npmjs.org/\) provided by the Node.js.
```
npm install -g @ohos/hpm-cli
```
After **hpm-cli** is installed, run the following command to view default HPM configurations:
```
hpm config
```
You can modify the default configurations as required. The following lists common HPM configurations:
```
registry = https://hpm.harmonyos.com # Register with the HPM registration center. This is mandatory for downloading components.
strictSsl = true # Enable strict SSL verification as HTTPS is used for connection.
http_proxy = http://your-proxy-server:port # Configure the HTTP proxy.
https_proxy = http://your-proxy-server:port # Configure the HTTPS proxy.
```
For details about **hpm-cli** commands, see [HPM Commands](bundle-management.md#table10510164515371).
## Python Environment<a name="section1621819180417"></a>
Run the following commands to install Python later than 3.7:
```
sudo apt-get install python3.8
sudo apt-get install python3-pip
sudo pip3 install setuptools
sudo pip3 install kconfiglib # Install kconfiglib 13.2.0 or later.
```
>![](public_sys-resources/icon-note.gif) **NOTE:**
>The preceding method is applicable to Hi3518 and Hi3516 platforms. For Hi3861, run the following commands to install the Python environment:
>```
>sudo apt-get install python3.8
>sudo apt-get install python3-pip
>sudo pip3 install setuptools
>sudo pip3 install kconfiglib # Install kconfiglib 13.2.0 or later.
>sudo pip3 install pycryptodome
>sudo pip3 install six --upgrade --ignore-installed six
>sudo pip3 install ecdsa
>```
If both Python2 and Python3 have been installed in the current system, run the following commands to set the default Python to Python3:
```
ll `which python`
rm /usr/bin/python
ln -s python3.8 /usr/bin/python
```
## File Packaging Tool<a name="section77617165913"></a>
Run the following commands to install the tool:
```
which mkfs.vfat # If mkfs.vfat is not found, run the following command:
sudo apt-get install dosfstools
which mcopy # If mcopy is not found, run the following command:
sudo apt-get install mtools
```
>![](public_sys-resources/icon-note.gif) **NOTE:**
>Both Hi3518 and Hi3516 platforms require the file packaging tool. For Hi3861, the tool is not required.
## SCons<a name="section20558439191516"></a>
Run the following command to install SCons:
```
sudo apt-get install scons # SCons 3.0.4 or later is recommended.
```
>![](public_sys-resources/icon-note.gif) **NOTE:**
>SCons is required for the Hi3861 platform, but not for the Hi3518 or Hi3516 platform.
docs-en/bundles/preparations.md
浏览文件 @ 37cc208b
...@@ -23,9 +23,7 @@ ...@@ -23,9 +23,7 @@
You are advised to install [Node.js](https://nodejs.org/) 12.x \(including npm 6.14.4\) or a later version \(12.13.0 or later is recommended\). You are advised to install [Node.js](https://nodejs.org/) 12.x \(including npm 6.14.4\) or a later version \(12.13.0 or later is recommended\).
2. Install the **hpm-cli** tool using **npm** delivered with **Node.js**. 2. Install the **hpm-cli** tool using **npm** delivered with **Node.js**. Run the following command:
Start **cmd.exe** to run the following command:
``` ```
npm install -g @ohos/hpm-cli npm install -g @ohos/hpm-cli
......
docs-en/get-code/tool-acquisition.md
浏览文件 @ 37cc208b
# Tool Acquisition<a name="EN-US_TOPIC_0000001055701144"></a> # Tool Acquisition<a name="EN-US_TOPIC_0000001055701144"></a>
- [Acquiring Compilation Toolchain](#section18750162432511) - [Using Docker to Prepare the Build Environment](#section107932281315)
- [HPM-based Docker](#section054931895313)
- [Standalone Docker Environment](#section980782720014)
- [Using a Software Package to Prepare the Build Environment](#section18750162432511)
- [Acquiring the Device Development Tool \(HUAWEI DevEco Device Tool\)](#section12307171315108) - [Acquiring the Device Development Tool \(HUAWEI DevEco Device Tool\)](#section12307171315108)
- [Tool Introduction](#section68281728193514) - [Tool Introduction](#section68281728193514)
- [Website](#section13785205443514) - [Website](#section13785205443514)
...@@ -10,11 +14,178 @@ ...@@ -10,11 +14,178 @@
- [Website](#section1572093543613) - [Website](#section1572093543613)
- [Usage Guidelines](#section1125615298385) - [Usage Guidelines](#section1125615298385)
## Acquiring Compilation Toolchain<a name="section18750162432511"></a> ## Using Docker to Prepare the Build Environment<a name="section107932281315"></a>
OpenHarmony provides the following two types of Docker environments for you to quickly get the development environment ready:
- HPM-based Docker environment: applicable when using the HarmonyOS Package Manager \(HPM\) to build a distribution.
- Standalone Docker environment: applicable when using Ubuntu or Windows to build a distribution.
The following table lists container-based options needed for building in the standalone Docker environment.
**Table 1** Docker image
<a name="table2790164495315"></a>
<table><thead align="left"><tr id="row3790644155317"><th class="cellrowborder" valign="top" width="17.97%" id="mcps1.2.5.1.1"><p id="p127896443535"><a name="p127896443535"></a><a name="p127896443535"></a>Compatible Hardware Platform</p>
</th>
<th class="cellrowborder" valign="top" width="29.110000000000003%" id="mcps1.2.5.1.2"><p id="p8789114445316"><a name="p8789114445316"></a><a name="p8789114445316"></a>Docker Image Repository</p>
</th>
<th class="cellrowborder" valign="top" width="8.43%" id="mcps1.2.5.1.3"><p id="p17896448533"><a name="p17896448533"></a><a name="p17896448533"></a>Tag</p>
</th>
<th class="cellrowborder" valign="top" width="44.49%" id="mcps1.2.5.1.4"><p id="p1278917444539"><a name="p1278917444539"></a><a name="p1278917444539"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row167901244115315"><td class="cellrowborder" valign="top" width="17.97%" headers="mcps1.2.5.1.1 "><p id="p6790144155314"><a name="p6790144155314"></a><a name="p6790144155314"></a>Hi3861/Hi3516/Hi3518</p>
</td>
<td class="cellrowborder" valign="top" width="29.110000000000003%" headers="mcps1.2.5.1.2 "><p id="p87901744185316"><a name="p87901744185316"></a><a name="p87901744185316"></a>swr.cn-south-1.myhuaweicloud.com/openharmony-docker/openharmony-docker</p>
</td>
<td class="cellrowborder" valign="top" width="8.43%" headers="mcps1.2.5.1.3 "><p id="p15790184410536"><a name="p15790184410536"></a><a name="p15790184410536"></a>0.0.2</p>
</td>
<td class="cellrowborder" valign="top" width="44.49%" headers="mcps1.2.5.1.4 "><p id="p15790124416531"><a name="p15790124416531"></a><a name="p15790124416531"></a>The build environment for the <span id="text895113715412"><a name="text895113715412"></a><a name="text895113715412"></a>OpenHarmony</span> version has been pre-installed.</p>
</td>
</tr>
</tbody>
</table>
### HPM-based Docker<a name="section054931895313"></a>
**docker\_dist** is a template component in the [HPM](https://hpm.harmonyos.com/#/en/home) system. It helps to quickly initialize an HPM project and use the Docker image to quickly build a distribution of OpenHarmony, greatly simplifying environment configurations needed for building. After configuring the Ubuntu and [hpm-cli](https://device.harmonyos.com/en/docs/develop/bundles/oem_bundle_guide_prepare-0000001050129846) development environments, perform the following steps to access the Docker environment:
**Setting Up the Docker Environment**
1. Initialize the installation template by running the following command in any of the working directories:
```
hpm init -t @ohos/docker_dist
```
2. Modify the **publishAs** field.
Open the **bundle.json** file in the current directory and change the value of **publishAs** from **template** to **distribution** as needed.
3. Select the desired solution, and set the environment variables for the solution distribution.
ip\_camera\_hi3516dv300:
```
export solution=@ohos/ip_camera_hi3516dv300
```
ip\_camera\_hi3518ev300:
```
export solution=@ohos/ip_camera_hi3518ev300
```
wifiiot:
```
export solution=@ohos/wifi_iot
```
>![](public_sys-resources/icon-note.gif) **NOTE:**
>If you use the Windows command line, run the following command instead:
>```
>set solution=Distribution name
>```
**Building**
Start building. The following takes ip\_camera\_hi3518ev300 as an example.
Running the following command will automatically install the Docker, pull the image, and start the pulling and building of the corresponding solution in the container.
```
hpm run docker
```
The following will be displayed if the building is successful:
```
......
ohos ipcamera_hi3518 build success!
@ohos/ip_camera_hi3518ev300: distribution building completed.
```
>![](public_sys-resources/icon-note.gif) **NOTE:**
>Docker can be automatically installed only on Ubuntu. If you are using any other operating system, manually install Docker before pulling the image. The operations are as follows:
>```
># Pull the image.
>docker pull swr.cn-south-1.myhuaweicloud.com/openharmony-docker/openharmony-docker:0.0.2
># Build the distribution on Linux.
>hpm run distWithDocker
># When using Windows, make sure to configure the Git Bash.
>hpm config set shellPath "Git Bash path"
>hpm run distWithDocker
>```
### Standalone Docker Environment<a name="section980782720014"></a>
The Docker image of OpenHarmony is hosted on [HUAWEI Cloud SWR](https://auth.huaweicloud.com/authui/login.html?service=https%3A%2F%2Fconsole.huaweicloud.com%2Fswr%2F%3Fregion%3Dcn-south-1%26cloud_route_state%3D%2Fapp%2Fwarehouse%2FwarehouseMangeDetail%2Fgoldensir%2Fopenharmony-docker%2Fopenharmony-docker%3Ftype%3DownImage&locale=en-us#/login). Using the Docker image will help simplify environment configurations needed for the building. After configuring the development environments, perform the steps below to access the Docker environment. The following steps use Ubuntu as an example \(Windows is also supported\).
**Method 1: Obtaining the Docker image from HuaweiCloud SWR**
1. Obtain the Docker image.
```
docker pull swr.cn-south-1.myhuaweicloud.com/openharmony-docker/openharmony-docker:0.0.2
```
2. Go to the root directory of OpenHarmony code and run the following command to access the Docker build environment:
```
docker run -it -v $(pwd):/home/openharmony swr.cn-south-1.myhuaweicloud.com/openharmony-docker/openharmony-docker:0.0.2
```
3. Use the following build script to start the building for the wifiiot, ipcamera\_hi3516dv300, and ipcamera\_hi3518ev300 platforms.
```
python build.py wifiiot/ipcamera_hi3516dv300/ipcamera_hi3518ev300
```
```
```
**Method 2: Using the Dockerfile to Build a Local Docker Image**
1. Obtain the Dockerfile script for a local Docker image.
```
git clone https://gitee.com/openharmony/docs.git
```
2. Go to the directory of the Dockerfile code and run the following command to build the Docker image:
```
cd docs/docker
./build.sh
```
3. Go to the root directory of OpenHarmony code and run the following command to access the Docker build environment:
```
docker run -it -v $(pwd):/home/openharmony openharmony-docker:0.0.2
```
4. Use the following build script to start the building for the wifiiot, ipcamera\_hi3516dv300, and ipcamera\_hi3518ev300 platforms.
```
python build.py wifiiot/ipcamera_hi3516dv300/ipcamera_hi3518ev300
```
## Using a Software Package to Prepare the Build Environment<a name="section18750162432511"></a>
If you do not use Docker, use a software package instead to install the compilation environment. Specially, download some compilation toolchains from the image sites listed in the following table.
The following table lists the compilation toolchain downloaded from an image site. For details about how to download and install all compilation tools, see [Setting Up a Hi3861 Development Environment](../quick-start/setting-up-a-development-environment.md), [Setting Up a Hi3516 Development Environment](../quick-start/setting-up-a-hi3516-board-environment.md), or [Setting Up a Hi3518 Development Environment](../quick-start/setting-up-a-development-environment-1.md) in _Quick Start_. For details about how to download and install all compilation tools, see [Setting Up the Hi3861 Development Environment](../quick-start/setting-up-the-hi3861-development-environment.md), [Setting Up the Hi3516 Development Environment](../quick-start/setting-up-the-hi3516-development-environment.md), or [Setting Up the Hi3518 Development Environment](../quick-start/setting-up-the-hi3518-development-environment.md) in _Quick Start_.
**Table 1** Acquiring compilation toolchain **Table 2** Acquiring compilation toolchain
<a name="table167961324122511"></a> <a name="table167961324122511"></a>
<table><thead align="left"><tr id="row87941124202517"><th class="cellrowborder" valign="top" width="16.35%" id="mcps1.2.6.1.1"><p id="p12231193484318"><a name="p12231193484318"></a><a name="p12231193484318"></a>Development Board</p> <table><thead align="left"><tr id="row87941124202517"><th class="cellrowborder" valign="top" width="16.35%" id="mcps1.2.6.1.1"><p id="p12231193484318"><a name="p12231193484318"></a><a name="p12231193484318"></a>Development Board</p>
...@@ -99,7 +270,7 @@ You need to check whether these tools are downloaded from the official channel. ...@@ -99,7 +270,7 @@ You need to check whether these tools are downloaded from the official channel.
2. Compare the generated digest with the officially provided one. 2. Compare the generated digest with the officially provided one.
If they are consistent, the **sha256sum** package you downloaded has not been tampered with. Otherwise, your package may be insecure. If they are consistent, the tool package you downloaded has not been tampered with. Otherwise, your package may be insecure.
## Acquiring the Device Development Tool \(HUAWEI DevEco Device Tool\)<a name="section12307171315108"></a> ## Acquiring the Device Development Tool \(HUAWEI DevEco Device Tool\)<a name="section12307171315108"></a>
......
docs-en/guide/use-case-5.md
浏览文件 @ 37cc208b
...@@ -11,7 +11,12 @@ This use case takes **camera\_sample** \(contained in the source code\) as an ...@@ -11,7 +11,12 @@ This use case takes **camera\_sample** \(contained in the source code\) as an
- The compilation result of the sample code is stored in **out/ipcamera\_hi3516dv300/dev\_tools/bin/camera\_sample**. To ensure that the code can be executed on the development board, you can copy the file to a TF card through a card reader, or modify the compilation script of **camera\_sample** to copy the compilation result to **rootfs.img**. - The compilation result of the sample code is stored in **out/ipcamera\_hi3516dv300/dev\_tools/bin/camera\_sample**. To ensure that the code can be executed on the development board, you can copy the file to a TF card through a card reader, or modify the compilation script of **camera\_sample** to copy the compilation result to **rootfs.img**.
How to Modify: In source code path **applications/sample/camera/media/BUILD.gn**, replace the first **output\_dir = "$root\_out\_dir/dev\_ools"** with **output\_dir = "$root\_out\_dir/"**, recompile the source code repository, and burn the code into the development board. Then you can find the **camera\_sample** file in the **bin** directory of the development board. Modify the first **output\_dir** in the source code path **applications/sample/camera/media/BUILD.gn**.
- Before: **output\_dir = "$root\_out\_dir/dev\_tools"**
- After: **output\_dir = "$root\_out\_dir/"**
Recompile the source code repository and burn the code into the development board. Then you can find the **camera\_sample** file in the **bin** directory of the board.
>![](public_sys-resources/icon-notice.gif) **NOTICE:** >![](public_sys-resources/icon-notice.gif) **NOTICE:**
>You should insert a TF card \(up to 128 GB supported\) for photographing and video recording before system startup. This way, the TF card will be automatically mounted to the **/sdcard** directory. If you insert the TF card after the system is started, you have to manually mount the TF card. >You should insert a TF card \(up to 128 GB supported\) for photographing and video recording before system startup. This way, the TF card will be automatically mounted to the **/sdcard** directory. If you insert the TF card after the system is started, you have to manually mount the TF card.
......
docs-en/guide/use-case.md
浏览文件 @ 37cc208b
# Use Case<a name="EN-US_TOPIC_0000001055686082"></a> # Use Case<a name="EN-US_TOPIC_0000001055686082"></a>
- For details bout the development board, compilation, burning, and image running process, see [Getting Started with Hi3518](../quick-start/introduction-to-the-hi3518-development-board.md). A compilation result file of sample code is stored in **out/ipcamera\_hi3518ev300/dev\_tools/bin/camera\_sample**. You can copy the file to a TF card, or modify the compilation script of **camera\_sample** to copy the result to **rootfs.img**. - For details about the development board, compilation, burning, and image running process, see [Getting Started with Hi3518](../quick-start/introduction-to-the-hi3518-development-board.md). A compilation result file of sample code is stored in **out/ipcamera\_hi3518ev300/dev\_tools/bin/camera\_sample**. You can copy the file to a TF card, or modify the compilation script of **camera\_sample** to copy the result to **rootfs.img**.
**How to Modify**: In **applications/sample/camera/media/BUILD.gn**, replace **output\_dir = "$root\_out\_dir/dev\_tools"** with **output\_dir = "$root\_out\_dir/"**, recompile the source code repository, and burn the code into the development board. Then you can find the **camera\_sample** file in the **bin** directory of the board. Modify **output\_dir** in **applications/sample/camera/media/BUILD.gn**.
- Before: **output\_dir = "$root\_out\_dir/dev\_tools"**
- After: **output\_dir = "$root\_out\_dir/"**
Recompile the source code repository and burn the code into the development board. Then you can find the **camera\_sample** file in the **bin** directory of the board.
- The sample code for camera development is stored in **applications/sample/camera/media/camera\_sample.cpp**. - The sample code for camera development is stored in **applications/sample/camera/media/camera\_sample.cpp**.
......
docs-en/porting/Readme-EN.md 0 → 100644
浏览文件 @ 37cc208b
# Third-Party Library Porting Guide
- [Third-Party Library Porting Guide](third-party-library-porting-guide.md)
- [Overview](overview.md)
- [Porting a Library Built Using CMake](porting-a-library-built-using-cmake.md)
- [Porting a Library Built Using Makefile](porting-a-library-built-using-makefile.md)
docs-en/porting/overview.md 0 → 100644
浏览文件 @ 37cc208b
# Overview<a name="EN-US_TOPIC_0000001064570046"></a>
This document provides guidance for OpenHarmony developers to port third-party libraries that use common compiler organization modes, such as CMakeLists and Makefile. It describes how to set a toolchain in different compiler organization modes and how to add the compiling configuration of a library to the OpenHarmony project. Currently, this guide applies only to Hi3516DV300 and Hi3518EV300.
docs-en/porting/porting-a-library-built-using-cmake.md 0 → 100644
浏览文件 @ 37cc208b
# Porting a Library Built Using CMake<a name="EN-US_TOPIC_0000001063033549"></a>
- [Source Code Acquisition](#section1771132116245)
- [Porting Guidelines](#section9737174410328)
- [Cross-Compilation](#section38205577332)
- [Compilation Reference](#section1088111263418)
- [Cross-Compilation Settings](#section8168182883515)
- [Library Test](#section6686144293611)
- [Adding the Compiled double-conversion Library to the Project](#section1651053153715)
The following shows how to port the double-conversion library.
## Source Code Acquisition<a name="section1771132116245"></a>
Acquire the source code of double-conversion from [https://github.com/google/double-conversion](https://github.com/google/double-conversion). The following table lists the directory structure.
**Table 1** Directory structure of the source code
<a name="table824211132418"></a>
<table><thead align="left"><tr id="row524220131043"><th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.1"><p id="p22421213442"><a name="p22421213442"></a><a name="p22421213442"></a>Directory</p>
</th>
<th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.2"><p id="p132427131241"><a name="p132427131241"></a><a name="p132427131241"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1335114463010"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p3354144414307"><a name="p3354144414307"></a><a name="p3354144414307"></a>double-conversion/cmake/</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p1235564417307"><a name="p1235564417307"></a><a name="p1235564417307"></a>Template used for building with CMake</p>
</td>
</tr>
<tr id="row1024211133411"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p12423137414"><a name="p12423137414"></a><a name="p12423137414"></a>double-conversion/double-conversion/</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p824221314420"><a name="p824221314420"></a><a name="p824221314420"></a>Directory of source files</p>
</td>
</tr>
<tr id="row1242813545"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p424213131343"><a name="p424213131343"></a><a name="p424213131343"></a>double-conversion/msvc/</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p172429139418"><a name="p172429139418"></a><a name="p172429139418"></a>-</p>
</td>
</tr>
<tr id="row20242513641"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p2024210139412"><a name="p2024210139412"></a><a name="p2024210139412"></a>double-conversion/test/</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p7242713241"><a name="p7242713241"></a><a name="p7242713241"></a>Source files of the test cases</p>
</td>
</tr>
<tr id="row12242191314413"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p172420131646"><a name="p172420131646"></a><a name="p172420131646"></a>double-conversion/.gitignore</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p112426131843"><a name="p112426131843"></a><a name="p112426131843"></a>-</p>
</td>
</tr>
<tr id="row1484211616360"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p1384206143617"><a name="p1384206143617"></a><a name="p1384206143617"></a>double-conversion/AUTHORS</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p384310614366"><a name="p384310614366"></a><a name="p384310614366"></a>-</p>
</td>
</tr>
<tr id="row1290331063610"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p18903410183613"><a name="p18903410183613"></a><a name="p18903410183613"></a>double-conversion/BUILD</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p1990491033617"><a name="p1990491033617"></a><a name="p1990491033617"></a>-</p>
</td>
</tr>
<tr id="row5967101420368"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p696710141361"><a name="p696710141361"></a><a name="p696710141361"></a>double-conversion/CMakeLists.txt</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p1196714147366"><a name="p1196714147366"></a><a name="p1196714147366"></a>Top-level file used for building with CMake</p>
</td>
</tr>
<tr id="row19372034133612"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p1596214484473"><a name="p1596214484473"></a><a name="p1596214484473"></a>double-conversion/COPYING</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p163811348364"><a name="p163811348364"></a><a name="p163811348364"></a>-</p>
</td>
</tr>
<tr id="row0184133717364"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p1166255034715"><a name="p1166255034715"></a><a name="p1166255034715"></a>double-conversion/Changelog</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p151851337193617"><a name="p151851337193617"></a><a name="p151851337193617"></a>-</p>
</td>
</tr>
<tr id="row173871412369"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p411055217475"><a name="p411055217475"></a><a name="p411055217475"></a>double-conversion/LICENSE</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p9387641173617"><a name="p9387641173617"></a><a name="p9387641173617"></a>-</p>
</td>
</tr>
<tr id="row534170185015"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p035703507"><a name="p035703507"></a><a name="p035703507"></a>double-conversion/Makefile</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p6367075019"><a name="p6367075019"></a><a name="p6367075019"></a>-</p>
</td>
</tr>
<tr id="row1367804175011"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p1246133725014"><a name="p1246133725014"></a><a name="p1246133725014"></a>double-conversion/README.md</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p136796410508"><a name="p136796410508"></a><a name="p136796410508"></a>-</p>
</td>
</tr>
<tr id="row2070619141508"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p1963193815509"><a name="p1963193815509"></a><a name="p1963193815509"></a>double-conversion/SConstruct</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p570691485015"><a name="p570691485015"></a><a name="p570691485015"></a>-</p>
</td>
</tr>
<tr id="row186521925020"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p152191040155012"><a name="p152191040155012"></a><a name="p152191040155012"></a>double-conversion/WORKSPACE</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p4661119175014"><a name="p4661119175014"></a><a name="p4661119175014"></a>-</p>
</td>
</tr>
</tbody>
</table>
## Porting Guidelines<a name="section9737174410328"></a>
Cross-compile the double-conversion library by modifying the toolchain to generate executable files for the OpenHarmony platform and then add these files to the OpenHarmony project by invoking CMake via GN.
## Cross-Compilation<a name="section38205577332"></a>
### Compilation Reference<a name="section1088111263418"></a>
The **README.md** file in the code repository details the procedures for compiling the double-conversion library using CMake as well as the testing methods. This document focuses on the building, compilation, and testing of the library. If you have any questions during library porting, refer to the [README.md](https://github.com/google/double-conversion/blob/master/README.md) file. For porting of other third-party libraries that can be independently built with CMake, you can refer to the compilation guides provided by the libraries.
### Cross-Compilation Settings<a name="section8168182883515"></a>
The following steps show how to configure and modify the toolchains for cross-compiling the libraries built using CMake to compile executable files for the OpenHarmony platform.
1. Configure the toolchains.
Add configuration of the clang toolchains to the top-level file **CMakeLists.txt** listed in [Table 1](#table824211132418).
```
set(CMAKE_CROSSCOMPILING TRUE)
set(CMAKE_SYSTEM_NAME Generic)
set(CMAKE_CXX_COMPILER_ID Clang)
set(CMAKE_TOOLCHAIN_PREFIX llvm-)
# Specify the C compiler (ensure that the path of the toolchain has been added to the PATH environment variable) and its flags. To perform cross-compilation using clang, the --target flag must be specified.
set(CMAKE_C_COMPILER clang)
set(CMAKE_C_FLAGS "--target=arm-liteos -D__clang__ -march=armv7-a -w")
# Specify the C++ compiler (ensure that the path of the toolchain has been added to the PATH environment variable) and its flags. To perform cross-compilation, the --target flag must be specified.
set(CMAKE_CXX_COMPILER clang++)
set(CMAKE_CXX_FLAGS "--target=arm-liteos -D__clang__ -march=armv7-a -w")
# Specify the linker and its flags. --target and --sysroot must be specified. You can specify OHOS_ROOT_PATH via the suffix parameter of the cmake command.
set(MY_LINK_FLAGS "--target=arm-liteos --sysroot=${OHOS_SYSROOT_PATH}")
set(CMAKE_LINKER clang)
set(CMAKE_CXX_LINKER clang++)
set(CMAKE_C_LINKER clang)
set(CMAKE_C_LINK_EXECUTABLE "${CMAKE_C_LINKER} ${MY_LINK_FLAGS} <FLAGS> <LINK_FLAGS> <OBJECTS> -o <TARGET> <LINK_LIBRARIES>")
set(CMAKE_CXX_LINK_EXECUTABLE "${CMAKE_CXX_LINKER} ${MY_LINK_FLAGS} <FLAGS> <LINK_FLAGS> <OBJECTS> -o <TARGET> <LINK_LIBRARIES>")
# Specify the path for searching chained libraries.
set(CMAKE_SYSROOT ${OHOS_SYSROOT_PATH})
```
2. Perform the compilation.
Run a Linux command to enter the directory \(listed in [Table 1](#table824211132418)\) for storing double-conversion source files and then run the following commands:
```
mkdir build && cd build
cmake .. -DBUILD_TESTING=ON -DOHOS_SYSROOT_PATH="..."
make -j
```
**OHOS\_SYSROOT\_PATH** specifies the absolute path where **sysroot** is located. Taking OpenHarmony for example, set **OHOS\_SYSROOT\_PATH** to the absolute path of **openHarmony/prebuilts/lite/sysroot**.
3. <a name="li15717101715249"></a>View the result.
After step 2 is complete, a static library file and test cases are generated in the **build** directory.
**Table 2** Directory structure of compiled files
<a name="table1452412391911"></a>
<table><thead align="left"><tr id="row15259397114"><th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.1"><p id="p084365219116"><a name="p084365219116"></a><a name="p084365219116"></a>Directory</p>
</th>
<th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.2"><p id="p118435524118"><a name="p118435524118"></a><a name="p118435524118"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row17861750780"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p208014918411"><a name="p208014918411"></a><a name="p208014918411"></a>double-conversion/build/libdouble-conversion.a</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p155272391619"><a name="p155272391619"></a><a name="p155272391619"></a>Static library file</p>
</td>
</tr>
<tr id="row141820612910"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p1941811618918"><a name="p1941811618918"></a><a name="p1941811618918"></a>double-conversion/build/test/</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p64181761995"><a name="p64181761995"></a><a name="p64181761995"></a>Test cases and CMake cache files</p>
</td>
</tr>
<tr id="row19525239815"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p452512394117"><a name="p452512394117"></a><a name="p452512394117"></a>double-conversion/build/CMakeCache.txt</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p652615391617"><a name="p652615391617"></a><a name="p652615391617"></a>Cache files during CMake building</p>
</td>
</tr>
<tr id="row1526839312"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p28017499413"><a name="p28017499413"></a><a name="p28017499413"></a>double-conversion/build/CMakeFiles/</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p25261439314"><a name="p25261439314"></a><a name="p25261439314"></a>-</p>
</td>
</tr>
<tr id="row15269396111"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p138014494415"><a name="p138014494415"></a><a name="p138014494415"></a>double-conversion/build/cmake_install.cmake</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p75268391519"><a name="p75268391519"></a><a name="p75268391519"></a>-</p>
</td>
</tr>
<tr id="row185265399113"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p78054914419"><a name="p78054914419"></a><a name="p78054914419"></a>double-conversion/build/CTestTestfile.cmake</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p65261039218"><a name="p65261039218"></a><a name="p65261039218"></a>-</p>
</td>
</tr>
<tr id="row125261139115"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p158064916419"><a name="p158064916419"></a><a name="p158064916419"></a>double-conversion/build/DartConfiguration.tcl</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p20526939118"><a name="p20526939118"></a><a name="p20526939118"></a>-</p>
</td>
</tr>
<tr id="row2526839712"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p6803491043"><a name="p6803491043"></a><a name="p6803491043"></a>double-conversion/build/generated/</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p115269395113"><a name="p115269395113"></a><a name="p115269395113"></a>-</p>
</td>
</tr>
<tr id="row173131653454"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p7803493412"><a name="p7803493412"></a><a name="p7803493412"></a>double-conversion/build/Makefile</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p19316135318512"><a name="p19316135318512"></a><a name="p19316135318512"></a>-</p>
</td>
</tr>
<tr id="row4380879618"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p10381478619"><a name="p10381478619"></a><a name="p10381478619"></a>double-conversion/build/Testing/</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p17381679610"><a name="p17381679610"></a><a name="p17381679610"></a>-</p>
</td>
</tr>
</tbody>
</table>
## Library Test<a name="section6686144293611"></a>
1. Set up the OpenHarmony environment.
Using Hi3518EV300 as an example, compile the OpenHarmony image and burn it to the development board. For details, see [Developing the First Example Program Running on Hi3518](https://gitee.com/openharmony/docs/blob/master/docs-en/quick-start/developing-the-first-example-program-running-on-hi3518.md).
The following screen is displayed after a successful login to the OS.
**Figure 1** Successful startup of OpenHarmony<a name="fig13279524162418"></a>
![](figures/successful-startup-of-openharmony.png "successful-startup-of-openharmony")
2. Mount the **nfs** directory and put the executable file **cctest** into the **test** directory \(listed in [Table 2](#table1452412391911)\) to the **nfs** directory.
3. Perform the test cases.
If the double-conversion library is not cross-compiled, you can execute the test cases by running the **make test** command and obtain the result via CMake. However, this command is not applicable to the library after cross-compilation. This way, you can perform the test cases by executing the generated test case files.
- After the **nfs** directory is successfully mounted, run the following command to list all items in the test cases:
```
cd nfs
./cctest --list
```
Some items are as follows:
```
test-bignum/Assign<
test-bignum/ShiftLeft<
test-bignum/AddUInt64<
test-bignum/AddBignum<
test-bignum/SubtractBignum<
test-bignum/MultiplyUInt32<
test-bignum/MultiplyUInt64<
test-bignum/MultiplyPowerOfTen<
test-bignum/DivideModuloIntBignum<
test-bignum/Compare<
test-bignum/PlusCompare<
test-bignum/Square<
test-bignum/AssignPowerUInt16<
test-bignum-dtoa/BignumDtoaVariousDoubles<
test-bignum-dtoa/BignumDtoaShortestVariousFloats<
test-bignum-dtoa/BignumDtoaGayShortest<
test-bignum-dtoa/BignumDtoaGayShortestSingle<
test-bignum-dtoa/BignumDtoaGayFixed<
test-bignum-dtoa/BignumDtoaGayPrecision<
test-conversions/DoubleToShortest<
test-conversions/DoubleToShortestSingle<
...
```
- Run the following command to test **test-bignum**:
```
./cctest test-bignum
```
The test is passed if the following information is displayed:
```
Ran 13 tests.
```
## Adding the Compiled double-conversion Library to the OpenHarmony Project<a name="section1651053153715"></a>
1. Copy the double-conversion library to the OpenHarmony project.
Copy this library that can be cross-compiled to the **third\_party** directory of OpenHarmony. To avoid modifying the **BUILD.gn** file in the directory of the third-party library to be ported, add a directory to store adaptation files, including **BUILD.gn**, **build\_thirdparty.py**, and **config.gni**, for converting GN to CMake building.
**Table 3** Directory structure of the ported library
<a name="table13265185817173"></a>
<table><thead align="left"><tr id="row92666583171"><th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.1"><p id="p2266105816178"><a name="p2266105816178"></a><a name="p2266105816178"></a>Directory</p>
</th>
<th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.2"><p id="p32661158161718"><a name="p32661158161718"></a><a name="p32661158161718"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1526655816175"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p226605811710"><a name="p226605811710"></a><a name="p226605811710"></a>openHarmony/third_party/double-conversion/BUILD.gn</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p1626675812177"><a name="p1626675812177"></a><a name="p1626675812177"></a>GN file for adding the third-party library to the <span id="text2025921715555"><a name="text2025921715555"></a><a name="text2025921715555"></a>OpenHarmony</span> project</p>
</td>
</tr>
<tr id="row1726610589179"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p12266115815170"><a name="p12266115815170"></a><a name="p12266115815170"></a>openHarmony/third_party/double-conversion/build_thirdpaty.py</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p122661958201719"><a name="p122661958201719"></a><a name="p122661958201719"></a>Script file for GN to call the <strong id="b45891919155715"><a name="b45891919155715"></a><a name="b45891919155715"></a>shell</strong> command to convert compilation from GN to CMake.</p>
</td>
</tr>
<tr id="row7266195891714"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p162665581170"><a name="p162665581170"></a><a name="p162665581170"></a>openHarmony/third_party/double-conversion/config.gni</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p626712588175"><a name="p626712588175"></a><a name="p626712588175"></a>Third-party library compilation configuration file, which can be modified to determine whether the test cases will be used during the building</p>
</td>
</tr>
<tr id="row1272420109203"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p17725101052012"><a name="p17725101052012"></a><a name="p17725101052012"></a>openHarmony/third_party/double-conversion/double-conversion/</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p87252109205"><a name="p87252109205"></a><a name="p87252109205"></a>Directory of the third-party library to be ported</p>
</td>
</tr>
</tbody>
</table>
2. Add the GN file to the CMake adaptation file.
- The following shows the implementation for building using the newly added **BUILD.gn** file. For other third-party libraries that can be independently compiled using CMake, you only need to change the target paths when porting them to OpenHarmony.
```
import("config.gni")
group("double-conversion") {
if (ohos_build_thirdparty_migrated_from_fuchisa == true) {
deps = [":make"]
}
}
if (ohos_build_thirdparty_migrated_from_fuchisa == true) {
action("make") {
script = "//third_party/double-conversion/build_thirdparty.py"
outputs = ["$root_out_dir/log_dc.txt"]
exec_path = rebase_path(rebase_path("./double-conversion/build", root_build_dir))
command = "rm * .* -rf && $CMAKE_TOOLS_PATH/cmake .. $CMAKE_FLAG $CMAKE_TOOLCHAIN_FLAG && make -j"
args = [
"--path=$exec_path",
"--command=${command}"
]
}
}
```
- The newly added **config.gni** file is used to configure the library in the following example implementation. For other third-party libraries that can be independently compiled using CMake, you only need to change the configuration of **CMAKE\_FLAG** when porting them to OpenHarmony.
```
#CMAKE_FLAG: config compile feature
CMAKE_FLAG = "-DBUILD_TESTING=ON -DCMAKE_CXX_STANDARD=11"
#toolchain: follow up-layer, depend on $ohos_build_compiler
if (ohos_build_compiler == "clang") {
CMAKE_TOOLCHAIN_FLAG = "-DOHOS_SYSROOT_PATH=${ohos_root_path}prebuilts/lite/sysroot/"
} else {
CMAKE_TOOLCHAIN_FLAG = ""
}
#CMake tools path,no need setting if this path already joined to $PATH.
CMAKE_TOOLS_PATH = "setting CMake tools path..."
```
- The following shows the implementation of the newly added **build\_thirdparty.py** file. For other third-party libraries that can be independently compiled using CMake, you can port them to OpenHarmony without modifications.
```
import os
import sys
from subprocess import Popen
import argparse
import shlex
def cmd_exec(command):
cmd = shlex.split(command)
proc = Popen(cmd)
proc.wait()
ret_code = proc.returncode
if ret_code != 0:
raise Exception("{} failed, return code is {}".format(cmd, ret_code))
def main():
parser = argparse.ArgumentParser()
parser.add_argument('--path', help='Build path.')
parser.add_argument('--command', help='Build command.')
parser.add_argument('--enable', help='enable python.', nargs='*')
args = parser.parse_args()
if args.enable:
if args.enable[0] == 'false':
return
if args.path:
curr_dir = os.getcwd()
os.chdir(args.path)
if args.command:
if '&&' in args.command:
command = args.command.split('&&')
for data in command:
cmd_exec(data)
else:
cmd_exec(args.command)
os.chdir(curr_dir)
if __name__ == '__main__':
sys.exit(main())
```
- Add a configuration item in the configuration file to control compiling of the library. By default, library compilation is disabled.
For example, add the following configuration to the **//build/lite/ohos\_var.gni** file:
```
declare_args() {
ohos_build_thirdparty_migrated_from_fuchisa = false
}
```
3. Add the library to the compiling configuration.
Add the directory where the library is located to the project compiling configuration. Taking Hi3518EV300 for example, modify the **openHarmony\\build\\lite\\product\\ ipcamera\_hi3518ev300.json** file and add the following configuration to **subsystem**, as shown in [Figure 2](#fig152112412192).
```
{
"name": "double-conversion",
"component": [
{ "name": "double-conversion", "dir": "//third_party/double-conversion:double-conversion", "features":[] }
]
},
```
**Figure 2** Position for adding the configuration<a name="fig152112412192"></a>
![](figures/position-for-adding-the-configuration.png "position-for-adding-the-configuration")
4. Build the library.
- Manual building
Execute the following command:
```
python build.py ipcamera_hi3518ev300 -T //third_party/double-conversion:double-conversion
```
If the compilation is successful, a static library file and test cases will be generated in the [build](#li15717101715249) directory.
- Automatic building with the project
Modify the compiling configuration in the **//build/lite/ohos\_var.gni** file.
```
ohos_build_thirdparty_migrated_from_fuchisa = true
```
Execute the following command:
```
python build.py ipcamera_hi3518ev300 -b debug
```
If the compilation is successful, a static library file and test cases will be generated in the [build](#li15717101715249) directory.
docs-en/porting/porting-a-library-built-using-makefile.md 0 → 100644
浏览文件 @ 37cc208b
# Porting a Library Built Using Makefile<a name="EN-US_TOPIC_0000001064218672"></a>
- [Source Code Acquisition](#section114115321416)
- [Cross-Compilation Settings](#section81263255384)
- [Library Test](#section1830015913391)
- [Adding the Compiled yxml Library to the Project](#section1898016213406)
The following shows how to port the yxml library.
## Source Code Acquisition<a name="section114115321416"></a>
Acquire the source code of yxml from [https://github.com/getdnsapi/yxml](https://github.com/getdnsapi/yxml). The following table lists the directory structure.
**Table 1** Directory structure of the source code
<a name="table16520154171813"></a>
<table><thead align="left"><tr id="row2052115419188"><th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.1"><p id="p1352111417181"><a name="p1352111417181"></a><a name="p1352111417181"></a>Directory</p>
</th>
<th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.2"><p id="p2521541171812"><a name="p2521541171812"></a><a name="p2521541171812"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row252164101814"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p747319438225"><a name="p747319438225"></a><a name="p747319438225"></a>yxml/bench/</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p1852214114183"><a name="p1852214114183"></a><a name="p1852214114183"></a>Benchmark-related code</p>
</td>
</tr>
<tr id="row11402205216237"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p6473134382216"><a name="p6473134382216"></a><a name="p6473134382216"></a>yxml/test/</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p2040355219237"><a name="p2040355219237"></a><a name="p2040355219237"></a>Input and output files as well as scripts of the test cases</p>
</td>
</tr>
<tr id="row35220418182"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p1547384313229"><a name="p1547384313229"></a><a name="p1547384313229"></a>yxml/Makefile</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p7522041131814"><a name="p7522041131814"></a><a name="p7522041131814"></a>File for organizing compilation</p>
</td>
</tr>
<tr id="row17522144114180"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p6473164392210"><a name="p6473164392210"></a><a name="p6473164392210"></a>yxml/.gitattributes</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p145221541151817"><a name="p145221541151817"></a><a name="p145221541151817"></a>-</p>
</td>
</tr>
<tr id="row7522941131811"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p12473144312217"><a name="p12473144312217"></a><a name="p12473144312217"></a>yxml/.gitignore</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p95231141121810"><a name="p95231141121810"></a><a name="p95231141121810"></a>-</p>
</td>
</tr>
<tr id="row13523841161812"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p72441217182819"><a name="p72441217182819"></a><a name="p72441217182819"></a>yxml/COPYING</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p1752319414186"><a name="p1752319414186"></a><a name="p1752319414186"></a>-</p>
</td>
</tr>
<tr id="row165231641111810"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p347304312226"><a name="p347304312226"></a><a name="p347304312226"></a>yxml/yxml.c</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p4523174113188"><a name="p4523174113188"></a><a name="p4523174113188"></a>-</p>
</td>
</tr>
<tr id="row1452344110184"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p18473643152213"><a name="p18473643152213"></a><a name="p18473643152213"></a>yxml/yxml.c.in</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p1252317413187"><a name="p1252317413187"></a><a name="p1252317413187"></a>-</p>
</td>
</tr>
<tr id="row12744431142214"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p274693119222"><a name="p274693119222"></a><a name="p274693119222"></a>yxml/yxml-gen.pl</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p274753111227"><a name="p274753111227"></a><a name="p274753111227"></a>-</p>
</td>
</tr>
<tr id="row7967123412215"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p1947314314225"><a name="p1947314314225"></a><a name="p1947314314225"></a>yxml/yxml.h</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p16967203462218"><a name="p16967203462218"></a><a name="p16967203462218"></a>-</p>
</td>
</tr>
<tr id="row3988153742217"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p109891737112216"><a name="p109891737112216"></a><a name="p109891737112216"></a>yxml/yxml.md</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p10989123732213"><a name="p10989123732213"></a><a name="p10989123732213"></a>-</p>
</td>
</tr>
<tr id="row184521641102214"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p847314433221"><a name="p847314433221"></a><a name="p847314433221"></a>yxml/yxml-states</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p4453154111224"><a name="p4453154111224"></a><a name="p4453154111224"></a>-</p>
</td>
</tr>
</tbody>
</table>
## Cross-Compilation Settings<a name="section81263255384"></a>
The following steps show how to configure and modify the toolchains for cross-compiling the libraries built using CMake to compile executable files for the OpenHarmony platform.
1. Configure the toolchains.
Replace the original configuration of MakeFile \(listed in [Table 1](#table16520154171813)\) in the root directory of the yxml library with the following clang toolchains configuration.
clang toolchains configuration:
```
# Set the cross-compilation toolchain and ensure that the path of the toolchain has been added to the PATH environment variable.
CC:=clang
AR:=llvm-ar
# The --target and --sysroot flags must be specified.
CFLAGS:=-Wall -Wextra -Wno-unused-parameter -O2 -g --target=arm-liteos -march=armv7-a --sysroot=$(OHOS_ROOT_PATH)prebuilts/lite/sysroot
```
Original configuration:
```
CC:=gcc
AR:=ar
CFLAGS:=-Wall -Wextra -Wno-unused-parameter -O2 -g
```
2. Perform the compilation.
Run a Linux command to enter the directory \(listed in [Table 1](#table16520154171813)\) for storing yxml source files and then run the following command:
```
make test OHOS_SYSROOT_PATH=...
```
**OHOS\_SYSROOT\_PATH** specifies the absolute path of the directory where **sysroot** is located. Taking OpenHarmony for example, set **OHOS\_SYSROOT\_PATH** to the absolute path of **prebuilts/lite/sysroot/**.
3. View the result.
After step 2 is complete, a static library file and test case are generated in the **out** directory of the yxml library.
**Table 2** Directory structure of compiled files
<a name="table3271115435618"></a>
<table><thead align="left"><tr id="row1273454185610"><th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.1"><p id="p3273154185616"><a name="p3273154185616"></a><a name="p3273154185616"></a>Directory</p>
</th>
<th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.2"><p id="p18273145445612"><a name="p18273145445612"></a><a name="p18273145445612"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1627317542567"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p13273154175620"><a name="p13273154175620"></a><a name="p13273154175620"></a>openHarmony/third_party/yxml/yxml/out/lib/</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p132744541562"><a name="p132744541562"></a><a name="p132744541562"></a>Static library file</p>
</td>
</tr>
<tr id="row112741554165612"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p17274165475611"><a name="p17274165475611"></a><a name="p17274165475611"></a>openHarmony/third_party/yxml/yxml/out/test/</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p152741354135614"><a name="p152741354135614"></a><a name="p152741354135614"></a>Test cases as well as the input and output files</p>
</td>
</tr>
</tbody>
</table>
## Library Test<a name="section1830015913391"></a>
The test procedure for the yxml library is similar to that for the double-conversion library. For details, see [Library Test](porting-a-library-built-using-cmake.md#section6686144293611). The following describes how to use the test cases of the yxml library.
**Table 3** Directory structure of the test directory
<a name="table115941423164318"></a>
<table><thead align="left"><tr id="row1059515236433"><th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.1"><p id="p55950233437"><a name="p55950233437"></a><a name="p55950233437"></a>Directory</p>
</th>
<th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.2"><p id="p4595192324313"><a name="p4595192324313"></a><a name="p4595192324313"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1759572304318"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p17595323144319"><a name="p17595323144319"></a><a name="p17595323144319"></a>openHarmony/third_party/yxml/yxml/out/test/test.sh</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p25956235437"><a name="p25956235437"></a><a name="p25956235437"></a>Automatic test script, which cannot be used because <span id="text625264318457"><a name="text625264318457"></a><a name="text625264318457"></a>OpenHarmony</span> does not support automatic script execution. However, you can refer to this script to conduct a manual test.</p>
</td>
</tr>
<tr id="row155951823184312"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p659572313436"><a name="p659572313436"></a><a name="p659572313436"></a>openHarmony/third_party/yxml/yxml/out/test/test</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p7595102314319"><a name="p7595102314319"></a><a name="p7595102314319"></a>Executable file for testing.</p>
</td>
</tr>
<tr id="row359619238437"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p205969232436"><a name="p205969232436"></a><a name="p205969232436"></a>openHarmony/third_party/yxml/yxml/out/test/*.xml</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p559662344315"><a name="p559662344315"></a><a name="p559662344315"></a>Input test file.</p>
</td>
</tr>
<tr id="row959613236439"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p1159652312438"><a name="p1159652312438"></a><a name="p1159652312438"></a>openHarmony/third_party/yxml/yxml/out/test/*.out</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p18596182314318"><a name="p18596182314318"></a><a name="p18596182314318"></a>Expected output file.</p>
</td>
</tr>
</tbody>
</table>
The content of the **test.sh** file is as follows:
```
#!/bin/sh
for i in *.xml; do
b=`basename $i .xml`
o=${b}.out
t=${b}.test
./test <$i >$t
if [ -n "`diff -q $o $t`" ]; then
echo "Test failed for $i:"
diff -u $o $t
exit 1
fi
done
echo "All tests completed successfully."
```
The shell of OpenHarmony does not support input and output redirection symbols \(< and \>\). During the test, you need to copy the content in the **_\*_.xml** file to the shell and press **Enter**. The output content is displayed in the shell screen.
The following operations are performed based on the assumption that the OpenHarmony environment has been set up and the **nfs** directory has been mounted and accessed.
1. Execute the following command:
```
./test
```
2. Copy the content in the **_\*_.xml** file to shell.
Taking the **pi01.xml** file in the [test](#table115941423164318) directory as an example, copy the following content to shell and press **Enter**:
```
<?SomePI abc?><a/>
```
3. Check whether the output in the shell is the same as that of the **_\*_.out** file in the [test](#table115941423164318) directory.
The output is as follows:
```
pistart SomePI
picontent abc
piend
elemstart a
elemend
ok
```
The output is the same as the **pi01.out** file in the [test](#table115941423164318) directory. The test is passed.
## Adding the Compiled yxml Library to the OpenHarmony Project<a name="section1898016213406"></a>
The procedure for adding the yxml library is almost the same as that for adding the double-conversion library, except that the implementation of **build.gn** and **config.gni** files. For details, see [Adding the Compiled double-conversion Library to the OpenHarmony Project](porting-a-library-built-using-cmake.md#section1651053153715).
- The implementation of the newly added **BUILD.gn** file in the yxml library is as follows:
```
import("config.gni")
group("yxml") {
if (ohos_build_thirdparty_migrated_from_fuchisa == true) {
deps = [":make"]
}
}
if (ohos_build_thirdparty_migrated_from_fuchisa == true) {
action("make") {
script = "//third_party/yxml/build_thirdparty.py"
outputs = ["$target_out_dir/log_yxml.txt"]
exec_path = rebase_path(rebase_path("./yxml", root_build_dir))
command = "make clean && $MAKE_COMMAND"
args = [
"--path=$exec_path",
"--command=${command}"
]
}
}
```
- The configuration of the newly added **config.gni** file in the yxml library is as follows:
```
TEST_ENABLE = "YES"
if (TEST_ENABLE == "YES") {
MAKE_COMMAND = "make test OHOS_SYSROOT_PATH=${ohos_root_path}prebuilts/lite/sysroot/"
} else {
MAKE_COMMAND = "make OHOS_SYSROOT_PATH=${ohos_root_path}prebuilts/lite/sysroot/"
}
```
- The following table lists the directory structure of the OpenHarmony project.
**Table 4** Directory structure of the ported library
<a name="table13265185817173"></a>
<table><thead align="left"><tr id="row92666583171"><th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.1"><p id="p2266105816178"><a name="p2266105816178"></a><a name="p2266105816178"></a>Directory</p>
</th>
<th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.2"><p id="p32661158161718"><a name="p32661158161718"></a><a name="p32661158161718"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1526655816175"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p226605811710"><a name="p226605811710"></a><a name="p226605811710"></a>openHarmony/third_party/yxml/BUILD.gn</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p1626675812177"><a name="p1626675812177"></a><a name="p1626675812177"></a>GN file for adding the third-party library to the <span id="text1699851716117"><a name="text1699851716117"></a><a name="text1699851716117"></a>OpenHarmony</span> project</p>
</td>
</tr>
<tr id="row1726610589179"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p12266115815170"><a name="p12266115815170"></a><a name="p12266115815170"></a>openHarmony/third_party/yxml/build_thirdpaty.py</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p122661958201719"><a name="p122661958201719"></a><a name="p122661958201719"></a>Script file for GN to call the <strong id="b8482154111113"><a name="b8482154111113"></a><a name="b8482154111113"></a>shell</strong> command to convert compilation from GN to Makefile.</p>
</td>
</tr>
<tr id="row7266195891714"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p162665581170"><a name="p162665581170"></a><a name="p162665581170"></a>openHarmony/third_party/yxml/config.gni</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p626712588175"><a name="p626712588175"></a><a name="p626712588175"></a>Third-party library compilation configuration file, which can be modified to determine whether the test cases will be used during the building</p>
</td>
</tr>
<tr id="row1272420109203"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p17725101052012"><a name="p17725101052012"></a><a name="p17725101052012"></a>openHarmony/third_party/yxml/yxml/</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p87252109205"><a name="p87252109205"></a><a name="p87252109205"></a>Directory of the third-party library to be ported</p>
</td>
</tr>
</tbody>
</table>
docs-en/porting/third-party-library-porting-guide.md 0 → 100644
浏览文件 @ 37cc208b
# Third-Party Library Porting Guide<a name="EN-US_TOPIC_0000001073864042"></a>
- **[Overview](overview.md)**
- **[Porting a Library Built Using CMake](porting-a-library-built-using-cmake.md)**
- **[Porting a Library Built Using Makefile](porting-a-library-built-using-makefile.md)**
docs-en/quick-start/Readme-EN.md
浏览文件 @ 37cc208b
...@@ -2,21 +2,21 @@ ...@@ -2,21 +2,21 @@
- [Hi3861 Development Board](hi3861-development-board.md) - [Hi3861 Development Board](hi3861-development-board.md)
- [Introduction to the Hi3861 Development Board](introduction-to-the-hi3861-development-board.md) - [Introduction to the Hi3861 Development Board](introduction-to-the-hi3861-development-board.md)
- [Setting Up a Development Environment](setting-up-a-development-environment.md) - [Setting Up the Hi3861 Development Environment](setting-up-the-hi3861-development-environment.md)
- [Developing the First Example Program Running on Hi3861](developing-the-first-example-program-running-on-hi3861.md) - [Developing the First Example Program Running on Hi3861](developing-the-first-example-program-running-on-hi3861.md)
- [Developing the Second Example Program Running on Hi3861](developing-the-second-example-program-running-on-hi3861.md) - [Developing the Second Example Program Running on Hi3861](developing-the-second-example-program-running-on-hi3861.md)
- [FAQs](faqs.md) - [FAQ on Hi3861](faq-on-hi3861.md)
- [Hi3516 Development Board](hi3516-development-board.md) - [Hi3516 Development Board](hi3516-development-board.md)
- [Introduction to the Hi3516 Development Board](introduction-to-the-hi3516-development-board.md) - [Introduction to the Hi3516 Development Board](introduction-to-the-hi3516-development-board.md)
- [Setting up a Development Environment](setting-up-a-development-environment-0.md) - [Setting Up the Hi3516 Development Environment](setting-up-the-hi3516-development-environment.md)
- [Developing the First Example Program Running on Hi3516](developing-the-first-example-program-running-on-hi3516.md) - [Developing the First Example Program Running on Hi3516](developing-the-first-example-program-running-on-hi3516.md)
- [Developing the First Driver Running on Hi3516](developing-the-first-driver-running-on-hi3516.md) - [Developing the First Driver Running on Hi3516](developing-the-first-driver-running-on-hi3516.md)
- [FAQs](faqs-1.md) - [FAQ on Hi3516](faq-on-hi3516.md)
- [Hi3518 Development Board](hi3518-development-board.md) - [Hi3518 Development Board](hi3518-development-board.md)
- [Introduction to the Hi3518 Development Board](introduction-to-the-hi3518-development-board.md) - [Introduction to the Hi3518 Development Board](introduction-to-the-hi3518-development-board.md)
- [Setting Up a Development Environment](setting-up-a-development-environment-2.md) - [Setting Up the Hi3518 Development Environment](setting-up-the-hi3518-development-environment.md)
- [Developing the First Example Program Running on Hi3518](developing-the-first-example-program-running-on-hi3518.md) - [Developing the First Example Program Running on Hi3518](developing-the-first-example-program-running-on-hi3518.md)
- [FAQs](faqs-3.md) - [FAQ on Hi3518](faq-on-hi3518.md)
docs-en/quick-start/developing-the-first-driver-running-on-hi3516.md
浏览文件 @ 37cc208b
...@@ -427,14 +427,14 @@ The following operations take a HDF-based UART driver as an example to show how ...@@ -427,14 +427,14 @@ The following operations take a HDF-based UART driver as an example to show how
## Compiling and Burning<a name="section660016185110"></a> ## Compiling and Burning<a name="section660016185110"></a>
Compile and burn images by referring to [Compiling Code](developing-the-first-example-program-running-on-hi3516.md#section1077671315253) and [Burning](developing-the-first-example-program-running-on-hi3516.md#section08153912587). Compile and burn images by referring to [Building](developing-the-first-example-program-running-on-hi3516.md#section1077671315253) and [Burning](developing-the-first-example-program-running-on-hi3516.md#section08153912587).
## Running an Image<a name="section197971119142915"></a> ## Running an Image<a name="section197971119142915"></a>
1. Connect to a serial port. 1. Connect to a serial port.
>![](public_sys-resources/icon-notice.gif) **NOTICE:** >![](public_sys-resources/icon-notice.gif) **NOTICE:**
>If the connection fails, rectify the fault by referring to [What should I do when no command output is displayed?](faqs-1.md#section14871149155911). >If the connection fails, rectify the fault by referring to [What should I do when no command output is displayed?](faq-on-hi3516.md#section14871149155911).
**Figure 1** Serial port connection<a name="en-us_topic_0000001052906247_fig056645018495"></a> **Figure 1** Serial port connection<a name="en-us_topic_0000001052906247_fig056645018495"></a>
......
docs-en/quick-start/developing-the-first-example-program-running-on-hi3516.md
浏览文件 @ 37cc208b
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
- [Acquiring Source Code](#section215953714245) - [Acquiring Source Code](#section215953714245)
- [Modifying a Program](#s8efc1952ebfe4d1ea717182e108c29bb) - [Modifying a Program](#s8efc1952ebfe4d1ea717182e108c29bb)
- [Compiling Code](#section1077671315253) - [Building](#section1077671315253)
- [Burning](#section08153912587) - [Burning](#section08153912587)
- [Running an Image](#section380511712615) - [Running an Image](#section380511712615)
- [Running a Program](#section5276734182615) - [Running a Program](#section5276734182615)
...@@ -33,36 +33,38 @@ int main(int argc, char **argv) ...@@ -33,36 +33,38 @@ int main(int argc, char **argv)
} }
``` ```
## Compiling Code<a name="section1077671315253"></a> ## Building<a name="section1077671315253"></a>
On the Linux server, execute the **build.py** script stored in the root directory of the source code package. The result files in the **out/ipcamera\_hi3516dv300** directory. If the Linux environment is installed using Docker, perform the compilation by referring to [Using Docker to Prepare the Build Environment](../get-code/tool-acquisition.md). If the Linux environment is installed using a software package, go to the root directory of the source code and run the following command for source code compilation:
``` ```
python build.py ipcamera_hi3516dv300 -b debug python build.py ipcamera_hi3516dv300 -b debug
``` ```
The result files are generated in the **out/ipcamera\_hi3518ev300** directory.
## Burning<a name="section08153912587"></a> ## Burning<a name="section08153912587"></a>
The Hi3516 development board allows you to burn flash memory over the USB port, serial port, or network port. The following uses the network port burning as an example. The Hi3516 development board allows you to burn flash memory over the USB port, serial port, or network port. The following uses the network port burning as an example.
1. Connect the PC and the target development board through the power port, serial port, and network port. In this section, the Hi3516DV300 is used as an example. For details, please refer to [Introduction to the Hi3516 Development Board](https://device.harmonyos.com/en/docs/start/introduce/oem_camera_start_3516-0000001052670587). 1. Connect the PC and the target development board through the power port, serial port, and network port. In this section, the Hi3516DV300 is used as an example. For details, please refer to [Introduction to the Hi3516 Development Board](https://device.harmonyos.com/en/docs/start/introduce/oem_camera_start_3516-0000001052670587).
2. <a name="en-us_topic_0000001056443961_li142386399535"></a>Open Device Manager, then check and record the serial port number corresponding to the development board. 2. <a name="en-us_topic_0000001071634529_li142386399535"></a>Open Device Manager, then check and record the serial port number corresponding to the development board.
>![](public_sys-resources/icon-note.gif) **NOTE:** >![](public_sys-resources/icon-note.gif) **NOTE:**
>If the serial port number is not displayed correctly, follow the steps described in [Installing the Serial Port Driver on the Hi3516 or Hi3518 Series Development Boards](https://device.harmonyos.com/en/docs/ide/user-guides/hi3516_hi3518-drivers-0000001050743695). >If the serial port number is not displayed correctly, follow the steps described in [Installing the Serial Port Driver on the Hi3516 or Hi3518 Series Development Boards](https://device.harmonyos.com/en/docs/ide/user-guides/hi3516_hi3518-drivers-0000001050743695).
![](figures/en-us_image_0000001057235010.png) ![](figures/en-us_image_0000001071792503.png)
3. Go to **Configure** \> **Burn**. On the displayed page, set the programming information. 3. Go to **Configure** \> **Burn**. On the displayed page, set the programming information.
![](figures/en-us_image_0000001057354060.png) ![](figures/en-us_image_0000001071904255.png)
4. Set **Burning Mode** to **network**. 4. Set **Burning Mode** to **network**.
![](figures/网口烧录-1.png) ![](figures/网口烧录-1.png)
5. Set the programming parameters. 5. Set the programming parameters.
- Set **Port number** to the serial port number recorded in [2](#en-us_topic_0000001056443961_li142386399535). - Set **Port number** to the serial port number recorded in [2](#en-us_topic_0000001071634529_li142386399535).
- Retain the default values for the baud rate and data bits, which have been adapted for the development board. - Retain the default values for the baud rate and data bits, which have been adapted for the development board.
- Set network connection parameters. - Set network connection parameters.
...@@ -70,73 +72,73 @@ The Hi3516 development board allows you to burn flash memory over the USB port, ...@@ -70,73 +72,73 @@ The Hi3516 development board allows you to burn flash memory over the USB port,
- **Remote IP address**: IP address of the development board, which is automatically populated. - **Remote IP address**: IP address of the development board, which is automatically populated.
- **Gateway**: gateway of the development board, which is automatically populated. - **Gateway**: gateway of the development board, which is automatically populated.
- **Subnet mask**: subnet mask, which is automatically populated. - **Subnet mask**: subnet mask, which is automatically populated.
- **MAC address of board**: physical address of the development board. - **MAC address of board**: physical address of the development board. Retain the default value.
![](figures/en-us_image_0000001057543065.png) ![](figures/en-us_image_0000001072552472.png)
- Set the memory type. The settings are related to the receive type of the hardware. For details, please refer to the user guide delivered with the hardware. For example, the value is fixed at EMMC for Hi3516DV300. - Set the memory type. The settings are related to the receive type of the hardware. For details, please refer to the user guide delivered with the hardware. For example, the value is fixed at EMMC for Hi3516DV300.
- Set the information about the files to be written according to the following table. The U-Boot file is not supported for programming through the network port. - Set the information about the files to be written according to the following table. The U-Boot file is not supported for programming through the network port.
<a name="en-us_topic_0000001056443961_table833816126143"></a> <a name="en-us_topic_0000001071634529_table833816126143"></a>
<table><thead align="left"><tr id="en-us_topic_0000001056443961_row123381912111410"><th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.1"><p id="en-us_topic_0000001056443961_p933816122140"><a name="en-us_topic_0000001056443961_p933816122140"></a><a name="en-us_topic_0000001056443961_p933816122140"></a>File Name</p> <table><thead align="left"><tr id="en-us_topic_0000001071634529_row123381912111410"><th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.1"><p id="en-us_topic_0000001071634529_p933816122140"><a name="en-us_topic_0000001071634529_p933816122140"></a><a name="en-us_topic_0000001071634529_p933816122140"></a>File Name</p>
</th> </th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.2"><p id="en-us_topic_0000001056443961_p1533819122144"><a name="en-us_topic_0000001056443961_p1533819122144"></a><a name="en-us_topic_0000001056443961_p1533819122144"></a>Start Address</p> <th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.2"><p id="en-us_topic_0000001071634529_p1533819122144"><a name="en-us_topic_0000001071634529_p1533819122144"></a><a name="en-us_topic_0000001071634529_p1533819122144"></a>Start Address</p>
</th> </th>
<th class="cellrowborder" valign="top" width="24.98%" id="mcps1.1.5.1.3"><p id="en-us_topic_0000001056443961_p1733831231411"><a name="en-us_topic_0000001056443961_p1733831231411"></a><a name="en-us_topic_0000001056443961_p1733831231411"></a>File Size</p> <th class="cellrowborder" valign="top" width="24.98%" id="mcps1.1.5.1.3"><p id="en-us_topic_0000001071634529_p1733831231411"><a name="en-us_topic_0000001071634529_p1733831231411"></a><a name="en-us_topic_0000001071634529_p1733831231411"></a>File Size</p>
</th> </th>
<th class="cellrowborder" valign="top" width="25.019999999999996%" id="mcps1.1.5.1.4"><p id="en-us_topic_0000001056443961_p1433851211145"><a name="en-us_topic_0000001056443961_p1433851211145"></a><a name="en-us_topic_0000001056443961_p1433851211145"></a>Enable</p> <th class="cellrowborder" valign="top" width="25.019999999999996%" id="mcps1.1.5.1.4"><p id="en-us_topic_0000001071634529_p1433851211145"><a name="en-us_topic_0000001071634529_p1433851211145"></a><a name="en-us_topic_0000001071634529_p1433851211145"></a>Enable</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="en-us_topic_0000001056443961_row6339412101413"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001056443961_p14339131221416"><a name="en-us_topic_0000001056443961_p14339131221416"></a><a name="en-us_topic_0000001056443961_p14339131221416"></a>OHOS_Image.bin</p> <tbody><tr id="en-us_topic_0000001071634529_row6339412101413"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001071634529_p14339131221416"><a name="en-us_topic_0000001071634529_p14339131221416"></a><a name="en-us_topic_0000001071634529_p14339131221416"></a>OHOS_Image.bin</p>
</td> </td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001056443961_p133901211419"><a name="en-us_topic_0000001056443961_p133901211419"></a><a name="en-us_topic_0000001056443961_p133901211419"></a>1M</p> <td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001071634529_p133901211419"><a name="en-us_topic_0000001071634529_p133901211419"></a><a name="en-us_topic_0000001071634529_p133901211419"></a>1M</p>
</td> </td>
<td class="cellrowborder" valign="top" width="24.98%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001056443961_p1533951261412"><a name="en-us_topic_0000001056443961_p1533951261412"></a><a name="en-us_topic_0000001056443961_p1533951261412"></a>9M</p> <td class="cellrowborder" valign="top" width="24.98%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001071634529_p1533951261412"><a name="en-us_topic_0000001071634529_p1533951261412"></a><a name="en-us_topic_0000001071634529_p1533951261412"></a>9M</p>
</td> </td>
<td class="cellrowborder" valign="top" width="25.019999999999996%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001056443961_p2574183818223"><a name="en-us_topic_0000001056443961_p2574183818223"></a><a name="en-us_topic_0000001056443961_p2574183818223"></a>Select the check box if this is the first time you are programing flash memory on the development board or if the content related to the kernel and driver is modified.</p> <td class="cellrowborder" valign="top" width="25.019999999999996%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001071634529_p2574183818223"><a name="en-us_topic_0000001071634529_p2574183818223"></a><a name="en-us_topic_0000001071634529_p2574183818223"></a>Select the check box if this is the first time you are programing flash memory on the development board or if the content related to the kernel and driver is modified.</p>
</td> </td>
</tr> </tr>
<tr id="en-us_topic_0000001056443961_row533914120143"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001056443961_p8339112111412"><a name="en-us_topic_0000001056443961_p8339112111412"></a><a name="en-us_topic_0000001056443961_p8339112111412"></a>rootfs.img</p> <tr id="en-us_topic_0000001071634529_row533914120143"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001071634529_p8339112111412"><a name="en-us_topic_0000001071634529_p8339112111412"></a><a name="en-us_topic_0000001071634529_p8339112111412"></a>rootfs.img</p>
</td> </td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001056443961_p733921271410"><a name="en-us_topic_0000001056443961_p733921271410"></a><a name="en-us_topic_0000001056443961_p733921271410"></a>10M</p> <td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001071634529_p733921271410"><a name="en-us_topic_0000001071634529_p733921271410"></a><a name="en-us_topic_0000001071634529_p733921271410"></a>10M</p>
</td> </td>
<td class="cellrowborder" valign="top" width="24.98%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001056443961_p13339181214145"><a name="en-us_topic_0000001056443961_p13339181214145"></a><a name="en-us_topic_0000001056443961_p13339181214145"></a>15M</p> <td class="cellrowborder" valign="top" width="24.98%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001071634529_p13339181214145"><a name="en-us_topic_0000001071634529_p13339181214145"></a><a name="en-us_topic_0000001071634529_p13339181214145"></a>15M</p>
</td> </td>
<td class="cellrowborder" rowspan="2" valign="top" width="25.019999999999996%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001056443961_p233901211146"><a name="en-us_topic_0000001056443961_p233901211146"></a><a name="en-us_topic_0000001056443961_p233901211146"></a>Select the check boxes if this is the first time you are programing flash memory on the development board or if the files have been modified. It is recommended that you always select these check boxes.</p> <td class="cellrowborder" rowspan="2" valign="top" width="25.019999999999996%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001071634529_p233901211146"><a name="en-us_topic_0000001071634529_p233901211146"></a><a name="en-us_topic_0000001071634529_p233901211146"></a>Select the check boxes if this is the first time you are programing flash memory on the development board or if the files have been modified. It is recommended that you always select these check boxes.</p>
</td> </td>
</tr> </tr>
<tr id="en-us_topic_0000001056443961_row1333901281418"><td class="cellrowborder" valign="top" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001056443961_p53391912131416"><a name="en-us_topic_0000001056443961_p53391912131416"></a><a name="en-us_topic_0000001056443961_p53391912131416"></a>userfs.img</p> <tr id="en-us_topic_0000001071634529_row1333901281418"><td class="cellrowborder" valign="top" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001071634529_p53391912131416"><a name="en-us_topic_0000001071634529_p53391912131416"></a><a name="en-us_topic_0000001071634529_p53391912131416"></a>userfs.img</p>
</td> </td>
<td class="cellrowborder" valign="top" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001056443961_p193391612161414"><a name="en-us_topic_0000001056443961_p193391612161414"></a><a name="en-us_topic_0000001056443961_p193391612161414"></a>25M</p> <td class="cellrowborder" valign="top" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001071634529_p193391612161414"><a name="en-us_topic_0000001071634529_p193391612161414"></a><a name="en-us_topic_0000001071634529_p193391612161414"></a>25M</p>
</td> </td>
<td class="cellrowborder" valign="top" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001056443961_p433918121148"><a name="en-us_topic_0000001056443961_p433918121148"></a><a name="en-us_topic_0000001056443961_p433918121148"></a>50M</p> <td class="cellrowborder" valign="top" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001071634529_p433918121148"><a name="en-us_topic_0000001071634529_p433918121148"></a><a name="en-us_topic_0000001071634529_p433918121148"></a>50M</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
![](figures/en-us_image_0000001057621705.png) ![](figures/en-us_image_0000001071514639.png)
6. When you have done, click **Save** at the bottom to save the settings. 6. When you have done, click **Save** at the bottom to save the settings.
7. Click ![](figures/en-us_image_0000001057097113.png) next to **Burn** to start programming. 7. Click ![](figures/en-us_image_0000001072074632.png) next to **Burn** to start programming.
![](figures/en-us_image_0000001057911116.png) ![](figures/en-us_image_0000001071634537.png)
8. Restart the development board within 15 seconds. 8. Restart the development board within 15 seconds.
9. Wait until the programming is complete. If the following information is displayed on the console, it indicates that the programming is successful. 9. Wait until the programming is complete. If the following information is displayed on the console, it indicates that the programming is successful.
![](figures/en-us_image_0000001056648688.png) ![](figures/en-us_image_0000001071984311.png)
10. If this is the first time you use the development board, use the [serial port tool](en-us_topic_0000001057649420.md) to modify the bootcmd and bootargs contents of U-Boot. For details, please refer to [Running an Image on the Hi3516](https://device.harmonyos.com/en/docs/start/introduce/oem_camera_start_first_example-0000001051610926#ZH-CN_TOPIC_0000001052906247__section380511712615). 10. If this is the first time you use the development board, use the [serial port tool](https://device.harmonyos.com/en/docs/ide/user-guides/serial_port-0000001057649420) to modify the bootcmd and bootargs contents of U-Boot. For details, please refer to [Running an Image on the Hi3516](https://device.harmonyos.com/en/docs/start/introduce/oem_camera_start_first_example-0000001051610926#EN-US_TOPIC_0000001052906247__section380511712615).
## Running an Image<a name="section380511712615"></a> ## Running an Image<a name="section380511712615"></a>
1. Connect to a serial port. 1. Connect to a serial port.
>![](public_sys-resources/icon-notice.gif) **NOTICE:** >![](public_sys-resources/icon-notice.gif) **NOTICE:**
>If the connection fails, rectify the fault by referring to [What should I do when no command output is displayed?](faqs-1.md#section14871149155911). >If the connection fails, rectify the fault by referring to [What should I do when no command output is displayed?](faq-on-hi3516.md#section14871149155911).
**Figure 1** Serial port connection<a name="fig056645018495"></a> **Figure 1** Serial port connection<a name="fig056645018495"></a>
......
docs-en/quick-start/developing-the-first-example-program-running-on-hi3518.md
浏览文件 @ 37cc208b
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
- [Acquiring Source Code](#section1726092873119) - [Acquiring Source Code](#section1726092873119)
- [Modifying a Program](#s8efc1952ebfe4d1ea717182e108c29bb) - [Modifying a Program](#s8efc1952ebfe4d1ea717182e108c29bb)
- [Compiling Code](#section234175193114) - [Building](#section234175193114)
- [Burning](#section57955241588) - [Burning](#section57955241588)
- [Running an Image](#section62131033183710) - [Running an Image](#section62131033183710)
- [Follow-up Learning](#section9712145420182) - [Follow-up Learning](#section9712145420182)
...@@ -33,123 +33,125 @@ int main(int argc, char **argv) ...@@ -33,123 +33,125 @@ int main(int argc, char **argv)
} }
``` ```
## Compiling Code<a name="section234175193114"></a> ## Building<a name="section234175193114"></a>
On the Linux server, access the root directory of the source code package and run the following script to compile the source code package. The result files are generated in the **out/ipcamera\_hi3518ev300** directory. If the Linux environment is installed using Docker, perform the compilation by referring to [Using Docker to Prepare the Build Environment](../get-code/tool-acquisition.md). If the Linux compilation environment is installed using a software package, execute the following command to compile source code in the root directory of the source code package.
``` ```
python build.py ipcamera_hi3518ev300 -b debug python build.py ipcamera_hi3518ev300 -b debug
``` ```
The result files are generated in the **out/ipcamera\_hi3518ev300** directory.
## Burning<a name="section57955241588"></a> ## Burning<a name="section57955241588"></a>
The USB port is the only burning mode supported by the Hi3518 development board. The USB port is the only burning mode supported by the Hi3518 development board.
1. Connect the PC and the target development board through the serial port and USB port. In this section, the Hi3518EV300 is used as an example. For details, please refer to [Introduction to the Hi3518 Development Board](https://device.harmonyos.com/en/docs/start/introduce/oem_camera_start_hi3518-0000001050170473). 1. Connect the PC and the target development board through the serial port and USB port. In this section, the Hi3518EV300 is used as an example. For details, please refer to [Introduction to the Hi3518 Development Board](https://device.harmonyos.com/en/docs/start/introduce/oem_camera_start_hi3518-0000001050170473).
2. <a name="en-us_topic_0000001057313128_li101031912111518"></a>Open Device Manager, then check and record the serial port number corresponding to the development board. 2. <a name="en-us_topic_0000001072392860_li101031912111518"></a>Open Device Manager, then check and record the serial port number corresponding to the development board.
>![](public_sys-resources/icon-note.gif) **NOTE:** >![](public_sys-resources/icon-note.gif) **NOTE:**
>If the serial port number is not displayed correctly, follow the steps described in [Installing the Serial Port Driver on the Hi3516 or Hi3518 Series Development Boards](https://device.harmonyos.com/en/docs/ide/user-guides/hi3516_hi3518-drivers-0000001050743695). >If the serial port number is not displayed correctly, follow the steps described in [Installing the Serial Port Driver on the Hi3516 or Hi3518 Series Development Boards](https://device.harmonyos.com/en/docs/ide/user-guides/hi3516_hi3518-drivers-0000001050743695).
![](figures/en-us_image_0000001057235010.png) ![](figures/en-us_image_0000001071792503.png)
3. Go to **Device Tool** \> **Configure** \> **Burn**. On the displayed page, set the programming information. 3. Go to **Device Tool** \> **Configure** \> **Burn**. On the displayed page, set the programming information.
![](figures/en-us_image_0000001057194144.png) ![](figures/en-us_image_0000001071514657.png)
4. Set **Burning Mode** to **usbport**. 4. Set **Burning Mode** to **usbport**.
![](figures/en-us_image_0000001057392985.png) ![](figures/en-us_image_0000001072552464.png)
5. Set the programming parameters. 5. Set the programming parameters.
- Set **Port number** to the serial port number recorded in [2](#en-us_topic_0000001057313128_li101031912111518). - Set **Port number** to the serial port number recorded in [2](#en-us_topic_0000001072392860_li101031912111518).
- Retain the default values for the baud rate and data bits, which have been adapted for the development board. - Retain the default values for the baud rate and data bits, which have been adapted for the development board.
- Set the memory type. For the Hi3518 series development boards, the memory type is fixed at SPI NOR. - Set the memory type. For the Hi3518 series development boards, the memory type is fixed at SPI NOR.
- Set the information about the files to be written according to the following table. - Set the information about the files to be written according to the following table.
<a name="en-us_topic_0000001057313128_table17829824143410"></a> <a name="en-us_topic_0000001072392860_table17829824143410"></a>
<table><thead align="left"><tr id="en-us_topic_0000001057313128_row1782992414343"><th class="cellrowborder" valign="top" width="25.130000000000003%" id="mcps1.1.5.1.1"><p id="en-us_topic_0000001057313128_p198641828133419"><a name="en-us_topic_0000001057313128_p198641828133419"></a><a name="en-us_topic_0000001057313128_p198641828133419"></a>File Name</p> <table><thead align="left"><tr id="en-us_topic_0000001072392860_row1782992414343"><th class="cellrowborder" valign="top" width="25.130000000000003%" id="mcps1.1.5.1.1"><p id="en-us_topic_0000001072392860_p198641828133419"><a name="en-us_topic_0000001072392860_p198641828133419"></a><a name="en-us_topic_0000001072392860_p198641828133419"></a>File Name</p>
</th> </th>
<th class="cellrowborder" valign="top" width="24.87%" id="mcps1.1.5.1.2"><p id="en-us_topic_0000001057313128_p086415289344"><a name="en-us_topic_0000001057313128_p086415289344"></a><a name="en-us_topic_0000001057313128_p086415289344"></a>Start Address</p> <th class="cellrowborder" valign="top" width="24.87%" id="mcps1.1.5.1.2"><p id="en-us_topic_0000001072392860_p086415289344"><a name="en-us_topic_0000001072392860_p086415289344"></a><a name="en-us_topic_0000001072392860_p086415289344"></a>Start Address</p>
</th> </th>
<th class="cellrowborder" valign="top" width="24.98%" id="mcps1.1.5.1.3"><p id="en-us_topic_0000001057313128_p986462863413"><a name="en-us_topic_0000001057313128_p986462863413"></a><a name="en-us_topic_0000001057313128_p986462863413"></a>File Size</p> <th class="cellrowborder" valign="top" width="24.98%" id="mcps1.1.5.1.3"><p id="en-us_topic_0000001072392860_p986462863413"><a name="en-us_topic_0000001072392860_p986462863413"></a><a name="en-us_topic_0000001072392860_p986462863413"></a>File Size</p>
</th> </th>
<th class="cellrowborder" valign="top" width="25.019999999999996%" id="mcps1.1.5.1.4"><p id="en-us_topic_0000001057313128_p58291224193410"><a name="en-us_topic_0000001057313128_p58291224193410"></a><a name="en-us_topic_0000001057313128_p58291224193410"></a>Enable</p> <th class="cellrowborder" valign="top" width="25.019999999999996%" id="mcps1.1.5.1.4"><p id="en-us_topic_0000001072392860_p58291224193410"><a name="en-us_topic_0000001072392860_p58291224193410"></a><a name="en-us_topic_0000001072392860_p58291224193410"></a>Enable</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="en-us_topic_0000001057313128_row4829112453415"><td class="cellrowborder" valign="top" width="25.130000000000003%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001057313128_p18829162417342"><a name="en-us_topic_0000001057313128_p18829162417342"></a><a name="en-us_topic_0000001057313128_p18829162417342"></a>u-boot-<em id="en-us_topic_0000001057313128_i1060617376418"><a name="en-us_topic_0000001057313128_i1060617376418"></a><a name="en-us_topic_0000001057313128_i1060617376418"></a>development board name</em>.bin</p> <tbody><tr id="en-us_topic_0000001072392860_row4829112453415"><td class="cellrowborder" valign="top" width="25.130000000000003%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001072392860_p18829162417342"><a name="en-us_topic_0000001072392860_p18829162417342"></a><a name="en-us_topic_0000001072392860_p18829162417342"></a>u-boot-<em id="en-us_topic_0000001072392860_i1060617376418"><a name="en-us_topic_0000001072392860_i1060617376418"></a><a name="en-us_topic_0000001072392860_i1060617376418"></a>development board name</em>.bin</p>
</td> </td>
<td class="cellrowborder" valign="top" width="24.87%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001057313128_p38298241348"><a name="en-us_topic_0000001057313128_p38298241348"></a><a name="en-us_topic_0000001057313128_p38298241348"></a>0</p> <td class="cellrowborder" valign="top" width="24.87%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001072392860_p38298241348"><a name="en-us_topic_0000001072392860_p38298241348"></a><a name="en-us_topic_0000001072392860_p38298241348"></a>0</p>
</td> </td>
<td class="cellrowborder" valign="top" width="24.98%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001057313128_p18295244345"><a name="en-us_topic_0000001057313128_p18295244345"></a><a name="en-us_topic_0000001057313128_p18295244345"></a>1M</p> <td class="cellrowborder" valign="top" width="24.98%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001072392860_p18295244345"><a name="en-us_topic_0000001072392860_p18295244345"></a><a name="en-us_topic_0000001072392860_p18295244345"></a>1M</p>
</td> </td>
<td class="cellrowborder" valign="top" width="25.019999999999996%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001057313128_p1282982415342"><a name="en-us_topic_0000001057313128_p1282982415342"></a><a name="en-us_topic_0000001057313128_p1282982415342"></a>Select the check box.</p> <td class="cellrowborder" valign="top" width="25.019999999999996%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001072392860_p1282982415342"><a name="en-us_topic_0000001072392860_p1282982415342"></a><a name="en-us_topic_0000001072392860_p1282982415342"></a>Select the check box.</p>
</td> </td>
</tr> </tr>
<tr id="en-us_topic_0000001057313128_row8829192415342"><td class="cellrowborder" valign="top" width="25.130000000000003%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001057313128_p1782912420346"><a name="en-us_topic_0000001057313128_p1782912420346"></a><a name="en-us_topic_0000001057313128_p1782912420346"></a>OHOS_Image.bin</p> <tr id="en-us_topic_0000001072392860_row8829192415342"><td class="cellrowborder" valign="top" width="25.130000000000003%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001072392860_p1782912420346"><a name="en-us_topic_0000001072392860_p1782912420346"></a><a name="en-us_topic_0000001072392860_p1782912420346"></a>OHOS_Image.bin</p>
</td> </td>
<td class="cellrowborder" valign="top" width="24.87%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001057313128_p1483012483410"><a name="en-us_topic_0000001057313128_p1483012483410"></a><a name="en-us_topic_0000001057313128_p1483012483410"></a>1M</p> <td class="cellrowborder" valign="top" width="24.87%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001072392860_p1483012483410"><a name="en-us_topic_0000001072392860_p1483012483410"></a><a name="en-us_topic_0000001072392860_p1483012483410"></a>1M</p>
</td> </td>
<td class="cellrowborder" valign="top" width="24.98%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001057313128_p1283032433419"><a name="en-us_topic_0000001057313128_p1283032433419"></a><a name="en-us_topic_0000001057313128_p1283032433419"></a>6M</p> <td class="cellrowborder" valign="top" width="24.98%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001072392860_p1283032433419"><a name="en-us_topic_0000001072392860_p1283032433419"></a><a name="en-us_topic_0000001072392860_p1283032433419"></a>6M</p>
</td> </td>
<td class="cellrowborder" valign="top" width="25.019999999999996%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001057313128_p17830524163416"><a name="en-us_topic_0000001057313128_p17830524163416"></a><a name="en-us_topic_0000001057313128_p17830524163416"></a>Select the check box if this is the first time you are programing flash memory on the development board or if the content related to the kernel and driver is modified.</p> <td class="cellrowborder" valign="top" width="25.019999999999996%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001072392860_p17830524163416"><a name="en-us_topic_0000001072392860_p17830524163416"></a><a name="en-us_topic_0000001072392860_p17830524163416"></a>Select the check box if this is the first time you are programing flash memory on the development board or if the content related to the kernel and driver is modified.</p>
</td> </td>
</tr> </tr>
<tr id="en-us_topic_0000001057313128_row18830192453415"><td class="cellrowborder" valign="top" width="25.130000000000003%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001057313128_p0830162453411"><a name="en-us_topic_0000001057313128_p0830162453411"></a><a name="en-us_topic_0000001057313128_p0830162453411"></a>rootfs.img</p> <tr id="en-us_topic_0000001072392860_row18830192453415"><td class="cellrowborder" valign="top" width="25.130000000000003%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001072392860_p0830162453411"><a name="en-us_topic_0000001072392860_p0830162453411"></a><a name="en-us_topic_0000001072392860_p0830162453411"></a>rootfs.img</p>
</td> </td>
<td class="cellrowborder" valign="top" width="24.87%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001057313128_p7830424133418"><a name="en-us_topic_0000001057313128_p7830424133418"></a><a name="en-us_topic_0000001057313128_p7830424133418"></a>7M</p> <td class="cellrowborder" valign="top" width="24.87%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001072392860_p7830424133418"><a name="en-us_topic_0000001072392860_p7830424133418"></a><a name="en-us_topic_0000001072392860_p7830424133418"></a>7M</p>
</td> </td>
<td class="cellrowborder" valign="top" width="24.98%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001057313128_p1583012413417"><a name="en-us_topic_0000001057313128_p1583012413417"></a><a name="en-us_topic_0000001057313128_p1583012413417"></a>8M</p> <td class="cellrowborder" valign="top" width="24.98%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001072392860_p1583012413417"><a name="en-us_topic_0000001072392860_p1583012413417"></a><a name="en-us_topic_0000001072392860_p1583012413417"></a>8M</p>
</td> </td>
<td class="cellrowborder" rowspan="2" valign="top" width="25.019999999999996%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001057313128_p166645916376"><a name="en-us_topic_0000001057313128_p166645916376"></a><a name="en-us_topic_0000001057313128_p166645916376"></a>Select the check boxes if this is the first time you are programing flash memory on the development board or if the files have been modified. It is recommended that you always select these check boxes.</p> <td class="cellrowborder" rowspan="2" valign="top" width="25.019999999999996%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001072392860_p166645916376"><a name="en-us_topic_0000001072392860_p166645916376"></a><a name="en-us_topic_0000001072392860_p166645916376"></a>Select the check boxes if this is the first time you are programing flash memory on the development board or if the files have been modified. It is recommended that you always select these check boxes.</p>
</td> </td>
</tr> </tr>
<tr id="en-us_topic_0000001057313128_row38301424183414"><td class="cellrowborder" valign="top" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001057313128_p983032415348"><a name="en-us_topic_0000001057313128_p983032415348"></a><a name="en-us_topic_0000001057313128_p983032415348"></a>userfs.img</p> <tr id="en-us_topic_0000001072392860_row38301424183414"><td class="cellrowborder" valign="top" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001072392860_p983032415348"><a name="en-us_topic_0000001072392860_p983032415348"></a><a name="en-us_topic_0000001072392860_p983032415348"></a>userfs.img</p>
</td> </td>
<td class="cellrowborder" valign="top" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001057313128_p783016244344"><a name="en-us_topic_0000001057313128_p783016244344"></a><a name="en-us_topic_0000001057313128_p783016244344"></a>15M</p> <td class="cellrowborder" valign="top" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001072392860_p783016244344"><a name="en-us_topic_0000001072392860_p783016244344"></a><a name="en-us_topic_0000001072392860_p783016244344"></a>15M</p>
</td> </td>
<td class="cellrowborder" valign="top" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001057313128_p2830142412349"><a name="en-us_topic_0000001057313128_p2830142412349"></a><a name="en-us_topic_0000001057313128_p2830142412349"></a>1M</p> <td class="cellrowborder" valign="top" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001072392860_p2830142412349"><a name="en-us_topic_0000001072392860_p2830142412349"></a><a name="en-us_topic_0000001072392860_p2830142412349"></a>1M</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
![](figures/en-us_image_0000001057952739.png) ![](figures/en-us_image_0000001071634551.png)
6. When you have done, click **Save** at the bottom to save the settings. 6. When you have done, click **Save** at the bottom to save the settings.
7. Click ![](figures/en-us_image_0000001057311476.png) next to **Burn** to start programming. 7. Click ![](figures/en-us_image_0000001071984309.png) next to **Burn** to start programming.
>![](public_sys-resources/icon-note.gif) **NOTE:** >![](public_sys-resources/icon-note.gif) **NOTE:**
>If this is the first time you program flash memory on the Hi3516 or Hi3518 board, the message "not find the Devices" may be displayed. In this case, follow the steps in [Installing the USB Driver on the Hi3516 or Hi3518 Series Development Boards](https://device.harmonyos.com/cn/docs/ide/user-guides/usb_driver-0000001058690393) and start programming again. >If this is the first time you program flash memory on the Hi3516 or Hi3518 board, the message "not find the Devices" may be displayed. In this case, follow the steps in [Installing the USB Driver on the Hi3516 or Hi3518 Series Development Boards](https://device.harmonyos.com/en/docs/ide/user-guides/usb_driver-0000001058690393) and start programming again.
![](figures/en-us_image_0000001058192356.png) ![](figures/en-us_image_0000001071904257.png)
8. Restart the development board within 15 seconds. 8. Restart the development board within 15 seconds.
9. Wait until the programming is complete. If the following information is displayed on the console, it indicates that the programming is successful. 9. Wait until the programming is complete. If the following information is displayed on the console, it indicates that the programming is successful.
![](figures/usb烧录-6.png) ![](figures/usb烧录-6.png)
10. Use the [serial port tool](en-us_topic_0000001057649420.md) to modify the bootcmd and bootargs contents of U-Boot. For details, please refer to [Running an Image on the Hi3518](https://device.harmonyos.com/en/docs/start/introduce/oem_camera_start_example-0000001051610926#EN-US_TOPIC_0000001053422339__section62131033183710). 10. Use the [serial port tool](https://device.harmonyos.com/en/docs/ide/user-guides/serial_port-0000001057649420) to modify the bootcmd and bootargs contents of U-Boot. For details, please refer to [Running an Image on the Hi3518](https://device.harmonyos.com/en/docs/start/introduce/oem_camera_start_example-0000001051610926#EN-US_TOPIC_0000001053422339__section62131033183710).
## Running an Image<a name="section62131033183710"></a> ## Running an Image<a name="section62131033183710"></a>
1. Connect to a serial port. 1. Connect to a serial port.
>![](public_sys-resources/icon-notice.gif) **NOTICE:** >![](public_sys-resources/icon-notice.gif) **NOTICE:**
>If the connection fails, rectify the fault by referring to [What should I do when no command output is displayed?](faqs-3.md#en-us_topic_0000001053466255_section14871149155911). >If the connection fails, rectify the fault by referring to [What should I do when no command output is displayed?](faq-on-hi3518.md#en-us_topic_0000001053466255_section14871149155911).
**Figure 1** Serial port connection<a name="fig056645018495"></a> **Figure 1** Serial port connection<a name="fig056645018495"></a>
![](figures/chuankou1-1.png) ![](figures/chuankou1-0.png)
1. Click **Serial port** to enable it. 1. Click **Serial port** to enable it.
2. Enter the serial port number queried in the "Burning" section \(COM11 is used in this example\) and press **Enter** until **hisillicon** is displayed. 2. Enter the serial port number queried in the "Burning" section \(COM11 is used in this example\) and press **Enter** until **hisillicon** is displayed.
3. Go to step [2](#l5b42e79a33ea4d35982b78a22913b0b1) if the board is started for the first time or the startup parameters need to be modified; go to step [3](#ld26f18828aa44c36bfa36be150e60e49) otherwise. 3. Go to [step 2](#li9441185382314) if the board is started for the first time or the startup parameters need to be modified; go to [step 3](#li6442853122312) otherwise.
2. \(Mandatory for the first burning\) Modify the **bootcmd** and **bootargs** parameters of U-boot. This step is a fixed operation and the result can be saved. However, you need to perform the following steps again if U-boot needs to be reburnt. 2. <a name="li9441185382314"></a>\(Mandatory for the first burning\) Modify the **bootcmd** and **bootargs** parameters of U-boot. This step is a fixed operation and the result can be saved. However, you need to perform the following steps again if U-boot needs to be reburnt.
**Table 1** Parameters of the U-boot **Table 1** Parameters of the U-boot
...@@ -191,7 +193,7 @@ The USB port is the only burning mode supported by the Hi3518 development board. ...@@ -191,7 +193,7 @@ The USB port is the only burning mode supported by the Hi3518 development board.
>![](public_sys-resources/icon-notice.gif) **NOTICE:** >![](public_sys-resources/icon-notice.gif) **NOTICE:**
>**go 0x40000000** \(optional\) indicates that the command is fixed in the startup parameters by default and the board automatically starts after it is reset. If you want to manually start the board, press **Enter** in the countdown phase of the U-boot startup to interrupt the automatic startup. >**go 0x40000000** \(optional\) indicates that the command is fixed in the startup parameters by default and the board automatically starts after it is reset. If you want to manually start the board, press **Enter** in the countdown phase of the U-boot startup to interrupt the automatic startup.
3. If **hisilicon \#** is displayed during the startup, run the **reset** command. After the system automatically starts and **OHOS** is displayed, run the **./bin/camera\_app** command and then press **Enter**. The system is started successfully if information shown in the following figure is displayed. 3. <a name="li6442853122312"></a>If **hisilicon \#** is displayed during the startup, run the **reset** command. After the system automatically starts and **OHOS** is displayed, run the **./bin/camera\_app** command and then press **Enter**. The system is started successfully if information shown in the following figure is displayed.
**Figure 2** Successful system startup and program execution<a name="fig11838403383"></a> **Figure 2** Successful system startup and program execution<a name="fig11838403383"></a>
![](figures/successful-system-startup-and-program-execution.png "successful-system-startup-and-program-execution") ![](figures/successful-system-startup-and-program-execution.png "successful-system-startup-and-program-execution")
......
docs-en/quick-start/developing-the-first-example-program-running-on-hi3861.md
浏览文件 @ 37cc208b
# Developing the First Example Program Running on Hi3861<a name="EN-US_TOPIC_0000001053302600"></a> # Developing the First Example Program Running on Hi3861<a name="EN-US_TOPIC_0000001053302600"></a>
- [Acquiring Source Code](#section1545225464016) - [Acquiring Source Code](#section1545225464016)
- [Compiling Source Code](#section1736014117148) - [Building](#section1736014117148)
- [Burning Images](#section1610612214150) - [Burning Images](#section1610612214150)
- [Connecting WLAN Module to the Internet](#section168257461059) - [Connecting WLAN Module to the Internet](#section168257461059)
...@@ -11,9 +11,11 @@ This example shows how to connect the WLAN module to the gateway using attention ...@@ -11,9 +11,11 @@ This example shows how to connect the WLAN module to the gateway using attention
You need to acquire [Hi3861 source code](https://repo.huaweicloud.com/harmonyos/os/1.0/code-1.0.tar.gz), download it on a Linux server, and decompress it. For more obtaining methods, see [Source Code Acquisition](../get-code/source-code-acquisition.md). You need to acquire [Hi3861 source code](https://repo.huaweicloud.com/harmonyos/os/1.0/code-1.0.tar.gz), download it on a Linux server, and decompress it. For more obtaining methods, see [Source Code Acquisition](../get-code/source-code-acquisition.md).
## Compiling Source Code<a name="section1736014117148"></a> ## Building<a name="section1736014117148"></a>
This section describes how to compile the WLAN module on a Linux server. This section describes how to perform the WLAN module building on a Linux server.
If the Linux environment is installed using Docker, perform the building by referring to [Using Docker to Prepare the Build Environment](../get-code/tool-acquisition.md). If the Linux environment is installed using a software package, perform the following steps:
1. Open the HUAWEI DevEco Device Tool and choose **View** \> **Terminal**. 1. Open the HUAWEI DevEco Device Tool and choose **View** \> **Terminal**.
...@@ -22,16 +24,16 @@ This section describes how to compile the WLAN module on a Linux server. ...@@ -22,16 +24,16 @@ This section describes how to compile the WLAN module on a Linux server.
![](figures/en-us_image_0000001055040538.png) ![](figures/en-us_image_0000001055040538.png)
On the TERMINAL page, run the ssh command, for example, **ssh _user_@_ipaddr_**, to connect to the Linux server. On the TERMINAL page, run the ssh command, for example, **ssh** **_user_@_ipaddr_**, to connect to the Linux server.
**Figure 2** TERMINAL page<a name="fig91165301546"></a> **Figure 2** TERMINAL page<a name="fig91165301546"></a>
![](figures/en-us_image_0000001054599199.png) ![](figures/en-us_image_0000001054599199.png)
2. Go to the root directory of the code and run the **python build.py wifiiot** command in the TERMINAL page to start compilation. 2. Go to the root directory of the code and run the **python build.py wifiiot** command in the TERMINAL page to start building.
**Figure 3** Running the compilation command on TERMINAL page<a name="fig17727115215612"></a> **Figure 3** Running the command on TERMINAL page<a name="fig17727115215612"></a>
![](figures/en-us_image_0000001055040596.png) ![](figures/en-us_image_0000001055040596.png)
...@@ -41,13 +43,13 @@ This section describes how to compile the WLAN module on a Linux server. ...@@ -41,13 +43,13 @@ This section describes how to compile the WLAN module on a Linux server.
**Figure 4** Successful building<a name="fig1262101218463"></a> **Figure 4** Successful building<a name="fig1262101218463"></a>
![](figures/successful-building.png "successful-building") ![](figures/successful-building.png "successful-building")
4. Run the following command to check whether the following files are generated in the **./out/wifiiot/** directory: 4. Check whether the following files are generated in the **./out/wifiiot/** directory.
``` ```
ls -l out/wifiiot ls -l out/wifiiot
``` ```
**Figure 5** Directory for storing compilation files<a name="fig38521346164618"></a> **Figure 5** Directory for storing the generated files<a name="fig38521346164618"></a>
![](figures/en-us_image_0000001055040654.png) ![](figures/en-us_image_0000001055040654.png)
......
docs-en/quick-start/developing-the-second-example-program-running-on-hi3861.md
浏览文件 @ 37cc208b
...@@ -120,7 +120,7 @@ Call Stack 6 -- 3f5e24 addr:f78fc ...@@ -120,7 +120,7 @@ Call Stack 6 -- 3f5e24 addr:f78fc
To parse the call stack information, the **Hi3861\_wifiiot\_app.asm** file is required. This file records the symbol addresses of the functions in the code in the flash memory and the disassembly information. The asm file is built and output together with the version software package and is stored in the **./out/wifiiot/** directory. To parse the call stack information, the **Hi3861\_wifiiot\_app.asm** file is required. This file records the symbol addresses of the functions in the code in the flash memory and the disassembly information. The asm file is built and output together with the version software package and is stored in the **./out/wifiiot/** directory.
1. \(Optional\) Save the** CallStack** information to a txt file for editing. 1. \(Optional\) Save the **CallStack** information to a txt file for editing.
2. Open the asm file, search for the function address in each call stack, and list the corresponding function. Generally, you only need to find the functions matching the first several stacks to locate exceptions. 2. Open the asm file, search for the function address in each call stack, and list the corresponding function. Generally, you only need to find the functions matching the first several stacks to locate exceptions.
``` ```
...@@ -133,7 +133,7 @@ To parse the call stack information, the **Hi3861\_wifiiot\_app.asm** file is ...@@ -133,7 +133,7 @@ To parse the call stack information, the **Hi3861\_wifiiot\_app.asm** file is
Call Stack 6 -- 3f5e24 addr:f78fc Call Stack 6 -- 3f5e24 addr:f78fc
``` ```
3. Determined that an exception occurs in the **WadRecvCB** function based on the call stack information. 3. Determine that an exception occurs in the **WadRecvCB** function based on the call stack information.
![](figures/en-us_image_0000001054763554.png) ![](figures/en-us_image_0000001054763554.png)
......
docs-en/quick-start/faq-on-hi3516.md 0 → 100644
浏览文件 @ 37cc208b
# FAQ on Hi3516<a name="EN-US_TOPIC_0000001053466255"></a>
- [What should I do when the images failed to be burnt over the selected serial port?](#section627268185113)
- [What should I do when Windows-based PC failed to be connected to the board?](#section195391036568)
- [What should I do when the image failed to be burnt?](#section571164016565)
- [What should I do when the message indicating Python cannot be found is displayed during compilation and building?](#section1039835245619)
- [What should I do when no command output is displayed?](#section14871149155911)
## What should I do when the images failed to be burnt over the selected serial port?<a name="section627268185113"></a>
- **Symptom**
**Error: Opening COMxx: Access denied** is displayed after clicking **Burn** and selecting a serial port.
**Figure 1** Failed to open the serial port<a name="fig066333283916"></a>
![](figures/failed-to-open-the-serial-port.png "failed-to-open-the-serial-port")
- **Possible Causes**
The serial port has been used.
- **Solutions**
1. Search for the terminal using serial-xx from the drop-down list in the **TERMINAL** panel.
**Figure 2** Checking whether the serial port is used<a name="fig165994164420"></a>
![](figures/checking-whether-the-serial-port-is-used.png "checking-whether-the-serial-port-is-used")
2. Click the dustbin icon as shown in the following figure to disable the terminal using the serial port.
**Figure 3** Disabling the terminal using the serial port<a name="fig7911282453"></a>
![](figures/disabling-the-terminal-using-the-serial-port.png "disabling-the-terminal-using-the-serial-port")
3. Click **Burn**, select the serial port, and start burning images again.
**Figure 4** Restarting burning<a name="fig1138624316485"></a>
![](figures/changjian1.png)
## What should I do when Windows-based PC failed to be connected to the board?<a name="section195391036568"></a>
- **Symptom**
The file image cannot be obtained after clicking **Burn** and selecting a serial port.
**Figure 5** Failed to obtain the image file due to unavailable connection<a name="fig5218920223"></a>
![](figures/failed-to-obtain-the-image-file-due-to-unavailable-connection.png "failed-to-obtain-the-image-file-due-to-unavailable-connection")
- **Possible Causes**
The board is disconnected from the Windows-based PC.
Windows Firewall does not allow Visual Studio Code to access the network.
- **Solutions**
1. Check whether the network cable is properly connected.
2. Click **Windows Firewall**.
**Figure 6** Network and firewall setting<a name="fig62141417794"></a>
![](figures/network-and-firewall-setting.png "network-and-firewall-setting")
3. Click **Firewall & network protection**, and on the displayed page, click **Allow applications to communicate through Windows Firewall**.
**Figure 7** Firewall and network protection<a name="fig20703151111116"></a>
![](figures/firewall-and-network-protection.png "firewall-and-network-protection")
4. Select the Visual Studio Code application
**Figure 8** Selecting the Visual Studio Code application<a name="fig462316612165"></a>
![](figures/selecting-the-visual-studio-code-application.png "selecting-the-visual-studio-code-application")
5. Select the **Private** and **Public** network access rights for the Visual Studio Code application.
**Figure 9** Allowing the Visual Studio Code application to access the network<a name="fig132725269184"></a>
![](figures/allowing-the-visual-studio-code-application-to-access-the-network.png "allowing-the-visual-studio-code-application-to-access-the-network")
## What should I do when the image failed to be burnt?<a name="section571164016565"></a>
- **Symptom**
The burning status is not displayed after clicking **Burn** and selecting a serial port.
- **Possible Causes**
The IDE is not restarted after the DevEco plug-in is installed.
- **Solutions**
Restart the IDE.
## What should I do when the message indicating Python cannot be found is displayed during compilation and building?<a name="section1039835245619"></a>
- **Symptom**
![](figures/en-us_image_0000001055035538.png)
- **Possible Cause 1**: Python is not installed.
- **Solutions**
Install the Python environment by referring to [Installing a Python Environment](setting-up-the-hi3516-development-environment.md#section126442079459).
- **Possible Cause 2**: The soft link that points to the Python does not exist in the usr/bin directory.
![](figures/en-us_image_0000001054475589.png)
- **Solutions**
Run the following commands:
```
# cd /usr/bin/
# which python3
# ln -s /usr/local/bin/python3 python
# python --version
```
Example:
![](figures/en-us_image_0000001054875562.png)
## What should I do when no command output is displayed?<a name="section14871149155911"></a>
- **Symptom**
The serial port shows that the connection has been established. After the board is restarted, nothing is displayed when you press **Enter**.
- **Possible Cause 1**
The serial port is connected incorrectly.
- **Solutions**
Change the serial port number.
Start **Device Manager** to check whether the serial port connected to the board is the same as that connected to the terminal device. If the serial ports are different, perform step [1](developing-the-first-example-program-running-on-hi3516.md#l177d08e77bd441d38991da9be4572a74) in the **Running an Image** section to change the serial port number.
- **Possible Cause 2**
The U-boot of the board is damaged.
- **Solutions**
Burn the U-boot.
If the fault persists after you perform the preceding operations, the U-boot of the board may be damaged. You can burn the U-boot by performing the following steps:
1. Obtain the U-boot file.
>![](public_sys-resources/icon-notice.gif) **NOTICE:**
>The U-boot file of the two boards can be obtained from the following paths, respectively.
>- Hi3516DV300: vendor\\hisi\\hi35xx\\hi3516dv300\\uboot\\out\\boot\\u-boot-hi3516dv300.bin
>- Hi3518EV300: vendor\\hisi\\hi35xx\\hi3518ev300\\uboot\\out\\boot\\u-boot-hi3518ev300.bin
2. Burn the U-boot file by following the procedures for burning a U-boot file over USB.
Select the U-boot files of corresponding development boards for burning by referring to [Programming Flash Memory on the Hi3516](https://device.harmonyos.com/en/docs/ide/user-guides/hi3516_upload-0000001052148681)/[Programming Flash Memory on the Hi3518](https://device.harmonyos.com/en/docs/ide/user-guides/hi3518_upload-0000001057313128)
3. Log in to the serial port after the burning is complete.
**Figure 10** Serial port displayed after the U-boot is burnt<a name="en-us_topic_0000001053466255_fig155914681910"></a>
![](figures/serial-port-displayed-after-the-u-boot-is-burnt.png "serial-port-displayed-after-the-u-boot-is-burnt")
docs-en/quick-start/faq-on-hi3518.md 0 → 100644
浏览文件 @ 37cc208b
# FAQ on Hi3518<a name="EN-US_TOPIC_0000001058898620"></a>
- [What should I do when the images failed to be burnt over the selected serial port?](#section1498892119619)
- [What should I do when Windows-based PC failed to be connected to the board?](#section8512971816)
- [What should I do when the image failed to be burnt?](#section1767804111198)
- [What should I do when the message indicating Python cannot be found is displayed during compilation and building?](#en-us_topic_0000001053466255_section1039835245619)
- [What should I do when no command output is displayed?](#en-us_topic_0000001053466255_section14871149155911)
## What should I do when the images failed to be burnt over the selected serial port?<a name="section1498892119619"></a>
- **Symptom**
**Error: Opening COMxx: Access denied** is displayed after clicking **Burn** and selecting a serial port.
**Figure 1** Failed to open the serial port<a name="en-us_topic_0000001053466255_fig066333283916"></a>
![](figures/failed-to-open-the-serial-port.png "failed-to-open-the-serial-port")
- **Possible Causes**
The serial port has been used.
- **Solutions**
1. Search for the terminal using serial-xx from the drop-down list in the **TERMINAL** panel.
**Figure 2** Checking whether the serial port is used<a name="en-us_topic_0000001053466255_fig165994164420"></a>
![](figures/checking-whether-the-serial-port-is-used.png "checking-whether-the-serial-port-is-used")
2. Click the dustbin icon as shown in the following figure to disable the terminal using the serial port.
**Figure 3** Disabling the terminal using the serial port<a name="en-us_topic_0000001053466255_fig7911282453"></a>
![](figures/disabling-the-terminal-using-the-serial-port.png "disabling-the-terminal-using-the-serial-port")
3. Click **Burn**, select the serial port, and start burning images again.
**Figure 4** Restarting burning<a name="en-us_topic_0000001053466255_fig1138624316485"></a>
![](figures/changjian1.png)
## What should I do when Windows-based PC failed to be connected to the board?<a name="section8512971816"></a>
- **Symptom**
The file image cannot be obtained after clicking **Burn** and selecting a serial port.
**Figure 5** Failed to obtain the image file due to unavailable connection<a name="en-us_topic_0000001053466255_fig5218920223"></a>
![](figures/failed-to-obtain-the-image-file-due-to-unavailable-connection.png "failed-to-obtain-the-image-file-due-to-unavailable-connection")
- **Possible Causes**
The board is disconnected from the Windows-based PC.
Windows Firewall does not allow Visual Studio Code to access the network.
- **Solutions**
1. Check whether the network cable is properly connected.
2. Click **Windows Firewall**.
**Figure 6** Network and firewall setting<a name="en-us_topic_0000001053466255_fig62141417794"></a>
![](figures/network-and-firewall-setting.png "network-and-firewall-setting")
3. Click **Firewall & network protection**, and on the displayed page, click **Allow applications to communicate through Windows Firewall**.
**Figure 7** Firewall and network protection<a name="en-us_topic_0000001053466255_fig20703151111116"></a>
![](figures/firewall-and-network-protection.png "firewall-and-network-protection")
4. Select the Visual Studio Code application
**Figure 8** Selecting the Visual Studio Code application<a name="en-us_topic_0000001053466255_fig462316612165"></a>
![](figures/selecting-the-visual-studio-code-application.png "selecting-the-visual-studio-code-application")
5. Select the **Private** and **Public** network access rights for the Visual Studio Code application.
**Figure 9** Allowing the Visual Studio Code application to access the network<a name="en-us_topic_0000001053466255_fig132725269184"></a>
![](figures/allowing-the-visual-studio-code-application-to-access-the-network.png "allowing-the-visual-studio-code-application-to-access-the-network")
## What should I do when the image failed to be burnt?<a name="section1767804111198"></a>
- **Symptom**
The burning status is not displayed after clicking **Burn** and selecting a serial port.
- **Possible Causes**
The IDE is not restarted after the DevEco plug-in is installed.
- **Solutions**
Restart the IDE.
## What should I do when the message indicating Python cannot be found is displayed during compilation and building?<a name="en-us_topic_0000001053466255_section1039835245619"></a>
- **Symptom**
![](figures/en-us_image_0000001058781525.png)
- **Possible Cause 1**
Python is not installed.
- **Solutions**
Install the Python environment by referring to [Installing a Python Environment](setting-up-the-hi3518-development-environment.md#section10807183719500).
- **Possible Cause 2**
![](figures/en-us_image_0000001058939672.png)
- **Solutions**
Run the following commands:
```
# cd /usr/bin/
# which python3
# ln -s /usr/local/bin/python3 python
# python --version
```
Example:
![](figures/en-us_image_0000001058781464.png)
## What should I do when no command output is displayed?<a name="en-us_topic_0000001053466255_section14871149155911"></a>
- **Symptom**
The serial port shows that the connection has been established. After the board is restarted, nothing is displayed when you press **Enter**.
- **Possible Cause 1**
The serial port is connected incorrectly.
- **Solutions**
Change the serial port number.
Start **Device Manager** to check whether the serial port connected to the board is the same as that connected to the terminal device. If the serial ports are different, perform step [1](developing-the-first-example-program-running-on-hi3518.md#li744118533233) in the **Running an Image** section to change the serial port number.
- **Possible Cause 2**
The U-boot of the board is damaged.
- **Solutions**
Burn the U-boot.
If the fault persists after you perform the preceding operations, the U-boot of the board may be damaged. You can burn the U-boot by performing the following steps:
1. Obtain the U-boot file.
>![](public_sys-resources/icon-notice.gif) **NOTICE:**
>The U-boot file of the two boards can be obtained from the following paths, respectively.
>- Hi3516DV300: vendor\\hisi\\hi35xx\\hi3516dv300\\uboot\\out\\boot\\u-boot-hi3516dv300.bin
>- Hi3518EV300: vendor\\hisi\\hi35xx\\hi3518ev300\\uboot\\out\\boot\\u-boot-hi3518ev300.bin
2. Burn the U-boot file by following the procedures for burning a U-boot file over USB.
Select the U-boot files of corresponding development boards for burning by referring to [Programming Flash Memory on the Hi3516](https://device.harmonyos.com/en/docs/ide/user-guides/hi3516_upload-0000001052148681)/[Programming Flash Memory on the Hi3518](https://device.harmonyos.com/en/docs/ide/user-guides/hi3518_upload-0000001057313128)
3. Log in to the serial port after the burning is complete.
![](figures/en-us_image_0000001058719409.png)
docs-en/quick-start/faq-on-hi3861.md 0 → 100644
浏览文件 @ 37cc208b
# FAQ on Hi3861<a name="EN-US_TOPIC_0000001053143860"></a>
- [What should I do when the message is displayed during Python 3 installation?](#section1221016541119)
- [What should I do when the message is displayed during Python 3 installation?](#section1913477181213)
- [What should I do when the message is displayed during Python 3 installation?](#section108211415131210)
- [What should I do when the message is displayed during Python 3 installation?](#section2062268124)
- [What should I do when the message is displayed during compilation and building?](#section982315398121)
- [What should I do when the message is displayed during compilation and building?](#section102035451216)
- [What should I do when the message is displayed during compilation and building?](#section4498158162320)
- [What should I do when the message is displayed during compilation and building?](#section11181036112615)
- [What should I do when the message indicating Python cannot be found is displayed during compilation and building?](#section1571810194619)
- [What should I do when an error with occurs during installation?](#section691681635814)
## What should I do when the message **configure: error: no acceptable C compiler found in $PATH** is displayed during Python 3 installation?<a name="section1221016541119"></a>
- **Symptom**
The following error occurs during Python3 installation:
```
configure: error: no acceptable C compiler found in $PATH. See 'config.log' for more details
```
- **Possible Causes**
**gcc** is not installed.
- **Solutions**
1. Run the **apt-get install gcc** command to install **gcc** online.
2. After the installation, reinstall Python 3.
## What should I do when the message **-bash: make: command not found** is displayed during Python 3 installation?<a name="section1913477181213"></a>
- **Symptom**
The following error occurs during Python3 installation:
```
-bash: make: command not found
```
- **Possible Causes**
**make** is not installed.
- **Solutions**
1. Run the **apt-get install make** command to install **make** online.
2. After the installation, reinstall Python 3.
## What should I do when the message **zlib not available** is displayed during Python 3 installation?<a name="section108211415131210"></a>
- **Symptom**
The following error occurs during Python3 installation:
```
zipimport.ZipImportError: can't decompress data; zlib not avaliable
```
- **Possible Causes**
**zlib** is not installed.
- **Solutions**
Solution 1: Run the **apt-get install zlib** command to install **zlib** online.
Solution 2: If the software source does not contain **zlib**, download the source code from [http://www.zlib.net/](http://www.zlib.net/).
![](figures/10.png)
Then run the following commands to install **zlib** offline:
```
# tar xvf zlib-1.2.11.tar.gz
# cd zlib-1.2.11
# ./configure
# make && make install
```
After the installation, reinstall Python 3.
## What should I do when the message **No module named '\_ctypes'** is displayed during Python 3 installation?<a name="section2062268124"></a>
- **Symptom**
The following error occurs during Python3 installation:
```
ModuleNotFoundError: No module named '_ctypes'
```
- **Possible Causes**
**libffi** and **libffi-devel** are not installed.
- **Solutions**
1. Run the **apt-get install libffi\* -y** command to install **libffi** and **libffi-devel** online.
2. After the installation, reinstall Python 3.
## What should I do when the message **No module named 'Crypto'** is displayed during compilation and building?<a name="section982315398121"></a>
- **Symptom**
The following error occurs during compilation and building:
```
ModuleNotFoundError: No module named 'Crypto'
```
- **Possible Causes**
**Crypto** is not installed.
- **Solutions**
Solution 1: Run the **pip3 install Crypto** command to install **Crypto** online.
Solution 2: Install **Crypto** offline.
- Download the source code from [https://pypi.org/project/pycrypto/\#files](https://pypi.org/project/pycrypto/#files).
![](figures/en-us_image_0000001053462612.png)
- Save the source code package to the Linux server, decompress the package, and run the **python3 setup.py install** command to install **Crypto**.
- Rebuild an environment.
## What should I do when the message **No module named 'ecdsa'** is displayed during compilation and building?<a name="section102035451216"></a>
- **Symptom**
The following error occurs during compilation and building:
```
ModuleNotFoundError: No module named 'ecdsa'
```
- **Possible Causes**
**ecdsa** is not installed.
- **Solutions**
Solution 1: Run the **pip3 install ecdsa** command to install **ecdsa** online.
Solution 2: Install **ecdsa** offline.
- Download the installation package from [https://pypi.org/project/ecdsa/\#files](https://pypi.org/project/ecdsa/#files).
![](figures/en-us_image_0000001053022609.png)
- Save the installation package to the Linux server and run the **pip3 install ecdsa-0.15-py2.py3-none-any.whl** command to install **ecdsa**.
- Rebuild an environment.
## What should I do when the message **Could not find a version that satisfies the requirement six\>=1.9.0** is displayed during compilation and building?<a name="section4498158162320"></a>
- **Symptom**
The following error occurs during compilation and building:
```
Could not find a version that satisfies the requirment six>=1.9.0
```
- **Possible Causes**
**six** is not installed.
- **Solutions**
Solution 1: Run the **pip3 install six** command to install **six** online.
Solution 2: Install **six** offline.
- Download the installation package from [https://pypi.org/project/six/\#files](https://pypi.org/project/six/#files).
![](figures/en-us_image_0000001052742629.png)
- Save the source code to the Linux server and run the **pip3 install six-1.14.0-py2.py3-none-any.whl** command to install **six**.
- Rebuild an environment.
## What should I do when the message **cannot find -lgcc** is displayed during compilation and building?<a name="section11181036112615"></a>
- **Symptom**
The following error occurs during compilation and building:
```
riscv32-unknown-elf-ld: cannot find -lgcc
```
- **Possible Causes**
The PATH is incorrectly written by **gcc\_riscv32**. There is an extra slash \(/\).
```
~/gcc_riscv32/bin/:/data/toolchain/
```
- **Solutions**
Modify the PATH by deleting the slash \(/\).
```
~/gcc_riscv32/bin:/data/toolchain/
```
## What should I do when the message indicating Python cannot be found is displayed during compilation and building?<a name="section1571810194619"></a>
- **Symptom**
The following error occurs during compilation and building:
```
-bash: /usr/bin/python: No such file or directory
```
- **Possible Cause 1:** Python is not installed.
- **Solutions**
Install Python by referring to [Installing a Python Environment](setting-up-the-hi3861-development-environment.md#section18835251192618).
- **Possible Cause 2:** The soft link that points to the Python does not exist in the **usr/bin** directory.
![](figures/en-us_image_0000001055372855.png)
- **Solutions**
Run the following commands to add a soft link:
```
# cd /usr/bin/
# which python3
# ln -s /usr/local/bin/python3 python
# python --version
```
Example:
![](figures/en-us_image_0000001055012855.png)
## What should I do when an error with **lsb\_release** occurs during **kconfiglib** installation?<a name="section691681635814"></a>
- **Symptom**
The following error occurs during **kconfiglib** installation:
```
subprocess.CalledProcessError: Command '('lsb_release', '-a')' returned non-zero exit status 1.
```
- **Possible Causes**
The Python version matched with the **lsb\_release** module is different from the current Python version.
- **Solutions**
Run the **find / -name lsb\_release** command, for example, **sudo rm -rf /usr/bin/lsb\_release** to locate and delete **lsb\_release**.
docs-en/quick-start/hi3516-development-board.md
浏览文件 @ 37cc208b
...@@ -2,12 +2,12 @@ ...@@ -2,12 +2,12 @@
- **[Introduction to the Hi3516 Development Board](introduction-to-the-hi3516-development-board.md)** - **[Introduction to the Hi3516 Development Board](introduction-to-the-hi3516-development-board.md)**
- **[Setting up a Development Environment](setting-up-a-development-environment-0.md)** - **[Setting Up the Hi3516 Development Environment](setting-up-the-hi3516-development-environment.md)**
- **[Developing the First Example Program Running on Hi3516](developing-the-first-example-program-running-on-hi3516.md)** - **[Developing the First Example Program Running on Hi3516](developing-the-first-example-program-running-on-hi3516.md)**
- **[Developing the First Driver Running on Hi3516](developing-the-first-driver-running-on-hi3516.md)** - **[Developing the First Driver Running on Hi3516](developing-the-first-driver-running-on-hi3516.md)**
- **[FAQs](faqs-1.md)** - **[FAQ on Hi3516](faq-on-hi3516.md)**
docs-en/quick-start/hi3518-development-board.md
浏览文件 @ 37cc208b
...@@ -2,10 +2,10 @@ ...@@ -2,10 +2,10 @@
- **[Introduction to the Hi3518 Development Board](introduction-to-the-hi3518-development-board.md)** - **[Introduction to the Hi3518 Development Board](introduction-to-the-hi3518-development-board.md)**
- **[Setting Up a Development Environment](setting-up-a-development-environment-2.md)** - **[Setting Up the Hi3518 Development Environment](setting-up-the-hi3518-development-environment.md)**
- **[Developing the First Example Program Running on Hi3518](developing-the-first-example-program-running-on-hi3518.md)** - **[Developing the First Example Program Running on Hi3518](developing-the-first-example-program-running-on-hi3518.md)**
- **[FAQs](faqs-3.md)** - **[FAQ on Hi3518](faq-on-hi3518.md)**
docs-en/quick-start/hi3861-development-board.md
浏览文件 @ 37cc208b
...@@ -2,12 +2,12 @@ ...@@ -2,12 +2,12 @@
- **[Introduction to the Hi3861 Development Board](introduction-to-the-hi3861-development-board.md)** - **[Introduction to the Hi3861 Development Board](introduction-to-the-hi3861-development-board.md)**
- **[Setting Up a Development Environment](setting-up-a-development-environment.md)** - **[Setting Up the Hi3861 Development Environment](setting-up-the-hi3861-development-environment.md)**
- **[Developing the First Example Program Running on Hi3861](developing-the-first-example-program-running-on-hi3861.md)** - **[Developing the First Example Program Running on Hi3861](developing-the-first-example-program-running-on-hi3861.md)**
- **[Developing the Second Example Program Running on Hi3861](developing-the-second-example-program-running-on-hi3861.md)** - **[Developing the Second Example Program Running on Hi3861](developing-the-second-example-program-running-on-hi3861.md)**
- **[FAQs](faqs.md)** - **[FAQ on Hi3861](faq-on-hi3861.md)**
docs-en/quick-start/setting-up-the-hi3516-development-environment.md 0 → 100644
浏览文件 @ 37cc208b
# Setting Up the Hi3516 Development Environment<a name="EN-US_TOPIC_0000001054501981"></a>
- [Environment Requirements](#section179175261196)
- [Hardware Requirements](#section5840424125014)
- [Software Requirements](#section965634210501)
- [Build Tools for Linux](#section7786130185118)
- [Development Tools for Windows](#section939920316515)
- [Using Docker to Install the Linux Environment](#section748632362420)
- [Installing the Linux Environment Using an Installation Package](#section182916865219)
- [Connecting to a Linux Server](#section14371161220386)
- [Changing Linux Shell to Bash](#section77681442174413)
- [Installing a Python Environment](#section126442079459)
- [Installing a File Packing Tool](#section8352161417450)
- [Installing gn](#section16725103716357)
- [Installing ninja](#section18469114293513)
- [Installing LLVM](#section18344103584516)
- [Installing hc-gen](#section2075110583451)
- [Installing the JVM](#section101989994613)
- [Installing the HAP Packing Tool](#section14507022124614)
- [Installing the HAP Signature Tool](#section15236123816464)
- [Installing a Windows Development Environment](#section1995840162515)
## Environment Requirements<a name="section179175261196"></a>
### Hardware Requirements<a name="section5840424125014"></a>
- Linux server
- Windows workstation \(host computer\)
- Hi3516DV300 IoT camera development board
- USB-to-serial cable and network cable \(The Windows workstation is connected to Hi3516DV300 development board through the USB-to-serial cable and network cable.\)
The following figure shows the hardware connections.
**Figure 1** Hardware connections<a name="fig19527104710591"></a>
![](figures/矩形备份-292.png)
### Software Requirements<a name="section965634210501"></a>
**Table 1** Platforms required for the Hi3516DV300 development board
<a name="tc50585b2b3fe43f7835154789b0e25af"></a>
<table><thead align="left"><tr id="ra9df6acc53154b819d5f86d885d994de"><th class="cellrowborder" valign="top" width="8.53%" id="mcps1.2.5.1.1"><p id="a999bb40532eb4f74a7383e1e776bb94a"><a name="a999bb40532eb4f74a7383e1e776bb94a"></a><a name="a999bb40532eb4f74a7383e1e776bb94a"></a>Hardware</p>
</th>
<th class="cellrowborder" valign="top" width="11.66%" id="mcps1.2.5.1.2"><p id="ae63cf791fbe348d3b907d20fc4927df8"><a name="ae63cf791fbe348d3b907d20fc4927df8"></a><a name="ae63cf791fbe348d3b907d20fc4927df8"></a>Software</p>
</th>
<th class="cellrowborder" valign="top" width="66%" id="mcps1.2.5.1.3"><p id="a54c4c80c43c84cb187342865a1d2b51e"><a name="a54c4c80c43c84cb187342865a1d2b51e"></a><a name="a54c4c80c43c84cb187342865a1d2b51e"></a>Description</p>
</th>
<th class="cellrowborder" valign="top" width="13.81%" id="mcps1.2.5.1.4"><p id="a11e8d096fb204378a63d8805cd6d1f88"><a name="a11e8d096fb204378a63d8805cd6d1f88"></a><a name="a11e8d096fb204378a63d8805cd6d1f88"></a>Remarks</p>
</th>
</tr>
</thead>
<tbody><tr id="row117591159175819"><td class="cellrowborder" valign="top" width="8.53%" headers="mcps1.2.5.1.1 "><p id="a0c1290183f2548898dbfc516a4db2c4b"><a name="a0c1290183f2548898dbfc516a4db2c4b"></a><a name="a0c1290183f2548898dbfc516a4db2c4b"></a>Linux compile server</p>
</td>
<td class="cellrowborder" valign="top" width="11.66%" headers="mcps1.2.5.1.2 "><p id="a687efa8001f140488dc1da9a2ee8f6d1"><a name="a687efa8001f140488dc1da9a2ee8f6d1"></a><a name="a687efa8001f140488dc1da9a2ee8f6d1"></a>Operating system</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.2.5.1.3 "><p id="ace724e00c9094eccb8c600d6ad426ed8"><a name="ace724e00c9094eccb8c600d6ad426ed8"></a><a name="ace724e00c9094eccb8c600d6ad426ed8"></a>Ubuntu 16.04 64-bit or later is used for the Linux OS, and bash is used as the shell.</p>
<div class="note" id="note124531828194919"><a name="note124531828194919"></a><a name="note124531828194919"></a><span class="notetitle"> NOTE: </span><div class="notebody"><p id="p1244243142810"><a name="p1244243142810"></a><a name="p1244243142810"></a>Common software such as samba and vim is installed in the OS by default. Adaptation is required to support Linux file sharing.</p>
</div></div>
</td>
<td class="cellrowborder" rowspan="3" valign="top" width="13.81%" headers="mcps1.2.5.1.4 "><p id="a4d0e2c8444484554ab58949ce322be32"><a name="a4d0e2c8444484554ab58949ce322be32"></a><a name="a4d0e2c8444484554ab58949ce322be32"></a>You can develop programs on the Windows workstation or on the Linux server through remote login.</p>
</td>
</tr>
<tr id="r85c4bf56ff3244e48db9d2f5b622b340"><td class="cellrowborder" rowspan="2" valign="top" headers="mcps1.2.5.1.1 "><p id="a8e99fd0262cb4489b70cf86c2144c294"><a name="a8e99fd0262cb4489b70cf86c2144c294"></a><a name="a8e99fd0262cb4489b70cf86c2144c294"></a>Windows workstation</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.5.1.2 "><p id="a44d6164ce2e9421f9ade362f600c2815"><a name="a44d6164ce2e9421f9ade362f600c2815"></a><a name="a44d6164ce2e9421f9ade362f600c2815"></a>Operating system</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.5.1.3 "><p id="a1c17349e334a44ada5c5f150457fe17d"><a name="a1c17349e334a44ada5c5f150457fe17d"></a><a name="a1c17349e334a44ada5c5f150457fe17d"></a>Windows XP/Windows7/Windows10</p>
</td>
</tr>
<tr id="r2c85a3b244764425b0d08fa20503da12"><td class="cellrowborder" valign="top" headers="mcps1.2.5.1.1 "><p id="a70beb9d769e340018c9c39c7d44cf424"><a name="a70beb9d769e340018c9c39c7d44cf424"></a><a name="a70beb9d769e340018c9c39c7d44cf424"></a>USB-to-Serial adapter driver</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.5.1.2 "><p id="p9790183418466"><a name="p9790183418466"></a><a name="p9790183418466"></a><a href="http://www.hihope.org/download/AllDocuments" target="_blank" rel="noopener noreferrer">http://www.hihope.org/download/AllDocuments</a></p>
<p id="p37901134184614"><a name="p37901134184614"></a><a name="p37901134184614"></a>Driver name: USB-to-Serial Comm Port.exe</p>
</td>
</tr>
</tbody>
</table>
### Build Tools for Linux<a name="section7786130185118"></a>
The following table describes the tools required for setting up the general environment for a Linux server and how to obtain these tools.
**Table 2** Development tools and obtaining methods
<a name="table6299192712513"></a>
<table><thead align="left"><tr id="row122993276512"><th class="cellrowborder" valign="top" width="13.081308130813083%" id="mcps1.2.4.1.1"><p id="p1829914271858"><a name="p1829914271858"></a><a name="p1829914271858"></a>Development Tool</p>
</th>
<th class="cellrowborder" valign="top" width="19.921992199219922%" id="mcps1.2.4.1.2"><p id="p429918274517"><a name="p429918274517"></a><a name="p429918274517"></a>Description</p>
</th>
<th class="cellrowborder" valign="top" width="66.996699669967%" id="mcps1.2.4.1.3"><p id="p12997271757"><a name="p12997271757"></a><a name="p12997271757"></a>How to Obtain</p>
</th>
</tr>
</thead>
<tbody><tr id="row430016273514"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p330015271158"><a name="p330015271158"></a><a name="p330015271158"></a>Python3.7+</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p43003270510"><a name="p43003270510"></a><a name="p43003270510"></a>Runs the compilation scripts.</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p18254155164617"><a name="p18254155164617"></a><a name="p18254155164617"></a><a href="https://www.python.org/ftp/python/3.8.5/Python-3.8.5.tgz" target="_blank" rel="noopener noreferrer">https://www.python.org/ftp/python/3.8.5/Python-3.8.5.tgz</a></p>
</td>
</tr>
<tr id="row42668197206"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p426711912014"><a name="p426711912014"></a><a name="p426711912014"></a>bash</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p14267131962014"><a name="p14267131962014"></a><a name="p14267131962014"></a>Executes commands.</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p14267101962014"><a name="p14267101962014"></a><a name="p14267101962014"></a>Internet</p>
</td>
</tr>
<tr id="row1711946154018"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p15588165684216"><a name="p15588165684216"></a><a name="p15588165684216"></a>gn</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p4588135634213"><a name="p4588135634213"></a><a name="p4588135634213"></a>Generates ninja compilation scripts.</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p10572194318318"><a name="p10572194318318"></a><a name="p10572194318318"></a><a href="https://repo.huaweicloud.com/harmonyos/compiler/gn/1523/linux/gn.1523.tar" target="_blank" rel="noopener noreferrer">https://repo.huaweicloud.com/harmonyos/compiler/gn/1523/linux/gn.1523.tar</a></p>
</td>
</tr>
<tr id="row16990164213404"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p1858825613428"><a name="p1858825613428"></a><a name="p1858825613428"></a>ninja</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p15844174611816"><a name="p15844174611816"></a><a name="p15844174611816"></a>Executes ninja compilation scripts.</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p1923373393515"><a name="p1923373393515"></a><a name="p1923373393515"></a><a href="https://repo.huaweicloud.com/harmonyos/compiler/ninja/1.9.0/linux/ninja.1.9.0.tar" target="_blank" rel="noopener noreferrer">https://repo.huaweicloud.com/harmonyos/compiler/ninja/1.9.0/linux/ninja.1.9.0.tar</a></p>
</td>
</tr>
<tr id="row192161027104010"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p15217227174016"><a name="p15217227174016"></a><a name="p15217227174016"></a>LLVM</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p122171727184019"><a name="p122171727184019"></a><a name="p122171727184019"></a>Functions as the compiler toolchain.</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p0191147134415"><a name="p0191147134415"></a><a name="p0191147134415"></a><a href="https://repo.huaweicloud.com/harmonyos/compiler/clang/9.0.0-34042/linux/llvm-linux-9.0.0-34042.tar" target="_blank" rel="noopener noreferrer">https://repo.huaweicloud.com/harmonyos/compiler/clang/9.0.0-34042/linux/llvm-linux-9.0.0-34042.tar</a></p>
</td>
</tr>
<tr id="row18516509507"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p14521650135017"><a name="p14521650135017"></a><a name="p14521650135017"></a>hc-gen</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p125255010501"><a name="p125255010501"></a><a name="p125255010501"></a>Configures and compiles files.</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p145061517114519"><a name="p145061517114519"></a><a name="p145061517114519"></a><a href="https://repo.huaweicloud.com/harmonyos/compiler/hc-gen/0.65/linux/hc-gen-0.65-linux.tar" target="_blank" rel="noopener noreferrer">https://repo.huaweicloud.com/harmonyos/compiler/hc-gen/0.65/linux/hc-gen-0.65-linux.tar</a></p>
</td>
</tr>
<tr id="row105773499422"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p15300102717517"><a name="p15300102717517"></a><a name="p15300102717517"></a>IPOP, PuTTY, or other HyperTerminal software</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p109418530386"><a name="p109418530386"></a><a name="p109418530386"></a>Connects to the Linux server (choose one of the terminals).</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p7312122523813"><a name="p7312122523813"></a><a name="p7312122523813"></a>Internet (for example, <a href="https://www.putty.org/" target="_blank" rel="noopener noreferrer">https://www.putty.org/</a>)</p>
</td>
</tr>
<tr id="row29204072315"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p5921190162318"><a name="p5921190162318"></a><a name="p5921190162318"></a>Java virtual machine (JVM)</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p17921110152311"><a name="p17921110152311"></a><a name="p17921110152311"></a>Compiles, debugs, and runs Java programs.</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p16921805237"><a name="p16921805237"></a><a name="p16921805237"></a>apt-get install</p>
</td>
</tr>
<tr id="row1176514438124"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p87662439123"><a name="p87662439123"></a><a name="p87662439123"></a>hmos_app_packing_tool</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p18766343141214"><a name="p18766343141214"></a><a name="p18766343141214"></a>HAP packing tool</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p117668435124"><a name="p117668435124"></a><a name="p117668435124"></a><a href="https://repo.huaweicloud.com/harmonyos/develop_tools/hmos_app_packing_tool.jar" target="_blank" rel="noopener noreferrer">https://repo.huaweicloud.com/harmonyos/develop_tools/hmos_app_packing_tool.jar</a></p>
</td>
</tr>
<tr id="row576920166454"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p643319185456"><a name="p643319185456"></a><a name="p643319185456"></a>hapsigntool</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p19433131844519"><a name="p19433131844519"></a><a name="p19433131844519"></a>HAP signature tool</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p1785173474910"><a name="p1785173474910"></a><a name="p1785173474910"></a><a href="https://repo.huaweicloud.com/harmonyos/develop_tools/hapsigntoolv2.jar" target="_blank" rel="noopener noreferrer">https://repo.huaweicloud.com/harmonyos/develop_tools/hapsigntoolv2.jar</a></p>
</td>
</tr>
</tbody>
</table>
### Development Tools for Windows<a name="section939920316515"></a>
**Table 3** Development tools for the Windows workstation
<a name="table1313323311274"></a>
<table><thead align="left"><tr id="row3133133312711"><th class="cellrowborder" valign="top" width="16.371637163716375%" id="mcps1.2.4.1.1"><p id="p16132203372716"><a name="p16132203372716"></a><a name="p16132203372716"></a>Development Tool</p>
</th>
<th class="cellrowborder" valign="top" width="50.29502950295029%" id="mcps1.2.4.1.2"><p id="p1413219339278"><a name="p1413219339278"></a><a name="p1413219339278"></a>Description</p>
</th>
<th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.2.4.1.3"><p id="p17133183312711"><a name="p17133183312711"></a><a name="p17133183312711"></a>How to Obtain</p>
</th>
</tr>
</thead>
<tbody><tr id="row13697410143219"><td class="cellrowborder" valign="top" width="16.371637163716375%" headers="mcps1.2.4.1.1 "><p id="p163612016916"><a name="p163612016916"></a><a name="p163612016916"></a>Visual Studio Code</p>
</td>
<td class="cellrowborder" valign="top" width="50.29502950295029%" headers="mcps1.2.4.1.2 "><p id="p1563690791"><a name="p1563690791"></a><a name="p1563690791"></a>Edits codes.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="p146361701097"><a name="p146361701097"></a><a name="p146361701097"></a><a href="https://code.visualstudio.com/" target="_blank" rel="noopener noreferrer">https://code.visualstudio.com/</a></p>
</td>
</tr>
<tr id="row12133123315277"><td class="cellrowborder" valign="top" width="16.371637163716375%" headers="mcps1.2.4.1.1 "><p id="p613393317271"><a name="p613393317271"></a><a name="p613393317271"></a>HUAWEI DevEco Device Tool</p>
</td>
<td class="cellrowborder" valign="top" width="50.29502950295029%" headers="mcps1.2.4.1.2 "><p id="p10133193310276"><a name="p10133193310276"></a><a name="p10133193310276"></a>Functions as the integrated development environment (IDE) to provide code compilation, burning, and debugging. C and C++ languages are supported.</p>
<div class="note" id="note7133193392718"><a name="note7133193392718"></a><a name="note7133193392718"></a><span class="notetitle"> NOTE: </span><div class="notebody"><p id="p1133183310277"><a name="p1133183310277"></a><a name="p1133183310277"></a>HUAWEI DevEco Device Tool is a one-stop IDE provided by <span id="text4133533192719"><a name="text4133533192719"></a><a name="text4133533192719"></a>OpenHarmony</span> for smart device developers. You can customize <span id="text14536110256"><a name="text14536110256"></a><a name="text14536110256"></a>OpenHarmony</span> components on it as required, HUAWEI DevEco Device Tool is deployed on Visual Studio Code as a plug-in.</p>
</div></div>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="p16788135433519"><a name="p16788135433519"></a><a name="p16788135433519"></a><a href="https://device.harmonyos.com/en/ide" target="_blank" rel="noopener noreferrer">https://device.harmonyos.com/en/ide</a></p>
</td>
</tr>
</tbody>
</table>
## Using Docker to Install the Linux Environment<a name="section748632362420"></a>
You can use Docker to quickly install the Linux environment. For details, see **Setting Up the Docker Environment** in [Using Docker to Prepare the Build Environment](../get-code/tool-acquisition.md).
## Installing the Linux Environment Using an Installation Package<a name="section182916865219"></a>
>![](public_sys-resources/icon-notice.gif) **NOTICE:**
>- If you acquire the source code using an HPM component or HPM CLI tool, compilation tools like **gn**, **ninja**, **LLVM**, and **hc-gen** are not required.
>- \(Recommended\) If you obtain the source code through an image site or a code repository, compilation tools like **gn**, **ninja**, **LLVM**, and **hc-gen** need to be installed. When installing **gn**, **ninja**, **LLVM**, and **hc-gen**, ensure that the environment variable paths of the compilation tools are unique.
### Connecting to a Linux Server<a name="section14371161220386"></a>
Using PuTTY to log in to a Linux server from a PC running Windows
1. Open [PuTTY](https://www.putty.org/), enter the IP address of the Linux server, and click **Open**.
**Figure 2** PuTTY configuration<a name="en-us_topic_0000001054781998_f825e6d7569cc487db9b744e454c7157a"></a>
![](figures/putty-configuration.png "putty-configuration")
2. Click **Yes** in the PuTTY **Security Alert** dialog box.
3. Enter the account and password.
**Figure 3** Login<a name="en-us_topic_0000001054781998_fe1428afffbdd45f9b4a39497691ff5ff"></a>
![](figures/login.png "login")
4. The login is successful.
**Figure 4** Successful login<a name="en-us_topic_0000001054781998_f11bea69483e14bd39fef4a10b1ed1a3a"></a>
![](figures/successful-login.png "successful-login")
### Changing Linux Shell to Bash<a name="section77681442174413"></a>
Check whether bash is used as the shell.
```
ls -l /bin/sh
```
If **/bin/sh -\> bash** is not displayed, do as follows to change shell to bash.
**Method 1:** Run the following command on the device and then click **No**.
```
sudo dpkg-reconfigure dash
```
**Method 2:** Run the first command to delete sh and then run the second command to create a new soft link.
```
sudo rm -rf /bin/sh
sudo ln -s /bin/bash /bin/sh
```
### Installing a Python Environment<a name="section126442079459"></a>
1. Start a Linux server.
2. Check the Python version \(Python 3.7 or later is required\).
```
python3 --version
```
If the Python version is earlier than 3.7, reinstall a later Python version \(for example, Python 3.8\) as follows:
1. Check the Ubuntu version.
```
cat /etc/issue
```
1. Install Python based on the Ubuntu version.
- If the Ubuntu version is 18 or later, run the following command:
```
sudo apt-get install python3.8
```
- If the Ubuntu version is 16, download the installation package and install Python.
1. Install Python environment dependencies \(gcc, g++, make, zlib, libffi\).
```
sudo apt-get install gcc && sudo apt-get install g++ && sudo apt-get install make && sudo apt-get install zlib* && sudo apt-get install libffi-dev
```
1. Obtain the [Python3.8.5 installation package](https://www.python.org/ftp/python/3.8.5/Python-3.8.5.tgz), save it to the Linux server, and run the following command:
```
tar -xvzf Python-3.8.5.tgz && cd Python-3.8.5 && sudo ./configure && sudo make && sudo make install
```
3. After Python is installed, link the Python path to **/usr/bin/python**.
Check whether Python is soft linked to Python 3.8.
```
python --version
```
If the command output is not **python 3.8.5**, run the following command to check the directory where Python 3.8 is stored:
```
which python3.8
```
Replace **python3.8-path** in the following command with the output path of the **which python3.8** command.
```
cd /usr/bin && sudo rm python && sudo rm python3 && sudo ln -s python3.8-path python && sudo ln -s python3.8-path python3 && python3 --version && python --version
```
4. Install and upgrade the Python package management tool \(pip3\) using either of the following methods:
- **Command line:**
```
sudo apt-get install python3-setuptools python3-pip -y
sudo pip3 install --upgrade pip
```
- **Installation package:**
```
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
python get-pip.py
```
5. Install setuptools.
```
pip3 install setuptools
```
6. Install the GUI menuconfig tool \(Kconfiglib\). You are advised to install Kconfiglib 13.2.0 or later.
- **Command line:**
```
sudo pip3 install kconfiglib
```
- **Installation package:**
1. Download the **.whl** file \(for example, **kconfiglib-13.2.0-py2.py3-none-any.whl**\).
Download path: [https://pypi.org/project/kconfiglib\#files](https://pypi.org/project/kconfiglib#files)
1. Install the **.whl** file.
```
sudo pip3 install kconfiglib-13.2.0-py2.py3-none-any.whl
```
### Installing a File Packing Tool<a name="section8352161417450"></a>
1. Start a Linux server.
2. Install **dosfstools**.
```
sudo apt-get install dosfstools
```
3. Install **mtools**.
```
sudo apt-get install mtools
```
4. Install **mtd-utils**.
```
sudo apt-get install mtd-utils
```
### Installing gn<a name="section16725103716357"></a>
1. Start a Linux server.
2. Download [gn](https://repo.huaweicloud.com/harmonyos/compiler/gn/1523/linux/gn.1523.tar).
3. Decompress the gn installation package to **\~/gn**.
```
tar -xvf gn.1523.tar -C ~/
```
4. Set an environment variable.
```
vim ~/.bashrc
```
Copy the following command to the last line of the **.bashrc** file, save the file, and exit.
```
export PATH=~/gn:$PATH
```
5. Validate the environment variable.
```
source ~/.bashrc
```
### Installing ninja<a name="section18469114293513"></a>
1. Start a Linux server.
2. Download [ninja](https://repo.huaweicloud.com/harmonyos/compiler/ninja/1.9.0/linux/ninja.1.9.0.tar).
3. Decompress the ninja installation package to **\~/ninja**.
```
tar -xvf ninja.1.9.0.tar -C ~/
```
4. Set an environment variable.
```
vim ~/.bashrc
```
Copy the following command to the last line of the **.bashrc** file, save the file, and exit.
```
export PATH=~/ninja:$PATH
```
5. Validate the environment variable.
```
source ~/.bashrc
```
### Installing LLVM<a name="section18344103584516"></a>
1. Start a Linux server.
2. Download [LLVM](http://tools.harmonyos.com/mirrors/clang/9.0.0-34042/linux/llvm-linux-9.0.0-34042.tar).
3. Decompress the LLVM installation package to **\~/llvm**.
```
tar -xvf llvm-linux-9.0.0-34042.tar -C ~/
```
4. Set an environment variable.
```
vim ~/.bashrc
```
Copy the following command to the last line of the **.bashrc** file, save the file, and exit.
```
export PATH=~/llvm/bin:$PATH
```
5. Validate the environment variable.
```
source ~/.bashrc
```
### Installing hc-gen<a name="section2075110583451"></a>
1. Start a Linux server.
2. Download [hc-gen](https://repo.huaweicloud.com/harmonyos/compiler/hc-gen/0.65/linux/hc-gen-0.65-linux.tar).
3. Decompress the hc-gen installation package to **\~/hc-gen** on the Linux server.
```
tar -xvf hc-gen-0.65-linux.tar -C ~/
```
4. Set an environment variable.
```
vim ~/.bashrc
```
Copy the following command to the last line of the **.bashrc** file, save the file, and exit.
```
export PATH=~/hc-gen:$PATH
```
5. Validate the environment variable.
```
source ~/.bashrc
```
### Installing the JVM<a name="section101989994613"></a>
1. Start a Linux server.
2. Install the Java Runtime Environment \(JRE\).
```
sudo apt-get install default-jre
```
3. Install the Java Development Kit \(JDK\).
```
sudo apt-get install default-jdk
```
### Installing the HAP Packing Tool<a name="section14507022124614"></a>
The HAP packing tool is used for packing system applications during the compilation of OpenHarmony. To install this tool, perform the following operations:
1. Start a Linux server.
2. Install the JVM before using the HAP packing tool.
3. [Download the HAP packing tool](https://repo.huaweicloud.com/harmonyos/develop_tools/hmos_app_packing_tool.jar).
4. Copy **hmos\_app\_packing\_tool.jar** to the **\~/developtools** directory on the Linux server.
5. Set an environment variable.
```
vim ~/.bashrc
```
Copy the following command to the last line of the **.bashrc** file, save the file, and exit.
```
export PATH=~/developtools:$PATH
```
6. Validate the environment variable.
```
source ~/.bashrc
```
### Installing the HAP Signature Tool<a name="section15236123816464"></a>
The HAP signature tool is used for signing system applications that have been packaged during the compilation of OpenHarmony. To install this tool, perform the following operations:
1. Start a Linux server.
2. [Download the HAP signature tool](https://repo.huaweicloud.com/harmonyos/develop_tools/hapsigntoolv2.jar).
3. Copy **hapsigntoolv2.jar** to the **\~/developtools** directory on the Linux server.
4. Set an environment variable.
```
vim ~/.bashrc
```
Copy the following command to the last line of the **.bashrc** file, save the file, and exit.
```
export PATH=~/developtools:$PATH
```
5. Validate the environment variable.
```
source ~/.bashrc
```
## Installing a Windows Development Environment<a name="section1995840162515"></a>
The OpenHarmony IDE Development Tool \(HUAWEI DevEco Device Tool\) integrates the capabilities of terminal tools. For details about how to install the tool, see [Preparations ](https://device.harmonyos.com/en/docs/ide/user-guides/tool_install-0000001050164976)and [Importing and Configuring a Project](https://device.harmonyos.com/en/docs/ide/user-guides/import_project-0000001050164980).
docs-en/quick-start/setting-up-the-hi3518-development-environment.md 0 → 100644
浏览文件 @ 37cc208b
# Setting Up the Hi3518 Development Environment<a name="EN-US_TOPIC_0000001054022306"></a>
- [Environment Requirements](#section1724111409282)
- [Hardware Requirements](#section487353718276)
- [Software Requirements](#section44143554278)
- [Build Tools for Linux](#section17315193935817)
- [Development Tools for Windows](#section1897593723017)
- [Using Docker to Install the Linux Environment](#section4848141175215)
- [Installing the Linux Environment Using an Installation Package](#section8831868501)
- [Connecting to a Linux Server](#section12584112413505)
- [Changing Linux Shell to Bash](#section21811833145019)
- [Installing a Python Environment](#section10807183719500)
- [Installing a File Packing Tool](#section480195453419)
- [Installing gn](#section16725103716357)
- [Installing ninja](#section156834539351)
- [Installing LLVM](#section11739111964114)
- [Installing hc-gen](#section351420104218)
- [Installing a Windows Development Environment](#section188621583120)
## Environment Requirements<a name="section1724111409282"></a>
### Hardware Requirements<a name="section487353718276"></a>
- Linux server
- Windows workstation \(host computer\)
- Hi3518EV300 IoT camera development board
- USB-to-serial cable and network cable \(The Windows workstation is connected to the Hi3518EV300 development board through the USB-to-serial cable and network cable.\)
The following figure shows the hardware connections.
**Figure 1** Hardware connections<a name="fig8211468392"></a>
![](figures/hardware-connections.png "hardware-connections")
### Software Requirements<a name="section44143554278"></a>
**Table 1** Platforms required for the Hi3518EV300 development board
<a name="table16641975408"></a>
<table><thead align="left"><tr id="row196634713405"><th class="cellrowborder" valign="top" width="8.53%" id="mcps1.2.5.1.1"><p id="p116632718408"><a name="p116632718408"></a><a name="p116632718408"></a>Hardware</p>
</th>
<th class="cellrowborder" valign="top" width="11.66%" id="mcps1.2.5.1.2"><p id="p1766312724017"><a name="p1766312724017"></a><a name="p1766312724017"></a>Software</p>
</th>
<th class="cellrowborder" valign="top" width="66%" id="mcps1.2.5.1.3"><p id="p666327144010"><a name="p666327144010"></a><a name="p666327144010"></a>Description</p>
</th>
<th class="cellrowborder" valign="top" width="13.81%" id="mcps1.2.5.1.4"><p id="p106631273406"><a name="p106631273406"></a><a name="p106631273406"></a>Remarks</p>
</th>
</tr>
</thead>
<tbody><tr id="row066315717402"><td class="cellrowborder" valign="top" width="8.53%" headers="mcps1.2.5.1.1 "><p id="p666318712403"><a name="p666318712403"></a><a name="p666318712403"></a>Linux compile server</p>
</td>
<td class="cellrowborder" valign="top" width="11.66%" headers="mcps1.2.5.1.2 "><p id="p76632712403"><a name="p76632712403"></a><a name="p76632712403"></a>Operating system</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.2.5.1.3 "><p id="p15663127204015"><a name="p15663127204015"></a><a name="p15663127204015"></a>Ubuntu 16.04 64-bit or later is used for the Linux OS, and bash is used as the shell.</p>
<div class="note" id="note196631578401"><a name="note196631578401"></a><a name="note196631578401"></a><span class="notetitle"> NOTE: </span><div class="notebody"><p id="p1466311720406"><a name="p1466311720406"></a><a name="p1466311720406"></a>Common software such as samba and vim is installed in the OS by default. Adaptation is required to support Linux file sharing.</p>
</div></div>
</td>
<td class="cellrowborder" rowspan="3" valign="top" width="13.81%" headers="mcps1.2.5.1.4 "><p id="p96631975404"><a name="p96631975404"></a><a name="p96631975404"></a>You can develop programs on the Windows workstation or on the Linux server through remote login.</p>
</td>
</tr>
<tr id="row19664272408"><td class="cellrowborder" rowspan="2" valign="top" headers="mcps1.2.5.1.1 "><p id="p1366314764011"><a name="p1366314764011"></a><a name="p1366314764011"></a>Windows workstation</p>
<p id="p145850361498"><a name="p145850361498"></a><a name="p145850361498"></a></p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.5.1.2 "><p id="p15663177204019"><a name="p15663177204019"></a><a name="p15663177204019"></a>Operating system</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.5.1.3 "><p id="p1766411719408"><a name="p1766411719408"></a><a name="p1766411719408"></a>Windows XP/Windows7/Windows10</p>
</td>
</tr>
<tr id="row258543619919"><td class="cellrowborder" valign="top" headers="mcps1.2.5.1.1 "><p id="a70beb9d769e340018c9c39c7d44cf424"><a name="a70beb9d769e340018c9c39c7d44cf424"></a><a name="a70beb9d769e340018c9c39c7d44cf424"></a>USB-to-Serial adapter driver</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.5.1.2 "><p id="p9790183418466"><a name="p9790183418466"></a><a name="p9790183418466"></a><a href="http://www.hihope.org/download/AllDocuments" target="_blank" rel="noopener noreferrer">http://www.hihope.org/download/AllDocuments</a></p>
<p id="p37901134184614"><a name="p37901134184614"></a><a name="p37901134184614"></a>Driver name: USB-to-Serial Comm Port.exe</p>
</td>
</tr>
</tbody>
</table>
### Build Tools for Linux<a name="section17315193935817"></a>
The following table describes the tools required for setting up the general environment for a Linux server and how to obtain these tools.
**Table 2** Development tools and obtaining methods
<a name="table15485545145811"></a>
<table><thead align="left"><tr id="row1748610451588"><th class="cellrowborder" valign="top" width="13.081308130813083%" id="mcps1.2.4.1.1"><p id="p13486154545816"><a name="p13486154545816"></a><a name="p13486154545816"></a>Development Tool</p>
</th>
<th class="cellrowborder" valign="top" width="19.921992199219922%" id="mcps1.2.4.1.2"><p id="p44867452589"><a name="p44867452589"></a><a name="p44867452589"></a>Description</p>
</th>
<th class="cellrowborder" valign="top" width="66.996699669967%" id="mcps1.2.4.1.3"><p id="p1748619458583"><a name="p1748619458583"></a><a name="p1748619458583"></a>How to Obtain</p>
</th>
</tr>
</thead>
<tbody><tr id="row1948614518582"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p9486154516582"><a name="p9486154516582"></a><a name="p9486154516582"></a>Python3.7+</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p74861645105812"><a name="p74861645105812"></a><a name="p74861645105812"></a>Runs the compilation scripts.</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p11486194575814"><a name="p11486194575814"></a><a name="p11486194575814"></a><a href="https://www.python.org/ftp/python/3.8.5/Python-3.8.5.tgz" target="_blank" rel="noopener noreferrer">https://www.python.org/ftp/python/3.8.5/Python-3.8.5.tgz</a></p>
</td>
</tr>
<tr id="row1248714455582"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p1548774535814"><a name="p1548774535814"></a><a name="p1548774535814"></a>bash</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p18487134595817"><a name="p18487134595817"></a><a name="p18487134595817"></a>Executes commands.</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p184871645105816"><a name="p184871645105816"></a><a name="p184871645105816"></a>Internet</p>
</td>
</tr>
<tr id="row148784525817"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p10487345115817"><a name="p10487345115817"></a><a name="p10487345115817"></a>gn</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p348724585820"><a name="p348724585820"></a><a name="p348724585820"></a>Generates ninja compilation scripts.</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p194878454589"><a name="p194878454589"></a><a name="p194878454589"></a><a href="https://repo.huaweicloud.com/harmonyos/compiler/gn/1523/linux/gn.1523.tar" target="_blank" rel="noopener noreferrer">https://repo.huaweicloud.com/harmonyos/compiler/gn/1523/linux/gn.1523.tar</a></p>
</td>
</tr>
<tr id="row184874451585"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p174871045105814"><a name="p174871045105814"></a><a name="p174871045105814"></a>ninja</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p204871645145811"><a name="p204871645145811"></a><a name="p204871645145811"></a>Executes ninja compilation scripts.</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p184871245135810"><a name="p184871245135810"></a><a name="p184871245135810"></a><a href="https://repo.huaweicloud.com/harmonyos/compiler/ninja/1.9.0/linux/ninja.1.9.0.tar" target="_blank" rel="noopener noreferrer">https://repo.huaweicloud.com/harmonyos/compiler/ninja/1.9.0/linux/ninja.1.9.0.tar</a></p>
</td>
</tr>
<tr id="row12487154515585"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p1348713452581"><a name="p1348713452581"></a><a name="p1348713452581"></a>LLVM</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p648774510589"><a name="p648774510589"></a><a name="p648774510589"></a>Functions as the compiler toolchain.</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p148719454586"><a name="p148719454586"></a><a name="p148719454586"></a><a href="https://repo.huaweicloud.com/harmonyos/compiler/clang/9.0.0-34042/linux/llvm-linux-9.0.0-34042.tar" target="_blank" rel="noopener noreferrer">https://repo.huaweicloud.com/harmonyos/compiler/clang/9.0.0-34042/linux/llvm-linux-9.0.0-34042.tar</a></p>
</td>
</tr>
<tr id="row1548710453586"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p15487114585814"><a name="p15487114585814"></a><a name="p15487114585814"></a>hc-gen</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p148719452588"><a name="p148719452588"></a><a name="p148719452588"></a>Configures and compiles files.</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p1487164565819"><a name="p1487164565819"></a><a name="p1487164565819"></a><a href="https://repo.huaweicloud.com/harmonyos/compiler/hc-gen/0.65/linux/hc-gen-0.65-linux.tar" target="_blank" rel="noopener noreferrer">https://repo.huaweicloud.com/harmonyos/compiler/hc-gen/0.65/linux/hc-gen-0.65-linux.tar</a></p>
</td>
</tr>
<tr id="row248764585810"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p1848711459584"><a name="p1848711459584"></a><a name="p1848711459584"></a>IPOP, PuTTY, or HyperTerminal</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p7487745125819"><a name="p7487745125819"></a><a name="p7487745125819"></a>Connects to the Linux server (choose one of the terminals).</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p18487154516584"><a name="p18487154516584"></a><a name="p18487154516584"></a>Public internet (for example, <a href="https://www.putty.org/" target="_blank" rel="noopener noreferrer">https://www.putty.org/</a>)</p>
</td>
</tr>
</tbody>
</table>
### Development Tools for Windows<a name="section1897593723017"></a>
**Table 3** Development tools for the Windows workstation
<a name="en-us_topic_0000001054501981_table1313323311274"></a>
<table><thead align="left"><tr id="en-us_topic_0000001054501981_row3133133312711"><th class="cellrowborder" valign="top" width="16.371637163716375%" id="mcps1.2.4.1.1"><p id="en-us_topic_0000001054501981_p16132203372716"><a name="en-us_topic_0000001054501981_p16132203372716"></a><a name="en-us_topic_0000001054501981_p16132203372716"></a>Development Tool</p>
</th>
<th class="cellrowborder" valign="top" width="50.29502950295029%" id="mcps1.2.4.1.2"><p id="en-us_topic_0000001054501981_p1413219339278"><a name="en-us_topic_0000001054501981_p1413219339278"></a><a name="en-us_topic_0000001054501981_p1413219339278"></a>Description</p>
</th>
<th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.2.4.1.3"><p id="en-us_topic_0000001054501981_p17133183312711"><a name="en-us_topic_0000001054501981_p17133183312711"></a><a name="en-us_topic_0000001054501981_p17133183312711"></a>How to Obtain</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0000001054501981_row13697410143219"><td class="cellrowborder" valign="top" width="16.371637163716375%" headers="mcps1.2.4.1.1 "><p id="en-us_topic_0000001054501981_p163612016916"><a name="en-us_topic_0000001054501981_p163612016916"></a><a name="en-us_topic_0000001054501981_p163612016916"></a>Visual Studio Code</p>
</td>
<td class="cellrowborder" valign="top" width="50.29502950295029%" headers="mcps1.2.4.1.2 "><p id="en-us_topic_0000001054501981_p1563690791"><a name="en-us_topic_0000001054501981_p1563690791"></a><a name="en-us_topic_0000001054501981_p1563690791"></a>Edits codes.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="en-us_topic_0000001054501981_p146361701097"><a name="en-us_topic_0000001054501981_p146361701097"></a><a name="en-us_topic_0000001054501981_p146361701097"></a><a href="https://code.visualstudio.com/" target="_blank" rel="noopener noreferrer">https://code.visualstudio.com/</a></p>
</td>
</tr>
<tr id="en-us_topic_0000001054501981_row12133123315277"><td class="cellrowborder" valign="top" width="16.371637163716375%" headers="mcps1.2.4.1.1 "><p id="en-us_topic_0000001054501981_p613393317271"><a name="en-us_topic_0000001054501981_p613393317271"></a><a name="en-us_topic_0000001054501981_p613393317271"></a>HUAWEI DevEco Device Tool</p>
</td>
<td class="cellrowborder" valign="top" width="50.29502950295029%" headers="mcps1.2.4.1.2 "><p id="en-us_topic_0000001054501981_p10133193310276"><a name="en-us_topic_0000001054501981_p10133193310276"></a><a name="en-us_topic_0000001054501981_p10133193310276"></a>Functions as the integrated development environment (IDE) to provide code compilation, burning, and debugging. C and C++ languages are supported.</p>
<div class="note" id="en-us_topic_0000001054501981_note7133193392718"><a name="en-us_topic_0000001054501981_note7133193392718"></a><a name="en-us_topic_0000001054501981_note7133193392718"></a><span class="notetitle"> NOTE: </span><div class="notebody"><p id="en-us_topic_0000001054501981_p1133183310277"><a name="en-us_topic_0000001054501981_p1133183310277"></a><a name="en-us_topic_0000001054501981_p1133183310277"></a>HUAWEI DevEco Device Tool is a one-stop IDE provided by <span id="en-us_topic_0000001054501981_text4133533192719"><a name="en-us_topic_0000001054501981_text4133533192719"></a><a name="en-us_topic_0000001054501981_text4133533192719"></a>OpenHarmony</span> for smart device developers. You can customize <span id="en-us_topic_0000001054501981_text14536110256"><a name="en-us_topic_0000001054501981_text14536110256"></a><a name="en-us_topic_0000001054501981_text14536110256"></a>OpenHarmony</span> components on it as required, HUAWEI DevEco Device Tool is deployed on Visual Studio Code as a plug-in.</p>
</div></div>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="en-us_topic_0000001054501981_p16788135433519"><a name="en-us_topic_0000001054501981_p16788135433519"></a><a name="en-us_topic_0000001054501981_p16788135433519"></a><a href="https://device.harmonyos.com/en/ide" target="_blank" rel="noopener noreferrer">https://device.harmonyos.com/en/ide</a></p>
</td>
</tr>
</tbody>
</table>
## Using Docker to Install the Linux Environment<a name="section4848141175215"></a>
You can use Docker to quickly install the Linux environment. For details, see **Setting Up the Docker Environment** in [Using Docker to Prepare the Build Environment](../get-code/tool-acquisition.md).
## Installing the Linux Environment Using an Installation Package<a name="section8831868501"></a>
>![](public_sys-resources/icon-notice.gif) **NOTICE:**
>- If you acquire the source code using an HPM component or HPM CLI tool, compilation tools like **gn**, **ninja**, **LLVM**, and **hc-gen** are not required.
>- \(Recommended\) If you obtain the source code through an image site or a code repository, compilation tools like **gn**, **ninja**, **LLVM**, and **hc-gen** need to be installed. When installing **gn**, **ninja**, **LLVM**, and **hc-gen**, ensure that the environment variable paths of the compilation tools are unique.
### Connecting to a Linux Server<a name="section12584112413505"></a>
Using PuTTY to log in to a Linux server from a PC running Windows
1. Open [PuTTY](https://www.putty.org/), enter the IP address of the Linux server, and click **Open**.
**Figure 2** PuTTY configuration<a name="en-us_topic_0000001054781998_f825e6d7569cc487db9b744e454c7157a"></a>
![](figures/putty-configuration.png "putty-configuration")
2. Click **Yes** in the PuTTY **Security Alert** dialog box.
3. Enter the account and password.
**Figure 3** Login<a name="en-us_topic_0000001054781998_fe1428afffbdd45f9b4a39497691ff5ff"></a>
![](figures/login.png "login")
4. The login is successful.
**Figure 4** Successful login<a name="en-us_topic_0000001054781998_f11bea69483e14bd39fef4a10b1ed1a3a"></a>
![](figures/successful-login.png "successful-login")
### Changing Linux Shell to Bash<a name="section21811833145019"></a>
Check whether bash is used as the shell.
```
ls -l /bin/sh
```
If **/bin/sh -\> bash** is not displayed, do as follows to change shell to bash.
**Method 1:** Run the following command on the device and then click **No**.
```
sudo dpkg-reconfigure dash
```
**Method 2:** Run the first command to delete sh and then run the second command to create a new soft link.
```
sudo rm -rf /bin/sh
sudo ln -s /bin/bash /bin/sh
```
### Installing a Python Environment<a name="section10807183719500"></a>
1. Start a Linux server.
2. Check the Python version \(Python 3.7 or later is required\).
```
python3 --version
```
If the Python version is earlier than 3.7, reinstall a later Python version \(for example, Python 3.8\) as follows:
1. Check the Ubuntu version.
```
cat /etc/issue
```
1. Install Python based on the Ubuntu version.
- If the Ubuntu version is 18 or later, run the following command:
```
sudo apt-get install python3.8
```
- If the Ubuntu version is 16, download the installation package and install Python.
1. Install Python environment dependencies \(gcc, g++, make, zlib, libffi\).
```
sudo apt-get install gcc && sudo apt-get install g++ && sudo apt-get install make && sudo apt-get install zlib* && sudo apt-get install libffi-dev
```
1. Obtain the [Python3.8.5 installation package](https://www.python.org/ftp/python/3.8.5/Python-3.8.5.tgz), save it to the Linux server, and run the following command:
```
tar -xvzf Python-3.8.5.tgz && cd Python-3.8.5 && sudo ./configure && sudo make && sudo make install
```
3. After Python is installed, link the Python path to **/usr/bin/python**.
Check whether Python is soft linked to Python 3.8.
```
python --version
```
If the command output is not **python 3.8.5**, run the following command to check the directory where Python 3.8 is stored:
```
which python3.8
```
Replace **python3.8-path** in the following command with the output path of the **which python3.8** command.
```
cd /usr/bin && sudo rm python && sudo rm python3 && sudo ln -s python3.8-path python && sudo ln -s python3.8-path python3 && python3 --version && python --version
```
4. Install and upgrade the Python package management tool \(pip3\) using either of the following methods:
- **Command line:**
```
sudo apt-get install python3-setuptools python3-pip -y
sudo pip3 install --upgrade pip
```
- **Installation package:**
```
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
python get-pip.py
```
5. Install setuptools.
```
pip3 install setuptools
```
6. Install the GUI menuconfig tool \(Kconfiglib\). You are advised to install Kconfiglib 13.2.0 or later.
- **Command line:**
```
sudo pip3 install kconfiglib
```
- **Installation package:**
1. Download the **.whl** file \(for example, **kconfiglib-13.2.0-py2.py3-none-any.whl**\).
Download path: [https://pypi.org/project/kconfiglib\#files](https://pypi.org/project/kconfiglib#files)
1. Install the **.whl** file.
```
sudo pip3 install kconfiglib-13.2.0-py2.py3-none-any.whl
```
### Installing a File Packing Tool<a name="section480195453419"></a>
1. Start a Linux server.
2. Install **dosfstools**.
```
sudo apt-get install dosfstools
```
3. Install **mtools**.
```
sudo apt-get install mtools
```
4. Install **mtd-utils**.
```
sudo apt-get install mtd-utils
```
### Installing gn<a name="section16725103716357"></a>
1. Start a Linux server.
2. Download [gn](https://repo.huaweicloud.com/harmonyos/compiler/gn/1523/linux/gn.1523.tar).
3. Decompress the gn installation package to **\~/gn**.
```
tar -xvf gn.1523.tar -C ~/
```
4. Set an environment variable.
```
vim ~/.bashrc
```
Copy the following command to the last line of the **.bashrc** file, save the file, and exit.
```
export PATH=~/gn:$PATH
```
5. Validate the environment variable.
```
source ~/.bashrc
```
### Installing ninja<a name="section156834539351"></a>
1. Start a Linux server.
2. Download [ninja](https://repo.huaweicloud.com/harmonyos/compiler/ninja/1.9.0/linux/ninja.1.9.0.tar).
3. Decompress the ninja installation package to **\~/ninja**.
```
tar -xvf ninja.1.9.0.tar -C ~/
```
4. Set an environment variable.
```
vim ~/.bashrc
```
Copy the following command to the last line of the **.bashrc** file, save the file, and exit.
```
export PATH=~/ninja:$PATH
```
5. Validate the environment variable.
```
source ~/.bashrc
```
### Installing LLVM<a name="section11739111964114"></a>
1. Start a Linux server.
2. Download [LLVM](http://tools.harmonyos.com/mirrors/clang/9.0.0-34042/linux/llvm-linux-9.0.0-34042.tar).
3. Decompress the LLVM installation package to **\~/llvm**.
```
tar -xvf llvm-linux-9.0.0-34042.tar -C ~/
```
4. Set an environment variable.
```
vim ~/.bashrc
```
Copy the following command to the last line of the **.bashrc** file, save the file, and exit.
```
export PATH=~/llvm/bin:$PATH
```
5. Validate the environment variable.
```
source ~/.bashrc
```
### Installing hc-gen<a name="section351420104218"></a>
1. Start a Linux server.
2. Download [hc-gen](https://repo.huaweicloud.com/harmonyos/compiler/hc-gen/0.65/linux/hc-gen-0.65-linux.tar).
3. Decompress the hc-gen installation package to **\~/hc-gen** on the Linux server.
```
tar -xvf hc-gen-0.65-linux.tar -C ~/
```
4. Set an environment variable.
```
vim ~/.bashrc
```
Copy the following command to the last line of the **.bashrc** file, save the file, and exit.
```
export PATH=~/hc-gen:$PATH
```
5. Validate the environment variable.
```
source ~/.bashrc
```
## Installing a Windows Development Environment<a name="section188621583120"></a>
The OpenHarmony IDE Development Tool \(HUAWEI DevEco Device Tool\) integrates the capabilities of terminal tools. For details about how to install the tool, see [Preparations ](https://device.harmonyos.com/en/docs/ide/user-guides/tool_install-0000001050164976)and [Importing and Configuring a Project](https://device.harmonyos.com/en/docs/ide/user-guides/import_project-0000001050164980).
docs-en/quick-start/setting-up-the-hi3861-development-environment.md 0 → 100644
浏览文件 @ 37cc208b
# Setting Up the Hi3861 Development Environment<a name="EN-US_TOPIC_0000001054781998"></a>
- [Environment Requirements](#section466851916410)
- [Software Requirements](#section1595725202314)
- [Build Tools for Linux](#section992619473117)
- [Development Tools for Windows](#section2833173411317)
- [Using Docker to Install the Linux Environment](#section107932281315)
- [Using an Installation Package to install the Linux Environment](#section497484245614)
- [Connecting to a Linux Server](#section1565413132610)
- [Changing Linux Shell to Bash](#section1715027152617)
- [Installing a Python Environment](#section18835251192618)
- [Installing Scons](#section13515123015279)
- [Installing gn](#section0646125972716)
- [Installing ninja](#section7681117192813)
- [Installing gcc\_riscv32 \(Compilation Toolchain for WLAN Module\)](#section1842910288284)
- [Installing a Windows Development Environment](#section1995840162515)
## Environment Requirements<a name="section466851916410"></a>
### Software Requirements<a name="section1595725202314"></a>
**Table 1** Requirements on the development platform
<a name="table1822785713303"></a>
<table><thead align="left"><tr id="row72271157163014"><th class="cellrowborder" valign="top" width="12.41%" id="mcps1.2.5.1.1"><p id="p17227205711305"><a name="p17227205711305"></a><a name="p17227205711305"></a>Hardware</p>
</th>
<th class="cellrowborder" valign="top" width="12.389999999999999%" id="mcps1.2.5.1.2"><p id="p112271557113019"><a name="p112271557113019"></a><a name="p112271557113019"></a>Software</p>
</th>
<th class="cellrowborder" valign="top" width="46.21%" id="mcps1.2.5.1.3"><p id="p16227105718309"><a name="p16227105718309"></a><a name="p16227105718309"></a>Description</p>
</th>
<th class="cellrowborder" valign="top" width="28.99%" id="mcps1.2.5.1.4"><p id="p162271957163018"><a name="p162271957163018"></a><a name="p162271957163018"></a>Remarks</p>
</th>
</tr>
</thead>
<tbody><tr id="row16227157163014"><td class="cellrowborder" valign="top" width="12.41%" headers="mcps1.2.5.1.1 "><p id="p1222775733020"><a name="p1222775733020"></a><a name="p1222775733020"></a>Linux compile server</p>
</td>
<td class="cellrowborder" valign="top" width="12.389999999999999%" headers="mcps1.2.5.1.2 "><p id="p22272577304"><a name="p22272577304"></a><a name="p22272577304"></a>Operating system</p>
</td>
<td class="cellrowborder" valign="top" width="46.21%" headers="mcps1.2.5.1.3 "><p id="p622719576305"><a name="p622719576305"></a><a name="p622719576305"></a>Ubuntu 16.04 64-bit server or later (Use bash as the shell.)</p>
</td>
<td class="cellrowborder" rowspan="2" valign="top" width="28.99%" headers="mcps1.2.5.1.4 "><p id="p162276579305"><a name="p162276579305"></a><a name="p162276579305"></a>You can develop programs on the Windows workstation or Linux server via a remote login.</p>
</td>
</tr>
<tr id="row5227165719305"><td class="cellrowborder" valign="top" headers="mcps1.2.5.1.1 "><p id="p32279578305"><a name="p32279578305"></a><a name="p32279578305"></a>Windows workstation</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.5.1.2 "><p id="p192271757133018"><a name="p192271757133018"></a><a name="p192271757133018"></a>Operating system</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.5.1.3 "><p id="p1022855713303"><a name="p1022855713303"></a><a name="p1022855713303"></a>Windows XP/Windows7/Windows10</p>
</td>
</tr>
</tbody>
</table>
### Build Tools for Linux<a name="section992619473117"></a>
The following table describes the tools required for setting up the general environment for a Linux server and how to obtain these tools.
**Table 2** Development tools and obtaining methods
<a name="table6299192712513"></a>
<table><thead align="left"><tr id="row122993276512"><th class="cellrowborder" valign="top" width="25.562556255625562%" id="mcps1.2.4.1.1"><p id="p1829914271858"><a name="p1829914271858"></a><a name="p1829914271858"></a>Development Tool</p>
</th>
<th class="cellrowborder" valign="top" width="20.7020702070207%" id="mcps1.2.4.1.2"><p id="p429918274517"><a name="p429918274517"></a><a name="p429918274517"></a>Description</p>
</th>
<th class="cellrowborder" valign="top" width="53.73537353735374%" id="mcps1.2.4.1.3"><p id="p12997271757"><a name="p12997271757"></a><a name="p12997271757"></a>How to Obtain</p>
</th>
</tr>
</thead>
<tbody><tr id="row1829915274517"><td class="cellrowborder" valign="top" width="25.562556255625562%" headers="mcps1.2.4.1.1 "><p id="p1629902717511"><a name="p1629902717511"></a><a name="p1629902717511"></a>gcc_riscv32</p>
</td>
<td class="cellrowborder" valign="top" width="20.7020702070207%" headers="mcps1.2.4.1.2 "><p id="p1219863434519"><a name="p1219863434519"></a><a name="p1219863434519"></a>Executes script cross compilation.</p>
</td>
<td class="cellrowborder" valign="top" width="53.73537353735374%" headers="mcps1.2.4.1.3 "><p id="p14145637348"><a name="p14145637348"></a><a name="p14145637348"></a><a href="https://repo.huaweicloud.com/harmonyos/compiler/gcc_riscv32/7.3.0/linux/gcc_riscv32-linux-7.3.0.tar.gz" target="_blank" rel="noopener noreferrer">https://repo.huaweicloud.com/harmonyos/compiler/gcc_riscv32/7.3.0/linux/gcc_riscv32-linux-7.3.0.tar.gz</a></p>
</td>
</tr>
<tr id="row430016273514"><td class="cellrowborder" valign="top" width="25.562556255625562%" headers="mcps1.2.4.1.1 "><p id="p330015271158"><a name="p330015271158"></a><a name="p330015271158"></a>Python3.7+</p>
</td>
<td class="cellrowborder" valign="top" width="20.7020702070207%" headers="mcps1.2.4.1.2 "><p id="p43003270510"><a name="p43003270510"></a><a name="p43003270510"></a>Executes script compilation.</p>
</td>
<td class="cellrowborder" valign="top" width="53.73537353735374%" headers="mcps1.2.4.1.3 "><p id="p18254155164617"><a name="p18254155164617"></a><a name="p18254155164617"></a><a href="https://www.python.org/ftp/python/3.8.5/Python-3.8.5.tgz" target="_blank" rel="noopener noreferrer">https://www.python.org/ftp/python/3.8.5/Python-3.8.5.tgz</a></p>
</td>
</tr>
<tr id="row1397335913612"><td class="cellrowborder" valign="top" width="25.562556255625562%" headers="mcps1.2.4.1.1 "><p id="p097355911620"><a name="p097355911620"></a><a name="p097355911620"></a>SCons3.0.4+</p>
</td>
<td class="cellrowborder" valign="top" width="20.7020702070207%" headers="mcps1.2.4.1.2 "><p id="p1973195917619"><a name="p1973195917619"></a><a name="p1973195917619"></a>Executes script compilation.</p>
</td>
<td class="cellrowborder" valign="top" width="53.73537353735374%" headers="mcps1.2.4.1.3 "><p id="p1722663441514"><a name="p1722663441514"></a><a name="p1722663441514"></a>Internet</p>
</td>
</tr>
<tr id="row42668197206"><td class="cellrowborder" valign="top" width="25.562556255625562%" headers="mcps1.2.4.1.1 "><p id="p426711912014"><a name="p426711912014"></a><a name="p426711912014"></a>bash</p>
</td>
<td class="cellrowborder" valign="top" width="20.7020702070207%" headers="mcps1.2.4.1.2 "><p id="p14267131962014"><a name="p14267131962014"></a><a name="p14267131962014"></a>Executes commands.</p>
</td>
<td class="cellrowborder" valign="top" width="53.73537353735374%" headers="mcps1.2.4.1.3 "><p id="p14267101962014"><a name="p14267101962014"></a><a name="p14267101962014"></a>Internet</p>
</td>
</tr>
<tr id="row1463517494402"><td class="cellrowborder" valign="top" width="25.562556255625562%" headers="mcps1.2.4.1.1 "><p id="p258814561424"><a name="p258814561424"></a><a name="p258814561424"></a>build-essential</p>
</td>
<td class="cellrowborder" valign="top" width="20.7020702070207%" headers="mcps1.2.4.1.2 "><p id="p1749611716181"><a name="p1749611716181"></a><a name="p1749611716181"></a>Provides basic software package for compilation.</p>
</td>
<td class="cellrowborder" valign="top" width="53.73537353735374%" headers="mcps1.2.4.1.3 "><p id="p8635174916403"><a name="p8635174916403"></a><a name="p8635174916403"></a>Internet</p>
</td>
</tr>
<tr id="row1711946154018"><td class="cellrowborder" valign="top" width="25.562556255625562%" headers="mcps1.2.4.1.1 "><p id="p15588165684216"><a name="p15588165684216"></a><a name="p15588165684216"></a>gn</p>
</td>
<td class="cellrowborder" valign="top" width="20.7020702070207%" headers="mcps1.2.4.1.2 "><p id="p4588135634213"><a name="p4588135634213"></a><a name="p4588135634213"></a>Generates ninja compilation scripts.</p>
</td>
<td class="cellrowborder" valign="top" width="53.73537353735374%" headers="mcps1.2.4.1.3 "><p id="p10572194318318"><a name="p10572194318318"></a><a name="p10572194318318"></a><a href="https://repo.huaweicloud.com/harmonyos/compiler/gn/1523/linux/gn.1523.tar" target="_blank" rel="noopener noreferrer">https://repo.huaweicloud.com/harmonyos/compiler/gn/1523/linux/gn.1523.tar</a></p>
</td>
</tr>
<tr id="row16990164213404"><td class="cellrowborder" valign="top" width="25.562556255625562%" headers="mcps1.2.4.1.1 "><p id="p1858825613428"><a name="p1858825613428"></a><a name="p1858825613428"></a>ninja</p>
</td>
<td class="cellrowborder" valign="top" width="20.7020702070207%" headers="mcps1.2.4.1.2 "><p id="p15844174611816"><a name="p15844174611816"></a><a name="p15844174611816"></a>Executes ninja compilation scripts.</p>
</td>
<td class="cellrowborder" valign="top" width="53.73537353735374%" headers="mcps1.2.4.1.3 "><p id="p1923373393515"><a name="p1923373393515"></a><a name="p1923373393515"></a><a href="https://repo.huaweicloud.com/harmonyos/compiler/ninja/1.9.0/linux/ninja.1.9.0.tar" target="_blank" rel="noopener noreferrer">https://repo.huaweicloud.com/harmonyos/compiler/ninja/1.9.0/linux/ninja.1.9.0.tar</a></p>
</td>
</tr>
</tbody>
</table>
### Development Tools for Windows<a name="section2833173411317"></a>
**Table 3** Development tools and obtaining methods
<a name="table1313323311274"></a>
<table><thead align="left"><tr id="row3133133312711"><th class="cellrowborder" valign="top" width="16.371637163716375%" id="mcps1.2.4.1.1"><p id="p16132203372716"><a name="p16132203372716"></a><a name="p16132203372716"></a>Development Tool</p>
</th>
<th class="cellrowborder" valign="top" width="50.29502950295029%" id="mcps1.2.4.1.2"><p id="p1413219339278"><a name="p1413219339278"></a><a name="p1413219339278"></a>Description</p>
</th>
<th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.2.4.1.3"><p id="p17133183312711"><a name="p17133183312711"></a><a name="p17133183312711"></a>How to Obtain</p>
</th>
</tr>
</thead>
<tbody><tr id="row138432533451"><td class="cellrowborder" valign="top" width="16.371637163716375%" headers="mcps1.2.4.1.1 "><p id="p163612016916"><a name="p163612016916"></a><a name="p163612016916"></a>Visual Studio Code</p>
</td>
<td class="cellrowborder" valign="top" width="50.29502950295029%" headers="mcps1.2.4.1.2 "><p id="p1563690791"><a name="p1563690791"></a><a name="p1563690791"></a>Edits code.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="p146361701097"><a name="p146361701097"></a><a name="p146361701097"></a><a href="https://code.visualstudio.com/" target="_blank" rel="noopener noreferrer">https://code.visualstudio.com/</a></p>
</td>
</tr>
<tr id="row12133123315277"><td class="cellrowborder" valign="top" width="16.371637163716375%" headers="mcps1.2.4.1.1 "><p id="p613393317271"><a name="p613393317271"></a><a name="p613393317271"></a>HUAWEI DevEco Device Tool</p>
</td>
<td class="cellrowborder" valign="top" width="50.29502950295029%" headers="mcps1.2.4.1.2 "><p id="p10133193310276"><a name="p10133193310276"></a><a name="p10133193310276"></a>Supports code editing, compilation, burning, and debugging.</p>
<div class="note" id="note7133193392718"><a name="note7133193392718"></a><a name="note7133193392718"></a><span class="notetitle"> NOTE: </span><div class="notebody"><p id="p1133183310277"><a name="p1133183310277"></a><a name="p1133183310277"></a>HUAWEI DevEco Device Tool is a one-stop integrated development environment (IDE) provided for developers of <span id="text4133533192719"><a name="text4133533192719"></a><a name="text4133533192719"></a>OpenHarmony</span>-based smart devices. It supports C and C++ languages and is installed in Visual Studio Code as a plug-in.</p>
</div></div>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="p1240954393114"><a name="p1240954393114"></a><a name="p1240954393114"></a><a href="https://device.harmonyos.com/en/ide" target="_blank" rel="noopener noreferrer">https://device.harmonyos.com/en/ide</a></p>
</td>
</tr>
<tr id="row18342145821513"><td class="cellrowborder" valign="top" width="16.371637163716375%" headers="mcps1.2.4.1.1 "><p id="p123421958131517"><a name="p123421958131517"></a><a name="p123421958131517"></a>PuTTY, or other HyperTerminal</p>
</td>
<td class="cellrowborder" valign="top" width="50.29502950295029%" headers="mcps1.2.4.1.2 "><p id="p18342658131511"><a name="p18342658131511"></a><a name="p18342658131511"></a>Remotely connects to a Linux compile server or a serial port.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="p17342125851518"><a name="p17342125851518"></a><a name="p17342125851518"></a>Internet (for example, <a href="https://www.putty.org/" target="_blank" rel="noopener noreferrer">https://www.putty.org/</a>)</p>
</td>
</tr>
<tr id="row244884215147"><td class="cellrowborder" valign="top" width="16.371637163716375%" headers="mcps1.2.4.1.1 "><p id="p1044974291416"><a name="p1044974291416"></a><a name="p1044974291416"></a>CH341SER.EXE</p>
</td>
<td class="cellrowborder" valign="top" width="50.29502950295029%" headers="mcps1.2.4.1.2 "><p id="p94491342131413"><a name="p94491342131413"></a><a name="p94491342131413"></a>Identifies serial port device to transmit data.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="p6449184214148"><a name="p6449184214148"></a><a name="p6449184214148"></a><a href="http://www.wch-ic.com/downloads/CH341SER_EXE.html" target="_blank" rel="noopener noreferrer">http://www.wch-ic.com/downloads/CH341SER_EXE.html</a></p>
</td>
</tr>
</tbody>
</table>
## Using Docker to Install the Linux Environment<a name="section107932281315"></a>
You can use Docker to quickly install the Linux environment. For details, see **Setting Up the Docker Environment** in [Using Docker to Prepare the Build Environment](../get-code/tool-acquisition.md).
## Using an Installation Package to install the Linux Environment<a name="section497484245614"></a>
>![](public_sys-resources/icon-notice.gif) **NOTICE:**
>- If you acquire the source code using an HPM component or HPM CLI tool, compilation tools like **gn**, **ninja**, **gcc\_riscv32** are not required.
>- \(Recommended\) If you obtain the source code via the mirror site or code repository, install compilation tools such as **gn**, **ninja**, and **gcc\_riscv32**.
> When installing **gn**, **ninja**, and **gcc\_riscv32**, ensure that the environment variable paths of the compilation tools are unique.
### Connecting to a Linux Server<a name="section1565413132610"></a>
Using PuTTY to log in to a Linux server from a PC running Windows
1. Open [PuTTY](https://www.putty.org/), enter the IP address of the Linux server, and click **Open**.
**Figure 1** PuTTY configuration<a name="f825e6d7569cc487db9b744e454c7157a"></a>
![](figures/putty-configuration.png "putty-configuration")
2. Click **Yes** in the PuTTY **Security Alert** dialog box.
3. Enter the account and password.
**Figure 2** Login<a name="fe1428afffbdd45f9b4a39497691ff5ff"></a>
![](figures/login.png "login")
4. The login is successful.
**Figure 3** Successful login<a name="f11bea69483e14bd39fef4a10b1ed1a3a"></a>
![](figures/successful-login.png "successful-login")
### Changing Linux Shell to Bash<a name="section1715027152617"></a>
Check whether bash is used as the shell.
```
ls -l /bin/sh
```
If **/bin/sh -\> bash** is not displayed, do as follows to change shell to bash.
**Method 1:** Run the following command on the device and then click **No**.
```
sudo dpkg-reconfigure dash
```
**Method 2:** Run the first command to delete sh and then run the second command to create a new soft link.
```
sudo rm -rf /bin/sh
sudo ln -s /bin/bash /bin/sh
```
### Installing a Python Environment<a name="section18835251192618"></a>
1. Start a Linux server.
2. Check the Python version \(Python 3.7 or later is required\).
```
python3 --version
```
If the Python version is earlier than 3.7, reinstall a later Python version \(for example, Python 3.8\) as follows:
1. Check the Ubuntu version.
```
cat /etc/issue
```
1. Install Python based on the Ubuntu version.
- If the Ubuntu version is 18 or later, run the following command:
```
sudo apt-get install python3.8
```
- If the Ubuntu version is 16, download the installation package and install Python.
1. Install Python environment dependencies \(gcc, g++, make, zlib, libffi\).
```
sudo apt-get install gcc && sudo apt-get install g++ && sudo apt-get install make && sudo apt-get install zlib* && sudo apt-get install libffi-dev
```
1. Obtain the [Python3.8.5 installation package](https://www.python.org/ftp/python/3.8.5/Python-3.8.5.tgz), save it to the Linux server, and run the following command:
```
tar -xvzf Python-3.8.5.tgz && cd Python-3.8.5 && sudo ./configure && sudo make && sudo make install
```
3. After Python is installed, link the Python path to **/usr/bin/python**.
Check whether Python is soft linked to Python 3.8.
```
python --version
```
If the command output is not **python 3.8.5**, run the following command to check the directory where Python 3.8 is stored:
```
which python3.8
```
Replace **python3.8-path** in the following command with the output path of the **which python3.8** command.
```
cd /usr/bin && sudo rm python && sudo rm python3 && sudo ln -s python3.8-path python && sudo ln -s python3.8-path python3 && python3 --version && python --version
```
4. Install and upgrade the Python package management tool \(pip3\) using either of the following methods:
- **Command line:**
```
sudo apt-get install python3-setuptools python3-pip -y
sudo pip3 install --upgrade pip
```
- **Installation package:**
```
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
python get-pip.py
```
5. Install setuptools.
```
pip3 install setuptools
```
6. Install the GUI menuconfig tool \(Kconfiglib\). You are advised to install Kconfiglib 13.2.0 or later.
- **Command line:**
```
sudo pip3 install kconfiglib
```
- **Installation package:**
1. Download the **.whl** file \(for example, **kconfiglib-13.2.0-py2.py3-none-any.whl**\).
Download path: [https://pypi.org/project/kconfiglib\#files](https://pypi.org/project/kconfiglib#files)
1. Install the **.whl** file.
```
sudo pip3 install kconfiglib-13.2.0-py2.py3-none-any.whl
```
7. Install **pycryptodome** using either of the following methods:
Install the Python component packages on which the file signature depends, including pycryptodome, six, and ecdsa. As the installation of **ecdsa** depends on that of **six**, install **six** first.
- **Command line:**
```
sudo pip3 install pycryptodome
```
- **Installation package:**
1. Download the **.whl** file, for example, **pycryptodome-3.9.9-cp38-cp38-manylinux1\_x86\_64.whl**, from [https://pypi.org/project/pycryptodome/\#files](https://pypi.org/project/pycryptodome/#files).
1. Install the **.whl** file.
```
sudo pip3 install pycryptodome-3.9.9-cp38-cp38-manylinux1_x86_64.whl
```
8. Install **six** using either of the following methods:
- **Command line:**
```
sudo pip3 install six --upgrade --ignore-installed six
```
- **Installation package:**
1. Download the **.whl** file, for example, **six-1.12.0-py2.py3-none-any.whl** from [https://pypi.org/project/six/\#files](https://pypi.org/project/six/#files).
1. Install the **.whl** file.
```
sudo pip3 install six-1.12.0-py2.py3-none-any.whl
```
9. Install **ecdsa** using either of the following methods:
- **Command line:**
```
sudo pip3 install ecdsa
```
- **Installation package:**
1. Download the **.whl** file, for example, **ecdsa-0.14.1-py2.py3-none-any.whl** from [https://pypi.org/project/ecdsa/\#files](https://pypi.org/project/ecdsa/#files).
1. Install the **.whl** file.
```
sudo pip3 install ecdsa-0.14.1-py2.py3-none-any.whl
```
### Installing Scons<a name="section13515123015279"></a>
1. Start a Linux server.
2. Install the SCons installation package.
```
sudo apt-get install scons -y
```
If the installation package cannot be found in the software source, do as follows:
1. Download the source code package from [https://scons.org/pages/download.html](https://scons.org/pages/download.html). The recommended SCons version is 3.0.4 or later.
2. Decompress the source code package to any directory, for example, scons-3.1.2.
```
tar -xvf scons-3.1.2.tar.gz
```
3. Go to the source code directory and run the following command to install the source code package:
```
sudo python3 setup.py install
```
3. Check whether the installation is successful.
```
scons -v
```
**Figure 4** Successful installation<a name="fig235815252492"></a>
![](figures/successful-installation.png "successful-installation")
### Installing gn<a name="section0646125972716"></a>
1. Start a Linux server.
2. Download [gn](https://repo.huaweicloud.com/harmonyos/compiler/gn/1523/linux/gn.1523.tar).
3. Decompress the gn installation package to **\~/gn**.
```
tar -xvf gn.1523.tar -C ~/
```
4. Set an environment variable.
```
vim ~/.bashrc
```
Copy the following command to the last line of the **.bashrc** file, save the file, and exit.
```
export PATH=~/gn:$PATH
```
5. Validate the environment variable.
```
source ~/.bashrc
```
### Installing ninja<a name="section7681117192813"></a>
1. Start a Linux server.
2. Download [ninja](https://repo.huaweicloud.com/harmonyos/compiler/ninja/1.9.0/linux/ninja.1.9.0.tar).
3. Decompress the ninja installation package to **\~/ninja**.
```
tar -xvf ninja.1.9.0.tar -C ~/
```
4. Set an environment variable.
```
vim ~/.bashrc
```
Copy the following command to the last line of the **.bashrc** file, save the file, and exit.
```
export PATH=~/ninja:$PATH
```
5. Validate the environment variable.
```
source ~/.bashrc
```
### Installing gcc\_riscv32 \(Compilation Toolchain for WLAN Module\)<a name="section1842910288284"></a>
>![](public_sys-resources/icon-notice.gif) **NOTICE:**
>The Hi3861 platform supports only the static link of the libgcc library. **The dynamic link is not recommended because version 3 of the GNU General Public License \(GPLv3\) will be polluted during commercial distribution.**
1. Start a Linux server.
2. Install the **gcc**, **g++**, **bison**, **flex**, **makeinfo** tools to ensure that the toolchain can be correctly compiled.
```
sudo apt-get install gcc && sudo apt-get install g++ && sudo apt-get install flex bison && sudo apt-get install texinfo
```
3. Download the RISC-V GNU toolchain.
```
git clone --recursive https://github.com/riscv/riscv-gnu-toolchain
```
4. Open the **riscv-gnu-toolchain** folder and delete empty folders to prevent conflicts during the download of **newlib**, **binutils**, and **gcc**.
```
cd riscv-gnu-toolchain && rm -rf riscv-newlib && rm -rf riscv-binutils && rm -rf riscv-gcc
```
5. Download RISC-V newlib 3.0.0.
```
git clone -b riscv-newlib-3.0.0 https://github.com/riscv/riscv-newlib.git
```
6. Download RISC-V binutils 2.31.1.
```
git clone -b riscv-binutils-2.31.1 https://github.com/riscv/riscv-binutils-gdb.git
```
7. Download RISC-V gcc 7.3.0.
```
git clone -b riscv-gcc-7.3.0 https://github.com/riscv/riscv-gcc
```
8. Download RISC-V gcc 7.3.0 patches.
Copy the [89411.patch](https://gcc.gnu.org/git/?p=gcc.git;a=patch;h=026216a753ef0a757a9e368a59fa667ea422cf09;hp=2a23a1c39fb33df0277abd4486a3da64ae5e62c2) and [86724.patch](https://gcc.gnu.org/git/?p=gcc.git;a=blobdiff;f=gcc/graphite.h;h=be0a22b38942850d88feb159603bb846a8607539;hp=4e0e58c60ab83f1b8acf576e83330466775fac17;hb=b1761565882ed6a171136c2c89e597bc4dd5b6bf;hpb=fbd5f023a03f9f60c6ae36133703af5a711842a3), modify the line number of the corresponding code, and place the two patches in the **riscv-gcc** directory.
```
cd riscv-gcc && patch -p1 < 89411.patch && patch -p1 < 86724.patch
```
If problems such as **Hunk \#1 FAILED** occur during patch installation, modify the line number in the code pertaining to the patches in the **.c** file.
9. Download, decompress, and install [GMP 6.1.2](https://gmplib.org/download/gmp/gmp-6.1.2.tar.bz2).
```
tar -xvf mpfr-4.0.2.tar.gz && mkdir build_mpfr && cd build_mpfr && ../mpfr-4.0.2/configure --prefix=/usr/local/mpfr-4.0.2 --with-gmp=/usr/local/gmp-6.1.2 --disable-shared && make && make install
```
10. Download, decompress, and install [mpfr-4.0.2 ](https://www.mpfr.org/mpfr-4.0.2/mpfr-4.0.2.tar.gz).
```
tar -xvf mpfr-4.0.2.tar.gz && mkdir build_mpfr && cd build_mpfr && ../mpfr-4.0.2/configure --prefix=/usr/local/mpfr-4.0.2 --with-gmp=/usr/local/gmp-6.1.2 --disable-shared && make && make install
```
11. Download, decompress, and install [mpc-1.1.0](https://ftp.gnu.org/gnu/mpc/mpc-1.1.0.tar.gz).
```
tar -xvf mpc-1.1.0.tar.gz && mkdir build_mpc && cd build_mpc && ../mpc-1.1.0/configure --prefix=/usr/local/mpc-1.1.0 --with-gmp=/usr/local/gmp-6.1.2 --with-mpfr=/usr/local/mpfr-4.0.2 --disable-shared && make && make install
```
12. Open the **riscv-gnu-toolchain** folder and create a directory for toolchain output.
```
cd /opt && mkdir gcc_riscv32
```
13. Build **bintutils**.
```
mkdir build_binutils && cd build_binutils && ../riscv-binutils-gdb/configure --prefix=/opt/gcc_riscv32 --target=riscv32-unknown-elf --with-arch=rv32imc --with-abi=ilp32 --disable-__cxa_atexit --disable-libgomp --disable-libmudflap --enable-libssp --disable-libstdcxx-pch --disable-nls --disable-shared --disable-threads --disable-multilib --enable-poison-system-directories --enable-languages=c,c++ --with-gnu-as --with-gnu-ld --with-newlib --with-system-zlib CFLAGS="-fstack-protector-strong -O2 -D_FORTIFY_SOURCE=2 -Wl,-z,relro,-z,now,-z,noexecstack -fPIE" CXXFLAGS="-fstack-protector-strong -O2 -D_FORTIFY_SOURCE=2 -Wl,-z,relro,-z,now,-z,noexecstack -fPIE" CXXFLAGS_FOR_TARGET="-Os -mcmodel=medlow -Wall -fstack-protector-strong -Wl,-z,relro,-z,now,-z,noexecstack -Wtrampolines -fno-short-enums -fno-short-wchar" CFLAGS_FOR_TARGET="-Os -mcmodel=medlow -Wall -fstack-protector-strong -Wl,-z,relro,-z,now,-z,noexecstack -Wtrampolines -fno-short-enums -fno-short-wchar" --bindir=/opt/gcc_riscv32/bin --libexecdir=/opt/gcc_riscv32/riscv32 --libdir=/opt/gcc_riscv32 --includedir=/opt/gcc_riscv32 && make -j16 && make install
```
14. Build **newlib**.
```
mkdir build_newlib && cd build_newlib && ../riscv-newlib/configure --prefix=/opt/gcc_riscv32 --target=riscv32-unknown-elf --with-arch=rv32imc --with-abi=ilp32 --disable-__cxa_atexit --disable-libgomp --disable-libmudflap --enable-libssp --disable-libstdcxx-pch --disable-nls --disable-shared --disable-threads --disable-multilib --enable-poison-system-directories --enable-languages=c,c++ --with-gnu-as --with-gnu-ld --with-newlib --with-system-zlib CFLAGS="-fstack-protector-strong -O2 -D_FORTIFY_SOURCE=2 -Wl,-z,relro,-z,now,-z,noexecstack -fPIE" CXXFLAGS="-fstack-protector-strong -O2 -D_FORTIFY_SOURCE=2 -Wl,-z,relro,-z,now,-z,noexecstack -fPIE" \CXXFLAGS_FOR_TARGET="-Os -mcmodel=medlow -Wall -fstack-protector-strong -Wl,-z,relro,-z,now,-z,noexecstack -Wtrampolines -fno-short-enums -fno-short-wchar" CFLAGS_FOR_TARGET="-Os -mcmodel=medlow -Wall -fstack-protector-strong -Wl,-z,relro,-z,now,-z,noexecstack -Wtrampolines -fno-short-enums -fno-short-wchar" --bindir=/opt/gcc_riscv32/bin --libexecdir=/opt/gcc_riscv32 --libdir=/opt/gcc_riscv32 --includedir=/opt/gcc_riscv32 && make -j16 && make install
```
15. Build **gcc**.
```
mkdir build_gcc && cd build_gcc && ../riscv-gcc/configure --prefix=/opt/gcc_riscv32 --target=riscv32-unknown-elf --with-arch=rv32imc --with-abi=ilp32 --disable-__cxa_atexit --disable-libgomp --disable-libmudflap --enable-libssp --disable-libstdcxx-pch --disable-nls --disable-shared --disable-threads --disable-multilib --enable-poison-system-directories --enable-languages=c,c++ --with-gnu-as --with-gnu-ld --with-newlib --with-system-zlib CFLAGS="-fstack-protector-strong -O2 -D_FORTIFY_SOURCE=2 -Wl,-z,relro,-z,now,-z,noexecstack -fPIE" CXXFLAGS="-fstack-protector-strong -O2 -D_FORTIFY_SOURCE=2 -Wl,-z,relro,-z,now,-z,noexecstack -fPIE" LDFLAGS="-Wl,-z,relro,-z,now,-z,noexecstack" CXXFLAGS_FOR_TARGET="-Os -mcmodel=medlow -Wall -fstack-protector-strong -Wl,-z,relro,-z,now,-z,noexecstack -Wtrampolines -fno-short-enums -fno-short-wchar" CFLAGS_FOR_TARGET="-Os -mcmodel=medlow -Wall -fstack-protector-strong -Wl,-z,relro,-z,now,-z,noexecstack -Wtrampolines -fno-short-enums -fno-short-wchar" --with-headers="/opt/gcc-riscv32/riscv32-unknown-elf/include" --with-mpc=/usr/local/mpc-1.1.0 --with-gmp=/usr/local/gmp-6.1.2 --with-mpfr=/usr/local/mpfr-4.0.2 && make -j16 && make install
```
16. Set an environment variable.
```
vim ~/.bashrc
```
Copy the following command to the last line of the **.bashrc** file, save the file, and exit.
```
export PATH=/opt/gcc_riscv32/bin:$PATH
```
17. Validate the environment variable.
```
source ~/.bashrc
```
18. Enter the following command to check whether the compiler is successfully installed. If the compiler version number is correctly displayed, the installation is successful.
```
riscv32-unknown-elf-gcc -v
```
## Installing a Windows Development Environment<a name="section1995840162515"></a>
The OpenHarmony IDE Development Tool \(HUAWEI DevEco Device Tool\) integrates the capabilities of terminal tools. For details about how to install the tool, see [Preparations ](https://device.harmonyos.com/en/docs/ide/user-guides/tool_install-0000001050164976)and [Importing and Configuring a Project](https://device.harmonyos.com/en/docs/ide/user-guides/import_project-0000001050164980).
docs-en/subsystems/Readme-EN.md
浏览文件 @ 37cc208b
# Subsystem Development Guidelines # Subsystem Development Guidelines
- [Distributed Remote Startup](distributed-remote-startup.md) - [Distributed Remote Startup](distributed-remote-startup.md)
- [Graphic](graphic.md) - [Graphics](graphics.md)
- [Graphics](graphics.md) - [Graphics](graphics-0.md)
- [Development Guidelines on Container Components](development-guidelines-on-container-components.md) - [Development Guidelines on Container Components](development-guidelines-on-container-components.md)
- [Development Guidelines on Layout Container Components](development-guidelines-on-layout-container-components.md) - [Development Guidelines on Layout Container Components](development-guidelines-on-layout-container-components.md)
- [Development Guidelines on Common Components](development-guidelines-on-common-components.md) - [Development Guidelines on Common Components](development-guidelines-on-common-components.md)
- [Development Guidelines on Animators](development-guidelines-on-animators.md) - [Development Guidelines on Animators](development-guidelines-on-animators.md)
- [Camera](camera.md) - [Multimedia](multimedia.md)
- [Overview](overview.md) - [Overview](overview.md)
- [Development Guidelines on Photographing](development-guidelines-on-photographing.md) - [Development Guidelines on Photographing](development-guidelines-on-photographing.md)
- [Development Guidelines on Video Recording](development-guidelines-on-video-recording.md) - [Development Guidelines on Video Recording](development-guidelines-on-video-recording.md)
- [Development Guidelines on Previewing](development-guidelines-on-previewing.md) - [Development Guidelines on Previewing](development-guidelines-on-previewing.md)
- [Overview](overview-1.md)
- [Audio and Video](audio-and-video.md)
- [Overview](overview-0.md)
- [Development Guidelines on Media Playback](development-guidelines-on-media-playback.md) - [Development Guidelines on Media Playback](development-guidelines-on-media-playback.md)
- [Development Guidelines on Media Recording](development-guidelines-on-media-recording.md) - [Development Guidelines on Media Recording](development-guidelines-on-media-recording.md)
- [Utils](utils.md)
- [Utils Overview](utils-overview.md)
- [Utils Development Guidelines](utils-development-guidelines.md)
- [Utils FAQ](utils-faq.md)
- [Application Framework](application-framework.md)
- [Overview](overview-2.md)
- [Setting Up a Development Environment](setting-up-a-development-environment.md)
- [Development Guidelines](development-guidelines.md)
- [Development Example](development-example.md)
- [FAQ](faq.md)
- [Compilation and Building](compilation-and-building.md)
- [Compilation and Building Overview](compilation-and-building-overview.md)
- [Compilation and Building Guidelines](compilation-and-building-guidelines.md)
- [Compilation and Building FAQ](compilation-and-building-faq.md)
- [Testing](testing.md)
- [DFX](dfx.md)
- [DFX](dfx-3.md)
- [Development Guidelines on the mini Framework](development-guidelines-on-the-mini-framework.md)
- [Development Guidelines on the featured Framework](development-guidelines-on-the-featured-framework.md)
- [FAQ](faq-4.md)
- [Reference](reference.md)
- [XTS](xts.md)
docs-en/subsystems/application-framework.md 0 → 100644
浏览文件 @ 37cc208b
# Application Framework<a name="EN-US_TOPIC_0000001074304592"></a>
- **[Overview](overview-2.md)**
- **[Setting Up a Development Environment](setting-up-a-development-environment.md)**
- **[Development Guidelines](development-guidelines.md)**
- **[Development Example](development-example.md)**
- **[FAQ](faq.md)**
docs-en/subsystems/compilation-and-building-faq.md 0 → 100644
浏览文件 @ 37cc208b
# Compilation and Building FAQ<a name="EN-US_TOPIC_0000001060804832"></a>
- [Invalid -- w option](#section1019152312222)
- [Ncurses library not found](#section21449422618)
- [Mcopy not found](#section12477184992615)
- [No riscv file or directory](#section178451337202716)
- [No Crypto](#section1241481172819)
- [Unexpected operator](#section3691222152919)
## Invalid -- w option<a name="section1019152312222"></a>
- **Problem**
The compilation fails, and **usr/sbin/ninja: invalid option -- w** is displayed.
- **Cause**
The Ninja version in the compilation environment is outdated and does not support the **--w** option.
- **Solution**
Uninstall Ninja and GN and follow the instructions provided in [Tool Acquisition](../get-code/tool-acquisition.md) to obtain the provided compilation toolchain.
## Ncurses library not found<a name="section21449422618"></a>
- **Problem**
The compilation fails, and **/usr/bin/ld: cannot find -lncurses** is displayed.
- **Cause**
The ncurses library is not installed.
- **Solution**
Run **sudo apt-get install lib32ncurses5-dev** to install the library.
## Mcopy not found<a name="section12477184992615"></a>
- **Problem**
The compilation fails, and **line 77: mcopy: command not found** is displayed.
- **Cause**
Mcopy is not installed.
- **Solution**
Run **sudo apt-get install dosfstools mtools** to install mcopy.
## No riscv file or directory<a name="section178451337202716"></a>
- **Problem**
The compilation fails, and **riscv32-unknown-elf-gcc: error trying to exec 'cc1': execvp: No such file or directory** is displayed.
- **Cause**
Permission is required to access files in the **riscv** compiler path.
- **Solution**
Run **which riscv32-unknown-elf-gcc** and **chmod 755** to modify the permission to access the directory where **hcc\_riscv32** is located.
## No Crypto<a name="section1241481172819"></a>
- **Problem**
The compilation fails, and **No module named'Crypto loaded** is displayed.
- **Cause**
Crypto is not installed in Python3.
- **Solution**
Run **python3 --version** to check the Python version. Ensure that the Python version is 3.7 or later and run **sudo pip3 install pycryptodome**.
## Unexpected operator<a name="section3691222152919"></a>
- **Problem**
The compilation fails, and **xx.sh \[: xx upexpected operator** is displayed.
- **Cause**
The compilation environment is shell instead of bash.
- **Solution**
Run the following commands to switch the compilation environment:
**sudo rm -rf /bin/sh**
**sudo ln -s /bin/bash /bin/sh**
docs-en/subsystems/compilation-and-building-guidelines.md 0 → 100644
浏览文件 @ 37cc208b
# Compilation and Building Guidelines<a name="EN-US_TOPIC_0000001060378721"></a>
- [Directory Structure](#section56731811102915)
- [Compilation Commands](#section1475192018291)
- [How to Develop](#section4207112818418)
## Directory Structure<a name="section56731811102915"></a>
```
build/lite # Primary directory for compilation and building
├── config # Compilation configuration items
│ ├── boards # Declaration of development board–related variables, including its name, target architecture, and target CPU
│ ├── component # Definition of templates related to OpenHarmony components, including static libraries, dynamic libraries, extension components, and emulator libraries
│ ├── kernel # Compilation variable declaration and configuration parameters for the OpenHarmony kernel
│ └── subsystem # OpenHarmony subsystem list
├── ndk # NDK-related compilation scripts and configuration parameters
├── platform # Platform-related configuration files
│ ├── hi3516dv300_liteos_a # Hi3516DV300 and LiteOS_A platform files, including full configuration tables and boot files
│ ├── hi3518ev300_liteos_a # Hi3518EV300 and LiteOS_A platform files, including full configuration tables and boot files
│ └── hi3861v100_liteos_riscv # Hi3861V100 and LiteOS_RISCV platform files, including full configuration tables and boot files
├── product # Full configuration tables of the product, including configuration units, the subsystem list, and the compiler
├── toolchain # Compilation toolchains, which contain the compiler paths, compilation options, and link options
└── tools # Tools on which compilation and building depend, for example, mkfs
```
## Compilation Commands<a name="section1475192018291"></a>
- Usage
```
python build.py product [options]
```
Replace **product** with **build/lite/produc/**_xxx_**.json**. Both the product name and components configured in the JSON file can be customized. By default, all components supported by the corresponding platform are contained in the JSON file.
- Compilation options
**-b, --build\_type** Debug or release
**-t, --test** Build with test suit
**-T, --target** Build single target
- Output directory: _root directory of the code_**/out/product**
## How to Develop<a name="section4207112818418"></a>
1. Add a component.
This step takes a custom component as an example to describe how to compile components, libraries, and executable files.
The example component consists of two features: **feature1** and **feature2**. The target of **feature1** is a dynamic library, and that of **feature2** is an executable file. The complete directory structure of the example component is as follows:
```
example # Custom component
├── BUILD.gn # GN script of the component. The name is fixed.
├── feature1 # Custom unit 1
│ ├── BUILD.gn # GN script of feature1. The name is fixed.
│ ├── include # Header file folder
│ │ └── helloworld1.h # Header file 1
│ └── src # Source file folder
│ └── helloworld1.c # Source file 1
├── feature2 # Custom unit 2
│ ├── BUILD.gn # GN script of feature2. The name is fixed.
│ ├── include # Header file folder
│ │ └── helloworld2.h # Header file 2
│ └── src # Source file folder
│ └── helloworld2.c # Source file 2
├── build.sh # (Optional) build.sh script of the custom component
└── Makefile # (Optional) Makefile script of the custom component
```
Example 1: GN script \(**example/feature1/BUILD.gn**\) for dynamic library compilation.
```
# Example for compiling the helloworld dynamic library
# Build.gn script of helloworld
shared_library("helloworld_lib") {
sources = [
"src/helloworld1.c"
]
include_dirs = [
"include",
"../feature2_example/include" # (Optional) Add feature2_example to this include if needed.
]
}
```
Example 2: GN script \(**example/feature2/BUILD.gn**\) for executable file compilation
The built-in **executable** function generates the executable file. Sample code is as follows:
```
# Compile the executable .bin file.
executable("hello_world_bin") {
sources = [
"src/helloworld2.c"
]
include_dirs = [
"include",
"../feature2_example/include" # (Optional) Add feature2_example to this include if needed.
]
# (Optional) Add feature1_example to this deps if needed.
deps = [
"../feature1_example:helloworld1"
]
}
```
Example 3: GN script \(**example/BUILD.gn**\) for component compilation
```
import("//build/lite/config/component/lite_component.gni")
lite_component("example_gn") {
features = [
"feature_example1:helloworld_lib",
"feature_example2:hello_world_bin",
]
}
```
Example 4: GN script for compiling **build.sh** or the **Makefile** project of a third-party open-source software
```
build_ext_component("example_mk") {
exec_path = rebase_path(rebase_path(".", root_build_dir))
outdir = rebase_path(get_path_info(".", "out_dir"))
prebuilts = "sh build.sh"
command = "make clean && make"
}
```
Global variables are defined in **build/lite/ohos\_var.gni.**
The following table describes common global variables.
**Table 1** Global variables
<a name="table520317612613"></a>
<table><thead align="left"><tr id="row13203861262"><th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.2.4.1.1"><p id="p2203368619"><a name="p2203368619"></a><a name="p2203368619"></a>Variable</p>
</th>
<th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.2.4.1.2"><p id="p15203765620"><a name="p15203765620"></a><a name="p15203765620"></a>Value Range</p>
</th>
<th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.2.4.1.3"><p id="p6203669616"><a name="p6203669616"></a><a name="p6203669616"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row42036617616"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.1 "><p id="p1643814011561"><a name="p1643814011561"></a><a name="p1643814011561"></a>ohos_kernel_type</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.2 "><p id="p114385019568"><a name="p114385019568"></a><a name="p114385019568"></a>"liteos_a", "liteos_riscv"</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="p820396265"><a name="p820396265"></a><a name="p820396265"></a>Kernel type</p>
</td>
</tr>
<tr id="row62033619614"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.1 "><p id="p134381805564"><a name="p134381805564"></a><a name="p134381805564"></a>board_name</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.2 "><p id="p9203161968"><a name="p9203161968"></a><a name="p9203161968"></a>"hi3516dv300", "hi3518ev300", "hi3861v100"</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="p172031169619"><a name="p172031169619"></a><a name="p172031169619"></a>Development board</p>
</td>
</tr>
<tr id="row1620318610614"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.1 "><p id="p1143880135612"><a name="p1143880135612"></a><a name="p1143880135612"></a>ohos_build_compiler</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.2 "><p id="p22041613618"><a name="p22041613618"></a><a name="p22041613618"></a>"gcc", "clang"</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="p9204861469"><a name="p9204861469"></a><a name="p9204861469"></a>Compilation toolchain type</p>
</td>
</tr>
<tr id="row6392114583815"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.1 "><p id="p539294514383"><a name="p539294514383"></a><a name="p539294514383"></a>ohos_build_type</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.2 "><p id="p7392144510388"><a name="p7392144510388"></a><a name="p7392144510388"></a>"debug", "release"</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="p53921145123819"><a name="p53921145123819"></a><a name="p53921145123819"></a>Compilation type</p>
</td>
</tr>
</tbody>
</table>
The following example code configures **ohos\_kernel\_type** in **component\_example/feature2\_example/BUILD.gn**
```
lite_library("helloworld") {
if (ohos_kernel_type == "liteos_a") {
target_type = "shared_library"
}
else if (ohos_kernel_type == "liteos_riscv") {
target_type = "static_library"
}
sources = [
"src/helloworld1.c"
]
include_dirs = [
"include"
]
}
```
2. Compile the product solution.
The configuration of the product solution is stored in a JSON file \(for example, **ipcamera\_hi3516dv300.json**\) under the **build/lite/product** directory. During the construction, the system reads the configuration file, which contains custom subsystems and components. To compile **ipcamera\_hi3516dv30**, for example, run the following command:
```
python build.py ipcamera_hi3516dv30
```
3. Obtain the compilation result.
Files generated after compilation are archived in the **out** directory. For example, run **python build.py wifiiot -b debug** in the directory where the code is located. After **wifiiot** is compiled, the following result is generated:
```
out/
└── wifiiot # Product name
├── args.gn # Custom variables for GN compilation
├── build.log # Compilation log
├── build.ninja
├── build.ninja.d
├── gen
├── Hi3861_boot_signed_B.bin # Signed bootloader backup file
├── Hi3861_boot_signed.bin # Signed bootloader file
├── Hi3861_loader_signed.bin # Loader file used by the burning tool
├── Hi3861_wifiiot_app_allinone.bin # Production line tooling burning file, which contains the independent burning program and loader program
├── Hi3861_wifiiot_app.asm # Kernel asm file
├── Hi3861_wifiiot_app_burn.bin # Burning file
├── Hi3861_wifiiot_app_flash_boot_ota.bin # Flash Boot upgrade file
├── Hi3861_wifiiot_app.map # Kernel map file
├── Hi3861_wifiiot_app_ota.bin # Kernel upgrade file
├── Hi3861_wifiiot_app.out # Kernel output file
├── Hi3861_wifiiot_app_vercfg.bin # Configuration with secure boot and kernel versions to prevent version rollback
├── libs # Library folder
├── NOTICE_FILE
├── obj
├── suites
└── toolchain.ninja
```
Note: You are advised to use the **Hi3861\_wifiiot\_app\_allinone.bin** program to burn files.
Run **python build.py ipcamera\_hi3518ev300 -b debug**. After the compilation is complete, the following result is generated \(similar to that for **ipcamera\_hi3516dv300**\):
```
out/
└── ipcamera_hi3518ev300 # Product name
├── args.gn # Custom variables for GN compilation
├── bin # Link to the folder where the .bin file locates
├── bm_tool.map # map file
├── build.log # Compilation log
├── build.ninja
├── build.ninja.d
├── bundle_daemon_tool.map # map file
├── data # Configuration file of media resources on which the camera depends.
├── dev_tools # R&D self-testing
├── foundation.map # map file
├── gen
├── libaudio_api.so
├── libs # Library files
├── liteos.bin # Basic kernel file for LiteOS
├── media_server.map # map file
├── NOTICE_FILE
├── obj # Compilation result folder containing binary files
├── OHOS_Image # Unstriped .bin file of the LiteOS package
├── OHOS_Image.asm # Assembly code
├── OHOS_Image.bin # LiteOS package for burning
├── OHOS_Image.map # map file
├── rootfs.img # Compiled library and application image
├── rootfs.tar # Compressed rootfs
├── suites # XTS compilation result
├── test # Test case compilation result
├── toolchain.ninja
├── userfs # User-readable and -writable partition
├── userfs.img # User-readable and -writable partition in .img format, corresponding to the /storage directory after system startup.
└── vendor # Firmware and configuration files of the chip
```
docs-en/subsystems/compilation-and-building-overview.md 0 → 100644
浏览文件 @ 37cc208b
# Compilation and Building Overview<a name="EN-US_TOPIC_0000001060646620"></a>
- [Basic Concepts](#section175012297491)
- [Working Principles](#section193961322175011)
- [Limitations and Constraints](#section2029921310472)
The compilation and building subsystem provides a framework based on Generate Ninja \(GN\) and Ninja. This subsystem allows you to:
- Build products based on different chip platforms. For example, you can build IP camera products on the Hi3518EV300 and Hi3516DV300 development boards and WLAN module–based products on Hi3861 development boards.
- Build a customized product that is generated according to HarmonyOS Package Manager \(HPM\) configurations.
## Basic Concepts<a name="section175012297491"></a>
It is considered best practice to learn the following basic concepts before you start development, compilation, and building:
- **Platform**
A platform is a combination of development boards and kernels.
Supported subsystems and components vary with the platform.
- **Component**
A component is a reusable software unit that contains source code, configuration files, resource files, and compilation scripts.
- **GN**
GN is short for Generate Ninja, which is used to generate Ninja files.
- **Ninja**
Ninja is a small high-speed building system.
## Working Principles<a name="section193961322175011"></a>
The compilation and building processes are as follows:
- **Parsing**: Parse the name of the product to be compiled and the compilation type \(debug or release\).
- **Running GN**: Configure toolchains and global options for the compilation based on the product name and compilation type that have been parsed.
- **Running Ninja**: Start the compilation.
- **Packaging**: Package the component compilation result of the product to create a file system image.
## Limitations and Constraints<a name="section2029921310472"></a>
You must install GN and Ninja and compilation toolchains, and download the complete code.
docs-en/subsystems/compilation-and-building.md 0 → 100644
浏览文件 @ 37cc208b
# Compilation and Building<a name="EN-US_TOPIC_0000001074146280"></a>
- **[Compilation and Building Overview](compilation-and-building-overview.md)**
- **[Compilation and Building Guidelines](compilation-and-building-guidelines.md)**
- **[Compilation and Building FAQ](compilation-and-building-faq.md)**
docs-en/subsystems/development-example.md 0 → 100644
浏览文件 @ 37cc208b
# Development Example<a name="EN-US_TOPIC_0000001061399563"></a>
For details, see the [example in the open-source project](https://gitee.com/openharmony/aafwk_frameworks_kits_ability_lite/tree/master/example).
docs-en/subsystems/development-guidelines-on-the-featured-framework.md 0 → 100644
浏览文件 @ 37cc208b
# Development Guidelines on the featured Framework<a name="EN-US_TOPIC_0000001062713987"></a>
- [Available APIs](#section20840587473)
- [How to Develop](#section32781532131314)
- [Use Case](#section1210915266154)
The featured framework provides comprehensive DFX features. By default, logs are output to the serial port and the file in **/storage/data/log/** in debug versions.
## Available APIs<a name="section20840587473"></a>
```
HILOG_DEBUG(type, ...)
HILOG_INFO(type, ...)
HILOG_WARN(type, ...)
HILOG_ERROR(type, ...)
HILOG_FATAL(type, ...)
```
**Table 1** Parameters
<a name="table1872515171474"></a>
<table><thead align="left"><tr id="row772491734711"><th class="cellrowborder" valign="top" width="25.05%" id="mcps1.2.3.1.1"><p id="p1272431714477"><a name="p1272431714477"></a><a name="p1272431714477"></a>Parameter</p>
</th>
<th class="cellrowborder" valign="top" width="74.95%" id="mcps1.2.3.1.2"><p id="p472451724716"><a name="p472451724716"></a><a name="p472451724716"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row15416155714297"><td class="cellrowborder" valign="top" width="25.05%" headers="mcps1.2.3.1.1 "><p id="p041617572292"><a name="p041617572292"></a><a name="p041617572292"></a>type</p>
</td>
<td class="cellrowborder" valign="top" width="74.95%" headers="mcps1.2.3.1.2 "><p id="p74161557172912"><a name="p74161557172912"></a><a name="p74161557172912"></a>Used for compatibility with the parameters in the mini framework. The featured framework ignores any value passed to this parameter.</p>
</td>
</tr>
<tr id="row19724161794719"><td class="cellrowborder" valign="top" width="25.05%" headers="mcps1.2.3.1.1 "><p id="p1072431724710"><a name="p1072431724710"></a><a name="p1072431724710"></a>domainId</p>
</td>
<td class="cellrowborder" valign="top" width="74.95%" headers="mcps1.2.3.1.2 "><p id="p14724181724719"><a name="p14724181724719"></a><a name="p14724181724719"></a>Domain ID, which is a hidden parameter and needs to be defined</p>
</td>
</tr>
<tr id="row5724131714718"><td class="cellrowborder" valign="top" width="25.05%" headers="mcps1.2.3.1.1 "><p id="p2724191724716"><a name="p2724191724716"></a><a name="p2724191724716"></a>tag</p>
</td>
<td class="cellrowborder" valign="top" width="74.95%" headers="mcps1.2.3.1.2 "><p id="p11724917114715"><a name="p11724917114715"></a><a name="p11724917114715"></a>Log tag, which is a hidden parameter and needs to be defined</p>
</td>
</tr>
<tr id="row137243177475"><td class="cellrowborder" valign="top" width="25.05%" headers="mcps1.2.3.1.1 "><p id="p1772461754718"><a name="p1772461754718"></a><a name="p1772461754718"></a>fmt</p>
</td>
<td class="cellrowborder" valign="top" width="74.95%" headers="mcps1.2.3.1.2 "><p id="p131236352304"><a name="p131236352304"></a><a name="p131236352304"></a>Format specifier</p>
<p id="p2072401710475"><a name="p2072401710475"></a><a name="p2072401710475"></a>Parameters labeled {private} are private data, and those labeled {public} are public data.</p>
</td>
</tr>
<tr id="row11725161719477"><td class="cellrowborder" valign="top" width="25.05%" headers="mcps1.2.3.1.1 "><p id="p172591734710"><a name="p172591734710"></a><a name="p172591734710"></a>args</p>
</td>
<td class="cellrowborder" valign="top" width="74.95%" headers="mcps1.2.3.1.2 "><p id="p8725617194715"><a name="p8725617194715"></a><a name="p8725617194715"></a>Parameters to be displayed using the format specifier.</p>
</td>
</tr>
</tbody>
</table>
Privacy rules \(only for logs in release mode\):
1. The format specifier is labeled \{public\} by default.
```
HILOG_INFO(0, "Hello World\n"); >> Hello World
```
2. The formatted parameter is labeled \{private\} by default.
```
HILOG_INFO(0, "Age is %d\n", 10); >> Age is <private>
```
3. Parameters labeled %\{private\} are private data.
```
HILOG_INFO(0, "Age is %{private}d\n", 10); >> Age is <private>
```
4. Parameters labeled %\{public\} are public data.
```
HILOG_INFO(0, "Age is %{public}d\n", 10); >>Age is 10
```
## How to Develop<a name="section32781532131314"></a>
1. Include the dynamic library dependencies in the **Build.gn** file.
```
public_deps = [ "//base/hiviewdfx/frameworks/hilog_lite/featured:hilog_shared"]
```
2. Add the **log.h** header file to define the **TAG** and **Domain** values for the module.
```
#include<log.h>
#undef LOG_TAG
#undef LOG_DOMAIN
#define LOG_TAG "MyModule"
#define LOG_DOMAIN 0xD00000
```
3. Run the log printing code.
```
HILOG_INFO(0,"Hello World\n");
```
## Use Case<a name="section1210915266154"></a>
The following steps describe how the **samgr\_lite** module \(an example\) uses the featured framework.
1. Reference the **hilog** header file and dependency library by using dependency statements in **foundation/distributedschedule/services/samgr\_lite/samgr/source/BUILD.gn** in the source code path.
```
public_deps = [ "//base/hiviewdfx/frameworks/hilog_lite/featured:hilog_shared" ]
```
2. Reference the header file in the source code file and call the **HILOG** function.
Refer to the following source code file **distributedschedule/services/samgr\_lite/samgr\_server/source/samgr\_server.c**.
```
#include<log.h>
#undef LOG_TAG
#undef LOG_DOMAIN
#define LOG_TAG "Samgr"
#define LOG_DOMAIN 0xD001800
static void InitializeRegistry(void)
{
HILOG_INFO(HILOG_MODULE_SAMGR, "Initialize Registry!");
...
}
```
As shown in the file, the header file <log.h\> or <hilog/log.h\> is included, and the domain ID and tag \(Samgr\) are added.
3. Call the **InitializeRegistry** function to print the log content, including the date, PID \(**6**\), task ID \(**23**\), level \(**I**\), domain ID \(**01800**, the least five bits of the defined value **0xD001800**\), module name \(**Samgr**\), and statement \(**Initialize Registry!**\).
**Figure 1** Information printed during system startup<a name="fig418242621511"></a>
![](figures/information-printed-during-system-startup.png "information-printed-during-system-startup")
docs-en/subsystems/development-guidelines-on-the-mini-framework.md 0 → 100644
浏览文件 @ 37cc208b
# Development Guidelines on the mini Framework<a name="EN-US_TOPIC_0000001063393902"></a>
- [Available APIs](#section183731439142417)
- [Use Case](#section153112047155419)
The mini framework adopts a simple and compact DFX design that provides the logging function.
## Available APIs<a name="section183731439142417"></a>
```
HILOG_DEBUG(mod, fmt, ...)
HILOG_INFO(mod, fmt, ...)
HILOG_WARN(mod, fmt, ...)
HILOG_ERROR(mod, fmt, ...)
HILOG_FATAL(mod, fmt, ...)
```
The following table lists parameters of the preceding APIs.
<a name="table998125624816"></a>
<table><thead align="left"><tr id="row10981135611481"><th class="cellrowborder" valign="top" width="11.57%" id="mcps1.1.5.1.1"><p id="p11981145674811"><a name="p11981145674811"></a><a name="p11981145674811"></a>Parameter</p>
</th>
<th class="cellrowborder" valign="top" width="11.83%" id="mcps1.1.5.1.2"><p id="p39821456124810"><a name="p39821456124810"></a><a name="p39821456124810"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="15.21%" id="mcps1.1.5.1.3"><p id="p139822056104811"><a name="p139822056104811"></a><a name="p139822056104811"></a>Data Type</p>
</th>
<th class="cellrowborder" valign="top" width="61.39%" id="mcps1.1.5.1.4"><p id="p3982145618482"><a name="p3982145618482"></a><a name="p3982145618482"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row209821456144818"><td class="cellrowborder" valign="top" width="11.57%" headers="mcps1.1.5.1.1 "><p id="p20982125616483"><a name="p20982125616483"></a><a name="p20982125616483"></a>mod</p>
</td>
<td class="cellrowborder" valign="top" width="11.83%" headers="mcps1.1.5.1.2 "><p id="p1298245634810"><a name="p1298245634810"></a><a name="p1298245634810"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.21%" headers="mcps1.1.5.1.3 "><p id="p1198295634817"><a name="p1198295634817"></a><a name="p1198295634817"></a>uint8</p>
</td>
<td class="cellrowborder" valign="top" width="61.39%" headers="mcps1.1.5.1.4 "><p id="p0982145634817"><a name="p0982145634817"></a><a name="p0982145634817"></a>Module or service ID.</p>
<p id="p1982155664820"><a name="p1982155664820"></a><a name="p1982155664820"></a>IDs are planned and assigned in a unified manner. A maximum of 64 IDs are supported. Third-party applications use <strong id="b1367151118101"><a name="b1367151118101"></a><a name="b1367151118101"></a>HILOG_MODULE_APP</strong> as their module ID.</p>
</td>
</tr>
<tr id="row1898225611489"><td class="cellrowborder" valign="top" width="11.57%" headers="mcps1.1.5.1.1 "><p id="p9982656164812"><a name="p9982656164812"></a><a name="p9982656164812"></a>fmt</p>
</td>
<td class="cellrowborder" valign="top" width="11.83%" headers="mcps1.1.5.1.2 "><p id="p998255616484"><a name="p998255616484"></a><a name="p998255616484"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.21%" headers="mcps1.1.5.1.3 "><p id="p18982256194818"><a name="p18982256194818"></a><a name="p18982256194818"></a>char *</p>
</td>
<td class="cellrowborder" valign="top" width="61.39%" headers="mcps1.1.5.1.4 "><p id="p2982165664818"><a name="p2982165664818"></a><a name="p2982165664818"></a>Format specifier for output.</p>
<a name="ol19982256164816"></a><a name="ol19982256164816"></a><ol id="ol19982256164816"><li>A maximum of six variable parameters are supported. <strong id="b1465118167236"><a name="b1465118167236"></a><a name="b1465118167236"></a>%s</strong> is not supported.</li><li>The maximum length of a formatted log record is 128 bytes. If the maximum length is exceeded, the log cannot be printed.</li></ol>
</td>
</tr>
<tr id="row16982105613488"><td class="cellrowborder" valign="top" width="11.57%" headers="mcps1.1.5.1.1 "><p id="p1898225604813"><a name="p1898225604813"></a><a name="p1898225604813"></a>Variable parameters</p>
</td>
<td class="cellrowborder" valign="top" width="11.83%" headers="mcps1.1.5.1.2 "><p id="p1698217568486"><a name="p1698217568486"></a><a name="p1698217568486"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="15.21%" headers="mcps1.1.5.1.3 "><p id="p189834566489"><a name="p189834566489"></a><a name="p189834566489"></a>int32</p>
</td>
<td class="cellrowborder" valign="top" width="61.39%" headers="mcps1.1.5.1.4 "><p id="p9983175654814"><a name="p9983175654814"></a><a name="p9983175654814"></a>Only numeric types are supported. A maximum of six variable parameters are allowed.</p>
</td>
</tr>
</tbody>
</table>
1. Add the module ID.
Define **HILOG\_MODULE\_A** in **HiLogModuleType** of **interfaces/kits/hilog\_lite/hiview\_log.h**.
```
typedef enum {
/** DFX */
HILOG_MODULE_HIVIEW = 0,
/** System Module A */
HILOG_MODULE_A,
/** Maximum number of modules */
HILOG_MODULE_MAX
} HiLogModuleType;
```
2. Register the module.
Add the following code during the module initialization to register the module with the logging framework:
```
HiLogRegisterModule(HILOG_MODULE_A, "A");
```
3. Modify the static configuration of the DFX framework.
Modify **g\_hiviewConfig** in the following file as required. By default, modification is not required and logs are output to the serial port.
```
utils/lite/hiview_config.c
```
<a name="table15664428164516"></a>
<table><thead align="left"><tr id="row07061028154510"><th class="cellrowborder" valign="top" width="25.180000000000003%" id="mcps1.1.3.1.1"><p id="p10706128184514"><a name="p10706128184514"></a><a name="p10706128184514"></a>Configuration Item</p>
</th>
<th class="cellrowborder" valign="top" width="74.82%" id="mcps1.1.3.1.2"><p id="p11706928194520"><a name="p11706928194520"></a><a name="p11706928194520"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row8706828154511"><td class="cellrowborder" valign="top" width="25.180000000000003%" headers="mcps1.1.3.1.1 "><p id="p19706112824514"><a name="p19706112824514"></a><a name="p19706112824514"></a>outputOption</p>
</td>
<td class="cellrowborder" valign="top" width="74.82%" headers="mcps1.1.3.1.2 "><p id="p9706528104512"><a name="p9706528104512"></a><a name="p9706528104512"></a>Log output mode. The value can be:</p>
<a name="ul113982579190"></a><a name="ul113982579190"></a><ul id="ul113982579190"><li><strong id="b158115185206"><a name="b158115185206"></a><a name="b158115185206"></a>OUTPUT_OPTION_DEBUG</strong>: Logs are directly output to the serial port without cross-task scheduling. This value is used only for temporary debugging.</li><li><strong id="b961064410200"><a name="b961064410200"></a><a name="b961064410200"></a>OUTPUT_OPTION_FLOW</strong> (default value): Logs are output as data flow to the serial port.</li><li><strong id="b43331155112013"><a name="b43331155112013"></a><a name="b43331155112013"></a>OUTPUT_OPTION_TEXT_FILE</strong>: Logs are output as text files.</li></ul>
</td>
</tr>
<tr id="row1270720281453"><td class="cellrowborder" valign="top" width="25.180000000000003%" headers="mcps1.1.3.1.1 "><p id="p137071528164516"><a name="p137071528164516"></a><a name="p137071528164516"></a>level</p>
</td>
<td class="cellrowborder" valign="top" width="74.82%" headers="mcps1.1.3.1.2 "><p id="p177071428154510"><a name="p177071428154510"></a><a name="p177071428154510"></a>Log level for output. Only the logs whose levels are higher than or equal to the level specified by this parameter can be output. The value can be:</p>
<a name="ul1021772614515"></a><a name="ul1021772614515"></a><ul id="ul1021772614515"><li>HILOG_LV_DEBUG (default value)</li><li>HILOG_LV_INFO</li><li>HILOG_LV_WARN</li><li>HILOG_LV_ERROR</li><li>HILOG_LV_FATAL</li></ul>
</td>
</tr>
<tr id="row17707142814513"><td class="cellrowborder" valign="top" width="25.180000000000003%" headers="mcps1.1.3.1.1 "><p id="p11707192814517"><a name="p11707192814517"></a><a name="p11707192814517"></a>logSwitch</p>
</td>
<td class="cellrowborder" valign="top" width="74.82%" headers="mcps1.1.3.1.2 "><p id="p870711281452"><a name="p870711281452"></a><a name="p870711281452"></a>Logging switch. This switch is turned on by default. The <strong id="b164378447225"><a name="b164378447225"></a><a name="b164378447225"></a>log</strong> component can be successfully initialized even if this switch is turned off before compilation. The value can be:</p>
<a name="ul1698616567457"></a><a name="ul1698616567457"></a><ul id="ul1698616567457"><li>HIVIEW_FEATURE_ON</li><li>HIVIEW_FEATURE_OFF</li></ul>
</td>
</tr>
<tr id="row6708132813453"><td class="cellrowborder" valign="top" width="25.180000000000003%" headers="mcps1.1.3.1.1 "><p id="p1570813280453"><a name="p1570813280453"></a><a name="p1570813280453"></a>dumpSwitch</p>
</td>
<td class="cellrowborder" valign="top" width="74.82%" headers="mcps1.1.3.1.2 "><p id="p970852810459"><a name="p970852810459"></a><a name="p970852810459"></a>Dumping switch. This switch is turned off by default. If the default setting is retained before compilation, the <strong id="b19591628162312"><a name="b19591628162312"></a><a name="b19591628162312"></a>DUMP</strong> component will not be initialized. The value can be:</p>
<a name="ul122703764613"></a><a name="ul122703764613"></a><ul id="ul122703764613"><li>HIVIEW_FEATURE_ON</li><li>HIVIEW_FEATURE_OFF</li></ul>
</td>
</tr>
<tr id="row87081282452"><td class="cellrowborder" valign="top" width="25.180000000000003%" headers="mcps1.1.3.1.1 "><p id="p11708128124511"><a name="p11708128124511"></a><a name="p11708128124511"></a>eventSwitch</p>
</td>
<td class="cellrowborder" valign="top" width="74.82%" headers="mcps1.1.3.1.2 "><p id="p17708202834519"><a name="p17708202834519"></a><a name="p17708202834519"></a>Event output switch. This switch is turned off by default. If the default setting is retained before compilation, the <strong id="b86242510254"><a name="b86242510254"></a><a name="b86242510254"></a>Event</strong> component will not be initialized. The value can be:</p>
<a name="ul845720186469"></a><a name="ul845720186469"></a><ul id="ul845720186469"><li>HIVIEW_FEATURE_ON</li><li>HIVIEW_FEATURE_OFF</li></ul>
</td>
</tr>
</tbody>
</table>
4. Add the header file dependencies to the **Build.gn** file of the module.
```
include_dirs = [
"//base/hiviewdfx/interfaces/kits/hilog_lite",
]
```
5. Print logs.
Add **\#include "log.h"** in the .c file where logs need to be printed, and then call the following function:
```
HILOG_DEBUG(HILOG_MODULE_A, "log test: %d", 88);
```
## Use Case<a name="section153112047155419"></a>
The following steps describe how the **samgr\_lite** module \(an example\) uses the mini framework.
1. Add the module ID, and define **HILOG\_MODULE\_SAMGR** in the type definition structure in **base/hiviewdfx/interfaces/kits/hilog\_lite/hiview\_log.h**.
```
typedef enum {
...
HILOG_MODULE_SAMGR,
...
} HiLogModuleType;
```
2. Register the module. Specifically, add the registration code in **HiLogInit** of **base/hiviewdfx/frameworks/hilog\_lite/mini/hiview\_log.c**.
```
HiLogRegisterModule(HILOG_MODULE_SAMGR, "SAMGR");
```
3. Include the header file dependencies in the **foundation/distributedschedule/services/samgr\_lite/samgr/source/BUILD.gn** file.
```
include_dirs = [
"//base/hiviewdfx/interfaces/kits/hilog_lite",
]
```
4. Reference the header file in the source code file **foundation/distributedschedule/services/samgr\_lite/samgr/source/message.c** and call the related functions.
```
#include <log.h>
uint32 *SAMGR_SendSharedRequest(const Identity *identity, const Request *request, uint32 *token, Handler handler)
{
...
if (err != EC_SUCCESS) {
HILOG_ERROR(HILOG_MODULE_SAMGR, "SharedSend [%p] failed(%d)!", identity->queueId, err);
(void)FreeReference(&exchange);
}
...
}
```
docs-en/subsystems/development-guidelines.md 0 → 100644
浏览文件 @ 37cc208b
# Development Guidelines<a name="EN-US_TOPIC_0000001062229264"></a>
- [When to Use](#section93012287133)
- [Available APIs](#section11821047161319)
- [How to Develop](#section10514141679)
- [Creating a Service Ability](#section19921154214315)
- [Development Guidelines on Bundle Management](#section1724016743217)
- [Packing a HAP File](#section171771212328)
## When to Use<a name="section93012287133"></a>
- Develop Page abilities for applications that have a UI for human-machine interaction, such as news applications, video players, navigation applications, and payment applications. Most applications we use in our daily lives are such type of applications.
- Develop Service abilities for applications so that they can run particular services in the background, such as music playing, computing, and navigation services.
- Pack both Page and Service abilities into HarmonyOS Ability Packages \(HAPs\). All applications must be packed into HAP files before being published to the application market. Once published, users can then download the applications from the application market.
## Available APIs<a name="section11821047161319"></a>
**Table 1** APIs of the ability management framework
<a name="table36761640135514"></a>
<table><thead align="left"><tr id="row570215713380"><th class="cellrowborder" valign="top" width="53.849999999999994%" id="mcps1.2.3.1.1"><p id="p1703155733819"><a name="p1703155733819"></a><a name="p1703155733819"></a>Function</p>
</th>
<th class="cellrowborder" valign="top" width="46.150000000000006%" id="mcps1.2.3.1.2"><p id="p37035579380"><a name="p37035579380"></a><a name="p37035579380"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row39211240205510"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p49215401550"><a name="p49215401550"></a><a name="p49215401550"></a>Want *WantParseUri(const char *uri)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p592164014553"><a name="p592164014553"></a><a name="p592164014553"></a>Converts a specified character string into a <strong id="b123303298245"><a name="b123303298245"></a><a name="b123303298245"></a>Want</strong> object.</p>
</td>
</tr>
<tr id="row192154055512"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p139212040175520"><a name="p139212040175520"></a><a name="p139212040175520"></a>const char *WantToUri(Want want)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p9921640135519"><a name="p9921640135519"></a><a name="p9921640135519"></a>Converts a specified <strong id="b26361419162420"><a name="b26361419162420"></a><a name="b26361419162420"></a>Want</strong> object into a character string.</p>
</td>
</tr>
<tr id="row16921440135520"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p1892124075519"><a name="p1892124075519"></a><a name="p1892124075519"></a>void SetWantElement(Want *want, ElementName element);</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p129214403555"><a name="p129214403555"></a><a name="p129214403555"></a>Sets the <strong id="b6704163515267"><a name="b6704163515267"></a><a name="b6704163515267"></a>element</strong> variable for a specified <strong id="b1759143810269"><a name="b1759143810269"></a><a name="b1759143810269"></a>Want</strong> object.</p>
</td>
</tr>
<tr id="row3921114018552"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p79210404555"><a name="p79210404555"></a><a name="p79210404555"></a>void SetWantData(Want *want, const void *data, uint16_t dataLength)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p09218402559"><a name="p09218402559"></a><a name="p09218402559"></a>Sets data to carry in a specified <strong id="b1317045311262"><a name="b1317045311262"></a><a name="b1317045311262"></a>Want</strong> object for starting a particular ability.</p>
</td>
</tr>
<tr id="row892124013556"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p4921040155510"><a name="p4921040155510"></a><a name="p4921040155510"></a>bool SetWantSvcIdentity(Want *want, SvcIdentity sid)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p992204013553"><a name="p992204013553"></a><a name="p992204013553"></a>Sets the <strong id="b171231625124319"><a name="b171231625124319"></a><a name="b171231625124319"></a>sid</strong> member variable for a specified <strong id="b11565173054314"><a name="b11565173054314"></a><a name="b11565173054314"></a>Want</strong> object.</p>
</td>
</tr>
<tr id="row99221840135520"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p139221840155519"><a name="p139221840155519"></a><a name="p139221840155519"></a>void ClearWant(Want *want)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p79221440185511"><a name="p79221440185511"></a><a name="p79221440185511"></a>Clears the memory of a specified <strong id="b233731018449"><a name="b233731018449"></a><a name="b233731018449"></a>Want</strong> object.</p>
</td>
</tr>
<tr id="row69221640125519"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p1792244017555"><a name="p1792244017555"></a><a name="p1792244017555"></a>void SetMainRoute(const std::string &amp;entry)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p7922174016558"><a name="p7922174016558"></a><a name="p7922174016558"></a>Sets the main route for the ability.</p>
</td>
</tr>
<tr id="row189221840165516"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p3922340125511"><a name="p3922340125511"></a><a name="p3922340125511"></a>void SetUIContent(RootView *rootView)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p9922240175511"><a name="p9922240175511"></a><a name="p9922240175511"></a>Sets the UI layout for the ability.</p>
</td>
</tr>
<tr id="row159226407552"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p1292213402552"><a name="p1292213402552"></a><a name="p1292213402552"></a>void OnStart(const Want&amp; intent)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p14922440195515"><a name="p14922440195515"></a><a name="p14922440195515"></a>Called when the ability is started. This callback is invoked to handle transitions between ability lifecycle states.</p>
</td>
</tr>
<tr id="row1392217402551"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p1292284065516"><a name="p1292284065516"></a><a name="p1292284065516"></a>void OnStop()</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p149223403554"><a name="p149223403554"></a><a name="p149223403554"></a>Called when the ability is being destroyed. This callback is invoked to handle transitions between ability lifecycle states.</p>
</td>
</tr>
<tr id="row169221407555"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p992218400556"><a name="p992218400556"></a><a name="p992218400556"></a>void OnActive(const Want&amp; intent)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p1923440135515"><a name="p1923440135515"></a><a name="p1923440135515"></a>Called when the ability is visible to users. This callback is invoked to handle transitions between ability lifecycle states.</p>
</td>
</tr>
<tr id="row9923640205516"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p19231340185511"><a name="p19231340185511"></a><a name="p19231340185511"></a>void OnInactive()</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p992311408556"><a name="p992311408556"></a><a name="p992311408556"></a>Called when the ability is invisible to users. This callback is invoked to handle transitions between ability lifecycle states.</p>
</td>
</tr>
<tr id="row4923154015557"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p99233404556"><a name="p99233404556"></a><a name="p99233404556"></a>void OnBackground()</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p79238400554"><a name="p79238400554"></a><a name="p79238400554"></a>Called when the ability is moved to the background. This callback is invoked to handle transitions between ability lifecycle states.</p>
</td>
</tr>
<tr id="row14923144045513"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p692354019558"><a name="p692354019558"></a><a name="p692354019558"></a>const SvcIdentity *OnConnect(const Want &amp;want)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p17923154085512"><a name="p17923154085512"></a><a name="p17923154085512"></a>Called when the Service ability is connected for the first time.</p>
</td>
</tr>
<tr id="row592313405552"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p1692312404551"><a name="p1692312404551"></a><a name="p1692312404551"></a>void OnDisconnect(const Want &amp;want);</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p892394017551"><a name="p892394017551"></a><a name="p892394017551"></a>Called when all abilities connected to the Service ability are disconnected.</p>
</td>
</tr>
<tr id="row3923194075515"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p5923240175516"><a name="p5923240175516"></a><a name="p5923240175516"></a>void MsgHandle(uint32_t funcId, IpcIo *request, IpcIo *reply);</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p2923184055518"><a name="p2923184055518"></a><a name="p2923184055518"></a>Handles a message sent by the client to the Service ability.</p>
</td>
</tr>
<tr id="row15923540155517"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p99231940105514"><a name="p99231940105514"></a><a name="p99231940105514"></a>void Dump(const std::string &amp;extra)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p18924174016554"><a name="p18924174016554"></a><a name="p18924174016554"></a>Prints ability information to the console.</p>
</td>
</tr>
<tr id="row1792414055517"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p1592454025513"><a name="p1592454025513"></a><a name="p1592454025513"></a>void Present(AbilitySlice *abilitySlice, const Want &amp;want)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p11924104045517"><a name="p11924104045517"></a><a name="p11924104045517"></a>Presents another ability slice.</p>
</td>
</tr>
<tr id="row15924114012556"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p13924154017551"><a name="p13924154017551"></a><a name="p13924154017551"></a>void Terminate()</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p11924104012557"><a name="p11924104012557"></a><a name="p11924104012557"></a>Destroys the ability slice.</p>
</td>
</tr>
<tr id="row2092484010558"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p4924540155515"><a name="p4924540155515"></a><a name="p4924540155515"></a>void SetUIContent(RootView *rootView)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p79241640185514"><a name="p79241640185514"></a><a name="p79241640185514"></a>Sets the UI layout for the host ability of the ability slice.</p>
</td>
</tr>
<tr id="row16924640195518"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p169245407559"><a name="p169245407559"></a><a name="p169245407559"></a>void OnStart(const Want&amp; want)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p492494095517"><a name="p492494095517"></a><a name="p492494095517"></a>Called when the ability slice is started. This callback is invoked to handle transitions between ability slice lifecycle states.</p>
</td>
</tr>
<tr id="row15924154065513"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p159242407559"><a name="p159242407559"></a><a name="p159242407559"></a>void OnStop()</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p13924114017556"><a name="p13924114017556"></a><a name="p13924114017556"></a>Called when the ability slice is being destroyed. This callback is invoked to handle transitions between ability slice lifecycle states.</p>
</td>
</tr>
<tr id="row13924154065517"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p292494005513"><a name="p292494005513"></a><a name="p292494005513"></a>void OnActive(const Want&amp; want)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p89256408553"><a name="p89256408553"></a><a name="p89256408553"></a>Called when the ability slice is visible to users. This callback is invoked to handle transitions between ability slice lifecycle states.</p>
</td>
</tr>
<tr id="row1925540125515"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p13925114015514"><a name="p13925114015514"></a><a name="p13925114015514"></a>void OnInactive()</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p892534025515"><a name="p892534025515"></a><a name="p892534025515"></a>Called when the ability slice is invisible to users. This callback is invoked to handle transitions between ability slice lifecycle states.</p>
</td>
</tr>
<tr id="row692519401558"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p1792515408558"><a name="p1792515408558"></a><a name="p1792515408558"></a>void OnBackground()</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p292554013551"><a name="p292554013551"></a><a name="p292554013551"></a>Called when the ability slice is moved to the background. This callback is invoked to handle transitions between ability slice lifecycle states.</p>
</td>
</tr>
<tr id="row129251040115515"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p0925174011553"><a name="p0925174011553"></a><a name="p0925174011553"></a>int StartAbility(const Want &amp;want)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p129251408557"><a name="p129251408557"></a><a name="p129251408557"></a>Starts an ability based on the specified <strong id="b3667652155017"><a name="b3667652155017"></a><a name="b3667652155017"></a>Want</strong> information.</p>
</td>
</tr>
<tr id="row3925940195519"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p19251440135512"><a name="p19251440135512"></a><a name="p19251440135512"></a>int StopAbility(const Want &amp;want)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p19925174035510"><a name="p19925174035510"></a><a name="p19925174035510"></a>Stops a Service ability based on the specified <strong id="b1176241795114"><a name="b1176241795114"></a><a name="b1176241795114"></a>Want</strong> information.</p>
</td>
</tr>
<tr id="row14925164055520"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p14925114015553"><a name="p14925114015553"></a><a name="p14925114015553"></a>int TerminateAbility()</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p39254405557"><a name="p39254405557"></a><a name="p39254405557"></a>Destroys the ability.</p>
</td>
</tr>
<tr id="row19925940115515"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p892584015559"><a name="p892584015559"></a><a name="p892584015559"></a>int ConnectAbility(const Want &amp;want, const IAbilityConnection &amp;conn, void *data);</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p4926640165513"><a name="p4926640165513"></a><a name="p4926640165513"></a>Connects to a <strong id="b10891169125217"><a name="b10891169125217"></a><a name="b10891169125217"></a>Service</strong> ability based on the specified <strong id="b184091115165216"><a name="b184091115165216"></a><a name="b184091115165216"></a>Want</strong> information.</p>
</td>
</tr>
<tr id="row10926540155513"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p119267409559"><a name="p119267409559"></a><a name="p119267409559"></a>int DisconnectAbility(const IAbilityConnection &amp;conn)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p592644085512"><a name="p592644085512"></a><a name="p592644085512"></a>Disconnects from a <strong id="b37531635205214"><a name="b37531635205214"></a><a name="b37531635205214"></a>Service</strong> ability.</p>
</td>
</tr>
<tr id="row11926340145516"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p892614035513"><a name="p892614035513"></a><a name="p892614035513"></a>const char *GetBundleName()</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p99261040105511"><a name="p99261040105511"></a><a name="p99261040105511"></a>Obtains the bundle name of the application to which the ability belongs.</p>
</td>
</tr>
<tr id="row7926440125519"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p4926114065519"><a name="p4926114065519"></a><a name="p4926114065519"></a>const char *GetSrcPath()</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p4926194055516"><a name="p4926194055516"></a><a name="p4926194055516"></a>Obtains the source code path of the ability.</p>
</td>
</tr>
<tr id="row29261840115519"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p1992604045519"><a name="p1992604045519"></a><a name="p1992604045519"></a>const char *GetDataPath()</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p109268403551"><a name="p109268403551"></a><a name="p109268403551"></a>Obtains the data path of the ability.</p>
</td>
</tr>
<tr id="row29261940195516"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p159267407555"><a name="p159267407555"></a><a name="p159267407555"></a>int StartAbility(const Want *want)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p1340210145179"><a name="p1340210145179"></a><a name="p1340210145179"></a>Starts an Ability. This function does not need to be used in applications developed based on <strong id="b12960101603119"><a name="b12960101603119"></a><a name="b12960101603119"></a>Ability</strong>.</p>
</td>
</tr>
<tr id="row16926240155514"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p1792617404558"><a name="p1792617404558"></a><a name="p1792617404558"></a>int ConnectAbility(const Want *want, const IAbilityConnection *conn, void *data);</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p1092612181812"><a name="p1092612181812"></a><a name="p1092612181812"></a>Connects to a Service ability based on the specified <strong id="b71516265816"><a name="b71516265816"></a><a name="b71516265816"></a>Want</strong> information. This function does not need to be used in applications developed based on <strong id="b12877235205716"><a name="b12877235205716"></a><a name="b12877235205716"></a>Ability</strong>.</p>
</td>
</tr>
<tr id="row5927164010552"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p49271540165510"><a name="p49271540165510"></a><a name="p49271540165510"></a>int DisconnectAbility(const IAbilityConnection *conn);</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p1296152820189"><a name="p1296152820189"></a><a name="p1296152820189"></a>Disconnects from a Service ability. This function does not need to be used in applications developed based on <strong id="b1866210445818"><a name="b1866210445818"></a><a name="b1866210445818"></a>Ability</strong>.</p>
</td>
</tr>
<tr id="row89271040135517"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p13927194011558"><a name="p13927194011558"></a><a name="p13927194011558"></a>int StopAbility(const Want *want)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p7699548131819"><a name="p7699548131819"></a><a name="p7699548131819"></a>Stops a Service ability based on the specified <strong id="b53334211588"><a name="b53334211588"></a><a name="b53334211588"></a>Want</strong> information. This function does not need to be used in applications developed based on <strong id="b1466212716581"><a name="b1466212716581"></a><a name="b1466212716581"></a>Ability</strong>.</p>
</td>
</tr>
<tr id="row1992764065516"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p192716406556"><a name="p192716406556"></a><a name="p192716406556"></a>void (*OnAbilityConnectDone)(ElementName *elementName, SvcIdentity *serviceSid, int resultCode, void *data)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p0927940195510"><a name="p0927940195510"></a><a name="p0927940195510"></a>Called when a client is connected to a Service ability.</p>
</td>
</tr>
<tr id="row7927134010559"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p692764095510"><a name="p692764095510"></a><a name="p692764095510"></a>void (*OnAbilityDisconnectDone)(ElementName *elementName, int resultCode, void *data)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p18927124035516"><a name="p18927124035516"></a><a name="p18927124035516"></a>Called after all connections to a Service ability are disconnected.</p>
</td>
</tr>
<tr id="row692784020556"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p17927104010557"><a name="p17927104010557"></a><a name="p17927104010557"></a>void PostTask(const Task&amp; task)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p13927940105516"><a name="p13927940105516"></a><a name="p13927940105516"></a>Posts a task to an asynchronous thread.</p>
</td>
</tr>
<tr id="row392784013552"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p1092794014555"><a name="p1092794014555"></a><a name="p1092794014555"></a>void PostQuit()</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p19281940185510"><a name="p19281940185510"></a><a name="p19281940185510"></a>Quits the event loop of the current thread.</p>
</td>
</tr>
<tr id="row2928140145519"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p292813401555"><a name="p292813401555"></a><a name="p292813401555"></a>static AbilityEventHandler* GetCurrentHandler()</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p9928154012554"><a name="p9928154012554"></a><a name="p9928154012554"></a>Obtains the event handler of the current thread.</p>
</td>
</tr>
<tr id="row15928174035513"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p1692824017551"><a name="p1692824017551"></a><a name="p1692824017551"></a>void Run()</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p592820401558"><a name="p592820401558"></a><a name="p592820401558"></a>Starts running the event loop of the current thread.</p>
</td>
</tr>
<tr id="row15928174013554"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p17928440125516"><a name="p17928440125516"></a><a name="p17928440125516"></a>#define REGISTER_AA(className)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p1892817404554"><a name="p1892817404554"></a><a name="p1892817404554"></a>Registers the class name of an <strong id="b102356594597"><a name="b102356594597"></a><a name="b102356594597"></a>Ability</strong> child class.</p>
</td>
</tr>
<tr id="row17928640135519"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p199281640125520"><a name="p199281640125520"></a><a name="p199281640125520"></a>#define REGISTER_AS(className)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p1792811409556"><a name="p1792811409556"></a><a name="p1792811409556"></a>Registers the class name of an <strong id="b691819710011"><a name="b691819710011"></a><a name="b691819710011"></a>AbilitySlice</strong> child class.</p>
</td>
</tr>
</tbody>
</table>
## How to Develop<a name="section10514141679"></a>
### Creating a Service Ability<a name="section19921154214315"></a>
1. Create the **MyServiceAbility** child class from **Ability** in **my\_service\_ability.h**.
```
class MyServiceAbility: public Ability {
protected:
void OnStart(const Want& want);
const SvcIdentity *OnConnect(const Want &want) override;
void MsgHandle(uint32_t funcId, IpcIo *request, IpcIo *reply) override;
};
```
2. Call the **REGISTER\_AA** macro to register the **ServiceAbility** class with the application framework so that the framework can instantiate the **MyServiceAbility** class you have created.
```
#include "my_service_ability.h"
REGISTER_AA(ServiceAbility)
void MyServiceAbility::OnStart(const Want& want)
{
printf("ServiceAbility::OnStart\n");
Ability::OnStart(want);
}
const SvcIdentity *MyServiceAbility::OnConnect(const Want &want)
{
printf("ServiceAbility::OnConnect\n");
return Ability::OnConnect(want);
}
void MyServiceAbility::MsgHandle(uint32_t funcId, IpcIo *request, IpcIo *reply)
{
printf("ServiceAbility::MsgHandle, funcId is %u\n", funcId);
int result = 0;
if (funcId == 0) {
result = IpcIoPopInt32(request) + IpcIoPopInt32(request);
}
// push data
IpcIoPushInt32(reply, result);
}
```
3. Override the following lifecycle callbacks for Service abilities to implement your own logic for your Service ability. When overriding a lifecycle callback, you must call the corresponding function from the parent class.
- OnStart\(\)
This callback is invoked when a Service ability is being created to perform Service ability initialization operations that take a short time. This callback is invoked only once in the entire lifecycle of a Service ability.
```
void MyServiceAbility::OnStart(const Want& want)
{
printf("ServiceAbility::OnStart\n");
Ability::OnStart(want);
}
```
- OnConnect\(\)
This callback is invoked when another ability is connected to the Service ability. This callback returns an **SvcIdentity** object for the other ability to interact with the Service ability.
```
const SvcIdentity *MyServiceAbility::OnConnect(const Want &want)
{
printf("ServiceAbility::OnConnect\n");
return Ability::OnConnect(want);
}
```
- OnDisconnect​\(\)
This callback is invoked when another ability is disconnected from the Service ability.
- OnStop\(\)
This callback is invoked when a Service ability is destroyed. You should override this callback for your Service ability to clear its resources, such as threads and registered listeners.
4. Override the message handling function.
The **MsgHandle** function is used by Service abilities to handle messages sent from clients. **funcId** indicates the type of the message sent from the client, and **request** indicates the pointer to the serialized request parameters sent from the client. If you want to send the result back after the message is handled, serialize the result and write it into **reply**.
```
void ServiceAbility::MsgHandle(uint32_t funcId, IpcIo *request, IpcIo *reply)
{
printf("ServiceAbility::MsgHandle, funcId is %d\n", funcId);
int result = 0;
if (funcId == PLUS) {
result = IpcIoPopInt32(request) + IpcIoPopInt32(request);
}
// push data
IpcIoPushInt32(reply, result);
}
```
5. Register a Service ability.
Declare your Service ability in the **config.json** file by setting its **type** attribute to **service**.
```
"abilities": [{
"name": "ServiceAbility",
"icon": "res/drawable/phone.png",
"label": "test app 2",
"launchType": "standard",
"type": "service",
"visible": true
}
]
```
6. Start a Service ability.
- The **Ability** class provides the **StartAbility\(\)** function to start another ability. You can pass a **Want** object to this function to start a Service ability.
You can use the **SetWantElement\(\)** function provided in the **AbilityKit** to set information about the target Service ability to start. The **element** parameter of the **SetWantElement\(\)** function indicates the **ElementName** structure that contains the bundle name and target ability name required for starting an ability.
```
{
Want want = { nullptr };
ElementName element = { nullptr };
SetElementBundleName(&element, "com.company.appname");
SetElementAbilityName(&element, "ServiceAbility");
SetWantElement(&want, element);
StartAbility(want);
ClearElement(&element);
ClearWant(&want);
}
```
The **StartAbility\(\)** function is executed immediately. If the Service ability is not running while the function is called, the system invokes **OnStart\(\)** first.
- Stops a Service ability.
Once created, the Service ability keeps running in the background. You can call **StopAbility\(\)** to stop the Service ability.
7. Connect to a Service ability.
- If you need to connect a Service ability to a Page ability or to a Service ability in another application, you should first create a Service ability for connection. A Service ability allows other abilities to connect to it through **ConnectAbility\(\)** by passing a **Want** object that contains information about the target Service ability to the function. You can implement callbacks in **IAbilityConnection** to be invoked when a Service ability is connected or disconnected. The **OnAbilityConnectDone\(\)** callback is invoked when an ability is connected, and **OnAbilityDisconnectDone\(\)** is invoked when an ability is disconnected.
```
{
// Create an IAbilityConnection object and implement the two callbacks.
IAbilityConnection abilityConnection = new IAbilityConnection();
abilityConnection->OnAbilityConnectDone = OnAbilityConnectDone;
abilityConnection->OnAbilityDisconnectDone = OnAbilityDisconnectDone;
void OnAbilityConnectDone(ElementName *elementName, SvcIdentity *serviceSid,
int resultCode, void *data)
{
if (resultCode != 0) {
return;
}
// Push data.
IpcIo request;
char dataBuffer[IPC_IO_DATA_MAX];
IpcIoInit(&request, dataBuffer, IPC_IO_DATA_MAX, 0);
IpcIoPushInt32(&request, 10);
IpcIoPushInt32(&request, 6);
// Send and receive the reply.
IpcIo reply;
uintptr_t ptr = 0;
if (Transact(nullptr, *serviceSid, 0, &request, &reply,
LITEIPC_FLAG_DEFAULT, &ptr) != LITEIPC_OK) {
printf("transact error\n");
return;
}
int result = IpcIoPopInt32(&reply);
printf("execute add method, result is %d\n", result);
if (ptr != 0) {
FreeBuffer(nullptr, reinterpret_cast<void *>(ptr));
}
}
void OnAbilityDisconnectDone(ElementName *elementName,
int resultCode, void *data)
{
printf("elementName is %s, %s\n",
elementName->bundleName, elementName->abilityName);
}
}
```
- The following sample code snippet shows how to initiate ability connection and disconnection:
```
{
// Connect an ability to a specified Service ability.
Want want = { nullptr };
ElementName element = { nullptr };
SetElementBundleName(&element, "com.company.appname");
SetElementAbilityName(&element, "ServiceAbility");
SetWantElement(&want, element);
ConnectAbility(want, *abilityConnection, this);
// Disconnect from a Service ability.
DisconnectAbility(*abilityConnection);
}
```
### Development Guidelines on Bundle Management<a name="section1724016743217"></a>
**Installing an Application**
The installation API can only be used by built-in system applications. Applications can be installed in either of the following paths:
- Default installation directory **/storage/app/** in the system
- Particular directory on the external storage, for example, a microSD card
You can specify the installation path when creating an **InstallParam** instance. To install the application in the **/storage/app/** directory, set the **installLocation** member variable in the **InstallParam** instance to **INSTALL\_LOCATION\_INTERNAL\_ONLY**. To install the application in the **/sdcard/app/** directory of the external storage, set **installLocation** to **INSTALL\_LOCATION\_PREFER\_EXTERNAL**. The application installation process is asynchronous, and a semaphore-like mechanism is required to ensure that the installation callback can be executed.
The procedure for installing an application is as follows \(the system directory is used as an example\):
1. Place the signed HAP file in a specified directory.
2. Create an **InstallParam** instance and define the semaphore.
```
InstallParam installParam = {
.installLocation = INSTALL_LOCATION_INTERNAL_ONLY, // Install the application in the system directory.
.keepData = false
};
static sem_t g_sem;
```
3. Define the callback function.
```
static void InstallCallback(const uint8_t resultCode, const void *resultMessage)
{
std::string strMessage = reinterpret_cast<const char *>(resultMessage);
if (!strMessage.empty()) {
printf("install resultMessage is %s, %d\n", strMessage.c_str(),resultCode);
}
sem_post(&g_sem);
}
```
4. Call the **Install** function.
```
const uint32_t WAIT_TIMEOUT = 30;
sem_init(&g_sem, 0, 0);
std::string installPath = "/storage/bundle/demo.hap"; // Specify the path where the HAP file is stored.
bool result = Install(installPath.c_str(), &installParam, InstallCallback);
struct timespec ts = {};
clock_gettime(CLOCK_REALTIME, &ts);
ts.tv_sec += WAIT_TIMEOUT; // Release the semaphore upon timeout.
sem_timedwait(&g_sem, &ts);
```
**Uninstalling an Application**
When uninstalling an application, you can specify whether to retain application data using the **keepData** member variable in the created **InstallParam** instance. If **keepData** is set to **true**, the application data will be retained after the application is uninstalled. If the variable is set to **false**, the application data will be removed during application installation.
1. Create an **InstallParam** instance and define the semaphore.
```
static sem_t g_sem;
InstallParam installParam = {
.installLocation = 1,
.keepData = false // Remove application data.
};
```
2. Define the callback function.
```
static void UninstallCallback(const uint8_t resultCode, const void *resultMessage)
{
std::string strMessage = reinterpret_cast<const char *>(resultMessage);
if (!strMessage.empty()) {
printf("uninstall resultMessage is %s\n", strMessage.c_str());
g_resultMessage = strMessage;
}
g_resultCode = resultCode;
sem_post(&g_sem);
}
```
3. Call the **Uninstall** function.
```
sem_init(&g_sem, 0, 0);
const uint32_t WAIT_TIMEOUT = 30;
std::string BUNDLE_NAME = "com.huawei.demo"; // Bundle name of the application to be uninstalled
Uninstall(BUNDLE_NAME.c_str(), &installParam, UninstallCallback);
struct timespec ts = {};
clock_gettime(CLOCK_REALTIME, &ts);
ts.tv_sec += WAIT_TIMEOUT;
sem_timedwait(&g_sem, &ts);
```
**Querying Bundle Information About an Installed Application**
You can use the **GetBundleInfo** function provided by **BundleManager** to query the bundle information about installed applications in the system.
1. Create and initialize a **BundleInfo** object.
```
BundleInfo bundleInfo;
(void) memset_s(&bundleInfo, sizeof(BundleInfo), 0, sizeof(BundleInfo));
```
2. Call **GetBundleInfo** to obtain bundle information about a specified application. The **bundleName** parameter indicates the pointer to the application bundle name, and the **flags** parameter specifies whether the obtained **BundleInfo** object can contain **AbilityInfo**.
```
std::string BUNDLE_NAME = "com.huawei.demo";
uint8_t ret = GetBundleInfo(BUNDLE_NAME.c_str(), 1, &bundleInfo); // When flags is set to 1, the obtained BundleInfo object contains AbilityInfo.
```
3. After you finish using the obtained **BundleInfo** object, clear the memory space occupied by the object in a timely manner to prevent memory leakage.
```
ClearBundleInfo(&bundleInfo);
```
### Packing a HAP File<a name="section171771212328"></a>
The packing tool is generally integrated into the development tool or IDE, and you rarely have the occasion to use it directly. This section is provided for you to have a general knowledge of the packing tool. The JAR file of the packing tool is stored in the **developtools/packing\_tool/jar** directory of the open-source code.
- CLI command parameters for packing a HAP file
**Table 2** Description of resource files required for packing
<a name="table2151102833212"></a>
<table><thead align="left"><tr id="row314812893218"><th class="cellrowborder" valign="top" width="25%" id="mcps1.2.5.1.1"><p id="p1614732812320"><a name="p1614732812320"></a><a name="p1614732812320"></a>Command Parameter</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.2.5.1.2"><p id="p214722819322"><a name="p214722819322"></a><a name="p214722819322"></a>Resource File</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.2.5.1.3"><p id="p214714286324"><a name="p214714286324"></a><a name="p214714286324"></a>Description</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.2.5.1.4"><p id="p1014712863211"><a name="p1014712863211"></a><a name="p1014712863211"></a>Initial Value Allowed</p>
</th>
</tr>
</thead>
<tbody><tr id="row614812289322"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p16148182853216"><a name="p16148182853216"></a><a name="p16148182853216"></a>--mode</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.2 "><p id="p5148162814328"><a name="p5148162814328"></a><a name="p5148162814328"></a>-</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.3 "><p id="p11481228143215"><a name="p11481228143215"></a><a name="p11481228143215"></a>This parameter is set to <strong id="b5192781718"><a name="b5192781718"></a><a name="b5192781718"></a>hap</strong> for packing the resource files into a HAP file.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.4 "><p id="p11148132811325"><a name="p11148132811325"></a><a name="p11148132811325"></a>No</p>
</td>
</tr>
<tr id="row81486283327"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p6148132833215"><a name="p6148132833215"></a><a name="p6148132833215"></a>--json-path</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.2 "><p id="p214810286325"><a name="p214810286325"></a><a name="p214810286325"></a>Configuration file <strong id="b88502557175"><a name="b88502557175"></a><a name="b88502557175"></a>config.json</strong></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.3 "><p id="p514802823216"><a name="p514802823216"></a><a name="p514802823216"></a>-</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.4 "><p id="p4148182813326"><a name="p4148182813326"></a><a name="p4148182813326"></a>No</p>
</td>
</tr>
<tr id="row1214917281322"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p171497285322"><a name="p171497285322"></a><a name="p171497285322"></a>--resources-path</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.2 "><p id="p414914286320"><a name="p414914286320"></a><a name="p414914286320"></a>Resource file <strong id="b62311484202"><a name="b62311484202"></a><a name="b62311484202"></a>resources</strong></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.3 "><p id="p41492286324"><a name="p41492286324"></a><a name="p41492286324"></a>-</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.4 "><p id="p1114922812327"><a name="p1114922812327"></a><a name="p1114922812327"></a>Yes</p>
</td>
</tr>
<tr id="row14149122817322"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p11149528173218"><a name="p11149528173218"></a><a name="p11149528173218"></a>--assets-path</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.2 "><p id="p314918286324"><a name="p314918286324"></a><a name="p314918286324"></a>Resource file <strong id="b847745320206"><a name="b847745320206"></a><a name="b847745320206"></a>assets</strong></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.3 "><p id="p1414916284327"><a name="p1414916284327"></a><a name="p1414916284327"></a>-</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.4 "><p id="p9149122817324"><a name="p9149122817324"></a><a name="p9149122817324"></a>Yes</p>
</td>
</tr>
<tr id="row41501728193219"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p514918280325"><a name="p514918280325"></a><a name="p514918280325"></a>--lib-path</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.2 "><p id="p16149162823212"><a name="p16149162823212"></a><a name="p16149162823212"></a>Dependent library file</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.3 "><p id="p12149122853216"><a name="p12149122853216"></a><a name="p12149122853216"></a>-</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.4 "><p id="p614962853217"><a name="p614962853217"></a><a name="p614962853217"></a>Yes</p>
</td>
</tr>
<tr id="row131501928183212"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p4150122833213"><a name="p4150122833213"></a><a name="p4150122833213"></a>--shared-libs-path</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.2 "><p id="p15150112814322"><a name="p15150112814322"></a><a name="p15150112814322"></a>Shared library file</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.3 "><p id="p20150128113212"><a name="p20150128113212"></a><a name="p20150128113212"></a>The shared library is used by system applications in special cases.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.4 "><p id="p181501928183214"><a name="p181501928183214"></a><a name="p181501928183214"></a>Yes</p>
</td>
</tr>
<tr id="row10150142812329"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p1015011286320"><a name="p1015011286320"></a><a name="p1015011286320"></a>--ability-so-path</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.2 "><p id="p6150728123214"><a name="p6150728123214"></a><a name="p6150728123214"></a>SO file providing main functionality</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.3 "><p id="p16150192813323"><a name="p16150192813323"></a><a name="p16150192813323"></a>-</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.4 "><p id="p1315052811325"><a name="p1315052811325"></a><a name="p1315052811325"></a>Yes</p>
</td>
</tr>
<tr id="row51519280321"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p315092813214"><a name="p315092813214"></a><a name="p315092813214"></a>--index-path</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.2 "><p id="p1115012813325"><a name="p1115012813325"></a><a name="p1115012813325"></a>Resource index</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.3 "><p id="p111501028123220"><a name="p111501028123220"></a><a name="p111501028123220"></a>The resource index file is generated by the resource generation tool and integrated by the resource pipeline.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.4 "><p id="p1115122811326"><a name="p1115122811326"></a><a name="p1115122811326"></a>Yes</p>
</td>
</tr>
<tr id="row91511928203211"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p0151328173211"><a name="p0151328173211"></a><a name="p0151328173211"></a>--out-path</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.2 "><p id="p215112833214"><a name="p215112833214"></a><a name="p215112833214"></a>-</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.3 "><p id="p11151152833217"><a name="p11151152833217"></a><a name="p11151152833217"></a>This parameter indicates the output path of the generated HAP file. The default value is the current directory.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.4 "><p id="p1815110281328"><a name="p1815110281328"></a><a name="p1815110281328"></a>Yes</p>
</td>
</tr>
<tr id="row4151162812329"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p1015112280329"><a name="p1015112280329"></a><a name="p1015112280329"></a>--force</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.2 "><p id="p2151128133219"><a name="p2151128133219"></a><a name="p2151128133219"></a>-</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.3 "><p id="p9151928183218"><a name="p9151928183218"></a><a name="p9151928183218"></a>This parameter specifies whether to overwrite an existing file with the same name. The default value is <strong id="b867781662412"><a name="b867781662412"></a><a name="b867781662412"></a>false</strong>.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.4 "><p id="p171511728143217"><a name="p171511728143217"></a><a name="p171511728143217"></a>Yes</p>
</td>
</tr>
</tbody>
</table>
- Example HAP File Structure
- Development view
![](figures/en-us_image_0000001062942690.png)
- Compilation view
![](figures/en-us_image_0000001062334618.png)
- Run the following commands to pack a HAP file using the packing tool.
![](figures/en-us_image_0000001062476933.png)
```
$ java -jar hmos_app_packing_tool.jar --mode hap --json-path ./config.json --assets-path ./assets/ --ability-so-path ./libentry.so --index-path ./resources.index --out-path out/entry.hap --force true
```
docs-en/subsystems/dfx-3.md 0 → 100644
浏览文件 @ 37cc208b
# DFX<a name="EN-US_TOPIC_0000001062565873"></a>
The design for X \(DFX\) subsystem mainly includes design for reliability \(DFR\) and design for testability \(DFT\), providing code maintenance and testing.
As chip resources are limited and hardware platforms are diversified, component-based and customizable DFX frameworks are required for different hardware architectures and resources. DFX provides two types of lightweight frameworks, mini and featured, for hardware platforms powered by RISC-V, Cortex-M, and Cortex-A.
- mini: This framework is intended for hardware platforms with Cortex-M or equivalent processing capabilities. Specifically, the system memory is generally less than 512 KB, and there is only one lightweight file system that can be used in limited scenarios, or no file system at all. The mini framework complies with the Cortex Microcontroller Software Interface Standard \(CMSIS\). Related APIs are called to record logs about user tasks in buffers, and logging APIs are then asynchronously called to print the logs, as illustrated in the following figure.
**Figure 1** mini framework architecture<a name="fig470284245214"></a>
![](figures/en-us_image_0000001064795436.png)
- featured: This framework is intended for hardware platforms with Cortex-A or equivalent processing capabilities. Specifically, the system memory is generally greater than 512 KB, and there is a comprehensive file system for storing a large amount of data. The featured framework complies with the Portable Operating System Interface \(POSIX\) specifications.
**Figure 2** featured framework architecture<a name="fig1073631233910"></a>
![](figures/en-us_image_0000001064187438.png)
As shown in the figure, logs about the user-space processes or kernel tasks are written into the hilogtask and then stored in the ringbuffer. The user-space hilogcat and apphilogcat processes then output logs to the serial port and performs flushing-to-flash.
The details are as follows:
1. hilogtask: kernel task for logging
- This is a driver of the kernel. It is initialized during system startup.
- Kernel-space or user-space modules call the logging APIs to transfer the formatted log content to the hilogtask and store the content in a ringbuffer.
2. apphilogcat: stores logs in user space
- This is a user-space process. It reads the log content from the ringbuffer of the kernel and stores the content in the log file.
3. hilogcat: command line tool for viewing logs
This tool reads the log content in the ringbuffer via the kernel driver API, filters the content if required, and then outputs the content to **stdout**.
docs-en/subsystems/dfx.md 0 → 100644
浏览文件 @ 37cc208b
# DFX<a name="EN-US_TOPIC_0000001073655967"></a>
- **[DFX](dfx-3.md)**
- **[Development Guidelines on the mini Framework](development-guidelines-on-the-mini-framework.md)**
- **[Development Guidelines on the featured Framework](development-guidelines-on-the-featured-framework.md)**
- **[FAQ](faq-4.md)**
- **[Reference](reference.md)**
docs-en/subsystems/faq-4.md 0 → 100644
浏览文件 @ 37cc208b
# FAQ<a name="EN-US_TOPIC_0000001062423639"></a>
N/A
docs-en/subsystems/faq.md 0 → 100644
浏览文件 @ 37cc208b
# FAQ<a name="EN-US_TOPIC_0000001061877724"></a>
docs-en/subsystems/graphics-0.md 0 → 100644
浏览文件 @ 37cc208b
# Graphics<a name="EN-US_TOPIC_0000001051770388"></a>
- [UI Components](#section1987017145112)
- [Layouts](#section662016231612)
- [Animators](#section73736284117)
- [Input Events](#section672194012114)
- [Rendering](#section14338859916)
The OpenHarmony graphics subsystem provides you with basic UI and container components, including buttons, images, labels, lists, animators, scroll views, swipe views, fonts, clock, charts, canvas, sliders, and layouts. In addition, this subsystem provides the Design for X \(DFX\) capability to capture screenshots and export the component tree. It also implements features such as component rendering, animation, and input event distribution.
## UI Components<a name="section1987017145112"></a>
Contain a variety of basic components \(such as buttons, text, and progress bars\) and complex components \(such as page switching and image sequence frames\).
## Layouts<a name="section662016231612"></a>
Implement grid layout and flexible layout \(such as centered, left-aligned, and right-aligned\).
As each layout is a one-off, the positions of components in a specific layout are calculated each time related functions are called on the layout. However, if the position of a component changes with an operation \(dragging for example\), the positions of other associated components do not automatically change. To change them, you need to call the layout functions again.
## Animators<a name="section73736284117"></a>
Each time the Tick event is received, the Task Manager module periodically invokes callbacks upon attribute changes and then triggers redrawing to produce the desired animation effect.
You can call related functions to start, stop, pause, resume, create, and destroy an animator.
## Input Events<a name="section672194012114"></a>
Include touchscreen and physical key input events. Each time the GUI engine runs, the Input Manager module reads the input of all registered hardware devices and converts the input into various events for UI components to use.
## Rendering<a name="section14338859916"></a>
- 2D graphics rendering
Draws lines, rectangles, triangles, and arcs.
- Image rendering
Draws images of various types, such as RGB565, RGB888, ARGB8888, PNG, and JPG.
- Font rendering
Draws vector fonts in real time.
docs-en/subsystems/graphics.md
浏览文件 @ 37cc208b
# Graphics<a name="EN-US_TOPIC_0000001051770388"></a> # Graphics<a name="EN-US_TOPIC_0000001053134511"></a>
- [UI Components](#section1987017145112) - **[Graphics](graphics-0.md)**
- [Layouts](#section662016231612)
- [Animators](#section73736284117)
- [Input Events](#section672194012114)
- [Rendering](#section14338859916)
The OpenHarmony graphics subsystem provides you with basic UI and container components, including buttons, images, labels, lists, animators, scroll views, swipe views, fonts, clock, charts, canvas, sliders, and layouts. In addition, this subsystem provides the Design for X \(DFX\) capability to capture screenshots and export the component tree. It also implements features such as component rendering, animation, and input event distribution. - **[Development Guidelines on Container Components](development-guidelines-on-container-components.md)**
## UI Components<a name="section1987017145112"></a> - **[Development Guidelines on Layout Container Components](development-guidelines-on-layout-container-components.md)**
Contain a variety of basic components \(such as buttons, text, and progress bars\) and complex components \(such as page switching and image sequence frames\). - **[Development Guidelines on Common Components](development-guidelines-on-common-components.md)**
## Layouts<a name="section662016231612"></a> - **[Development Guidelines on Animators](development-guidelines-on-animators.md)**
Implement grid layout and flexible layout \(such as centered, left-aligned, and right-aligned\).
As each layout is a one-off, the positions of components in a specific layout are calculated each time related functions are called on the layout. However, if the position of a component changes with an operation \(dragging for example\), the positions of other associated components do not automatically change. To change them, you need to call the layout functions again.
## Animators<a name="section73736284117"></a>
Each time the Tick event is received, the Task Manager module periodically invokes callbacks upon attribute changes and then triggers redrawing to produce the desired animation effect.
You can call related functions to start, stop, pause, resume, create, and destroy an animator.
## Input Events<a name="section672194012114"></a>
Include touchscreen and physical key input events. Each time the GUI engine runs, the Input Manager module reads the input of all registered hardware devices and converts the input into various events for UI components to use.
## Rendering<a name="section14338859916"></a>
- 2D graphics rendering
Draws lines, rectangles, triangles, and arcs.
- Image rendering
Draws images of various types, such as RGB565, RGB888, ARGB8888, PNG, and JPG.
- Font rendering
Draws vector fonts in real time.
docs-en/subsystems/multimedia.md 0 → 100644
浏览文件 @ 37cc208b
# Multimedia<a name="EN-US_TOPIC_0000001074241327"></a>
- **[Overview](overview.md)**
- **[Development Guidelines on Photographing](development-guidelines-on-photographing.md)**
- **[Development Guidelines on Video Recording](development-guidelines-on-video-recording.md)**
- **[Development Guidelines on Previewing](development-guidelines-on-previewing.md)**
- **[Overview](overview-1.md)**
- **[Development Guidelines on Media Playback](development-guidelines-on-media-playback.md)**
- **[Development Guidelines on Media Recording](development-guidelines-on-media-recording.md)**
docs-en/subsystems/overview-1.md 0 → 100644
浏览文件 @ 37cc208b
# Overview<a name="EN-US_TOPIC_0000001051770578"></a>
- [Basic Concepts](#section967213571204)
- [Encoding and Decoding](#section1582020483111)
OpenHarmony multimedia services help you to develop for audio and video playback and recording.
- The media playback module facilitates the development of audio and video playback, including media file and stream playback, volume control, and playback progress control.
- The media recording module supports the development of audio and video recording and provides functions to set the size of captured video, encoding bit rate, encoder type, video frame rate, audio sampling rate, and output file format.
## Basic Concepts<a name="section967213571204"></a>
It is considered good practice that you understand the following concepts before starting development:
- Streaming media technology
The streaming media technology refers to a process to encode continuous video and audio data and store the data on a network server. A viewer can watch and listen to the video and audio during download with no need to wait for the completion of download.
- Video frame rate
The frame rate is used to measure the number of displayed frames, which is the number of images transmitted per second. The more frames per second \(FPS\), the smoother the video.
- Bit rate
Bit rate is the number of bits transmitted per unit of time. The commonly used unit is kbit/s.
- Sampling rate
The sampling rate is the number of samples per second taken from continuous signals to form discrete signals. The unit is hertz \(Hz\).
## Encoding and Decoding<a name="section1582020483111"></a>
Available audio and video encoding and decoding capabilities vary depending on device types. The following table lists supported specifications for available development boards.
**Table 1** Encoding and decoding specifications for different development boards
<a name="table1611142712535"></a>
<table><thead align="left"><tr id="row5129278531"><th class="cellrowborder" valign="top" width="7.520752075207521%" id="mcps1.2.5.1.1"><p id="p163711594517"><a name="p163711594517"></a><a name="p163711594517"></a>Device Type</p>
</th>
<th class="cellrowborder" valign="top" width="8.24082408240824%" id="mcps1.2.5.1.2"><p id="p1112727195316"><a name="p1112727195316"></a><a name="p1112727195316"></a>Development Board</p>
</th>
<th class="cellrowborder" valign="top" width="40.82408240824083%" id="mcps1.2.5.1.3"><p id="p14124279538"><a name="p14124279538"></a><a name="p14124279538"></a>Decoding</p>
</th>
<th class="cellrowborder" valign="top" width="43.41434143414341%" id="mcps1.2.5.1.4"><p id="p812132715535"><a name="p812132715535"></a><a name="p812132715535"></a>Encoding</p>
</th>
</tr>
</thead>
<tbody><tr id="row712427195316"><td class="cellrowborder" valign="top" width="7.520752075207521%" headers="mcps1.2.5.1.1 "><p id="p19371179459"><a name="p19371179459"></a><a name="p19371179459"></a>Cameras with a screen</p>
</td>
<td class="cellrowborder" valign="top" width="8.24082408240824%" headers="mcps1.2.5.1.2 "><p id="p1312182713535"><a name="p1312182713535"></a><a name="p1312182713535"></a>Hi3516</p>
</td>
<td class="cellrowborder" valign="top" width="40.82408240824083%" headers="mcps1.2.5.1.3 "><a name="ul178862023587"></a><a name="ul178862023587"></a><ul id="ul178862023587"><li>Audio: The MPEG-4 AAC Profile (AAC LC), mono and dual channels, and the MPEG-4 (.mp4 and .m4a) container format are supported.</li><li>Video: The H.265 (HEVC) and H.264 (AVC) (for streams encoded using a chip of the same type) and the MPEG-4 (.mp4) container format are supported.</li></ul>
</td>
<td class="cellrowborder" valign="top" width="43.41434143414341%" headers="mcps1.2.5.1.4 "><a name="ul5101301882"></a><a name="ul5101301882"></a><ul id="ul5101301882"><li>Audio: AAC-LC encoding, mono and dual channels, and the MPEG-4 (.mp4) container format are supported.</li><li>Video: H.264 and H.265 encoding and the MPEG-4 (.mp4) container format are supported.</li></ul>
</td>
</tr>
<tr id="row01212273532"><td class="cellrowborder" valign="top" width="7.520752075207521%" headers="mcps1.2.5.1.1 "><p id="p33711914515"><a name="p33711914515"></a><a name="p33711914515"></a>Cameras without a screen</p>
</td>
<td class="cellrowborder" valign="top" width="8.24082408240824%" headers="mcps1.2.5.1.2 "><p id="p51202713531"><a name="p51202713531"></a><a name="p51202713531"></a>Hi3518</p>
</td>
<td class="cellrowborder" valign="top" width="40.82408240824083%" headers="mcps1.2.5.1.3 "><a name="ul11786193316820"></a><a name="ul11786193316820"></a><ul id="ul11786193316820"><li>Audio: The MPEG-4 AAC Profile (AAC LC), mono and dual channels, and the MPEG-4 (.mp4 and .m4a) container format are supported.</li><li>Video: none</li></ul>
</td>
<td class="cellrowborder" valign="top" width="43.41434143414341%" headers="mcps1.2.5.1.4 "><a name="ul816485812814"></a><a name="ul816485812814"></a><ul id="ul816485812814"><li>Audio: AAC-LC encoding, mono and dual channels, and the MPEG-4 (.mp4) container format are supported.</li><li>Video: H.264 and H.265 encoding and the MPEG-4 (.mp4) container format are supported.</li></ul>
</td>
</tr>
<tr id="row1812172713534"><td class="cellrowborder" valign="top" width="7.520752075207521%" headers="mcps1.2.5.1.1 "><p id="p6371594514"><a name="p6371594514"></a><a name="p6371594514"></a>WLAN connecting devices</p>
</td>
<td class="cellrowborder" valign="top" width="8.24082408240824%" headers="mcps1.2.5.1.2 "><p id="p1212927165318"><a name="p1212927165318"></a><a name="p1212927165318"></a>Hi3861</p>
</td>
<td class="cellrowborder" valign="top" width="40.82408240824083%" headers="mcps1.2.5.1.3 "><p id="p9122271537"><a name="p9122271537"></a><a name="p9122271537"></a>N/A</p>
</td>
<td class="cellrowborder" valign="top" width="43.41434143414341%" headers="mcps1.2.5.1.4 "><p id="p2012122713531"><a name="p2012122713531"></a><a name="p2012122713531"></a>N/A</p>
</td>
</tr>
</tbody>
</table>
For details about the encoding and decoding specifications of Hi3516 and Hi3518, refer to their documentation.
docs-en/subsystems/overview-2.md 0 → 100644
浏览文件 @ 37cc208b
# Overview<a name="EN-US_TOPIC_0000001062225512"></a>
- [Basic Concepts](#section72601941194812)
- [Ability Management Framework](#section14633111813374)
- [Bundle Management Framework](#section1341146154412)
- [Working Principles](#section94302021112717)
- [Limitations and Constraints](#section89534912527)
The application framework is provided by OpenHarmony for you to develop OpenHarmony applications. It consists of two modules: ability management framework and bundle management framework.
## Basic Concepts<a name="section72601941194812"></a>
This section describes some basic concepts for you to better understand the OpenHarmony application framework before you start development.
## Ability Management Framework<a name="section14633111813374"></a>
The ability management framework manages running status of OpenHarmony applications.
**Figure 1** Architecture of the ability management framework<a name="fig9759195514371"></a>
![](figures/architecture-of-the-ability-management-framework.png "architecture-of-the-ability-management-framework")
- **Ability** is the minimum unit for the system to schedule applications. It is a component that can implement an independent functionality. An application can contain one or more **Ability** instances. There are two types of templates that you can use to create an **Ability** instance: Page and Service.
- An **Ability using the Page template** \(Page ability for short\) provides a UI for interacting with users.
- An **Ability using the Service template** does not have a UI and is used for running background tasks.
- An **AbilitySlice** represents a single screen and its control logic. It is specific to Page abilities. A Page ability may contain one ability slice or multiple ability slices that provide highly relevant capabilities.
**Figure 2** Relationship between a Page ability and its ability slices<a name="fig1065819910347"></a>
![](figures/relationship-between-a-page-ability-and-its-ability-slices.png "relationship-between-a-page-ability-and-its-ability-slices")
- **Lifecycle** is a general term for all states of an ability, including **INITIAL**, **INACTIVE**, **ACTIVE**, and **BACKGROUND**.
**Figure 3** Lifecycle state transition of a Page ability<a name="fig56111543375"></a>
![](figures/图片1.png)
- **OnStart\(\)**
This callback is invoked when the system first creates the Page ability. After this callback is executed, the Page ability enters the **INACTIVE** state. This callback is triggered only once in the entire lifecycle of each Page ability. You must override this callback and set the default ability slice to be displayed.
- **OnActive\(\)**
This callback is invoked when the Page ability in the **INACTIVE** state enters the foreground. After this callback is executed, the Page ability enters the **ACTIVE** state, in which it becomes interactive. The Page ability will stay in this state unless it loses focus upon a certain event, for example, when the user touches the Back button or navigates to another Page ability.
When such an event occurs, the Page ability returns to the **INACTIVE** state, and the system invokes the **OnInactive\(\)** callback. The Page ability may move to the **ACTIVE** state again, and the system will then invoke the **OnActive\(\)** callback again. You should implement both **OnActive\(\)** and **OnInactive\(\)** for a Page ability and use **OnActive\(\)** to obtain the resources released in **OnInactive\(\)**.
- **OnInactive\(\)**
This callback is invoked when the Page ability loses focus, and the Page ability then becomes **INACTIVE**. You can implement the behavior to perform after the Page ability loses focus.
- **OnBackground\(\)**
This callback is invoked based on the system resource status when the Page ability becomes invisible to the user. After this callback is executed, the Page ability enters the **BACKGROUND** state. You should release the resources that are no longer needed after the Page ability becomes invisible or perform time-consuming save operations in this callback.
- **OnForeground\(\)**
A Page ability in the **BACKGROUND** state still resides in memory. When the Page ability returns to the foreground \(for example, when the user navigates to this Page ability again\), the system first calls **OnForeground\(\)** to switch the Page ability to the **INACTIVE** state, and then calls **OnActive\(\)** to make it **ACTIVE**. You should use the **OnForeground\(\)** callback to reclaim the resources released in **OnBackground\(\)**. Currently, the **onForeground\(\)** callback is unavailable to lite devices.
- **OnStop\(\)**
This callback is invoked when the system is destroying a Page ability due to one of the following possible causes:
- The user explicitly closes the Page ability using a system management feature, for example, the task manager.
- The user behavior, for example, exiting an application, triggers the **TerminateAbility\(\)** function on the Page ability.
- The system needs to temporarily destroy the Page ability and re-create it due to configuration changes.
- The system automatically destroys a Page ability in the **BACKGROUND** state due to resource management purposes.
- **AbilityKit** is a development kit provided by the ability management framework. You can use this kit to develop applications based on the **Ability** component. There are two types of applications developed based on the **Ability** component: JS Ability developed using the JavaScript language and Native Ability developed using the C/C++ language. The JS application development framework encapsulates JavaScript UI components on the basis of the **AbilityKit** and is used to help you quickly develop JS Ability-based applications.
- **AbilityLoader** is used to register and load **Ability** classes. After creating an **Ability** class, you should first call the registration API defined in **AbilityLoader** to register the **Ability** class name with the ability management framework so that this **Ability** can be instantiated when being started.
- **AbilityManager** enables inter-process communication \(IPC\) between the **AbilityKit** and the Ability Manager Service.
- **EventHandler** is provided by the **AbilityKit** to enable inter-thread communication between abilities.
- The **Ability Manager Service** is a system service used to coordinate the running relationships and lifecycle states of **Ability** instances. It consists of the following modules:
- The service startup module starts and registers the Ability Manager Service.
- The service interface management module manages external capabilities provided by the Ability Manager Service.
- The process management module starts and destroys processes where **Ability** instances are running, and maintains the process information.
- The ability stack management module maintains the presentation sequence of abilities in the stack.
- The lifecycle scheduling module changes an ability to a particular state based on the current operation of the system.
- The connection management module manages connections to Service abilities.
- **AppSpawn** is a system service used to create the process for running an ability. This service has high permissions. It sets permissions for **Ability** instances and pre-loads some common modules to accelerate application startup.
## Bundle Management Framework<a name="section1341146154412"></a>
The bundle management framework is provided by OpenHarmony for you to manage application bundles.
**Figure 4** Architecture of the bundle management framework<a name="fig11490181810425"></a>
![](figures/architecture-of-the-bundle-management-framework.png "architecture-of-the-bundle-management-framework")
- **BundleKit** includes external APIs provided by the Bundle Manager Service, including the APIs for application installation and uninstallation, bundle information query, and bundle state change listeners.
- The **bundle scanning module** parses pre-installed or installed bundles on the local device and extracts information from them for the bundle management module to manage and make the information persistent for storage.
- The **bundle installation module** installs, uninstalls, and updates a bundle. The **bundle installation service** is an independent process that communicates with the Bundle Manager Service through IPC. It is used to create or delete installation directories and has high permissions.
- The **bundle management module** manages information related to application bundles and stores persistent bundle information.
- The **bundle security management module** verifies signatures, and grants and manages permissions.
## Working Principles<a name="section94302021112717"></a>
The Ability Manager Service and Bundle Manager Service are the core modules of the ability management framework and bundle management framework, respectively. The two system-level services are registered and discovered by using the system service framework SAMgr, and they are used by manage abilities and bundles for other processes. The Ability Manager Service and Bundle Manager Service are provided as open APIs in the **AbilityKit** and **BundleKit**.
**Figure 5** Startup of the Ability Manager Service and Bundle Manager Service<a name="fig13121104711910"></a>
![](figures/startup-of-the-ability-manager-service-and-bundle-manager-service.png "startup-of-the-ability-manager-service-and-bundle-manager-service")
OpenHarmony applications can be installed and started after the two services are started.
**Figure 6** Application startup process<a name="fig756104112311"></a>
![](figures/application-startup-process.png "application-startup-process")
The home screen is the first OpenHarmony application started by the Ability Manager Service. After the home screen is started, the user can touch any installed OpenHarmony application on the home screen to start the particular application. The figure above shows the interaction process of starting an installed application from the home screen.
As shown in the figure, the Ability Manager Service is responsible for displaying or hiding an ability, and the Bundle Manager Service is responsible for storing and querying ability information.
## Limitations and Constraints<a name="section89534912527"></a>
- Language version
- C++ 11 or later
- The specifications of the application framework vary depending on the System-on-a-Chip \(SoC\) and underlying OS capabilities.
- Cortex-M RAM and ROM
- RAM: greater than 20 KB \(recommended\)
- ROM: greater than 300 KB \(for the JS application development framework and related subsystems, such as UIKit and engine\)
- Cortex-A RAM and ROM
- RAM: greater than 2 MB \(recommended\)
- ROM: greater than 2 MB \(for the JS application development framework and related subsystems, such as UIKit and engine\)
docs-en/subsystems/overview.md
浏览文件 @ 37cc208b
...@@ -90,7 +90,7 @@ It is considered good practice that you understand the following concepts before ...@@ -90,7 +90,7 @@ It is considered good practice that you understand the following concepts before
Similarly, you can create a surface, implement consumer logic for it, and transfer it to the **Camera** instance. For example, transmit video streams over the network or save captured frame data as an image file. Similarly, you can create a surface, implement consumer logic for it, and transfer it to the **Camera** instance. For example, transmit video streams over the network or save captured frame data as an image file.
The graphics module also obtains stream resources from the camera module through surfaces. For details, see development guidelines on [Graphic](graphics.md). The graphics module also obtains stream resources from the camera module through surfaces. For details, see development guidelines on [Graphic](graphics-0.md).
- Camera running process - Camera running process
1. Creating a camera 1. Creating a camera
......
docs-en/subsystems/reference.md 0 → 100644
浏览文件 @ 37cc208b
# Reference<a name="EN-US_TOPIC_0000001063223654"></a>
- [Directory Structure](#section5487173174316)
## Directory Structure<a name="section5487173174316"></a>
**Table 1** Directory structure of the source code for DFX
<a name="table66755210373"></a>
<table><thead align="left"><tr id="row56777233718"><th class="cellrowborder" valign="top" width="36.09%" id="mcps1.2.3.1.1"><p id="p1367713214377"><a name="p1367713214377"></a><a name="p1367713214377"></a>Directory</p>
</th>
<th class="cellrowborder" valign="top" width="63.91%" id="mcps1.2.3.1.2"><p id="p36771228375"><a name="p36771228375"></a><a name="p36771228375"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row66782283710"><td class="cellrowborder" valign="top" width="36.09%" headers="mcps1.2.3.1.1 "><p id="p1167811273717"><a name="p1167811273717"></a><a name="p1167811273717"></a>hiviewdfx/interface</p>
</td>
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.2.3.1.2 "><p id="p1467912223712"><a name="p1467912223712"></a><a name="p1467912223712"></a>Stores all header files for open APIs.</p>
</td>
</tr>
<tr id="row1167910233715"><td class="cellrowborder" valign="top" width="36.09%" headers="mcps1.2.3.1.1 "><p id="p106801023374"><a name="p106801023374"></a><a name="p106801023374"></a>hiviewdfx/interfaces/kits/hilog</p>
</td>
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.2.3.1.2 "><p id="p668013223716"><a name="p668013223716"></a><a name="p668013223716"></a>Defines open APIs available for logs in the featured framework.</p>
</td>
</tr>
<tr id="row166801626377"><td class="cellrowborder" valign="top" width="36.09%" headers="mcps1.2.3.1.1 "><p id="p9681162123713"><a name="p9681162123713"></a><a name="p9681162123713"></a>hiviewdfx/interfaces/kits/hilog_lite</p>
</td>
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.2.3.1.2 "><p id="p16814213713"><a name="p16814213713"></a><a name="p16814213713"></a>Defines open APIs available for logs in the mini framework.</p>
</td>
</tr>
<tr id="row1568116218371"><td class="cellrowborder" valign="top" width="36.09%" headers="mcps1.2.3.1.1 "><p id="p868115223710"><a name="p868115223710"></a><a name="p868115223710"></a>hiviewdfx/interfaces/innerkits/hievent_lite</p>
</td>
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.2.3.1.2 "><p id="p66823263717"><a name="p66823263717"></a><a name="p66823263717"></a>Defines open APIs available for event printing in the mini framework.</p>
</td>
</tr>
<tr id="row11682112203711"><td class="cellrowborder" valign="top" width="36.09%" headers="mcps1.2.3.1.1 "><p id="p96825213719"><a name="p96825213719"></a><a name="p96825213719"></a>hiviewdfx/services/hilogcat_lite</p>
</td>
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.2.3.1.2 "><p id="p36821528373"><a name="p36821528373"></a><a name="p36821528373"></a>Stores services and commands related to logs.</p>
</td>
</tr>
<tr id="row1768314213719"><td class="cellrowborder" valign="top" width="36.09%" headers="mcps1.2.3.1.1 "><p id="p156830213710"><a name="p156830213710"></a><a name="p156830213710"></a>hiviewdfx/services/hilogcat_lite/apphilogcat</p>
</td>
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.2.3.1.2 "><p id="p176847283719"><a name="p176847283719"></a><a name="p176847283719"></a>Provides the log flushing-to-disk service in the featured framework.</p>
</td>
</tr>
<tr id="row16841212371"><td class="cellrowborder" valign="top" width="36.09%" headers="mcps1.2.3.1.1 "><p id="p2068419220378"><a name="p2068419220378"></a><a name="p2068419220378"></a>hiviewdfx/services/hilogcat_lite/command</p>
</td>
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.2.3.1.2 "><p id="p7684627377"><a name="p7684627377"></a><a name="p7684627377"></a>Provides DFX commands specific to the mini framework.</p>
</td>
</tr>
<tr id="row1068414210373"><td class="cellrowborder" valign="top" width="36.09%" headers="mcps1.2.3.1.1 "><p id="p18685127370"><a name="p18685127370"></a><a name="p18685127370"></a>hiviewdfx/services/hilogcat_lite/hilogcat</p>
</td>
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.2.3.1.2 "><p id="p1868515233717"><a name="p1868515233717"></a><a name="p1868515233717"></a>Provides commands to output logs in the featured framework.</p>
</td>
</tr>
<tr id="row568610243714"><td class="cellrowborder" valign="top" width="36.09%" headers="mcps1.2.3.1.1 "><p id="p6686720376"><a name="p6686720376"></a><a name="p6686720376"></a>hiviewdfx/services/hiview_lite</p>
</td>
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.2.3.1.2 "><p id="p196875293712"><a name="p196875293712"></a><a name="p196875293712"></a>Registers the DFX service specific to the mini framework.</p>
</td>
</tr>
<tr id="row56871215376"><td class="cellrowborder" valign="top" width="36.09%" headers="mcps1.2.3.1.1 "><p id="p468710214371"><a name="p468710214371"></a><a name="p468710214371"></a>hiviewdfx/frameworks/ddrdump_lite</p>
</td>
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.2.3.1.2 "><p id="p2687152153717"><a name="p2687152153717"></a><a name="p2687152153717"></a>Dumps Double Data Rate (DDR) memory in the mini framework.</p>
</td>
</tr>
<tr id="row669011223710"><td class="cellrowborder" valign="top" width="36.09%" headers="mcps1.2.3.1.1 "><p id="p15690029377"><a name="p15690029377"></a><a name="p15690029377"></a>hiviewdfx/frameworks/hievent_lite</p>
</td>
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.2.3.1.2 "><p id="p56911927374"><a name="p56911927374"></a><a name="p56911927374"></a>Records event printing in the mini framework.</p>
</td>
</tr>
<tr id="row196911922371"><td class="cellrowborder" valign="top" width="36.09%" headers="mcps1.2.3.1.1 "><p id="p1969222203712"><a name="p1969222203712"></a><a name="p1969222203712"></a>hiviewdfx/frameworks/hilog_lite</p>
</td>
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.2.3.1.2 "><p id="p1669213210373"><a name="p1669213210373"></a><a name="p1669213210373"></a>Defines APIs for logging.</p>
</td>
</tr>
<tr id="row166921927372"><td class="cellrowborder" valign="top" width="36.09%" headers="mcps1.2.3.1.1 "><p id="p76931217377"><a name="p76931217377"></a><a name="p76931217377"></a>hiviewdfx/frameworks/hilog_lite/featured</p>
</td>
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.2.3.1.2 "><p id="p1069311212377"><a name="p1069311212377"></a><a name="p1069311212377"></a>Defines APIs for logging in the featured framework.</p>
</td>
</tr>
<tr id="row1669315213379"><td class="cellrowborder" valign="top" width="36.09%" headers="mcps1.2.3.1.1 "><p id="p7693152143719"><a name="p7693152143719"></a><a name="p7693152143719"></a>hiviewdfx/frameworks/hilog_lite/mini</p>
</td>
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.2.3.1.2 "><p id="p116931223711"><a name="p116931223711"></a><a name="p116931223711"></a>Defines APIs for logging in the mini framework.</p>
</td>
</tr>
<tr id="row769413216372"><td class="cellrowborder" valign="top" width="36.09%" headers="mcps1.2.3.1.1 "><p id="p769542113710"><a name="p769542113710"></a><a name="p769542113710"></a>hiviewdfx/utils/lite</p>
</td>
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.2.3.1.2 "><p id="p16951524379"><a name="p16951524379"></a><a name="p16951524379"></a>Stores utils, including the configuration items of the mini framework.</p>
</td>
</tr>
</tbody>
</table>
docs-en/subsystems/setting-up-a-development-environment.md 0 → 100644
浏览文件 @ 37cc208b
# Setting Up a Development Environment<a name="EN-US_TOPIC_0000001061629245"></a>
- Development board: Hi3516D V300
- [Download the source code](https://device.harmonyos.com/en/docs/start/get-code/oem_sourcecode_guide-0000001050769927).
- [Compile the application framework](https://gitee.com/openharmony/docs/blob/master/docs-en/readme/application-framework.md).
docs-en/subsystems/testing.md 0 → 100644
浏览文件 @ 37cc208b
# Testing<a name="EN-US_TOPIC_0000001074910589"></a>
- [Overview](#en-us_topic_0000001059860314_section12403172115920)
- [Basic Concepts](#en-us_topic_0000001059860314_section53632272090)
- [Working Principles](#en-us_topic_0000001059860314_section2394431106)
- [Limitations and Constraints](#en-us_topic_0000001059860314_section2029921310472)
- [Function Constraints](#en-us_topic_0000001059860314_section172441620111610)
- [Operation Constraints](#en-us_topic_0000001059860314_section201523661616)
- [Setting Up a Test Environment](#en-us_topic_0000001059860314_section175012297491)
- [Environment Requirements](#en-us_topic_0000001059860314_section935055691014)
- [Installing the Environment](#en-us_topic_0000001059860314_section6511193210111)
- [Verifying the Test Environment](#en-us_topic_0000001059860314_section1899144517117)
- [Development Guidelines](#en-us_topic_0000001059860314_section16741101301210)
- [When to Use](#en-us_topic_0000001059860314_section93782214124)
- [Available APIs](#en-us_topic_0000001059860314_section54131732101218)
- [How to Develop](#en-us_topic_0000001059860314_section53541946111218)
- [Development Example](#en-us_topic_0000001059860314_section7477121918136)
- [Directory Structure](#en-us_topic_0000001059860314_section1875515364133)
## Overview<a name="en-us_topic_0000001059860314_section12403172115920"></a>
### Basic Concepts<a name="en-us_topic_0000001059860314_section53632272090"></a>
The testing subsystem provides a one-click Python-based self-test platform for developers. It also supports operations on third-party testing frameworks, including compiling, managing, scheduling and distributing, and executing test cases, collecting test results, generating test reports, creating test case templates, and managing test environments.
Before development using the testing subsystem, you need to understand the following concepts:
- Test case compilation
This operation compiles the source code of test cases into binary files that can be executed on the tested device.
- Test case scheduling & distributing
This operation distributes test cases to different tested devices through the network port or serial port, and allocates a specific executor for each test case.
- Test case executor
A test case executor integrates the unit testing frameworks for different programming languages, such as Unity, and defines the execution logic of each test case, such as its pre-processing, execution, and result recording.
- Test case template
A test case template defines respective unified formats for test cases and for GN files.
- Test tool kit
The test tool kit provides common methods to be used during the running of the test tool, for example, providing the test case directory to mount the file system to a tested device, distributing test cases to the tested device, or obtaining test results from the tested device.
- Test report generation
This operation defines a template for generating self-test reports and converts the XML file of a report into an HTML file.
- Test environment management
The tested devices can be managed through the USB port or serial port, including discovering a device and querying the device status.
### Working Principles<a name="en-us_topic_0000001059860314_section2394431106"></a>
- The following figure shows the architecture of the test tool.
**Figure 1** Test tool architecture<a name="en-us_topic_0000001059860314_fig418674910399"></a>
![](figures/test-tool-architecture.png "test-tool-architecture")
- The following figure shows the running sequence diagram of the test tool.
**Figure 2** Running sequence of the test tool<a name="en-us_topic_0000001059860314_fig107203017407"></a>
![](figures/running-sequence-of-the-test-tool.png "running-sequence-of-the-test-tool")
- Working principle of the test tool
The test tool is started using a shell script. It executes a series of testing commands entered on the command line interface \(CLI\) and prints the command output.
## Limitations and Constraints<a name="en-us_topic_0000001059860314_section2029921310472"></a>
### Function Constraints<a name="en-us_topic_0000001059860314_section172441620111610"></a>
- Application scope
Self-test tools support only code-level test case development and verification, such as unit testing and module testing.
- Specifications
Currently, the testing frameworks support only white-box testing.
### Operation Constraints<a name="en-us_topic_0000001059860314_section201523661616"></a>
Only one test platform can be started on a testing device.
## Setting Up a Test Environment<a name="en-us_topic_0000001059860314_section175012297491"></a>
### Environment Requirements<a name="en-us_topic_0000001059860314_section935055691014"></a>
**Table 1** Environment requirements
<a name="en-us_topic_0000001059860314_table13112443615"></a>
<table><thead align="left"><tr id="en-us_topic_0000001059860314_row1947247360"><th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.2.4.1.1"><p id="en-us_topic_0000001059860314_p64172414367"><a name="en-us_topic_0000001059860314_p64172414367"></a><a name="en-us_topic_0000001059860314_p64172414367"></a>Item</p>
</th>
<th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.2.4.1.2"><p id="en-us_topic_0000001059860314_p6452410368"><a name="en-us_topic_0000001059860314_p6452410368"></a><a name="en-us_topic_0000001059860314_p6452410368"></a>Testing Device</p>
</th>
<th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.2.4.1.3"><p id="en-us_topic_0000001059860314_p94924103617"><a name="en-us_topic_0000001059860314_p94924103617"></a><a name="en-us_topic_0000001059860314_p94924103617"></a>Tested Device</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0000001059860314_row10452414368"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.1 "><p id="en-us_topic_0000001059860314_p1422414368"><a name="en-us_topic_0000001059860314_p1422414368"></a><a name="en-us_topic_0000001059860314_p1422414368"></a>Hardware</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.2 "><a name="en-us_topic_0000001059860314_ul19802171518438"></a><a name="en-us_topic_0000001059860314_ul19802171518438"></a><ul id="en-us_topic_0000001059860314_ul19802171518438"><li>Memory: 8 GB or above</li><li>Hard disk space: 100 GB or above</li><li>Hardware architecture: x86 or ARM64</li></ul>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="en-us_topic_0000001059860314_p5417240364"><a name="en-us_topic_0000001059860314_p5417240364"></a><a name="en-us_topic_0000001059860314_p5417240364"></a>Hi3516D V300 development board</p>
<p id="en-us_topic_0000001059860314_p1286125194416"><a name="en-us_topic_0000001059860314_p1286125194416"></a><a name="en-us_topic_0000001059860314_p1286125194416"></a>Hi3518E V300 development board</p>
</td>
</tr>
<tr id="en-us_topic_0000001059860314_row24182410361"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.1 "><p id="en-us_topic_0000001059860314_p45102453620"><a name="en-us_topic_0000001059860314_p45102453620"></a><a name="en-us_topic_0000001059860314_p45102453620"></a>Software</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.2 "><a name="en-us_topic_0000001059860314_ul16677122216594"></a><a name="en-us_topic_0000001059860314_ul16677122216594"></a><ul id="en-us_topic_0000001059860314_ul16677122216594"><li>OS: Windows 10 (64-bit) or Ubuntu 18.04<p id="en-us_topic_0000001059860314_p717443952718"><a name="en-us_topic_0000001059860314_p717443952718"></a><a name="en-us_topic_0000001059860314_p717443952718"></a>System component (Linux): libreadline-dev</p>
</li><li>Python: 3.7.5 or later</li><li>Python plug-ins: pySerial 3.3 or later, Paramiko 2.7.1 or later, Setuptools 40.8.0 or later, and RSA 4.0 or later</li><li>NFS server: haneWIN NFS Server 1.2.50 or later, or NFSv4 or later</li></ul>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><a name="en-us_topic_0000001059860314_ul20976824133414"></a><a name="en-us_topic_0000001059860314_ul20976824133414"></a><ul id="en-us_topic_0000001059860314_ul20976824133414"><li>OS: OpenHarmony 1.0 or later</li><li>Kernel: LiteOS Cortex-A or Linux kernel</li></ul>
</td>
</tr>
</tbody>
</table>
### Installing the Environment<a name="en-us_topic_0000001059860314_section6511193210111"></a>
1. Go to the **test/xdevice** directory and run the **python setup.py install** command.
2. \(Optional\) If the test environment runs Linux, run the following command to install system component readline:
```
sudo apt-get install libreadline-dev
```
3. Install Python extension plug-ins pySerial, Setuptools, RSA, and Paramiko.
Run the following command to install pySerial:
```
pip install pyserial
```
Run the following command to install Setuptools:
```
pip install setuptools
```
Run the following command to install RSA:
```
pip install rsa
```
Run the following command to install Paramiko:
```
pip install paramiko
```
4. Install an NFS server.
**Windows OS**
Download and install **haneWIN NFS Server 1.2.50** at https://www.hanewin.net/nfs-e.htm.
**Linux OS**
```
sudo apt install nfs-kernel-server
```
After the environment is installed, you can conduct coding and debugging for a test tool in an integrated development environment \(IDE\) \(DevEco Studio is recommended\).
### Verifying the Test Environment<a name="en-us_topic_0000001059860314_section1899144517117"></a>
**Table 2** Environment verification
<a name="en-us_topic_0000001059860314_table76761616112218"></a>
<table><thead align="left"><tr id="en-us_topic_0000001059860314_row6677121616229"><th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.2.4.1.1"><p id="en-us_topic_0000001059860314_p176771416182216"><a name="en-us_topic_0000001059860314_p176771416182216"></a><a name="en-us_topic_0000001059860314_p176771416182216"></a>Item</p>
</th>
<th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.2.4.1.2"><p id="en-us_topic_0000001059860314_p18677181612220"><a name="en-us_topic_0000001059860314_p18677181612220"></a><a name="en-us_topic_0000001059860314_p18677181612220"></a>Operation</p>
</th>
<th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.2.4.1.3"><p id="en-us_topic_0000001059860314_p5677151642215"><a name="en-us_topic_0000001059860314_p5677151642215"></a><a name="en-us_topic_0000001059860314_p5677151642215"></a>Requirement</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0000001059860314_row567731662216"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.1 "><p id="en-us_topic_0000001059860314_p1667711613224"><a name="en-us_topic_0000001059860314_p1667711613224"></a><a name="en-us_topic_0000001059860314_p1667711613224"></a>Check that a compliant Python version has been installed.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.2 "><p id="en-us_topic_0000001059860314_p16678101614220"><a name="en-us_topic_0000001059860314_p16678101614220"></a><a name="en-us_topic_0000001059860314_p16678101614220"></a>Run the <strong id="en-us_topic_0000001059860314_b7670932632"><a name="en-us_topic_0000001059860314_b7670932632"></a><a name="en-us_topic_0000001059860314_b7670932632"></a>python --version</strong> command.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="en-us_topic_0000001059860314_p6554216134112"><a name="en-us_topic_0000001059860314_p6554216134112"></a><a name="en-us_topic_0000001059860314_p6554216134112"></a>The Python version must be 3.7.5 or later.</p>
</td>
</tr>
<tr id="en-us_topic_0000001059860314_row559954144717"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.1 "><p id="en-us_topic_0000001059860314_p1259195419474"><a name="en-us_topic_0000001059860314_p1259195419474"></a><a name="en-us_topic_0000001059860314_p1259195419474"></a>Check that Python extension plug-ins have been installed.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.2 "><p id="en-us_topic_0000001059860314_p175925424714"><a name="en-us_topic_0000001059860314_p175925424714"></a><a name="en-us_topic_0000001059860314_p175925424714"></a>Access the <strong id="en-us_topic_0000001059860314_b35031935731"><a name="en-us_topic_0000001059860314_b35031935731"></a><a name="en-us_topic_0000001059860314_b35031935731"></a>test/xdevice</strong> directory and run <strong id="en-us_topic_0000001059860314_b155070352317"><a name="en-us_topic_0000001059860314_b155070352317"></a><a name="en-us_topic_0000001059860314_b155070352317"></a>run.bat</strong> or <strong id="en-us_topic_0000001059860314_b5507935931"><a name="en-us_topic_0000001059860314_b5507935931"></a><a name="en-us_topic_0000001059860314_b5507935931"></a>run.sh</strong>.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="en-us_topic_0000001059860314_p1040211281418"><a name="en-us_topic_0000001059860314_p1040211281418"></a><a name="en-us_topic_0000001059860314_p1040211281418"></a>The <strong id="en-us_topic_0000001059860314_b82085361632"><a name="en-us_topic_0000001059860314_b82085361632"></a><a name="en-us_topic_0000001059860314_b82085361632"></a>&gt;&gt;&gt;</strong> prompt is displayed.</p>
</td>
</tr>
<tr id="en-us_topic_0000001059860314_row66781016182213"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.1 "><p id="en-us_topic_0000001059860314_p8678416132217"><a name="en-us_topic_0000001059860314_p8678416132217"></a><a name="en-us_topic_0000001059860314_p8678416132217"></a>Check the NFS server status.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.2 "><p id="en-us_topic_0000001059860314_p56781416142210"><a name="en-us_topic_0000001059860314_p56781416142210"></a><a name="en-us_topic_0000001059860314_p56781416142210"></a>Log in to the development board through the serial port and run the <strong id="en-us_topic_0000001059860314_b194410371631"><a name="en-us_topic_0000001059860314_b194410371631"></a><a name="en-us_topic_0000001059860314_b194410371631"></a>mount</strong> command to mount the NFS server.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="en-us_topic_0000001059860314_p27475710414"><a name="en-us_topic_0000001059860314_p27475710414"></a><a name="en-us_topic_0000001059860314_p27475710414"></a>The file directory can be mounted properly.</p>
</td>
</tr>
</tbody>
</table>
## Development Guidelines<a name="en-us_topic_0000001059860314_section16741101301210"></a>
### When to Use<a name="en-us_topic_0000001059860314_section93782214124"></a>
Test cases are mainly used to conduct self-tests for service code and can be used in code-level unit testing, module testing, and performance testing.
### Available APIs<a name="en-us_topic_0000001059860314_section54131732101218"></a>
The testing framework integrates the open-source unit testing framework and expands the macros of the test cases. For details about the framework, see the official open-source documentation.
**Table 3** Expanded macros of the framework
<a name="en-us_topic_0000001059860314_table3247152012146"></a>
<table><thead align="left"><tr id="en-us_topic_0000001059860314_row824713209143"><th class="cellrowborder" valign="top" width="11.41%" id="mcps1.2.3.1.1"><p id="en-us_topic_0000001059860314_p52484202141"><a name="en-us_topic_0000001059860314_p52484202141"></a><a name="en-us_topic_0000001059860314_p52484202141"></a>Macro</p>
</th>
<th class="cellrowborder" valign="top" width="88.59%" id="mcps1.2.3.1.2"><p id="en-us_topic_0000001059860314_p1424812015145"><a name="en-us_topic_0000001059860314_p1424812015145"></a><a name="en-us_topic_0000001059860314_p1424812015145"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0000001059860314_row424892018145"><td class="cellrowborder" valign="top" width="11.41%" headers="mcps1.2.3.1.1 "><p id="en-us_topic_0000001059860314_p5248192016144"><a name="en-us_topic_0000001059860314_p5248192016144"></a><a name="en-us_topic_0000001059860314_p5248192016144"></a>HWTEST</p>
</td>
<td class="cellrowborder" valign="top" width="88.59%" headers="mcps1.2.3.1.2 "><p id="en-us_topic_0000001059860314_p2248120191418"><a name="en-us_topic_0000001059860314_p2248120191418"></a><a name="en-us_topic_0000001059860314_p2248120191418"></a>This macro applies to simple tests, and its execution does not rely on the setup and teardown execution. This macro expands the test case level based on the <strong id="en-us_topic_0000001059860314_b195655481312"><a name="en-us_topic_0000001059860314_b195655481312"></a><a name="en-us_topic_0000001059860314_b195655481312"></a>TEST</strong> macro, for example, <strong id="en-us_topic_0000001059860314_b1757154816312"><a name="en-us_topic_0000001059860314_b1757154816312"></a><a name="en-us_topic_0000001059860314_b1757154816312"></a>HWTEST(CalculatorAddTest, TestPoint_001, TestSize.Level1)</strong>.</p>
</td>
</tr>
<tr id="en-us_topic_0000001059860314_row18248220131414"><td class="cellrowborder" valign="top" width="11.41%" headers="mcps1.2.3.1.1 "><p id="en-us_topic_0000001059860314_p4248132014144"><a name="en-us_topic_0000001059860314_p4248132014144"></a><a name="en-us_topic_0000001059860314_p4248132014144"></a>HWTEST_F</p>
</td>
<td class="cellrowborder" valign="top" width="88.59%" headers="mcps1.2.3.1.2 "><p id="en-us_topic_0000001059860314_p17248132061412"><a name="en-us_topic_0000001059860314_p17248132061412"></a><a name="en-us_topic_0000001059860314_p17248132061412"></a>Test cases defined in this macro are independent. The macro execution relies on the setup and teardown execution. This macro expands the test case level based on the <strong id="en-us_topic_0000001059860314_b19233145210316"><a name="en-us_topic_0000001059860314_b19233145210316"></a><a name="en-us_topic_0000001059860314_b19233145210316"></a>TEST_F</strong> macro, for example, <strong id="en-us_topic_0000001059860314_b72381252235"><a name="en-us_topic_0000001059860314_b72381252235"></a><a name="en-us_topic_0000001059860314_b72381252235"></a>HWTEST_F(CalculatorAddTest, TestPoint_001, TestSize.Level1)</strong>.</p>
</td>
</tr>
<tr id="en-us_topic_0000001059860314_row924892011148"><td class="cellrowborder" valign="top" width="11.41%" headers="mcps1.2.3.1.1 "><p id="en-us_topic_0000001059860314_p5248132031420"><a name="en-us_topic_0000001059860314_p5248132031420"></a><a name="en-us_topic_0000001059860314_p5248132031420"></a>HWTEST_P</p>
</td>
<td class="cellrowborder" valign="top" width="88.59%" headers="mcps1.2.3.1.2 "><p id="en-us_topic_0000001059860314_p1248142031417"><a name="en-us_topic_0000001059860314_p1248142031417"></a><a name="en-us_topic_0000001059860314_p1248142031417"></a>This macro applies to parameterized tests. It expands the test case level based on the <strong id="en-us_topic_0000001059860314_b10661453933"><a name="en-us_topic_0000001059860314_b10661453933"></a><a name="en-us_topic_0000001059860314_b10661453933"></a>TEST_P</strong> macro, for example, <strong id="en-us_topic_0000001059860314_b1677532036"><a name="en-us_topic_0000001059860314_b1677532036"></a><a name="en-us_topic_0000001059860314_b1677532036"></a>HWTEST_P(CalculatorAddTest, TestPoint_001, TestSize.Level1)</strong>.</p>
</td>
</tr>
</tbody>
</table>
### How to Develop<a name="en-us_topic_0000001059860314_section53541946111218"></a>
1. Define a test suite file based on the test case directory, for example, **test/developertest/example/cxx\_demo/test/unittest/common/calc\_subtraction\_test.cpp**. The class in this test suite should be inherited from the **testing::Test** class and named in the format of "_Tested feature_**Test**".
```
#include <gtest/gtest.h>
using namespace std;
using namespace testing::ext;
class CalcSubtractionTest : public testing::Test {
public:
static void SetUpTestCase(void);
static void TearDownTestCase(void);
void SetUp();
void TearDown();
};
```
2. Implement the preprocessing \(via the **SetUp** function\) and postprocessing \(via the **TearDown** function\) operations required by the execution of the test suite.
```
void CalcSubtractionTest::SetUpTestCase(void)
{
// step 2: input testsuit setup step
}
void CalcSubtractionTest::TearDownTestCase(void)
{
// step 2: input testsuit teardown step
}
void CalcSubtractionTest::SetUp(void)
{
// step 3: input testcase setup step
}
void CalcSubtractionTest::TearDown(void)
{
// step 3: input testcase teardown step
}
```
3. Compile a test case based on the feature to be tested. The following code uses **HWTEST\_F** as an example:
```
/*
* Feature: Calculator
* Function: Subtraction
* SubFunction: NA
* FunctionPoints: Integer Subtraction
* EnvConditions: NA
* CaseDescription: Verify the Subtraction function.
*/
HWTEST_F(CalcSubtractionTest, integer_sub_001, TestSize.Level1)
{
EXPECT_EQ(0, Subtraction(1, 0));
}
```
4. Compile the GN file of the test case, including defining the compilation target, adding compilation dependencies, and setting the source file. \(Example file path: **test/developertest/example/cxx\_demo/test/unittest/common/BUILD.gn**\)
```
import("//build/lite/config/test.gni")
unittest("CalcSubTest") {
output_extension = "bin"
sources = [
"calc_subtraction_test.cpp"
]
include_dirs = []
deps = []
}
```
5. Add the test case compilation target to the subsystem compilation configuration to ensure that the test case is compiled with the version release. \(Example file path: **test/developertest/BUILD.gn**\)
```
import("//build/lite/config/test.gni")
subsystem_test("test") {
test_components = []
if(ohos_kernel_type == "liteos_riscv") {
features += [
]
}else if(ohos_kernel_type == "liteos_a") {
test_components += [
"//test/developertest/example/cxx_demo/test/unittest/common:CalcSubTest"
]
}
}
```
6. Run the version compilation command in the root directory of the code to compile the test case.
## Development Example<a name="en-us_topic_0000001059860314_section7477121918136"></a>
The code repository of the testing subsystem provides complete demo cases, which are available in the **test/developertest/example/** directory. The following is an example of compiling a test case using a subtraction function:
- The tested code is as follows:
```
static int Subtraction(int a, int b)
{
return a - b;
}
```
- The test case code is as follows:
```
/*
* Feature: Calculator
* Function: Subtraction
* SubFunction: NA
* FunctionPoints: Integer Subtraction
* EnvConditions: NA
* CaseDescription: Verify the Subtraction function.
*/
HWTEST_F(CalcSubtractionTest, integer_sub_002, TestSize.Level1)
{
EXPECT_EQ(1, Subtraction(2, 1));
}
```
## Directory Structure<a name="en-us_topic_0000001059860314_section1875515364133"></a>
The source code for the test platform framework is stored in the **test/xdevice** directory. The following table describes the **xdevice** directory structure.
**Table 4** **xdevice** directory structure
<a name="en-us_topic_0000001059860314_table954494411114"></a>
<table><thead align="left"><tr id="en-us_topic_0000001059860314_row5545104415118"><th class="cellrowborder" valign="top" width="45.050000000000004%" id="mcps1.2.3.1.1"><p id="en-us_topic_0000001059860314_p2054554411115"><a name="en-us_topic_0000001059860314_p2054554411115"></a><a name="en-us_topic_0000001059860314_p2054554411115"></a>Directory</p>
</th>
<th class="cellrowborder" valign="top" width="54.949999999999996%" id="mcps1.2.3.1.2"><p id="en-us_topic_0000001059860314_p13545124420115"><a name="en-us_topic_0000001059860314_p13545124420115"></a><a name="en-us_topic_0000001059860314_p13545124420115"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0000001059860314_row185457441816"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="en-us_topic_0000001059860314_p754544411116"><a name="en-us_topic_0000001059860314_p754544411116"></a><a name="en-us_topic_0000001059860314_p754544411116"></a>xdevice</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="en-us_topic_0000001059860314_p05459441212"><a name="en-us_topic_0000001059860314_p05459441212"></a><a name="en-us_topic_0000001059860314_p05459441212"></a>Basic framework for test tools</p>
</td>
</tr>
<tr id="en-us_topic_0000001059860314_row454511442018"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="en-us_topic_0000001059860314_p75451144810"><a name="en-us_topic_0000001059860314_p75451144810"></a><a name="en-us_topic_0000001059860314_p75451144810"></a>xdevice/src/xdevice</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="en-us_topic_0000001059860314_p105453448111"><a name="en-us_topic_0000001059860314_p105453448111"></a><a name="en-us_topic_0000001059860314_p105453448111"></a>Source code for the basic testing framework</p>
</td>
</tr>
<tr id="en-us_topic_0000001059860314_row87541401381"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="en-us_topic_0000001059860314_p67551309382"><a name="en-us_topic_0000001059860314_p67551309382"></a><a name="en-us_topic_0000001059860314_p67551309382"></a>xdevice/config</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="en-us_topic_0000001059860314_p1575512093811"><a name="en-us_topic_0000001059860314_p1575512093811"></a><a name="en-us_topic_0000001059860314_p1575512093811"></a>Configuration file of the basic testing framework</p>
</td>
</tr>
<tr id="en-us_topic_0000001059860314_row5649112018488"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="en-us_topic_0000001059860314_p196491420164819"><a name="en-us_topic_0000001059860314_p196491420164819"></a><a name="en-us_topic_0000001059860314_p196491420164819"></a>xdevice/src/xdevice/__main__.py</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="en-us_topic_0000001059860314_p10650320204819"><a name="en-us_topic_0000001059860314_p10650320204819"></a><a name="en-us_topic_0000001059860314_p10650320204819"></a>Internal entrance to the basic testing framework</p>
</td>
</tr>
<tr id="en-us_topic_0000001059860314_row686513384812"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="en-us_topic_0000001059860314_p886514334481"><a name="en-us_topic_0000001059860314_p886514334481"></a><a name="en-us_topic_0000001059860314_p886514334481"></a>xdevice/src/xdevice/__init__.py</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="en-us_topic_0000001059860314_p1986519338482"><a name="en-us_topic_0000001059860314_p1986519338482"></a><a name="en-us_topic_0000001059860314_p1986519338482"></a>Package and plug-in dependencies</p>
</td>
</tr>
<tr id="en-us_topic_0000001059860314_row4833912191119"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="en-us_topic_0000001059860314_p1083418127115"><a name="en-us_topic_0000001059860314_p1083418127115"></a><a name="en-us_topic_0000001059860314_p1083418127115"></a>xdevice/src/xdevice/variables.py</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="en-us_topic_0000001059860314_p138341712101118"><a name="en-us_topic_0000001059860314_p138341712101118"></a><a name="en-us_topic_0000001059860314_p138341712101118"></a>Global variables</p>
</td>
</tr>
<tr id="en-us_topic_0000001059860314_row1637375614140"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="en-us_topic_0000001059860314_p8373105615143"><a name="en-us_topic_0000001059860314_p8373105615143"></a><a name="en-us_topic_0000001059860314_p8373105615143"></a>xdevice/src/xdevice/_core/command</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="en-us_topic_0000001059860314_p1937319561140"><a name="en-us_topic_0000001059860314_p1937319561140"></a><a name="en-us_topic_0000001059860314_p1937319561140"></a>Commands entered by test cases</p>
</td>
</tr>
<tr id="en-us_topic_0000001059860314_row10415205961418"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="en-us_topic_0000001059860314_p184151659131413"><a name="en-us_topic_0000001059860314_p184151659131413"></a><a name="en-us_topic_0000001059860314_p184151659131413"></a>xdevice/src/xdevice/_core/config</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="en-us_topic_0000001059860314_p1986220312212"><a name="en-us_topic_0000001059860314_p1986220312212"></a><a name="en-us_topic_0000001059860314_p1986220312212"></a>Configuration management of the basic testing framework</p>
</td>
</tr>
<tr id="en-us_topic_0000001059860314_row94787251511"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="en-us_topic_0000001059860314_p174781520154"><a name="en-us_topic_0000001059860314_p174781520154"></a><a name="en-us_topic_0000001059860314_p174781520154"></a>xdevice/src/xdevice/_core/environment</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="en-us_topic_0000001059860314_p164783210154"><a name="en-us_topic_0000001059860314_p164783210154"></a><a name="en-us_topic_0000001059860314_p164783210154"></a>Environment management of the basic testing framework, including device management</p>
</td>
</tr>
<tr id="en-us_topic_0000001059860314_row61686255266"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="en-us_topic_0000001059860314_p81691225162617"><a name="en-us_topic_0000001059860314_p81691225162617"></a><a name="en-us_topic_0000001059860314_p81691225162617"></a>xdevice/src/xdevice/_core/executor</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="en-us_topic_0000001059860314_p1316918254269"><a name="en-us_topic_0000001059860314_p1316918254269"></a><a name="en-us_topic_0000001059860314_p1316918254269"></a>Scheduling and distribution of test cases</p>
</td>
</tr>
<tr id="en-us_topic_0000001059860314_row197501910202715"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="en-us_topic_0000001059860314_p1375091013272"><a name="en-us_topic_0000001059860314_p1375091013272"></a><a name="en-us_topic_0000001059860314_p1375091013272"></a>xdevice/src/xdevice/_core/driver</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="en-us_topic_0000001059860314_p10750101062710"><a name="en-us_topic_0000001059860314_p10750101062710"></a><a name="en-us_topic_0000001059860314_p10750101062710"></a>Test executor for the basic testing framework</p>
</td>
</tr>
<tr id="en-us_topic_0000001059860314_row176501346185920"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="en-us_topic_0000001059860314_p66514461593"><a name="en-us_topic_0000001059860314_p66514461593"></a><a name="en-us_topic_0000001059860314_p66514461593"></a>xdevice/src/xdevice/_core/resource</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="en-us_topic_0000001059860314_p15651746155911"><a name="en-us_topic_0000001059860314_p15651746155911"></a><a name="en-us_topic_0000001059860314_p15651746155911"></a>Resource files and test report templates for the basic testing framework</p>
</td>
</tr>
<tr id="en-us_topic_0000001059860314_row1484675718210"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="en-us_topic_0000001059860314_p20847105792118"><a name="en-us_topic_0000001059860314_p20847105792118"></a><a name="en-us_topic_0000001059860314_p20847105792118"></a>xdevice/src/xdevice/_core/testkit</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="en-us_topic_0000001059860314_p784795762120"><a name="en-us_topic_0000001059860314_p784795762120"></a><a name="en-us_topic_0000001059860314_p784795762120"></a>Common operations for the basic testing framework, including NFS mounting</p>
</td>
</tr>
<tr id="en-us_topic_0000001059860314_row182104023911"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="en-us_topic_0000001059860314_p5211808398"><a name="en-us_topic_0000001059860314_p5211808398"></a><a name="en-us_topic_0000001059860314_p5211808398"></a>xdevice/src/xdevice/_core/logger.py</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="en-us_topic_0000001059860314_p92110017395"><a name="en-us_topic_0000001059860314_p92110017395"></a><a name="en-us_topic_0000001059860314_p92110017395"></a>Log management of the basic testing framework</p>
</td>
</tr>
<tr id="en-us_topic_0000001059860314_row164491410124017"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="en-us_topic_0000001059860314_p7449171012400"><a name="en-us_topic_0000001059860314_p7449171012400"></a><a name="en-us_topic_0000001059860314_p7449171012400"></a>xdevice/src/xdevice/_core/plugin.py</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="en-us_topic_0000001059860314_p1944991024013"><a name="en-us_topic_0000001059860314_p1944991024013"></a><a name="en-us_topic_0000001059860314_p1944991024013"></a>Plug-in management of the basic testing framework</p>
</td>
</tr>
<tr id="en-us_topic_0000001059860314_row14857134011406"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="en-us_topic_0000001059860314_p118571440104014"><a name="en-us_topic_0000001059860314_p118571440104014"></a><a name="en-us_topic_0000001059860314_p118571440104014"></a>xdevice/src/xdevice/_core/interface.py</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="en-us_topic_0000001059860314_p158571940184016"><a name="en-us_topic_0000001059860314_p158571940184016"></a><a name="en-us_topic_0000001059860314_p158571940184016"></a>Interfaces for plug-ins of the basic testing framework</p>
</td>
</tr>
<tr id="en-us_topic_0000001059860314_row94193383812"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="en-us_topic_0000001059860314_p154194363813"><a name="en-us_topic_0000001059860314_p154194363813"></a><a name="en-us_topic_0000001059860314_p154194363813"></a>xdevice/setup.py</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="en-us_topic_0000001059860314_p44193353819"><a name="en-us_topic_0000001059860314_p44193353819"></a><a name="en-us_topic_0000001059860314_p44193353819"></a>Installation script of the basic testing framework</p>
</td>
</tr>
<tr id="en-us_topic_0000001059860314_row537019532284"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="en-us_topic_0000001059860314_p63711953202815"><a name="en-us_topic_0000001059860314_p63711953202815"></a><a name="en-us_topic_0000001059860314_p63711953202815"></a>xdevice/run.bat</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="en-us_topic_0000001059860314_p4371153172812"><a name="en-us_topic_0000001059860314_p4371153172812"></a><a name="en-us_topic_0000001059860314_p4371153172812"></a>Startup script of the basic testing framework (Windows)</p>
</td>
</tr>
<tr id="en-us_topic_0000001059860314_row554513912325"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="en-us_topic_0000001059860314_p165451493324"><a name="en-us_topic_0000001059860314_p165451493324"></a><a name="en-us_topic_0000001059860314_p165451493324"></a>xdevice/run.sh</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="en-us_topic_0000001059860314_p165453953218"><a name="en-us_topic_0000001059860314_p165453953218"></a><a name="en-us_topic_0000001059860314_p165453953218"></a>Startup script of the basic testing framework (Linux)</p>
</td>
</tr>
</tbody>
</table>
docs-en/subsystems/utils-development-guidelines.md 0 → 100644
浏览文件 @ 37cc208b
# Utils Development Guidelines<a name="EN-US_TOPIC_0000001059307279"></a>
- [Available APIs](#section1633115419401)
- [How to Develop](#section4207112818418)
## Available APIs<a name="section1633115419401"></a>
**Table 1** APIs for file operations
<a name="table1171894475019"></a>
<table><thead align="left"><tr id="row1471814441508"><th class="cellrowborder" valign="top" width="45.540000000000006%" id="mcps1.2.3.1.1"><p id="p11718174425016"><a name="p11718174425016"></a><a name="p11718174425016"></a>Function</p>
</th>
<th class="cellrowborder" valign="top" width="54.459999999999994%" id="mcps1.2.3.1.2"><p id="p6718124475013"><a name="p6718124475013"></a><a name="p6718124475013"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row671818445506"><td class="cellrowborder" valign="top" width="45.540000000000006%" headers="mcps1.2.3.1.1 "><p id="p871814441501"><a name="p871814441501"></a><a name="p871814441501"></a>int UtilsFileOpen(const char* path, int oflag, int mode)</p>
</td>
<td class="cellrowborder" valign="top" width="54.459999999999994%" headers="mcps1.2.3.1.2 "><p id="p127181444165016"><a name="p127181444165016"></a><a name="p127181444165016"></a>Opens or creates a file.</p>
</td>
</tr>
<tr id="row1171874420507"><td class="cellrowborder" valign="top" width="45.540000000000006%" headers="mcps1.2.3.1.1 "><p id="p1671884419509"><a name="p1671884419509"></a><a name="p1671884419509"></a>int UtilsFileClose(int fd)</p>
</td>
<td class="cellrowborder" valign="top" width="54.459999999999994%" headers="mcps1.2.3.1.2 "><p id="p1071884416504"><a name="p1071884416504"></a><a name="p1071884416504"></a>Closes a file with a specified file descriptor.</p>
</td>
</tr>
<tr id="row6718744105017"><td class="cellrowborder" valign="top" width="45.540000000000006%" headers="mcps1.2.3.1.1 "><p id="p137181644145015"><a name="p137181644145015"></a><a name="p137181644145015"></a>int UtilsFileRead(int fd, char *buf, unsigned int len)</p>
</td>
<td class="cellrowborder" valign="top" width="54.459999999999994%" headers="mcps1.2.3.1.2 "><p id="p1171854410509"><a name="p1171854410509"></a><a name="p1171854410509"></a>Reads a specified length of data from a file with the specified file descriptor and writes the data into the buffer.</p>
</td>
</tr>
<tr id="row2071817440509"><td class="cellrowborder" valign="top" width="45.540000000000006%" headers="mcps1.2.3.1.1 "><p id="p17718144465012"><a name="p17718144465012"></a><a name="p17718144465012"></a>int UtilsFileWrite(int fd, const char *buf, unsigned int len)</p>
</td>
<td class="cellrowborder" valign="top" width="54.459999999999994%" headers="mcps1.2.3.1.2 "><p id="p67191444145012"><a name="p67191444145012"></a><a name="p67191444145012"></a>Writes a specified length of data into a file with the specified file descriptor.</p>
</td>
</tr>
<tr id="row471974425019"><td class="cellrowborder" valign="top" width="45.540000000000006%" headers="mcps1.2.3.1.1 "><p id="p11719174475016"><a name="p11719174475016"></a><a name="p11719174475016"></a>int UtilsFileDelete(const char *path)</p>
</td>
<td class="cellrowborder" valign="top" width="54.459999999999994%" headers="mcps1.2.3.1.2 "><p id="p2071919446507"><a name="p2071919446507"></a><a name="p2071919446507"></a>Deletes a specified file.</p>
</td>
</tr>
<tr id="row1071964425013"><td class="cellrowborder" valign="top" width="45.540000000000006%" headers="mcps1.2.3.1.1 "><p id="p20719114405010"><a name="p20719114405010"></a><a name="p20719114405010"></a>int UtilsFileStat(const char *path, unsigned int *fileSize)</p>
</td>
<td class="cellrowborder" valign="top" width="54.459999999999994%" headers="mcps1.2.3.1.2 "><p id="p8719144435015"><a name="p8719144435015"></a><a name="p8719144435015"></a>Obtains the file size.</p>
</td>
</tr>
<tr id="row2071924417504"><td class="cellrowborder" valign="top" width="45.540000000000006%" headers="mcps1.2.3.1.1 "><p id="p57193447501"><a name="p57193447501"></a><a name="p57193447501"></a>int UtilsFileSeek(int fd, int offset, unsigned int whence)</p>
</td>
<td class="cellrowborder" valign="top" width="54.459999999999994%" headers="mcps1.2.3.1.2 "><p id="p1071934495014"><a name="p1071934495014"></a><a name="p1071934495014"></a>Adjusts the read and write position offset in a file.</p>
</td>
</tr>
<tr id="row1135017417557"><td class="cellrowborder" valign="top" width="45.540000000000006%" headers="mcps1.2.3.1.1 "><p id="p2350184112554"><a name="p2350184112554"></a><a name="p2350184112554"></a>int UtilsFileCopy(const char* src, const char* dest)</p>
</td>
<td class="cellrowborder" valign="top" width="54.459999999999994%" headers="mcps1.2.3.1.2 "><p id="p113501041155511"><a name="p113501041155511"></a><a name="p113501041155511"></a>Copies the source file to a target file.</p>
</td>
</tr>
<tr id="row11216645145517"><td class="cellrowborder" valign="top" width="45.540000000000006%" headers="mcps1.2.3.1.1 "><p id="p192171345105519"><a name="p192171345105519"></a><a name="p192171345105519"></a>int UtilsFileMove(const char* src, const char* dest)</p>
</td>
<td class="cellrowborder" valign="top" width="54.459999999999994%" headers="mcps1.2.3.1.2 "><p id="p921744595517"><a name="p921744595517"></a><a name="p921744595517"></a>Moves the source file into a target file.</p>
</td>
</tr>
</tbody>
</table>
Sample code for file operations:
```
// Open a file and write data.
char fileName[] = "testfile";
static const char def[] = "utils_file_operation implement.";
int fd = UtilsFileOpen(fileName, O_RDWR_FS | O_CREAT_FS | O_TRUNC_FS, 0);
printf("file handle = %d\n", fd);
int ret = UtilsFileWrite(fd, def, strlen(def));
printf("write ret = %d\n", ret);
// Adjust the position offset in the file.
ret = UtilsFileSeek(fd, 5, SEEK_SET_FS);
printf("lseek ret = %d\n", ret);
// Read data and close the file.
char buf[64] = {0};
int readLen = UtilsFileRead(fd, buf, 64);
ret = UtilsFileClose(fd);
printf("read len = %d : buf = %s\n", readLen, buf);
// Obtain the file size.
int fileLen = 0;
ret = UtilsFileStat(fileName, &fileLen);
printf("file size = %d\n", fileLen);
// Delete the file.
ret = UtilsFileDelete(fileName);
printf("delete ret = %d\n", ret);
```
**Table 2** APIs for KV store operations
<a name="table1731550155318"></a>
<table><thead align="left"><tr id="row4419501537"><th class="cellrowborder" valign="top" width="57.38999999999999%" id="mcps1.2.3.1.1"><p id="p54150165315"><a name="p54150165315"></a><a name="p54150165315"></a>Function</p>
</th>
<th class="cellrowborder" valign="top" width="42.61%" id="mcps1.2.3.1.2"><p id="p941150145313"><a name="p941150145313"></a><a name="p941150145313"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row34145016535"><td class="cellrowborder" valign="top" width="57.38999999999999%" headers="mcps1.2.3.1.1 "><p id="p980953910190"><a name="p980953910190"></a><a name="p980953910190"></a>int UtilsGetValue(const char* key, char* value, unsigned int len)</p>
</td>
<td class="cellrowborder" valign="top" width="42.61%" headers="mcps1.2.3.1.2 "><p id="p13562171015712"><a name="p13562171015712"></a><a name="p13562171015712"></a>Obtains the value matching a specified key from the file system or cache.</p>
</td>
</tr>
<tr id="row1746172917474"><td class="cellrowborder" valign="top" width="57.38999999999999%" headers="mcps1.2.3.1.1 "><p id="p242913617818"><a name="p242913617818"></a><a name="p242913617818"></a>int UtilsSetValue(const char* key, const char* value)</p>
</td>
<td class="cellrowborder" valign="top" width="42.61%" headers="mcps1.2.3.1.2 "><p id="p2431455765"><a name="p2431455765"></a><a name="p2431455765"></a>Adds or updates the value matching a specified key in the file system or cache.</p>
</td>
</tr>
<tr id="row10992232154714"><td class="cellrowborder" valign="top" width="57.38999999999999%" headers="mcps1.2.3.1.1 "><p id="p118151439111910"><a name="p118151439111910"></a><a name="p118151439111910"></a>int UtilsDeleteValue(const char* key)</p>
</td>
<td class="cellrowborder" valign="top" width="42.61%" headers="mcps1.2.3.1.2 "><p id="p126575774517"><a name="p126575774517"></a><a name="p126575774517"></a>Deletes the value matching a specified key from the file system or cache.</p>
</td>
</tr>
</tbody>
</table>
Sample code for the KV store:
```
// Set the value matching the specified key.
char key[] = "rw.sys.version_100";
char value[] = "Hello kv operation implement!";
int ret = UtilsSetValue(key, value);
printf("UtilsSetValue set ret = %d\n", ret);
// Obtain the value matching the specified key.
char temp[128] = {0};
ret = UtilsGetValue(key, temp, 128);
printf("UtilsGetValue get ret = %d, temp = %s\n", ret, temp);
// Delete the value matching the specified key.
ret = UtilsDeleteValue(key);
printf("UtilsDeleteValue delete ret = %d\n", ret);
```
## How to Develop<a name="section4207112818418"></a>
To develop a native application for the KV store that uses the LiteOS Cortex-A kernel \(Hi3516 or Hi3518\), perform the following steps:
1. Develop the native application for the KV store using **AbilityKit** APIs.
- Write the user program by calling the APIs provided by the KV store and compile the **libLauncher.so** file.
```
// Set the value matching the specified key.
char key[] = "rw.sys.version_100";
char value[] = "Hello kv operation implement!";
int ret = UtilsSetValue(key, value);
printf("UtilsSetValue set ret = %d\n", ret);
// Obtain the value matching the specified key.
char temp[128] = {0};
ret = UtilsGetValue(key, temp, 128);
printf("UtilsGetValue get ret = %d, temp = %s\n", ret, temp);
// Delete the value matching the specified key.
ret = UtilsDeleteValue(key);
printf("UtilsDeleteValue delete ret = %d\n", ret);
```
- Edit the **config.json** file as follows:
```
{
"app": {
"bundleName": "com.huawei.launcher",
"vendor": "huawei",
"version": {
"code": 1,
"name": "1.0"
}
},
"deviceConfig": {
"default": {
"reqSdk": {
"compatible": "zsdk 1.0.0",
"target": "zsdk 1.0.1"
},
"keepAlive": false
},
"smartCamera": {
"reqSdk": {
"compatible": "zsdk 1.0.0",
"target": "zsdk 1.0.1"
},
"keepAlive": false
}
},
"module": {
"package": "com.huawei.launcher",
"name": ".MyHarmonyAbilityPackage",
"deviceType": [
"phone", "tv","tablet", "pc","car","smartWatch","sportsWatch","smartCamera"
],
"distro": {
"deliveryWithInstall": true,
"moduleName": "Launcher",
"moduleType": "entry"
},
"abilities": [{
"name": "MainAbility",
"icon": "res/drawable/phone.png",
"label": "test app 1",
"launchType": "standard",
"type": "page"
},
{
"name": "SecondAbility",
"icon": "res/drawable/phone.png",
"label": "test app 2",
"launchType": "standard",
"type": "page"
},
{
"name": "ServiceAbility",
"icon": "res/drawable/phone.png",
"label": "test app 2",
"launchType": "standard",
"type": "service"
}
]
}
}
```
- Generate a HAP file.
- Add resource files in the **res/drawable** directory based on the following directory structure.
![](figures/unnaming.png)
- Compress the **libLauncher.so**, **config.json**, and resource files into a ZIP package and change the file name extension to **.hap**, for example, **Launcher.hap**.
2. Connect the development board and send the command for installing the native KV store application to the board through the serial port.
```
./nfs/dev_tools/bin/bm install -p /nfs/Launcher.hap
```
3. Send the command for running the native KV store application to the board through the serial port.
```
./nfs/dev_tools/bin/aa start -p com.huawei.launcher -n ServiceAbility
```
docs-en/subsystems/utils-faq.md 0 → 100644
浏览文件 @ 37cc208b
# Utils FAQ<a name="EN-US_TOPIC_0000001058735275"></a>
- [1. Failure in running the KV store on the LiteOS Cortex-A kernel \(Hi3516 or Hi3518\) due to incorrect path setting for the KV store](#section2041345718513)
## 1. Failure in running the KV store on the LiteOS Cortex-A kernel \(Hi3516 or Hi3518\) due to incorrect path setting for the KV store<a name="section2041345718513"></a>
**Problem**
When the LiteOS Cortex-A kernel \(Hi3516 or Hi3518 platform\) directly calls the API provided by the KV store, the compiled executable program fails to run.
**Possible Causes**
The compiled executable program is run directly without being converted to an application using **AbilityKit** APIs. In this case, the Bundle Manager Service \(BMS\) cannot correctly set the path for storing application data during application installation. As a result, the KV store fails to run.
**Solution**
Call the **UtilsSetEnv** function of the KV store to set the data storage path.
```
UtilsSetEnv("/storage/com.huawei.kv");
```
docs-en/subsystems/utils-overview.md 0 → 100644
浏览文件 @ 37cc208b
# Utils Overview<a name="EN-US_TOPIC_0000001060172974"></a>
The Utils library stores common basic components of OpenHarmony. These basic components can be used by OpenHarmony service subsystems and upper-layer applications.
The Utils library provides the following capabilities on different platforms:
LiteOS Cortex-M \(Hi3861 platform\): KV store, file operations, and IoT peripheral control
LiteOS Cortex-A \(Hi3516 or Hi3518 platform\): JavaScript APIs for KV store, timer, and data and file storage modules
docs-en/subsystems/utils.md 0 → 100644
浏览文件 @ 37cc208b
# Utils<a name="EN-US_TOPIC_0000001074066259"></a>
- **[Utils Overview](utils-overview.md)**
- **[Utils Development Guidelines](utils-development-guidelines.md)**
- **[Utils FAQ](utils-faq.md)**
docs-en/subsystems/xts.md 0 → 100644
浏览文件 @ 37cc208b
# XTS<a name="EN-US_TOPIC_0000001074750691"></a>
- [Overview](#en-us_topic_0000001059475030_section44931242483)
- [Directory Structure](#en-us_topic_0000001059475030_section45118915548)
- [Limitations and Constraints](#en-us_topic_0000001059475030_section115518148474)
- [Development Guidelines](#en-us_topic_0000001059475030_section99973470498)
- [ACTS Cases for the IoTLink Module](#en-us_topic_0000001059475030_section1348215596491)
- [ACTS Cases for the SmartVision Device \(IP Camera\)](#en-us_topic_0000001059475030_section11458163095019)
- [Executing ACTS Cases for the IoTLink Module](#en-us_topic_0000001059475030_section3115140115113)
- [Executing ACTS Cases for the SmartVision Device \(IP Camera\)](#en-us_topic_0000001059475030_section1759138185215)
## Overview<a name="en-us_topic_0000001059475030_section44931242483"></a>
X Test Suite is a set of OpenHarmony certification test suites, including the currently supported application compatibility test suite \(ACTS\) and the device compatibility test suite \(DCTS\) that will be supported in the future.
The **test/xts** repository contains the **acts** directory and **tools** software package.
- The **acts** directory stores the source code and configuration files of ACTS test cases. The ACTS helps device vendors detect the software incompatibility as early as possible and ensures that the software is compatible to OpenHarmony during the entire development process.
- The **tools** software package stores the test case development framework related to **acts**.
## Directory Structure<a name="en-us_topic_0000001059475030_section45118915548"></a>
The directory structure of the **test/xts** repository is as follows:
├── acts
│ ├── BUILD.gn \#Compilation configuration of test cases
│ └── subsystem\_lite \# Test case source code
└── tools
│ └── build \#Templates and scripts related to test cases compilation
│ └── hcpptest \#Source code of the development framework for SmartVision device \(IP camera\) test cases
│ └── hctest \#Source code of the development framework for IoTLink module test cases
│ └── BUILD.gn \#Compilation configuration
│ └── build.sh \#Compiling entry
## Limitations and Constraints<a name="en-us_topic_0000001059475030_section115518148474"></a>
You must use the C language to develop IoTLink module ACTS cases, and C++ for SmartVision device \(IP camera\) ACTS cases.
## Development Guidelines<a name="en-us_topic_0000001059475030_section99973470498"></a>
### ACTS Cases for the IoTLink Module<a name="en-us_topic_0000001059475030_section1348215596491"></a>
The HCTest framework is used.
The HCTest framework supports the C language and allows you to execute your test cases on the connecting module. The framework is enhanced and adapted based on the open-source test framework Unity.
1. Store test cases in the **test/xts/acts** repository.
├── acts
│ ├── BUILD.gn
│ └──subsystem\_lite
│ │ └── module\_hal
│ │ │ └── BUILD.gn
│ │ │ └── src
2. Write the test case stored in the **src** directory.
a. Import the test framework.
```
#include "hctest.h"
```
b. Use the **LITE\_TEST\_SUIT** macro to define names of the subsystem, module, and test suite.
```
/**
* @brief register a test suit named "IntTestSuite"
* @param test subsystem name
* @param example module name
* @param IntTestSuite test suit name
*/
LITE_TEST_SUIT(test, example, IntTestSuite);
```
c. Define Setup and TearDown.
Format: test suite name+Setup, test suite name+TearDown.
The Setup and TearDown functions must exist, but function bodies can be empty.
d. Use the **LITE\_TEST\_CASE** macro to write the test case.
Three parameters are involved: test suite name, test case name, and test case level.
The case level can be one of the following:
**Level0**, **Level1**, **Level2**, **Level3**, and **Level4**.
```
LITE_TEST_CASE(IntTestSuite, TestCase001, Level0)
{
//do something
};
```
The following table describes the case levels.
**Table 1** Case levels
<a name="en-us_topic_0000001059475030_table115309197517"></a>
<table><thead align="left"><tr id="en-us_topic_0000001059475030_row053010198520"><th class="cellrowborder" valign="top" width="13.46134613461346%" id="mcps1.2.4.1.1"><p id="en-us_topic_0000001059475030_p6251523752"><a name="en-us_topic_0000001059475030_p6251523752"></a><a name="en-us_topic_0000001059475030_p6251523752"></a><strong id="en-us_topic_0000001059475030_b735631654213"><a name="en-us_topic_0000001059475030_b735631654213"></a><a name="en-us_topic_0000001059475030_b735631654213"></a>Level</strong></p>
</th>
<th class="cellrowborder" valign="top" width="10.25102510251025%" id="mcps1.2.4.1.2"><p id="en-us_topic_0000001059475030_p1825117231157"><a name="en-us_topic_0000001059475030_p1825117231157"></a><a name="en-us_topic_0000001059475030_p1825117231157"></a><strong id="en-us_topic_0000001059475030_b6560217204216"><a name="en-us_topic_0000001059475030_b6560217204216"></a><a name="en-us_topic_0000001059475030_b6560217204216"></a>Definition</strong></p>
</th>
<th class="cellrowborder" valign="top" width="76.2876287628763%" id="mcps1.2.4.1.3"><p id="en-us_topic_0000001059475030_p1325111230519"><a name="en-us_topic_0000001059475030_p1325111230519"></a><a name="en-us_topic_0000001059475030_p1325111230519"></a><strong id="en-us_topic_0000001059475030_b5195171918426"><a name="en-us_topic_0000001059475030_b5195171918426"></a><a name="en-us_topic_0000001059475030_b5195171918426"></a>Testing Scope</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0000001059475030_row45301619957"><td class="cellrowborder" valign="top" width="13.46134613461346%" headers="mcps1.2.4.1.1 "><p id="en-us_topic_0000001059475030_p122511231759"><a name="en-us_topic_0000001059475030_p122511231759"></a><a name="en-us_topic_0000001059475030_p122511231759"></a>Level0</p>
</td>
<td class="cellrowborder" valign="top" width="10.25102510251025%" headers="mcps1.2.4.1.2 "><p id="en-us_topic_0000001059475030_p132511238516"><a name="en-us_topic_0000001059475030_p132511238516"></a><a name="en-us_topic_0000001059475030_p132511238516"></a>Smoke</p>
</td>
<td class="cellrowborder" valign="top" width="76.2876287628763%" headers="mcps1.2.4.1.3 "><p id="en-us_topic_0000001059475030_p82511223550"><a name="en-us_topic_0000001059475030_p82511223550"></a><a name="en-us_topic_0000001059475030_p82511223550"></a>Verifies basic functionalities of key features and basic DFX attributes with the most common input. The pass result indicates that the features are runnable.</p>
</td>
</tr>
<tr id="en-us_topic_0000001059475030_row12531121912518"><td class="cellrowborder" valign="top" width="13.46134613461346%" headers="mcps1.2.4.1.1 "><p id="en-us_topic_0000001059475030_p16252523557"><a name="en-us_topic_0000001059475030_p16252523557"></a><a name="en-us_topic_0000001059475030_p16252523557"></a>Level1</p>
</td>
<td class="cellrowborder" valign="top" width="10.25102510251025%" headers="mcps1.2.4.1.2 "><p id="en-us_topic_0000001059475030_p1125212231358"><a name="en-us_topic_0000001059475030_p1125212231358"></a><a name="en-us_topic_0000001059475030_p1125212231358"></a>Basic</p>
</td>
<td class="cellrowborder" valign="top" width="76.2876287628763%" headers="mcps1.2.4.1.3 "><p id="en-us_topic_0000001059475030_p02521123757"><a name="en-us_topic_0000001059475030_p02521123757"></a><a name="en-us_topic_0000001059475030_p02521123757"></a>Verifies basic functionalities of key features and basic DFX attributes with common input. The pass result indicates that the features are testable.</p>
</td>
</tr>
<tr id="en-us_topic_0000001059475030_row1531131917514"><td class="cellrowborder" valign="top" width="13.46134613461346%" headers="mcps1.2.4.1.1 "><p id="en-us_topic_0000001059475030_p1525219237517"><a name="en-us_topic_0000001059475030_p1525219237517"></a><a name="en-us_topic_0000001059475030_p1525219237517"></a>Level2</p>
</td>
<td class="cellrowborder" valign="top" width="10.25102510251025%" headers="mcps1.2.4.1.2 "><p id="en-us_topic_0000001059475030_p5252523458"><a name="en-us_topic_0000001059475030_p5252523458"></a><a name="en-us_topic_0000001059475030_p5252523458"></a>Major</p>
</td>
<td class="cellrowborder" valign="top" width="76.2876287628763%" headers="mcps1.2.4.1.3 "><p id="en-us_topic_0000001059475030_p1125215231552"><a name="en-us_topic_0000001059475030_p1125215231552"></a><a name="en-us_topic_0000001059475030_p1125215231552"></a>Verifies basic functionalities of key features and basic DFX attributes with common input and errors. The pass result indicates that the features are functional and ready for beta testing.</p>
</td>
</tr>
<tr id="en-us_topic_0000001059475030_row1853111191556"><td class="cellrowborder" valign="top" width="13.46134613461346%" headers="mcps1.2.4.1.1 "><p id="en-us_topic_0000001059475030_p625220234514"><a name="en-us_topic_0000001059475030_p625220234514"></a><a name="en-us_topic_0000001059475030_p625220234514"></a>Level3</p>
</td>
<td class="cellrowborder" valign="top" width="10.25102510251025%" headers="mcps1.2.4.1.2 "><p id="en-us_topic_0000001059475030_p92528231952"><a name="en-us_topic_0000001059475030_p92528231952"></a><a name="en-us_topic_0000001059475030_p92528231952"></a>Regular</p>
</td>
<td class="cellrowborder" valign="top" width="76.2876287628763%" headers="mcps1.2.4.1.3 "><p id="en-us_topic_0000001059475030_p72521423855"><a name="en-us_topic_0000001059475030_p72521423855"></a><a name="en-us_topic_0000001059475030_p72521423855"></a>Verifies functionalities of all key features, and all DFX attributes with common and uncommon input combinations or normal and abnormal preset conditions.</p>
</td>
</tr>
<tr id="en-us_topic_0000001059475030_row25311219459"><td class="cellrowborder" valign="top" width="13.46134613461346%" headers="mcps1.2.4.1.1 "><p id="en-us_topic_0000001059475030_p52521223659"><a name="en-us_topic_0000001059475030_p52521223659"></a><a name="en-us_topic_0000001059475030_p52521223659"></a>Level4</p>
</td>
<td class="cellrowborder" valign="top" width="10.25102510251025%" headers="mcps1.2.4.1.2 "><p id="en-us_topic_0000001059475030_p10252223853"><a name="en-us_topic_0000001059475030_p10252223853"></a><a name="en-us_topic_0000001059475030_p10252223853"></a>Rare</p>
</td>
<td class="cellrowborder" valign="top" width="76.2876287628763%" headers="mcps1.2.4.1.3 "><p id="en-us_topic_0000001059475030_p1625214231655"><a name="en-us_topic_0000001059475030_p1625214231655"></a><a name="en-us_topic_0000001059475030_p1625214231655"></a>Verifies functionalities of key features under extremely abnormal presets and uncommon input combinations.</p>
</td>
</tr>
</tbody>
</table>
e. Use the **RUN\_TEST\_SUITE** macro to register the test suite.
```
RUN_TEST_SUITE(IntTestSuite);
```
3. Create the configuration file of the test module.
Create a **BUILD.gn** \(example\) compilation file in each test module directory. Specify the name of the compiled static library and its dependent header file and library in the compilation file. The format is as follows:
```
import("//test/xts/tools/build/suite_lite.gni")
hctest_suite("ActsDemoTest") {
suite_name = "acts"
sources = [
"src/test_demo.c",
]
include_dirs = [ ]
cflags = [ "-Wno-error" ]
}
```
4. Add compilation options to the **BUILD.gn** file in the **acts** directory.
You need to add the test module to the **test/xts/acts/BUILD.gn** script in the **acts** directory.
```
lite_component("acts") {
...
if(board_name == "liteos_riscv") {
features += [
...
"//xts/acts/subsystem_lite/module_hal:ActsDemoTest"
]
}
}
```
5. Run compilation commands.
**python build.py wifiiot -b debug**
**out/wifiiot**
>![](public_sys-resources/icon-note.gif) **NOTE:**
>The ACTS compilation middleware used for IoTLink module is a static library, which will be linked to the version image **Hi3861\_wifiiot\_app\_allinone.bin**.
### ACTS Cases for the SmartVision Device \(IP Camera\)<a name="en-us_topic_0000001059475030_section11458163095019"></a>
The HCPP Test framework is enhanced and adapted based on the open-source googletest framework.
1. Store test cases in the **test/xts/acts** repository.
├── acts
│ ├── BUILD.gn
│ └──subsystem\_lite
│ │ └── module\_posix
│ │ │ └── BUILD.gn
│ │ │ └── src
2. Write the test case stored in the **src** directory.
a. Import the test framework.
The following statement imports **gtest.h**.
```
#include "gtest/gtest.h"
```
b. Define Setup and TearDown.
```
class TestSuite: public testing::Test {
protected:
// Preset action of the test suite, which is executed before the first test case
static void SetUpTestCase(void){
}
// Test suite cleanup action, which is executed after the last test case
static void TearDownTestCase(void){
}
// Preset action of the test case
virtual void SetUp()
{
}
// Cleanup action of the test case
virtual void TearDown()
{
}
};
```
c. Use the **HWTEST** or **HWTEST\_F** macro to write the test case.
**HWTEST**: definition of common test cases, including the test suite name, test case name, and case marking.
**HWTEST\_F**: definition of SetUp and TearDown test cases, including the test suite name, test case name, and case marking.
A macro definition contains three parameters: test suite name, test case name, and test case level.
The case level can be one of the following:
**Level0**, **Level1**, **Level2**, **Level3**, and **Level4**.
```
HWTEST_F(TestSuite, TestCase_0001, Level0) {
// do something
}
```
The following table describes the case levels.
**Table 2** Case levels
<a name="en-us_topic_0000001059475030_table1830755842"></a>
<table><thead align="left"><tr id="en-us_topic_0000001059475030_row93075510420"><th class="cellrowborder" valign="top" width="13.681368136813681%" id="mcps1.2.4.1.1"><p id="en-us_topic_0000001059475030_p153681823247"><a name="en-us_topic_0000001059475030_p153681823247"></a><a name="en-us_topic_0000001059475030_p153681823247"></a><strong id="en-us_topic_0000001059475030_b4584205664410"><a name="en-us_topic_0000001059475030_b4584205664410"></a><a name="en-us_topic_0000001059475030_b4584205664410"></a>Level</strong></p>
</th>
<th class="cellrowborder" valign="top" width="10.961096109610962%" id="mcps1.2.4.1.2"><p id="en-us_topic_0000001059475030_p9368823749"><a name="en-us_topic_0000001059475030_p9368823749"></a><a name="en-us_topic_0000001059475030_p9368823749"></a><strong id="en-us_topic_0000001059475030_b514111593442"><a name="en-us_topic_0000001059475030_b514111593442"></a><a name="en-us_topic_0000001059475030_b514111593442"></a>Definition</strong></p>
</th>
<th class="cellrowborder" valign="top" width="75.35753575357535%" id="mcps1.2.4.1.3"><p id="en-us_topic_0000001059475030_p3368112319418"><a name="en-us_topic_0000001059475030_p3368112319418"></a><a name="en-us_topic_0000001059475030_p3368112319418"></a><strong id="en-us_topic_0000001059475030_b2745175924412"><a name="en-us_topic_0000001059475030_b2745175924412"></a><a name="en-us_topic_0000001059475030_b2745175924412"></a>Testing Scope</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0000001059475030_row13079520412"><td class="cellrowborder" valign="top" width="13.681368136813681%" headers="mcps1.2.4.1.1 "><p id="en-us_topic_0000001059475030_p1236811237417"><a name="en-us_topic_0000001059475030_p1236811237417"></a><a name="en-us_topic_0000001059475030_p1236811237417"></a>Level0</p>
</td>
<td class="cellrowborder" valign="top" width="10.961096109610962%" headers="mcps1.2.4.1.2 "><p id="en-us_topic_0000001059475030_p336812235414"><a name="en-us_topic_0000001059475030_p336812235414"></a><a name="en-us_topic_0000001059475030_p336812235414"></a>Smoke</p>
</td>
<td class="cellrowborder" valign="top" width="75.35753575357535%" headers="mcps1.2.4.1.3 "><p id="en-us_topic_0000001059475030_p2036852311414"><a name="en-us_topic_0000001059475030_p2036852311414"></a><a name="en-us_topic_0000001059475030_p2036852311414"></a>Verifies basic functionalities of key features and basic DFX attributes with the most common input. The pass result indicates that the features are runnable.</p>
</td>
</tr>
<tr id="en-us_topic_0000001059475030_row4307953415"><td class="cellrowborder" valign="top" width="13.681368136813681%" headers="mcps1.2.4.1.1 "><p id="en-us_topic_0000001059475030_p18369623540"><a name="en-us_topic_0000001059475030_p18369623540"></a><a name="en-us_topic_0000001059475030_p18369623540"></a>Level1</p>
</td>
<td class="cellrowborder" valign="top" width="10.961096109610962%" headers="mcps1.2.4.1.2 "><p id="en-us_topic_0000001059475030_p103698231443"><a name="en-us_topic_0000001059475030_p103698231443"></a><a name="en-us_topic_0000001059475030_p103698231443"></a>Basic</p>
</td>
<td class="cellrowborder" valign="top" width="75.35753575357535%" headers="mcps1.2.4.1.3 "><p id="en-us_topic_0000001059475030_p136916234410"><a name="en-us_topic_0000001059475030_p136916234410"></a><a name="en-us_topic_0000001059475030_p136916234410"></a>Verifies basic functionalities of key features and basic DFX attributes with common input. The pass result indicates that the features are testable.</p>
</td>
</tr>
<tr id="en-us_topic_0000001059475030_row83075510419"><td class="cellrowborder" valign="top" width="13.681368136813681%" headers="mcps1.2.4.1.1 "><p id="en-us_topic_0000001059475030_p12369192315420"><a name="en-us_topic_0000001059475030_p12369192315420"></a><a name="en-us_topic_0000001059475030_p12369192315420"></a>Level2</p>
</td>
<td class="cellrowborder" valign="top" width="10.961096109610962%" headers="mcps1.2.4.1.2 "><p id="en-us_topic_0000001059475030_p13698231341"><a name="en-us_topic_0000001059475030_p13698231341"></a><a name="en-us_topic_0000001059475030_p13698231341"></a>Major</p>
</td>
<td class="cellrowborder" valign="top" width="75.35753575357535%" headers="mcps1.2.4.1.3 "><p id="en-us_topic_0000001059475030_p16369142312412"><a name="en-us_topic_0000001059475030_p16369142312412"></a><a name="en-us_topic_0000001059475030_p16369142312412"></a>Verifies basic functionalities of key features and basic DFX attributes with common input and errors. The pass result indicates that the features are functional and ready for beta testing.</p>
</td>
</tr>
<tr id="en-us_topic_0000001059475030_row930815512416"><td class="cellrowborder" valign="top" width="13.681368136813681%" headers="mcps1.2.4.1.1 "><p id="en-us_topic_0000001059475030_p1636932315417"><a name="en-us_topic_0000001059475030_p1636932315417"></a><a name="en-us_topic_0000001059475030_p1636932315417"></a>Level3</p>
</td>
<td class="cellrowborder" valign="top" width="10.961096109610962%" headers="mcps1.2.4.1.2 "><p id="en-us_topic_0000001059475030_p1336918239414"><a name="en-us_topic_0000001059475030_p1336918239414"></a><a name="en-us_topic_0000001059475030_p1336918239414"></a>Regular</p>
</td>
<td class="cellrowborder" valign="top" width="75.35753575357535%" headers="mcps1.2.4.1.3 "><p id="en-us_topic_0000001059475030_p143691023345"><a name="en-us_topic_0000001059475030_p143691023345"></a><a name="en-us_topic_0000001059475030_p143691023345"></a>Verifies functionalities of all key features, and all DFX attributes with common and uncommon input combinations or normal and abnormal preset conditions.</p>
</td>
</tr>
<tr id="en-us_topic_0000001059475030_row183085518414"><td class="cellrowborder" valign="top" width="13.681368136813681%" headers="mcps1.2.4.1.1 "><p id="en-us_topic_0000001059475030_p63691423347"><a name="en-us_topic_0000001059475030_p63691423347"></a><a name="en-us_topic_0000001059475030_p63691423347"></a>Level4</p>
</td>
<td class="cellrowborder" valign="top" width="10.961096109610962%" headers="mcps1.2.4.1.2 "><p id="en-us_topic_0000001059475030_p63697236413"><a name="en-us_topic_0000001059475030_p63697236413"></a><a name="en-us_topic_0000001059475030_p63697236413"></a>Rare</p>
</td>
<td class="cellrowborder" valign="top" width="75.35753575357535%" headers="mcps1.2.4.1.3 "><p id="en-us_topic_0000001059475030_p133695231443"><a name="en-us_topic_0000001059475030_p133695231443"></a><a name="en-us_topic_0000001059475030_p133695231443"></a>Verifies functionalities of key features under extremely abnormal presets and uncommon input combinations.</p>
</td>
</tr>
</tbody>
</table>
3. Create the configuration file of the test module.
Create a **BUILD.gn** \(example\) compilation file in each test module directory. Specify the name of the compiled static library and its dependent header file and library in the compilation file. Each test module is independently compiled into a **.bin** executable file, which can be directly mounted to the development board for testing.
Example:
```
import("//test/xts/tools/build/suite_lite.gni")
hcpptest_suite("ActsDemoTest") {
suite_name = "acts"
sources = [
"src/TestDemo.cpp"
]
include_dirs = [
"src",
...
]
deps = [
...
]
cflags = [ "-Wno-error" ]
}
```
4. Add compilation options to the **BUILD.gn** file in the **acts** directory.
Add the test module to the **test/xts/acts/BUILD.gn** script in the **acts** directory.
```
lite_component("acts") {
...
else if(board_name == "liteos_a") {
features += [
...
"//xts/acts/subsystem_lite/module_posix:ActsDemoTest"
]
}
}
```
5. Run compilation commands.
- For Hi3518E V300:
**python build.py ipcamera\_hi3518ev300 -b debug**
**out/ipcamera\_hi3518ev300**
- For Hi3516D V300:
**python build.py ipcamera\_hi3518ev300 -b debug**
**out/ipcamera\_hi3516dv300**
>![](public_sys-resources/icon-note.gif) **NOTE:**
>The ACTS for the SmartVision device \(IP camera\) is independently compiled to a **.bin** executable file, which can be directly mounted to the development board for testing.
### Executing ACTS Cases for the IoTLink Module<a name="en-us_topic_0000001059475030_section3115140115113"></a>
**Obtaining the testing software package**
Obtain the image from the **out\\wifiiot\\Hi3861\_wifiiot\_app\_allinone.bin** directory.
Note: To check whether the ACTS is integrated into the current image, go to **out\\wifiiot\\Hi3861\_wifiiot\_app.map** to check whether the corresponding **.a** file is compiled.
**Burning the image into the development board**
**Performing testing**
1. Use a serial port tool to log in to the development board and save information about the serial port.
2. Restart the device and view serial port logs.
**Analyzing the test result.**
View the serial port logs, whose format is as follows:
The log for each test suite starts with **Start to run test suite:** and ends with **xx Tests xx Failures xx Ignored**.
### Executing ACTS Cases for the SmartVision Device \(IP Camera\)<a name="en-us_topic_0000001059475030_section1759138185215"></a>
Currently, test cases are shared by the NFS and mounted to the development board for execution.
**Setting up the environment**
1. Use a network cable or wireless network to connect the IP camera development board to your personal computer \(PC\).
2. Configure the IP address, subnet mask, and gateway for the IP camera development board. Ensure that the development board and the PC are in the same network segment.
3. Install and register the NFS server on the PC and start the NFS service.
4. Run the **mount** command for the IP camera development board to ensure that the development board can access NFS shared files on the PC.
Format: **mount** _NFS server IP address_**:/**_NFS shared directory_ **/**_IP camera development board directory_ **nfs**
Example:
```
mount 192.168.1.10:/nfs /nfs nfs
```
**Executing test cases**
1. View the serial port logs.
2. Run the **./**_Test module_**.bin** command to execute test cases of each test suite.
get-code/源码获取.md
浏览文件 @ 37cc208b
...@@ -188,7 +188,7 @@ OpenHarmony是HarmonyOS的开源版，由华为捐赠给开放原子开源基金 ...@@ -188,7 +188,7 @@ OpenHarmony是HarmonyOS的开源版，由华为捐赠给开放原子开源基金
## 操作<a name="section1445143510117"></a> ## 操作<a name="section1445143510117"></a>
接下来将组件添加到开发项目中，假定要获取的组件名为@ohos/demo，具体操作如下： 接下来将组件添加到开发项目中，假定要获取的组件名为@ohos/demo，实际操作过程中以实际组件名为准，具体操作如下：
1. 进入开发目录，执行如下命令，采用默认模板创建一个开发项目。 1. 进入开发目录，执行如下命令，采用默认模板创建一个开发项目。
......
get-code/获取工具.md
浏览文件 @ 37cc208b
# 获取工具<a name="ZH-CN_TOPIC_0000001055705774"></a> # 获取工具<a name="ZH-CN_TOPIC_0000001055705774"></a>
- [编译工具链获取路径](#zh-cn_topic_0000001055701144_section18750162432511) - [Docker方式获取编译环境](#zh-cn_topic_0000001055701144_section107932281315)
- [基于HPM的Docker环境](#zh-cn_topic_0000001055701144_section054931895313)
- [独立Docker环境](#zh-cn_topic_0000001055701144_section980782720014)
- [软件包方式获取编译工具链](#zh-cn_topic_0000001055701144_section18750162432511)
- [获取设备开发工具（HUAWEI DevEco Device Tool）](#zh-cn_topic_0000001055701144_section12307171315108) - [获取设备开发工具（HUAWEI DevEco Device Tool）](#zh-cn_topic_0000001055701144_section12307171315108)
- [工具简介](#zh-cn_topic_0000001055701144_section68281728193514) - [工具简介](#zh-cn_topic_0000001055701144_section68281728193514)
- [工具获取路径](#zh-cn_topic_0000001055701144_section13785205443514) - [工具获取路径](#zh-cn_topic_0000001055701144_section13785205443514)
...@@ -10,11 +14,178 @@ ...@@ -10,11 +14,178 @@
- [工具获取路径](#zh-cn_topic_0000001055701144_section1572093543613) - [工具获取路径](#zh-cn_topic_0000001055701144_section1572093543613)
- [工具使用指南](#zh-cn_topic_0000001055701144_section1125615298385) - [工具使用指南](#zh-cn_topic_0000001055701144_section1125615298385)
## 编译工具链获取路径<a name="zh-cn_topic_0000001055701144_section18750162432511"></a> ## Docker方式获取编译环境<a name="zh-cn_topic_0000001055701144_section107932281315"></a>
OpenHarmony为开发者提供了两种Docker环境，以帮助开发者快速完成复杂的开发环境准备工作。两种Docker环境及适用场景如下：
- 基于HPM的Docker环境：适用于使用HPM工具进行发行版编译的场景。
- 独立Docker环境：适用于直接基于Ubuntu、Windows操作系统平台进行版本编译的场景。
独立Docker环境目前容器化构建选项支持情况如下：
**表 1** Docker镜像介绍
<a name="zh-cn_topic_0000001055701144_table2790164495315"></a>
<table><thead align="left"><tr id="zh-cn_topic_0000001055701144_row3790644155317"><th class="cellrowborder" valign="top" width="17.97%" id="mcps1.2.5.1.1"><p id="zh-cn_topic_0000001055701144_p127896443535"><a name="zh-cn_topic_0000001055701144_p127896443535"></a><a name="zh-cn_topic_0000001055701144_p127896443535"></a>适配的硬件平台</p>
</th>
<th class="cellrowborder" valign="top" width="29.110000000000003%" id="mcps1.2.5.1.2"><p id="zh-cn_topic_0000001055701144_p8789114445316"><a name="zh-cn_topic_0000001055701144_p8789114445316"></a><a name="zh-cn_topic_0000001055701144_p8789114445316"></a>Docker镜像仓库</p>
</th>
<th class="cellrowborder" valign="top" width="8.43%" id="mcps1.2.5.1.3"><p id="zh-cn_topic_0000001055701144_p17896448533"><a name="zh-cn_topic_0000001055701144_p17896448533"></a><a name="zh-cn_topic_0000001055701144_p17896448533"></a>标签</p>
</th>
<th class="cellrowborder" valign="top" width="44.49%" id="mcps1.2.5.1.4"><p id="zh-cn_topic_0000001055701144_p1278917444539"><a name="zh-cn_topic_0000001055701144_p1278917444539"></a><a name="zh-cn_topic_0000001055701144_p1278917444539"></a>说明</p>
</th>
</tr>
</thead>
<tbody><tr id="zh-cn_topic_0000001055701144_row167901244115315"><td class="cellrowborder" valign="top" width="17.97%" headers="mcps1.2.5.1.1 "><p id="zh-cn_topic_0000001055701144_p6790144155314"><a name="zh-cn_topic_0000001055701144_p6790144155314"></a><a name="zh-cn_topic_0000001055701144_p6790144155314"></a>Hi3861/Hi3516/Hi3518</p>
</td>
<td class="cellrowborder" valign="top" width="29.110000000000003%" headers="mcps1.2.5.1.2 "><p id="zh-cn_topic_0000001055701144_p87901744185316"><a name="zh-cn_topic_0000001055701144_p87901744185316"></a><a name="zh-cn_topic_0000001055701144_p87901744185316"></a>swr.cn-south-1.myhuaweicloud.com/openharmony-docker/openharmony-docker</p>
</td>
<td class="cellrowborder" valign="top" width="8.43%" headers="mcps1.2.5.1.3 "><p id="zh-cn_topic_0000001055701144_p15790184410536"><a name="zh-cn_topic_0000001055701144_p15790184410536"></a><a name="zh-cn_topic_0000001055701144_p15790184410536"></a>0.0.2</p>
</td>
<td class="cellrowborder" valign="top" width="44.49%" headers="mcps1.2.5.1.4 "><p id="zh-cn_topic_0000001055701144_p15790124416531"><a name="zh-cn_topic_0000001055701144_p15790124416531"></a><a name="zh-cn_topic_0000001055701144_p15790124416531"></a>已经预安装<span id="zh-cn_topic_0000001055701144_text6790444135318"><a name="zh-cn_topic_0000001055701144_text6790444135318"></a><a name="zh-cn_topic_0000001055701144_text6790444135318"></a>OpenHarmony</span>版本的编译环境，支持Hi3861/Hi3516/Hi3518三种平台的版本构建</p>
</td>
</tr>
</tbody>
</table>
### 基于HPM的Docker环境<a name="zh-cn_topic_0000001055701144_section054931895313"></a>
docker\_dist是一个[HPM](https://hpm.harmonyos.com/)系统中的模板组件，能够帮助用户快速初始化HPM工程，利用docker镜像来快速编译OpenHarmony发行版，在很大程度上简化了编译前的环境配置。开发者在配置好Ubuntu和[hpm-cli](https://device.harmonyos.com/cn/docs/develop/bundles/oem_bundle_guide_prepare-0000001050129846)开发环境后，可以通过以下步骤来使用我们提供的Docker环境。
**搭建Docker环境**
1. 初始化安装模板。在任意工作目录中执行以下命令。
```
hpm init -t @ohos/docker_dist
```
2. 修改publishAs。
因为获取到的是模板类型的包，要把包的类型改为需要的类型。 在当前目录下打开bundle.json文件，把"publishAs"字段的值由"template"改为"distribution"。
3. 选择解决方案。设置解决方案发行版的环境变量。
ip\_camera\_hi3516dv300:
```
export solution=@ohos/ip_camera_hi3516dv300
```
ip\_camera\_hi3518ev300:
```
export solution=@ohos/ip_camera_hi3518ev300
```
wifiiot:
```
export solution=@ohos/wifi_iot
```
>![](public_sys-resources/icon-note.gif) **说明：**
>windows下使用cmd设置需要使用如下命令
>```
>set solution=发行版名称
>```
**编译源码**
执行编译。以ip\_camera\_hi3518ev300为例。
以下命令可以帮助用户自动安装docker, 拉取镜像，并且在容器中开始运行对应解决方案的拉取和编译。
```
hpm run docker
```
执行成功结果如下：
```
......
ohos ipcamera_hi3518 build success!
@ohos/ip_camera_hi3518ev300: distribution building completed.
```
>![](public_sys-resources/icon-note.gif) **说明：**
>自动安装docker只能在Ubuntu环境下执行，如果其他环境，需要用户自行安装docker，然后拉取镜像，执行编译。相关操作如下：
>```
># 拉取镜像
>docker pull swr.cn-south-1.myhuaweicloud.com/openharmony-docker/openharmony-docker:0.0.2
># linux环境下的编译
>hpm run distWithDocker
># windows下的编译，需要配置gitbash
>hpm config set shellPath "gitbash路径"
>hpm run distWithDocker
>```
### 独立Docker环境<a name="zh-cn_topic_0000001055701144_section980782720014"></a>
OpenHarmony的Docker镜像托管在[HuaweiCloud SWR](https://console.huaweicloud.com/swr/?region=cn-south-1#/app/warehouse/warehouseMangeDetail/goldensir/openharmony-docker/openharmony-docker?type=ownImage)上。开发者可以通过该镜像在很大程度上简化编译前的环境配置。开发者在配置好开发环境后，通过以下步骤来使用Docker环境。本Docker支持Ubuntu/Windows平台，下文将以Ubuntu系统为例进行使用介绍。
**方式一：从HuaweiCloud SWR上直接获取Docker镜像进行构建：**
1. 获取Docker镜像。
```
docker pull swr.cn-south-1.myhuaweicloud.com/openharmony-docker/openharmony-docker:0.0.2
```
2. 进入OpenHarmony代码根目录执行如下命令，从而进入Docker构建环境。
```
docker run -it -v $(pwd):/home/openharmony swr.cn-south-1.myhuaweicloud.com/openharmony-docker/openharmony-docker:0.0.2
```
3. 通过如下编译脚本启动wifiiot、ipcamera\_hi3516dv300、ipcamera\_hi3518ev300不同平台的编译。
```
python build.py wifiiot/ipcamera_hi3516dv300/ipcamera_hi3518ev300
```
```
```
**方式二：通过Dockerfile 构建本地Docker镜像进行构建**
1. 获取Dockerfile脚本文件，用来构建本地Docker镜像。
```
git clone https://gitee.com/openharmony/docs.git
```
2. 进入Dockerfile代码目录路径执行Docker镜像构建命令。
```
cd docs/docker
./build.sh
```
3. 进入OpenHarmony代码根目录执行如下命令，从而进入Docker构建环境。
```
docker run -it -v $(pwd):/home/openharmony openharmony-docker:0.0.2
```
4. 通过如下编译脚本启动wifiiot、ipcamera\_hi3516dv300、ipcamera\_hi3518ev300不同平台的编译。
```
python build.py wifiiot/ipcamera_hi3516dv300/ipcamera_hi3518ev300
```
## 软件包方式获取编译工具链<a name="zh-cn_topic_0000001055701144_section18750162432511"></a>
如果不使用Docker，使用软件包方式安装编译环境，请按本节要求，从镜像站点下载部分编译工具链，具体如下表所示。
从镜像站点下载的编译工具链如下表所示。全部编译工具链的下载以及安装，请参考“快速入门”的“[Hi3861环境搭建](../quick-start/搭建环境.md)、[Hi3516环境搭建](../quick-start/搭建环境-0.md)、[Hi3518环境搭建](../quick-start/搭建环境-2.md)”部分。 全部编译工具链的下载以及安装，请参考“快速入门”的“[Hi3861环境搭建](../quick-start/Hi3861搭建环境.md)、[Hi3516环境搭建](../quick-start/Hi3516搭建环境.md)、[Hi3518环境搭建](../quick-start/Hi3518搭建环境.md)”部分。
**表 1** 编译工具链获取路径 **表 2** 编译工具链获取路径
<a name="zh-cn_topic_0000001055701144_table167961324122511"></a> <a name="zh-cn_topic_0000001055701144_table167961324122511"></a>
<table><thead align="left"><tr id="zh-cn_topic_0000001055701144_row87941124202517"><th class="cellrowborder" valign="top" width="16.35%" id="mcps1.2.6.1.1"><p id="zh-cn_topic_0000001055701144_p12231193484318"><a name="zh-cn_topic_0000001055701144_p12231193484318"></a><a name="zh-cn_topic_0000001055701144_p12231193484318"></a>适用开发板</p> <table><thead align="left"><tr id="zh-cn_topic_0000001055701144_row87941124202517"><th class="cellrowborder" valign="top" width="16.35%" id="mcps1.2.6.1.1"><p id="zh-cn_topic_0000001055701144_p12231193484318"><a name="zh-cn_topic_0000001055701144_p12231193484318"></a><a name="zh-cn_topic_0000001055701144_p12231193484318"></a>适用开发板</p>
......
guide/figures/选择工程模板.png
查看替换文件 @ 7958dbc6 浏览文件 @ 37cc208b
guide/figures/选择工程模板.png

77.0 KB | W: | H:

guide/figures/选择工程模板.png

21.5 KB | W: | H:

guide/figures/选择工程模板.png
guide/figures/选择工程模板.png
guide/figures/选择工程模板.png
guide/figures/选择工程模板.png
  • 2-up
  • Swipe
  • Onion skin
guide/应用实例-5.md
浏览文件 @ 37cc208b
...@@ -11,7 +11,12 @@ ...@@ -11,7 +11,12 @@
- 本示例编译结果路径为“out/ipcamera\_hi3516dv300/dev\_tools/bin/camera\_sample”，为让文件能在单板中执行，可将示例文件通过读卡器复制至TF卡中，或者修改camera\_sample的编译脚本将结果文件复制至rootfs.img中。 - 本示例编译结果路径为“out/ipcamera\_hi3516dv300/dev\_tools/bin/camera\_sample”，为让文件能在单板中执行，可将示例文件通过读卡器复制至TF卡中，或者修改camera\_sample的编译脚本将结果文件复制至rootfs.img中。
**修改方法：**将源码路径“applications/sample/camera/media/BUILD.gn”中第一处的output\_dir = "$root\_out\_dir/dev\_ools"语句修改为output\_dir = "$root\_out\_dir/"，重新执行源码仓编译并烧写入单板后，可在单板bin目录下找到camera\_sample文件。 修改源码路径“applications/sample/camera/media/BUILD.gn”中第一处的output\_dir。
- 修改前：output\_dir = "$root\_out\_dir/dev\_ools"
- 修改后：output\_dir = "$root\_out\_dir/"
重新执行源码仓编译并烧写入单板后，可在单板bin目录下找到camera\_sample文件。
>![](public_sys-resources/icon-notice.gif) **须知：** >![](public_sys-resources/icon-notice.gif) **须知：**
>实例运行拍照和录像功能需要插入TF卡\(最大容量支持128GB\)，系统启动后自动将TF卡挂载至/sdcard目录，如果在启动后插入则需要手动挂载。查看拍照和录像内容可将TF卡中内容复制到电脑中进行查看，预览功能无需TF卡。 >实例运行拍照和录像功能需要插入TF卡\(最大容量支持128GB\)，系统启动后自动将TF卡挂载至/sdcard目录，如果在启动后插入则需要手动挂载。查看拍照和录像内容可将TF卡中内容复制到电脑中进行查看，预览功能无需TF卡。
......
guide/应用实例.md
浏览文件 @ 37cc208b
...@@ -2,7 +2,12 @@ ...@@ -2,7 +2,12 @@
- 开发板介绍及编译烧录、运行镜像基本流程参考对应开发板快速入门手册：[Hi3518快速入门](../quick-start/Hi3518开发板介绍.md)，编译结果包含示例，结果文件为out/ipcamera\_hi3518ev300/dev\_tools/bin/camera\_sample，可将文件通过读卡器复制至TF卡中，或者修改camera\_sample的编译脚本将结果文件复制至rootfs.img中。 - 开发板介绍及编译烧录、运行镜像基本流程参考对应开发板快速入门手册：[Hi3518快速入门](../quick-start/Hi3518开发板介绍.md)，编译结果包含示例，结果文件为out/ipcamera\_hi3518ev300/dev\_tools/bin/camera\_sample，可将文件通过读卡器复制至TF卡中，或者修改camera\_sample的编译脚本将结果文件复制至rootfs.img中。
**修改方法**：将`applications/sample/camera/media/BUILD.gn`中的`output_dir = "$root_out_dir/dev_tools"`语句修改为`output_dir = "$root_out_dir/"`，重新执行源码仓编译并烧写入单板后，可在单板bin目录下找到`camera_sample`文件。 修改applications/sample/camera/media/BUILD.gn中的output\_dir。
- 修改前：output\_dir = "$root\_out\_dir/dev\_tools"
- 修改后：output\_dir = "$root\_out\_d_i_r/"
重新执行源码仓编译并烧写入单板后，可在单板bin目录下找到camera\_sample文件。
- 相机示例代码为applications/sample/camera/media/camera\_sample.cpp。 - 相机示例代码为applications/sample/camera/media/camera\_sample.cpp。
......
guide/开发准备.md
浏览文件 @ 37cc208b
...@@ -9,41 +9,12 @@ ...@@ -9,41 +9,12 @@
## 创建项目<a name="section1456035192720"></a> ## 创建项目<a name="section1456035192720"></a>
DevEco Studio配置完成后，请根据如下步骤创建项目（暂不支持直接创建“smartVision”类型项目）。 DevEco Studio配置完成后，请根据如下步骤创建项目。
>![](public_sys-resources/icon-note.gif) **说明：** 1. 运行DevEco Studio，点击**File \> Project**，选择“Smart Vision”下的“Empty Feature Ability”模板。
>当前的DevEco Studio提供基本的开发功能，至于模拟器界面预览、代码调测将在下个版本提供，敬请期待。
1. 运行DevEco Studio，点击**File \> Project**，选择“Lite Wearable”下的“Empty Feature Ability”模板。
**图 1** 选择工程模板<a name="fig1111842916140"></a> **图 1** 选择工程模板<a name="fig1111842916140"></a>
![](figures/选择工程模板.png "选择工程模板") ![](figures/选择工程模板.png "选择工程模板")
2. 创建成功后，修改**entry \> src \> main**目录下的config.json文件。 2. 点击Next，配置项目名称和路径等信息后点击Finish按钮即完成项目创建。
1. 将“deviceType”的取值修改为"smartVision"。
2. 在abilities数组内新增“visible”属性，取值设置为“true”。
```
"deviceConfig": {},
"module": {
"deviceType": [
"smartVision" //将deviceType 改为"smartVision"
],
"distro": {
"deliveryWithInstall": true,
"moduleName": "entry",
"moduleType": "entry"
},
"abilities": [
{"name":
"default","icon":
"$media:icon",
"label": "airquality",
"visible": true, //新增“visible”属性，值为“true”
"type": "page"
}
],
```
guide/验证.md
浏览文件 @ 37cc208b
# 验证<a name="ZH-CN_TOPIC_0000001054370931"></a> # 验证<a name="ZH-CN_TOPIC_0000001054370931"></a>
编译过程请参考《[Hi3861快速入门-源码编译](../quick-start/Hi3861开发板第一个示例程序.md)》，烧录过程请参考《[Hi3861快速入门-镜像烧录](../quick-start/Hi3861开发板第一个示例程序.md)》。 编译过程请参考《[Hi3861快速入门-源码编译](../quick-start/开发Hi3861第一个示例程序.md)》，烧录过程请参考《[Hi3861快速入门-镜像烧录](../quick-start/开发Hi3861第一个示例程序.md)》。
完成以上两步后，按下RST键复位模组，可发现LED在周期性闪烁，与预期相符，验证完毕。 完成以上两步后，按下RST键复位模组，可发现LED在周期性闪烁，与预期相符，验证完毕。
......
porting/CMake方式组织编译的库移植.md 0 → 100644
浏览文件 @ 37cc208b
# CMake方式组织编译的库移植<a name="ZH-CN_TOPIC_0000001063033549"></a>
- [源码获取](#section1771132116245)
- [移植思路](#section9737174410328)
- [交叉编译](#section38205577332)
- [编译参考](#section1088111263418)
- [设置执行交叉编译](#section8168182883515)
- [测试](#section6686144293611)
- [将该库编译添加到工程中](#section1651053153715)
以double-conversion库为例，其移植过程如下文所示
## 源码获取<a name="section1771132116245"></a>
从仓库[获取double-conversion源码](https://github.com/google/double-conversion)，其目录结构如下表：
**表 1** 源码目录结构
<a name="table824211132418"></a>
<table><thead align="left"><tr id="row524220131043"><th class="cellrowborder" valign="top" width="49.95%" id="mcps1.2.3.1.1"><p id="p22421213442"><a name="p22421213442"></a><a name="p22421213442"></a>名称</p>
</th>
<th class="cellrowborder" valign="top" width="50.05%" id="mcps1.2.3.1.2"><p id="p132427131241"><a name="p132427131241"></a><a name="p132427131241"></a>描述</p>
</th>
</tr>
</thead>
<tbody><tr id="row1335114463010"><td class="cellrowborder" valign="top" width="49.95%" headers="mcps1.2.3.1.1 "><p id="p3354144414307"><a name="p3354144414307"></a><a name="p3354144414307"></a>double-conversion/cmake/</p>
</td>
<td class="cellrowborder" valign="top" width="50.05%" headers="mcps1.2.3.1.2 "><p id="p1235564417307"><a name="p1235564417307"></a><a name="p1235564417307"></a>CMake组织编译使用到的模板</p>
</td>
</tr>
<tr id="row1024211133411"><td class="cellrowborder" valign="top" width="49.95%" headers="mcps1.2.3.1.1 "><p id="p12423137414"><a name="p12423137414"></a><a name="p12423137414"></a>double-conversion/double-conversion/</p>
</td>
<td class="cellrowborder" valign="top" width="50.05%" headers="mcps1.2.3.1.2 "><p id="p824221314420"><a name="p824221314420"></a><a name="p824221314420"></a>源文件目录</p>
</td>
</tr>
<tr id="row1242813545"><td class="cellrowborder" valign="top" width="49.95%" headers="mcps1.2.3.1.1 "><p id="p424213131343"><a name="p424213131343"></a><a name="p424213131343"></a>double-conversion/msvc/</p>
</td>
<td class="cellrowborder" valign="top" width="50.05%" headers="mcps1.2.3.1.2 "><p id="p172429139418"><a name="p172429139418"></a><a name="p172429139418"></a>-</p>
</td>
</tr>
<tr id="row20242513641"><td class="cellrowborder" valign="top" width="49.95%" headers="mcps1.2.3.1.1 "><p id="p2024210139412"><a name="p2024210139412"></a><a name="p2024210139412"></a>double-conversion/test/</p>
</td>
<td class="cellrowborder" valign="top" width="50.05%" headers="mcps1.2.3.1.2 "><p id="p7242713241"><a name="p7242713241"></a><a name="p7242713241"></a>测试用例源文件</p>
</td>
</tr>
<tr id="row12242191314413"><td class="cellrowborder" valign="top" width="49.95%" headers="mcps1.2.3.1.1 "><p id="p172420131646"><a name="p172420131646"></a><a name="p172420131646"></a>double-conversion/.gitignore</p>
</td>
<td class="cellrowborder" valign="top" width="50.05%" headers="mcps1.2.3.1.2 "><p id="p112426131843"><a name="p112426131843"></a><a name="p112426131843"></a>-</p>
</td>
</tr>
<tr id="row1484211616360"><td class="cellrowborder" valign="top" width="49.95%" headers="mcps1.2.3.1.1 "><p id="p1384206143617"><a name="p1384206143617"></a><a name="p1384206143617"></a>double-conversion/AUTHORS</p>
</td>
<td class="cellrowborder" valign="top" width="50.05%" headers="mcps1.2.3.1.2 "><p id="p384310614366"><a name="p384310614366"></a><a name="p384310614366"></a>-</p>
</td>
</tr>
<tr id="row1290331063610"><td class="cellrowborder" valign="top" width="49.95%" headers="mcps1.2.3.1.1 "><p id="p18903410183613"><a name="p18903410183613"></a><a name="p18903410183613"></a>double-conversion/BUILD</p>
</td>
<td class="cellrowborder" valign="top" width="50.05%" headers="mcps1.2.3.1.2 "><p id="p1990491033617"><a name="p1990491033617"></a><a name="p1990491033617"></a>-</p>
</td>
</tr>
<tr id="row5967101420368"><td class="cellrowborder" valign="top" width="49.95%" headers="mcps1.2.3.1.1 "><p id="p696710141361"><a name="p696710141361"></a><a name="p696710141361"></a>double-conversion/CMakeLists.txt</p>
</td>
<td class="cellrowborder" valign="top" width="50.05%" headers="mcps1.2.3.1.2 "><p id="p1196714147366"><a name="p1196714147366"></a><a name="p1196714147366"></a>CMake方式顶层编译组织文件</p>
</td>
</tr>
<tr id="row19372034133612"><td class="cellrowborder" valign="top" width="49.95%" headers="mcps1.2.3.1.1 "><p id="p1596214484473"><a name="p1596214484473"></a><a name="p1596214484473"></a>double-conversion/COPYING</p>
</td>
<td class="cellrowborder" valign="top" width="50.05%" headers="mcps1.2.3.1.2 "><p id="p163811348364"><a name="p163811348364"></a><a name="p163811348364"></a>-</p>
</td>
</tr>
<tr id="row0184133717364"><td class="cellrowborder" valign="top" width="49.95%" headers="mcps1.2.3.1.1 "><p id="p1166255034715"><a name="p1166255034715"></a><a name="p1166255034715"></a>double-conversion/Changelog</p>
</td>
<td class="cellrowborder" valign="top" width="50.05%" headers="mcps1.2.3.1.2 "><p id="p151851337193617"><a name="p151851337193617"></a><a name="p151851337193617"></a>-</p>
</td>
</tr>
<tr id="row173871412369"><td class="cellrowborder" valign="top" width="49.95%" headers="mcps1.2.3.1.1 "><p id="p411055217475"><a name="p411055217475"></a><a name="p411055217475"></a>double-conversion/LICENSE</p>
</td>
<td class="cellrowborder" valign="top" width="50.05%" headers="mcps1.2.3.1.2 "><p id="p9387641173617"><a name="p9387641173617"></a><a name="p9387641173617"></a>-</p>
</td>
</tr>
<tr id="row534170185015"><td class="cellrowborder" valign="top" width="49.95%" headers="mcps1.2.3.1.1 "><p id="p035703507"><a name="p035703507"></a><a name="p035703507"></a>double-conversion/Makefile</p>
</td>
<td class="cellrowborder" valign="top" width="50.05%" headers="mcps1.2.3.1.2 "><p id="p6367075019"><a name="p6367075019"></a><a name="p6367075019"></a>-</p>
</td>
</tr>
<tr id="row1367804175011"><td class="cellrowborder" valign="top" width="49.95%" headers="mcps1.2.3.1.1 "><p id="p1246133725014"><a name="p1246133725014"></a><a name="p1246133725014"></a>double-conversion/README.md</p>
</td>
<td class="cellrowborder" valign="top" width="50.05%" headers="mcps1.2.3.1.2 "><p id="p136796410508"><a name="p136796410508"></a><a name="p136796410508"></a>-</p>
</td>
</tr>
<tr id="row2070619141508"><td class="cellrowborder" valign="top" width="49.95%" headers="mcps1.2.3.1.1 "><p id="p1963193815509"><a name="p1963193815509"></a><a name="p1963193815509"></a>double-conversion/SConstruct</p>
</td>
<td class="cellrowborder" valign="top" width="50.05%" headers="mcps1.2.3.1.2 "><p id="p570691485015"><a name="p570691485015"></a><a name="p570691485015"></a>-</p>
</td>
</tr>
<tr id="row186521925020"><td class="cellrowborder" valign="top" width="49.95%" headers="mcps1.2.3.1.1 "><p id="p152191040155012"><a name="p152191040155012"></a><a name="p152191040155012"></a>double-conversion/WORKSPACE</p>
</td>
<td class="cellrowborder" valign="top" width="50.05%" headers="mcps1.2.3.1.2 "><p id="p4661119175014"><a name="p4661119175014"></a><a name="p4661119175014"></a>-</p>
</td>
</tr>
</tbody>
</table>
## 移植思路<a name="section9737174410328"></a>
移植思路：通过修改工具链，交叉编译该三方库，生成OpenHarmony平台的可执行文件，最后再通过GN调用CMake的方式添加到OpenHarmony工程中。
## 交叉编译<a name="section38205577332"></a>
### 编译参考<a name="section1088111263418"></a>
代码仓库的README.md中详细介绍了使用CMake编译double-conversion库的步骤，以及测试方法。本文参考该指导设置该库的编译配置，并完成测试。若开发人员在移植过程中对该库的编译选项配置有疑惑的地方，[可参考该指导](https://github.com/google/double-conversion/blob/master/README.md)。对于其他使用CMake可独立编译的三方库，在移植时可以参考其自带的编译指导。
### 设置执行交叉编译<a name="section8168182883515"></a>
CMake方式可通过指定工具链进行交叉编译，修改并编译该库，生成OpenHarmony平台的可执行文件，步骤如下：
1. 设置工具链
将下列clang工具链配置添加到该工程的顶层CMakeLists.txt（即[表1中的该文件](#table824211132418)）中即可。
```
set(CMAKE_CROSSCOMPILING TRUE)
set(CMAKE_SYSTEM_NAME Generic)
set(CMAKE_CXX_COMPILER_ID Clang)
set(CMAKE_TOOLCHAIN_PREFIX llvm-)
#指定c编译工具（确保工具链所在路径已经添加到了PATH环境变量中）和编译标志，使用clang编译时标志中必须指定--target，否则无法交叉编译。
set(CMAKE_C_COMPILER clang)
set(CMAKE_C_FLAGS "--target=arm-liteos -D__clang__ -march=armv7-a -w")
#指定c++编译工具（确保工具链所在路径已经添加到了PATH环境变量中）和编译标志，必须指定--target，否则无法交叉编译。
set(CMAKE_CXX_COMPILER clang++)
set(CMAKE_CXX_FLAGS "--target=arm-liteos -D__clang__ -march=armv7-a -w")
#指定链接工具和链接标志，必须指定--target和--sysroot，其中OHOS_ROOT_PATH可通过cmake命令后缀参数来指定。
set(MY_LINK_FLAGS "--target=arm-liteos --sysroot=${OHOS_SYSROOT_PATH}")
set(CMAKE_LINKER clang)
set(CMAKE_CXX_LINKER clang++)
set(CMAKE_C_LINKER clang)
set(CMAKE_C_LINK_EXECUTABLE "${CMAKE_C_LINKER} ${MY_LINK_FLAGS} <FLAGS> <LINK_FLAGS> <OBJECTS> -o <TARGET> <LINK_LIBRARIES>")
set(CMAKE_CXX_LINK_EXECUTABLE "${CMAKE_CXX_LINKER} ${MY_LINK_FLAGS} <FLAGS> <LINK_FLAGS> <OBJECTS> -o <TARGET> <LINK_LIBRARIES>")
#指定链接库的查找路径。
set(CMAKE_SYSROOT ${OHOS_SYSROOT_PATH})
```
2. 执行编译
linux命令行中进入double-conversion的源文件目录（即[表1所示目录](#table824211132418)），执行下列命令：
```
mkdir build && cd build
cmake .. -DBUILD_TESTING=ON -DOHOS_SYSROOT_PATH="..."
make -j
```
其中OHOS\_SYSROOT\_PATH需用绝对路径指定出sysroot目录的位置，以OpenHarmony为例即目录openHarmony/prebuilts/lite/sysroot的绝对路径。
3. <a name="li15717101715249"></a>查看结果
步骤2操作完成后，build目录下会生成静态库文件和测试用例：
**表 2** 编译生成文件目录结构
<a name="table1452412391911"></a>
<table><thead align="left"><tr id="row15259397114"><th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.1"><p id="p084365219116"><a name="p084365219116"></a><a name="p084365219116"></a>名称</p>
</th>
<th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.2"><p id="p118435524118"><a name="p118435524118"></a><a name="p118435524118"></a>描述</p>
</th>
</tr>
</thead>
<tbody><tr id="row17861750780"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p208014918411"><a name="p208014918411"></a><a name="p208014918411"></a>double-conversion/build/libdouble-conversion.a</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p155272391619"><a name="p155272391619"></a><a name="p155272391619"></a>生成的静态库文件</p>
</td>
</tr>
<tr id="row141820612910"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p1941811618918"><a name="p1941811618918"></a><a name="p1941811618918"></a>double-conversion/build/test/</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p64181761995"><a name="p64181761995"></a><a name="p64181761995"></a>目录下存放生成的测试用例和相关CMake缓存文件</p>
</td>
</tr>
<tr id="row19525239815"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p452512394117"><a name="p452512394117"></a><a name="p452512394117"></a>double-conversion/build/CMakeCache.txt</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p652615391617"><a name="p652615391617"></a><a name="p652615391617"></a>CMake构建过程中的缓存文件</p>
</td>
</tr>
<tr id="row1526839312"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p28017499413"><a name="p28017499413"></a><a name="p28017499413"></a>double-conversion/build/CMakeFiles/</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p25261439314"><a name="p25261439314"></a><a name="p25261439314"></a>-</p>
</td>
</tr>
<tr id="row15269396111"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p138014494415"><a name="p138014494415"></a><a name="p138014494415"></a>double-conversion/build/cmake_install.cmake</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p75268391519"><a name="p75268391519"></a><a name="p75268391519"></a>-</p>
</td>
</tr>
<tr id="row185265399113"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p78054914419"><a name="p78054914419"></a><a name="p78054914419"></a>double-conversion/build/CTestTestfile.cmake</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p65261039218"><a name="p65261039218"></a><a name="p65261039218"></a>-</p>
</td>
</tr>
<tr id="row125261139115"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p158064916419"><a name="p158064916419"></a><a name="p158064916419"></a>double-conversion/build/DartConfiguration.tcl</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p20526939118"><a name="p20526939118"></a><a name="p20526939118"></a>-</p>
</td>
</tr>
<tr id="row2526839712"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p6803491043"><a name="p6803491043"></a><a name="p6803491043"></a>double-conversion/build/generated/</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p115269395113"><a name="p115269395113"></a><a name="p115269395113"></a>-</p>
</td>
</tr>
<tr id="row173131653454"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p7803493412"><a name="p7803493412"></a><a name="p7803493412"></a>double-conversion/build/Makefile</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p19316135318512"><a name="p19316135318512"></a><a name="p19316135318512"></a>-</p>
</td>
</tr>
<tr id="row4380879618"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p10381478619"><a name="p10381478619"></a><a name="p10381478619"></a>double-conversion/build/Testing/</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p17381679610"><a name="p17381679610"></a><a name="p17381679610"></a>-</p>
</td>
</tr>
</tbody>
</table>
## 测试<a name="section6686144293611"></a>
1. 搭建OpenHarmony环境
以hi3518ev300为例，编译出OpenHarmony镜像，烧写到开发板，参考[开发Hi3518第一个示例程序.md](https://gitee.com/openharmony/docs/blob/master/quick-start/%E5%BC%80%E5%8F%91Hi3518%E7%AC%AC%E4%B8%80%E4%B8%AA%E7%A4%BA%E4%BE%8B%E7%A8%8B%E5%BA%8F.md)。
进入系统如下所示：
**图 1** OpenHarmony启动成功界面<a name="fig13279524162418"></a>
![](figures/OpenHarmony启动成功界面.png "OpenHarmony启动成功界面")
2. 挂载nfs目录，将[表2](#table1452412391911)中test目录下cctest可执行文件放入nfs目录
3. 执行用例
该库采用非交叉编译时用例是通过make test执行，CMake会有相关的执行结果统计；交叉编译时无法使用该方法，因此可直接执行生成的测试文件完成测试。
- 挂载成功后执行下列命令可列出用例所有条目：
```
cd nfs
./cctest --list
```
上述命令执行结果部分展示：
```
test-bignum/Assign<
test-bignum/ShiftLeft<
test-bignum/AddUInt64<
test-bignum/AddBignum<
test-bignum/SubtractBignum<
test-bignum/MultiplyUInt32<
test-bignum/MultiplyUInt64<
test-bignum/MultiplyPowerOfTen<
test-bignum/DivideModuloIntBignum<
test-bignum/Compare<
test-bignum/PlusCompare<
test-bignum/Square<
test-bignum/AssignPowerUInt16<
test-bignum-dtoa/BignumDtoaVariousDoubles<
test-bignum-dtoa/BignumDtoaShortestVariousFloats<
test-bignum-dtoa/BignumDtoaGayShortest<
test-bignum-dtoa/BignumDtoaGayShortestSingle<
test-bignum-dtoa/BignumDtoaGayFixed<
test-bignum-dtoa/BignumDtoaGayPrecision<
test-conversions/DoubleToShortest<
test-conversions/DoubleToShortestSingle<
...
```
- 以test-bignum条目为例，执行下列命令开始测试：
```
./cctest test-bignum
```
测试结果如下则表示通过：
```
Ran 13 tests.
```
## 将该库编译添加到OpenHarmony工程中<a name="section1651053153715"></a>
1. 复制库到OpenHarmony工程中
拷贝已经能够成功交叉编译的库到OpenHarmony的third\_party目录，为了不修改要移植的三方库目录下的BUILD.gn文件，再添加一层目录放置新增的gn转CMake编译适配文件，新增的文件有BUILD.gn、build\_thirdparty.py、 config.gni，新增后的目录结构如下所示。
**表 3** 添加到工程后的目录结构
<a name="table13265185817173"></a>
<table><thead align="left"><tr id="row92666583171"><th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.1"><p id="p2266105816178"><a name="p2266105816178"></a><a name="p2266105816178"></a>名称</p>
</th>
<th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.2"><p id="p32661158161718"><a name="p32661158161718"></a><a name="p32661158161718"></a>描述</p>
</th>
</tr>
</thead>
<tbody><tr id="row1526655816175"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p226605811710"><a name="p226605811710"></a><a name="p226605811710"></a>openHarmony/third_party/double-conversion/BUILD.gn</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p1626675812177"><a name="p1626675812177"></a><a name="p1626675812177"></a>将三方库加入工程的gn适配文件</p>
</td>
</tr>
<tr id="row1726610589179"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p12266115815170"><a name="p12266115815170"></a><a name="p12266115815170"></a>openHarmony/third_party/double-conversion/build_thirdpaty.py</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p122661958201719"><a name="p122661958201719"></a><a name="p122661958201719"></a>GN调用shell命令脚本文件，由上面GN文件将相关命令传入，实现GN转CMake</p>
</td>
</tr>
<tr id="row7266195891714"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p162665581170"><a name="p162665581170"></a><a name="p162665581170"></a>openHarmony/third_party/double-conversion/config.gni</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p626712588175"><a name="p626712588175"></a><a name="p626712588175"></a>三方库编译配置文件，可修改该文件来配置用例是否参与构建等</p>
</td>
</tr>
<tr id="row1272420109203"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p17725101052012"><a name="p17725101052012"></a><a name="p17725101052012"></a>openHarmony/third_party/double-conversion/double-conversion/</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p87252109205"><a name="p87252109205"></a><a name="p87252109205"></a>要移植的三方库目录</p>
</td>
</tr>
</tbody>
</table>
2. 添加gn到CMake适配文件
- **新增的BUILD.gn文件实现如下，其他采用CMake方式可独立编译的三方库移植到OpenHarmony平台时只需修改路径即可**。
```
import("config.gni")
group("double-conversion") {
if (ohos_build_thirdparty_migrated_from_fuchisa == true) {
deps = [":make"]
}
}
if (ohos_build_thirdparty_migrated_from_fuchisa == true) {
action("make") {
script = "//third_party/double-conversion/build_thirdparty.py"
outputs = ["$root_out_dir/log_dc.txt"]
exec_path = rebase_path(rebase_path("./double-conversion/build", root_build_dir))
command = "rm * .* -rf && $CMAKE_TOOLS_PATH/cmake .. $CMAKE_FLAG $CMAKE_TOOLCHAIN_FLAG && make -j"
args = [
"--path=$exec_path",
"--command=${command}"
]
}
}
```
- **新增的config.gni用于配置该库，实现如下，其他采用CMake方式可独立编译的三方库移植到OpenHarmony时只需修改CMAKE\_FLAG的配置即可。**
```
#CMAKE_FLAG: config compile feature
CMAKE_FLAG = "-DBUILD_TESTING=ON -DCMAKE_CXX_STANDARD=11"
#toolchain：follow up-layer，depend on $ohos_build_compiler
if (ohos_build_compiler == "clang") {
CMAKE_TOOLCHAIN_FLAG = "-DOHOS_SYSROOT_PATH=${ohos_root_path}prebuilts/lite/sysroot/"
} else {
CMAKE_TOOLCHAIN_FLAG = ""
}
#CMake tools path,no need setting if this path already joined to $PATH.
CMAKE_TOOLS_PATH = "setting CMake tools path..."
```
- **新增的build\_thirdparty.py实现如下，其他采用CMake方式可独立编译的三方库移植到OpenHarmony时无需修改即可使用。**
```
import os
import sys
from subprocess import Popen
import argparse
import shlex
def cmd_exec(command):
cmd = shlex.split(command)
proc = Popen(cmd)
proc.wait()
ret_code = proc.returncode
if ret_code != 0:
raise Exception("{} failed, return code is {}".format(cmd, ret_code))
def main():
parser = argparse.ArgumentParser()
parser.add_argument('--path', help='Build path.')
parser.add_argument('--command', help='Build command.')
parser.add_argument('--enable', help='enable python.', nargs='*')
args = parser.parse_args()
if args.enable:
if args.enable[0] == 'false':
return
if args.path:
curr_dir = os.getcwd()
os.chdir(args.path)
if args.command:
if '&&' in args.command:
command = args.command.split('&&')
for data in command:
cmd_exec(data)
else:
cmd_exec(args.command)
os.chdir(curr_dir)
if __name__ == '__main__':
sys.exit(main())
```
- 在配置文件中添加开关控制该库编译，默认设为关闭
在//build/lite/ohos\_var.gni文件中添加下列配置：
```
declare_args() {
ohos_build_thirdparty_migrated_from_fuchisa = false
}
```
3. 将库加入构建配置
将该库所在目录添加到整个工程的构建配置中，以hi3518ev300为例修改文件openHarmony\\build\\lite\\product\\ ipcamera\_hi3518ev300.json，添加下列配置到“subsystem”下，如[图2所示](#fig152112412192)：
```
{
"name": "double-conversion",
"component": [
{ "name": "double-conversion", "dir": "//third_party/double-conversion:double-conversion", "features":[] }
]
},
```
**图 2** 添加位置示意图<a name="fig152112412192"></a>
![](figures/添加位置示意图.png "添加位置示意图")
4. 编译构建
- 手动单独构建：
执行下列命令
```
python build.py ipcamera_hi3518ev300 -T //third_party/double-conversion:double-conversion
```
编译成功则[build](#li15717101715249)目录下会生成静态库文件和测试用例
- 跟随工程自动构建：
修改文件//build/lite/ohos\_var.gni中的控制开关
```
ohos_build_thirdparty_migrated_from_fuchisa = true
```
执行下列命令
```
python build.py ipcamera_hi3518ev300 -b debug
```
编译成功则[build](#li15717101715249)目录下会生成静态库文件和测试用例
porting/Makefile方式组织编译的库移植.md 0 → 100644
浏览文件 @ 37cc208b
# Makefile方式组织编译的库移植<a name="ZH-CN_TOPIC_0000001064218672"></a>
- [源码获取](#section114115321416)
- [设置交叉编译](#section81263255384)
- [测试](#section1830015913391)
- [将该库编译添加到工程中](#section1898016213406)
以yxml库为例，其移植过程如下文所示
## 源码获取<a name="section114115321416"></a>
从仓库[获取yxml源码](https://github.com/getdnsapi/yxml)，其目录结构如下表：
**表 1** 源码目录结构
<a name="table16520154171813"></a>
<table><thead align="left"><tr id="row2052115419188"><th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.1"><p id="p1352111417181"><a name="p1352111417181"></a><a name="p1352111417181"></a>名称</p>
</th>
<th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.2"><p id="p2521541171812"><a name="p2521541171812"></a><a name="p2521541171812"></a>描述</p>
</th>
</tr>
</thead>
<tbody><tr id="row252164101814"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p747319438225"><a name="p747319438225"></a><a name="p747319438225"></a>yxml/bench/</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p1852214114183"><a name="p1852214114183"></a><a name="p1852214114183"></a>benchmark相关代码</p>
</td>
</tr>
<tr id="row11402205216237"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p6473134382216"><a name="p6473134382216"></a><a name="p6473134382216"></a>yxml/test/</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p2040355219237"><a name="p2040355219237"></a><a name="p2040355219237"></a>测试输入输出文件，及测试脚本</p>
</td>
</tr>
<tr id="row35220418182"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p1547384313229"><a name="p1547384313229"></a><a name="p1547384313229"></a>yxml/Makefile</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p7522041131814"><a name="p7522041131814"></a><a name="p7522041131814"></a>编译组织文件</p>
</td>
</tr>
<tr id="row17522144114180"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p6473164392210"><a name="p6473164392210"></a><a name="p6473164392210"></a>yxml/.gitattributes</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p145221541151817"><a name="p145221541151817"></a><a name="p145221541151817"></a>-</p>
</td>
</tr>
<tr id="row7522941131811"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p12473144312217"><a name="p12473144312217"></a><a name="p12473144312217"></a>yxml/.gitignore</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p95231141121810"><a name="p95231141121810"></a><a name="p95231141121810"></a>-</p>
</td>
</tr>
<tr id="row13523841161812"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p72441217182819"><a name="p72441217182819"></a><a name="p72441217182819"></a>yxml/COPYING</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p1752319414186"><a name="p1752319414186"></a><a name="p1752319414186"></a>-</p>
</td>
</tr>
<tr id="row165231641111810"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p347304312226"><a name="p347304312226"></a><a name="p347304312226"></a>yxml/yxml.c</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p4523174113188"><a name="p4523174113188"></a><a name="p4523174113188"></a>-</p>
</td>
</tr>
<tr id="row1452344110184"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p18473643152213"><a name="p18473643152213"></a><a name="p18473643152213"></a>yxml/yxml.c.in</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p1252317413187"><a name="p1252317413187"></a><a name="p1252317413187"></a>-</p>
</td>
</tr>
<tr id="row12744431142214"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p274693119222"><a name="p274693119222"></a><a name="p274693119222"></a>yxml/yxml-gen.pl</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p274753111227"><a name="p274753111227"></a><a name="p274753111227"></a>-</p>
</td>
</tr>
<tr id="row7967123412215"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p1947314314225"><a name="p1947314314225"></a><a name="p1947314314225"></a>yxml/yxml.h</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p16967203462218"><a name="p16967203462218"></a><a name="p16967203462218"></a>-</p>
</td>
</tr>
<tr id="row3988153742217"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p109891737112216"><a name="p109891737112216"></a><a name="p109891737112216"></a>yxml/yxml.md</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p10989123732213"><a name="p10989123732213"></a><a name="p10989123732213"></a>-</p>
</td>
</tr>
<tr id="row184521641102214"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p847314433221"><a name="p847314433221"></a><a name="p847314433221"></a>yxml/yxml-states</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p4453154111224"><a name="p4453154111224"></a><a name="p4453154111224"></a>-</p>
</td>
</tr>
</tbody>
</table>
## 设置交叉编译<a name="section81263255384"></a>
设置Makefile的交叉编译工具链，修改并编译该库，生成OpenHarmony平台的可执行文件，步骤如下：
1. 设置工具链
将下列clang工具链配置替换掉yxml库根目录的MakeFile（即[表1中的文件](#table16520154171813)）中的原有配置。
clang工具链配置
```
#设置交叉编译工具链，确保工具链所在路径已经添加到了PATH环境变量中
CC:=clang
AR:=llvm-ar
#cflags中必须要添加--target及--sysroot选项
CFLAGS:=-Wall -Wextra -Wno-unused-parameter -O2 -g --target=arm-liteos -march=armv7-a --sysroot=$(OHOS_ROOT_PATH)prebuilts/lite/sysroot
```
原有配置
```
CC:=gcc
AR:=ar
CFLAGS:=-Wall -Wextra -Wno-unused-parameter -O2 -g
```
2. 执行编译
linux命令行中进入yxml的源文件目录（即图1所示目录），执行下列命令：
```
make test OHOS_SYSROOT_PATH=...
```
其中OHOS\_SYSROOT\_PATH需用绝对路径指定出sysroot所在目录，以OpenHarmony为例即源码根目录prebuilts/lite/sysroot/所在的绝对路径。
3. 查看结果
步骤2操作完成后，yxml下会生成out目录，里面有静态库文件和测试用例：
**表 2** yxml编译生成目录
<a name="table3271115435618"></a>
<table><thead align="left"><tr id="row1273454185610"><th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.1"><p id="p3273154185616"><a name="p3273154185616"></a><a name="p3273154185616"></a>名称</p>
</th>
<th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.2"><p id="p18273145445612"><a name="p18273145445612"></a><a name="p18273145445612"></a>描述</p>
</th>
</tr>
</thead>
<tbody><tr id="row1627317542567"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p13273154175620"><a name="p13273154175620"></a><a name="p13273154175620"></a>openHarmony/third_party/yxml/yxml/out/lib/</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p132744541562"><a name="p132744541562"></a><a name="p132744541562"></a>编译生成的静态库的存放目录</p>
</td>
</tr>
<tr id="row112741554165612"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p17274165475611"><a name="p17274165475611"></a><a name="p17274165475611"></a>openHarmony/third_party/yxml/yxml/out/test/</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p152741354135614"><a name="p152741354135614"></a><a name="p152741354135614"></a>编译生成的测试用例及其输入输出等文件的存放目录</p>
</td>
</tr>
</tbody>
</table>
## 测试<a name="section1830015913391"></a>
yxml库测试步骤与double-conversion库基本一致，可参考[2.4节](CMake方式组织编译的库移植.md#section6686144293611)的测试过程，以下内容介绍yxml库测试用例的使用方法：
**表 3** 生成的test目录结构示意
<a name="table115941423164318"></a>
<table><thead align="left"><tr id="row1059515236433"><th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.1"><p id="p55950233437"><a name="p55950233437"></a><a name="p55950233437"></a>名称</p>
</th>
<th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.2"><p id="p4595192324313"><a name="p4595192324313"></a><a name="p4595192324313"></a>描述</p>
</th>
</tr>
</thead>
<tbody><tr id="row1759572304318"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p17595323144319"><a name="p17595323144319"></a><a name="p17595323144319"></a>openHarmony/third_party/yxml/yxml/out/test/test.sh</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p25956235437"><a name="p25956235437"></a><a name="p25956235437"></a>自动化测试脚本，由于<span id="text625264318457"><a name="text625264318457"></a><a name="text625264318457"></a>OpenHarmony</span>不支持脚本运行，因此无法使用，可参考其内容手动测试</p>
</td>
</tr>
<tr id="row155951823184312"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p659572313436"><a name="p659572313436"></a><a name="p659572313436"></a>openHarmony/third_party/yxml/yxml/out/test/test</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p7595102314319"><a name="p7595102314319"></a><a name="p7595102314319"></a>用于测试的可执行文件</p>
</td>
</tr>
<tr id="row359619238437"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p205969232436"><a name="p205969232436"></a><a name="p205969232436"></a>openHarmony/third_party/yxml/yxml/out/test/*.xml</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p559662344315"><a name="p559662344315"></a><a name="p559662344315"></a>测试输入文件</p>
</td>
</tr>
<tr id="row959613236439"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p1159652312438"><a name="p1159652312438"></a><a name="p1159652312438"></a>openHarmony/third_party/yxml/yxml/out/test/*.out</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p18596182314318"><a name="p18596182314318"></a><a name="p18596182314318"></a>期望的输出文件</p>
</td>
</tr>
</tbody>
</table>
test.sh内容如下所示：
```
#!/bin/sh
for i in *.xml; do
b=`basename $i .xml`
o=${b}.out
t=${b}.test
./test <$i >$t
if [ -n "`diff -q $o $t`" ]; then
echo "Test failed for $i:"
diff -u $o $t
exit 1
fi
done
echo "All tests completed successfully."
```
由于OpenHarmony的shell中暂不支持输入输出重定向（<和\>），所以测试时需要将输入\*.xml文件内容直接复制进shell后回车，输出内容会直接展示在shell窗口。过程如下：
下列操作假定已按照2.4节的步骤搭建OpenHarmony，挂载并进入nfs目录：
1. 执行下列命令
```
./test
```
2. 复制\*.xml内容到shell
以[test目录](#table115941423164318)下pi01.xml为例，内容如下，输入到shell并回车：
```
<?SomePI abc?><a/>
```
3. 比较shell中输出的内容与[test目录](#table115941423164318)中对应的\*.out文件是否一致
输出结果如下：
```
pistart SomePI
picontent abc
piend
elemstart a
elemend
ok
```
经比较与[test目录](#table115941423164318)下pi01.out内容一致，测试通过。
## 将该库编译添加到OpenHarmony工程中<a name="section1898016213406"></a>
yxml库添加的过程除了适配文件build.gn和config.gni有些许变化外，其他和double-conversion库完全一致，参考[2.5 节](CMake方式组织编译的库移植.md#section1651053153715)的配置过程。要修改的适配文件及添加后的目录结构如下：
- yxml库新增的BUILD.gn实现如下：
```
import("config.gni")
group("yxml") {
if (ohos_build_thirdparty_migrated_from_fuchisa == true) {
deps = [":make"]
}
}
if (ohos_build_thirdparty_migrated_from_fuchisa == true) {
action("make") {
script = "//third_party/yxml/build_thirdparty.py"
outputs = ["$target_out_dir/log_yxml.txt"]
exec_path = rebase_path(rebase_path("./yxml", root_build_dir))
command = "make clean && $MAKE_COMMAND"
args = [
"--path=$exec_path",
"--command=${command}"
]
}
}
```
- yxml库新增的config.gni配置如下：
```
TEST_ENABLE = "YES"
if (TEST_ENABLE == "YES") {
MAKE_COMMAND = "make test OHOS_SYSROOT_PATH=${ohos_root_path}prebuilts/lite/sysroot/"
} else {
MAKE_COMMAND = "make OHOS_SYSROOT_PATH=${ohos_root_path}prebuilts/lite/sysroot/"
}
```
- 添加完成后目录结构示意：
**表 4** 添加到工程后的目录结构
<a name="table13265185817173"></a>
<table><thead align="left"><tr id="row92666583171"><th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.1"><p id="p2266105816178"><a name="p2266105816178"></a><a name="p2266105816178"></a>名称</p>
</th>
<th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.2"><p id="p32661158161718"><a name="p32661158161718"></a><a name="p32661158161718"></a>描述</p>
</th>
</tr>
</thead>
<tbody><tr id="row1526655816175"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p226605811710"><a name="p226605811710"></a><a name="p226605811710"></a>openHarmony/third_party/yxml/BUILD.gn</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p1626675812177"><a name="p1626675812177"></a><a name="p1626675812177"></a>将三方库加入工程的gn适配文件</p>
</td>
</tr>
<tr id="row1726610589179"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p12266115815170"><a name="p12266115815170"></a><a name="p12266115815170"></a>openHarmony/third_party/yxml/build_thirdpaty.py</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p122661958201719"><a name="p122661958201719"></a><a name="p122661958201719"></a>GN调用shell命令脚本文件，由上面GN文件将相关命令传入，实现GN转Makefile</p>
</td>
</tr>
<tr id="row7266195891714"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p162665581170"><a name="p162665581170"></a><a name="p162665581170"></a>openHarmony/third_party/yxml/config.gni</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p626712588175"><a name="p626712588175"></a><a name="p626712588175"></a>三方库编译配置文件，可修改该文件来配置用例是否参与构建等</p>
</td>
</tr>
<tr id="row1272420109203"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><p id="p17725101052012"><a name="p17725101052012"></a><a name="p17725101052012"></a>openHarmony/third_party/yxml/yxml/</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><p id="p87252109205"><a name="p87252109205"></a><a name="p87252109205"></a>要移植的三方库目录</p>
</td>
</tr>
</tbody>
</table>
porting/Readme-CN.md 0 → 100644
浏览文件 @ 37cc208b
# 三方库移植指南
- [概述](概述.md)
- [CMake方式组织编译的库移植](CMake方式组织编译的库移植.md)
- [Makefile方式组织编译的库移植](Makefile方式组织编译的库移植.md)
porting/概述.md 0 → 100644
浏览文件 @ 37cc208b
# 概述<a name="ZH-CN_TOPIC_0000001064570046"></a>
本文为OpenHarmony开发者提供一些组织编译形式比较常见（CMakeLists、Makefile）的三方库的移植指南，该指南当前仅适用于Hi3516DV300和Hi3518EV300两个平台，文中着重介绍各编译组织方式下工具链的设置方法以及如何将该库的编译添加到OpenHarmony整个工程的构建中。
quick-start/Hi3516常见问题.md 0 → 100644
浏览文件 @ 37cc208b
# Hi3516常见问题<a name="ZH-CN_TOPIC_0000001053466255"></a>
- [烧写选择串口后提示失败](#section627268185113)
- [Windows电脑与单板网络连接失败](#section195391036568)
- [烧写失败](#section571164016565)
- [编译构建过程中，提示找不到“python”](#section1039835245619)
- [串口无回显](#section14871149155911)
## 烧写选择串口后提示失败<a name="section627268185113"></a>
- **现象描述**
点击烧写并选择串口后，出现Error: Opening COMxx: Access denied。
**图 1** 打开串口失败图<a name="fig066333283916"></a>
![](figures/打开串口失败图.png "打开串口失败图")
- **可能原因**
串口已经被占用。
- **解决办法**
1. 按图依次选择下拉框，查找带有serial-xx的终端
**图 2** 查找是否存在占用串口的终端<a name="fig165994164420"></a>
![](figures/查找是否存在占用串口的终端.png "查找是否存在占用串口的终端")
2. 点击标号中的垃圾桶图标，关闭串口。
**图 3** 关闭串口终端<a name="fig7911282453"></a>
![](figures/关闭串口终端.png "关闭串口终端")
3. 重新点击烧写，选择串口并开始烧写程序
**图 4** 重新启动烧写任务<a name="fig1138624316485"></a>
![](figures/changjian1.png)
## Windows电脑与单板网络连接失败<a name="section195391036568"></a>
- **现象描述**
点击烧写并选择串口后，无法获取文件。
**图 5** 网络不通，单板无法获取文件图<a name="fig5218920223"></a>
![](figures/网络不通-单板无法获取文件图.png "网络不通-单板无法获取文件图")
- **可能原因**
单板网络与Windows电脑不联通。
Windows电脑防火墙未允许Visual Studio Code联网。
- **解决方法**
1. 检查网线是否连接。
2. 点击Windows防火墙。
**图 6** 网络防火墙设置图<a name="fig62141417794"></a>
![](figures/网络防火墙设置图.png "网络防火墙设置图")
3. 点击“允许应用通过防火墙”。
**图 7** 防火墙和网络保护界面图<a name="fig20703151111116"></a>
![](figures/防火墙和网络保护界面图.png "防火墙和网络保护界面图")
4. 查找Visual Studio Code应用。
**图 8** 查找Visual Studio Code应用图<a name="fig462316612165"></a>
![](figures/查找Visual-Studio-Code应用图.png "查找Visual-Studio-Code应用图")
5. 勾选Visual Studio Code的专用和公用网络的访问权限。
**图 9** 允许Visual Studio Code应用访问网络<a name="fig132725269184"></a>
![](figures/允许Visual-Studio-Code应用访问网络.png "允许Visual-Studio-Code应用访问网络")
## 烧写失败<a name="section571164016565"></a>
- **现象描述**
点击烧写并选择串口后，出现无法烧写的情况。
- **可能原因**
安装IDE插件DevEco后未重启。
- **解决方法**
重启IDE。
## 编译构建过程中，提示找不到“python”<a name="section1039835245619"></a>
- **现象描述**
![](figures/zh-cn_image_0000001055035538.png)
- **可能原因1**
没有装python。
- **解决办法**
请按照[安装Python环境](Hi3516搭建环境.md#section126442079459)安装python。
- **可能原因2**
![](figures/zh-cn_image_0000001054475589.png)
- **解决办法**
usr/bin目录下没有python软链接，请运行以下命令：
```
# cd /usr/bin/
# which python3
# ln -s /usr/local/bin/python3 python
# python --version
```
例：
![](figures/zh-cn_image_0000001054875562.png)
## 串口无回显<a name="section14871149155911"></a>
- **现象描述**
串口显示已连接，重启单板后，回车无任何回显。
- **可能原因1**
串口连接错误。
- **解决办法**
修改串口号。
请查看设备管理器，确认连接单板的串口与终端中连接串口是否一致，若不一致，请按镜像运行内[步骤1](开发Hi3516第一个应用程序示例.md#l177d08e77bd441d38991da9be4572a74)修改串口号。
- **可能原因2**
单板U-boot被损坏。
- **解决办法**
烧写U-boot。
若上述步骤依旧无法连接串口，可能由于单板U-boot损坏，按下述步骤烧写U-boot。
1. 获取引导文件U-boot。
>![](public_sys-resources/icon-notice.gif) **须知：**
>单板的U-boot文件请在开源包中获取：
>Hi3516DV300：vendor\\hisi\\hi35xx\\hi3516dv300\\uboot\\out\\boot\\u-boot-hi3516dv300.bin
>Hi3518EV300：vendor\\hisi\\hi35xx\\hi3518ev300\\uboot\\out\\boot\\u-boot-hi3518ev300.bin
2. 根据USB烧写步骤烧写U-boot文件。
按照[Hi3516系列USB烧写步骤](https://device.harmonyos.com/cn/docs/ide/user-guides/hi3516_upload-0000001052148681)/[Hi3518系列USB烧写步骤](https://device.harmonyos.com/cn/docs/ide/user-guides/hi3518_upload-0000001057313128)中描述的USB烧写方法，选择对应单板的U-boot文件进行烧写。
3. 烧写完成后，登录串口如下图所示。
**图 10** U-boot烧写完成串口显示图<a name="zh-cn_topic_0000001053466255_fig155914681910"></a>
![](figures/U-boot烧写完成串口显示图.png "U-boot烧写完成串口显示图")
quick-start/Hi3516开发板.md
浏览文件 @ 37cc208b
...@@ -2,12 +2,12 @@ ...@@ -2,12 +2,12 @@
- **[Hi3516开发板介绍](Hi3516开发板介绍.md)** - **[Hi3516开发板介绍](Hi3516开发板介绍.md)**
- **[搭建环境](搭建环境-0.md)** - **[Hi3516搭建环境](Hi3516搭建环境.md)**
- **[开发Hi3516第一个应用程序示例](开发Hi3516第一个应用程序示例.md)** - **[开发Hi3516第一个应用程序示例](开发Hi3516第一个应用程序示例.md)**
- **[开发Hi3516第一个驱动程序示例](开发Hi3516第一个驱动程序示例.md)** - **[开发Hi3516第一个驱动程序示例](开发Hi3516第一个驱动程序示例.md)**
- **[常见问题](常见问题-1.md)** - **[Hi3516常见问题](Hi3516常见问题.md)**
quick-start/Hi3516开发板介绍.md
浏览文件 @ 37cc208b
...@@ -5,7 +5,7 @@ ...@@ -5,7 +5,7 @@
## 开发板简介<a name="section047719215429"></a> ## 开发板简介<a name="section047719215429"></a>
Hi3516DV300作为新一代行业专用Smart HD IP摄像机SOC，集成新一代ISP、业界最新的H.265视频压缩编码器，同时集成高性能NNIE引擎，使得Hi3516DV300在低码率、高画质、智能处理和分析、低功耗等方面引领行业水平。 Hi3516DV300作为新一代行业专用Smart HD IP摄像机SOC，集成新一代ISP、H.265视频压缩编码器，同时集成高性能NNIE引擎，使得Hi3516DV300在低码率、高画质、智能处理和分析、低功耗等方面引领行业水平。
**图 1** Hi3516单板正面外观图<a name="fig11402183715219"></a> **图 1** Hi3516单板正面外观图<a name="fig11402183715219"></a>
......
quick-start/Hi3516搭建环境.md 0 → 100644
浏览文件 @ 37cc208b
# Hi3516搭建环境<a name="ZH-CN_TOPIC_0000001054501981"></a>
- [环境要求](#section179175261196)
- [硬件要求](#section5840424125014)
- [软件系统要求](#section965634210501)
- [Linux构建工具要求](#section7786130185118)
- [Windows开发工具要求](#section939920316515)
- [安装Linux编译环境（方法一：Docker方式）](#section748632362420)
- [安装Linux编译环境（方法二：安装包方式）](#section182916865219)
- [连接Linux服务器](#section14371161220386)
- [将Linux shell改为bash](#section77681442174413)
- [安装Python环境](#section126442079459)
- [安装文件打包工具](#section8352161417450)
- [安装gn](#section16725103716357)
- [安装ninja](#section18469114293513)
- [安装LLVM](#section18344103584516)
- [安装hc-gen](#section2075110583451)
- [安装Java 虚拟机环境](#section101989994613)
- [安装hap打包工具](#section14507022124614)
- [安装hap签名工具](#section15236123816464)
- [安装Windows开发环境](#section1995840162515)
## 环境要求<a name="section179175261196"></a>
### 硬件要求<a name="section5840424125014"></a>
- Linux服务器
- Windows工作台（主机电脑）
- Hi3516DV300 IoT Camera开发板
- USB转串口线、网线（Windows工作台通过USB转串口线、网线与Hi3516DV300 开发板连接）
各硬件连接关系如下图所示。
**图 1** 硬件连线图<a name="fig19527104710591"></a>
![](figures/矩形备份-292.png)
### 软件系统要求<a name="section965634210501"></a>
**表 1** Hi3516DV300开发板开发平台要求
<a name="tc50585b2b3fe43f7835154789b0e25af"></a>
<table><thead align="left"><tr id="ra9df6acc53154b819d5f86d885d994de"><th class="cellrowborder" valign="top" width="8.53%" id="mcps1.2.5.1.1"><p id="a999bb40532eb4f74a7383e1e776bb94a"><a name="a999bb40532eb4f74a7383e1e776bb94a"></a><a name="a999bb40532eb4f74a7383e1e776bb94a"></a>硬件</p>
</th>
<th class="cellrowborder" valign="top" width="11.66%" id="mcps1.2.5.1.2"><p id="ae63cf791fbe348d3b907d20fc4927df8"><a name="ae63cf791fbe348d3b907d20fc4927df8"></a><a name="ae63cf791fbe348d3b907d20fc4927df8"></a>软件</p>
</th>
<th class="cellrowborder" valign="top" width="66%" id="mcps1.2.5.1.3"><p id="a54c4c80c43c84cb187342865a1d2b51e"><a name="a54c4c80c43c84cb187342865a1d2b51e"></a><a name="a54c4c80c43c84cb187342865a1d2b51e"></a>描述</p>
</th>
<th class="cellrowborder" valign="top" width="13.81%" id="mcps1.2.5.1.4"><p id="a11e8d096fb204378a63d8805cd6d1f88"><a name="a11e8d096fb204378a63d8805cd6d1f88"></a><a name="a11e8d096fb204378a63d8805cd6d1f88"></a>备注</p>
</th>
</tr>
</thead>
<tbody><tr id="row117591159175819"><td class="cellrowborder" valign="top" width="8.53%" headers="mcps1.2.5.1.1 "><p id="a0c1290183f2548898dbfc516a4db2c4b"><a name="a0c1290183f2548898dbfc516a4db2c4b"></a><a name="a0c1290183f2548898dbfc516a4db2c4b"></a>Linux编译服务器</p>
</td>
<td class="cellrowborder" valign="top" width="11.66%" headers="mcps1.2.5.1.2 "><p id="a687efa8001f140488dc1da9a2ee8f6d1"><a name="a687efa8001f140488dc1da9a2ee8f6d1"></a><a name="a687efa8001f140488dc1da9a2ee8f6d1"></a>操作系统</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.2.5.1.3 "><p id="ace724e00c9094eccb8c600d6ad426ed8"><a name="ace724e00c9094eccb8c600d6ad426ed8"></a><a name="ace724e00c9094eccb8c600d6ad426ed8"></a>Ubuntu16.04及以上64位系统版本，Shell使用bash。</p>
<div class="note" id="note124531828194919"><a name="note124531828194919"></a><a name="note124531828194919"></a><span class="notetitle"> 说明： </span><div class="notebody"><p id="p1244243142810"><a name="p1244243142810"></a><a name="p1244243142810"></a>通常系统默认安装samba、vim等常用软件，需要做适当适配以支持linux文件共享。</p>
</div></div>
</td>
<td class="cellrowborder" rowspan="3" valign="top" width="13.81%" headers="mcps1.2.5.1.4 "><p id="a4d0e2c8444484554ab58949ce322be32"><a name="a4d0e2c8444484554ab58949ce322be32"></a><a name="a4d0e2c8444484554ab58949ce322be32"></a>开发人员可以在Windows工作台中进行程序开发，或者远程登录到Linux服务器进行程序开发。</p>
</td>
</tr>
<tr id="r85c4bf56ff3244e48db9d2f5b622b340"><td class="cellrowborder" rowspan="2" valign="top" headers="mcps1.2.5.1.1 "><p id="a8e99fd0262cb4489b70cf86c2144c294"><a name="a8e99fd0262cb4489b70cf86c2144c294"></a><a name="a8e99fd0262cb4489b70cf86c2144c294"></a>Windows工作台</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.5.1.2 "><p id="a44d6164ce2e9421f9ade362f600c2815"><a name="a44d6164ce2e9421f9ade362f600c2815"></a><a name="a44d6164ce2e9421f9ade362f600c2815"></a>操作系统</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.5.1.3 "><p id="a1c17349e334a44ada5c5f150457fe17d"><a name="a1c17349e334a44ada5c5f150457fe17d"></a><a name="a1c17349e334a44ada5c5f150457fe17d"></a>Windows XP/Windows7/Windows10</p>
</td>
</tr>
<tr id="r2c85a3b244764425b0d08fa20503da12"><td class="cellrowborder" valign="top" headers="mcps1.2.5.1.1 "><p id="a70beb9d769e340018c9c39c7d44cf424"><a name="a70beb9d769e340018c9c39c7d44cf424"></a><a name="a70beb9d769e340018c9c39c7d44cf424"></a>USB转串口驱动</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.5.1.2 "><p id="p9790183418466"><a name="p9790183418466"></a><a name="p9790183418466"></a><a href="http://www.hihope.org/download/AllDocuments" target="_blank" rel="noopener noreferrer">http://www.hihope.org/download/AllDocuments</a></p>
<p id="p37901134184614"><a name="p37901134184614"></a><a name="p37901134184614"></a>驱动软件名：USB-to-Serial Comm Port.exe</p>
</td>
</tr>
</tbody>
</table>
### Linux构建工具要求<a name="section7786130185118"></a>
Linux服务器通用环境配置需要的工具及其获取途径如下表所示。
**表 2** Linux服务器开发工具及获取途径
<a name="table6299192712513"></a>
<table><thead align="left"><tr id="row122993276512"><th class="cellrowborder" valign="top" width="13.081308130813083%" id="mcps1.2.4.1.1"><p id="p1829914271858"><a name="p1829914271858"></a><a name="p1829914271858"></a>开发工具</p>
</th>
<th class="cellrowborder" valign="top" width="19.921992199219922%" id="mcps1.2.4.1.2"><p id="p429918274517"><a name="p429918274517"></a><a name="p429918274517"></a>用途</p>
</th>
<th class="cellrowborder" valign="top" width="66.996699669967%" id="mcps1.2.4.1.3"><p id="p12997271757"><a name="p12997271757"></a><a name="p12997271757"></a>获取途径</p>
</th>
</tr>
</thead>
<tbody><tr id="row430016273514"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p330015271158"><a name="p330015271158"></a><a name="p330015271158"></a>Python3.7+</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p43003270510"><a name="p43003270510"></a><a name="p43003270510"></a>执行编译脚本工具</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p18254155164617"><a name="p18254155164617"></a><a name="p18254155164617"></a><a href="https://www.python.org/ftp/python/3.8.5/Python-3.8.5.tgz" target="_blank" rel="noopener noreferrer">https://www.python.org/ftp/python/3.8.5/Python-3.8.5.tgz</a></p>
</td>
</tr>
<tr id="row42668197206"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p426711912014"><a name="p426711912014"></a><a name="p426711912014"></a>bash</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p14267131962014"><a name="p14267131962014"></a><a name="p14267131962014"></a>执行命令行工具</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p14267101962014"><a name="p14267101962014"></a><a name="p14267101962014"></a>通过互联网获取</p>
</td>
</tr>
<tr id="row1711946154018"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p15588165684216"><a name="p15588165684216"></a><a name="p15588165684216"></a>gn</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p4588135634213"><a name="p4588135634213"></a><a name="p4588135634213"></a>产生ninja编译脚本</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p10572194318318"><a name="p10572194318318"></a><a name="p10572194318318"></a><a href="https://repo.huaweicloud.com/harmonyos/compiler/gn/1523/linux/gn.1523.tar" target="_blank" rel="noopener noreferrer">https://repo.huaweicloud.com/harmonyos/compiler/gn/1523/linux/gn.1523.tar</a></p>
</td>
</tr>
<tr id="row16990164213404"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p1858825613428"><a name="p1858825613428"></a><a name="p1858825613428"></a>ninja</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p15844174611816"><a name="p15844174611816"></a><a name="p15844174611816"></a>执行ninja编译脚本</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p1923373393515"><a name="p1923373393515"></a><a name="p1923373393515"></a><a href="https://repo.huaweicloud.com/harmonyos/compiler/ninja/1.9.0/linux/ninja.1.9.0.tar" target="_blank" rel="noopener noreferrer">https://repo.huaweicloud.com/harmonyos/compiler/ninja/1.9.0/linux/ninja.1.9.0.tar</a></p>
</td>
</tr>
<tr id="row192161027104010"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p15217227174016"><a name="p15217227174016"></a><a name="p15217227174016"></a>LLVM</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p122171727184019"><a name="p122171727184019"></a><a name="p122171727184019"></a>编译工具链</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p0191147134415"><a name="p0191147134415"></a><a name="p0191147134415"></a><a href="https://repo.huaweicloud.com/harmonyos/compiler/clang/9.0.0-34042/linux/llvm-linux-9.0.0-34042.tar" target="_blank" rel="noopener noreferrer">https://repo.huaweicloud.com/harmonyos/compiler/clang/9.0.0-34042/linux/llvm-linux-9.0.0-34042.tar</a></p>
</td>
</tr>
<tr id="row18516509507"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p14521650135017"><a name="p14521650135017"></a><a name="p14521650135017"></a>hc-gen</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p125255010501"><a name="p125255010501"></a><a name="p125255010501"></a>驱动配置编译工具</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p145061517114519"><a name="p145061517114519"></a><a name="p145061517114519"></a><a href="https://repo.huaweicloud.com/harmonyos/compiler/hc-gen/0.65/linux/hc-gen-0.65-linux.tar" target="_blank" rel="noopener noreferrer">https://repo.huaweicloud.com/harmonyos/compiler/hc-gen/0.65/linux/hc-gen-0.65-linux.tar</a></p>
</td>
</tr>
<tr id="row105773499422"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p15300102717517"><a name="p15300102717517"></a><a name="p15300102717517"></a>IPOP、PuTTY或其他超级终端</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p109418530386"><a name="p109418530386"></a><a name="p109418530386"></a>连接Linux服务器工具（任选其一）</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p7312122523813"><a name="p7312122523813"></a><a name="p7312122523813"></a>通过互联网获取（如：<a href="https://www.putty.org/" target="_blank" rel="noopener noreferrer">https://www.putty.org/</a>）</p>
</td>
</tr>
<tr id="row29204072315"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p5921190162318"><a name="p5921190162318"></a><a name="p5921190162318"></a>Java 虚拟机环境</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p17921110152311"><a name="p17921110152311"></a><a name="p17921110152311"></a>编译、调试和运行Java程序</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p16921805237"><a name="p16921805237"></a><a name="p16921805237"></a>通过apt-get install安装</p>
</td>
</tr>
<tr id="row1176514438124"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p87662439123"><a name="p87662439123"></a><a name="p87662439123"></a>hmos_app_packing_tool</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p18766343141214"><a name="p18766343141214"></a><a name="p18766343141214"></a>hap打包工具</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p117668435124"><a name="p117668435124"></a><a name="p117668435124"></a><a href="https://repo.huaweicloud.com/harmonyos/develop_tools/hmos_app_packing_tool.jar" target="_blank" rel="noopener noreferrer">https://repo.huaweicloud.com/harmonyos/develop_tools/hmos_app_packing_tool.jar</a></p>
</td>
</tr>
<tr id="row576920166454"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p643319185456"><a name="p643319185456"></a><a name="p643319185456"></a>hapsigntool</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p19433131844519"><a name="p19433131844519"></a><a name="p19433131844519"></a>hap签名工具</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p1785173474910"><a name="p1785173474910"></a><a name="p1785173474910"></a><a href="https://repo.huaweicloud.com/harmonyos/develop_tools/hapsigntoolv2.jar" target="_blank" rel="noopener noreferrer">https://repo.huaweicloud.com/harmonyos/develop_tools/hapsigntoolv2.jar</a></p>
</td>
</tr>
</tbody>
</table>
### Windows开发工具要求<a name="section939920316515"></a>
**表 3** Windows工作台开发工具及获取途径
<a name="table1313323311274"></a>
<table><thead align="left"><tr id="row3133133312711"><th class="cellrowborder" valign="top" width="16.371637163716375%" id="mcps1.2.4.1.1"><p id="p16132203372716"><a name="p16132203372716"></a><a name="p16132203372716"></a>开发工具</p>
</th>
<th class="cellrowborder" valign="top" width="50.29502950295029%" id="mcps1.2.4.1.2"><p id="p1413219339278"><a name="p1413219339278"></a><a name="p1413219339278"></a>用途</p>
</th>
<th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.2.4.1.3"><p id="p17133183312711"><a name="p17133183312711"></a><a name="p17133183312711"></a>获取途径</p>
</th>
</tr>
</thead>
<tbody><tr id="row13697410143219"><td class="cellrowborder" valign="top" width="16.371637163716375%" headers="mcps1.2.4.1.1 "><p id="p163612016916"><a name="p163612016916"></a><a name="p163612016916"></a>Visual Studio Code</p>
</td>
<td class="cellrowborder" valign="top" width="50.29502950295029%" headers="mcps1.2.4.1.2 "><p id="p1563690791"><a name="p1563690791"></a><a name="p1563690791"></a>代码编辑工具</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="p146361701097"><a name="p146361701097"></a><a name="p146361701097"></a><a href="https://code.visualstudio.com/" target="_blank" rel="noopener noreferrer">https://code.visualstudio.com/</a></p>
</td>
</tr>
<tr id="row12133123315277"><td class="cellrowborder" valign="top" width="16.371637163716375%" headers="mcps1.2.4.1.1 "><p id="p613393317271"><a name="p613393317271"></a><a name="p613393317271"></a>HUAWEI DevEco Device Tool</p>
</td>
<td class="cellrowborder" valign="top" width="50.29502950295029%" headers="mcps1.2.4.1.2 "><p id="p10133193310276"><a name="p10133193310276"></a><a name="p10133193310276"></a>IDE开发工具，Visual Studio Code插件，支持代码编译、烧录和调试等功能，支持C/C++语言</p>
<div class="note" id="note7133193392718"><a name="note7133193392718"></a><a name="note7133193392718"></a><span class="notetitle"> 说明： </span><div class="notebody"><p id="p1133183310277"><a name="p1133183310277"></a><a name="p1133183310277"></a>HUAWEI DevEco Device Tool是<span id="text4133533192719"><a name="text4133533192719"></a><a name="text4133533192719"></a>OpenHarmony</span>面向智能设备开发者提供的一站式集成开发环境，支持<span id="text4133933162719"><a name="text4133933162719"></a><a name="text4133933162719"></a>OpenHarmony</span>的组件按需定制，支持代码编辑、编译、烧录、调试等功能，支持C/C++语言，以插件的形式部署在Visual Studio Code上。</p>
</div></div>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="p16788135433519"><a name="p16788135433519"></a><a name="p16788135433519"></a><a href="https://device.harmonyos.com/cn/ide" target="_blank" rel="noopener noreferrer">https://device.harmonyos.com/cn/ide</a></p>
</td>
</tr>
</tbody>
</table>
## 安装Linux编译环境（方法一：Docker方式）<a name="section748632362420"></a>
Linux编译环境可以通过Docker方式快速安装，具体请参见[Docker方式获取编译环境](../get-code/获取工具.md)的“搭建Docker环境”。
## 安装Linux编译环境（方法二：安装包方式）<a name="section182916865219"></a>
>![](public_sys-resources/icon-notice.gif) **须知：**
>- 如果后续通过“HPM组件方式”或“HPM包管理器命令行工具方式”获取源码，不需要安装gn、ninja、LLVM、hc-gen编译工具。
>- （推荐）如果后续通过“镜像站点方式”或“代码仓库方式”获取源码，需要安装gn、ninja、LLVM、hc-gen编译工具。安装gn、ninja、LLVM、hc-gen编译工具时，请确保编译工具的环境变量路径唯一。
### 连接Linux服务器<a name="section14371161220386"></a>
使用Windows远程登录Linux，以PUTTY工具为例：
1. 打开[PuTTY工具](https://www.putty.org/)，输入Linux服务器IP地址，后点击“open”，打开连接。
**图 2** PuTTY界面示例图<a name="zh-cn_topic_0000001054781998_f825e6d7569cc487db9b744e454c7157a"></a>
![](figures/PuTTY界面示例图.png "PuTTY界面示例图")
2. 弹框告警选择“是\(Y\)”。
3. 弹出界面中输入帐号并按回车键，继续输入密码并回车键。
**图 3** 登录界面图<a name="zh-cn_topic_0000001054781998_fe1428afffbdd45f9b4a39497691ff5ff"></a>
![](figures/登录界面图.png "登录界面图")
4. 登录成功。
**图 4** 登录成功界面<a name="zh-cn_topic_0000001054781998_f11bea69483e14bd39fef4a10b1ed1a3a"></a>
![](figures/登录成功界面.png "登录成功界面")
### 将Linux shell改为bash<a name="section77681442174413"></a>
查看shell是否为bash，在终端运行如下命令
```
ls -l /bin/sh
```
如果显示为“/bin/sh -\> bash”则为正常，否则请按以下方式修改：
**方法一**：在终端运行如下命令，然后选择 no。
```
sudo dpkg-reconfigure dash
```
**方法二**：先删除sh，再创建软链接。
```
sudo rm -rf /bin/sh
sudo ln -s /bin/bash /bin/sh
```
### 安装Python环境<a name="section126442079459"></a>
1. 打开Linux编译服务器终端。
2. 输入如下命令，查看python版本号，需使用python3.7以上版本。
```
python3 --version
```
如果低于python3.7版本，不建议直接升级，请按照如下步骤重新安装。以python3.8为例，按照以下步骤安装python。
1. 运行如下命令，查看Ubuntu版本：
```
cat /etc/issue
```
1. 根据Ubuntu不同版本，安装python。
- 如果Ubuntu 版本为18+，运行如下命令。
```
sudo apt-get install python3.8
```
- 如果Ubuntu版本为16，请以下载包的方式安装python。
1. python安装环境依赖\(gcc, g++, make, zlib, libffi\)请运行如下命令：
```
sudo apt-get install gcc && sudo apt-get install g++ && sudo apt-get install make && sudo apt-get install zlib* && sudo apt-get install libffi-dev
```
1. 获取[python3.8.5安装包](https://www.python.org/ftp/python/3.8.5/Python-3.8.5.tgz)，将其放至linux服务器中，运行如下命令 ：
```
tar -xvzf Python-3.8.5.tgz && cd Python-3.8.5 && sudo ./configure && sudo make && sudo make install
```
3. 确定python安装好后，将python路径链接到"/usr/bin/python"。
输入如下命令，查看python是否正确软链接到python3.8。
```
python --version
```
如果回显不是python 3.8.5，则运行如下命令，查看python3.8所在目录：
```
which python3.8
```
将以下命令中的 "python3.8-path" 替换为 "which python3.8" 命令执行后的回显路径
```
cd /usr/bin && sudo rm python && sudo rm python3 && sudo ln -s python3.8-path python && sudo ln -s python3.8-path python3 && python3 --version && python --version
```
4. 安装并升级Python包管理工具（pip3），任选如下一种方式。
- **命令行方式：**
```
sudo apt-get install python3-setuptools python3-pip -y
sudo pip3 install --upgrade pip
```
- **安装包方式：**
```
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
python get-pip.py
```
5. 运行如下命令，安装python模块setuptools。
```
pip3 install setuptools
```
6. 安装GUI menuconfig工具（Kconfiglib），建议安装Kconfiglib 13.2.0+版本，任选如下一种方式。
- **命令行方式：**
```
sudo pip3 install kconfiglib
```
- **安装包方式：**
1. 下载.whl文件（例如：kconfiglib-13.2.0-py2.py3-none-any.whl）。
下载路径：“[https://pypi.org/project/kconfiglib\#files](https://pypi.org/project/kconfiglib#files)”
1. 运行如下命令，安装.whl文件。
```
sudo pip3 install kconfiglib-13.2.0-py2.py3-none-any.whl
```
### 安装文件打包工具<a name="section8352161417450"></a>
1. 打开Linux编译服务器终端。
2. 运行如下命令，安装dosfstools。
```
sudo apt-get install dosfstools
```
3. 运行如下命令，安装mtools。
```
sudo apt-get install mtools
```
4. 运行如下命令，安装mtd-utils。
```
sudo apt-get install mtd-utils
```
### 安装gn<a name="section16725103716357"></a>
1. 打开Linux编译服务器终端。
2. [下载gn工具](https://repo.huaweicloud.com/harmonyos/compiler/gn/1523/linux/gn.1523.tar)。
3. 解压gn安装包至\~/gn路径下。
```
tar -xvf gn.1523.tar -C ~/
```
4. 设置环境变量。
```
vim ~/.bashrc
```
将以下命令拷贝到.bashrc文件的最后一行，保存并退出。
```
export PATH=~/gn:$PATH
```
5. 生效环境变量。
```
source ~/.bashrc
```
### 安装ninja<a name="section18469114293513"></a>
1. 打开Linux编译服务器终端。
2. [下载ninja工具](https://repo.huaweicloud.com/harmonyos/compiler/ninja/1.9.0/linux/ninja.1.9.0.tar)。
3. 解压ninja安装包至\~/ninja路径下。
```
tar -xvf ninja.1.9.0.tar -C ~/
```
4. 设置环境变量。
```
vim ~/.bashrc
```
将以下命令拷贝到.bashrc文件的最后一行，保存并退出。
```
export PATH=~/ninja:$PATH
```
5. 生效环境变量。
```
source ~/.bashrc
```
### 安装LLVM<a name="section18344103584516"></a>
1. 打开Linux编译服务器终端。
2. [下载LLVM工具](https://repo.huaweicloud.com/harmonyos/compiler/clang/9.0.0-34042/linux/llvm-linux-9.0.0-34042.tar)。
3. 解压LLVM安装包至\~/llvm路径下。
```
tar -xvf llvm-linux-9.0.0-34042.tar -C ~/
```
4. 设置环境变量。
```
vim ~/.bashrc
```
将以下命令拷贝到.bashrc文件的最后一行，保存并退出。
```
export PATH=~/llvm/bin:$PATH
```
5. 生效环境变量。
```
source ~/.bashrc
```
### 安装hc-gen<a name="section2075110583451"></a>
1. 打开Linux编译服务器终端。
2. [下载hc-gen工具](https://repo.huaweicloud.com/harmonyos/compiler/hc-gen/0.65/linux/hc-gen-0.65-linux.tar)。
3. 解压hc-gen安装包到Linux服务器\~/hc-gen路径下。
```
tar -xvf hc-gen-0.65-linux.tar -C ~/
```
4. 设置环境变量。
```
vim ~/.bashrc
```
将以下命令拷贝到.bashrc文件的最后一行，保存并退出。
```
export PATH=~/hc-gen:$PATH
```
5. 生效环境变量。
```
source ~/.bashrc
```
### 安装Java 虚拟机环境<a name="section101989994613"></a>
1. 打开Linux编译服务器终端。
2. 安装Java运行时环境（JRE）。
```
sudo apt-get install default-jre
```
3. 安装Java sdk开发工具包。
```
sudo apt-get install default-jdk
```
### 安装hap打包工具<a name="section14507022124614"></a>
编译OpenHarmony时，该工具用于打包系统应用。安装步骤如下：
1. 打开Linux编译服务器终端。
2. 打包工具使用Java开发，使用前请先安装Java 虚拟机环境。
3. [下载hap打包工具](https://repo.huaweicloud.com/harmonyos/develop_tools/hmos_app_packing_tool.jar)。
4. 拷贝hmos\_app\_packing\_tool.jar到Linux服务器\~/developtools路径下。
5. 设置环境变量。
```
vim ~/.bashrc
```
将以下命令拷贝到.bashrc文件的最后一行，保存并退出。
```
export PATH=~/developtools:$PATH
```
6. 生效环境变量。
```
source ~/.bashrc
```
### 安装hap签名工具<a name="section15236123816464"></a>
编译OpenHarmony时，在系统应用打包完成后，编译脚本会调用hap签名工具对其签名。安装步骤如下：
1. 打开Linux编译服务器终端。
2. [下载hap签名工具](https://repo.huaweicloud.com/harmonyos/develop_tools/hapsigntoolv2.jar)。
3. 拷贝hapsigntoolv2.jar到Linux服务器\~/developtools路径下。
4. 设置环境变量。
```
vim ~/.bashrc
```
将以下命令拷贝到.bashrc文件的最后一行，保存并退出。
```
export PATH=~/developtools:$PATH
```
5. 生效环境变量。
```
source ~/.bashrc
```
## 安装Windows开发环境<a name="section1995840162515"></a>
OpenHarmony IDE工具DevEco Device Tool集成了终端工具的能力，工具的安装步骤请参考[DevEco Device Tool环境搭建](https://device.harmonyos.com/cn/docs/ide/user-guides/tool_install-0000001050164976)、[导入和配置工程](https://device.harmonyos.com/cn/docs/ide/user-guides/import_project-0000001050164980)完成。
quick-start/Hi3518常见问题.md 0 → 100644
浏览文件 @ 37cc208b
# Hi3518常见问题<a name="ZH-CN_TOPIC_0000001058898620"></a>
- [烧写选择串口后提示失败](#section1498892119619)
- [Windows电脑与单板网络连接失败](#section8512971816)
- [烧写失败](#section1767804111198)
- [编译构建过程中，提示找不到“python”](#zh-cn_topic_0000001053466255_section1039835245619)
- [串口无回显](#zh-cn_topic_0000001053466255_section14871149155911)
## 烧写选择串口后提示失败<a name="section1498892119619"></a>
- **现象描述**
点击烧写并选择串口后，出现Error: Opening COMxx: Access denied。
**图 1** 打开串口失败图<a name="zh-cn_topic_0000001053466255_fig066333283916"></a>
![](figures/打开串口失败图.png "打开串口失败图")
- **可能原因**
串口已经被占用。
- **解决办法**
1. 按图依次选择下拉框，查找带有serial-xx的终端
**图 2** 查找是否存在占用串口的终端<a name="zh-cn_topic_0000001053466255_fig165994164420"></a>
![](figures/查找是否存在占用串口的终端.png "查找是否存在占用串口的终端")
2. 点击标号中的垃圾桶图标，关闭串口。
**图 3** 关闭串口终端<a name="zh-cn_topic_0000001053466255_fig7911282453"></a>
![](figures/关闭串口终端.png "关闭串口终端")
3. 重新点击烧写，选择串口并开始烧写程序
**图 4** 重新启动烧写任务<a name="zh-cn_topic_0000001053466255_fig1138624316485"></a>
![](figures/changjian1.png)
## Windows电脑与单板网络连接失败<a name="section8512971816"></a>
- **现象描述**
点击烧写并选择串口后，无法获取文件。
**图 5** 网络不通，单板无法获取文件图<a name="zh-cn_topic_0000001053466255_fig5218920223"></a>
![](figures/网络不通-单板无法获取文件图.png "网络不通-单板无法获取文件图")
- **可能原因**
单板网络与Windows电脑不联通。
Windows电脑防火墙未允许Visual Studio Code联网。
- **解决方法**
1. 检查网线是否连接。
2. 点击Windows防火墙。
**图 6** 网络防火墙设置图<a name="zh-cn_topic_0000001053466255_fig62141417794"></a>
![](figures/网络防火墙设置图.png "网络防火墙设置图")
3. 点击“允许应用通过防火墙”。
**图 7** 防火墙和网络保护界面图<a name="zh-cn_topic_0000001053466255_fig20703151111116"></a>
![](figures/防火墙和网络保护界面图.png "防火墙和网络保护界面图")
4. 查找Visual Studio Code应用。
**图 8** 查找Visual Studio Code应用图<a name="zh-cn_topic_0000001053466255_fig462316612165"></a>
![](figures/查找Visual-Studio-Code应用图.png "查找Visual-Studio-Code应用图")
5. 勾选Visual Studio Code的专用和公用网络的访问权限。
**图 9** 允许Visual Studio Code应用访问网络<a name="zh-cn_topic_0000001053466255_fig132725269184"></a>
![](figures/允许Visual-Studio-Code应用访问网络.png "允许Visual-Studio-Code应用访问网络")
## 烧写失败<a name="section1767804111198"></a>
- **现象描述**
点击烧写并选择串口后，出现无法烧写的情况。
- **可能原因**
安装IDE插件DevEco后未重启。
- **解决方法**
重启IDE。
## 编译构建过程中，提示找不到“python”<a name="zh-cn_topic_0000001053466255_section1039835245619"></a>
- **现象描述**
![](figures/zh-cn_image_0000001058781525.png)
- **可能原因1**
没有装python。
- **解决办法**
请按照[安装Python环境](Hi3518搭建环境.md#section10807183719500)安装python。
- **可能原因2**
![](figures/zh-cn_image_0000001058939672.png)
- **解决办法**
usr/bin目录下没有python软链接，请运行以下命令：
```
# cd /usr/bin/
# which python3
# ln -s /usr/local/bin/python3 python
# python --version
```
例：
![](figures/zh-cn_image_0000001058781464.png)
## 串口无回显<a name="zh-cn_topic_0000001053466255_section14871149155911"></a>
- **现象描述**
串口显示已连接，重启单板后，回车无任何回显。
- **可能原因1**
串口连接错误。
- **解决办法**
修改串口号。
请查看设备管理器，确认连接单板的串口与终端中连接串口是否一致，若不一致，请按镜像运行内[步骤1](开发Hi3518第一个示例程序.md#li744118533233)修改串口号。
- **可能原因2**
单板U-boot被损坏。
- **解决办法**
烧写U-boot。
若上述步骤依旧无法连接串口，可能由于单板U-boot损坏，按下述步骤烧写U-boot。
1. 获取引导文件U-boot。
>![](public_sys-resources/icon-notice.gif) **须知：**
>单板的U-boot文件请在开源包中获取：
>- Hi3516DV300：vendor\\hisi\\hi35xx\\hi3516dv300\\uboot\\out\\boot\\u-boot-hi3516dv300.bin
>- Hi3518EV300：vendor\\hisi\\hi35xx\\hi3518ev300\\uboot\\out\\boot\\u-boot-hi3518ev300.bin
2. 根据USB烧写步骤烧写U-boot文件。
按照[Hi3516系列USB烧写步骤](https://device.harmonyos.com/cn/docs/ide/user-guides/hi3516_upload-0000001052148681)/[Hi3518系列USB烧写步骤](https://device.harmonyos.com/cn/docs/ide/user-guides/hi3518_upload-0000001057313128)中描述的USB烧写方法，选择对应单板的U-boot文件进行烧写。
3. 烧写完成后，登录串口如下图所示。
![](figures/zh-cn_image_0000001058719409.png)
quick-start/Hi3518开发板.md
浏览文件 @ 37cc208b
...@@ -2,10 +2,10 @@ ...@@ -2,10 +2,10 @@
- **[Hi3518开发板介绍](Hi3518开发板介绍.md)** - **[Hi3518开发板介绍](Hi3518开发板介绍.md)**
- **[搭建环境](搭建环境-2.md)** - **[Hi3518搭建环境](Hi3518搭建环境.md)**
- **[开发Hi3518第一个示例程序](开发Hi3518第一个示例程序.md)** - **[开发Hi3518第一个示例程序](开发Hi3518第一个示例程序.md)**
- **[常见问题](常见问题-3.md)** - **[Hi3518常见问题](Hi3518常见问题.md)**
quick-start/Hi3518开发板介绍.md
浏览文件 @ 37cc208b
...@@ -5,7 +5,7 @@ ...@@ -5,7 +5,7 @@
## 开发板简介<a name="section14862341445"></a> ## 开发板简介<a name="section14862341445"></a>
Hi3518EV300作为新一代智慧视觉处理SOC，集成新一代ISP\(Image Signal Processor\)以及业界最新的H.265视频压缩编码器，同时采用先进低功耗工艺和低功耗架构设计，使其在低码率、高画质、低功耗等方面引领行业水平。 Hi3518EV300作为新一代智慧视觉处理SOC，集成新一代ISP\(Image Signal Processor\)以及H.265视频压缩编码器，同时采用先进低功耗工艺和低功耗架构设计，使其在低码率、高画质、低功耗等方面引领行业水平。
**图 1** Hi3518EV300单板正面外观图<a name="fig1187174485310"></a> **图 1** Hi3518EV300单板正面外观图<a name="fig1187174485310"></a>
![](figures/Hi3518EV300单板正面外观图.png "Hi3518EV300单板正面外观图") ![](figures/Hi3518EV300单板正面外观图.png "Hi3518EV300单板正面外观图")
......
quick-start/Hi3518搭建环境.md 0 → 100644
浏览文件 @ 37cc208b
# Hi3518搭建环境<a name="ZH-CN_TOPIC_0000001054022306"></a>
- [环境要求](#section1724111409282)
- [硬件要求](#section487353718276)
- [软件系统要求](#section44143554278)
- [Linux构建工具要求](#section17315193935817)
- [Windows开发工具要求](#section1897593723017)
- [安装Linux编译环境（方法一：Docker方式）](#section4848141175215)
- [安装Linux编译环境（方法二：安装包方式）](#section8831868501)
- [连接Linux服务器](#section12584112413505)
- [将Linux shell改为bash](#section21811833145019)
- [安装Python环境](#section10807183719500)
- [安装文件打包工具](#section480195453419)
- [安装gn](#section16725103716357)
- [安装ninja](#section156834539351)
- [安装LLVM](#section11739111964114)
- [安装hc-gen](#section351420104218)
- [安装Windows开发环境](#section188621583120)
## 环境要求<a name="section1724111409282"></a>
### 硬件要求<a name="section487353718276"></a>
- Linux服务器
- Windows工作台（主机电脑）
- Hi3518EV300 IoT Camera开发板
- USB转串口线、网线（Windows工作台通过USB转串口线、网线与开发板连接）
各硬件连接关系如下图所示。
**图 1** 硬件连线图<a name="fig8211468392"></a>
![](figures/硬件连线图.png "硬件连线图")
### 软件系统要求<a name="section44143554278"></a>
**表 1** 开发板开发平台要求
<a name="table16641975408"></a>
<table><thead align="left"><tr id="row196634713405"><th class="cellrowborder" valign="top" width="8.53%" id="mcps1.2.5.1.1"><p id="p116632718408"><a name="p116632718408"></a><a name="p116632718408"></a>硬件</p>
</th>
<th class="cellrowborder" valign="top" width="11.66%" id="mcps1.2.5.1.2"><p id="p1766312724017"><a name="p1766312724017"></a><a name="p1766312724017"></a>软件</p>
</th>
<th class="cellrowborder" valign="top" width="66%" id="mcps1.2.5.1.3"><p id="p666327144010"><a name="p666327144010"></a><a name="p666327144010"></a>描述</p>
</th>
<th class="cellrowborder" valign="top" width="13.81%" id="mcps1.2.5.1.4"><p id="p106631273406"><a name="p106631273406"></a><a name="p106631273406"></a>备注</p>
</th>
</tr>
</thead>
<tbody><tr id="row066315717402"><td class="cellrowborder" valign="top" width="8.53%" headers="mcps1.2.5.1.1 "><p id="p666318712403"><a name="p666318712403"></a><a name="p666318712403"></a>Linux编译服务器</p>
</td>
<td class="cellrowborder" valign="top" width="11.66%" headers="mcps1.2.5.1.2 "><p id="p76632712403"><a name="p76632712403"></a><a name="p76632712403"></a>操作系统</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.2.5.1.3 "><p id="p15663127204015"><a name="p15663127204015"></a><a name="p15663127204015"></a>Ubuntu16.04及以上64位系统版本，Shell使用bash。</p>
<div class="note" id="note196631578401"><a name="note196631578401"></a><a name="note196631578401"></a><span class="notetitle"> 说明： </span><div class="notebody"><p id="p1466311720406"><a name="p1466311720406"></a><a name="p1466311720406"></a>通常系统默认安装samba、vim等常用软件，需要做适当适配以支持linux文件共享。</p>
</div></div>
</td>
<td class="cellrowborder" rowspan="3" valign="top" width="13.81%" headers="mcps1.2.5.1.4 "><p id="p96631975404"><a name="p96631975404"></a><a name="p96631975404"></a>开发人员可以在Windows工作台中进行程序开发，或者远程登录到Linux服务器进行程序开发。</p>
</td>
</tr>
<tr id="row19664272408"><td class="cellrowborder" rowspan="2" valign="top" headers="mcps1.2.5.1.1 "><p id="p1366314764011"><a name="p1366314764011"></a><a name="p1366314764011"></a>Windows工作台</p>
<p id="p145850361498"><a name="p145850361498"></a><a name="p145850361498"></a></p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.5.1.2 "><p id="p15663177204019"><a name="p15663177204019"></a><a name="p15663177204019"></a>操作系统</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.5.1.3 "><p id="p1766411719408"><a name="p1766411719408"></a><a name="p1766411719408"></a>Windows XP/Windows7/Windows10</p>
</td>
</tr>
<tr id="row258543619919"><td class="cellrowborder" valign="top" headers="mcps1.2.5.1.1 "><p id="a70beb9d769e340018c9c39c7d44cf424"><a name="a70beb9d769e340018c9c39c7d44cf424"></a><a name="a70beb9d769e340018c9c39c7d44cf424"></a>USB转串口驱动</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.5.1.2 "><p id="p9790183418466"><a name="p9790183418466"></a><a name="p9790183418466"></a><a href="http://www.hihope.org/download/AllDocuments" target="_blank" rel="noopener noreferrer">http://www.hihope.org/download/AllDocuments</a></p>
<p id="p37901134184614"><a name="p37901134184614"></a><a name="p37901134184614"></a>驱动软件名：USB-to-Serial Comm Port.exe</p>
</td>
</tr>
</tbody>
</table>
### Linux构建工具要求<a name="section17315193935817"></a>
Linux服务器通用环境配置需要的工具及其获取途径如下表所示。
**表 2** Linux服务器开发工具及获取途径
<a name="table15485545145811"></a>
<table><thead align="left"><tr id="row1748610451588"><th class="cellrowborder" valign="top" width="13.081308130813083%" id="mcps1.2.4.1.1"><p id="p13486154545816"><a name="p13486154545816"></a><a name="p13486154545816"></a>开发工具</p>
</th>
<th class="cellrowborder" valign="top" width="19.921992199219922%" id="mcps1.2.4.1.2"><p id="p44867452589"><a name="p44867452589"></a><a name="p44867452589"></a>用途</p>
</th>
<th class="cellrowborder" valign="top" width="66.996699669967%" id="mcps1.2.4.1.3"><p id="p1748619458583"><a name="p1748619458583"></a><a name="p1748619458583"></a>获取途径</p>
</th>
</tr>
</thead>
<tbody><tr id="row1948614518582"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p9486154516582"><a name="p9486154516582"></a><a name="p9486154516582"></a>Python3.7+</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p74861645105812"><a name="p74861645105812"></a><a name="p74861645105812"></a>执行编译脚本工具</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p11486194575814"><a name="p11486194575814"></a><a name="p11486194575814"></a><a href="https://www.python.org/ftp/python/3.8.5/Python-3.8.5.tgz" target="_blank" rel="noopener noreferrer">https://www.python.org/ftp/python/3.8.5/Python-3.8.5.tgz</a></p>
</td>
</tr>
<tr id="row1248714455582"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p1548774535814"><a name="p1548774535814"></a><a name="p1548774535814"></a>bash</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p18487134595817"><a name="p18487134595817"></a><a name="p18487134595817"></a>执行命令行工具</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p184871645105816"><a name="p184871645105816"></a><a name="p184871645105816"></a>通过互联网获取</p>
</td>
</tr>
<tr id="row148784525817"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p10487345115817"><a name="p10487345115817"></a><a name="p10487345115817"></a>gn</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p348724585820"><a name="p348724585820"></a><a name="p348724585820"></a>产生ninja编译脚本</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p194878454589"><a name="p194878454589"></a><a name="p194878454589"></a><a href="https://repo.huaweicloud.com/harmonyos/compiler/gn/1523/linux/gn.1523.tar" target="_blank" rel="noopener noreferrer">https://repo.huaweicloud.com/harmonyos/compiler/gn/1523/linux/gn.1523.tar</a></p>
</td>
</tr>
<tr id="row184874451585"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p174871045105814"><a name="p174871045105814"></a><a name="p174871045105814"></a>ninja</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p204871645145811"><a name="p204871645145811"></a><a name="p204871645145811"></a>执行ninja编译脚本</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p184871245135810"><a name="p184871245135810"></a><a name="p184871245135810"></a><a href="https://repo.huaweicloud.com/harmonyos/compiler/ninja/1.9.0/linux/ninja.1.9.0.tar" target="_blank" rel="noopener noreferrer">https://repo.huaweicloud.com/harmonyos/compiler/ninja/1.9.0/linux/ninja.1.9.0.tar</a></p>
</td>
</tr>
<tr id="row12487154515585"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p1348713452581"><a name="p1348713452581"></a><a name="p1348713452581"></a>LLVM</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p648774510589"><a name="p648774510589"></a><a name="p648774510589"></a>编译工具链</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p148719454586"><a name="p148719454586"></a><a name="p148719454586"></a><a href="https://repo.huaweicloud.com/harmonyos/compiler/clang/9.0.0-34042/linux/llvm-linux-9.0.0-34042.tar" target="_blank" rel="noopener noreferrer">https://repo.huaweicloud.com/harmonyos/compiler/clang/9.0.0-34042/linux/llvm-linux-9.0.0-34042.tar</a></p>
</td>
</tr>
<tr id="row1548710453586"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p15487114585814"><a name="p15487114585814"></a><a name="p15487114585814"></a>hc-gen</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p148719452588"><a name="p148719452588"></a><a name="p148719452588"></a>驱动配置编译工具</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p1487164565819"><a name="p1487164565819"></a><a name="p1487164565819"></a><a href="https://repo.huaweicloud.com/harmonyos/compiler/hc-gen/0.65/linux/hc-gen-0.65-linux.tar" target="_blank" rel="noopener noreferrer">https://repo.huaweicloud.com/harmonyos/compiler/hc-gen/0.65/linux/hc-gen-0.65-linux.tar</a></p>
</td>
</tr>
<tr id="row248764585810"><td class="cellrowborder" valign="top" width="13.081308130813083%" headers="mcps1.2.4.1.1 "><p id="p1848711459584"><a name="p1848711459584"></a><a name="p1848711459584"></a>IPOP、PuTTY或其他超级终端</p>
</td>
<td class="cellrowborder" valign="top" width="19.921992199219922%" headers="mcps1.2.4.1.2 "><p id="p7487745125819"><a name="p7487745125819"></a><a name="p7487745125819"></a>连接Linux服务器工具（任选其一）</p>
</td>
<td class="cellrowborder" valign="top" width="66.996699669967%" headers="mcps1.2.4.1.3 "><p id="p18487154516584"><a name="p18487154516584"></a><a name="p18487154516584"></a>通过互联网获取（如：<a href="https://www.putty.org/" target="_blank" rel="noopener noreferrer">https://www.putty.org/</a>）</p>
</td>
</tr>
</tbody>
</table>
### Windows开发工具要求<a name="section1897593723017"></a>
**表 3** Windows工作台开发工具及获取途径
<a name="zh-cn_topic_0000001054501981_table1313323311274"></a>
<table><thead align="left"><tr id="zh-cn_topic_0000001054501981_row3133133312711"><th class="cellrowborder" valign="top" width="16.371637163716375%" id="mcps1.2.4.1.1"><p id="zh-cn_topic_0000001054501981_p16132203372716"><a name="zh-cn_topic_0000001054501981_p16132203372716"></a><a name="zh-cn_topic_0000001054501981_p16132203372716"></a>开发工具</p>
</th>
<th class="cellrowborder" valign="top" width="50.29502950295029%" id="mcps1.2.4.1.2"><p id="zh-cn_topic_0000001054501981_p1413219339278"><a name="zh-cn_topic_0000001054501981_p1413219339278"></a><a name="zh-cn_topic_0000001054501981_p1413219339278"></a>用途</p>
</th>
<th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.2.4.1.3"><p id="zh-cn_topic_0000001054501981_p17133183312711"><a name="zh-cn_topic_0000001054501981_p17133183312711"></a><a name="zh-cn_topic_0000001054501981_p17133183312711"></a>获取途径</p>
</th>
</tr>
</thead>
<tbody><tr id="zh-cn_topic_0000001054501981_row13697410143219"><td class="cellrowborder" valign="top" width="16.371637163716375%" headers="mcps1.2.4.1.1 "><p id="zh-cn_topic_0000001054501981_p163612016916"><a name="zh-cn_topic_0000001054501981_p163612016916"></a><a name="zh-cn_topic_0000001054501981_p163612016916"></a>Visual Studio Code</p>
</td>
<td class="cellrowborder" valign="top" width="50.29502950295029%" headers="mcps1.2.4.1.2 "><p id="zh-cn_topic_0000001054501981_p1563690791"><a name="zh-cn_topic_0000001054501981_p1563690791"></a><a name="zh-cn_topic_0000001054501981_p1563690791"></a>代码编辑工具</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="zh-cn_topic_0000001054501981_p146361701097"><a name="zh-cn_topic_0000001054501981_p146361701097"></a><a name="zh-cn_topic_0000001054501981_p146361701097"></a><a href="https://code.visualstudio.com/" target="_blank" rel="noopener noreferrer">https://code.visualstudio.com/</a></p>
</td>
</tr>
<tr id="zh-cn_topic_0000001054501981_row12133123315277"><td class="cellrowborder" valign="top" width="16.371637163716375%" headers="mcps1.2.4.1.1 "><p id="zh-cn_topic_0000001054501981_p613393317271"><a name="zh-cn_topic_0000001054501981_p613393317271"></a><a name="zh-cn_topic_0000001054501981_p613393317271"></a>HUAWEI DevEco Device Tool</p>
</td>
<td class="cellrowborder" valign="top" width="50.29502950295029%" headers="mcps1.2.4.1.2 "><p id="zh-cn_topic_0000001054501981_p10133193310276"><a name="zh-cn_topic_0000001054501981_p10133193310276"></a><a name="zh-cn_topic_0000001054501981_p10133193310276"></a>IDE开发工具，Visual Studio Code插件，支持代码编译、烧录和调试等功能，支持C/C++语言</p>
<div class="note" id="zh-cn_topic_0000001054501981_note7133193392718"><a name="zh-cn_topic_0000001054501981_note7133193392718"></a><a name="zh-cn_topic_0000001054501981_note7133193392718"></a><span class="notetitle"> 说明： </span><div class="notebody"><p id="zh-cn_topic_0000001054501981_p1133183310277"><a name="zh-cn_topic_0000001054501981_p1133183310277"></a><a name="zh-cn_topic_0000001054501981_p1133183310277"></a>HUAWEI DevEco Device Tool是<span id="zh-cn_topic_0000001054501981_text4133533192719"><a name="zh-cn_topic_0000001054501981_text4133533192719"></a><a name="zh-cn_topic_0000001054501981_text4133533192719"></a>OpenHarmony</span>面向智能设备开发者提供的一站式集成开发环境，支持<span id="zh-cn_topic_0000001054501981_text4133933162719"><a name="zh-cn_topic_0000001054501981_text4133933162719"></a><a name="zh-cn_topic_0000001054501981_text4133933162719"></a>OpenHarmony</span>的组件按需定制，支持代码编辑、编译、烧录、调试等功能，支持C/C++语言，以插件的形式部署在Visual Studio Code上。</p>
</div></div>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="zh-cn_topic_0000001054501981_p16788135433519"><a name="zh-cn_topic_0000001054501981_p16788135433519"></a><a name="zh-cn_topic_0000001054501981_p16788135433519"></a><a href="https://device.harmonyos.com/cn/ide" target="_blank" rel="noopener noreferrer">https://device.harmonyos.com/cn/ide</a></p>
</td>
</tr>
</tbody>
</table>
## 安装Linux编译环境（方法一：Docker方式）<a name="section4848141175215"></a>
Linux编译环境可以通过Docker方式快速安装，具体请参见[Docker方式获取编译环境](../get-code/获取工具.md)的“搭建Docker环境”。
## 安装Linux编译环境（方法二：安装包方式）<a name="section8831868501"></a>
>![](public_sys-resources/icon-notice.gif) **须知：**
>- 如果后续通过“HPM组件方式”或“HPM包管理器命令行工具方式”获取源码，不需要安装gn、ninja、LLVM、hc-gen编译工具。
>- （推荐）如果后续通过“镜像站点方式”或“代码仓库方式”获取源码，需要安装gn、ninja、LLVM、hc-gen编译工具。安装gn、ninja、LLVM、hc-gen编译工具时，请确保编译工具的环境变量路径唯一。
### 连接Linux服务器<a name="section12584112413505"></a>
使用Windows远程登录Linux，以PUTTY工具为例：
1. 打开[PuTTY工具](https://www.putty.org/)，输入Linux服务器IP地址，后点击“open”，打开连接。
**图 2** PuTTY界面示例图<a name="zh-cn_topic_0000001054781998_f825e6d7569cc487db9b744e454c7157a"></a>
![](figures/PuTTY界面示例图.png "PuTTY界面示例图")
2. 弹框告警选择“是\(Y\)”。
3. 弹出界面中输入帐号并按回车键，继续输入密码并回车键。
**图 3** 登录界面图<a name="zh-cn_topic_0000001054781998_fe1428afffbdd45f9b4a39497691ff5ff"></a>
![](figures/登录界面图.png "登录界面图")
4. 登录成功。
**图 4** 登录成功界面<a name="zh-cn_topic_0000001054781998_f11bea69483e14bd39fef4a10b1ed1a3a"></a>
![](figures/登录成功界面.png "登录成功界面")
### 将Linux shell改为bash<a name="section21811833145019"></a>
查看shell是否为bash，在终端运行如下命令
```
ls -l /bin/sh
```
如果显示为“/bin/sh -\> bash”则为正常，否则请按以下方式修改：
**方法一**：在终端运行如下命令，然后选择 no。
```
sudo dpkg-reconfigure dash
```
**方法二**：先删除sh，再创建软链接。
```
sudo rm -rf /bin/sh
sudo ln -s /bin/bash /bin/sh
```
### 安装Python环境<a name="section10807183719500"></a>
1. 打开Linux编译服务器终端。
2. 输入如下命令，查看python版本号，需使用python3.7以上版本。
```
python3 --version
```
如果低于python3.7版本，不建议直接升级，请按照如下步骤重新安装。以python3.8为例，按照以下步骤安装python。
1. 运行如下命令，查看Ubuntu版本：
```
cat /etc/issue
```
1. 根据Ubuntu不同版本，安装python。
- 如果Ubuntu 版本为18+，运行如下命令。
```
sudo apt-get install python3.8
```
- 如果Ubuntu版本为16，请以下载包的方式安装python。
1. python安装环境依赖\(gcc, g++, make, zlib, libffi\)请运行如下命令：
```
sudo apt-get install gcc && sudo apt-get install g++ && sudo apt-get install make && sudo apt-get install zlib* && sudo apt-get install libffi-dev
```
1. 获取[python3.8.5安装包](https://www.python.org/ftp/python/3.8.5/Python-3.8.5.tgz)，将其放至linux服务器中，运行如下命令 ：
```
tar -xvzf Python-3.8.5.tgz && cd Python-3.8.5 && sudo ./configure && sudo make && sudo make install
```
3. 确定python安装好后，将python路径链接到"/usr/bin/python"。
输入如下命令，查看python是否正确软链接到python3.8。
```
python --version
```
如果回显不是python 3.8.5，则运行如下命令，查看python3.8所在目录：
```
which python3.8
```
将以下命令中的 "python3.8-path" 替换为 "which python3.8" 命令执行后的回显路径
```
cd /usr/bin && sudo rm python && sudo rm python3 && sudo ln -s python3.8-path python && sudo ln -s python3.8-path python3 && python3 --version && python --version
```
4. 安装并升级Python包管理工具（pip3），任选如下一种方式。
- **命令行方式：**
```
sudo apt-get install python3-setuptools python3-pip -y
sudo pip3 install --upgrade pip
```
- **安装包方式：**
```
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
python get-pip.py
```
5. 运行如下命令，安装python模块setuptools。
```
pip3 install setuptools
```
6. 安装GUI menuconfig工具（Kconfiglib），建议安装Kconfiglib 13.2.0+版本，任选如下一种方式。
- **命令行方式：**
```
sudo pip3 install kconfiglib
```
- **安装包方式：**
1. 下载.whl文件（例如：kconfiglib-13.2.0-py2.py3-none-any.whl）。
下载路径：“[https://pypi.org/project/kconfiglib\#files](https://pypi.org/project/kconfiglib#files)”
1. 运行如下命令，安装.whl文件。
```
sudo pip3 install kconfiglib-13.2.0-py2.py3-none-any.whl
```
### 安装文件打包工具<a name="section480195453419"></a>
1. 打开Linux编译服务器终端。
2. 运行如下命令，安装dosfstools。
```
sudo apt-get install dosfstools
```
3. 运行如下命令，安装mtools。
```
sudo apt-get install mtools
```
4. 运行如下命令，安装mtd-utils。
```
sudo apt-get install mtd-utils
```
### 安装gn<a name="section16725103716357"></a>
1. 打开Linux编译服务器终端。
2. [下载gn工具](https://repo.huaweicloud.com/harmonyos/compiler/gn/1523/linux/gn.1523.tar)。
3. 解压gn安装包至\~/gn路径下。
```
tar -xvf gn.1523.tar -C ~/
```
4. 设置环境变量。
```
vim ~/.bashrc
```
将以下命令拷贝到.bashrc文件的最后一行，保存并退出。
```
export PATH=~/gn:$PATH
```
5. 生效环境变量。
```
source ~/.bashrc
```
### 安装ninja<a name="section156834539351"></a>
1. 打开Linux编译服务器终端。
2. [下载ninja工具](https://repo.huaweicloud.com/harmonyos/compiler/ninja/1.9.0/linux/ninja.1.9.0.tar)。
3. 解压ninja安装包至\~/ninja路径下。
```
tar -xvf ninja.1.9.0.tar -C ~/
```
4. 设置环境变量。
```
vim ~/.bashrc
```
将以下命令拷贝到.bashrc文件的最后一行，保存并退出。
```
export PATH=~/ninja:$PATH
```
5. 生效环境变量。
```
source ~/.bashrc
```
### 安装LLVM<a name="section11739111964114"></a>
1. 打开Linux编译服务器终端。
2. [下载LLVM工具](https://repo.huaweicloud.com/harmonyos/compiler/clang/9.0.0-34042/linux/llvm-linux-9.0.0-34042.tar)。
3. 解压LLVM安装包至\~/llvm路径下。
```
tar -xvf llvm-linux-9.0.0-34042.tar -C ~/
```
4. 设置环境变量。
```
vim ~/.bashrc
```
将以下命令拷贝到.bashrc文件的最后一行，保存并退出。
```
export PATH=~/llvm/bin:$PATH
```
5. 生效环境变量。
```
source ~/.bashrc
```
### 安装hc-gen<a name="section351420104218"></a>
1. 打开Linux编译服务器终端。
2. [下载hc-gen工具](https://repo.huaweicloud.com/harmonyos/compiler/hc-gen/0.65/linux/hc-gen-0.65-linux.tar)。
3. 解压hc-gen安装包到Linux服务器\~/hc-gen路径下。
```
tar -xvf hc-gen-0.65-linux.tar -C ~/
```
4. 设置环境变量。
```
vim ~/.bashrc
```
将以下命令拷贝到.bashrc文件的最后一行，保存并退出。
```
export PATH=~/hc-gen:$PATH
```
5. 生效环境变量。
```
source ~/.bashrc
```
## 安装Windows开发环境<a name="section188621583120"></a>
OpenHarmony IDE工具DevEco Device Tool集成了终端工具的能力，工具的安装步骤请参考[DevEco Device Tool环境搭建](https://device.harmonyos.com/cn/docs/ide/user-guides/tool_install-0000001050164976)、[导入和配置工程](https://device.harmonyos.com/cn/docs/ide/user-guides/import_project-0000001050164980)完成。
quick-start/Hi3861常见问题.md 0 → 100644
浏览文件 @ 37cc208b
# Hi3861常见问题<a name="ZH-CN_TOPIC_0000001053143860"></a>
- [安装python3过程中，提示“configure: error: no acceptable C compiler found in $PATH”](#section1221016541119)
- [安装python3过程中，提示“-bash: make: command not found”](#section1913477181213)
- [安装python3过程中，提示“zlib not available”](#section108211415131210)
- [安装python3过程中，提示“No module named '\_ctypes'”](#section2062268124)
- [编译构建过程中，提示“No module named 'Crypto'”](#section982315398121)
- [编译构建过程中，提示“No module named 'ecdsa'”](#section102035451216)
- [编译构建过程中，提示“Could not find a version that satisfies the requirement six\>=1.9.0”](#section4498158162320)
- [编译构建过程中，提示找不到“-lgcc”](#section11181036112615)
- [编译构建过程中，提示找不到“python”](#section1571810194619)
- [安装 kconfiglib时，遇到lsb\_release错误](#section691681635814)
## 安装python3过程中，提示“configure: error: no acceptable C compiler found in $PATH”<a name="section1221016541119"></a>
- **现象描述**
安装python3过程中出现以下错误：
```
configure: error: no acceptable C compiler found in $PATH. See 'config.log' for more details
```
- **可能原因**
环境中未安装“gcc”。
- **解决办法**
1、通过命令“apt-get install gcc”在线安装。
2、完成后，重新安装python3。
## 安装python3过程中，提示“-bash: make: command not found”<a name="section1913477181213"></a>
- **现象描述**
安装python3过程中出现以下错误：
```
-bash: make: command not found
```
- **可能原因**
环境中未安装“make”。
- **解决办法**
1、通过命令“apt-get install make”在线安装。
2、完成后，重新安装python3。
## 安装python3过程中，提示“zlib not available”<a name="section108211415131210"></a>
- **现象描述**
安装python3过程中出现以下错误：
```
zipimport.ZipImportError: can't decompress data; zlib not avaliable
```
- **可能原因**
环境中未安装“zlib”。
- **解决办法**
方法1：通过命令“apt-get install zlib”在线安装。
方法2：如果软件源中没有该软件，请从“www.zlib.net”下载版本代码，并离线安装。
![](figures/10.png)
完成下载后，通过以下命令安装：
```
# tar xvf zlib-1.2.11.tar.gz
# cd zlib-1.2.11
# ./configure
# make && make install
```
完成后，重新安装python3。
## 安装python3过程中，提示“No module named '\_ctypes'”<a name="section2062268124"></a>
- **现象描述**
安装python3过程中出现以下错误：
```
ModuleNotFoundError：No module named ‘_ctypes’
```
- **可能原因**
环境中未安装“libffi”和“libffi-devel”。
- **解决办法**
1、通过命令“apt-get install libffi\* -y”，在线安装。
2、完成后，重新安装python3。
## 编译构建过程中，提示“No module named 'Crypto'”<a name="section982315398121"></a>
- **现象描述**
编译构建过程中出现以下错误：
```
ModuleNotFoundError: No module named 'Crypto'
```
- **可能原因**
环境中未安装“Crypto”。
- **解决办法**
方法1：通过命令“pip3 install Crypto”，在线安装。
方法2：离线安装
通过网页[https://pypi.org/project/pycrypto/\#files](https://pypi.org/project/pycrypto/#files)，下载源码。
![](figures/zh-cn_image_0000001053462612.png)
将源码放置在Linux服务器中，解压，并安装“python3 setup.py install”。
完成上述安装后，重新构建。
## 编译构建过程中，提示“No module named 'ecdsa'”<a name="section102035451216"></a>
- **现象描述**
编译构建过程中出现以下错误：
```
ModuleNotFoundError：No module named 'ecdsa'
```
- **可能原因**
环境中未安装“ecdsa”。
- **解决办法**
方法1：通过命令“pip3 install ecdsa”，在线安装。
方法2：离线安装
通过网页[https://pypi.org/project/ecdsa/\#files](https://pypi.org/project/ecdsa/#files)，下载安装包。
![](figures/zh-cn_image_0000001053022609.png)
将安装包放置Linux服务器中，并安装“pip3 install ecdsa-0.15-py2.py3-none-any.whl”。
完成上述安装后，重新构建。
## 编译构建过程中，提示“Could not find a version that satisfies the requirement six\>=1.9.0”<a name="section4498158162320"></a>
- **现象描述**
编译构建过程中出现以下错误：
```
Could not find a version that satisfies the requirment six>=1.9.0
```
- **可能原因**
环境中未安装合适的“six”。
- **解决办法**
方法1：通过命令“pip3 install six”，在线安装。
方法2：离线安装
通过网页[https://pypi.org/project/six/\#files](https://pypi.org/project/six/#files)，下载安装包。
![](figures/zh-cn_image_0000001052742629.png)
将源码放置在Linux服务器中，并安装“pip3 install six-1.14.0-py2.py3-none-any.whl”。
完成上述安装后，重新构建。
## 编译构建过程中，提示找不到“-lgcc”<a name="section11181036112615"></a>
- **现象描述**
编译构建过程中出现以下错误：
```
riscv32-unknown-elf-ld: cannot find -lgcc
```
- **可能原因**
交叉编译器gcc\_riscv32的PATH添加错误，如下，在"bin"后多添加了一个“/”，应该删除。
```
~/gcc_riscv32/bin/:/data/toolchain/
```
- **解决办法**
重新修改gcc\_riscv32的PATH，将多余的“/”删除。
```
~/gcc_riscv32/bin:/data/toolchain/
```
## 编译构建过程中，提示找不到“python”<a name="section1571810194619"></a>
- **现象描述**
编译构建过程中出现以下错误：
```
-bash: /usr/bin/python: No such file or directory
```
- **可能原因**1
没有装python。
- **解决办法**
请按照[安装Python环境](Hi3861搭建环境.md#section18835251192618)安装python。
- **可能原因2**
![](figures/zh-cn_image_0000001055372855.png)
- **解决办法**
usr/bin目录下没有python软链接，请运行以下命令添加软链接：
```
# cd /usr/bin/
# which python3
# ln -s /usr/local/bin/python3 python
# python --version
```
例：
![](figures/zh-cn_image_0000001055012855.png)
## 安装 kconfiglib时，遇到lsb\_release错误<a name="section691681635814"></a>
- **现象描述**
安装kconfiglib过程中遇到如下错误打印：
```
subprocess.CalledProcessError: Command '('lsb_release', '-a')' returned non-zero exit status 1.
```
- **可能原因**
lsb\_release模块基于的python版本与现有python版本不一致
- **解决办法**
执行"find / -name lsb\_release"，找到lsb\_release位置并删除，如："sudo rm -rf /usr/bin/lsb\_release"
quick-start/Hi3861开发板.md
浏览文件 @ 37cc208b
...@@ -2,12 +2,12 @@ ...@@ -2,12 +2,12 @@
- **[Hi3861开发板介绍](Hi3861开发板介绍.md)** - **[Hi3861开发板介绍](Hi3861开发板介绍.md)**
- **[搭建环境](搭建环境.md)** - **[Hi3861搭建环境](Hi3861搭建环境.md)**
- **[Hi3861开发板第一个示例程序](Hi3861开发板第一个示例程序.md)** - **[开发Hi3861第一个示例程序](开发Hi3861第一个示例程序.md)**
- **[Hi3861开发板第二个示例程序](Hi3861开发板第二个示例程序.md)** - **[开发Hi3861第二个示例程序](开发Hi3861第二个示例程序.md)**
- **[常见问题](常见问题.md)** - **[Hi3861常见问题](Hi3861常见问题.md)**
quick-start/Hi3861搭建环境.md 0 → 100644
浏览文件 @ 37cc208b
# Hi3861搭建环境<a name="ZH-CN_TOPIC_0000001054781998"></a>
- [环境要求](#section466851916410)
- [软件系统要求](#section1595725202314)
- [Linux构建工具要求](#section992619473117)
- [Windows开发工具要求](#section2833173411317)
- [安装Linux编译环境（方法一：Docker方式）](#section107932281315)
- [安装Linux编译环境（方法二：安装包方式）](#section497484245614)
- [连接Linux服务器](#section1565413132610)
- [将Linux shell改为bash](#section1715027152617)
- [安装Python环境](#section18835251192618)
- [安装Scons](#section13515123015279)
- [安装gn](#section0646125972716)
- [安装ninja](#section7681117192813)
- [安装gcc\_riscv32（WLAN模组类编译工具链）](#section1842910288284)
- [安装Windows开发环境](#section1995840162515)
## 环境要求<a name="section466851916410"></a>
### 软件系统要求<a name="section1595725202314"></a>
**表 1** Hi3861 WLAN模組开发平台要求
<a name="table1822785713303"></a>
<table><thead align="left"><tr id="row72271157163014"><th class="cellrowborder" valign="top" width="12.41%" id="mcps1.2.5.1.1"><p id="p17227205711305"><a name="p17227205711305"></a><a name="p17227205711305"></a>硬件</p>
</th>
<th class="cellrowborder" valign="top" width="12.389999999999999%" id="mcps1.2.5.1.2"><p id="p112271557113019"><a name="p112271557113019"></a><a name="p112271557113019"></a>软件</p>
</th>
<th class="cellrowborder" valign="top" width="46.21%" id="mcps1.2.5.1.3"><p id="p16227105718309"><a name="p16227105718309"></a><a name="p16227105718309"></a>描述</p>
</th>
<th class="cellrowborder" valign="top" width="28.99%" id="mcps1.2.5.1.4"><p id="p162271957163018"><a name="p162271957163018"></a><a name="p162271957163018"></a>备注</p>
</th>
</tr>
</thead>
<tbody><tr id="row16227157163014"><td class="cellrowborder" valign="top" width="12.41%" headers="mcps1.2.5.1.1 "><p id="p1222775733020"><a name="p1222775733020"></a><a name="p1222775733020"></a>Linux编译服务器</p>
</td>
<td class="cellrowborder" valign="top" width="12.389999999999999%" headers="mcps1.2.5.1.2 "><p id="p22272577304"><a name="p22272577304"></a><a name="p22272577304"></a>操作系统</p>
</td>
<td class="cellrowborder" valign="top" width="46.21%" headers="mcps1.2.5.1.3 "><p id="p622719576305"><a name="p622719576305"></a><a name="p622719576305"></a>Ubuntu16.04及以上64位系统版本，Shell使用bash</p>
</td>
<td class="cellrowborder" rowspan="2" valign="top" width="28.99%" headers="mcps1.2.5.1.4 "><p id="p162276579305"><a name="p162276579305"></a><a name="p162276579305"></a>开发人员可以在Windows工作台中进行程序开发，或者远程登录到Linux服务器进行程序开发。</p>
</td>
</tr>
<tr id="row5227165719305"><td class="cellrowborder" valign="top" headers="mcps1.2.5.1.1 "><p id="p32279578305"><a name="p32279578305"></a><a name="p32279578305"></a>Windows工作台</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.5.1.2 "><p id="p192271757133018"><a name="p192271757133018"></a><a name="p192271757133018"></a>操作系统</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.5.1.3 "><p id="p1022855713303"><a name="p1022855713303"></a><a name="p1022855713303"></a>Windows XP/Windows7/Windows10</p>
</td>
</tr>
</tbody>
</table>
### Linux构建工具要求<a name="section992619473117"></a>
Linux服务器通用环境配置需要的工具及其获取途径如下表所示。
**表 2** Linux服务器开发工具及获取途径
<a name="table6299192712513"></a>
<table><thead align="left"><tr id="row122993276512"><th class="cellrowborder" valign="top" width="25.562556255625562%" id="mcps1.2.4.1.1"><p id="p1829914271858"><a name="p1829914271858"></a><a name="p1829914271858"></a>开发工具</p>
</th>
<th class="cellrowborder" valign="top" width="20.7020702070207%" id="mcps1.2.4.1.2"><p id="p429918274517"><a name="p429918274517"></a><a name="p429918274517"></a>用途</p>
</th>
<th class="cellrowborder" valign="top" width="53.73537353735374%" id="mcps1.2.4.1.3"><p id="p12997271757"><a name="p12997271757"></a><a name="p12997271757"></a>获取途径</p>
</th>
</tr>
</thead>
<tbody><tr id="row1829915274517"><td class="cellrowborder" valign="top" width="25.562556255625562%" headers="mcps1.2.4.1.1 "><p id="p1629902717511"><a name="p1629902717511"></a><a name="p1629902717511"></a>交叉编译器gcc_riscv32</p>
</td>
<td class="cellrowborder" valign="top" width="20.7020702070207%" headers="mcps1.2.4.1.2 "><p id="p1219863434519"><a name="p1219863434519"></a><a name="p1219863434519"></a>交叉编译工具</p>
</td>
<td class="cellrowborder" valign="top" width="53.73537353735374%" headers="mcps1.2.4.1.3 "><p id="p14145637348"><a name="p14145637348"></a><a name="p14145637348"></a><a href="https://repo.huaweicloud.com/harmonyos/compiler/gcc_riscv32/7.3.0/linux/gcc_riscv32-linux-7.3.0.tar.gz" target="_blank" rel="noopener noreferrer">https://repo.huaweicloud.com/harmonyos/compiler/gcc_riscv32/7.3.0/linux/gcc_riscv32-linux-7.3.0.tar.gz</a></p>
</td>
</tr>
<tr id="row430016273514"><td class="cellrowborder" valign="top" width="25.562556255625562%" headers="mcps1.2.4.1.1 "><p id="p330015271158"><a name="p330015271158"></a><a name="p330015271158"></a>Python3.7+</p>
</td>
<td class="cellrowborder" valign="top" width="20.7020702070207%" headers="mcps1.2.4.1.2 "><p id="p43003270510"><a name="p43003270510"></a><a name="p43003270510"></a>编译构建工具</p>
</td>
<td class="cellrowborder" valign="top" width="53.73537353735374%" headers="mcps1.2.4.1.3 "><p id="p18254155164617"><a name="p18254155164617"></a><a name="p18254155164617"></a><a href="https://www.python.org/ftp/python/3.8.5/Python-3.8.5.tgz" target="_blank" rel="noopener noreferrer">https://www.python.org/ftp/python/3.8.5/Python-3.8.5.tgz</a></p>
</td>
</tr>
<tr id="row1397335913612"><td class="cellrowborder" valign="top" width="25.562556255625562%" headers="mcps1.2.4.1.1 "><p id="p097355911620"><a name="p097355911620"></a><a name="p097355911620"></a>SCons3.0.4+</p>
</td>
<td class="cellrowborder" valign="top" width="20.7020702070207%" headers="mcps1.2.4.1.2 "><p id="p1973195917619"><a name="p1973195917619"></a><a name="p1973195917619"></a>编译构建工具</p>
</td>
<td class="cellrowborder" valign="top" width="53.73537353735374%" headers="mcps1.2.4.1.3 "><p id="p1722663441514"><a name="p1722663441514"></a><a name="p1722663441514"></a>通过互联网获取</p>
</td>
</tr>
<tr id="row42668197206"><td class="cellrowborder" valign="top" width="25.562556255625562%" headers="mcps1.2.4.1.1 "><p id="p426711912014"><a name="p426711912014"></a><a name="p426711912014"></a>bash</p>
</td>
<td class="cellrowborder" valign="top" width="20.7020702070207%" headers="mcps1.2.4.1.2 "><p id="p14267131962014"><a name="p14267131962014"></a><a name="p14267131962014"></a>命令处理器</p>
</td>
<td class="cellrowborder" valign="top" width="53.73537353735374%" headers="mcps1.2.4.1.3 "><p id="p14267101962014"><a name="p14267101962014"></a><a name="p14267101962014"></a>通过互联网获取</p>
</td>
</tr>
<tr id="row1463517494402"><td class="cellrowborder" valign="top" width="25.562556255625562%" headers="mcps1.2.4.1.1 "><p id="p258814561424"><a name="p258814561424"></a><a name="p258814561424"></a>build-essential</p>
</td>
<td class="cellrowborder" valign="top" width="20.7020702070207%" headers="mcps1.2.4.1.2 "><p id="p1749611716181"><a name="p1749611716181"></a><a name="p1749611716181"></a>编译依赖的基础软件包</p>
</td>
<td class="cellrowborder" valign="top" width="53.73537353735374%" headers="mcps1.2.4.1.3 "><p id="p8635174916403"><a name="p8635174916403"></a><a name="p8635174916403"></a>通过互联网获取</p>
</td>
</tr>
<tr id="row1711946154018"><td class="cellrowborder" valign="top" width="25.562556255625562%" headers="mcps1.2.4.1.1 "><p id="p15588165684216"><a name="p15588165684216"></a><a name="p15588165684216"></a>gn</p>
</td>
<td class="cellrowborder" valign="top" width="20.7020702070207%" headers="mcps1.2.4.1.2 "><p id="p4588135634213"><a name="p4588135634213"></a><a name="p4588135634213"></a>产生ninja编译脚本</p>
</td>
<td class="cellrowborder" valign="top" width="53.73537353735374%" headers="mcps1.2.4.1.3 "><p id="p10572194318318"><a name="p10572194318318"></a><a name="p10572194318318"></a><a href="https://repo.huaweicloud.com/harmonyos/compiler/gn/1523/linux/gn.1523.tar" target="_blank" rel="noopener noreferrer">https://repo.huaweicloud.com/harmonyos/compiler/gn/1523/linux/gn.1523.tar</a></p>
</td>
</tr>
<tr id="row16990164213404"><td class="cellrowborder" valign="top" width="25.562556255625562%" headers="mcps1.2.4.1.1 "><p id="p1858825613428"><a name="p1858825613428"></a><a name="p1858825613428"></a>ninja</p>
</td>
<td class="cellrowborder" valign="top" width="20.7020702070207%" headers="mcps1.2.4.1.2 "><p id="p15844174611816"><a name="p15844174611816"></a><a name="p15844174611816"></a>执行ninja编译脚本</p>
</td>
<td class="cellrowborder" valign="top" width="53.73537353735374%" headers="mcps1.2.4.1.3 "><p id="p1923373393515"><a name="p1923373393515"></a><a name="p1923373393515"></a><a href="https://repo.huaweicloud.com/harmonyos/compiler/ninja/1.9.0/linux/ninja.1.9.0.tar" target="_blank" rel="noopener noreferrer">https://repo.huaweicloud.com/harmonyos/compiler/ninja/1.9.0/linux/ninja.1.9.0.tar</a></p>
</td>
</tr>
</tbody>
</table>
### Windows开发工具要求<a name="section2833173411317"></a>
**表 3** Windows工作台开发工具及获取途径
<a name="table1313323311274"></a>
<table><thead align="left"><tr id="row3133133312711"><th class="cellrowborder" valign="top" width="16.371637163716375%" id="mcps1.2.4.1.1"><p id="p16132203372716"><a name="p16132203372716"></a><a name="p16132203372716"></a>开发工具</p>
</th>
<th class="cellrowborder" valign="top" width="50.29502950295029%" id="mcps1.2.4.1.2"><p id="p1413219339278"><a name="p1413219339278"></a><a name="p1413219339278"></a>用途</p>
</th>
<th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.2.4.1.3"><p id="p17133183312711"><a name="p17133183312711"></a><a name="p17133183312711"></a>获取途径</p>
</th>
</tr>
</thead>
<tbody><tr id="row138432533451"><td class="cellrowborder" valign="top" width="16.371637163716375%" headers="mcps1.2.4.1.1 "><p id="p163612016916"><a name="p163612016916"></a><a name="p163612016916"></a>Visual Studio Code</p>
</td>
<td class="cellrowborder" valign="top" width="50.29502950295029%" headers="mcps1.2.4.1.2 "><p id="p1563690791"><a name="p1563690791"></a><a name="p1563690791"></a>代码编辑工具。</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="p146361701097"><a name="p146361701097"></a><a name="p146361701097"></a><a href="https://code.visualstudio.com/" target="_blank" rel="noopener noreferrer">https://code.visualstudio.com/</a></p>
</td>
</tr>
<tr id="row12133123315277"><td class="cellrowborder" valign="top" width="16.371637163716375%" headers="mcps1.2.4.1.1 "><p id="p613393317271"><a name="p613393317271"></a><a name="p613393317271"></a>HUAWEI DevEco Device Tool</p>
</td>
<td class="cellrowborder" valign="top" width="50.29502950295029%" headers="mcps1.2.4.1.2 "><p id="p10133193310276"><a name="p10133193310276"></a><a name="p10133193310276"></a>IDE开发工具，支持WLAN模组的代码编写、远程编译、版本烧录、串口调试等功能。</p>
<div class="note" id="note7133193392718"><a name="note7133193392718"></a><a name="note7133193392718"></a><span class="notetitle"> 说明： </span><div class="notebody"><p id="p1133183310277"><a name="p1133183310277"></a><a name="p1133183310277"></a>HUAWEI DevEco Device Tool是<span id="text4133533192719"><a name="text4133533192719"></a><a name="text4133533192719"></a>OpenHarmony</span>面向智能设备开发者提供的一站式集成开发环境，支持<span id="text4133933162719"><a name="text4133933162719"></a><a name="text4133933162719"></a>OpenHarmony</span>的组件按需定制，支持C/C++语言，以插件的形式部署在Visual Studio Code上。</p>
</div></div>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="p1240954393114"><a name="p1240954393114"></a><a name="p1240954393114"></a><a href="https://device.harmonyos.com/cn/ide" target="_blank" rel="noopener noreferrer">https://device.harmonyos.com/cn/ide</a></p>
</td>
</tr>
<tr id="row18342145821513"><td class="cellrowborder" valign="top" width="16.371637163716375%" headers="mcps1.2.4.1.1 "><p id="p123421958131517"><a name="p123421958131517"></a><a name="p123421958131517"></a>PuTTY或其他超级终端（选其一）</p>
</td>
<td class="cellrowborder" valign="top" width="50.29502950295029%" headers="mcps1.2.4.1.2 "><p id="p18342658131511"><a name="p18342658131511"></a><a name="p18342658131511"></a>远程连接Linux编译服务器，连接模组串口工具。</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="p17342125851518"><a name="p17342125851518"></a><a name="p17342125851518"></a>通过互联网获取（如：<a href="https://www.putty.org/" target="_blank" rel="noopener noreferrer">https://www.putty.org/</a>）</p>
</td>
</tr>
<tr id="row244884215147"><td class="cellrowborder" valign="top" width="16.371637163716375%" headers="mcps1.2.4.1.1 "><p id="p1044974291416"><a name="p1044974291416"></a><a name="p1044974291416"></a>CH341SER.EXE</p>
</td>
<td class="cellrowborder" valign="top" width="50.29502950295029%" headers="mcps1.2.4.1.2 "><p id="p94491342131413"><a name="p94491342131413"></a><a name="p94491342131413"></a>USB转串口驱动。</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="p6449184214148"><a name="p6449184214148"></a><a name="p6449184214148"></a><a href="http://www.wch.cn/search?q=ch340g&amp;t=downloads" target="_blank" rel="noopener noreferrer">http://www.wch.cn/search?q=ch340g&amp;t=downloads</a></p>
</td>
</tr>
</tbody>
</table>
## 安装Linux编译环境（方法一：Docker方式）<a name="section107932281315"></a>
Linux编译环境可以通过Docker方式快速安装，具体请参见[Docker方式获取编译环境](../get-code/获取工具.md)的“搭建Docker环境”。
## 安装Linux编译环境（方法二：安装包方式）<a name="section497484245614"></a>
>![](public_sys-resources/icon-notice.gif) **须知：**
>- 如果后续通过“HPM组件方式”或“HPM包管理器命令行工具方式”获取源码，不需要安装gn、ninja、gcc\_riscv32编译工具。
>- （推荐）如果后续通过“镜像站点方式”或“代码仓库方式”获取源码，需要安装gn、ninja、gcc\_riscv32编译工具。
> 安装gn、ninja、gcc\_riscv32编译工具时，请确保编译工具的环境变量路径唯一。
### 连接Linux服务器<a name="section1565413132610"></a>
使用Windows远程登录Linux，以PUTTY工具为例：
1. 打开[PuTTY工具](https://www.putty.org/)，输入Linux服务器IP地址，后点击“open”，打开连接。
**图 1** PuTTY界面示例图<a name="f825e6d7569cc487db9b744e454c7157a"></a>
![](figures/PuTTY界面示例图.png "PuTTY界面示例图")
2. 弹框告警选择“是\(Y\)”。
3. 弹出界面中输入帐号并按回车键，继续输入密码并回车键。
**图 2** 登录界面图<a name="fe1428afffbdd45f9b4a39497691ff5ff"></a>
![](figures/登录界面图.png "登录界面图")
4. 登录成功。
**图 3** 登录成功界面<a name="f11bea69483e14bd39fef4a10b1ed1a3a"></a>
![](figures/登录成功界面.png "登录成功界面")
### 将Linux shell改为bash<a name="section1715027152617"></a>
查看shell是否为bash，在终端运行如下命令
```
ls -l /bin/sh
```
如果显示为“/bin/sh -\> bash”则为正常，否则请按以下方式修改：
**方法一**：在终端运行如下命令，然后选择 no。
```
sudo dpkg-reconfigure dash
```
**方法二**：先删除sh，再创建软链接。
```
sudo rm -rf /bin/sh
sudo ln -s /bin/bash /bin/sh
```
### 安装Python环境<a name="section18835251192618"></a>
1. 打开Linux编译服务器终端。
2. 输入如下命令，查看python版本号，需使用python3.7以上版本。
```
python3 --version
```
如果低于python3.7版本，不建议直接升级，请按照如下步骤重新安装。以python3.8为例，按照以下步骤安装python。
1. 运行如下命令，查看Ubuntu版本：
```
cat /etc/issue
```
1. 根据Ubuntu不同版本，安装python。
- 如果Ubuntu 版本为18+，运行如下命令。
```
sudo apt-get install python3.8
```
- 如果Ubuntu版本为16，请以下载包的方式安装python。
1. python安装环境依赖\(gcc, g++, make, zlib, libffi\)请运行如下命令：
```
sudo apt-get install gcc && sudo apt-get install g++ && sudo apt-get install make && sudo apt-get install zlib* && sudo apt-get install libffi-dev
```
1. 获取[python3.8.5安装包](https://www.python.org/ftp/python/3.8.5/Python-3.8.5.tgz)，将其放至linux服务器中，运行如下命令 ：
```
tar -xvzf Python-3.8.5.tgz && cd Python-3.8.5 && sudo ./configure && sudo make && sudo make install
```
3. 确定python安装好后，将python路径链接到"/usr/bin/python"。
输入如下命令，查看python是否正确软链接到python3.8。
```
python --version
```
如果回显不是python 3.8.5，则运行如下命令，查看python3.8所在目录：
```
which python3.8
```
将以下命令中的 "python3.8-path" 替换为 "which python3.8" 命令执行后的回显路径
```
cd /usr/bin && sudo rm python && sudo rm python3 && sudo ln -s python3.8-path python && sudo ln -s python3.8-path python3 && python3 --version && python --version
```
4. 安装并升级Python包管理工具（pip3），任选如下一种方式。
- **命令行方式：**
```
sudo apt-get install python3-setuptools python3-pip -y
sudo pip3 install --upgrade pip
```
- **安装包方式：**
```
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
python get-pip.py
```
5. 运行如下命令，安装python模块setuptools。
```
pip3 install setuptools
```
6. 安装GUI menuconfig工具（Kconfiglib），建议安装Kconfiglib 13.2.0+版本，任选如下一种方式。
- **命令行方式：**
```
sudo pip3 install kconfiglib
```
- **安装包方式：**
1. 下载.whl文件（例如：kconfiglib-13.2.0-py2.py3-none-any.whl）。
下载路径：“[https://pypi.org/project/kconfiglib\#files](https://pypi.org/project/kconfiglib#files)”
1. 运行如下命令，安装.whl文件。
```
sudo pip3 install kconfiglib-13.2.0-py2.py3-none-any.whl
```
7. 安装pycryptodome，任选如下一种方式。
安装升级文件签名依赖的Python组件包，包括：pycryptodome、six、ecdsa。安装ecdsa依赖six，请先安装six，再安装ecdsa。
- **命令行方式：**
```
sudo pip3 install pycryptodome
```
- **安装包方式：**
1. 下载.whl文件（例如：pycryptodome-3.9.9-cp38-cp38-manylinux1\_x86\_64.whl）。
下载路径：“[https://pypi.org/project/pycryptodome/\#files](https://pypi.org/project/pycryptodome/#files)”。
1. 运行如下命令，安装.whl文件。
```
sudo pip3 install pycryptodome-3.9.9-cp38-cp38-manylinux1_x86_64.whl
```
8. 安装six，任选如下一种方式。
- **命令行方式：**
```
sudo pip3 install six --upgrade --ignore-installed six
```
- **安装包方式：**
1. 下载.whl文件（例如：six-1.12.0-py2.py3-none-any.whl）。
下载路径：“[https://pypi.org/project/six/\#files](https://pypi.org/project/six/#files)”
1. 运行如下命令，安装.whl文件。
```
sudo pip3 install six-1.12.0-py2.py3-none-any.whl
```
9. 安装ecdsa，任选如下一种方式。
- **命令行方式：**
```
sudo pip3 install ecdsa
```
- **安装包方式：**
1. 下载.whl文件（例如：ecdsa-0.14.1-py2.py3-none-any.whl）。
下载路径：“[https://pypi.org/project/ecdsa/\#files](https://pypi.org/project/ecdsa/#files)”
1. 运行如下命令，安装.whl文件。
```
sudo pip3 install ecdsa-0.14.1-py2.py3-none-any.whl
```
### 安装Scons<a name="section13515123015279"></a>
1. 打开Linux编译服务器终端。
2. 运行如下命令，安装SCons安装包。
```
sudo apt-get install scons -y
```
如果软件源中无法找到安装包，请按以下步骤处理：
1. 下载源码包（下载路径：“ [https://scons.org/pages/download.html](https://scons.org/pages/download.html) ”，推荐SCons版本是3.0.4+）。
2. 解压源码包到任意目录（以scons-3.1.2为例）。
```
tar -xvf scons-3.1.2.tar.gz
```
3. 安装源码包：进入解压目录，运行如下命令：
```
sudo python3 setup.py install
```
3. 运行如下命令，查看是否安装成功。如果安装成功，查询结果下图所示。
```
scons -v
```
**图 4** SCons安装成功界面<a name="fig235815252492"></a>
![](figures/SCons安装成功界面.png "SCons安装成功界面")
### 安装gn<a name="section0646125972716"></a>
1. 打开Linux编译服务器终端。
2. [下载gn工具](https://repo.huaweicloud.com/harmonyos/compiler/gn/1523/linux/gn.1523.tar)。
3. 解压gn安装包至\~/gn路径下。
```
tar -xvf gn.1523.tar -C ~/
```
4. 设置环境变量。
```
vim ~/.bashrc
```
将以下命令拷贝到.bashrc文件的最后一行，保存并退出。
```
export PATH=~/gn:$PATH
```
5. 生效环境变量。
```
source ~/.bashrc
```
### 安装ninja<a name="section7681117192813"></a>
1. 打开Linux编译服务器终端。
2. [下载ninja工具](https://repo.huaweicloud.com/harmonyos/compiler/ninja/1.9.0/linux/ninja.1.9.0.tar)。
3. 解压ninja安装包至\~/ninja路径下。
```
tar -xvf ninja.1.9.0.tar -C ~/
```
4. 设置环境变量。
```
vim ~/.bashrc
```
将以下命令拷贝到.bashrc文件的最后一行，保存并退出。
```
export PATH=~/ninja:$PATH
```
5. 生效环境变量。
```
source ~/.bashrc
```
### 安装gcc\_riscv32（WLAN模组类编译工具链）<a name="section1842910288284"></a>
>![](public_sys-resources/icon-notice.gif) **须知：**
>Hi3861平台仅支持使用libgcc运行时库的静态链接，**不建议开发者使用libgcc运行时库的动态链接，会导致商业分发时被GPL V3污染。**
1. 打开Linux编译服务器终端。
2. 环境准备，请安装"gcc, g++, bison, flex, makeinfo"软件，确保工具链能正确编译。
```
sudo apt-get install gcc && sudo apt-get install g++ && sudo apt-get install flex bison && sudo apt-get install texinfo
```
3. 下载riscv-gnu-toolchain交叉编译工具链。
```
git clone --recursive https://github.com/riscv/riscv-gnu-toolchain
```
4. 打开文件夹riscv-gnu-toolchain，先删除空文件夹，以防止下载newlib，binutils，gcc时冲突。
```
cd riscv-gnu-toolchain && rm -rf riscv-newlib && rm -rf riscv-binutils && rm -rf riscv-gcc
```
5. 下载riscv-newlib-3.0.0。
```
git clone -b riscv-newlib-3.0.0 https://github.com/riscv/riscv-newlib.git
```
6. 下载riscv-binutils-2.31.1。
```
git clone -b riscv-binutils-2.31.1 https://github.com/riscv/riscv-binutils-gdb.git
```
7. 下载riscv-gcc-7.3.0。
```
git clone -b riscv-gcc-7.3.0 https://github.com/riscv/riscv-gcc
```
8. 下载riscv-gcc-7.3.0补丁。
拷贝gcc官方[89411.patch](https://gcc.gnu.org/git/?p=gcc.git;a=patch;h=026216a753ef0a757a9e368a59fa667ea422cf09;hp=2a23a1c39fb33df0277abd4486a3da64ae5e62c2)，拷贝gcc官方[86724.patch](https://gcc.gnu.org/git/?p=gcc.git;a=blobdiff;f=gcc/graphite.h;h=be0a22b38942850d88feb159603bb846a8607539;hp=4e0e58c60ab83f1b8acf576e83330466775fac17;hb=b1761565882ed6a171136c2c89e597bc4dd5b6bf;hpb=fbd5f023a03f9f60c6ae36133703af5a711842a3)，并对应代码做一定的行数号修改，将两个patch放入 riscv-gcc目录
```
cd riscv-gcc && patch -p1 < 89411.patch && patch -p1 < 86724.patch
```
patch过程中如遇到Hunk \#1 FAILED等问题，请对应到相应.c文件，修改patch代码所在行数
9. 下载[GMP 6.1.2](https://gmplib.org/download/gmp/gmp-6.1.2.tar.bz2)，并解压安装。
```
tar -xvf mpfr-4.0.2.tar.gz && mkdir build_mpfr && cd build_mpfr && ../mpfr-4.0.2/configure --prefix=/usr/local/mpfr-4.0.2 --with-gmp=/usr/local/gmp-6.1.2 --disable-shared && make && make install
```
10. 下载[mpfr-4.0.2 ](https://www.mpfr.org/mpfr-4.0.2/mpfr-4.0.2.tar.gz)，并解压安装。
```
tar -xvf mpfr-4.0.2.tar.gz && mkdir build_mpfr && cd build_mpfr && ../mpfr-4.0.2/configure --prefix=/usr/local/mpfr-4.0.2 --with-gmp=/usr/local/gmp-6.1.2 --disable-shared && make && make install
```
11. 下载[mpc-1.1.0](https://ftp.gnu.org/gnu/mpc/mpc-1.1.0.tar.gz) ，并解压安装。
```
tar -xvf mpc-1.1.0.tar.gz && mkdir build_mpc && cd build_mpc && ../mpc-1.1.0/configure --prefix=/usr/local/mpc-1.1.0 --with-gmp=/usr/local/gmp-6.1.2 --with-mpfr=/usr/local/mpfr-4.0.2 --disable-shared && make && make install
```
12. 打开文件夹riscv-gnu-toolchain，新建工具链输出目录。
```
cd /opt && mkdir gcc_riscv32
```
13. 编译bintutils。
```
mkdir build_binutils && cd build_binutils && ../riscv-binutils-gdb/configure --prefix=/opt/gcc_riscv32 --target=riscv32-unknown-elf --with-arch=rv32imc --with-abi=ilp32 --disable-__cxa_atexit --disable-libgomp --disable-libmudflap --enable-libssp --disable-libstdcxx-pch --disable-nls --disable-shared --disable-threads --disable-multilib --enable-poison-system-directories --enable-languages=c,c++ --with-gnu-as --with-gnu-ld --with-newlib --with-system-zlib CFLAGS="-fstack-protector-strong -O2 -D_FORTIFY_SOURCE=2 -Wl,-z,relro,-z,now,-z,noexecstack -fPIE" CXXFLAGS="-fstack-protector-strong -O2 -D_FORTIFY_SOURCE=2 -Wl,-z,relro,-z,now,-z,noexecstack -fPIE" CXXFLAGS_FOR_TARGET="-Os -mcmodel=medlow -Wall -fstack-protector-strong -Wl,-z,relro,-z,now,-z,noexecstack -Wtrampolines -fno-short-enums -fno-short-wchar" CFLAGS_FOR_TARGET="-Os -mcmodel=medlow -Wall -fstack-protector-strong -Wl,-z,relro,-z,now,-z,noexecstack -Wtrampolines -fno-short-enums -fno-short-wchar" --bindir=/opt/gcc_riscv32/bin --libexecdir=/opt/gcc_riscv32/riscv32 --libdir=/opt/gcc_riscv32 --includedir=/opt/gcc_riscv32 && make -j16 && make install
```
14. 编译newlib。
```
mkdir build_newlib && cd build_newlib && ../riscv-newlib/configure --prefix=/opt/gcc_riscv32 --target=riscv32-unknown-elf --with-arch=rv32imc --with-abi=ilp32 --disable-__cxa_atexit --disable-libgomp --disable-libmudflap --enable-libssp --disable-libstdcxx-pch --disable-nls --disable-shared --disable-threads --disable-multilib --enable-poison-system-directories --enable-languages=c,c++ --with-gnu-as --with-gnu-ld --with-newlib --with-system-zlib CFLAGS="-fstack-protector-strong -O2 -D_FORTIFY_SOURCE=2 -Wl,-z,relro,-z,now,-z,noexecstack -fPIE" CXXFLAGS="-fstack-protector-strong -O2 -D_FORTIFY_SOURCE=2 -Wl,-z,relro,-z,now,-z,noexecstack -fPIE" \CXXFLAGS_FOR_TARGET="-Os -mcmodel=medlow -Wall -fstack-protector-strong -Wl,-z,relro,-z,now,-z,noexecstack -Wtrampolines -fno-short-enums -fno-short-wchar" CFLAGS_FOR_TARGET="-Os -mcmodel=medlow -Wall -fstack-protector-strong -Wl,-z,relro,-z,now,-z,noexecstack -Wtrampolines -fno-short-enums -fno-short-wchar" --bindir=/opt/gcc_riscv32/bin --libexecdir=/opt/gcc_riscv32 --libdir=/opt/gcc_riscv32 --includedir=/opt/gcc_riscv32 && make -j16 && make install
```
15. 编译gcc。
```
mkdir build_gcc && cd build_gcc && ../riscv-gcc/configure --prefix=/opt/gcc_riscv32 --target=riscv32-unknown-elf --with-arch=rv32imc --with-abi=ilp32 --disable-__cxa_atexit --disable-libgomp --disable-libmudflap --enable-libssp --disable-libstdcxx-pch --disable-nls --disable-shared --disable-threads --disable-multilib --enable-poison-system-directories --enable-languages=c,c++ --with-gnu-as --with-gnu-ld --with-newlib --with-system-zlib CFLAGS="-fstack-protector-strong -O2 -D_FORTIFY_SOURCE=2 -Wl,-z,relro,-z,now,-z,noexecstack -fPIE" CXXFLAGS="-fstack-protector-strong -O2 -D_FORTIFY_SOURCE=2 -Wl,-z,relro,-z,now,-z,noexecstack -fPIE" LDFLAGS="-Wl,-z,relro,-z,now,-z,noexecstack" CXXFLAGS_FOR_TARGET="-Os -mcmodel=medlow -Wall -fstack-protector-strong -Wl,-z,relro,-z,now,-z,noexecstack -Wtrampolines -fno-short-enums -fno-short-wchar" CFLAGS_FOR_TARGET="-Os -mcmodel=medlow -Wall -fstack-protector-strong -Wl,-z,relro,-z,now,-z,noexecstack -Wtrampolines -fno-short-enums -fno-short-wchar" --with-headers="/opt/gcc-riscv32/riscv32-unknown-elf/include" --with-mpc=/usr/local/mpc-1.1.0 --with-gmp=/usr/local/gmp-6.1.2 --with-mpfr=/usr/local/mpfr-4.0.2 && make -j16 && make install
```
16. 设置环境变量。
```
vim ~/.bashrc
```
将以下命令拷贝到.bashrc文件的最后一行，保存并退出。
```
export PATH=/opt/gcc_riscv32/bin:$PATH
```
17. 生效环境变量。
```
source ~/.bashrc
```
18. Shell命令行中输入如下命令，如果能正确显示编译器版本号，表明编译器安装成功。
```
riscv32-unknown-elf-gcc -v
```
## 安装Windows开发环境<a name="section1995840162515"></a>
OpenHarmony IDE工具DevEco Device Tool集成了终端工具的能力，工具的安装步骤请参考[DevEco Device Tool环境搭建](https://device.harmonyos.com/cn/docs/ide/user-guides/tool_install-0000001050164976)、[导入和配置工程](https://device.harmonyos.com/cn/docs/ide/user-guides/import_project-0000001050164980)完成。
quick-start/Readme-CN.md
浏览文件 @ 37cc208b
...@@ -2,21 +2,21 @@ ...@@ -2,21 +2,21 @@
- [Hi3861开发板](Hi3861开发板.md) - [Hi3861开发板](Hi3861开发板.md)
- [Hi3861开发板介绍](Hi3861开发板介绍.md) - [Hi3861开发板介绍](Hi3861开发板介绍.md)
- [搭建环境](搭建环境.md) - [Hi3861搭建环境](Hi3861搭建环境.md)
- [Hi3861开发板第一个示例程序](Hi3861开发板第一个示例程序.md) - [开发Hi3861第一个示例程序](开发Hi3861第一个示例程序.md)
- [Hi3861开发板第二个示例程序](Hi3861开发板第二个示例程序.md) - [开发Hi3861第二个示例程序](开发Hi3861第二个示例程序.md)
- [常见问题](常见问题.md) - [Hi3861常见问题](Hi3861常见问题.md)
- [Hi3516开发板](Hi3516开发板.md) - [Hi3516开发板](Hi3516开发板.md)
- [Hi3516开发板介绍](Hi3516开发板介绍.md) - [Hi3516开发板介绍](Hi3516开发板介绍.md)
- [搭建环境](搭建环境-0.md) - [Hi3516搭建环境](Hi3516搭建环境.md)
- [开发Hi3516第一个应用程序示例](开发Hi3516第一个应用程序示例.md) - [开发Hi3516第一个应用程序示例](开发Hi3516第一个应用程序示例.md)
- [开发Hi3516第一个驱动程序示例](开发Hi3516第一个驱动程序示例.md) - [开发Hi3516第一个驱动程序示例](开发Hi3516第一个驱动程序示例.md)
- [常见问题](常见问题-1.md) - [Hi3516常见问题](Hi3516常见问题.md)
- [Hi3518开发板](Hi3518开发板.md) - [Hi3518开发板](Hi3518开发板.md)
- [Hi3518开发板介绍](Hi3518开发板介绍.md) - [Hi3518开发板介绍](Hi3518开发板介绍.md)
- [搭建环境](搭建环境-2.md) - [Hi3518搭建环境](Hi3518搭建环境.md)
- [开发Hi3518第一个示例程序](开发Hi3518第一个示例程序.md) - [开发Hi3518第一个示例程序](开发Hi3518第一个示例程序.md)
- [常见问题](常见问题-3.md) - [Hi3518常见问题](Hi3518常见问题.md)
quick-start/开发Hi3516第一个应用程序示例.md
浏览文件 @ 37cc208b
...@@ -35,34 +35,36 @@ int main(int argc, char **argv) ...@@ -35,34 +35,36 @@ int main(int argc, char **argv)
## 编译<a name="section1077671315253"></a> ## 编译<a name="section1077671315253"></a>
在linux服务器上，进入源码包根目录，目录内存放有build.py编译脚本，执行如下脚本编译源码包。结果文件生成在out/ipcamera\_hi3516dv300目录下。 如果Linux编译环境通过Docker方式安装，具体编译过程请参见[Docker方式获取编译环境](../get-code/获取工具.md)的编译操作。如果Linux编译环境通过软件包方式安装，请进入源码根目录，执行如下命令进行编译：
``` ```
python build.py ipcamera_hi3516dv300 -b debug python build.py ipcamera_hi3516dv300 -b debug
``` ```
结果文件生成在out/ipcamera\_hi3516dv300目录下。
## 烧录<a name="section08153912587"></a> ## 烧录<a name="section08153912587"></a>
Hi3516开发板的代码烧录支持USB烧录、网口烧录和串口烧录三种方式。此处仅以网口烧录为例进行说明。 Hi3516开发板的代码烧录支持USB烧录、网口烧录和串口烧录三种方式。此处仅以网口烧录为例进行说明。
1. 请连接好电脑和待烧录开发板，以Hi3516DV300为例，需要同时连接串口、网口和电源，具体可参考[Hi3516开发板介绍](https://device.harmonyos.com/cn/docs/start/introduce/oem_camera_start_3516-0000001052670587)。 1. 请连接好电脑和待烧录开发板，以Hi3516DV300为例，需要同时连接串口、网口和电源，具体可参考[Hi3516开发板介绍](https://device.harmonyos.com/cn/docs/start/introduce/oem_camera_start_3516-0000001052670587)。
2. <a name="zh-cn_topic_0000001056443961_li142386399535"></a>打开电脑的设备管理器，查看并记录对应的串口号。 2. <a name="zh-cn_topic_0000001071634529_li142386399535"></a>打开电脑的设备管理器，查看并记录对应的串口号。
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
>如果对应的串口异常，请根据[Hi3516/Hi3518系列开发板串口驱动安装](https://device.harmonyos.com/cn/docs/ide/user-guides/hi3516_hi3518-drivers-0000001050743695)安装USB转串口的驱动程序。 >如果对应的串口异常，请根据[Hi3516/Hi3518系列开发板串口驱动安装](https://device.harmonyos.com/cn/docs/ide/user-guides/hi3516_hi3518-drivers-0000001050743695)安装USB转串口的驱动程序。
![](figures/zh-cn_image_0000001057235010.png) ![](figures/zh-cn_image_0000001071792503.png)
3. 点击“Configure \> Burn“，进入烧录配置界面，设置ARM系列芯片烧录信息。 3. 点击“Configure \> Burn“，进入烧录配置界面，设置ARM系列芯片烧录信息。
![](figures/zh-cn_image_0000001057354060.png) ![](figures/zh-cn_image_0000001071904255.png)
4. 选择烧录方式（Burning Mode），固定选择“network“。 4. 选择烧录方式（Burning Mode），固定选择“network“。
![](figures/网口烧录-1.png) ![](figures/网口烧录-1.png)
5. 设置网口烧录方式的烧录参数。 5. 设置网口烧录方式的烧录参数。
- 设置Port number，请选择[2](#zh-cn_topic_0000001056443961_li142386399535)中查询的串口号。 - 设置Port number，请选择[2](#zh-cn_topic_0000001071634529_li142386399535)中查询的串口号。
- 设置Baud rate和Data bits参数，已根据开发板进行适配，保持默认值即可。 - 设置Baud rate和Data bits参数，已根据开发板进行适配，保持默认值即可。
- 设置网络连接信息： - 设置网络连接信息：
...@@ -70,73 +72,73 @@ Hi3516开发板的代码烧录支持USB烧录、网口烧录和串口烧录三 ...@@ -70,73 +72,73 @@ Hi3516开发板的代码烧录支持USB烧录、网口烧录和串口烧录三
- Remote IP address：设置开发板的IP地址，工具自动设置。 - Remote IP address：设置开发板的IP地址，工具自动设置。
- Gateway：对应开发板的网关，工具自动设置。 - Gateway：对应开发板的网关，工具自动设置。
- Subnet mask：子网验码，工具自动设置。 - Subnet mask：子网验码，工具自动设置。
- MAC address of board：开发板的物理地址，请手动设置。 - MAC address of board：开发板的物理地址，请使用默认值即可。
![](figures/zh-cn_image_0000001057543065.png) ![](figures/zh-cn_image_0000001072552472.png)
- 设置器件类型（Memory Type），包括spi nor、spi nand和emmc，具体设置规则与硬件接收类型相关，请查阅随硬件发货的硬件说明书。例如Hi3516DV300固定设置为emmc。 - 设置器件类型（Memory Type），包括spi nor、spi nand和emmc，具体设置规则与硬件接收类型相关，请查阅随硬件发货的硬件说明书。例如Hi3516DV300固定设置为emmc。
- 设置烧录文件信息：请根据如下表格设置烧录文件，网口烧录方式，不支持烧录U-Boot文件。 - 设置烧录文件信息：请根据如下表格设置烧录文件，网口烧录方式，不支持烧录U-Boot文件。
<a name="zh-cn_topic_0000001056443961_table833816126143"></a> <a name="zh-cn_topic_0000001071634529_table833816126143"></a>
<table><thead align="left"><tr id="zh-cn_topic_0000001056443961_row123381912111410"><th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.1"><p id="zh-cn_topic_0000001056443961_p933816122140"><a name="zh-cn_topic_0000001056443961_p933816122140"></a><a name="zh-cn_topic_0000001056443961_p933816122140"></a>待烧录文件（File Name）</p> <table><thead align="left"><tr id="zh-cn_topic_0000001071634529_row123381912111410"><th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.1"><p id="zh-cn_topic_0000001071634529_p933816122140"><a name="zh-cn_topic_0000001071634529_p933816122140"></a><a name="zh-cn_topic_0000001071634529_p933816122140"></a>待烧录文件（File Name）</p>
</th> </th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.2"><p id="zh-cn_topic_0000001056443961_p1533819122144"><a name="zh-cn_topic_0000001056443961_p1533819122144"></a><a name="zh-cn_topic_0000001056443961_p1533819122144"></a>开始地址（Start Address）</p> <th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.2"><p id="zh-cn_topic_0000001071634529_p1533819122144"><a name="zh-cn_topic_0000001071634529_p1533819122144"></a><a name="zh-cn_topic_0000001071634529_p1533819122144"></a>开始地址（Start Address）</p>
</th> </th>
<th class="cellrowborder" valign="top" width="24.98%" id="mcps1.1.5.1.3"><p id="zh-cn_topic_0000001056443961_p1733831231411"><a name="zh-cn_topic_0000001056443961_p1733831231411"></a><a name="zh-cn_topic_0000001056443961_p1733831231411"></a>Flash地址块大小（File Size）</p> <th class="cellrowborder" valign="top" width="24.98%" id="mcps1.1.5.1.3"><p id="zh-cn_topic_0000001071634529_p1733831231411"><a name="zh-cn_topic_0000001071634529_p1733831231411"></a><a name="zh-cn_topic_0000001071634529_p1733831231411"></a>Flash地址块大小（File Size）</p>
</th> </th>
<th class="cellrowborder" valign="top" width="25.019999999999996%" id="mcps1.1.5.1.4"><p id="zh-cn_topic_0000001056443961_p1433851211145"><a name="zh-cn_topic_0000001056443961_p1433851211145"></a><a name="zh-cn_topic_0000001056443961_p1433851211145"></a>是否烧录（Enable）</p> <th class="cellrowborder" valign="top" width="25.019999999999996%" id="mcps1.1.5.1.4"><p id="zh-cn_topic_0000001071634529_p1433851211145"><a name="zh-cn_topic_0000001071634529_p1433851211145"></a><a name="zh-cn_topic_0000001071634529_p1433851211145"></a>是否烧录（Enable）</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="zh-cn_topic_0000001056443961_row6339412101413"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="zh-cn_topic_0000001056443961_p14339131221416"><a name="zh-cn_topic_0000001056443961_p14339131221416"></a><a name="zh-cn_topic_0000001056443961_p14339131221416"></a>OHOS_Image.bin</p> <tbody><tr id="zh-cn_topic_0000001071634529_row6339412101413"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="zh-cn_topic_0000001071634529_p14339131221416"><a name="zh-cn_topic_0000001071634529_p14339131221416"></a><a name="zh-cn_topic_0000001071634529_p14339131221416"></a>OHOS_Image.bin</p>
</td> </td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="zh-cn_topic_0000001056443961_p133901211419"><a name="zh-cn_topic_0000001056443961_p133901211419"></a><a name="zh-cn_topic_0000001056443961_p133901211419"></a>1M</p> <td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="zh-cn_topic_0000001071634529_p133901211419"><a name="zh-cn_topic_0000001071634529_p133901211419"></a><a name="zh-cn_topic_0000001071634529_p133901211419"></a>1M</p>
</td> </td>
<td class="cellrowborder" valign="top" width="24.98%" headers="mcps1.1.5.1.3 "><p id="zh-cn_topic_0000001056443961_p1533951261412"><a name="zh-cn_topic_0000001056443961_p1533951261412"></a><a name="zh-cn_topic_0000001056443961_p1533951261412"></a>9M</p> <td class="cellrowborder" valign="top" width="24.98%" headers="mcps1.1.5.1.3 "><p id="zh-cn_topic_0000001071634529_p1533951261412"><a name="zh-cn_topic_0000001071634529_p1533951261412"></a><a name="zh-cn_topic_0000001071634529_p1533951261412"></a>9M</p>
</td> </td>
<td class="cellrowborder" valign="top" width="25.019999999999996%" headers="mcps1.1.5.1.4 "><p id="zh-cn_topic_0000001056443961_p2574183818223"><a name="zh-cn_topic_0000001056443961_p2574183818223"></a><a name="zh-cn_topic_0000001056443961_p2574183818223"></a>第一次使用开发板烧录时，必须同时烧录；在后续烧录过程中，如果修改了内核和驱动相关内容，才需要烧录。</p> <td class="cellrowborder" valign="top" width="25.019999999999996%" headers="mcps1.1.5.1.4 "><p id="zh-cn_topic_0000001071634529_p2574183818223"><a name="zh-cn_topic_0000001071634529_p2574183818223"></a><a name="zh-cn_topic_0000001071634529_p2574183818223"></a>第一次使用开发板烧录时，必须同时烧录；在后续烧录过程中，如果修改了内核和驱动相关内容，才需要烧录。</p>
</td> </td>
</tr> </tr>
<tr id="zh-cn_topic_0000001056443961_row533914120143"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="zh-cn_topic_0000001056443961_p8339112111412"><a name="zh-cn_topic_0000001056443961_p8339112111412"></a><a name="zh-cn_topic_0000001056443961_p8339112111412"></a>rootfs.img</p> <tr id="zh-cn_topic_0000001071634529_row533914120143"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="zh-cn_topic_0000001071634529_p8339112111412"><a name="zh-cn_topic_0000001071634529_p8339112111412"></a><a name="zh-cn_topic_0000001071634529_p8339112111412"></a>rootfs.img</p>
</td> </td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="zh-cn_topic_0000001056443961_p733921271410"><a name="zh-cn_topic_0000001056443961_p733921271410"></a><a name="zh-cn_topic_0000001056443961_p733921271410"></a>10M</p> <td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="zh-cn_topic_0000001071634529_p733921271410"><a name="zh-cn_topic_0000001071634529_p733921271410"></a><a name="zh-cn_topic_0000001071634529_p733921271410"></a>10M</p>
</td> </td>
<td class="cellrowborder" valign="top" width="24.98%" headers="mcps1.1.5.1.3 "><p id="zh-cn_topic_0000001056443961_p13339181214145"><a name="zh-cn_topic_0000001056443961_p13339181214145"></a><a name="zh-cn_topic_0000001056443961_p13339181214145"></a>15M</p> <td class="cellrowborder" valign="top" width="24.98%" headers="mcps1.1.5.1.3 "><p id="zh-cn_topic_0000001071634529_p13339181214145"><a name="zh-cn_topic_0000001071634529_p13339181214145"></a><a name="zh-cn_topic_0000001071634529_p13339181214145"></a>15M</p>
</td> </td>
<td class="cellrowborder" rowspan="2" valign="top" width="25.019999999999996%" headers="mcps1.1.5.1.4 "><p id="zh-cn_topic_0000001056443961_p233901211146"><a name="zh-cn_topic_0000001056443961_p233901211146"></a><a name="zh-cn_topic_0000001056443961_p233901211146"></a>第一次使用开发板烧录时，必须同时烧录；在后续烧录过程中，如果这两个文件未做修改，可以不烧录。建议每次烧录时，都烧录这两个文件。</p> <td class="cellrowborder" rowspan="2" valign="top" width="25.019999999999996%" headers="mcps1.1.5.1.4 "><p id="zh-cn_topic_0000001071634529_p233901211146"><a name="zh-cn_topic_0000001071634529_p233901211146"></a><a name="zh-cn_topic_0000001071634529_p233901211146"></a>第一次使用开发板烧录时，必须同时烧录；在后续烧录过程中，如果这两个文件未做修改，可以不烧录。建议每次烧录时，都烧录这两个文件。</p>
</td> </td>
</tr> </tr>
<tr id="zh-cn_topic_0000001056443961_row1333901281418"><td class="cellrowborder" valign="top" headers="mcps1.1.5.1.1 "><p id="zh-cn_topic_0000001056443961_p53391912131416"><a name="zh-cn_topic_0000001056443961_p53391912131416"></a><a name="zh-cn_topic_0000001056443961_p53391912131416"></a>userfs.img</p> <tr id="zh-cn_topic_0000001071634529_row1333901281418"><td class="cellrowborder" valign="top" headers="mcps1.1.5.1.1 "><p id="zh-cn_topic_0000001071634529_p53391912131416"><a name="zh-cn_topic_0000001071634529_p53391912131416"></a><a name="zh-cn_topic_0000001071634529_p53391912131416"></a>userfs.img</p>
</td> </td>
<td class="cellrowborder" valign="top" headers="mcps1.1.5.1.2 "><p id="zh-cn_topic_0000001056443961_p193391612161414"><a name="zh-cn_topic_0000001056443961_p193391612161414"></a><a name="zh-cn_topic_0000001056443961_p193391612161414"></a>25M</p> <td class="cellrowborder" valign="top" headers="mcps1.1.5.1.2 "><p id="zh-cn_topic_0000001071634529_p193391612161414"><a name="zh-cn_topic_0000001071634529_p193391612161414"></a><a name="zh-cn_topic_0000001071634529_p193391612161414"></a>25M</p>
</td> </td>
<td class="cellrowborder" valign="top" headers="mcps1.1.5.1.3 "><p id="zh-cn_topic_0000001056443961_p433918121148"><a name="zh-cn_topic_0000001056443961_p433918121148"></a><a name="zh-cn_topic_0000001056443961_p433918121148"></a>50M</p> <td class="cellrowborder" valign="top" headers="mcps1.1.5.1.3 "><p id="zh-cn_topic_0000001071634529_p433918121148"><a name="zh-cn_topic_0000001071634529_p433918121148"></a><a name="zh-cn_topic_0000001071634529_p433918121148"></a>50M</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
![](figures/zh-cn_image_0000001057621705.png) ![](figures/zh-cn_image_0000001071514639.png)
6. 修改了相关配置后，请点击最下方的“Save“进行保存。 6. 修改了相关配置后，请点击最下方的“Save“进行保存。
7. 在DevEco Device Tool中，点击Burn后的![](figures/zh-cn_image_0000001057097113.png)按钮开始烧录。 7. 在DevEco Device Tool中，点击Burn后的![](figures/zh-cn_image_0000001072074632.png)按钮开始烧录。
![](figures/zh-cn_image_0000001057911116.png) ![](figures/zh-cn_image_0000001071634537.png)
8. 请在15秒内手动重启开发板\(下电再上电\)。 8. 请在15秒内手动重启开发板\(下电再上电\)。
9. 等待烧录完成，当控制台输出如下信息时，表示烧录成功。 9. 等待烧录完成，当控制台输出如下信息时，表示烧录成功。
![](figures/zh-cn_image_0000001056648688.png) ![](figures/zh-cn_image_0000001071984311.png)
10. 如果第一次使用开发板，需要使用[串口工具](zh-cn_topic_0000001057649420.md)修改U-boot的bootcmd及bootargs内容，具体可参考[Hi3516开发板镜像运行](https://device.harmonyos.com/cn/docs/start/introduce/oem_camera_start_first_example-0000001051610926#ZH-CN_TOPIC_0000001052906247__section380511712615)。 10. 如果第一次使用开发板，需要使用[串口工具](https://device.harmonyos.com/cn/docs/ide/user-guides/serial_port-0000001057649420)修改U-boot的bootcmd及bootargs内容，具体可参考[Hi3516开发板镜像运行](https://device.harmonyos.com/cn/docs/start/introduce/oem_camera_start_first_example-0000001051610926#ZH-CN_TOPIC_0000001052906247__section380511712615)。
## 镜像运行<a name="section380511712615"></a> ## 镜像运行<a name="section380511712615"></a>
1. 连接串口。 1. 连接串口。
>![](public_sys-resources/icon-notice.gif) **须知：** >![](public_sys-resources/icon-notice.gif) **须知：**
>若无法连接串口，请参考[常见问题](常见问题-1.md#section14871149155911)进行排查。 >若无法连接串口，请参考[常见问题](Hi3516常见问题.md#section14871149155911)进行排查。
**图 1** 连接串口图<a name="fig056645018495"></a> **图 1** 连接串口图<a name="fig056645018495"></a>
......
quick-start/开发Hi3516第一个驱动程序示例.md
浏览文件 @ 37cc208b
...@@ -434,7 +434,7 @@ ...@@ -434,7 +434,7 @@
1. 连接串口。 1. 连接串口。
>![](public_sys-resources/icon-notice.gif) **须知：** >![](public_sys-resources/icon-notice.gif) **须知：**
>若无法连接串口，请参考[常见问题](常见问题-1.md#section14871149155911)进行排查。 >若无法连接串口，请参考[常见问题](Hi3516常见问题.md#section14871149155911)进行排查。
**图 1** 连接串口图<a name="zh-cn_topic_0000001052906247_fig056645018495"></a> **图 1** 连接串口图<a name="zh-cn_topic_0000001052906247_fig056645018495"></a>
......
quick-start/开发Hi3518第一个示例程序.md
浏览文件 @ 37cc208b
...@@ -35,121 +35,123 @@ int main(int argc, char **argv) ...@@ -35,121 +35,123 @@ int main(int argc, char **argv)
## 编译<a name="section234175193114"></a> ## 编译<a name="section234175193114"></a>
在Linux服务器上，进入源码包根目录，执行如下脚本编译源码包。结果文件生成在out/ipcamera\_hi3518ev300目录下。 如果Linux编译环境通过Docker方式安装，具体编译过程请参见[Docker方式获取编译环境](../get-code/获取工具.md)的编译操作。如果Linux编译环境通过软件包方式安装，进入源码根目录，执行如下命令进行编译：
``` ```
python build.py ipcamera_hi3518ev300 -b debug python build.py ipcamera_hi3518ev300 -b debug
``` ```
结果文件生成在out/ipcamera\_hi3518ev300目录下。
## 烧录<a name="section57955241588"></a> ## 烧录<a name="section57955241588"></a>
Hi3518开发板的代码烧录仅支持USB烧录方式。 Hi3518开发板的代码烧录仅支持USB烧录方式。
1. 请连接好电脑和待烧录开发板，以Hi3518EV300为例，需要同时连接串口和USB口，具体可参考[Hi3518开发板介绍](https://device.harmonyos.com/cn/docs/start/introduce/oem_camera_start_hi3518-0000001050170473)。 1. 请连接好电脑和待烧录开发板，以Hi3518EV300为例，需要同时连接串口和USB口，具体可参考[Hi3518开发板介绍](https://device.harmonyos.com/cn/docs/start/introduce/oem_camera_start_hi3518-0000001050170473)。
2. <a name="zh-cn_topic_0000001057313128_li101031912111518"></a>打开电脑的设备管理器，查看并记录对应的串口号。 2. <a name="zh-cn_topic_0000001072392860_li101031912111518"></a>打开电脑的设备管理器，查看并记录对应的串口号。
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
>如果对应的串口异常，请根据[Hi3516/Hi3518系列开发板串口驱动安装](https://device.harmonyos.com/cn/docs/ide/user-guides/hi3516_hi3518-drivers-0000001050743695)安装USB转串口的驱动程序。 >如果对应的串口异常，请根据[Hi3516/Hi3518系列开发板串口驱动安装](https://device.harmonyos.com/cn/docs/ide/user-guides/hi3516_hi3518-drivers-0000001050743695)安装USB转串口的驱动程序。
![](figures/zh-cn_image_0000001057235010.png) ![](figures/zh-cn_image_0000001071792503.png)
3. 点击“Device Tool \> Configure \> Burn”进入烧录配置界面，设置Hi3518系列开发板烧录信息。 3. 点击“Device Tool \> Configure \> Burn”进入烧录配置界面，设置Hi3518系列开发板烧录信息。
![](figures/zh-cn_image_0000001057194144.png) ![](figures/zh-cn_image_0000001071514657.png)
4. 选择烧录方式（Burning Mode），固定选择“usbport”。 4. 选择烧录方式（Burning Mode），固定选择“usbport”。
![](figures/zh-cn_image_0000001057392985.png) ![](figures/zh-cn_image_0000001072552464.png)
5. 设置USB烧录的烧录参数。 5. 设置USB烧录的烧录参数。
- 设置Port number，请选择[2](#zh-cn_topic_0000001057313128_li101031912111518)中查询的串口号。 - 设置Port number，请选择[2](#zh-cn_topic_0000001072392860_li101031912111518)中查询的串口号。
- 设置Baud Rate和Data Bits参数，已根据开发板进行适配，保持默认值即可。 - 设置Baud Rate和Data Bits参数，已根据开发板进行适配，保持默认值即可。
- 设置器件类型（Memory Type），Hi3518系列开发板固定设置为spi nor。 - 设置器件类型（Memory Type），Hi3518系列开发板固定设置为spi nor。
- 设置烧录文件信息：请根据如下表格设置烧录文件。 - 设置烧录文件信息：请根据如下表格设置烧录文件。
<a name="zh-cn_topic_0000001057313128_table17829824143410"></a> <a name="zh-cn_topic_0000001072392860_table17829824143410"></a>
<table><thead align="left"><tr id="zh-cn_topic_0000001057313128_row1782992414343"><th class="cellrowborder" valign="top" width="25.130000000000003%" id="mcps1.1.5.1.1"><p id="zh-cn_topic_0000001057313128_p198641828133419"><a name="zh-cn_topic_0000001057313128_p198641828133419"></a><a name="zh-cn_topic_0000001057313128_p198641828133419"></a>待烧录文件（File Name）</p> <table><thead align="left"><tr id="zh-cn_topic_0000001072392860_row1782992414343"><th class="cellrowborder" valign="top" width="25.130000000000003%" id="mcps1.1.5.1.1"><p id="zh-cn_topic_0000001072392860_p198641828133419"><a name="zh-cn_topic_0000001072392860_p198641828133419"></a><a name="zh-cn_topic_0000001072392860_p198641828133419"></a>待烧录文件（File Name）</p>
</th> </th>
<th class="cellrowborder" valign="top" width="24.87%" id="mcps1.1.5.1.2"><p id="zh-cn_topic_0000001057313128_p086415289344"><a name="zh-cn_topic_0000001057313128_p086415289344"></a><a name="zh-cn_topic_0000001057313128_p086415289344"></a>开始地址（Start Address）</p> <th class="cellrowborder" valign="top" width="24.87%" id="mcps1.1.5.1.2"><p id="zh-cn_topic_0000001072392860_p086415289344"><a name="zh-cn_topic_0000001072392860_p086415289344"></a><a name="zh-cn_topic_0000001072392860_p086415289344"></a>开始地址（Start Address）</p>
</th> </th>
<th class="cellrowborder" valign="top" width="24.98%" id="mcps1.1.5.1.3"><p id="zh-cn_topic_0000001057313128_p986462863413"><a name="zh-cn_topic_0000001057313128_p986462863413"></a><a name="zh-cn_topic_0000001057313128_p986462863413"></a>Flash地址块大小（File Size）</p> <th class="cellrowborder" valign="top" width="24.98%" id="mcps1.1.5.1.3"><p id="zh-cn_topic_0000001072392860_p986462863413"><a name="zh-cn_topic_0000001072392860_p986462863413"></a><a name="zh-cn_topic_0000001072392860_p986462863413"></a>Flash地址块大小（File Size）</p>
</th> </th>
<th class="cellrowborder" valign="top" width="25.019999999999996%" id="mcps1.1.5.1.4"><p id="zh-cn_topic_0000001057313128_p58291224193410"><a name="zh-cn_topic_0000001057313128_p58291224193410"></a><a name="zh-cn_topic_0000001057313128_p58291224193410"></a>是否烧录（Enable）</p> <th class="cellrowborder" valign="top" width="25.019999999999996%" id="mcps1.1.5.1.4"><p id="zh-cn_topic_0000001072392860_p58291224193410"><a name="zh-cn_topic_0000001072392860_p58291224193410"></a><a name="zh-cn_topic_0000001072392860_p58291224193410"></a>是否烧录（Enable）</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="zh-cn_topic_0000001057313128_row4829112453415"><td class="cellrowborder" valign="top" width="25.130000000000003%" headers="mcps1.1.5.1.1 "><p id="zh-cn_topic_0000001057313128_p18829162417342"><a name="zh-cn_topic_0000001057313128_p18829162417342"></a><a name="zh-cn_topic_0000001057313128_p18829162417342"></a>u-boot-开发板名称.bin</p> <tbody><tr id="zh-cn_topic_0000001072392860_row4829112453415"><td class="cellrowborder" valign="top" width="25.130000000000003%" headers="mcps1.1.5.1.1 "><p id="zh-cn_topic_0000001072392860_p18829162417342"><a name="zh-cn_topic_0000001072392860_p18829162417342"></a><a name="zh-cn_topic_0000001072392860_p18829162417342"></a>u-boot-开发板名称.bin</p>
</td> </td>
<td class="cellrowborder" valign="top" width="24.87%" headers="mcps1.1.5.1.2 "><p id="zh-cn_topic_0000001057313128_p38298241348"><a name="zh-cn_topic_0000001057313128_p38298241348"></a><a name="zh-cn_topic_0000001057313128_p38298241348"></a>0</p> <td class="cellrowborder" valign="top" width="24.87%" headers="mcps1.1.5.1.2 "><p id="zh-cn_topic_0000001072392860_p38298241348"><a name="zh-cn_topic_0000001072392860_p38298241348"></a><a name="zh-cn_topic_0000001072392860_p38298241348"></a>0</p>
</td> </td>
<td class="cellrowborder" valign="top" width="24.98%" headers="mcps1.1.5.1.3 "><p id="zh-cn_topic_0000001057313128_p18295244345"><a name="zh-cn_topic_0000001057313128_p18295244345"></a><a name="zh-cn_topic_0000001057313128_p18295244345"></a>1M</p> <td class="cellrowborder" valign="top" width="24.98%" headers="mcps1.1.5.1.3 "><p id="zh-cn_topic_0000001072392860_p18295244345"><a name="zh-cn_topic_0000001072392860_p18295244345"></a><a name="zh-cn_topic_0000001072392860_p18295244345"></a>1M</p>
</td> </td>
<td class="cellrowborder" valign="top" width="25.019999999999996%" headers="mcps1.1.5.1.4 "><p id="zh-cn_topic_0000001057313128_p1282982415342"><a name="zh-cn_topic_0000001057313128_p1282982415342"></a><a name="zh-cn_topic_0000001057313128_p1282982415342"></a>是</p> <td class="cellrowborder" valign="top" width="25.019999999999996%" headers="mcps1.1.5.1.4 "><p id="zh-cn_topic_0000001072392860_p1282982415342"><a name="zh-cn_topic_0000001072392860_p1282982415342"></a><a name="zh-cn_topic_0000001072392860_p1282982415342"></a>是</p>
</td> </td>
</tr> </tr>
<tr id="zh-cn_topic_0000001057313128_row8829192415342"><td class="cellrowborder" valign="top" width="25.130000000000003%" headers="mcps1.1.5.1.1 "><p id="zh-cn_topic_0000001057313128_p1782912420346"><a name="zh-cn_topic_0000001057313128_p1782912420346"></a><a name="zh-cn_topic_0000001057313128_p1782912420346"></a>OHOS_Image.bin</p> <tr id="zh-cn_topic_0000001072392860_row8829192415342"><td class="cellrowborder" valign="top" width="25.130000000000003%" headers="mcps1.1.5.1.1 "><p id="zh-cn_topic_0000001072392860_p1782912420346"><a name="zh-cn_topic_0000001072392860_p1782912420346"></a><a name="zh-cn_topic_0000001072392860_p1782912420346"></a>OHOS_Image.bin</p>
</td> </td>
<td class="cellrowborder" valign="top" width="24.87%" headers="mcps1.1.5.1.2 "><p id="zh-cn_topic_0000001057313128_p1483012483410"><a name="zh-cn_topic_0000001057313128_p1483012483410"></a><a name="zh-cn_topic_0000001057313128_p1483012483410"></a>1M</p> <td class="cellrowborder" valign="top" width="24.87%" headers="mcps1.1.5.1.2 "><p id="zh-cn_topic_0000001072392860_p1483012483410"><a name="zh-cn_topic_0000001072392860_p1483012483410"></a><a name="zh-cn_topic_0000001072392860_p1483012483410"></a>1M</p>
</td> </td>
<td class="cellrowborder" valign="top" width="24.98%" headers="mcps1.1.5.1.3 "><p id="zh-cn_topic_0000001057313128_p1283032433419"><a name="zh-cn_topic_0000001057313128_p1283032433419"></a><a name="zh-cn_topic_0000001057313128_p1283032433419"></a>6M</p> <td class="cellrowborder" valign="top" width="24.98%" headers="mcps1.1.5.1.3 "><p id="zh-cn_topic_0000001072392860_p1283032433419"><a name="zh-cn_topic_0000001072392860_p1283032433419"></a><a name="zh-cn_topic_0000001072392860_p1283032433419"></a>6M</p>
</td> </td>
<td class="cellrowborder" valign="top" width="25.019999999999996%" headers="mcps1.1.5.1.4 "><p id="zh-cn_topic_0000001057313128_p17830524163416"><a name="zh-cn_topic_0000001057313128_p17830524163416"></a><a name="zh-cn_topic_0000001057313128_p17830524163416"></a>第一次使用开发板烧录时，必须同时烧录；在后续烧录过程中，如果修改了内核和驱动相关内容，才需要烧录。</p> <td class="cellrowborder" valign="top" width="25.019999999999996%" headers="mcps1.1.5.1.4 "><p id="zh-cn_topic_0000001072392860_p17830524163416"><a name="zh-cn_topic_0000001072392860_p17830524163416"></a><a name="zh-cn_topic_0000001072392860_p17830524163416"></a>第一次使用开发板烧录时，必须同时烧录；在后续烧录过程中，如果修改了内核和驱动相关内容，才需要烧录。</p>
</td> </td>
</tr> </tr>
<tr id="zh-cn_topic_0000001057313128_row18830192453415"><td class="cellrowborder" valign="top" width="25.130000000000003%" headers="mcps1.1.5.1.1 "><p id="zh-cn_topic_0000001057313128_p0830162453411"><a name="zh-cn_topic_0000001057313128_p0830162453411"></a><a name="zh-cn_topic_0000001057313128_p0830162453411"></a>rootfs.img</p> <tr id="zh-cn_topic_0000001072392860_row18830192453415"><td class="cellrowborder" valign="top" width="25.130000000000003%" headers="mcps1.1.5.1.1 "><p id="zh-cn_topic_0000001072392860_p0830162453411"><a name="zh-cn_topic_0000001072392860_p0830162453411"></a><a name="zh-cn_topic_0000001072392860_p0830162453411"></a>rootfs.img</p>
</td> </td>
<td class="cellrowborder" valign="top" width="24.87%" headers="mcps1.1.5.1.2 "><p id="zh-cn_topic_0000001057313128_p7830424133418"><a name="zh-cn_topic_0000001057313128_p7830424133418"></a><a name="zh-cn_topic_0000001057313128_p7830424133418"></a>7M</p> <td class="cellrowborder" valign="top" width="24.87%" headers="mcps1.1.5.1.2 "><p id="zh-cn_topic_0000001072392860_p7830424133418"><a name="zh-cn_topic_0000001072392860_p7830424133418"></a><a name="zh-cn_topic_0000001072392860_p7830424133418"></a>7M</p>
</td> </td>
<td class="cellrowborder" valign="top" width="24.98%" headers="mcps1.1.5.1.3 "><p id="zh-cn_topic_0000001057313128_p1583012413417"><a name="zh-cn_topic_0000001057313128_p1583012413417"></a><a name="zh-cn_topic_0000001057313128_p1583012413417"></a>8M</p> <td class="cellrowborder" valign="top" width="24.98%" headers="mcps1.1.5.1.3 "><p id="zh-cn_topic_0000001072392860_p1583012413417"><a name="zh-cn_topic_0000001072392860_p1583012413417"></a><a name="zh-cn_topic_0000001072392860_p1583012413417"></a>8M</p>
</td> </td>
<td class="cellrowborder" rowspan="2" valign="top" width="25.019999999999996%" headers="mcps1.1.5.1.4 "><p id="zh-cn_topic_0000001057313128_p166645916376"><a name="zh-cn_topic_0000001057313128_p166645916376"></a><a name="zh-cn_topic_0000001057313128_p166645916376"></a>第一次使用开发板烧录时，必须同时烧录；在后续烧录过程中，如果这两个文件未做修改，可以不烧录。建议每次烧录时，都烧录这两个文件。</p> <td class="cellrowborder" rowspan="2" valign="top" width="25.019999999999996%" headers="mcps1.1.5.1.4 "><p id="zh-cn_topic_0000001072392860_p166645916376"><a name="zh-cn_topic_0000001072392860_p166645916376"></a><a name="zh-cn_topic_0000001072392860_p166645916376"></a>第一次使用开发板烧录时，必须同时烧录；在后续烧录过程中，如果这两个文件未做修改，可以不烧录。建议每次烧录时，都烧录这两个文件。</p>
</td> </td>
</tr> </tr>
<tr id="zh-cn_topic_0000001057313128_row38301424183414"><td class="cellrowborder" valign="top" headers="mcps1.1.5.1.1 "><p id="zh-cn_topic_0000001057313128_p983032415348"><a name="zh-cn_topic_0000001057313128_p983032415348"></a><a name="zh-cn_topic_0000001057313128_p983032415348"></a>userfs.img</p> <tr id="zh-cn_topic_0000001072392860_row38301424183414"><td class="cellrowborder" valign="top" headers="mcps1.1.5.1.1 "><p id="zh-cn_topic_0000001072392860_p983032415348"><a name="zh-cn_topic_0000001072392860_p983032415348"></a><a name="zh-cn_topic_0000001072392860_p983032415348"></a>userfs.img</p>
</td> </td>
<td class="cellrowborder" valign="top" headers="mcps1.1.5.1.2 "><p id="zh-cn_topic_0000001057313128_p783016244344"><a name="zh-cn_topic_0000001057313128_p783016244344"></a><a name="zh-cn_topic_0000001057313128_p783016244344"></a>15M</p> <td class="cellrowborder" valign="top" headers="mcps1.1.5.1.2 "><p id="zh-cn_topic_0000001072392860_p783016244344"><a name="zh-cn_topic_0000001072392860_p783016244344"></a><a name="zh-cn_topic_0000001072392860_p783016244344"></a>15M</p>
</td> </td>
<td class="cellrowborder" valign="top" headers="mcps1.1.5.1.3 "><p id="zh-cn_topic_0000001057313128_p2830142412349"><a name="zh-cn_topic_0000001057313128_p2830142412349"></a><a name="zh-cn_topic_0000001057313128_p2830142412349"></a>1M</p> <td class="cellrowborder" valign="top" headers="mcps1.1.5.1.3 "><p id="zh-cn_topic_0000001072392860_p2830142412349"><a name="zh-cn_topic_0000001072392860_p2830142412349"></a><a name="zh-cn_topic_0000001072392860_p2830142412349"></a>1M</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
![](figures/zh-cn_image_0000001057952739.png) ![](figures/zh-cn_image_0000001071634551.png)
6. 修改了相关配置后，请点击最下方的“Save”进行保存。 6. 修改了相关配置后，请点击最下方的“Save”进行保存。
7. 在DevEco Device Tool中，点击Burn后的![](figures/zh-cn_image_0000001057311476.png)按钮开始烧录。 7. 在DevEco Device Tool中，点击Burn后的![](figures/zh-cn_image_0000001071984309.png)按钮开始烧录。
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
>如果您是第一次在工作台烧录Hi3516/Hi3518系列开发板，可能烧录失败，提示“not find the Devices”，请根据[Hi3516/Hi3518系列开发板USB驱动安装](https://device.harmonyos.com/cn/docs/ide/user-guides/usb_driver-0000001058690393)进行处理后再重新烧录。 >如果您是第一次在工作台烧录Hi3516/Hi3518系列开发板，可能烧录失败，提示“not find the Devices”，请根据[Hi3516/Hi3518系列开发板USB驱动安装](https://device.harmonyos.com/cn/docs/ide/user-guides/usb_driver-0000001058690393)进行处理后再重新烧录。
![](figures/zh-cn_image_0000001058192356.png) ![](figures/zh-cn_image_0000001071904257.png)
8. 请在15秒内手动重启开发板\(下电再上电\)。 8. 请在15秒内手动重启开发板\(下电再上电\)。
9. 等待烧录完成，当控制台输出如下信息时，表示烧录成功。 9. 等待烧录完成，当控制台输出如下信息时，表示烧录成功。
![](figures/USB烧录-6.png) ![](figures/USB烧录-6.png)
10. 每次烧录U-boot后，需要使用[串口工具](zh-cn_topic_0000001057649420.md)修改U-boot的bootcmd及bootargs内容，具体可参考[Hi3518开发板镜像运行](https://device.harmonyos.com/cn/docs/start/introduce/oem_camera_start_example-0000001051610926#ZH-CN_TOPIC_0000001053422339__section62131033183710)。 10. 每次烧录U-boot后，需要使用[串口工具](https://device.harmonyos.com/cn/docs/ide/user-guides/serial_port-0000001057649420)修改U-boot的bootcmd及bootargs内容，具体可参考[Hi3518开发板镜像运行](https://device.harmonyos.com/cn/docs/start/introduce/oem_camera_start_example-0000001051610926#ZH-CN_TOPIC_0000001053422339__section62131033183710)。
## 镜像运行<a name="section62131033183710"></a> ## 镜像运行<a name="section62131033183710"></a>
1. 连接串口。 1. 连接串口。
>![](public_sys-resources/icon-notice.gif) **须知：** >![](public_sys-resources/icon-notice.gif) **须知：**
>若无法连接串口，请参考[常见问题](常见问题-3.md#zh-cn_topic_0000001053466255_section14871149155911)进行排查。 >若无法连接串口，请参考[常见问题](Hi3518常见问题.md#zh-cn_topic_0000001053466255_section14871149155911)进行排查。
**图 1** 连接串口图<a name="fig056645018495"></a> **图 1** 连接串口图<a name="fig056645018495"></a>
![](figures/chuankou1-1.png) ![](figures/chuankou1-0.png)
1. 单击**Serial port**打开串口。 1. 单击**Serial port**打开串口。
2. 输入串口编号\(按照烧录步骤中查询的串口号，此处以com11举例\)，并连续输入回车直到串口显示"hisillicon"。 2. 输入串口编号\(按照烧录步骤中查询的串口号，此处以com11举例\)，并连续输入回车直到串口显示"hisillicon"。
3. 单板初次启动或修改启动参数，请进入[步骤2](#l5b42e79a33ea4d35982b78a22913b0b1)，否则进入[步骤3](#ld26f18828aa44c36bfa36be150e60e49)。 3. 单板初次启动或修改启动参数，请进入[步骤2](#li9441185382314)，否则进入[步骤3](#li6442853122312)。
2. （初次烧写必选）修改U-boot的bootcmd及bootargs内容：该步骤为固化操作，可保存执行结果，但U-boot重新烧入，则需要再次执行下述步骤。 2. <a name="li9441185382314"></a>（初次烧写必选）修改U-boot的bootcmd及bootargs内容：该步骤为固化操作，可保存执行结果，但U-boot重新烧入，则需要再次执行下述步骤。
**表 1** U-boot修改命令 **表 1** U-boot修改命令
...@@ -191,7 +193,7 @@ Hi3518开发板的代码烧录仅支持USB烧录方式。 ...@@ -191,7 +193,7 @@ Hi3518开发板的代码烧录仅支持USB烧录方式。
>![](public_sys-resources/icon-notice.gif) **须知：** >![](public_sys-resources/icon-notice.gif) **须知：**
>**“go 0x40000000”**为可选指令，默认配置已将该指令固化在启动参数中，单板复位后可自动启动。若想切换为手动启动，可在U-boot启动倒数阶段使用"回车"打断自动启动。 >**“go 0x40000000”**为可选指令，默认配置已将该指令固化在启动参数中，单板复位后可自动启动。若想切换为手动启动，可在U-boot启动倒数阶段使用"回车"打断自动启动。
3. 若启动时显示**"hisilicon \#**字样，请输入**“reset”**指令，等待系统自启动进入系统，系统启动后，显示**“OHOS”**字样，输入**”./bin/camera\_app”**并回车，显示成功结果如下图所示。 3. <a name="li6442853122312"></a>若启动时显示**"hisilicon \#**字样，请输入**“reset”**指令，等待系统自启动进入系统，系统启动后，显示**“OHOS”**字样，输入**”./bin/camera\_app”**并回车，显示成功结果如下图所示。
**图 2** 启动成功并执行应用程序图<a name="fig11838403383"></a> **图 2** 启动成功并执行应用程序图<a name="fig11838403383"></a>
![](figures/启动成功并执行应用程序图.png "启动成功并执行应用程序图") ![](figures/启动成功并执行应用程序图.png "启动成功并执行应用程序图")
......
quick-start/开发Hi3861第一个示例程序.md 0 → 100644
浏览文件 @ 37cc208b
# 开发Hi3861第一个示例程序<a name="ZH-CN_TOPIC_0000001053302600"></a>
- [源码获取](#section1545225464016)
- [源码编译](#section1736014117148)
- [镜像烧录](#section1610612214150)
- [WLAN模组联网](#section168257461059)
本示例将演示如何通过AT命令完成WLAN模组与网关联网。
## 源码获取<a name="section1545225464016"></a>
开发者需要在Linux服务器上下载并解压一套源代码，获取Hi3861源码（[下载链接](https://repo.huaweicloud.com/harmonyos/os/1.0/code-1.0.tar.gz)）。更多源码获取方式，请见[源码获取](../get-code/源码获取.md)。
## 源码编译<a name="section1736014117148"></a>
本节描述如何在Linux服务器上进行WLAN模组版本的编译。
如果Linux编译环境通过Docker方式安装，具体编译过程请参见[Docker方式获取编译环境](../get-code/获取工具.md)的编译操作。如果Linux编译环境通过软件包方式安装，请参考如下步骤。
1. 打开DevEco Device Tool工具，点击“View \> Terminal”，进入终端界面。
**图 1** IDE终端工具打开方法<a name="fig1975813338510"></a>
![](figures/zh-cn_image_0000001055040538.png)
在终端界面使用ssh命令连接linux服务器，如“ssh _user_@_ipaddr_”。
**图 2** 终端界面示意图<a name="fig91165301546"></a>
![](figures/zh-cn_image_0000001054599199.png)
2. 进入代码根路径，并在终端窗口，执行编译脚本命令启动编译“python build.py wifiiot”。
**图 3** 在终端界面执行编译命令示意图<a name="fig17727115215612"></a>
![](figures/zh-cn_image_0000001055040596.png)
3. 编译结束后，如果出现“BUILD SUCCESS”字样，则证明构建成功，如下图所示。
**图 4** 编译成功示意图<a name="fig1262101218463"></a>
![](figures/编译成功示意图.png "编译成功示意图")
4. 构建成功后，会在./out/wifiiot/路径中生成以下文件，使用如下命令可以查看，至此编译构建流程结束。
```
ls -l out/wifiiot
```
**图 5** 编译文件存放目录示意图<a name="fig38521346164618"></a>
![](figures/zh-cn_image_0000001055040654.png)
## 镜像烧录<a name="section1610612214150"></a>
Hi3861 WLAN模组的镜像烧录可以通过OpenHarmony IDE工具DevEco完成，工具的基本使用请参考[DevEco Device Tool使用指南](https://device.harmonyos.com/cn/docs/ide/user-guides/service_introduction-0000001050166905)，烧录过程包含如下步骤。
1. 使用USB线连接Windows工作台和WLAN模组。
2. [下载USB转串口驱动](http://www.wch.cn/downloads/CH341SER_EXE.html)，安装USB转串口驱动。
3. 查询设备管理器上的COM口，如CH340\(COM11\)。该串口集成了烧录、日志打印、AT命令等功能。
**图 6** 设备管理器的COM口示意图<a name="fig85905394917"></a>
![](figures/设备管理器的COM口示意图.png "设备管理器的COM口示意图")
4. 进入IDE烧录配置界面。
**图 7** 烧录基础配置示意图<a name="fig16939203111472"></a>
![](figures/zh-cn_image_0000001054877726.png)
5. 基础参数配置如下。
1. 在Baud rate中选择合适的波特率，波特率越高烧写速度越快，此处建议使用默认值921600。
2. 在Data bit中选择数据位，WLAN模组使用默认值8。
3. 选择版本包路径“./out/wifiiot/Hi3861\_wifiiot\_app\_allinone.bin”，选择Mode为“Hiburn”。
4. 点击“Save”保存配置。
**图 8** 波特率和数据位配置示意图<a name="fig4315145184815"></a>
![](figures/波特率和数据位配置示意图.png "波特率和数据位配置示意图")
**图 9** 烧录包路径示意图<a name="fig105491550185115"></a>
![](figures/zh-cn_image_0000001055427138.png)
6. 在DevEco工具界面中单击“烧录”按钮![](figures/zh-cn_image_0000001054443694.png)，然后选择烧录串口“COM11”。
**图 10** 烧录启动示意图<a name="fig051518341529"></a>
![](figures/烧录启动示意图.png "烧录启动示意图")
7. 选择串口后，IDE的TERMINAL对话框中出现“Connecting, please reset device...”的字样，模组进入待烧录状态。
**图 11** 烧录进行中示意图<a name="fig233565715549"></a>
![](figures/烧录进行中示意图.png "烧录进行中示意图")
8. 按下模组上的复位按键，开始烧写版本，等待TERMINAL对话框中出现“Execution Successful”字样，即烧录完成。
**图 12** 烧录完成示意图<a name="fig191921618564"></a>
![](figures/zh-cn_image_0000001054802306.png)
## WLAN模组联网<a name="section168257461059"></a>
完成版本构建及烧录后，下面开始介绍如何在串口终端上执行AT命令，使WLAN模组联网。
1. 保持Windows工作台和WLAN模组的连接状态，在DevEco工具最下方，点击“Serial port”按钮，弹出串口终端的配置界面。
**图 13** 打开DevEco串口终端示意图<a name="fig12489182991119"></a>
![](figures/打开DevEco串口终端示意图.png "打开DevEco串口终端示意图")
2. 选择串口，并完成参数配置。根据实际情况输入串口号，此处为“COM11”；波特率、数据位、停止位使用默认值；由于AT命令输入需要以“\\r\\n”结尾，否则输入无效，所以结束符处输入“1”。
**图 14** 串口参数配置示意图<a name="fig192312048131213"></a>
![](figures/串口参数配置示意图.png "串口参数配置示意图")
3. 复位WLAN模组，终端界面显示“ready to OS start”，则启动成功。
**图 15** WLAN复位成功示意图<a name="fig496084516332"></a>
![](figures/3.png)
4. 在DevEco的串口终端中，依次执行如下AT命令，启动STA模式，连接指定AP热点，并开启DHCP功能。
```
AT+STARTSTA - 启动STA模式
AT+SCAN - 扫描周边AP
AT+SCANRESULT - 显示扫描结果
AT+CONN="SSID",,2,"PASSWORD" - 连接指定AP，其中SSID/PASSWORD为待连接的热点名称和密码
AT+STASTAT - 查看连接结果
AT+DHCP=wlan0,1 - 通过DHCP向AP请求wlan0的IP地址
```
5. 查看WLAN模组与网关联通是否正常，如下图所示。
```
AT+IFCFG - 查看模组接口IP
AT+PING=X.X.X.X - 检查模组与网关的联通性，其中X.X.X.X需替换为实际的网关地址
```
**图 16** WLAN模组联网成功示意图<a name="fig1166371318339"></a>
![](figures/4.png)
quick-start/开发Hi3861第二个示例程序.md 0 → 100644
浏览文件 @ 37cc208b
# 开发Hi3861第二个示例程序<a name="ZH-CN_TOPIC_0000001053183925"></a>
- [修改源码](#section9360141181414)
- [调测验证](#section1621064881419)
- [printf打印](#section1246911301217)
- [根据asm文件进行问题定位](#section197271353219)
- [运行结果](#section18115713118)
- [下一步学习](#section9712145420182)
本示例将演示如何编写简单业务，输出“Hello World”，初步了解OpenHarmony 如何运行在开发板上。
## 修改源码<a name="section9360141181414"></a>
bugfix和新增业务两种情况，涉及源码修改。下面以新增业务（my\_first\_app）为例，向开发者介绍如何进行源码修改。
1. <a name="li5479332115116"></a>确定目录结构。
开发者编写业务时，务必先在./applications/sample/wifi-iot/app路径下新建一个目录（或一套目录结构），用于存放业务源码文件。
例如：在app下新增业务my\_first\_app，其中hello\_world.c为业务代码，BUILD.gn为编译脚本，具体规划目录结构如下：
```
.
└── applications
└── sample
└── wifi-iot
└── app
│── my_first_app
│ │── hello_world.c
│ └── BUILD.gn
└── BUILD.gn
```
2. 编写业务代码。
新建./applications/sample/wifi-iot/app/my\_first\_app下的hello\_world.c文件，在hello\_world.c中新建业务入口函数HelloWorld，并实现业务逻辑。并在代码最下方，使用OpenHarmony启动恢复模块接口SYS\_RUN\(\)启动业务。（SYS\_RUN定义在ohos\_init.h文件中）
```
#include <stdio.h>
#include "ohos_init.h"
#include "ohos_types.h"
void HelloWorld(void)
{
printf("[DEMO] Hello world.\n");
}
SYS_RUN(HelloWorld);
```
3. 编写用于将业务构建成静态库的BUILD.gn文件。
新建./applications/sample/wifi-iot/app/my\_first\_app下的BUILD.gn文件，并完成如下配置。
如[步骤1](#li5479332115116)所述，BUILD.gn文件由三部分内容（目标、源文件、头文件路径）构成，需由开发者完成填写。。
```
static_library("myapp") {
sources = [
"hello_world.c"
]
include_dirs = [
"//utils/native/lite/include"
]
}
```
- static\_library中指定业务模块的编译结果，为静态库文件libmyapp.a，开发者根据实际情况完成填写。
- sources中指定静态库.a所依赖的.c文件及其路径，若路径中包含"//"则表示绝对路径（此处为代码根路径），若不包含"//"则表示相对路径。
- include\_dirs中指定source所需要依赖的.h文件路径。
4. 编写模块BUILD.gn文件，指定需参与构建的特性模块。
配置./applications/sample/wifi-iot/app/BUILD.gn文件，在features字段中增加索引，使目标模块参与编译。features字段指定业务模块的路径和目标，以my\_first\_app举例，features字段配置如下。
```
import("//build/lite/config/component/lite_component.gni")
lite_component("app") {
features = [
"my_first_app:myapp",
]
}
```
- my\_first\_app是相对路径，指向./applications/sample/wifi-iot/app/my\_first\_app/BUILD.gn。
- myapp是目标，指向./applications/sample/wifi-iot/app/my\_first\_app/BUILD.gn中的static\_library\("myapp"\)。
## 调测验证<a name="section1621064881419"></a>
目前调试验证的方法有两种，分别为通过printf打印日志、通过asm文件定位panic问题，开发者可以根据具体业务情况选择。
由于本示例业务简单，采用printf打印日志的调试方式即可。下面开始介绍这两种调试手段的使用方法。
## printf打印<a name="section1246911301217"></a>
代码中增加printf维测，信息会直接打印到串口上。开发者可在业务关键路径或业务异常位置增加日志打印，如下所示。
```
void HelloWorld(void)
{
printf("[DEMO] Hello world.\n");
}
```
## 根据asm文件进行问题定位<a name="section197271353219"></a>
系统异常退出时，会在串口上打印异常退出原因调用栈信息，如下文所示。通过解析异常栈信息可以定位异常位置。
```
=======KERNEL PANIC=======
**********************Call Stack*********************
Call Stack 0 -- 4860d8 addr:f784c
Call Stack 1 -- 47b2b2 addr:f788c
Call Stack 2 -- 3e562c addr:f789c
Call Stack 3 -- 4101de addr:f78ac
Call Stack 4 -- 3e5f32 addr:f78cc
Call Stack 5 -- 3f78c0 addr:f78ec
Call Stack 6 -- 3f5e24 addr:f78fc
********************Call Stack end*******************
```
为解析上述调用栈信息，需要使用到Hi3861\_wifiiot\_app.asm文件，该文件记录了代码中函数在Flash上的符号地址以及反汇编信息。asm文件会随版本大包一同构建输出，存放在./out/wifiiot/路径下。
1. 将调用栈CallStack信息保存到txt文档中，以便于编辑。（可选）
2. 打开asm文件，并搜索CallStack中的地址，列出对应的函数名 信息。通常只需找出前几个栈信息对应的函数，就可明确异常代码方向。
```
Call Stack 0 -- 4860d8 addr:f784c -- WadRecvCB
Call Stack 1 -- 47b2b2 addr:f788c -- wal_sdp_process_rx_data
Call Stack 2 -- 3e562c addr:f789c
Call Stack 3 -- 4101de addr:f78ac
Call Stack 4 -- 3e5f32 addr:f78cc
Call Stack 5 -- 3f78c0 addr:f78ec
Call Stack 6 -- 3f5e24 addr:f78fc
```
3. 根据以上调用栈信息，可以定位WadRecvCB函数中出现了异常。
![](figures/zh-cn_image_0000001054763554.png)
4. 完成代码排查及修改。
## 运行结果<a name="section18115713118"></a>
示例代码编译、烧录、运行、调测后，在串口界面会显示如下结果：
```
ready to OS start
FileSystem mount ok.
wifi init success!
[DEMO] Hello world.
```
## 下一步学习<a name="section9712145420182"></a>
恭喜，您已完成Hi3861 WLAN模组快速上手！建议您下一步进入[WLAN产品开发](../guide/概述.md)的学习 。
subsystems/DFX.md 0 → 100644
浏览文件 @ 37cc208b
# DFX<a name="ZH-CN_TOPIC_0000001073655967"></a>
- **[DFX子系统概述](DFX子系统概述.md)**
- **[使用mini框架开发](使用mini框架开发.md)**
- **[使用featured框架开发](使用featured框架开发.md)**
- **[常见问题](常见问题-0.md)**
- **[参考](参考.md)**
subsystems/DFX子系统概述.md 0 → 100644
浏览文件 @ 37cc208b
# DFX子系统概述<a name="ZH-CN_TOPIC_0000001062565873"></a>
DFX子系统主要包含DFR（Design for Reliability，可靠性）和DFT（Design for Testability，可测试性）特性，为开发者提供代码维测信息。
由于芯片平台资源有限，且硬件平台多样，因此需要针对不同硬件架构和资源提供组件化且可定制的DFX框架。根据RISC-V、Cortex-M、Cortex-A不同硬件平台，提供两种不同的轻量级DFX框架，以下简称mini、featured框架。
- mini框架：针对处理架构为Cortex-M或同等处理能力的硬件平台，系统内存一般低于512KB，无文件系统或者仅提供一个可有限使用的轻量级文件系统，遵循CMSIS接口规范。用户Task通过API接口，将日志记录在缓存中，异步调用输出接口打印日志，如下图所示。
**图 1** mini框架架构<a name="fig470284245214"></a>
![](figures/zh-cn_image_0000001064795436.png)
- featured框架：处理架构为Cortex-A或同等处理能力的硬件平台，内存资源一般大于512KB，文件系统完善，可存储大量数据，遵循POSIX接口规范。
**图 2** featured框架架构<a name="fig1073631233910"></a>
![](figures/zh-cn_image_0000001064187438.png)
**图解：**用户态Process或内核Task写日志至hilogtask，hilogtask将日志内容存入ringbuffer中，用户态的hilogcat及apphilogcat进程负责日志的串口输出和flash落盘。
下述主要任务的详细内容：
1. hilogtask流水日志的内核任务。
- 此功能是一个内核的驱动，在系统启动时初始化。
- 当内核或者用户态模块调用日志接口，将格式化好的日志内容传输给该任务，并将其存储在一个环形缓冲区中 。
2. apphilogcat用户态日志存储服务。
- 用户态进程，负责将内核的Ringbuffer读取出来，存储到日志文件中。
3. hilogcat日志查看命令行工具。
从内核驱动接口读取ringbuffer内容，输出到标准输出，可支持日志过滤。
subsystems/Readme-CN.md
浏览文件 @ 37cc208b
...@@ -8,14 +8,39 @@ ...@@ -8,14 +8,39 @@
- [普通组件开发指导](普通组件开发指导.md) - [普通组件开发指导](普通组件开发指导.md)
- [动画开发指导](动画开发指导.md) - [动画开发指导](动画开发指导.md)
- [相机](相机.md) - [媒体](媒体.md)
- [相机开发概述](相机开发概述.md) - [相机开发概述](相机开发概述.md)
- [拍照开发指导](拍照开发指导.md) - [拍照开发指导](拍照开发指导.md)
- [录像开发指导](录像开发指导.md) - [录像开发指导](录像开发指导.md)
- [预览开发指导](预览开发指导.md) - [预览开发指导](预览开发指导.md)
- [音视频](音视频.md)
- [音视频开发概述](音视频开发概述.md) - [音视频开发概述](音视频开发概述.md)
- [音视频播放开发指导](音视频播放开发指导.md) - [音视频播放开发指导](音视频播放开发指导.md)
- [音视频录制开发指导](音视频录制开发指导.md) - [音视频录制开发指导](音视频录制开发指导.md)
- [公共基础](公共基础.md)
- [公共基础库概述](公共基础库概述.md)
- [公共基础库开发指导](公共基础库开发指导.md)
- [公共基础库常见问题](公共基础库常见问题.md)
- [用户程序框架](用户程序框架.md)
- [概述](概述.md)
- [搭建环境](搭建环境.md)
- [开发指导](开发指导.md)
- [开发实例](开发实例.md)
- [常见问题](常见问题.md)
- [编译构建](编译构建.md)
- [编译构建概述](编译构建概述.md)
- [编译构建使用指导](编译构建使用指导.md)
- [编译构建常见问题](编译构建常见问题.md)
- [测试](测试.md)
- [DFX](DFX.md)
- [DFX子系统概述](DFX子系统概述.md)
- [使用mini框架开发](使用mini框架开发.md)
- [使用featured框架开发](使用featured框架开发.md)
- [常见问题](常见问题-0.md)
- [参考](参考.md)
- [XTS认证](XTS认证.md)
subsystems/XTS认证.md 0 → 100644
浏览文件 @ 37cc208b
# XTS认证<a name="ZH-CN_TOPIC_0000001074750691"></a>
- [概述](#zh-cn_topic_0000001059475030_section44931242483)
- [目录结构](#zh-cn_topic_0000001059475030_section45118915548)
- [约束与限制](#zh-cn_topic_0000001059475030_section115518148474)
- [开发指导](#zh-cn_topic_0000001059475030_section99973470498)
- [编写联接类模组acts测试用例](#zh-cn_topic_0000001059475030_section1348215596491)
- [编写智慧视觉类设备（Ipcamera）acts测试用例](#zh-cn_topic_0000001059475030_section11458163095019)
- [执行联接类模组acts测试用例](#zh-cn_topic_0000001059475030_section3115140115113)
- [执行智慧视觉类设备（Ipcamera）acts测试用例](#zh-cn_topic_0000001059475030_section1759138185215)
## 概述<a name="zh-cn_topic_0000001059475030_section44931242483"></a>
XTS是OpenHarmony生态认证测试套件的集合，当前包括acts（application compatibility test suite）应用兼容性测试套，后续会拓展dcts（device compatibility test suite）设备兼容性测试套等。
test/xts仓当前包括acts与tools软件包：
- acts，存放acts相关测试用例源码与配置文件，其目的是帮助终端设备厂商尽早发现软件与OpenHarmony的不兼容性，确保软件在整个开发过程中满足OpenHarmony的兼容性要求。
- tools，存放acts相关测试用例开发框架。
## 目录结构<a name="zh-cn_topic_0000001059475030_section45118915548"></a>
test/xts源代码目录结构：
├── acts
│ ├── BUILD.gn 测试用例编译配置
│ └── subsystem\_lite 子系统测试用例源码
└── tools
│ └── build 测试用例编译相关的模板与脚本
│ └── hcpptest 智慧视觉类设备（Ipcamera）测试用例开发框架源码
│ └── hctest 联接类模组测试用例开发框架源码
│ └── BUILD.gn 编译配置
│ └── build.sh 编译入口
## 约束与限制<a name="zh-cn_topic_0000001059475030_section115518148474"></a>
联接类模组acts用例开发语言是C，智慧视觉类设备（Ipcamera）acts用例开发语言是C++。
## 开发指导<a name="zh-cn_topic_0000001059475030_section99973470498"></a>
### 编写联接类模组acts测试用例<a name="zh-cn_topic_0000001059475030_section1348215596491"></a>
当前使用的测试框架是hctest。
hctest测试框架支持使用C语言编写测试用例，在联接类模组上执行，是在开源测试框架unity的基础上进行增强和适配。
1. 规范用例目录：测试用例存储test/xts/acts仓中。
├── acts
│ ├── BUILD.gn
│ └──subsystem\_lite
│ │ └── module\_hal
│ │ │ └── BUILD.gn
│ │ │ └── src
2. src目录下用例编写样例。
a. 引用测试框架
```
#include "hctest.h"
```
b. 使用宏定义LITE\_TEST\_SUIT定义子系统、模块、测试套件名称
```
/**
* @brief register a test suit named "IntTestSuite"
* @param test subsystem name
* @param example module name
* @param IntTestSuite test suit name
*/
LITE_TEST_SUIT(test, example, IntTestSuite);
```
c. 定义Setup与TearDown
命名方式：测试套件名称+Setup，测试套件名称+TearDown。
Setup与TearDown必须存在，可以为空函数。
d. 使用宏定义LITE\_TEST\_CASE写测试用例
包括三个参数：测试套件名称，测试用例名称，用例级别。
用例级别取值为如下内容之一:
“Level0”,“Level1”,“Level2”,“Level3”，“Level4”。
```
LITE_TEST_CASE(IntTestSuite, TestCase001, Level0)
{
//do something
};
```
用例级别说明如下表所示。
**表 1** 用例级别说明
<a name="zh-cn_topic_0000001059475030_table115309197517"></a>
<table><thead align="left"><tr id="zh-cn_topic_0000001059475030_row053010198520"><th class="cellrowborder" valign="top" width="13.46134613461346%" id="mcps1.2.4.1.1"><p id="zh-cn_topic_0000001059475030_p6251523752"><a name="zh-cn_topic_0000001059475030_p6251523752"></a><a name="zh-cn_topic_0000001059475030_p6251523752"></a><strong id="zh-cn_topic_0000001059475030_b72510235511"><a name="zh-cn_topic_0000001059475030_b72510235511"></a><a name="zh-cn_topic_0000001059475030_b72510235511"></a>级别名称</strong></p>
</th>
<th class="cellrowborder" valign="top" width="10.25102510251025%" id="mcps1.2.4.1.2"><p id="zh-cn_topic_0000001059475030_p1825117231157"><a name="zh-cn_topic_0000001059475030_p1825117231157"></a><a name="zh-cn_topic_0000001059475030_p1825117231157"></a><strong id="zh-cn_topic_0000001059475030_b1825142312518"><a name="zh-cn_topic_0000001059475030_b1825142312518"></a><a name="zh-cn_topic_0000001059475030_b1825142312518"></a>基本定义</strong></p>
</th>
<th class="cellrowborder" valign="top" width="76.2876287628763%" id="mcps1.2.4.1.3"><p id="zh-cn_topic_0000001059475030_p1325111230519"><a name="zh-cn_topic_0000001059475030_p1325111230519"></a><a name="zh-cn_topic_0000001059475030_p1325111230519"></a><strong id="zh-cn_topic_0000001059475030_b1525110231356"><a name="zh-cn_topic_0000001059475030_b1525110231356"></a><a name="zh-cn_topic_0000001059475030_b1525110231356"></a>测试范围</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="zh-cn_topic_0000001059475030_row45301619957"><td class="cellrowborder" valign="top" width="13.46134613461346%" headers="mcps1.2.4.1.1 "><p id="zh-cn_topic_0000001059475030_p122511231759"><a name="zh-cn_topic_0000001059475030_p122511231759"></a><a name="zh-cn_topic_0000001059475030_p122511231759"></a>Level0</p>
</td>
<td class="cellrowborder" valign="top" width="10.25102510251025%" headers="mcps1.2.4.1.2 "><p id="zh-cn_topic_0000001059475030_p132511238516"><a name="zh-cn_topic_0000001059475030_p132511238516"></a><a name="zh-cn_topic_0000001059475030_p132511238516"></a>冒烟</p>
</td>
<td class="cellrowborder" valign="top" width="76.2876287628763%" headers="mcps1.2.4.1.3 "><p id="zh-cn_topic_0000001059475030_p82511223550"><a name="zh-cn_topic_0000001059475030_p82511223550"></a><a name="zh-cn_topic_0000001059475030_p82511223550"></a>验证关键功能点基本功能/最基本DFX属性在最常见输入下的表现，通过表示功能基本可运行。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059475030_row12531121912518"><td class="cellrowborder" valign="top" width="13.46134613461346%" headers="mcps1.2.4.1.1 "><p id="zh-cn_topic_0000001059475030_p16252523557"><a name="zh-cn_topic_0000001059475030_p16252523557"></a><a name="zh-cn_topic_0000001059475030_p16252523557"></a>Level1</p>
</td>
<td class="cellrowborder" valign="top" width="10.25102510251025%" headers="mcps1.2.4.1.2 "><p id="zh-cn_topic_0000001059475030_p1125212231358"><a name="zh-cn_topic_0000001059475030_p1125212231358"></a><a name="zh-cn_topic_0000001059475030_p1125212231358"></a>基本</p>
</td>
<td class="cellrowborder" valign="top" width="76.2876287628763%" headers="mcps1.2.4.1.3 "><p id="zh-cn_topic_0000001059475030_p02521123757"><a name="zh-cn_topic_0000001059475030_p02521123757"></a><a name="zh-cn_topic_0000001059475030_p02521123757"></a>验证各功能点基本功能/基本DFX属性在常见输入下的表现，通过表示功能基本可测试。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059475030_row1531131917514"><td class="cellrowborder" valign="top" width="13.46134613461346%" headers="mcps1.2.4.1.1 "><p id="zh-cn_topic_0000001059475030_p1525219237517"><a name="zh-cn_topic_0000001059475030_p1525219237517"></a><a name="zh-cn_topic_0000001059475030_p1525219237517"></a>Level2</p>
</td>
<td class="cellrowborder" valign="top" width="10.25102510251025%" headers="mcps1.2.4.1.2 "><p id="zh-cn_topic_0000001059475030_p5252523458"><a name="zh-cn_topic_0000001059475030_p5252523458"></a><a name="zh-cn_topic_0000001059475030_p5252523458"></a>重要</p>
</td>
<td class="cellrowborder" valign="top" width="76.2876287628763%" headers="mcps1.2.4.1.3 "><p id="zh-cn_topic_0000001059475030_p1125215231552"><a name="zh-cn_topic_0000001059475030_p1125215231552"></a><a name="zh-cn_topic_0000001059475030_p1125215231552"></a>验证各功能点的基本功能/基本DFX属性在常规输入/常见异常情况下的表现，通过表示功能基本正常可用，可开展Beta。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059475030_row1853111191556"><td class="cellrowborder" valign="top" width="13.46134613461346%" headers="mcps1.2.4.1.1 "><p id="zh-cn_topic_0000001059475030_p625220234514"><a name="zh-cn_topic_0000001059475030_p625220234514"></a><a name="zh-cn_topic_0000001059475030_p625220234514"></a>Level3</p>
</td>
<td class="cellrowborder" valign="top" width="10.25102510251025%" headers="mcps1.2.4.1.2 "><p id="zh-cn_topic_0000001059475030_p92528231952"><a name="zh-cn_topic_0000001059475030_p92528231952"></a><a name="zh-cn_topic_0000001059475030_p92528231952"></a>一般</p>
</td>
<td class="cellrowborder" valign="top" width="76.2876287628763%" headers="mcps1.2.4.1.3 "><p id="zh-cn_topic_0000001059475030_p72521423855"><a name="zh-cn_topic_0000001059475030_p72521423855"></a><a name="zh-cn_topic_0000001059475030_p72521423855"></a>验证各功能点的全部功能/全部DFX属性在各种常规/非常规输入组合下，或各种正常/异常预置条件组合下的表现。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059475030_row25311219459"><td class="cellrowborder" valign="top" width="13.46134613461346%" headers="mcps1.2.4.1.1 "><p id="zh-cn_topic_0000001059475030_p52521223659"><a name="zh-cn_topic_0000001059475030_p52521223659"></a><a name="zh-cn_topic_0000001059475030_p52521223659"></a>Level4</p>
</td>
<td class="cellrowborder" valign="top" width="10.25102510251025%" headers="mcps1.2.4.1.2 "><p id="zh-cn_topic_0000001059475030_p10252223853"><a name="zh-cn_topic_0000001059475030_p10252223853"></a><a name="zh-cn_topic_0000001059475030_p10252223853"></a>生僻</p>
</td>
<td class="cellrowborder" valign="top" width="76.2876287628763%" headers="mcps1.2.4.1.3 "><p id="zh-cn_topic_0000001059475030_p1625214231655"><a name="zh-cn_topic_0000001059475030_p1625214231655"></a><a name="zh-cn_topic_0000001059475030_p1625214231655"></a>验证关键功能点在极端异常预置条件下、用户难以触及的异常输入组合下的表现。</p>
</td>
</tr>
</tbody>
</table>
e. 使用宏定义 RUN\_TEST\_SUITE注册测试套件。
```
RUN_TEST_SUITE(IntTestSuite);
```
3. 测试模块的配置文件样例：（BUILD.gn）。
每个测试模块目录下新建BUILD.gn编译文件，用于指定编译后静态库的名称、依赖的头文件、依赖的库等；具体写法如下：
```
import("//test/xts/tools/build/suite_lite.gni")
hctest_suite("ActsDemoTest") {
suite_name = "acts"
sources = [
"src/test_demo.c",
]
include_dirs = [ ]
cflags = [ "-Wno-error" ]
}
```
4. acts下BUILD.gn增加编译选项。
需要将测试模块加入到acts目录下的编译脚本中，编译脚本路径：test/xts/acts/BUILD.gn。
```
lite_component("acts") {
...
if(board_name == "liteos_riscv") {
features += [
...
"//xts/acts/subsystem_lite/module_hal:ActsDemoTest"
]
}
}
```
5. 测试套件编译命令。
**命令：**python build.py wifiiot -b debug
**输出：**out/wifiiot
>![](public_sys-resources/icon-note.gif) **说明：**
>联接类模组acts测试编译中间件为静态库，最终会链接到版本镜像中 ：Hi3861\_wifiiot\_app\_allinone.bin。
### 编写智慧视觉类设备（Ipcamera）acts测试用例<a name="zh-cn_topic_0000001059475030_section11458163095019"></a>
hcpptest测试框架是在开源的googletest测试框架的基础上进行的增强和适配。
1. 规范用例目录：测试用例存储到test/xts/acts仓中。
├── acts
│ ├── BUILD.gn
│ └──subsystem\_lite
│ │ └── module\_posix
│ │ │ └── BUILD.gn
│ │ │ └── src
2. 测试模块src下用例编写样例。
a. 引用测试框架：
需要引用gtest.h 如：\#include "gtest/gtest.h"
```
#include "gtest/gtest.h"
```
b. 定义Setup与TearDown
```
class TestSuite: public testing::Test {
protected:
// Preset action of the test suite, which is executed before the first test case
static void SetUpTestCase(void){
}
// Test suite cleanup action, which is executed after the last test case
static void TearDownTestCase(void){
}
// Preset action of the test case
virtual void SetUp()
{
}
// Cleanup action of the test case
virtual void TearDown()
{
}
};
```
c. 使用宏定义HWTEST或HWTEST\_F写测试用例
普通测试用例的定义：HWTEST（测试套名称， 测试用例名称， 用例标注）。
包含SetUp和TearDown的测试用例的定义 ：HWTEST\_F（测试套名称， 测试用例名称，用例标注）。
宏定义包括三个参数：测试套件名称，测试用例名称，用例级别。
用例级别取值为如下内容之一:
“Level0”,“Level1”,“Level2”,“Level3”，“Level4”。
```
HWTEST_F(TestSuite, TestCase_0001, Level0) {
// do something
}
```
用例级别说明如下表所示。
**表 2** 用例级别说明
<a name="zh-cn_topic_0000001059475030_table1830755842"></a>
<table><thead align="left"><tr id="zh-cn_topic_0000001059475030_row93075510420"><th class="cellrowborder" valign="top" width="13.681368136813681%" id="mcps1.2.4.1.1"><p id="zh-cn_topic_0000001059475030_p153681823247"><a name="zh-cn_topic_0000001059475030_p153681823247"></a><a name="zh-cn_topic_0000001059475030_p153681823247"></a><strong id="zh-cn_topic_0000001059475030_b036862311411"><a name="zh-cn_topic_0000001059475030_b036862311411"></a><a name="zh-cn_topic_0000001059475030_b036862311411"></a>级别名称</strong></p>
</th>
<th class="cellrowborder" valign="top" width="10.961096109610962%" id="mcps1.2.4.1.2"><p id="zh-cn_topic_0000001059475030_p9368823749"><a name="zh-cn_topic_0000001059475030_p9368823749"></a><a name="zh-cn_topic_0000001059475030_p9368823749"></a><strong id="zh-cn_topic_0000001059475030_b0368152312417"><a name="zh-cn_topic_0000001059475030_b0368152312417"></a><a name="zh-cn_topic_0000001059475030_b0368152312417"></a>基本定义</strong></p>
</th>
<th class="cellrowborder" valign="top" width="75.35753575357535%" id="mcps1.2.4.1.3"><p id="zh-cn_topic_0000001059475030_p3368112319418"><a name="zh-cn_topic_0000001059475030_p3368112319418"></a><a name="zh-cn_topic_0000001059475030_p3368112319418"></a><strong id="zh-cn_topic_0000001059475030_b2368523045"><a name="zh-cn_topic_0000001059475030_b2368523045"></a><a name="zh-cn_topic_0000001059475030_b2368523045"></a>测试范围</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="zh-cn_topic_0000001059475030_row13079520412"><td class="cellrowborder" valign="top" width="13.681368136813681%" headers="mcps1.2.4.1.1 "><p id="zh-cn_topic_0000001059475030_p1236811237417"><a name="zh-cn_topic_0000001059475030_p1236811237417"></a><a name="zh-cn_topic_0000001059475030_p1236811237417"></a>Level0</p>
</td>
<td class="cellrowborder" valign="top" width="10.961096109610962%" headers="mcps1.2.4.1.2 "><p id="zh-cn_topic_0000001059475030_p336812235414"><a name="zh-cn_topic_0000001059475030_p336812235414"></a><a name="zh-cn_topic_0000001059475030_p336812235414"></a>冒烟</p>
</td>
<td class="cellrowborder" valign="top" width="75.35753575357535%" headers="mcps1.2.4.1.3 "><p id="zh-cn_topic_0000001059475030_p2036852311414"><a name="zh-cn_topic_0000001059475030_p2036852311414"></a><a name="zh-cn_topic_0000001059475030_p2036852311414"></a>验证关键功能点基本功能/最基本DFX属性在最常见输入下的表现，通过表示功能基本可运行。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059475030_row4307953415"><td class="cellrowborder" valign="top" width="13.681368136813681%" headers="mcps1.2.4.1.1 "><p id="zh-cn_topic_0000001059475030_p18369623540"><a name="zh-cn_topic_0000001059475030_p18369623540"></a><a name="zh-cn_topic_0000001059475030_p18369623540"></a>Level1</p>
</td>
<td class="cellrowborder" valign="top" width="10.961096109610962%" headers="mcps1.2.4.1.2 "><p id="zh-cn_topic_0000001059475030_p103698231443"><a name="zh-cn_topic_0000001059475030_p103698231443"></a><a name="zh-cn_topic_0000001059475030_p103698231443"></a>基本</p>
</td>
<td class="cellrowborder" valign="top" width="75.35753575357535%" headers="mcps1.2.4.1.3 "><p id="zh-cn_topic_0000001059475030_p136916234410"><a name="zh-cn_topic_0000001059475030_p136916234410"></a><a name="zh-cn_topic_0000001059475030_p136916234410"></a>验证各功能点基本功能/基本DFX属性在常见输入下的表现，通过表示功能基本可测试。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059475030_row83075510419"><td class="cellrowborder" valign="top" width="13.681368136813681%" headers="mcps1.2.4.1.1 "><p id="zh-cn_topic_0000001059475030_p12369192315420"><a name="zh-cn_topic_0000001059475030_p12369192315420"></a><a name="zh-cn_topic_0000001059475030_p12369192315420"></a>Level2</p>
</td>
<td class="cellrowborder" valign="top" width="10.961096109610962%" headers="mcps1.2.4.1.2 "><p id="zh-cn_topic_0000001059475030_p13698231341"><a name="zh-cn_topic_0000001059475030_p13698231341"></a><a name="zh-cn_topic_0000001059475030_p13698231341"></a>重要</p>
</td>
<td class="cellrowborder" valign="top" width="75.35753575357535%" headers="mcps1.2.4.1.3 "><p id="zh-cn_topic_0000001059475030_p16369142312412"><a name="zh-cn_topic_0000001059475030_p16369142312412"></a><a name="zh-cn_topic_0000001059475030_p16369142312412"></a>验证各功能点的基本功能/基本DFX属性在常规输入/常见异常情况下的表现，通过表示功能基本正常可用，可开展Beta。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059475030_row930815512416"><td class="cellrowborder" valign="top" width="13.681368136813681%" headers="mcps1.2.4.1.1 "><p id="zh-cn_topic_0000001059475030_p1636932315417"><a name="zh-cn_topic_0000001059475030_p1636932315417"></a><a name="zh-cn_topic_0000001059475030_p1636932315417"></a>Level3</p>
</td>
<td class="cellrowborder" valign="top" width="10.961096109610962%" headers="mcps1.2.4.1.2 "><p id="zh-cn_topic_0000001059475030_p1336918239414"><a name="zh-cn_topic_0000001059475030_p1336918239414"></a><a name="zh-cn_topic_0000001059475030_p1336918239414"></a>一般</p>
</td>
<td class="cellrowborder" valign="top" width="75.35753575357535%" headers="mcps1.2.4.1.3 "><p id="zh-cn_topic_0000001059475030_p143691023345"><a name="zh-cn_topic_0000001059475030_p143691023345"></a><a name="zh-cn_topic_0000001059475030_p143691023345"></a>验证各功能点的全部功能/全部DFX属性在各种常规/非常规输入组合下，或各种正常/异常预置条件组合下的表现。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059475030_row183085518414"><td class="cellrowborder" valign="top" width="13.681368136813681%" headers="mcps1.2.4.1.1 "><p id="zh-cn_topic_0000001059475030_p63691423347"><a name="zh-cn_topic_0000001059475030_p63691423347"></a><a name="zh-cn_topic_0000001059475030_p63691423347"></a>Level4</p>
</td>
<td class="cellrowborder" valign="top" width="10.961096109610962%" headers="mcps1.2.4.1.2 "><p id="zh-cn_topic_0000001059475030_p63697236413"><a name="zh-cn_topic_0000001059475030_p63697236413"></a><a name="zh-cn_topic_0000001059475030_p63697236413"></a>生僻</p>
</td>
<td class="cellrowborder" valign="top" width="75.35753575357535%" headers="mcps1.2.4.1.3 "><p id="zh-cn_topic_0000001059475030_p133695231443"><a name="zh-cn_topic_0000001059475030_p133695231443"></a><a name="zh-cn_topic_0000001059475030_p133695231443"></a>验证关键功能点在极端异常预置条件下、用户难以触及的异常输入组合下的表现。</p>
</td>
</tr>
</tbody>
</table>
3. 测试模块下用例配置文件样例：（BUILD.gn）。
每个测试模块目录下新建BUILD.gn编译文件，用于指定编译后可执行文件的名称、依赖的头文件、依赖的库等；具体写法如下。每个测试模块将独立编译成.bin可执行文件， 该文件可直接mount到单板上进行测试。
举例：
```
import("//test/xts/tools/build/suite_lite.gni")
hcpptest_suite("ActsDemoTest") {
suite_name = "acts"
sources = [
"src/TestDemo.cpp"
]
include_dirs = [
"src",
...
]
deps = [
...
]
cflags = [ "-Wno-error" ]
}
```
4. acts目录下增加编译选项（BUILD.gn）。
将测试模块加入到acts目录下的编译脚本中，编译脚本为：test/xts/acts/BUILD.gn。
```
lite_component("acts") {
...
else if(board_name == "liteos_a") {
features += [
...
"//xts/acts/subsystem_lite/module_posix:ActsDemoTest"
]
}
}
```
5. 测试套件编译命令。
- **hi3518ev300**
**命令**：python build.py ipcamera\_hi3518ev300 -b debug
**输出**：out/ipcamera\_hi3518ev300
- **hi3516dv300**
**命令**：python build.py ipcamera\_hi3516dv300 -b debug
**输出**：out/ipcamera\_hi3516dv300
>![](public_sys-resources/icon-note.gif) **说明：**
>智慧视觉类设备（Ipcamera）acts独立编译成.bin可执行文件， 该文件可直接mount到单板上进行测试。
### 执行联接类模组acts测试用例<a name="zh-cn_topic_0000001059475030_section3115140115113"></a>
**获取测试大包**
请在如下目录获取版本镜像，归档目录：out\\wifiiot\\Hi3861\_wifiiot\_app\_allinone.bin。
备注：判断当前版本镜像是否集成acts测试套件方法：在map文件中查看对应.a是否被编译即可，out\\wifiiot\\Hi3861\_wifiiot\_app.map。
**版本镜像烧录进开发板**
**测试步骤**
1. 使用串口工具登录开发板，并保存串口打印信息。
2. 重启设备，查看串口日志。
**测试结果分析指导**
基于串口打印日志进行分析；
每个测试套件执行以：Start to run test suite:开始，以xx Tests xx Failures xx Ignored结束。
### 执行智慧视觉类设备（Ipcamera）acts测试用例<a name="zh-cn_topic_0000001059475030_section1759138185215"></a>
目前的用例执行采用nfs共享的方式，mount到单板去执行；
**环境搭建**
1. 使用有限网线或无线将Ipcamera开发板与PC进行连接。
2. Ipcamera开发板配置IP、子网掩码、网关，确保Ipcamera开发板与PC处于同一个网段。
3. PC安装nfs服务器并完成注册，启动nfs服务。
4. Ipcamera开发板配置mount命令，确保Ipcamera开发板可以访问PC端的nfs共享文件。
格式：mount \[nfs服务器IP\]:\[/nfs共享目录\] \[/Ipcamera开发板目录\] nfs
举例：
```
mount 192.168.1.10:/nfs /nfs nfs
```
**用例执行**
基于串口打印日志进行分析。
每个测试套件执行以./测试模块.bin 触发用例执行。
subsystems/使用featured框架开发.md 0 → 100644
浏览文件 @ 37cc208b
# 使用featured框架开发<a name="ZH-CN_TOPIC_0000001062713987"></a>
- [接口说明](#section20840587473)
- [开发步骤](#section32781532131314)
- [使用featured框架实例](#section1210915266154)
featured框架提供完整的DFX特性，debug版本默认输出到串口及文件，保存路径为“/storage/data/log/“。
## 接口说明<a name="section20840587473"></a>
```
HILOG_DEBUG(type, ...)
HILOG_INFO(type, ...)
HILOG_WARN(type, ...)
HILOG_ERROR(type, ...)
HILOG_FATAL(type, ...)
```
**表 1** 接口参数介绍
<a name="table1872515171474"></a>
<table><thead align="left"><tr id="row772491734711"><th class="cellrowborder" valign="top" width="25.05%" id="mcps1.2.3.1.1"><p id="p1272431714477"><a name="p1272431714477"></a><a name="p1272431714477"></a>参数名字</p>
</th>
<th class="cellrowborder" valign="top" width="74.95%" id="mcps1.2.3.1.2"><p id="p472451724716"><a name="p472451724716"></a><a name="p472451724716"></a>参数含义</p>
</th>
</tr>
</thead>
<tbody><tr id="row15416155714297"><td class="cellrowborder" valign="top" width="25.05%" headers="mcps1.2.3.1.1 "><p id="p041617572292"><a name="p041617572292"></a><a name="p041617572292"></a>type</p>
</td>
<td class="cellrowborder" valign="top" width="74.95%" headers="mcps1.2.3.1.2 "><p id="p74161557172912"><a name="p74161557172912"></a><a name="p74161557172912"></a>兼容mini框架的参数，featured框架忽略传入值。</p>
</td>
</tr>
<tr id="row19724161794719"><td class="cellrowborder" valign="top" width="25.05%" headers="mcps1.2.3.1.1 "><p id="p1072431724710"><a name="p1072431724710"></a><a name="p1072431724710"></a>domainId</p>
</td>
<td class="cellrowborder" valign="top" width="74.95%" headers="mcps1.2.3.1.2 "><p id="p14724181724719"><a name="p14724181724719"></a><a name="p14724181724719"></a>领域标识ID，隐藏参数，需要用户自定义。</p>
</td>
</tr>
<tr id="row5724131714718"><td class="cellrowborder" valign="top" width="25.05%" headers="mcps1.2.3.1.1 "><p id="p2724191724716"><a name="p2724191724716"></a><a name="p2724191724716"></a>tag</p>
</td>
<td class="cellrowborder" valign="top" width="74.95%" headers="mcps1.2.3.1.2 "><p id="p11724917114715"><a name="p11724917114715"></a><a name="p11724917114715"></a>日志tag，隐藏参数，需要用户自定义。</p>
</td>
</tr>
<tr id="row137243177475"><td class="cellrowborder" valign="top" width="25.05%" headers="mcps1.2.3.1.1 "><p id="p1772461754718"><a name="p1772461754718"></a><a name="p1772461754718"></a>fmt</p>
</td>
<td class="cellrowborder" valign="top" width="74.95%" headers="mcps1.2.3.1.2 "><p id="p131236352304"><a name="p131236352304"></a><a name="p131236352304"></a>格式化字符串，</p>
<p id="p2072401710475"><a name="p2072401710475"></a><a name="p2072401710475"></a>支持标识格式化字符串fmt是否是隐私，是{private}时fmt会被认为是隐私，{public}时被认为是公开。</p>
</td>
</tr>
<tr id="row11725161719477"><td class="cellrowborder" valign="top" width="25.05%" headers="mcps1.2.3.1.1 "><p id="p172591734710"><a name="p172591734710"></a><a name="p172591734710"></a>args</p>
</td>
<td class="cellrowborder" valign="top" width="74.95%" headers="mcps1.2.3.1.2 "><p id="p8725617194715"><a name="p8725617194715"></a><a name="p8725617194715"></a>格式化字符串参数。</p>
</td>
</tr>
</tbody>
</table>
接口隐私规则介绍（该功能仅在release版本中有效）：
1. 格式化字符串默认是非隐私
```
HILOG_INFO(0, "Hello World\n"); >> Hello World
```
2. 格式化参数默认是隐私
```
HILOG_INFO(0, "Age is %d\n", 10); >> Age is <private>
```
3. %\{private\}标识的参数是隐私
```
HILOG_INFO(0, "Age is %{private}d\n", 10); >> Age is <private>
```
4. %\{public\}标识的参数是非隐私
```
HILOG_INFO(0, "Age is %{public}d\n", 10); >>Age is 10
```
## 开发步骤<a name="section32781532131314"></a>
1. 在Build.gn文件中添加动态库依赖。
```
public_deps = [ "//base/hiviewdfx/frameworks/hilog_lite/featured:hilog_shared"]
```
2. 增加头文件，定义模块TAG及Domain数值。
```
#include<log.h>
#undef LOG_TAG
#undef LOG_DOMAIN
#define LOG_TAG "MyModule"
#define LOG_DOMAIN 0xD00000
```
3. 添加日志打印代码。
```
HILOG_INFO(0,"Hello World\n");
```
## 使用featured框架实例<a name="section1210915266154"></a>
以引用samgr\_lite模块使用featured框架作为实例。
1. 源码路径中foundation/distributedschedule/services/samgr\_lite/samgr/source/BUILD.gn中通过依赖语句引用hilog的头文件及依赖库。
```
public_deps = [ "//base/hiviewdfx/frameworks/hilog_lite/featured:hilog_shared" ]
```
2. 源码文件中引用头文件并使用HILOG接口。
参考源码文件distributedschedule/services/samgr\_lite/samgr\_server/source/samgr\_server.c。
```
#include<log.h>
#undef LOG_TAG
#undef LOG_DOMAIN
#define LOG_TAG "Samgr"
#define LOG_DOMAIN 0xD001800
static void InitializeRegistry(void)
{
HILOG_INFO(HILOG_MODULE_SAMGR, "Initialize Registry!");
...
}
```
文件内引用头文件<log.h\>或者<hilog/log.h\>，增加模块类别的编号及TAG标识（Samgr）。
3. InitializeRegistry函数被调用时，打印输出日志内容，内容包括日期，PID（6），taskID（23），级别（I），领域标识ID（01800，取定义值0xD001800的低5位），模块名（Samgr），语句内容（Initialize Registry!）。
**图 1** 启动阶段打印图示<a name="fig418242621511"></a>
![](figures/启动阶段打印图示.png "启动阶段打印图示")
subsystems/使用mini框架开发.md 0 → 100644
浏览文件 @ 37cc208b
# 使用mini框架开发<a name="ZH-CN_TOPIC_0000001063393902"></a>
- [接口说明](#section183731439142417)
- [使用mini框架实例](#section153112047155419)
mini框架是一套简单小巧的DFX设计，对外提供日志记录功能。
## 接口说明<a name="section183731439142417"></a>
```
HILOG_DEBUG(mod, fmt, ...)
HILOG_INFO(mod, fmt, ...)
HILOG_WARN(mod, fmt, ...)
HILOG_ERROR(mod, fmt, ...)
HILOG_FATAL(mod, fmt, ...)
```
接口参数说明：
<a name="table998125624816"></a>
<table><thead align="left"><tr id="row10981135611481"><th class="cellrowborder" valign="top" width="11.57%" id="mcps1.1.5.1.1"><p id="p11981145674811"><a name="p11981145674811"></a><a name="p11981145674811"></a>参数名</p>
</th>
<th class="cellrowborder" valign="top" width="11.83%" id="mcps1.1.5.1.2"><p id="p39821456124810"><a name="p39821456124810"></a><a name="p39821456124810"></a>是否必填</p>
</th>
<th class="cellrowborder" valign="top" width="15.21%" id="mcps1.1.5.1.3"><p id="p139822056104811"><a name="p139822056104811"></a><a name="p139822056104811"></a>参数类型</p>
</th>
<th class="cellrowborder" valign="top" width="61.39%" id="mcps1.1.5.1.4"><p id="p3982145618482"><a name="p3982145618482"></a><a name="p3982145618482"></a>参数说明</p>
</th>
</tr>
</thead>
<tbody><tr id="row209821456144818"><td class="cellrowborder" valign="top" width="11.57%" headers="mcps1.1.5.1.1 "><p id="p20982125616483"><a name="p20982125616483"></a><a name="p20982125616483"></a>mod</p>
</td>
<td class="cellrowborder" valign="top" width="11.83%" headers="mcps1.1.5.1.2 "><p id="p1298245634810"><a name="p1298245634810"></a><a name="p1298245634810"></a>是</p>
</td>
<td class="cellrowborder" valign="top" width="15.21%" headers="mcps1.1.5.1.3 "><p id="p1198295634817"><a name="p1198295634817"></a><a name="p1198295634817"></a>uint8</p>
</td>
<td class="cellrowborder" valign="top" width="61.39%" headers="mcps1.1.5.1.4 "><p id="p0982145634817"><a name="p0982145634817"></a><a name="p0982145634817"></a>模块/服务的ID。</p>
<p id="p1982155664820"><a name="p1982155664820"></a><a name="p1982155664820"></a>统一规划分配，最大支持64个，其中第三方APP统一使用HILOG_MODULE_APP作为模块ID。</p>
</td>
</tr>
<tr id="row1898225611489"><td class="cellrowborder" valign="top" width="11.57%" headers="mcps1.1.5.1.1 "><p id="p9982656164812"><a name="p9982656164812"></a><a name="p9982656164812"></a>fmt</p>
</td>
<td class="cellrowborder" valign="top" width="11.83%" headers="mcps1.1.5.1.2 "><p id="p998255616484"><a name="p998255616484"></a><a name="p998255616484"></a>是</p>
</td>
<td class="cellrowborder" valign="top" width="15.21%" headers="mcps1.1.5.1.3 "><p id="p18982256194818"><a name="p18982256194818"></a><a name="p18982256194818"></a>char *</p>
</td>
<td class="cellrowborder" valign="top" width="61.39%" headers="mcps1.1.5.1.4 "><p id="p2982165664818"><a name="p2982165664818"></a><a name="p2982165664818"></a>格式化输出字符串。</p>
<a name="ol19982256164816"></a><a name="ol19982256164816"></a><ol id="ol19982256164816"><li>最大支持6个可变参数，不支持%s。</li><li>格式化后的单条日志最大长度128字节，超过将无法打印。</li></ol>
</td>
</tr>
<tr id="row16982105613488"><td class="cellrowborder" valign="top" width="11.57%" headers="mcps1.1.5.1.1 "><p id="p1898225604813"><a name="p1898225604813"></a><a name="p1898225604813"></a>可变参</p>
</td>
<td class="cellrowborder" valign="top" width="11.83%" headers="mcps1.1.5.1.2 "><p id="p1698217568486"><a name="p1698217568486"></a><a name="p1698217568486"></a>否</p>
</td>
<td class="cellrowborder" valign="top" width="15.21%" headers="mcps1.1.5.1.3 "><p id="p189834566489"><a name="p189834566489"></a><a name="p189834566489"></a>int32</p>
</td>
<td class="cellrowborder" valign="top" width="61.39%" headers="mcps1.1.5.1.4 "><p id="p9983175654814"><a name="p9983175654814"></a><a name="p9983175654814"></a>仅支持数字类型，最大支持6个变参。</p>
</td>
</tr>
</tbody>
</table>
1. 添加模块ID
在interfaces/kits/hilog\_lite/hiview\_log.h的HiLogModuleType中添加HILOG\_MODULE\_A定义。
```
typedef enum {
/** DFX */
HILOG_MODULE_HIVIEW = 0,
/** System Module A */
HILOG_MODULE_A,
/** Maximum number of modules */
HILOG_MODULE_MAX
} HiLogModuleType;
```
2. 注册模块
在模块的初始化流程中添加如下代码，注册模块到日志框架中：
```
HiLogRegisterModule(HILOG_MODULE_A, "A");
```
3. 调整DFX框架静态配置
根据需要调整如下文件的g\_hiviewConfig全局参数配置。默认情况下不用修改，日志默认输出到串口。
```
utils/lite/hiview_config.c
```
<a name="table15664428164516"></a>
<table><thead align="left"><tr id="row07061028154510"><th class="cellrowborder" valign="top" width="25.180000000000003%" id="mcps1.1.3.1.1"><p id="p10706128184514"><a name="p10706128184514"></a><a name="p10706128184514"></a>配置项</p>
</th>
<th class="cellrowborder" valign="top" width="74.82%" id="mcps1.1.3.1.2"><p id="p11706928194520"><a name="p11706928194520"></a><a name="p11706928194520"></a>取值及含义</p>
</th>
</tr>
</thead>
<tbody><tr id="row8706828154511"><td class="cellrowborder" valign="top" width="25.180000000000003%" headers="mcps1.1.3.1.1 "><p id="p19706112824514"><a name="p19706112824514"></a><a name="p19706112824514"></a>outputOption</p>
</td>
<td class="cellrowborder" valign="top" width="74.82%" headers="mcps1.1.3.1.2 "><p id="p9706528104512"><a name="p9706528104512"></a><a name="p9706528104512"></a>日志的输出方式。取值如下：</p>
<a name="ul113982579190"></a><a name="ul113982579190"></a><ul id="ul113982579190"><li>OUTPUT_OPTION_DEBUG日志不进行跨任务调度直接输出到串口，仅适合临时调测使用。</li><li>OUTPUT_OPTION_FLOW日志流式输出到串口（默认设置）。</li><li>OUTPUT_OPTION_TEXT_FILE 日志输出为文本文件。</li></ul>
</td>
</tr>
<tr id="row1270720281453"><td class="cellrowborder" valign="top" width="25.180000000000003%" headers="mcps1.1.3.1.1 "><p id="p137071528164516"><a name="p137071528164516"></a><a name="p137071528164516"></a>level</p>
</td>
<td class="cellrowborder" valign="top" width="74.82%" headers="mcps1.1.3.1.2 "><p id="p177071428154510"><a name="p177071428154510"></a><a name="p177071428154510"></a>日志的输出级别，仅输出大于等于该级别的日志。取值如下：</p>
<a name="ul1021772614515"></a><a name="ul1021772614515"></a><ul id="ul1021772614515"><li>HILOG_LV_DEBUG（默认设置）</li><li>HILOG_LV_INFO</li><li>HILOG_LV_WARN</li><li>HILOG_LV_ERROR</li><li>HILOG_LV_FATAL</li></ul>
</td>
</tr>
<tr id="row17707142814513"><td class="cellrowborder" valign="top" width="25.180000000000003%" headers="mcps1.1.3.1.1 "><p id="p11707192814517"><a name="p11707192814517"></a><a name="p11707192814517"></a>logSwitch</p>
</td>
<td class="cellrowborder" valign="top" width="74.82%" headers="mcps1.1.3.1.2 "><p id="p870711281452"><a name="p870711281452"></a><a name="p870711281452"></a>流水日志功能开关。编译前关闭不影响log组件初始化，默认打开。取值如下：</p>
<a name="ul1698616567457"></a><a name="ul1698616567457"></a><ul id="ul1698616567457"><li>HIVIEW_FEATURE_ON</li><li>HIVIEW_FEATURE_OFF</li></ul>
</td>
</tr>
<tr id="row6708132813453"><td class="cellrowborder" valign="top" width="25.180000000000003%" headers="mcps1.1.3.1.1 "><p id="p1570813280453"><a name="p1570813280453"></a><a name="p1570813280453"></a>dumpSwitch</p>
</td>
<td class="cellrowborder" valign="top" width="74.82%" headers="mcps1.1.3.1.2 "><p id="p970852810459"><a name="p970852810459"></a><a name="p970852810459"></a>dump功能开关。编译前关闭则不再初始化DUMP组件，默认关闭。取值如下：</p>
<a name="ul122703764613"></a><a name="ul122703764613"></a><ul id="ul122703764613"><li>HIVIEW_FEATURE_ON</li><li>HIVIEW_FEATURE_OFF</li></ul>
</td>
</tr>
<tr id="row87081282452"><td class="cellrowborder" valign="top" width="25.180000000000003%" headers="mcps1.1.3.1.1 "><p id="p11708128124511"><a name="p11708128124511"></a><a name="p11708128124511"></a>eventSwitch</p>
</td>
<td class="cellrowborder" valign="top" width="74.82%" headers="mcps1.1.3.1.2 "><p id="p17708202834519"><a name="p17708202834519"></a><a name="p17708202834519"></a>事件功能开关。编译前关闭则不再初始化Event组件，默认关闭。取值如下：</p>
<a name="ul845720186469"></a><a name="ul845720186469"></a><ul id="ul845720186469"><li>HIVIEW_FEATURE_ON</li><li>HIVIEW_FEATURE_OFF</li></ul>
</td>
</tr>
</tbody>
</table>
4. 在模块的Build.gn文件中添加头文件依赖
```
include_dirs = [
"//base/hiviewdfx/interfaces/kits/hilog_lite",
]
```
5. 日志打印
在需要打印日志的.c文件中增加头文件依赖\#include "log.h"，并调用如下接口：
```
HILOG_DEBUG(HILOG_MODULE_A, "log test: %d", 88);
```
## 使用mini框架实例<a name="section153112047155419"></a>
以下引用samgr\_lite模块使用mini框架作为实例。
1. 添加模块ID，在base/hiviewdfx/interfaces/kits/hilog\_lite/hiview\_log.h的类型定义结构体中添加HILOG\_MODULE\_SAMGR定义。
```
typedef enum {
...
HILOG_MODULE_SAMGR,
...
} HiLogModuleType;
```
2. 注册模块，在base/hiviewdfx/frameworks/hilog\_lite/mini/hiview\_log.c的HiLogInit函数中添加注册代码。
```
HiLogRegisterModule(HILOG_MODULE_SAMGR, "SAMGR");
```
3. 在GN文件中添加头文件依赖，文件路径为：foundation/distributedschedule/services/samgr\_lite/samgr/source/BUILD.gn
```
include_dirs = [
"//base/hiviewdfx/interfaces/kits/hilog_lite",
]
```
4. 源文件foundation/distributedschedule/services/samgr\_lite/samgr/source/message.c中引用头文件并调用接口。
```
#include <log.h>
uint32 *SAMGR_SendSharedRequest(const Identity *identity, const Request *request, uint32 *token, Handler handler)
{
...
if (err != EC_SUCCESS) {
HILOG_ERROR(HILOG_MODULE_SAMGR, "SharedSend [%p] failed(%d)!", identity->queueId, err);
(void)FreeReference(&exchange);
}
...
}
```
subsystems/公共基础.md 0 → 100644
浏览文件 @ 37cc208b
# 公共基础<a name="ZH-CN_TOPIC_0000001074066259"></a>
- **[公共基础库概述](公共基础库概述.md)**
- **[公共基础库开发指导](公共基础库开发指导.md)**
- **[公共基础库常见问题](公共基础库常见问题.md)**
subsystems/公共基础库常见问题.md 0 → 100644
浏览文件 @ 37cc208b
# 公共基础库常见问题<a name="ZH-CN_TOPIC_0000001058735275"></a>
- [1.LiteOS-A内核\(Hi3516、Hi3518平台\)KV存储路径设置错误，导致KV存储运行失败](#section2041345718513)
## 1.LiteOS-A内核\(Hi3516、Hi3518平台\)KV存储路径设置错误，导致KV存储运行失败<a name="section2041345718513"></a>
**现象描述**
LiteOS-A内核\(Hi3516、Hi3518平台\)直接调用KV存储提供的接口，各参数正常的情况下，编译可执行程序运行失败。
**可能原因**
直接运行编译出的可执行文件，没有将程序基于AbilityKit转换成应用，不能由BMS在应用安装时正确设置应用数据存储路径，导致KV存储运行失败。
**解决办法**
显示调用KV存储的UtilsSetEnv接口，设置数据存储路径。
```
UtilsSetEnv("/storage/com.huawei.kv");
```
subsystems/公共基础库开发指导.md 0 → 100644
浏览文件 @ 37cc208b
# 公共基础库开发指导<a name="ZH-CN_TOPIC_0000001059307279"></a>
- [接口说明](#section1633115419401)
- [开发步骤](#section4207112818418)
## 接口说明<a name="section1633115419401"></a>
**表 1** 文件操作接口说明
<a name="table1171894475019"></a>
<table><thead align="left"><tr id="row1471814441508"><th class="cellrowborder" valign="top" width="45.540000000000006%" id="mcps1.2.3.1.1"><p id="p11718174425016"><a name="p11718174425016"></a><a name="p11718174425016"></a>接口名</p>
</th>
<th class="cellrowborder" valign="top" width="54.459999999999994%" id="mcps1.2.3.1.2"><p id="p6718124475013"><a name="p6718124475013"></a><a name="p6718124475013"></a>描述</p>
</th>
</tr>
</thead>
<tbody><tr id="row671818445506"><td class="cellrowborder" valign="top" width="45.540000000000006%" headers="mcps1.2.3.1.1 "><p id="p871814441501"><a name="p871814441501"></a><a name="p871814441501"></a>int UtilsFileOpen(const char* path, int oflag, int mode)</p>
</td>
<td class="cellrowborder" valign="top" width="54.459999999999994%" headers="mcps1.2.3.1.2 "><p id="p127181444165016"><a name="p127181444165016"></a><a name="p127181444165016"></a>打开或创建文件</p>
</td>
</tr>
<tr id="row1171874420507"><td class="cellrowborder" valign="top" width="45.540000000000006%" headers="mcps1.2.3.1.1 "><p id="p1671884419509"><a name="p1671884419509"></a><a name="p1671884419509"></a>int UtilsFileClose(int fd)</p>
</td>
<td class="cellrowborder" valign="top" width="54.459999999999994%" headers="mcps1.2.3.1.2 "><p id="p1071884416504"><a name="p1071884416504"></a><a name="p1071884416504"></a>关闭文件</p>
</td>
</tr>
<tr id="row6718744105017"><td class="cellrowborder" valign="top" width="45.540000000000006%" headers="mcps1.2.3.1.1 "><p id="p137181644145015"><a name="p137181644145015"></a><a name="p137181644145015"></a>int UtilsFileRead(int fd, char *buf, unsigned int len)</p>
</td>
<td class="cellrowborder" valign="top" width="54.459999999999994%" headers="mcps1.2.3.1.2 "><p id="p1171854410509"><a name="p1171854410509"></a><a name="p1171854410509"></a>读取特定长度的文件数据</p>
</td>
</tr>
<tr id="row2071817440509"><td class="cellrowborder" valign="top" width="45.540000000000006%" headers="mcps1.2.3.1.1 "><p id="p17718144465012"><a name="p17718144465012"></a><a name="p17718144465012"></a>int UtilsFileWrite(int fd, const char *buf, unsigned int len)</p>
</td>
<td class="cellrowborder" valign="top" width="54.459999999999994%" headers="mcps1.2.3.1.2 "><p id="p67191444145012"><a name="p67191444145012"></a><a name="p67191444145012"></a>向文件写入特定大小的数据</p>
</td>
</tr>
<tr id="row471974425019"><td class="cellrowborder" valign="top" width="45.540000000000006%" headers="mcps1.2.3.1.1 "><p id="p11719174475016"><a name="p11719174475016"></a><a name="p11719174475016"></a>int UtilsFileDelete(const char *path)</p>
</td>
<td class="cellrowborder" valign="top" width="54.459999999999994%" headers="mcps1.2.3.1.2 "><p id="p2071919446507"><a name="p2071919446507"></a><a name="p2071919446507"></a>删除指定文件</p>
</td>
</tr>
<tr id="row1071964425013"><td class="cellrowborder" valign="top" width="45.540000000000006%" headers="mcps1.2.3.1.1 "><p id="p20719114405010"><a name="p20719114405010"></a><a name="p20719114405010"></a>int UtilsFileStat(const char *path, unsigned int *fileSize)</p>
</td>
<td class="cellrowborder" valign="top" width="54.459999999999994%" headers="mcps1.2.3.1.2 "><p id="p8719144435015"><a name="p8719144435015"></a><a name="p8719144435015"></a>获取文件大小</p>
</td>
</tr>
<tr id="row2071924417504"><td class="cellrowborder" valign="top" width="45.540000000000006%" headers="mcps1.2.3.1.1 "><p id="p57193447501"><a name="p57193447501"></a><a name="p57193447501"></a>int UtilsFileSeek(int fd, int offset, unsigned int whence)</p>
</td>
<td class="cellrowborder" valign="top" width="54.459999999999994%" headers="mcps1.2.3.1.2 "><p id="p1071934495014"><a name="p1071934495014"></a><a name="p1071934495014"></a>重新定位文件读/写偏移量</p>
</td>
</tr>
<tr id="row1135017417557"><td class="cellrowborder" valign="top" width="45.540000000000006%" headers="mcps1.2.3.1.1 "><p id="p2350184112554"><a name="p2350184112554"></a><a name="p2350184112554"></a>int UtilsFileCopy(const char* src, const char* dest)</p>
</td>
<td class="cellrowborder" valign="top" width="54.459999999999994%" headers="mcps1.2.3.1.2 "><p id="p113501041155511"><a name="p113501041155511"></a><a name="p113501041155511"></a>将源文件复制一份并存储到目标文件</p>
</td>
</tr>
<tr id="row11216645145517"><td class="cellrowborder" valign="top" width="45.540000000000006%" headers="mcps1.2.3.1.1 "><p id="p192171345105519"><a name="p192171345105519"></a><a name="p192171345105519"></a>int UtilsFileMove(const char* src, const char* dest)</p>
</td>
<td class="cellrowborder" valign="top" width="54.459999999999994%" headers="mcps1.2.3.1.2 "><p id="p921744595517"><a name="p921744595517"></a><a name="p921744595517"></a>将源文件移动到指定目标文件</p>
</td>
</tr>
</tbody>
</table>
文件操作使用示例：
```
// open && write
char fileName[] = "testfile";
static const char def[] = "utils_file_operation implement.";
int fd = UtilsFileOpen(fileName, O_RDWR_FS | O_CREAT_FS | O_TRUNC_FS, 0);
printf("file handle = %d\n", fd);
int ret = UtilsFileWrite(fd, def, strlen(def));
printf("write ret = %d\n", ret);
// seek
ret = UtilsFileSeek(fd, 5, SEEK_SET_FS);
printf("lseek ret = %d\n", ret);
// read && close
char buf[64] = {0};
int readLen = UtilsFileRead(fd, buf, 64);
ret = UtilsFileClose(fd);
printf("read len = %d : buf = %s\n", readLen, buf);
// stat
int fileLen = 0;
ret = UtilsFileStat(fileName, &fileLen);
printf("file size = %d\n", fileLen);
// delete
ret = UtilsFileDelete(fileName);
printf("delete ret = %d\n", ret);
```
**表 2** KV存储接口说明
<a name="table1731550155318"></a>
<table><thead align="left"><tr id="row4419501537"><th class="cellrowborder" valign="top" width="57.38999999999999%" id="mcps1.2.3.1.1"><p id="p54150165315"><a name="p54150165315"></a><a name="p54150165315"></a>接口名</p>
</th>
<th class="cellrowborder" valign="top" width="42.61%" id="mcps1.2.3.1.2"><p id="p941150145313"><a name="p941150145313"></a><a name="p941150145313"></a>描述</p>
</th>
</tr>
</thead>
<tbody><tr id="row34145016535"><td class="cellrowborder" valign="top" width="57.38999999999999%" headers="mcps1.2.3.1.1 "><p id="p980953910190"><a name="p980953910190"></a><a name="p980953910190"></a>int UtilsGetValue(const char* key, char* value, unsigned int len)</p>
</td>
<td class="cellrowborder" valign="top" width="42.61%" headers="mcps1.2.3.1.2 "><p id="p13562171015712"><a name="p13562171015712"></a><a name="p13562171015712"></a>提供给上层应用根据key获取对应数据项</p>
</td>
</tr>
<tr id="row1746172917474"><td class="cellrowborder" valign="top" width="57.38999999999999%" headers="mcps1.2.3.1.1 "><p id="p242913617818"><a name="p242913617818"></a><a name="p242913617818"></a>int UtilsSetValue(const char* key, const char* value)</p>
</td>
<td class="cellrowborder" valign="top" width="42.61%" headers="mcps1.2.3.1.2 "><p id="p2431455765"><a name="p2431455765"></a><a name="p2431455765"></a>提供给上层应用用于存储/更新key对应数据项</p>
</td>
</tr>
<tr id="row10992232154714"><td class="cellrowborder" valign="top" width="57.38999999999999%" headers="mcps1.2.3.1.1 "><p id="p118151439111910"><a name="p118151439111910"></a><a name="p118151439111910"></a>int UtilsDeleteValue(const char* key)</p>
</td>
<td class="cellrowborder" valign="top" width="42.61%" headers="mcps1.2.3.1.2 "><p id="p126575774517"><a name="p126575774517"></a><a name="p126575774517"></a>提供给上层应用删除key对应数据项</p>
</td>
</tr>
</tbody>
</table>
KV存储使用示例：
```
// set
char key[] = "rw.sys.version_100";
char value[] = "Hello kv operation implement!";
int ret = UtilsSetValue(key, value);
printf("UtilsSetValue set ret = %d\n", ret);
// get
char temp[128] = {0};
ret = UtilsGetValue(key, temp, 128);
printf("UtilsGetValue get ret = %d, temp = %s\n", ret, temp);
// delete
ret = UtilsDeleteValue(key);
printf("UtilsDeleteValue delete ret = %d\n", ret);
```
## 开发步骤<a name="section4207112818418"></a>
<a name="table15992315220"></a>
<table><thead align="left"></thead>
<tbody></tbody>
</table>
LiteOS-A内核\(Hi3516、Hi3518平台\)KV存储的native应用开发步骤：
1. 基于AbilityKit开发KV存储的native应用。
- 基于KV存储提供的接口编写用户程序，并编译出so（libLauncher.so）文件。
```
// set
char key[] = "rw.sys.version_100";
char value[] = "Hello kv operation implement!";
int ret = UtilsSetValue(key, value);
printf("UtilsSetValue set ret = %d\n", ret);
// get
char temp[128] = {0};
ret = UtilsGetValue(key, temp, 128);
printf("UtilsGetValue get ret = %d, temp = %s\n", ret, temp);
// delete
ret = UtilsDeleteValue(key);
printf("UtilsDeleteValue delete ret = %d\n", ret);
```
- 编写config.json文件，内容如下：
```
{
"app": {
"bundleName": "com.huawei.launcher",
"vendor": "huawei",
"version": {
"code": 1,
"name": "1.0"
}
},
"deviceConfig": {
"default": {
"reqSdk": {
"compatible": "zsdk 1.0.0",
"target": "zsdk 1.0.1"
},
"keepAlive": false
},
"smartCamera": {
"reqSdk": {
"compatible": "zsdk 1.0.0",
"target": "zsdk 1.0.1"
},
"keepAlive": false
}
},
"module": {
"package": "com.huawei.launcher",
"name": ".MyHarmonyAbilityPackage",
"deviceType": [
"phone", "tv","tablet", "pc","car","smartWatch","sportsWatch","smartCamera"
],
"distro": {
"deliveryWithInstall": true,
"moduleName": "Launcher",
"moduleType": "entry"
},
"abilities": [{
"name": "MainAbility",
"icon": "res/drawable/phone.png",
"label": "test app 1",
"launchType": "standard",
"type": "page"
},
{
"name": "SecondAbility",
"icon": "res/drawable/phone.png",
"label": "test app 2",
"launchType": "standard",
"type": "page"
},
{
"name": "ServiceAbility",
"icon": "res/drawable/phone.png",
"label": "test app 2",
"launchType": "standard",
"type": "service"
}
]
}
}
```
- 生成hap包。
- 按照如下目录结构存放文件，res/drawable下面放置资源文件：
![](figures/unnaming.png)
- 将上述文件打包生成zip包，修改后缀为.hap，例如Launcher.hap
2. 连接单板，通过串口向单板发送安装KV存储native应用的命令。
```
./nfs/dev_tools/bin/bm install -p /nfs/Launcher.hap
```
3. 通过串口向单板发送运行KV存储native应用的命令。
```
./nfs/dev_tools/bin/aa start -p com.huawei.launcher -n ServiceAbility
```
subsystems/公共基础库概述.md 0 → 100644
浏览文件 @ 37cc208b
# 公共基础库概述<a name="ZH-CN_TOPIC_0000001060172974"></a>
公共基础库存放OpenHarmony通用的基础组件。这些基础组件可被OpenHarmony各业务子系统及上层应用所使用。
公共基础库在不同平台上提供的能力：
LiteOS-M内核\(Hi3861平台\)：KV存储、文件操作、IoT外设控制。
LiteOS-A内核\(Hi3516、Hi3518平台\)：KV存储、定时器、数据和文件存储的JS API。
subsystems/分布式远程启动.md
浏览文件 @ 37cc208b
# 分布式远程启动<a name="ZH-CN_TOPIC_0000001052857955"></a> # 分布式远程启动<a name="ZH-CN_TOPIC_0000001051071561"></a>
- [概述](#zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_section186634310418) - [概述](#section186634310418)
- [基本概念](#zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_section982651246) - [基本概念](#section982651246)
- [接口说明](#zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_section125479541744) - [接口说明](#section125479541744)
- [约束与限制](#zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_section1165911177314) - [约束与限制](#section1165911177314)
- [开发步骤](#zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_section34171333656) - [开发步骤](#section34171333656)
## 概述<a name="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_section186634310418"></a> ## 概述<a name="section186634310418"></a>
分布式任务调度模块，通过主从设备服务代理机制，在HarmonyOS操作系统上建立起分布式服务平台，支持主设备\(搭载HarmonyOS的智慧屏设备\)启动从设备\(IP Camera、运动手表等小内存HarmonyOS设备\)FA的能力。 分布式任务调度模块，通过主从设备服务代理机制，在OpenHarmony操作系统上建立起分布式服务平台，支持主设备\(搭载OpenHarmony的智慧屏设备\)启动从设备\(IP Camera、运动手表等小内存OpenHarmony设备\)FA的能力。
以智慧屏节目开播提醒为例，智慧屏上在喜欢的节目菜单中，点击“开播后提醒我”按钮，等节目开播后，智慧屏会拉起运动手表上的节目开播提醒FA。通过该FA用户可以快速知道喜欢的节目已经开始，达到协同互助的作用。 以智慧屏节目开播提醒为例，智慧屏上在喜欢的节目菜单中，点击“开播后提醒我”按钮，等节目开播后，智慧屏会拉起运动手表上的节目开播提醒FA。通过该FA用户可以快速知道喜欢的节目已经开始，达到协同互助的作用。
## 基本概念<a name="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_section982651246"></a> ## 基本概念<a name="section982651246"></a>
- FA - FA
Feature Ability代表有界面的元能力，用于与用户进行交互。 Feature Ability代表有界面的Ability，用于与用户进行交互。
- 远程启动 - 远程启动
...@@ -24,22 +24,22 @@ ...@@ -24,22 +24,22 @@
即跨设备启动FA，与本地启动FA相对应。 即跨设备启动FA，与本地启动FA相对应。
## 接口说明<a name="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_section125479541744"></a> ## 接口说明<a name="section125479541744"></a>
智慧屏端分布式开放能力如下表，包含在AbilitySlice类中，具体的API接口详见HarmonyOS应用接入接口文档： 智慧屏端分布式开放能力如下表，包含在AbilitySlice类中，具体的API接口详见OpenHarmony应用接入接口文档：
**表 1** 分布式远程启动FA的API接口功能介绍 **表 1** 分布式远程启动FA的API接口功能介绍
<a name="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_table1731550155318"></a> <a name="table1731550155318"></a>
<table><thead align="left"><tr id="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_row4419501537"><th class="cellrowborder" valign="top" width="57.38999999999999%" id="mcps1.2.3.1.1"><p id="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_p54150165315"><a name="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_p54150165315"></a><a name="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_p54150165315"></a>接口名</p> <table><thead align="left"><tr id="row4419501537"><th class="cellrowborder" valign="top" width="57.38999999999999%" id="mcps1.2.3.1.1"><p id="p54150165315"><a name="p54150165315"></a><a name="p54150165315"></a>接口名</p>
</th> </th>
<th class="cellrowborder" valign="top" width="42.61%" id="mcps1.2.3.1.2"><p id="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_p941150145313"><a name="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_p941150145313"></a><a name="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_p941150145313"></a>描述</p> <th class="cellrowborder" valign="top" width="42.61%" id="mcps1.2.3.1.2"><p id="p941150145313"><a name="p941150145313"></a><a name="p941150145313"></a>描述</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_row34145016535"><td class="cellrowborder" valign="top" width="57.38999999999999%" headers="mcps1.2.3.1.1 "><p id="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_p1682733119213"><a name="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_p1682733119213"></a><a name="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_p1682733119213"></a>void startAbility(Want want)</p> <tbody><tr id="row34145016535"><td class="cellrowborder" valign="top" width="57.38999999999999%" headers="mcps1.2.3.1.1 "><p id="p1682733119213"><a name="p1682733119213"></a><a name="p1682733119213"></a>void startAbility(Want want)</p>
</td> </td>
<td class="cellrowborder" valign="top" width="42.61%" headers="mcps1.2.3.1.2 "><p id="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_p13562171015712"><a name="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_p13562171015712"></a><a name="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_p13562171015712"></a>远程启动FA，Want参数命名以实际开发平台API为准。</p> <td class="cellrowborder" valign="top" width="42.61%" headers="mcps1.2.3.1.2 "><p id="p13562171015712"><a name="p13562171015712"></a><a name="p13562171015712"></a>远程启动FA，Want参数命名以实际开发平台API为准。</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
...@@ -47,32 +47,32 @@ ...@@ -47,32 +47,32 @@
**表 2** 参数Want功能介绍 **表 2** 参数Want功能介绍
<a name="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_table02120432364"></a> <a name="table02120432364"></a>
<table><thead align="left"><tr id="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_row172294315361"><th class="cellrowborder" valign="top" width="5.780578057805781%" id="mcps1.2.4.1.1"><p id="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_p722144318360"><a name="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_p722144318360"></a><a name="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_p722144318360"></a>参数名</p> <table><thead align="left"><tr id="row172294315361"><th class="cellrowborder" valign="top" width="5.780578057805781%" id="mcps1.2.4.1.1"><p id="p722144318360"><a name="p722144318360"></a><a name="p722144318360"></a>参数名</p>
</th> </th>
<th class="cellrowborder" valign="top" width="29.322932293229325%" id="mcps1.2.4.1.2"><p id="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_p10227434363"><a name="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_p10227434363"></a><a name="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_p10227434363"></a>类型</p> <th class="cellrowborder" valign="top" width="29.322932293229325%" id="mcps1.2.4.1.2"><p id="p10227434363"><a name="p10227434363"></a><a name="p10227434363"></a>类型</p>
</th> </th>
<th class="cellrowborder" valign="top" width="64.89648964896489%" id="mcps1.2.4.1.3"><p id="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_p22284383616"><a name="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_p22284383616"></a><a name="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_p22284383616"></a>说明</p> <th class="cellrowborder" valign="top" width="64.89648964896489%" id="mcps1.2.4.1.3"><p id="p22284383616"><a name="p22284383616"></a><a name="p22284383616"></a>说明</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_row3228436365"><td class="cellrowborder" valign="top" width="5.780578057805781%" headers="mcps1.2.4.1.1 "><p id="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_p1391227193713"><a name="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_p1391227193713"></a><a name="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_p1391227193713"></a>want</p> <tbody><tr id="row3228436365"><td class="cellrowborder" valign="top" width="5.780578057805781%" headers="mcps1.2.4.1.1 "><p id="p1391227193713"><a name="p1391227193713"></a><a name="p1391227193713"></a>want</p>
</td> </td>
<td class="cellrowborder" valign="top" width="29.322932293229325%" headers="mcps1.2.4.1.2 "><p id="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_p20993611193719"><a name="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_p20993611193719"></a><a name="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_p20993611193719"></a>ohos.aafwk.content.Want</p> <td class="cellrowborder" valign="top" width="29.322932293229325%" headers="mcps1.2.4.1.2 "><p id="p20993611193719"><a name="p20993611193719"></a><a name="p20993611193719"></a>ohos.aafwk.content.Want</p>
</td> </td>
<td class="cellrowborder" valign="top" width="64.89648964896489%" headers="mcps1.2.4.1.3 "><p id="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_p10555172211377"><a name="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_p10555172211377"></a><a name="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_p10555172211377"></a>当开发者需要调用该接口启动远程FA时，需要显式指定待启动FA的设备id、bundleName和abilityName。</p> <td class="cellrowborder" valign="top" width="64.89648964896489%" headers="mcps1.2.4.1.3 "><p id="p10555172211377"><a name="p10555172211377"></a><a name="p10555172211377"></a>当开发者需要调用该接口启动远程FA时，需要显式指定待启动FA的设备id、bundleName和abilityName。</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
## 约束与限制<a name="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_section1165911177314"></a> ## 约束与限制<a name="section1165911177314"></a>
- 支持主设备侧远程启动从设备侧FA，不支持从设备远程启动主设备FA。 - 支持主设备侧远程启动从设备侧FA，不支持从设备远程启动主设备FA。
- 远程启动前必须确保HarmonyOS设备间分布式组网成功（需要在同一网段内，可互相ping通），否则无法远程启动。 - 远程启动前必须确保OpenHarmony设备间分布式组网成功（需要在同一网段内，可互相ping通），否则无法远程启动。
- 当前只支持拥有共同公钥信息的主从设备间FA（即主从设备的FA使用相同华为证书）的拉起。 - 当前只支持拥有共同公钥信息的主从设备间FA（即主从设备的FA使用相同华为证书）的拉起。
## 开发步骤<a name="zh-cn_topic_0000001052698169_zh-cn_topic_0000001051071561_section34171333656"></a> ## 开发步骤<a name="section34171333656"></a>
智慧屏侧通过如下操作启动从设备侧FA，从设备侧FA默认已开发。 智慧屏侧通过如下操作启动从设备侧FA，从设备侧FA默认已开发。
...@@ -93,7 +93,7 @@ ...@@ -93,7 +93,7 @@
} }
``` ```
3. 构造want，首先使用ElementName类表明需要启动的远端设备ID，包名，元能力类名，传入want中，然后设置want中的分布式标志位Want.FLAG\_ABILITYSLICE\_MULTI\_DEVICE表示需要远程启动。 3. 构造want，首先使用ElementName类表明需要启动的远端设备ID，包名，Ability类名，传入want中，然后设置want中的分布式标志位Want.FLAG\_ABILITYSLICE\_MULTI\_DEVICE表示需要远程启动。
``` ```
// 引入相关头文件 // 引入相关头文件
......
subsystems/参考.md 0 → 100644
浏览文件 @ 37cc208b
# 参考<a name="ZH-CN_TOPIC_0000001063223654"></a>
- [包结构说明](#section5487173174316)
## 包结构说明<a name="section5487173174316"></a>
**表 1** 轻量级DFX子系统源代码目录结构
<a name="table66755210373"></a>
<table><thead align="left"><tr id="row56777233718"><th class="cellrowborder" valign="top" width="36.09%" id="mcps1.2.3.1.1"><p id="p1367713214377"><a name="p1367713214377"></a><a name="p1367713214377"></a>名称</p>
</th>
<th class="cellrowborder" valign="top" width="63.91%" id="mcps1.2.3.1.2"><p id="p36771228375"><a name="p36771228375"></a><a name="p36771228375"></a>描述</p>
</th>
</tr>
</thead>
<tbody><tr id="row66782283710"><td class="cellrowborder" valign="top" width="36.09%" headers="mcps1.2.3.1.1 "><p id="p1167811273717"><a name="p1167811273717"></a><a name="p1167811273717"></a>hiviewdfx/interface</p>
</td>
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.2.3.1.2 "><p id="p1467912223712"><a name="p1467912223712"></a><a name="p1467912223712"></a>存放所有对外接口定义头文件</p>
</td>
</tr>
<tr id="row1167910233715"><td class="cellrowborder" valign="top" width="36.09%" headers="mcps1.2.3.1.1 "><p id="p106801023374"><a name="p106801023374"></a><a name="p106801023374"></a>hiviewdfx/interfaces/kits/hilog</p>
</td>
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.2.3.1.2 "><p id="p668013223716"><a name="p668013223716"></a><a name="p668013223716"></a>featured框架流水日志对外接口定义</p>
</td>
</tr>
<tr id="row166801626377"><td class="cellrowborder" valign="top" width="36.09%" headers="mcps1.2.3.1.1 "><p id="p9681162123713"><a name="p9681162123713"></a><a name="p9681162123713"></a>hiviewdfx/interfaces/kits/hilog_lite</p>
</td>
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.2.3.1.2 "><p id="p16814213713"><a name="p16814213713"></a><a name="p16814213713"></a>mini框架流水日志对外接口定义</p>
</td>
</tr>
<tr id="row1568116218371"><td class="cellrowborder" valign="top" width="36.09%" headers="mcps1.2.3.1.1 "><p id="p868115223710"><a name="p868115223710"></a><a name="p868115223710"></a>hiviewdfx/interfaces/innerkits/hievent_lite</p>
</td>
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.2.3.1.2 "><p id="p66823263717"><a name="p66823263717"></a><a name="p66823263717"></a>mini框架事件打点对外接口定义</p>
</td>
</tr>
<tr id="row11682112203711"><td class="cellrowborder" valign="top" width="36.09%" headers="mcps1.2.3.1.1 "><p id="p96825213719"><a name="p96825213719"></a><a name="p96825213719"></a>hiviewdfx/services/hilogcat_lite</p>
</td>
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.2.3.1.2 "><p id="p36821528373"><a name="p36821528373"></a><a name="p36821528373"></a>流水日志相关服务和命令</p>
</td>
</tr>
<tr id="row1768314213719"><td class="cellrowborder" valign="top" width="36.09%" headers="mcps1.2.3.1.1 "><p id="p156830213710"><a name="p156830213710"></a><a name="p156830213710"></a>hiviewdfx/services/hilogcat_lite/apphilogcat</p>
</td>
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.2.3.1.2 "><p id="p176847283719"><a name="p176847283719"></a><a name="p176847283719"></a>featured框架流水日志落盘服务</p>
</td>
</tr>
<tr id="row16841212371"><td class="cellrowborder" valign="top" width="36.09%" headers="mcps1.2.3.1.1 "><p id="p2068419220378"><a name="p2068419220378"></a><a name="p2068419220378"></a>hiviewdfx/services/hilogcat_lite/command</p>
</td>
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.2.3.1.2 "><p id="p7684627377"><a name="p7684627377"></a><a name="p7684627377"></a>mini框架DFX命令</p>
</td>
</tr>
<tr id="row1068414210373"><td class="cellrowborder" valign="top" width="36.09%" headers="mcps1.2.3.1.1 "><p id="p18685127370"><a name="p18685127370"></a><a name="p18685127370"></a>hiviewdfx/services/hilogcat_lite/hilogcat</p>
</td>
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.2.3.1.2 "><p id="p1868515233717"><a name="p1868515233717"></a><a name="p1868515233717"></a>featured框架流水日志输出命令</p>
</td>
</tr>
<tr id="row568610243714"><td class="cellrowborder" valign="top" width="36.09%" headers="mcps1.2.3.1.1 "><p id="p6686720376"><a name="p6686720376"></a><a name="p6686720376"></a>hiviewdfx/services/hiview_lite</p>
</td>
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.2.3.1.2 "><p id="p196875293712"><a name="p196875293712"></a><a name="p196875293712"></a>DFX mini框架服务化注册</p>
</td>
</tr>
<tr id="row56871215376"><td class="cellrowborder" valign="top" width="36.09%" headers="mcps1.2.3.1.1 "><p id="p468710214371"><a name="p468710214371"></a><a name="p468710214371"></a>hiviewdfx/frameworks/ddrdump_lite</p>
</td>
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.2.3.1.2 "><p id="p2687152153717"><a name="p2687152153717"></a><a name="p2687152153717"></a>mini框架ddrdump信息转储</p>
</td>
</tr>
<tr id="row669011223710"><td class="cellrowborder" valign="top" width="36.09%" headers="mcps1.2.3.1.1 "><p id="p15690029377"><a name="p15690029377"></a><a name="p15690029377"></a>hiviewdfx/frameworks/hievent_lite</p>
</td>
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.2.3.1.2 "><p id="p56911927374"><a name="p56911927374"></a><a name="p56911927374"></a>mini框架事件打点记录实现</p>
</td>
</tr>
<tr id="row196911922371"><td class="cellrowborder" valign="top" width="36.09%" headers="mcps1.2.3.1.1 "><p id="p1969222203712"><a name="p1969222203712"></a><a name="p1969222203712"></a>hiviewdfx/frameworks/hilog_lite</p>
</td>
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.2.3.1.2 "><p id="p1669213210373"><a name="p1669213210373"></a><a name="p1669213210373"></a>流水日志接口实现</p>
</td>
</tr>
<tr id="row166921927372"><td class="cellrowborder" valign="top" width="36.09%" headers="mcps1.2.3.1.1 "><p id="p76931217377"><a name="p76931217377"></a><a name="p76931217377"></a>hiviewdfx/frameworks/hilog_lite/featured</p>
</td>
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.2.3.1.2 "><p id="p1069311212377"><a name="p1069311212377"></a><a name="p1069311212377"></a>featured框架流水日志接口实现</p>
</td>
</tr>
<tr id="row1669315213379"><td class="cellrowborder" valign="top" width="36.09%" headers="mcps1.2.3.1.1 "><p id="p7693152143719"><a name="p7693152143719"></a><a name="p7693152143719"></a>hiviewdfx/frameworks/hilog_lite/mini</p>
</td>
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.2.3.1.2 "><p id="p116931223711"><a name="p116931223711"></a><a name="p116931223711"></a>mini框架流水日志接口实现</p>
</td>
</tr>
<tr id="row769413216372"><td class="cellrowborder" valign="top" width="36.09%" headers="mcps1.2.3.1.1 "><p id="p769542113710"><a name="p769542113710"></a><a name="p769542113710"></a>hiviewdfx/utils/lite</p>
</td>
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.2.3.1.2 "><p id="p16951524379"><a name="p16951524379"></a><a name="p16951524379"></a>公共基础操作定义实现。包含了mini框架的config配置</p>
</td>
</tr>
</tbody>
</table>
subsystems/媒体.md 0 → 100644
浏览文件 @ 37cc208b
# 媒体<a name="ZH-CN_TOPIC_0000001074241327"></a>
- **[相机开发概述](相机开发概述.md)**
- **[拍照开发指导](拍照开发指导.md)**
- **[录像开发指导](录像开发指导.md)**
- **[预览开发指导](预览开发指导.md)**
- **[音视频开发概述](音视频开发概述.md)**
- **[音视频播放开发指导](音视频播放开发指导.md)**
- **[音视频录制开发指导](音视频录制开发指导.md)**
subsystems/常见问题-0.md 0 → 100644
浏览文件 @ 37cc208b
# 常见问题<a name="ZH-CN_TOPIC_0000001062423639"></a>
无
subsystems/常见问题.md 0 → 100644
浏览文件 @ 37cc208b
# 常见问题<a name="ZH-CN_TOPIC_0000001061877724"></a>
subsystems/开发实例.md 0 → 100644
浏览文件 @ 37cc208b
# 开发实例<a name="ZH-CN_TOPIC_0000001061399563"></a>
开发实例可参考[开源项目中的示例](https://gitee.com/openharmony/aafwk_frameworks_kits_ability_lite/tree/master/example)
subsystems/开发指导.md 0 → 100644
浏览文件 @ 37cc208b
# 开发指导<a name="ZH-CN_TOPIC_0000001062229264"></a>
- [场景介绍](#section93012287133)
- [接口说明](#section11821047161319)
- [开发步骤](#section10514141679)
- [创建Service类型的Ability](#section19921154214315)
- [包管理接口使用指导](#section1724016743217)
- [Hap包打包](#section171771212328)
## 场景介绍<a name="section93012287133"></a>
- 带界面的Ability的应用，比如：新闻类的应用、视频类的应用、导航类的应用、支付类的应用等等，目前我们看到的大部分应用都是带有界面的用于人机交互的应用。
- 不带界面的Ability应用，比如：音乐播放器能在后台播放音乐、后台提供计算服务、导航服务的各类应用等。
- 不管是带界面的Ability应用还是不带界面的Ability应用，都要打包成Hap包，最终发布到应用市场，用户通过应用市场下载安装相应的应用。
## 接口说明<a name="section11821047161319"></a>
**表 1** Ability子系统的对外接口
<a name="table36761640135514"></a>
<table><thead align="left"><tr id="row570215713380"><th class="cellrowborder" valign="top" width="53.849999999999994%" id="mcps1.2.3.1.1"><p id="p1703155733819"><a name="p1703155733819"></a><a name="p1703155733819"></a>接口名称</p>
</th>
<th class="cellrowborder" valign="top" width="46.150000000000006%" id="mcps1.2.3.1.2"><p id="p37035579380"><a name="p37035579380"></a><a name="p37035579380"></a>接口描述</p>
</th>
</tr>
</thead>
<tbody><tr id="row39211240205510"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p49215401550"><a name="p49215401550"></a><a name="p49215401550"></a>Want *WantParseUri(const char *uri)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p592164014553"><a name="p592164014553"></a><a name="p592164014553"></a>反序列化接口，由字符串生成Want对象。</p>
</td>
</tr>
<tr id="row192154055512"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p139212040175520"><a name="p139212040175520"></a><a name="p139212040175520"></a>const char *WantToUri(Want want)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p9921640135519"><a name="p9921640135519"></a><a name="p9921640135519"></a>序列化，把Want对象生成字符串。</p>
</td>
</tr>
<tr id="row16921440135520"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p1892124075519"><a name="p1892124075519"></a><a name="p1892124075519"></a>void SetWantElement(Want *want, ElementName element);</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p129214403555"><a name="p129214403555"></a><a name="p129214403555"></a>设置ElementName对象。</p>
</td>
</tr>
<tr id="row3921114018552"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p79210404555"><a name="p79210404555"></a><a name="p79210404555"></a>void SetWantData(Want *want, const void *data, uint16_t dataLength)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p09218402559"><a name="p09218402559"></a><a name="p09218402559"></a>设置数据。</p>
</td>
</tr>
<tr id="row892124013556"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p4921040155510"><a name="p4921040155510"></a><a name="p4921040155510"></a>bool SetWantSvcIdentity(Want *want, SvcIdentity sid)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p992204013553"><a name="p992204013553"></a><a name="p992204013553"></a>设置SvcIdentity。</p>
</td>
</tr>
<tr id="row99221840135520"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p139221840155519"><a name="p139221840155519"></a><a name="p139221840155519"></a>void ClearWant(Want *want)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p79221440185511"><a name="p79221440185511"></a><a name="p79221440185511"></a>清除Want的内部内存数据。</p>
</td>
</tr>
<tr id="row69221640125519"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p1792244017555"><a name="p1792244017555"></a><a name="p1792244017555"></a>void SetMainRoute(const std::string &amp;entry)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p7922174016558"><a name="p7922174016558"></a><a name="p7922174016558"></a>设置AbilitySlice主路由。</p>
</td>
</tr>
<tr id="row189221840165516"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p3922340125511"><a name="p3922340125511"></a><a name="p3922340125511"></a>void SetUIContent(RootView *rootView)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p9922240175511"><a name="p9922240175511"></a><a name="p9922240175511"></a>设置布局资源。</p>
</td>
</tr>
<tr id="row159226407552"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p1292213402552"><a name="p1292213402552"></a><a name="p1292213402552"></a>void OnStart(const Want&amp; intent)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p14922440195515"><a name="p14922440195515"></a><a name="p14922440195515"></a>Ability生命周期状态回调，Ability启动时被回调。</p>
</td>
</tr>
<tr id="row1392217402551"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p1292284065516"><a name="p1292284065516"></a><a name="p1292284065516"></a>void OnStop()</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p149223403554"><a name="p149223403554"></a><a name="p149223403554"></a>Ability生命周期状态回调，Ability销毁时被回调。</p>
</td>
</tr>
<tr id="row169221407555"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p992218400556"><a name="p992218400556"></a><a name="p992218400556"></a>void OnActive(const Want&amp; intent)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p1923440135515"><a name="p1923440135515"></a><a name="p1923440135515"></a>Ability生命周期状态回调，Ability显示时被回调。</p>
</td>
</tr>
<tr id="row9923640205516"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p19231340185511"><a name="p19231340185511"></a><a name="p19231340185511"></a>void OnInactive()</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p992311408556"><a name="p992311408556"></a><a name="p992311408556"></a>Ability生命周期状态回调，Ability隐藏时被回调。</p>
</td>
</tr>
<tr id="row4923154015557"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p99233404556"><a name="p99233404556"></a><a name="p99233404556"></a>void OnBackground()</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p79238400554"><a name="p79238400554"></a><a name="p79238400554"></a>Ability生命周期状态回调，Ability退到后台时被回调。</p>
</td>
</tr>
<tr id="row14923144045513"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p692354019558"><a name="p692354019558"></a><a name="p692354019558"></a>const SvcIdentity *OnConnect(const Want &amp;want)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p17923154085512"><a name="p17923154085512"></a><a name="p17923154085512"></a>Service类型Ability第一次连接时被回调。</p>
</td>
</tr>
<tr id="row592313405552"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p1692312404551"><a name="p1692312404551"></a><a name="p1692312404551"></a>void OnDisconnect(const Want &amp;want);</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p892394017551"><a name="p892394017551"></a><a name="p892394017551"></a>Service类型Ability断开连接被回调。</p>
</td>
</tr>
<tr id="row3923194075515"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p5923240175516"><a name="p5923240175516"></a><a name="p5923240175516"></a>void MsgHandle(uint32_t funcId, IpcIo *request, IpcIo *reply);</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p2923184055518"><a name="p2923184055518"></a><a name="p2923184055518"></a>Service类型Ability接收消息处理。</p>
</td>
</tr>
<tr id="row15923540155517"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p99231940105514"><a name="p99231940105514"></a><a name="p99231940105514"></a>void Dump(const std::string &amp;extra)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p18924174016554"><a name="p18924174016554"></a><a name="p18924174016554"></a>dump Ability信息。</p>
</td>
</tr>
<tr id="row1792414055517"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p1592454025513"><a name="p1592454025513"></a><a name="p1592454025513"></a>void Present(AbilitySlice *abilitySlice, const Want &amp;want)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p11924104045517"><a name="p11924104045517"></a><a name="p11924104045517"></a>发起AbilitySlice跳转。</p>
</td>
</tr>
<tr id="row15924114012556"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p13924154017551"><a name="p13924154017551"></a><a name="p13924154017551"></a>void Terminate()</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p11924104012557"><a name="p11924104012557"></a><a name="p11924104012557"></a>退出当前AbilitySlice。</p>
</td>
</tr>
<tr id="row2092484010558"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p4924540155515"><a name="p4924540155515"></a><a name="p4924540155515"></a>void SetUIContent(RootView *rootView)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p79241640185514"><a name="p79241640185514"></a><a name="p79241640185514"></a>设置当前AbilitySlice所在Ability的布局资源。</p>
</td>
</tr>
<tr id="row16924640195518"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p169245407559"><a name="p169245407559"></a><a name="p169245407559"></a>void OnStart(const Want&amp; want)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p492494095517"><a name="p492494095517"></a><a name="p492494095517"></a>AbilitySlice生命周期状态回调，AbilitySlice启动时被回调。</p>
</td>
</tr>
<tr id="row15924154065513"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p159242407559"><a name="p159242407559"></a><a name="p159242407559"></a>void OnStop()</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p13924114017556"><a name="p13924114017556"></a><a name="p13924114017556"></a>AbilitySlice生命周期状态回调，AbilitySlice销毁时被回调。</p>
</td>
</tr>
<tr id="row13924154065517"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p292494005513"><a name="p292494005513"></a><a name="p292494005513"></a>void OnActive(const Want&amp; want)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p89256408553"><a name="p89256408553"></a><a name="p89256408553"></a>AbilitySlice生命周期状态回调，AbilitySlice显示时被回调。</p>
</td>
</tr>
<tr id="row1925540125515"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p13925114015514"><a name="p13925114015514"></a><a name="p13925114015514"></a>void OnInactive()</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p892534025515"><a name="p892534025515"></a><a name="p892534025515"></a>AbilitySlice生命周期状态回调，AbilitySlice隐藏时被回调。</p>
</td>
</tr>
<tr id="row692519401558"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p1792515408558"><a name="p1792515408558"></a><a name="p1792515408558"></a>void OnBackground()</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p292554013551"><a name="p292554013551"></a><a name="p292554013551"></a>AbilitySlice生命周期状态回调，AbilitySlice退到后台时被回调。</p>
</td>
</tr>
<tr id="row129251040115515"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p0925174011553"><a name="p0925174011553"></a><a name="p0925174011553"></a>int StartAbility(const Want &amp;want)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p129251408557"><a name="p129251408557"></a><a name="p129251408557"></a>启动Ability。</p>
</td>
</tr>
<tr id="row3925940195519"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p19251440135512"><a name="p19251440135512"></a><a name="p19251440135512"></a>int StopAbility(const Want &amp;want)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p19925174035510"><a name="p19925174035510"></a><a name="p19925174035510"></a>停止Service类型的Ability。</p>
</td>
</tr>
<tr id="row14925164055520"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p14925114015553"><a name="p14925114015553"></a><a name="p14925114015553"></a>int TerminateAbility()</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p39254405557"><a name="p39254405557"></a><a name="p39254405557"></a>销毁当前的Ability。</p>
</td>
</tr>
<tr id="row19925940115515"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p892584015559"><a name="p892584015559"></a><a name="p892584015559"></a>int ConnectAbility(const Want &amp;want, const IAbilityConnection &amp;conn, void *data);</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p4926640165513"><a name="p4926640165513"></a><a name="p4926640165513"></a>绑定Service类型的Ability。</p>
</td>
</tr>
<tr id="row10926540155513"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p119267409559"><a name="p119267409559"></a><a name="p119267409559"></a>int DisconnectAbility(const IAbilityConnection &amp;conn)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p592644085512"><a name="p592644085512"></a><a name="p592644085512"></a>解绑Service类型的Ability。</p>
</td>
</tr>
<tr id="row11926340145516"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p892614035513"><a name="p892614035513"></a><a name="p892614035513"></a>const char *GetBundleName()</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p99261040105511"><a name="p99261040105511"></a><a name="p99261040105511"></a>获取当前ability的对应应用的包名。</p>
</td>
</tr>
<tr id="row7926440125519"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p4926114065519"><a name="p4926114065519"></a><a name="p4926114065519"></a>const char *GetSrcPath()</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p4926194055516"><a name="p4926194055516"></a><a name="p4926194055516"></a>获取当前ability的对应应用的安装路径。</p>
</td>
</tr>
<tr id="row29261840115519"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p1992604045519"><a name="p1992604045519"></a><a name="p1992604045519"></a>const char *GetDataPath()</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p109268403551"><a name="p109268403551"></a><a name="p109268403551"></a>获取当前ability的对应应用的数据路径。</p>
</td>
</tr>
<tr id="row29261940195516"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p159267407555"><a name="p159267407555"></a><a name="p159267407555"></a>int StartAbility(const Want *want)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p1340210145179"><a name="p1340210145179"></a><a name="p1340210145179"></a>启动Ability，该接口可以不需要在基于Ability开发的应用中使用。</p>
</td>
</tr>
<tr id="row16926240155514"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p1792617404558"><a name="p1792617404558"></a><a name="p1792617404558"></a>int ConnectAbility(const Want *want, const IAbilityConnection *conn, void *data);</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p1092612181812"><a name="p1092612181812"></a><a name="p1092612181812"></a>绑定Service类型的Ability，该接口可以不需要在基于Ability开发的应用中使用。</p>
</td>
</tr>
<tr id="row5927164010552"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p49271540165510"><a name="p49271540165510"></a><a name="p49271540165510"></a>int DisconnectAbility(const IAbilityConnection *conn);</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p1296152820189"><a name="p1296152820189"></a><a name="p1296152820189"></a>解绑Service类型的Ability，该接口可以不需要在基于Ability开发的应用中使用。</p>
</td>
</tr>
<tr id="row89271040135517"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p13927194011558"><a name="p13927194011558"></a><a name="p13927194011558"></a>int StopAbility(const Want *want)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p7699548131819"><a name="p7699548131819"></a><a name="p7699548131819"></a>停止Service类型的Ability，该接口可以不需要在基于Ability开发的应用中使用。</p>
</td>
</tr>
<tr id="row1992764065516"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p192716406556"><a name="p192716406556"></a><a name="p192716406556"></a>void (*OnAbilityConnectDone)(ElementName *elementName, SvcIdentity *serviceSid, int resultCode, void *data)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p0927940195510"><a name="p0927940195510"></a><a name="p0927940195510"></a>绑定Service Ability的回调。</p>
</td>
</tr>
<tr id="row7927134010559"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p692764095510"><a name="p692764095510"></a><a name="p692764095510"></a>void (*OnAbilityDisconnectDone)(ElementName *elementName, int resultCode, void *data)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p18927124035516"><a name="p18927124035516"></a><a name="p18927124035516"></a>解绑Service Ability的回调。</p>
</td>
</tr>
<tr id="row692784020556"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p17927104010557"><a name="p17927104010557"></a><a name="p17927104010557"></a>void PostTask(const Task&amp; task)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p13927940105516"><a name="p13927940105516"></a><a name="p13927940105516"></a>投递任务到异步线程进行处理。</p>
</td>
</tr>
<tr id="row392784013552"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p1092794014555"><a name="p1092794014555"></a><a name="p1092794014555"></a>void PostQuit()</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p19281940185510"><a name="p19281940185510"></a><a name="p19281940185510"></a>退出当前线程的消息循环。</p>
</td>
</tr>
<tr id="row2928140145519"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p292813401555"><a name="p292813401555"></a><a name="p292813401555"></a>static AbilityEventHandler* GetCurrentHandler()</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p9928154012554"><a name="p9928154012554"></a><a name="p9928154012554"></a>获取当前线程的事件处理器。</p>
</td>
</tr>
<tr id="row15928174035513"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p1692824017551"><a name="p1692824017551"></a><a name="p1692824017551"></a>void Run()</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p592820401558"><a name="p592820401558"></a><a name="p592820401558"></a>执行当前线程的消息循环。</p>
</td>
</tr>
<tr id="row15928174013554"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p17928440125516"><a name="p17928440125516"></a><a name="p17928440125516"></a>#define REGISTER_AA(className)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p1892817404554"><a name="p1892817404554"></a><a name="p1892817404554"></a>注册开发者的Ability到框架中。</p>
</td>
</tr>
<tr id="row17928640135519"><td class="cellrowborder" valign="top" width="53.849999999999994%" headers="mcps1.2.3.1.1 "><p id="p199281640125520"><a name="p199281640125520"></a><a name="p199281640125520"></a>#define REGISTER_AS(className)</p>
</td>
<td class="cellrowborder" valign="top" width="46.150000000000006%" headers="mcps1.2.3.1.2 "><p id="p1792811409556"><a name="p1792811409556"></a><a name="p1792811409556"></a>注册开发者的AbilitySlice到框架中。</p>
</td>
</tr>
</tbody>
</table>
## 开发步骤<a name="section10514141679"></a>
### 创建Service类型的Ability<a name="section19921154214315"></a>
1. 在my\_service\_ability.h中创建Ability的子类MyServiceAbility。
```
class MyServiceAbility: public Ability {
protected:
void OnStart(const Want& want);
const SvcIdentity *OnConnect(const Want &want) override;
void MsgHandle(uint32_t funcId, IpcIo *request, IpcIo *reply) override;
};
```
2. 调用REGISTER\_AA宏将ServiceAbility注册到应用框架中，以便应用框架实例化开发者的MyServiceAbility。
```
#include "my_service_ability.h"
REGISTER_AA(ServiceAbility)
void MyServiceAbility::OnStart(const Want& want)
{
printf("ServiceAbility::OnStart\n");
Ability::OnStart(want);
}
const SvcIdentity *MyServiceAbility::OnConnect(const Want &want)
{
printf("ServiceAbility::OnConnect\n");
return Ability::OnConnect(want);
}
void MyServiceAbility::MsgHandle(uint32_t funcId, IpcIo *request, IpcIo *reply)
{
printf("ServiceAbility::MsgHandle, funcId is %u\n", funcId);
int result = 0;
if (funcId == 0) {
result = IpcIoPopInt32(request) + IpcIoPopInt32(request);
}
// push data
IpcIoPushInt32(reply, result);
}
```
3. 实现Service相关的生命周期方法。Service也是一种Ability，Ability为服务提供了以下生命周期方法，用户可以重写这些方法来添加自己的处理。用户在重写的方法里，需要调用父类对应的方法。
- OnStart\(\)
该方法在创建Service的时候调用，用于做一些Service初始化且耗时较短的工作，在Service的整个生命周期只会调用一次。
```
void MyServiceAbility::OnStart(const Want& want)
{
printf("ServiceAbility::OnStart\n");
Ability::OnStart(want);
}
```
- OnConnect​\(\)
在组件和服务连接时调用，该方法返回SvcIdentity，组件可以通过它，与服务交互。
```
const SvcIdentity *MyServiceAbility::OnConnect(const Want &want)
{
printf("ServiceAbility::OnConnect\n");
return Ability::OnConnect(want);
}
```
- OnDisconnect​\(\)
在组件与绑定的Service断开连接时调用。
- OnStop\(\)
在Service销毁时调用。Service应通过实现此方法来清理任何资源，如关闭线程、注册的侦听器等。
4. 重写消息处理方法。
MsgHandle是Service用来处理客户端消息的方法。其中funcId是客户端传过来的消息类型，request是客户端传过来的序列化请求参数。如果用户在处理完成之后想要把结果传回去，需要把结果序列化后写入reply中。
```
void ServiceAbility::MsgHandle(uint32_t funcId, IpcIo *request, IpcIo *reply)
{
printf("ServiceAbility::MsgHandle, funcId is %d\n", funcId);
int result = 0;
if (funcId == PLUS) {
result = IpcIoPopInt32(request) + IpcIoPopInt32(request);
}
// push data
IpcIoPushInt32(reply, result);
}
```
5. 注册Service。
Service也需要在应用清单文件config.json中进行注册，注册类型type需要设置为service。
```
"abilities": [{
"name": "ServiceAbility",
"icon": "res/drawable/phone.png",
"label": "test app 2",
"launchType": "standard",
"type": "service",
"visible": true
}
]
```
6. 启动Service。
- Ability为用户提供了StartAbility\(\)方法来启动另外一个Ability，因为Service也是Ability的一种，开发者同样可以通过将Want传递给该方法来启动Service。
开发者可以通过Want的SetWantElement \(\)来设置目标服务信息。ElementName结构体的两个主要参数：第一个参数为包名称；第二个参数为目标Ability。
```
{
Want want = { nullptr };
ElementName element = { nullptr };
SetElementBundleName(&element, "com.company.appname");
SetElementAbilityName(&element, "ServiceAbility");
SetWantElement(&want, element);
StartAbility(want);
ClearElement(&element);
ClearWant(&want);
}
```
StartAbility\(\) 方法会立即执行，如果Service尚未运行，则系统首先会调用OnStart\(\)。
- 停止Service。
Service一旦创建就会一直保持在后台运行，开发者可以通过调用StopAbility\(\)来停止Service。
7. 连接Service。
- 如果Service需要与Page Ability或其他应用组件中的Service进行交互，则应创建用于连接的Service。Service支持其他Ability通过ConnectAbility\(\)与其进行连接，ConnectAbility\(\)需要传入目标Service的Want，以及IAbilityConnection的实例来处理回调。IAbilityConnection提供了两个方法供用户实现，OnAbilityConnectDone\(\)用来处理连接的回调，OnAbilityDisconnectDone\(\)用来处理断开连接的回调。
```
{
// ability创建IAbilityConnection对象和定义IAbilityConnection的两个方法实现
IAbilityConnection abilityConnection = new IAbilityConnection();
abilityConnection->OnAbilityConnectDone = OnAbilityConnectDone;
abilityConnection->OnAbilityDisconnectDone = OnAbilityDisconnectDone;
void OnAbilityConnectDone(ElementName *elementName, SvcIdentity *serviceSid,
int resultCode, void *data)
{
if (resultCode != 0) {
return;
}
// push data
IpcIo request;
char dataBuffer[IPC_IO_DATA_MAX];
IpcIoInit(&request, dataBuffer, IPC_IO_DATA_MAX, 0);
IpcIoPushInt32(&request, 10);
IpcIoPushInt32(&request, 6);
// send and getReply
IpcIo reply;
uintptr_t ptr = 0;
if (Transact(nullptr, *serviceSid, 0, &request, &reply,
LITEIPC_FLAG_DEFAULT, &ptr) != LITEIPC_OK) {
printf("transact error\n");
return;
}
int result = IpcIoPopInt32(&reply);
printf("execute add method, result is %d\n", result);
if (ptr != 0) {
FreeBuffer(nullptr, reinterpret_cast<void *>(ptr));
}
}
void OnAbilityDisconnectDone(ElementName *elementName,
int resultCode, void *data)
{
printf("elementName is %s, %s\n",
elementName->bundleName, elementName->abilityName);
}
}
```
- 发起connect和disconnect。
```
{
// ability发起connect
Want want = { nullptr };
ElementName element = { nullptr };
SetElementBundleName(&element, "com.company.appname");
SetElementAbilityName(&element, "ServiceAbility");
SetWantElement(&want, element);
ConnectAbility(want, *abilityConnection, this);
// ability发起disconnect
DisconnectAbility(*abilityConnection);
}
```
### 包管理接口使用指导<a name="section1724016743217"></a>
**安装应用**
安装接口只能给内置的系统应用使用。根据应用的安装路径，可以在安装应用时进行选择：
- 将应用安装到系统默认的文件目录/storage/app/。
- 将应用安装到系统外挂的存储介质中，例如micro sdcard。
这两种选择可以在创建InstallParam实例的时候指定，当InstallParam的成员变量installLocation为 INSTALL\_LOCATION\_INTERNAL\_ONLY时，意味着应用将会被安装到/storage/app/目录下；当InstallParam的成员变量installLocation为INSTALL\_LOCATION\_PREFER\_EXTERNAL时，意味着应用将被安装到存储介质，其安装目录是/sdcard/app/。由于安装应用的过程是异步的，所以需要使用类似信号量的机制来确保安装的回调可以被执行。
安装应用的步骤如下（示例代码以安装到系统目录为例）：
1. 将经过安全签名的应用放置于指定的目录下。
2. 创建InstallParam实例和信号量。
```
InstallParam installParam = {
.installLocation = INSTALL_LOCATION_INTERNAL_ONLY, // 安装到系统目录
.keepData = false
};
static sem_t g_sem;
```
3. 定义回调函数。
```
static void InstallCallback(const uint8_t resultCode, const void *resultMessage)
{
std::string strMessage = reinterpret_cast<const char *>(resultMessage);
if (!strMessage.empty()) {
printf("install resultMessage is %s, %d\n", strMessage.c_str(),resultCode);
}
sem_post(&g_sem);
}
```
4. 调用Install接口。
```
const uint32_t WAIT_TIMEOUT = 30;
sem_init(&g_sem, 0, 0);
std::string installPath = “/storage/bundle/demo.hap”; // hap包的存储路径
bool result = Install(installPath.c_str(), &installParam, InstallCallback);
struct timespec ts = {};
clock_gettime(CLOCK_REALTIME, &ts);
ts.tv_sec += WAIT_TIMEOUT; // 超时即释放信号量
sem_timedwait(&g_sem, &ts);
```
**卸载应用**
卸载应用的时候可以选择是否保留应用的数据，开发者可以通过创建的InstallParam实例的成员变量keepData来确定。当keepData为true, 卸载应用之后将保留应用的数据，当keepData为false时，卸载应用之后将不会保留应用的数据。
1. 创建InstallParam实例和信号量。
```
static sem_t g_sem;
InstallParam installParam = {
.installLocation = 1,
.keepData = false // 不保留应用数据
};
```
2. 定义回调函数。
```
static void UninstallCallback(const uint8_t resultCode, const void *resultMessage)
{
std::string strMessage = reinterpret_cast<const char *>(resultMessage);
if (!strMessage.empty()) {
printf("uninstall resultMessage is %s\n", strMessage.c_str());
g_resultMessage = strMessage;
}
g_resultCode = resultCode;
sem_post(&g_sem);
}
```
3. 调用Uninstall接口。
```
sem_init(&g_sem, 0, 0);
const uint32_t WAIT_TIMEOUT = 30;
std::string BUNDLE_NAME = “com.huawei.demo”; // 卸载应用的包名
Uninstall(BUNDLE_NAME.c_str(), &installParam, UninstallCallback);
struct timespec ts = {};
clock_gettime(CLOCK_REALTIME, &ts);
ts.tv_sec += WAIT_TIMEOUT;
sem_timedwait(&g_sem, &ts);
```
**查询已安装应用的包信息**
开发者可以利用BundleManager提供的接口GetBundleInfo来查询系统内已安装应用的包信息。
1. 创建以及初始化BundleInfo。
```
BundleInfo bundleInfo;
(void) memset_s(&bundleInfo, sizeof(BundleInfo), 0, sizeof(BundleInfo));
```
2. 调用GetBundleInfo接口，指定查询应用的包名，同时指定flag来确定获取的BundleInfo中是否含有元能力信息（实例代码以含有元能力信息为例）。
```
std::string BUNDLE_NAME = "com.huawei.demo";
uint8_t ret = GetBundleInfo(BUNDLE_NAME.c_str(), 1, &bundleInfo); // flags = 1，获取包信息中含有元能力信息
```
3. 使用完获取的BundleInfo之后，要及时清理掉其内部所占用的内存空间避免内存泄漏。
```
ClearBundleInfo(&bundleInfo);
```
### Hap包打包<a name="section171771212328"></a>
打包工具一般集成到开发工具或者ide中，开发者一般不涉及直接使用该工具，下面的介绍开发者可以作为了解。打包工具的jar包在开源代码中的位置：developtools/packing\_tool/jar。
- 打包命令行参数
**表 2** 打包所需要的资源文件描述
<a name="table2151102833212"></a>
<table><thead align="left"><tr id="row314812893218"><th class="cellrowborder" valign="top" width="25%" id="mcps1.2.5.1.1"><p id="p1614732812320"><a name="p1614732812320"></a><a name="p1614732812320"></a>命令参数</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.2.5.1.2"><p id="p214722819322"><a name="p214722819322"></a><a name="p214722819322"></a>对应的资源文件</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.2.5.1.3"><p id="p214714286324"><a name="p214714286324"></a><a name="p214714286324"></a>说明</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.2.5.1.4"><p id="p1014712863211"><a name="p1014712863211"></a><a name="p1014712863211"></a>是否可缺省</p>
</th>
</tr>
</thead>
<tbody><tr id="row614812289322"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p16148182853216"><a name="p16148182853216"></a><a name="p16148182853216"></a>--mode</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.2 "><p id="p5148162814328"><a name="p5148162814328"></a><a name="p5148162814328"></a>-</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.3 "><p id="p11481228143215"><a name="p11481228143215"></a><a name="p11481228143215"></a>为“hap”字段，打包生成hap</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.4 "><p id="p11148132811325"><a name="p11148132811325"></a><a name="p11148132811325"></a>否</p>
</td>
</tr>
<tr id="row81486283327"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p6148132833215"><a name="p6148132833215"></a><a name="p6148132833215"></a>--json-path</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.2 "><p id="p214810286325"><a name="p214810286325"></a><a name="p214810286325"></a>清单文件config.json</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.3 "><p id="p514802823216"><a name="p514802823216"></a><a name="p514802823216"></a>-</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.4 "><p id="p4148182813326"><a name="p4148182813326"></a><a name="p4148182813326"></a>否</p>
</td>
</tr>
<tr id="row1214917281322"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p171497285322"><a name="p171497285322"></a><a name="p171497285322"></a>--resources-path</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.2 "><p id="p414914286320"><a name="p414914286320"></a><a name="p414914286320"></a>资源文件resources</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.3 "><p id="p41492286324"><a name="p41492286324"></a><a name="p41492286324"></a>-</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.4 "><p id="p1114922812327"><a name="p1114922812327"></a><a name="p1114922812327"></a>是</p>
</td>
</tr>
<tr id="row14149122817322"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p11149528173218"><a name="p11149528173218"></a><a name="p11149528173218"></a>--assets-path</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.2 "><p id="p314918286324"><a name="p314918286324"></a><a name="p314918286324"></a>资源文件assets</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.3 "><p id="p1414916284327"><a name="p1414916284327"></a><a name="p1414916284327"></a>-</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.4 "><p id="p9149122817324"><a name="p9149122817324"></a><a name="p9149122817324"></a>是</p>
</td>
</tr>
<tr id="row41501728193219"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p514918280325"><a name="p514918280325"></a><a name="p514918280325"></a>--lib-path</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.2 "><p id="p16149162823212"><a name="p16149162823212"></a><a name="p16149162823212"></a>依赖库文件</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.3 "><p id="p12149122853216"><a name="p12149122853216"></a><a name="p12149122853216"></a>-</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.4 "><p id="p614962853217"><a name="p614962853217"></a><a name="p614962853217"></a>是</p>
</td>
</tr>
<tr id="row131501928183212"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p4150122833213"><a name="p4150122833213"></a><a name="p4150122833213"></a>--shared-libs-path</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.2 "><p id="p15150112814322"><a name="p15150112814322"></a><a name="p15150112814322"></a>共享库文件</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.3 "><p id="p20150128113212"><a name="p20150128113212"></a><a name="p20150128113212"></a>针对系统应用的共享库，特殊情况下使用</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.4 "><p id="p181501928183214"><a name="p181501928183214"></a><a name="p181501928183214"></a>是</p>
</td>
</tr>
<tr id="row10150142812329"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p1015011286320"><a name="p1015011286320"></a><a name="p1015011286320"></a>--ability-so-path</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.2 "><p id="p6150728123214"><a name="p6150728123214"></a><a name="p6150728123214"></a>主功能so文件</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.3 "><p id="p16150192813323"><a name="p16150192813323"></a><a name="p16150192813323"></a>-</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.4 "><p id="p1315052811325"><a name="p1315052811325"></a><a name="p1315052811325"></a>是</p>
</td>
</tr>
<tr id="row51519280321"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p315092813214"><a name="p315092813214"></a><a name="p315092813214"></a>--index-path</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.2 "><p id="p1115012813325"><a name="p1115012813325"></a><a name="p1115012813325"></a>资源索引</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.3 "><p id="p111501028123220"><a name="p111501028123220"></a><a name="p111501028123220"></a>资源索引文件由资源生成工具生成，由资源流水线会集成该工具</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.4 "><p id="p1115122811326"><a name="p1115122811326"></a><a name="p1115122811326"></a>是</p>
</td>
</tr>
<tr id="row91511928203211"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p0151328173211"><a name="p0151328173211"></a><a name="p0151328173211"></a>--out-path</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.2 "><p id="p215112833214"><a name="p215112833214"></a><a name="p215112833214"></a>-</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.3 "><p id="p11151152833217"><a name="p11151152833217"></a><a name="p11151152833217"></a>生成的hap包输出路径，默认为当前目录</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.4 "><p id="p1815110281328"><a name="p1815110281328"></a><a name="p1815110281328"></a>是</p>
</td>
</tr>
<tr id="row4151162812329"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p1015112280329"><a name="p1015112280329"></a><a name="p1015112280329"></a>--force</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.2 "><p id="p2151128133219"><a name="p2151128133219"></a><a name="p2151128133219"></a>-</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.3 "><p id="p9151928183218"><a name="p9151928183218"></a><a name="p9151928183218"></a>是否覆盖原有同名文件，默认为false</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.4 "><p id="p171511728143217"><a name="p171511728143217"></a><a name="p171511728143217"></a>是</p>
</td>
</tr>
</tbody>
</table>
- 打包示例
- 开发视图
![](figures/zh-cn_image_0000001062942690.png)
- 编译视图
![](figures/zh-cn_image_0000001062334618.png)
- 使用打包工具执行以下命令打包：
![](figures/zh-cn_image_0000001062476933.png)
```
$ java -jar hmos_app_packing_tool.jar --mode hap --json-path ./config.json --assets-path ./assets/ --ability-so-path ./libentry.so --index-path ./resources.index --out-path out/entry.hap --force true
```
subsystems/搭建环境.md 0 → 100644
浏览文件 @ 37cc208b
# 搭建环境<a name="ZH-CN_TOPIC_0000001061629245"></a>
- 开发板：Hi3516DV300
- [下载源码](https://device.harmonyos.com/cn/docs/start/get-code/oem_sourcecode_guide-0000001050769927)
- [编译用户程序框架](https://gitee.com/openharmony/docs/blob/master/readme/用户程序框架子系统README.md)
subsystems/概述.md 0 → 100644
浏览文件 @ 37cc208b
# 概述<a name="ZH-CN_TOPIC_0000001062225512"></a>
- [基本概念](#section72601941194812)
- [Ability子系统](#section14633111813374)
- [包管理子系统](#section1341146154412)
- [运作机制](#section94302021112717)
- [约束与限制](#section89534912527)
用户程序框架是OpenHarmony为开发者提供开发OpenHarmony应用的开发框架，包含两个模块：Ability子系统和包管理子系统。
## 基本概念<a name="section72601941194812"></a>
开发者在开发前需要先了解以下基本概念，方便开发者更好的理解OpenHarmony用户程序框架。
## Ability子系统<a name="section14633111813374"></a>
Ability子系统是管理OpenHarmony应用运行状态的开发框架。
**图 1** Ability子系统框架图<a name="fig9759195514371"></a>
![](figures/Ability子系统框架图.png "Ability子系统框架图")
- **Ability**：系统调度应用的最小单元，是能够完成一个独立功能的组件，一个应用可以包含一个或多个Ability。Ability分为两种类型：Page类型的Ability和Service类型的Ability。
- **Page类型的Ability**：带有界面，为用户提供人机交互的能力。
- **Service类型的Ability**：不带界面，为用户提供后台任务机制。
- **AbilitySlice**：单个页面及其控制逻辑的总和，是Page类型Ability特有的组件，一个Page类型的Ability可以包含多个AbilitySlice，此时，这些页面提供的业务能力应当是高度相关的。
**图 2** Ability与AbilitySlice的关系图<a name="fig1065819910347"></a>
![](figures/Ability与AbilitySlice的关系图.png "Ability与AbilitySlice的关系图")
- **生命周期**：Ability被调度到启动、激活、隐藏和退出等各个状态的统称。
**图 3** Ability生命周期流转<a name="fig56111543375"></a>
![](figures/图片1.png)
- **OnStart\(\)**
系统首次创建Page实例时触发该回调。对于一个Page实例，该回调在其生命周期过程中仅触发一次，Page在该逻辑后进入INACTIVE状态。开发者必须重写该方法，并在此配置默认展示的AbilitySlice。
- **OnActive\(\)**
Page会在进入INACTIVE状态后来到前台，然后系统调用此回调。Page在此之后进入ACTIVE状态，该状态是应用与用户交互的状态。Page将保持在此状态，除非某类事件发生导致Page失去焦点，比如用户点击返回键或导航到其他Page。
当此类事件发生时，会触发Page回到INACTIVE状态，系统将调用OnInactive\(\)回调。此后，Page可能重新回到ACTIVE状态，系统将再次调用OnActive\(\)回调。因此，开发者通常需要成对实现OnActive\(\)和OnInactive\(\)，并在OnActive\(\)中获取在OnInactive\(\)中被释放的资源。
- **OnInactive\(\)**
当Page失去焦点时，系统将调用此回调，此后Page进入INACTIVE状态。开发者可以在此回调中实现Page失去焦点时应表现的恰当行为。
- **OnBackground\(\)**
如果Page不再对用户可见，系统将可能根据资源状况调用此回调，此后Page进入BACKGROUND状态。开发者应该在此回调中释放Page不可见时无用的资源，或在此回调中执行较为耗时的状态保存操作。
- **OnForeground\(\)**
处于BACKGROUND状态的Page仍然驻留在内存中，当重新回到前台时（比如用户重新导航到此Page），系统将先调用OnForeground\(\)回调使Page回到INACTIVE状态，然后调用OnActive\(\)回调使Page回到ACTIVE状态。开发者应当在此回调中重新申请在OnBackground\(\)中释放的资源。轻量化设备目前不支持该接口。
- **OnStop\(\)**
此回调表示系统正在销毁Page。销毁Page的可能原因包括：
- 用户通过系统管理能力显式关闭Page，例如使用任务管理器关闭Page。
- 用户行为触发Page的TerminateAbility\(\)方法调用，例如使用应用的退出功能。
- 配置变更导致系统暂时销毁Page并重建。
- 系统出于资源管理目的，自动触发对处于BACKGROUND状态Page的销毁。
- **AbilityKit**：Ability框架提供给开发者的开发包，开发者基于该开发包可以开发出基于Ability组件的应用。基于Ability组件开发的应用有两种类型：基于Javascript语言开发的Ability（JS Ability）和基于C/C++语言开发的Ability（Native Ability）。JS应用开发框架是开发者开发JS Ability所用到框架，是在AbilityKit基础封装的包含js UI组件的一套方便开发者能够迅速开发Ability应用的框架。
- **AbilityLoader**：负责注册和加载开发者Ability的模块。开发者开发的Ability先要调用AbilityLoader的注册接口注册到框架中，接着Ability启动时会被实例化。
- **AbilityManager：**负责AbilityKit和Ability管理服务进行IPC的通信。
- **EventHandler**：AbilityKit提供给开发者的用于在Ability中实现线程间通信的一个模块。
- **AbilityManagerService**：元能力运行管理服务。该服务用于协调各Ability运行关系、及生命周期进行调度的系统服务。其中，服务启动模块负责Ability管理服务的启动、注册等。服务接口管理模块负责Ability管理服务对外能力的管理。进程管理模块负责Ability应用所在进程的启动和销毁、及其进程信息维护等功能。Ability栈管理模块负责维护各个Ability之间跳转的先后关系。生命周期调度模块是Ability管理服务根据系统当前的操作调度Ability进入相应的状态的模块。连接管理模块是Ability管理服务对Service类型Ability连接管理的模块
- **AppSpawn**：负责创建Ability应用所在进程的系统服务，该服务有较高的权限，为Ability应用设置相应的权限，并预加载一些通用的模块，加速应用的启动。
## 包管理子系统<a name="section1341146154412"></a>
包管理子系统是OpenHarmony为开发者提供的安装包管理框架。
**图 4** 包管理子系统框架图<a name="fig11490181810425"></a>
![](figures/包管理子系统框架图.png "包管理子系统框架图")
- **BundleKit**：是包管理服务对外提供的接口，有安装/卸载接口、包信息查询接口、包状态变化监听接口。
- **包扫描器**：用来解析本地预制或者安装的安装包，提取里面的各种信息，供管理子模块进行管理，持久化。
- **包安装子模块**：安装，卸载，升级一个包；包安装服务是一个单独进程和包管理服务通过IPC进行通信，该服务用于创建、删除安装目录和数据目录等，具有较高的权限。
- **包管理子模块**：管理安装包相关的信息，存储持久化包信息。
- **包安全管理子模块**：签名检查、权限授予、权限管理。
## 运作机制<a name="section94302021112717"></a>
Ability子系统的核心模块是Ability管理服务、包管理子系统的核心模块是包管理服务，这两个服务是系统级服务，借助系统服务框架Samgr实现服务的注册与发现，并对其他进程提供Ability管理服务和包管理服务。Ability管理服务和包管理服务通过AbilityKit和BundleKit以接口的形式向外提供服务。
**图 5** Ability管理服务和包管理服务启动<a name="fig13121104711910"></a>
![](figures/Ability管理服务和包管理服务启动.png "Ability管理服务和包管理服务启动")
Ability管理服务和包管理服务启动后，就可以安装OpenHarmony应用和启动运行OpenHarmony应用。
**图 6** 应用启动流程<a name="fig756104112311"></a>
![](figures/应用启动流程.png "应用启动流程")
桌面为Ability管理服务启动的第一个OpenHarmony应用。桌面启动后，用户可以在桌面上点击安装的OpenHarmony应用并启动该应用。上图6为从桌面启动一个已安装应用的交互流程。
从图中可知，Ability管理服务负责协调Ability之间的显示隐藏，包管理服务负责Ability信息的存储查询。
## 约束与限制<a name="section89534912527"></a>
- 语言版本
- C++11版本或以上
- 框架针对不同的芯片平台和底层OS能力，规格有所区别
- Cortex-M RAM/ROM：
- RAM：建议大于20K
- ROM: \> 300K （包含JS应用开发框架，UIKit及引擎等强相关子系统）
- Cortex-A RAM/ROM:
- RAM：建议大于2M
- ROM：\> 2M （包含JS应用开发框架，UIKit及引擎等强相关子系统）
subsystems/测试.md 0 → 100644
浏览文件 @ 37cc208b
# 测试<a name="ZH-CN_TOPIC_0000001074910589"></a>
- [概述](#zh-cn_topic_0000001059860314_section12403172115920)
- [基本概念](#zh-cn_topic_0000001059860314_section53632272090)
- [运作机制](#zh-cn_topic_0000001059860314_section2394431106)
- [约束与限制](#zh-cn_topic_0000001059860314_section2029921310472)
- [功能限制](#zh-cn_topic_0000001059860314_section172441620111610)
- [操作限制](#zh-cn_topic_0000001059860314_section201523661616)
- [搭建环境](#zh-cn_topic_0000001059860314_section175012297491)
- [环境要求](#zh-cn_topic_0000001059860314_section935055691014)
- [安装环境](#zh-cn_topic_0000001059860314_section6511193210111)
- [检验环境是否搭建成功](#zh-cn_topic_0000001059860314_section1899144517117)
- [开发指导](#zh-cn_topic_0000001059860314_section16741101301210)
- [场景介绍](#zh-cn_topic_0000001059860314_section93782214124)
- [接口说明](#zh-cn_topic_0000001059860314_section54131732101218)
- [开发步骤](#zh-cn_topic_0000001059860314_section53541946111218)
- [开发实例](#zh-cn_topic_0000001059860314_section7477121918136)
- [包结构说明](#zh-cn_topic_0000001059860314_section1875515364133)
## 概述<a name="zh-cn_topic_0000001059860314_section12403172115920"></a>
### 基本概念<a name="zh-cn_topic_0000001059860314_section53632272090"></a>
测试子系统提供基于python开发的一键式的开发者自测试平台，支持三方测试框架拓展，主要包括测试用例编译、测试用例管理、测试用例调度分发、测试用例执行、测试结果收集、测试报告生成、测试用例模板、测试环境管理。
在测试子系统开发前，开发者应先了解以下概念：
- 测试用例编译
支持将测试用例源代码编译成可在被测设备侧执行的二进制文件。
- 测试用例调度分发
支持将测试用例通过网口通道或者串口通道分发到不同的被测设备上，并且为每一个测试用例分配特定的测试用例执行器。
- 测试用例执行器
集成不同语言的单元测试框架，如unity等，定义每一个测试用例的预处理，用例执行，结果记录等执行逻辑。
- 测试用例模板
定义测试用例统一格式，以及测试用例编译配置GN文件的统一格式。
- 测试工具kit
测试工具运行过程中公共方法，如提供测试用例目录向被测设备挂载文件系统，测试用例推送到被测设备，或者从被测设备获取测试结果等操作。
- 测试报告生成
定义开发者自测试报告模板，支持将测试用例的xml结果通过html方式展示。
- 测试环境管理
支持通过USB、串口等方式管理被测设备，功能包括设备发现，设备状态查询等。
### 运作机制<a name="zh-cn_topic_0000001059860314_section2394431106"></a>
- 测试工具架构图如下：
**图 1** 测试工具架构<a name="zh-cn_topic_0000001059860314_fig418674910399"></a>
![](figures/测试工具架构.png "测试工具架构")
- 测试工具运行时序图如下：
**图 2** 测试工具运行时序<a name="zh-cn_topic_0000001059860314_fig107203017407"></a>
![](figures/测试工具运行时序.png "测试工具运行时序")
- 测试工具运行原理
测试工具通过shell脚本启动，以命令行方式支持一系列的测试指令执行，通过命令行输出测试结果。
## 约束与限制<a name="zh-cn_topic_0000001059860314_section2029921310472"></a>
### 功能限制<a name="zh-cn_topic_0000001059860314_section172441620111610"></a>
- 功能使用范围
开发自测试工具仅支持代码级的测试用例开发和验证，如单元测试，模块测试。
- 规格限制
当前测试框架的适用范围仅支持白盒测试。
### 操作限制<a name="zh-cn_topic_0000001059860314_section201523661616"></a>
一台测试设备上仅支持启动单个测试平台。
## 搭建环境<a name="zh-cn_topic_0000001059860314_section175012297491"></a>
### 环境要求<a name="zh-cn_topic_0000001059860314_section935055691014"></a>
**表 1** **环境要求**
<a name="zh-cn_topic_0000001059860314_table13112443615"></a>
<table><thead align="left"><tr id="zh-cn_topic_0000001059860314_row1947247360"><th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.2.4.1.1"><p id="zh-cn_topic_0000001059860314_p64172414367"><a name="zh-cn_topic_0000001059860314_p64172414367"></a><a name="zh-cn_topic_0000001059860314_p64172414367"></a>项目</p>
</th>
<th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.2.4.1.2"><p id="zh-cn_topic_0000001059860314_p6452410368"><a name="zh-cn_topic_0000001059860314_p6452410368"></a><a name="zh-cn_topic_0000001059860314_p6452410368"></a>测试设备</p>
</th>
<th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.2.4.1.3"><p id="zh-cn_topic_0000001059860314_p94924103617"><a name="zh-cn_topic_0000001059860314_p94924103617"></a><a name="zh-cn_topic_0000001059860314_p94924103617"></a>被测设备</p>
</th>
</tr>
</thead>
<tbody><tr id="zh-cn_topic_0000001059860314_row10452414368"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.1 "><p id="zh-cn_topic_0000001059860314_p1422414368"><a name="zh-cn_topic_0000001059860314_p1422414368"></a><a name="zh-cn_topic_0000001059860314_p1422414368"></a>硬件</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.2 "><a name="zh-cn_topic_0000001059860314_ul19802171518438"></a><a name="zh-cn_topic_0000001059860314_ul19802171518438"></a><ul id="zh-cn_topic_0000001059860314_ul19802171518438"><li>内存：8G及以上</li><li>硬盘：100G及以上</li><li>硬件架构：X86或ARM64</li></ul>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="zh-cn_topic_0000001059860314_p5417240364"><a name="zh-cn_topic_0000001059860314_p5417240364"></a><a name="zh-cn_topic_0000001059860314_p5417240364"></a>HI3516DV300开发板</p>
<p id="zh-cn_topic_0000001059860314_p1286125194416"><a name="zh-cn_topic_0000001059860314_p1286125194416"></a><a name="zh-cn_topic_0000001059860314_p1286125194416"></a>HI3518EV300开发板</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059860314_row24182410361"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.1 "><p id="zh-cn_topic_0000001059860314_p45102453620"><a name="zh-cn_topic_0000001059860314_p45102453620"></a><a name="zh-cn_topic_0000001059860314_p45102453620"></a>软件</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.2 "><a name="zh-cn_topic_0000001059860314_ul16677122216594"></a><a name="zh-cn_topic_0000001059860314_ul16677122216594"></a><ul id="zh-cn_topic_0000001059860314_ul16677122216594"><li>操作系统：Windows 10 64位 或 Ubuntu 18.04<p id="zh-cn_topic_0000001059860314_p717443952718"><a name="zh-cn_topic_0000001059860314_p717443952718"></a><a name="zh-cn_topic_0000001059860314_p717443952718"></a>系统组件（Linux）： libreadline-dev</p>
</li><li>Python：3.7.5及以上</li><li>Python插件：pyserial3.3及以上、paramiko2.7.1及以上、setuptools40.8.0及以上，rsa4.0及以上</li><li>NFS Server：haneWIN NFS Server1.2.50及以上或者 NFSv4及以上</li></ul>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><a name="zh-cn_topic_0000001059860314_ul20976824133414"></a><a name="zh-cn_topic_0000001059860314_ul20976824133414"></a><ul id="zh-cn_topic_0000001059860314_ul20976824133414"><li>系统软件：版本不低于OpenHarmony 1.0</li><li>内核类型：LiteOS-A或者Linux</li></ul>
</td>
</tr>
</tbody>
</table>
### 安装环境<a name="zh-cn_topic_0000001059860314_section6511193210111"></a>
1. 打开test/xdevice目录，执行python setup.py install。
2. 如测试环境为Linux，需要安装系统组件readline，命令如下：
```
sudo apt-get install libreadline-dev
```
3. 安装Python扩展组件pyserial、paramiko、setuptools以及rsa，命令如下:
安装pyserial
```
pip install pyserial
```
安装setuptools
```
pip install setuptools
```
安装rsa
```
pip install rsa
```
安装Paramiko
```
pip install paramiko
```
4. 安装NFS server。
**Windows环境安装**
下载并安装haneWIN NFS Server1.2.50，地址：https://www.hanewin.net/nfs-e.htm
**Linux环境下安装**
```
sudo apt install nfs-kernel-server
```
所有环境配置安装完成，即可在IDE中进行测试工具代码开发调试，推荐的IDE为 DevEco Studio。
### 检验环境是否搭建成功<a name="zh-cn_topic_0000001059860314_section1899144517117"></a>
**表 2** **检验环境**
<a name="zh-cn_topic_0000001059860314_table76761616112218"></a>
<table><thead align="left"><tr id="zh-cn_topic_0000001059860314_row6677121616229"><th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.2.4.1.1"><p id="zh-cn_topic_0000001059860314_p176771416182216"><a name="zh-cn_topic_0000001059860314_p176771416182216"></a><a name="zh-cn_topic_0000001059860314_p176771416182216"></a>检查项</p>
</th>
<th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.2.4.1.2"><p id="zh-cn_topic_0000001059860314_p18677181612220"><a name="zh-cn_topic_0000001059860314_p18677181612220"></a><a name="zh-cn_topic_0000001059860314_p18677181612220"></a>操作</p>
</th>
<th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.2.4.1.3"><p id="zh-cn_topic_0000001059860314_p5677151642215"><a name="zh-cn_topic_0000001059860314_p5677151642215"></a><a name="zh-cn_topic_0000001059860314_p5677151642215"></a>满足条件</p>
</th>
</tr>
</thead>
<tbody><tr id="zh-cn_topic_0000001059860314_row567731662216"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.1 "><p id="zh-cn_topic_0000001059860314_p1667711613224"><a name="zh-cn_topic_0000001059860314_p1667711613224"></a><a name="zh-cn_topic_0000001059860314_p1667711613224"></a>检查python安装与否，版本是否满足要求。</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.2 "><p id="zh-cn_topic_0000001059860314_p16678101614220"><a name="zh-cn_topic_0000001059860314_p16678101614220"></a><a name="zh-cn_topic_0000001059860314_p16678101614220"></a>命令行窗口执行命令：python --version。</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="zh-cn_topic_0000001059860314_p6554216134112"><a name="zh-cn_topic_0000001059860314_p6554216134112"></a><a name="zh-cn_topic_0000001059860314_p6554216134112"></a>版本不小于3.7.5即可。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059860314_row559954144717"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.1 "><p id="zh-cn_topic_0000001059860314_p1259195419474"><a name="zh-cn_topic_0000001059860314_p1259195419474"></a><a name="zh-cn_topic_0000001059860314_p1259195419474"></a>检查python扩展插件安装与否。</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.2 "><p id="zh-cn_topic_0000001059860314_p175925424714"><a name="zh-cn_topic_0000001059860314_p175925424714"></a><a name="zh-cn_topic_0000001059860314_p175925424714"></a>打开test/xdevice目录，执行run.bat或run.sh。</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="zh-cn_topic_0000001059860314_p1040211281418"><a name="zh-cn_topic_0000001059860314_p1040211281418"></a><a name="zh-cn_topic_0000001059860314_p1040211281418"></a>可进入提示符“&gt;&gt;&gt;”界面即可。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059860314_row66781016182213"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.1 "><p id="zh-cn_topic_0000001059860314_p8678416132217"><a name="zh-cn_topic_0000001059860314_p8678416132217"></a><a name="zh-cn_topic_0000001059860314_p8678416132217"></a>检查NFS Server启动状态。</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.2 "><p id="zh-cn_topic_0000001059860314_p56781416142210"><a name="zh-cn_topic_0000001059860314_p56781416142210"></a><a name="zh-cn_topic_0000001059860314_p56781416142210"></a>通过串口登录开发板，执行mount命令挂载NFS。</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="zh-cn_topic_0000001059860314_p27475710414"><a name="zh-cn_topic_0000001059860314_p27475710414"></a><a name="zh-cn_topic_0000001059860314_p27475710414"></a>可正常挂载文件目录即可。</p>
</td>
</tr>
</tbody>
</table>
## 开发指导<a name="zh-cn_topic_0000001059860314_section16741101301210"></a>
### 场景介绍<a name="zh-cn_topic_0000001059860314_section93782214124"></a>
开发者测试用例主要用于对开发业务代码进行自验证，支持代码级别的单元测试、模块测试、性能测试。
### 接口说明<a name="zh-cn_topic_0000001059860314_section54131732101218"></a>
测试框架集成了开源的单元测试框架，并对测试用例的宏定义做了扩展，具体框架说明详见开源官方文档。
**表 3** 测试框架扩展宏定义说明
<a name="zh-cn_topic_0000001059860314_table3247152012146"></a>
<table><thead align="left"><tr id="zh-cn_topic_0000001059860314_row824713209143"><th class="cellrowborder" valign="top" width="11.41%" id="mcps1.2.3.1.1"><p id="zh-cn_topic_0000001059860314_p52484202141"><a name="zh-cn_topic_0000001059860314_p52484202141"></a><a name="zh-cn_topic_0000001059860314_p52484202141"></a>宏定义</p>
</th>
<th class="cellrowborder" valign="top" width="88.59%" id="mcps1.2.3.1.2"><p id="zh-cn_topic_0000001059860314_p1424812015145"><a name="zh-cn_topic_0000001059860314_p1424812015145"></a><a name="zh-cn_topic_0000001059860314_p1424812015145"></a>描述</p>
</th>
</tr>
</thead>
<tbody><tr id="zh-cn_topic_0000001059860314_row424892018145"><td class="cellrowborder" valign="top" width="11.41%" headers="mcps1.2.3.1.1 "><p id="zh-cn_topic_0000001059860314_p5248192016144"><a name="zh-cn_topic_0000001059860314_p5248192016144"></a><a name="zh-cn_topic_0000001059860314_p5248192016144"></a>HWTEST</p>
</td>
<td class="cellrowborder" valign="top" width="88.59%" headers="mcps1.2.3.1.2 "><p id="zh-cn_topic_0000001059860314_p2248120191418"><a name="zh-cn_topic_0000001059860314_p2248120191418"></a><a name="zh-cn_topic_0000001059860314_p2248120191418"></a>适合做简单测试，执行不依赖Setup&amp;Teardown，对TEST扩展了用例级别，例如HWTEST(CalculatorAddTest, TestPoint_001, TestSize.Level1)。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059860314_row18248220131414"><td class="cellrowborder" valign="top" width="11.41%" headers="mcps1.2.3.1.1 "><p id="zh-cn_topic_0000001059860314_p4248132014144"><a name="zh-cn_topic_0000001059860314_p4248132014144"></a><a name="zh-cn_topic_0000001059860314_p4248132014144"></a>HWTEST_F</p>
</td>
<td class="cellrowborder" valign="top" width="88.59%" headers="mcps1.2.3.1.2 "><p id="zh-cn_topic_0000001059860314_p17248132061412"><a name="zh-cn_topic_0000001059860314_p17248132061412"></a><a name="zh-cn_topic_0000001059860314_p17248132061412"></a>用例具备独立性，执行依赖Setup&amp;Teardown，对TEST_F扩展了用例级别，例如HWTEST_F(CalculatorAddTest, TestPoint_001, TestSize.Level1)。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059860314_row924892011148"><td class="cellrowborder" valign="top" width="11.41%" headers="mcps1.2.3.1.1 "><p id="zh-cn_topic_0000001059860314_p5248132031420"><a name="zh-cn_topic_0000001059860314_p5248132031420"></a><a name="zh-cn_topic_0000001059860314_p5248132031420"></a>HWTEST_P</p>
</td>
<td class="cellrowborder" valign="top" width="88.59%" headers="mcps1.2.3.1.2 "><p id="zh-cn_topic_0000001059860314_p1248142031417"><a name="zh-cn_topic_0000001059860314_p1248142031417"></a><a name="zh-cn_topic_0000001059860314_p1248142031417"></a>参数化测试，对TEST_P扩展了用例级别，例如HWTEST_P(CalculatorAddTest, TestPoint_001, TestSize.Level1)。</p>
</td>
</tr>
</tbody>
</table>
### 开发步骤<a name="zh-cn_topic_0000001059860314_section53541946111218"></a>
1. 按照开发者测试用例目录规划定义测试套文件，需要继承testing::Test类，命名以被测特性+Test命名，示例代码路径：test/developertest/example/cxx\_demo/test/unittest/common/calc\_subtraction\_test.cpp
```
#include <gtest/gtest.h>
using namespace std;
using namespace testing::ext;
class CalcSubtractionTest : public testing::Test {
public:
static void SetUpTestCase(void);
static void TearDownTestCase(void);
void SetUp();
void TearDown();
};
```
2. 实现测试套执行过程需要的预处理操作和后处理操作，即实现SetUp和TearDown方法。
```
void CalcSubtractionTest::SetUpTestCase(void)
{
// step 2: input testsuit setup step
}
void CalcSubtractionTest::TearDownTestCase(void)
{
// step 2: input testsuit teardown step
}
void CalcSubtractionTest::SetUp(void)
{
// step 3: input testcase setup step
}
void CalcSubtractionTest::TearDown(void)
{
// step 3: input testcase teardown step
}
```
3. 针对被测对象的特性编写测试用例，以使用HWTEST\_F为例说明。
```
/*
* Feature: Calculator
* Function: Subtraction
* SubFunction: NA
* FunctionPoints: Integer Subtraction
* EnvConditions: NA
* CaseDescription: Verify the Subtraction function.
*/
HWTEST_F(CalcSubtractionTest, integer_sub_001, TestSize.Level1)
{
EXPECT_EQ(0, Subtraction(1, 0));
}
```
4. 编写用例编译GN文件，其中包括定义用例编译目标，添加编译配置依赖，源文件等，举例说明（示例文件路径：test/developertest/example/cxx\_demo/test/unittest/common/BUILD.gn）。
```
import("//build/lite/config/test.gni")
unittest("CalcSubTest") {
output_extension = "bin"
sources = [
"calc_subtraction_test.cpp"
]
include_dirs = []
deps = []
}
```
5. 将用例编译目标添加到子系统编译配置中，保证用例随版本一起编译，举例说明（示例文件路径：test/developertest/BUILD.gn）。
```
import("//build/lite/config/test.gni")
subsystem_test("test") {
test_components = []
if(ohos_kernel_type == "liteos_riscv") {
features += [
]
}else if(ohos_kernel_type == "liteos_a") {
test_components += [
"//test/developertest/example/cxx_demo/test/unittest/common:CalcSubTest"
]
}
}
```
6. 在代码根路径下执行版本编译命令，即可编译测试用例。
## 开发实例<a name="zh-cn_topic_0000001059860314_section7477121918136"></a>
测试子系统代码仓提供了完整demo用例，demo用例路径：test/developertest/example/。以一个减法运算方法编写测试用例举例说明：
- 被测代码如下：
```
static int Subtraction(int a, int b)
{
return a - b;
}
```
- 测试用例代码如下：
```
/*
* Feature: Calculator
* Function: Subtraction
* SubFunction: NA
* FunctionPoints: Integer Subtraction
* EnvConditions: NA
* CaseDescription: Verify the Subtraction function.
*/
HWTEST_F(CalcSubtractionTest, integer_sub_002, TestSize.Level1)
{
EXPECT_EQ(1, Subtraction(2, 1));
}
```
## 包结构说明<a name="zh-cn_topic_0000001059860314_section1875515364133"></a>
开发者测试平台基础框架xdevice包结构说明，代码目录test/xdevice，详见下表所示：
**表 4** 基础框架xdevice包结构说明
<a name="zh-cn_topic_0000001059860314_table954494411114"></a>
<table><thead align="left"><tr id="zh-cn_topic_0000001059860314_row5545104415118"><th class="cellrowborder" valign="top" width="45.050000000000004%" id="mcps1.2.3.1.1"><p id="zh-cn_topic_0000001059860314_p2054554411115"><a name="zh-cn_topic_0000001059860314_p2054554411115"></a><a name="zh-cn_topic_0000001059860314_p2054554411115"></a>名称</p>
</th>
<th class="cellrowborder" valign="top" width="54.949999999999996%" id="mcps1.2.3.1.2"><p id="zh-cn_topic_0000001059860314_p13545124420115"><a name="zh-cn_topic_0000001059860314_p13545124420115"></a><a name="zh-cn_topic_0000001059860314_p13545124420115"></a>功能描述</p>
</th>
</tr>
</thead>
<tbody><tr id="zh-cn_topic_0000001059860314_row185457441816"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="zh-cn_topic_0000001059860314_p754544411116"><a name="zh-cn_topic_0000001059860314_p754544411116"></a><a name="zh-cn_topic_0000001059860314_p754544411116"></a>xdevice</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="zh-cn_topic_0000001059860314_p05459441212"><a name="zh-cn_topic_0000001059860314_p05459441212"></a><a name="zh-cn_topic_0000001059860314_p05459441212"></a>测试工具基础框架。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059860314_row454511442018"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="zh-cn_topic_0000001059860314_p75451144810"><a name="zh-cn_topic_0000001059860314_p75451144810"></a><a name="zh-cn_topic_0000001059860314_p75451144810"></a>xdevice/src/xdevice</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="zh-cn_topic_0000001059860314_p105453448111"><a name="zh-cn_topic_0000001059860314_p105453448111"></a><a name="zh-cn_topic_0000001059860314_p105453448111"></a>基础测试框架源码。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059860314_row87541401381"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="zh-cn_topic_0000001059860314_p67551309382"><a name="zh-cn_topic_0000001059860314_p67551309382"></a><a name="zh-cn_topic_0000001059860314_p67551309382"></a>xdevice/config</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="zh-cn_topic_0000001059860314_p1575512093811"><a name="zh-cn_topic_0000001059860314_p1575512093811"></a><a name="zh-cn_topic_0000001059860314_p1575512093811"></a>基础测试框架配置文件定义。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059860314_row5649112018488"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="zh-cn_topic_0000001059860314_p196491420164819"><a name="zh-cn_topic_0000001059860314_p196491420164819"></a><a name="zh-cn_topic_0000001059860314_p196491420164819"></a>xdevice/src/xdevice/__main__.py</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="zh-cn_topic_0000001059860314_p10650320204819"><a name="zh-cn_topic_0000001059860314_p10650320204819"></a><a name="zh-cn_topic_0000001059860314_p10650320204819"></a>基础测试框架内部入口。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059860314_row686513384812"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="zh-cn_topic_0000001059860314_p886514334481"><a name="zh-cn_topic_0000001059860314_p886514334481"></a><a name="zh-cn_topic_0000001059860314_p886514334481"></a>xdevice/src/xdevice/__init__.py</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="zh-cn_topic_0000001059860314_p1986519338482"><a name="zh-cn_topic_0000001059860314_p1986519338482"></a><a name="zh-cn_topic_0000001059860314_p1986519338482"></a>包依赖定义，插件依赖。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059860314_row4833912191119"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="zh-cn_topic_0000001059860314_p1083418127115"><a name="zh-cn_topic_0000001059860314_p1083418127115"></a><a name="zh-cn_topic_0000001059860314_p1083418127115"></a>xdevice/src/xdevice/variables.py</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="zh-cn_topic_0000001059860314_p138341712101118"><a name="zh-cn_topic_0000001059860314_p138341712101118"></a><a name="zh-cn_topic_0000001059860314_p138341712101118"></a>全局变量定义。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059860314_row1637375614140"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="zh-cn_topic_0000001059860314_p8373105615143"><a name="zh-cn_topic_0000001059860314_p8373105615143"></a><a name="zh-cn_topic_0000001059860314_p8373105615143"></a>xdevice/src/xdevice/_core/command</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="zh-cn_topic_0000001059860314_p1937319561140"><a name="zh-cn_topic_0000001059860314_p1937319561140"></a><a name="zh-cn_topic_0000001059860314_p1937319561140"></a>用例输入的命令行处理。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059860314_row10415205961418"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="zh-cn_topic_0000001059860314_p184151659131413"><a name="zh-cn_topic_0000001059860314_p184151659131413"></a><a name="zh-cn_topic_0000001059860314_p184151659131413"></a>xdevice/src/xdevice/_core/config</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="zh-cn_topic_0000001059860314_p1986220312212"><a name="zh-cn_topic_0000001059860314_p1986220312212"></a><a name="zh-cn_topic_0000001059860314_p1986220312212"></a>基础测试框架的配置管理。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059860314_row94787251511"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="zh-cn_topic_0000001059860314_p174781520154"><a name="zh-cn_topic_0000001059860314_p174781520154"></a><a name="zh-cn_topic_0000001059860314_p174781520154"></a>xdevice/src/xdevice/_core/environment</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="zh-cn_topic_0000001059860314_p164783210154"><a name="zh-cn_topic_0000001059860314_p164783210154"></a><a name="zh-cn_topic_0000001059860314_p164783210154"></a>基础测试框架的环境管理，包括设备管理。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059860314_row61686255266"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="zh-cn_topic_0000001059860314_p81691225162617"><a name="zh-cn_topic_0000001059860314_p81691225162617"></a><a name="zh-cn_topic_0000001059860314_p81691225162617"></a>xdevice/src/xdevice/_core/executor</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="zh-cn_topic_0000001059860314_p1316918254269"><a name="zh-cn_topic_0000001059860314_p1316918254269"></a><a name="zh-cn_topic_0000001059860314_p1316918254269"></a>基础测试框架用例调度和分发。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059860314_row197501910202715"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="zh-cn_topic_0000001059860314_p1375091013272"><a name="zh-cn_topic_0000001059860314_p1375091013272"></a><a name="zh-cn_topic_0000001059860314_p1375091013272"></a>xdevice/src/xdevice/_core/driver</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="zh-cn_topic_0000001059860314_p10750101062710"><a name="zh-cn_topic_0000001059860314_p10750101062710"></a><a name="zh-cn_topic_0000001059860314_p10750101062710"></a>基础测试框架测试执行器。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059860314_row176501346185920"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="zh-cn_topic_0000001059860314_p66514461593"><a name="zh-cn_topic_0000001059860314_p66514461593"></a><a name="zh-cn_topic_0000001059860314_p66514461593"></a>xdevice/src/xdevice/_core/resource</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="zh-cn_topic_0000001059860314_p15651746155911"><a name="zh-cn_topic_0000001059860314_p15651746155911"></a><a name="zh-cn_topic_0000001059860314_p15651746155911"></a>基础测试框架资源文件以及测试报告模板。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059860314_row1484675718210"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="zh-cn_topic_0000001059860314_p20847105792118"><a name="zh-cn_topic_0000001059860314_p20847105792118"></a><a name="zh-cn_topic_0000001059860314_p20847105792118"></a>xdevice/src/xdevice/_core/testkit</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="zh-cn_topic_0000001059860314_p784795762120"><a name="zh-cn_topic_0000001059860314_p784795762120"></a><a name="zh-cn_topic_0000001059860314_p784795762120"></a>基础测试框架公共操作，包括NFS文件系统挂载等。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059860314_row182104023911"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="zh-cn_topic_0000001059860314_p5211808398"><a name="zh-cn_topic_0000001059860314_p5211808398"></a><a name="zh-cn_topic_0000001059860314_p5211808398"></a>xdevice/src/xdevice/_core/logger.py</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="zh-cn_topic_0000001059860314_p92110017395"><a name="zh-cn_topic_0000001059860314_p92110017395"></a><a name="zh-cn_topic_0000001059860314_p92110017395"></a>基础测试框架日志管理。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059860314_row164491410124017"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="zh-cn_topic_0000001059860314_p7449171012400"><a name="zh-cn_topic_0000001059860314_p7449171012400"></a><a name="zh-cn_topic_0000001059860314_p7449171012400"></a>xdevice/src/xdevice/_core/plugin.py</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="zh-cn_topic_0000001059860314_p1944991024013"><a name="zh-cn_topic_0000001059860314_p1944991024013"></a><a name="zh-cn_topic_0000001059860314_p1944991024013"></a>基础测试框架插件管理。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059860314_row14857134011406"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="zh-cn_topic_0000001059860314_p118571440104014"><a name="zh-cn_topic_0000001059860314_p118571440104014"></a><a name="zh-cn_topic_0000001059860314_p118571440104014"></a>xdevice/src/xdevice/_core/interface.py</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="zh-cn_topic_0000001059860314_p158571940184016"><a name="zh-cn_topic_0000001059860314_p158571940184016"></a><a name="zh-cn_topic_0000001059860314_p158571940184016"></a>基础测试框架插件接口定义。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059860314_row94193383812"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="zh-cn_topic_0000001059860314_p154194363813"><a name="zh-cn_topic_0000001059860314_p154194363813"></a><a name="zh-cn_topic_0000001059860314_p154194363813"></a>xdevice/setup.py</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="zh-cn_topic_0000001059860314_p44193353819"><a name="zh-cn_topic_0000001059860314_p44193353819"></a><a name="zh-cn_topic_0000001059860314_p44193353819"></a>基础测试框架的安装脚本。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059860314_row537019532284"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="zh-cn_topic_0000001059860314_p63711953202815"><a name="zh-cn_topic_0000001059860314_p63711953202815"></a><a name="zh-cn_topic_0000001059860314_p63711953202815"></a>xdevice/run.bat</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="zh-cn_topic_0000001059860314_p4371153172812"><a name="zh-cn_topic_0000001059860314_p4371153172812"></a><a name="zh-cn_topic_0000001059860314_p4371153172812"></a>基础测试框架启动脚本（Windows）。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001059860314_row554513912325"><td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.3.1.1 "><p id="zh-cn_topic_0000001059860314_p165451493324"><a name="zh-cn_topic_0000001059860314_p165451493324"></a><a name="zh-cn_topic_0000001059860314_p165451493324"></a>xdevice/run.sh</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.2.3.1.2 "><p id="zh-cn_topic_0000001059860314_p165453953218"><a name="zh-cn_topic_0000001059860314_p165453953218"></a><a name="zh-cn_topic_0000001059860314_p165453953218"></a>基础测试框架启动脚本（Linux）。</p>
</td>
</tr>
</tbody>
</table>
subsystems/用户程序框架.md 0 → 100644
浏览文件 @ 37cc208b
# 用户程序框架<a name="ZH-CN_TOPIC_0000001074304592"></a>
- **[概述](概述.md)**
- **[搭建环境](搭建环境.md)**
- **[开发指导](开发指导.md)**
- **[开发实例](开发实例.md)**
- **[常见问题](常见问题.md)**
subsystems/编译构建.md 0 → 100644
浏览文件 @ 37cc208b
# 编译构建<a name="ZH-CN_TOPIC_0000001074146280"></a>
- **[编译构建概述](编译构建概述.md)**
- **[编译构建使用指导](编译构建使用指导.md)**
- **[编译构建常见问题](编译构建常见问题.md)**
subsystems/编译构建使用指导.md 0 → 100644
浏览文件 @ 37cc208b
# 编译构建使用指导<a name="ZH-CN_TOPIC_0000001060378721"></a>
- [目录结构](#section56731811102915)
- [编译命令](#section1475192018291)
- [开发步骤](#section4207112818418)
## 目录结构<a name="section56731811102915"></a>
```
build/lite # 编译构建主目录
├── config # 编译相关的配置项
│ ├── boards # 开发板相关的变量定义。包括：开发板名、目标架构、目标CPU等
│ ├── component # OpenHarmony组件相关的模板定义。包括：静态库、动态库、扩展组件、模拟器库等
│ ├── kernel # OpenHarmony内核的编译变量定义与配置参数
│ └── subsystem # OpenHarmony子系统列表
├── ndk # NDK相关编译脚本与配置参数
├── platform # 平台相关的配置文件
│ ├── hi3516dv300_liteos_a # hi3516dv300, liteos_a平台。包括：平台全量配置表，启动文件。
│ ├── hi3518ev300_liteos_a # hi3518ev300, liteos_a平台。包括：平台全量配置表，启动文件。
│ └── hi3861v100_liteos_riscv # hi3861v100, liteos_riscv平台。包括：平台全量配置表，启动文件。
├── product # 产品全量配置表。包括：配置单元、子系统列表、编译器等。
├── toolchain # 编译工具链相关。包括：编译器路径、编译选项、链接选项等。
└── tools # 编译构建依赖的工具。包括：mkfs等。
```
## 编译命令<a name="section1475192018291"></a>
- 使用方法:
```
python build.py product [options]
```
product为build/lite/produc/xxx.json, product名称和json配置文件中的组件均可自定义。默认json文件中的组件为对应平台支持的全集。
- 编译选项:
-b, --build\_type Debug or release
-t, --test Build with test suit
-T, --target Build single target
- 编译输出: 代码根目录/out/product
## 开发步骤<a name="section4207112818418"></a>
1. 添加组件
本节以添加一个自定义的组件为例，描述了如何编译组件、编译库、编译可执行文件。
示例组件example由两个功能feature1和feature2组成。feture1的目标为一个动态库，feature2的目标为一个可执行文件。示例组件example的完整目录结构如下：
```
example # 自定义组件
├── BUILD.gn # 自定义组件gn脚本，BUILD.gn为固定名称
├── feature1 # 自定义单元1
│ ├── BUILD.gn # 自定义单元1的gn脚本，BUILD.gn为固定名称
│ ├── include # 头文件文件夹
│ │ └── helloworld1.h # 头文件1
│ └── src # 源文件文件夹
│ └── helloworld1.c # 源文件1
├── feature2 # 自定义单元2
│ ├── BUILD.gn # 自定义单元2的gn脚本，BUILD.gn为固定名称
│ ├── include # 头文件文件夹
│ │ └── helloworld2.h # 头文件2
│ └── src # 源文件文件夹
│ └── helloworld2.c # 源文件2
├── build.sh # 自定义组件build.sh脚本，非必要
└── Makefile # 自定义组件Makefile脚本，非必要
```
示例1：编写动态库gn脚本example/feature1/BUILD.gn，示例如下：
```
# helloworld动态库编译示例
# helloworld的Build.gn文件
shared_library("helloworld_lib") {
sources = [
"src/helloworld1.c"
]
include_dirs = [
"include",
"../feature2_example/include" #（可选）如果依赖 feature2_example 可以加入该include
]
}
```
示例2：编写可执行文件gn脚本example/feature2/BUILD.gn，示例如下：
内置函数executable，可编译出可执行文件。示例如下：
```
#编译可执行.bin文件
executable("hello_world_bin") {
sources = [
"src/helloworld2.c"
]
include_dirs = [
"include",
"../feature2_example/include" #（可选）如果依赖 feature2_example 可以加入该include
]
#（可选）如果依赖 feature1_example 可以加入该deps
deps = [
"../feature1_example:helloworld1"
]
}
```
示例3，编译组件脚本example/BUILD.gn：
```
import("//build/lite/config/component/lite_component.gni")
lite_component("example_gn") {
features = [
"feature_example1:helloworld_lib",
"feature_example2:hello_world_bin",
]
}
```
示例4，三方开源软件的build.sh或Makefile工程, 可用gn脚本调用混合编译：
```
build_ext_component("example_mk") {
exec_path = rebase_path(rebase_path(".", root_build_dir))
outdir = rebase_path(get_path_info(".", "out_dir"))
prebuilts = "sh build.sh"
command = "make clean && make"
}
```
全局可引用的变量定义在：build/lite/ohos\_var.gni
用户常用变量说明见表1：
**表 1** 用户常用变量
<a name="table520317612613"></a>
<table><thead align="left"><tr id="row13203861262"><th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.2.4.1.1"><p id="p2203368619"><a name="p2203368619"></a><a name="p2203368619"></a>变量</p>
</th>
<th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.2.4.1.2"><p id="p15203765620"><a name="p15203765620"></a><a name="p15203765620"></a>取值范围</p>
</th>
<th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.2.4.1.3"><p id="p6203669616"><a name="p6203669616"></a><a name="p6203669616"></a>说明</p>
</th>
</tr>
</thead>
<tbody><tr id="row42036617616"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.1 "><p id="p1643814011561"><a name="p1643814011561"></a><a name="p1643814011561"></a>ohos_kernel_type</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.2 "><p id="p114385019568"><a name="p114385019568"></a><a name="p114385019568"></a>"liteos_a", "liteos_riscv"</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="p820396265"><a name="p820396265"></a><a name="p820396265"></a>内核类型</p>
</td>
</tr>
<tr id="row62033619614"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.1 "><p id="p134381805564"><a name="p134381805564"></a><a name="p134381805564"></a>board_name</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.2 "><p id="p9203161968"><a name="p9203161968"></a><a name="p9203161968"></a>"hi3516dv300", "hi3518ev300", "hi3861v100"</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="p172031169619"><a name="p172031169619"></a><a name="p172031169619"></a>开发板类型</p>
</td>
</tr>
<tr id="row1620318610614"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.1 "><p id="p1143880135612"><a name="p1143880135612"></a><a name="p1143880135612"></a>ohos_build_compiler</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.2 "><p id="p22041613618"><a name="p22041613618"></a><a name="p22041613618"></a>"gcc", "clang"</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="p9204861469"><a name="p9204861469"></a><a name="p9204861469"></a>编译工具链类型</p>
</td>
</tr>
<tr id="row6392114583815"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.1 "><p id="p539294514383"><a name="p539294514383"></a><a name="p539294514383"></a>ohos_build_type</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.2 "><p id="p7392144510388"><a name="p7392144510388"></a><a name="p7392144510388"></a>"debug", "release"</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="p53921145123819"><a name="p53921145123819"></a><a name="p53921145123819"></a>编译类型</p>
</td>
</tr>
</tbody>
</table>
举例：ohos\_kernel\_type的使用方式，component\_example/feature2\_example/BUILD.gn。
```
lite_library("helloworld") {
if (ohos_kernel_type == "liteos_a") {
target_type = "shared_library"
}
else if (ohos_kernel_type == "liteos_riscv") {
target_type = "static_library"
}
sources = [
"src/helloworld1.c"
]
include_dirs = [
"include"
]
}
```
2. 编译产品解决方案
产品解决方案的配置在build/lite/product 目录下，如ipcamera\_hi3516dv300.json，构建时会读取该文件包含所有用户自定义子系统、组件等配置。以编译ipcamera\_hi3516dv30为例，编译命令如下：
```
python build.py ipcamera_hi3516dv30
```
3. 编译输出
编译所生产的文件都归档在out目录下，例如在代码所在目录下，运行"python build.py wifiiot -b debug"，编译wifiiot完成后，会有如下结果生成：
```
out/
└── wifiiot # 产品名
├── args.gn # gn编译，用户自定义变量
├── build.log # 编译日志
├── build.ninja
├── build.ninja.d
├── gen
├── Hi3861_boot_signed_B.bin # 带签名的bootloader备份文件
├── Hi3861_boot_signed.bin # 带签名的bootloader文件
├── Hi3861_loader_signed.bin # 烧写工具使用的加载文件
├── Hi3861_wifiiot_app_allinone.bin # 产线工装烧写文件(已经包含独立烧写程序和loader程序)
├── Hi3861_wifiiot_app.asm # Kernel asm文件
├── Hi3861_wifiiot_app_burn.bin # 烧写文件
├── Hi3861_wifiiot_app_flash_boot_ota.bin # Flash Boot升级文件
├── Hi3861_wifiiot_app.map # Kernel map文件
├── Hi3861_wifiiot_app_ota.bin # Kernel 升级文件
├── Hi3861_wifiiot_app.out # Kernel 输出文件
├── Hi3861_wifiiot_app_vercfg.bin # 安全启动配置boot和kernel版本号，防版本回滚
├── libs # 库文件夹
├── NOTICE_FILE
├── obj
├── suites
└── toolchain.ninja
```
注：烧写文件，烧写程序建议使用"Hi3861\_wifiiot\_app\_allinone.bin"。
运行"python build.py ipcamera\_hi3518ev300 -b debug"，编译ipcamera\_hi3518ev300完成后，会有如下结果生成\(同ipcamera\_hi3516dv300\):
```
out/
└── ipcamera_hi3518ev300 # 产品名
├── args.gn # gn编译，用户自定义变量
├── bin # 链接bin所在文件夹
├── bm_tool.map # map文件
├── build.log # 编译日志
├── build.ninja
├── build.ninja.d
├── bundle_daemon_tool.map # map文件
├── data # 媒体camera依赖底层资源配置文件
├── dev_tools # 研发自测试
├── foundation.map # map文件
├── gen
├── libaudio_api.so
├── libs # 镜像包含库文件
├── liteos.bin # liteos基础内核bin文件
├── media_server.map # map文件
├── NOTICE_FILE
├── obj # 二进制文件，编译结果文件夹
├── OHOS_Image # liteos整包bin文件，未strip
├── OHOS_Image.asm # 汇编代码
├── OHOS_Image.bin # liteos整包烧录bin文件
├── OHOS_Image.map # map文件
├── rootfs.img # 编译出的库和app的镜像
├── rootfs.tar # rootfs的压缩
├── suites # xts编译结果
├── test # 测试用例编译结果
├── toolchain.ninja
├── userfs # 用户可读写的分区
├── userfs.img # img格式的用户可读写的分区，对应启动之后的/storage目录
└── vendor # 芯片的Firmware文件及配置文件
```
subsystems/编译构建常见问题.md 0 → 100644
浏览文件 @ 37cc208b
# 编译构建常见问题<a name="ZH-CN_TOPIC_0000001060804832"></a>
- [由于ninja版本问题导致编译失败](#section1019152312222)
- [由于ncurses库缺失导致编译失败](#section21449422618)
- [由于未安装mcopy导致编译失败](#section12477184992615)
- [由于权限问题导致编译失败](#section178451337202716)
- [由于未安装Crypto导致编译失败](#section1241481172819)
- [由于编译环境为shell导致编译失败](#section3691222152919)
## 由于ninja版本问题导致编译失败<a name="section1019152312222"></a>
- **现象描述：**
编译失败，提示"usr/sbin/ninja: invalid option -- w"。
- **可能原因：**
编译环境中ninja版本太低，不支持--w选项。
- **解决办法：**
卸载环境中ninja和gn，按照HarmonyOS官网[获取工具](../get-code/获取工具.md)。
## 由于ncurses库缺失导致编译失败<a name="section21449422618"></a>
- **现象描述：**
编译失败，提示“/usr/bin/ld: cannot find -lncurses”。
- **可能原因：**
编译环境ncurses库缺失。
- **解决办法：**
sudo apt-get install lib32ncurses5-dev。
## 由于未安装mcopy导致编译失败<a name="section12477184992615"></a>
- **现象描述：**
​编译失败，提示“line 77: mcopy: command not found”。
- **可能原因：**
编译环境未安装mcopy。
- **解决办法：**
​sudo apt-get install dosfstools mtools。
## 由于权限问题导致编译失败<a name="section178451337202716"></a>
- **现象描述：**
编译失败，提示“riscv32-unknown-elf-gcc: error trying to exec 'cc1': execvp: No such file or directory”。
- ​**可能原因：**
当前用户对riscv编译器路径下的文件访问权限不够。
- ​**解决办法：**
输入命令\`which riscv32-unknown-elf-gcc\`, 对其hcc\_riscv32所在的目录，使用chmod 755修改权限。
## 由于未安装Crypto导致编译失败<a name="section1241481172819"></a>
- **现象描述：**
编译失败，提示“No module named 'Crypto'”。
- **可能原因：**
python3未安装Crypto。
- **解决办法：**
输入命令\`python3 --version\`，查看Python版本号。需使用python3.7以上版本，再输入\`sudo pip3 install pycryptodome\`。
## 由于编译环境为shell导致编译失败<a name="section3691222152919"></a>
- **现象描述：**
编译失败：“xx.sh \[: xx upexpected operator”。
- **可能原因：**
编译环境shell不是bash。
- **解决办法：**
sudo rm -rf /bin/sh
sudo ln -s /bin/bash /bin/sh
subsystems/编译构建概述.md 0 → 100644
浏览文件 @ 37cc208b
# 编译构建概述<a name="ZH-CN_TOPIC_0000001060646620"></a>
- [基本概念](#section175012297491)
- [运作机制](#section193961322175011)
- [约束与限制](#section2029921310472)
编译构建提供了一个基于gn和ninja的编译构建框架。主要提供以下功能：
- 构建不同芯片平台的产品。如：Hi3518EV300平台的IPcamera产品，Hi3516DV300平台的IPcamera产品，Hi3861平台的WLAN模组产品。
- 构建HPM包管理配置生成的自定义产品。
## 基本概念<a name="section175012297491"></a>
在开发编译构建前，应了解如下基本概念：
- 平台
开发板和内核的组合，不同平台支持的子系统和组件不同。
- 组件
可复用的软件单元，它包含源码、配置文件、资源文件和编译脚本等。
- gn
Generate ninja的缩写，用于产生ninja文件。
- ninja
ninja是一个专注于速度的小型构建系统。
## 运作机制<a name="section193961322175011"></a>
编译构建流程主要包括编译命令行解析，调用gn, 执行ninja和系统镜像打包。
- 命令行解析：解析待编译的产品名称，编译类型（debug/release）。
- 调用gn: 根据命令行解析的产品名称和编译类型配置编译工具链和全局的编译选项。
- 执行ninja：启动编译。
- 系统镜像打包：将组件编译产物打包，制作文件系统镜像。
## 约束与限制<a name="section2029921310472"></a>
开发者需预装gn、ninja构建工具和编译工具链，并下载完整代码。
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或