1 Star 0 Fork 993

fish / docs

forked from OpenHarmony / docs 
Create your Gitee Account
Explore and code with more than 6 million developers,Free private repositories !:)
Sign up
Clone or download
acquiring-tools.md 10.74 KB
Copy Edit Web IDE Raw Blame History
NEEN authored 2021-04-08 16:33 . fixed bugs

Acquiring Tools

Using Docker to Prepare the Build Environment

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

    Docker Image Repository





    The build environment for the OpenHarmony version has been pre-installed.

HPM-based Docker

docker_dist is a template component in the HPM 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 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.

    • Linux


    export solution=@ohos/ip_camera_hi3516dv300 


    export solution=@ohos/ip_camera_hi3518ev300 


    export solution=@ohos/wifi_iot 
    • Windows

    Run the following Windows CMD command:

    set solution=Distribution name


Start building. The following takes ip_camera_hi3518ev300 as an example. Docker can be automatically installed only on Ubuntu. If you are using any other operating system, manually install Docker before pulling the image.

  • Automatically Installing Docker (Ubuntu)

    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.
  • Manually Installing Docker (Non-Ubuntu)

    Perform the following operations to install Docker:

    # 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

The Docker image of OpenHarmony is hosted on HUAWEI Cloud SWR. 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).

Setting Up the Docker Environment for Mini-System Devices (reference memory ≥ 128 KB) and Small-System Devices (reference memory ≥ 1 MB)

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.3
  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.3

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
  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.3

Building for Mini-System Devices (reference memory ≥ 128 KB) and Small-System Devices (reference memory ≥ 1 MB)

The following uses the Hi3516 platform as an example to describe the build procedure. Run the following build scripts to start building:

  1. Run the following command in the root directory of the source code to install hb:

    python3 -m pip install --user build/lite
  2. Set the build path to the current path.

    hb set

    Figure 1 Setting page

    NOTE: The mapping between the development board and the building GUI:

    • Hi3861: wifiiot_hispark_pegasus@hisilicon
    • Hi3516: ipcamera_hispark_taurus@hisilicon
    • Hi3518: ipcamera_hispark_aries@hisilicon
  3. Select ipcamera_hispark_taurus@hisilicon and press Enter.

  4. Start building.

    hb build -f
  5. View the build result.

    The files will be generated in the out/hispark_taurus/ipcamera_hispark_taurus directory.

Acquiring the Device Development Tool (HUAWEI DevEco Device Tool)

HUAWEI DevEco Device Tool is a one-stop integrated development environment (IDE) provided to develop applications for OpenHarmony-based smart devices. It allows on-demand customization of OpenHarmony components, code editing, compilation, burning, and debugging, and supports C and C++ languages. This tool is installed in Visual Studio Code as a plug-in. For details, see Tool Acquisition and HUAWEI DevEco Device Tool User Guide.

Acquiring the Application Development Tool (HUAWEI DevEco Studio)

HUAWEI DevEco Studio (DevEco Studio for short) is a one-stop IDE oriented to Huawei devices in all scenarios. It provides E2E OpenHarmony application development services, ranging from project template creation to development, compilation, debugging, and release. With DevEco Studio, you will be able to efficiently develop OpenHarmony applications with distributed capabilities while speeding up innovation. For details, see Tool Acquisition and HUAWEI DevEco Studio User Guide.



102255 3a0e046c 1850385 102255 7aaa926c 1850385