diff --git a/README.md b/README.md index aba962085d5a390a8ac2a3dc6ca4937de4d3bb82..b6937ab30844ec8bf147717fdb435491699d45aa 100755 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ -# 传智教育元气派GenkiPi +# Itcast GenkiPi -- [简介](#section1) -- [目录](#section2) -- [编译指导](#section3) +- [Introduction](#section1) +- [Directory Structure](#section2) +- [Compilation](#section3) -## 简介 +## Introduction -元气派GenKiPi开发板由传智播客教育科技股份有限公司出品，搭载OpenHarmony2.0操作系统；基于海思HI3861模组, 160MHz主频、SRAM 352KB、ROM 288KB、2M Flash。支持SPI、IIC、UART、ADC、PWM等开发协议， 广泛适用于智能穿戴、智能安防和工业物联网场景。 +GenkiPi development board is produced by Itcast Co., Ltd. It is equipped with OpenHarmony2.0 operating system; based on Hisilicon HI3861 module, 160MHz main frequency, SRAM 352KB, ROM 288KB, 2M Flash. 。It supports development protocols such as SPI, IIC, UART, ADC, and PWM, and is widely used in smart wear, smart security and industrial IoT scenarios. ![](./asserts/board.png) @@ -20,55 +20,55 @@ | GPIO_09 | RTS_2 | TXD_0 | ADC_4 | PWM_0 | MCK_0 | D2 | SCL_0 | | GPIO_03 | LOG_TXD_0 | | | | | | | | GPIO_04 | LOG_RXD_0 | | ADC_1 | | | | | -| GPIO_02 | | | | PWM_2 | MCK_0 | | | -| GPIO_05 | RXD_1 | CSI_0 | ADC_2 | PWM_2 | TX_0 | | | -| GPIO_06 | TXD_1 | CLK_0 | | PWM_3 | | | | -| GPIO_14 | LOG_RXD_0/CTS_2 | | | PWM_5 | RX_0 | D1 | SCL_0 | -| GPIO_11 | TXD_2 | RXD_0 | ADC_5 | PWM_2 | CLK_0 | CMD | | -| GPIO_12 | RXD_2 | CSI_0 | ADC_0 | PWM_3 | WS_0 | CLK | | -| GPIO_13 | LOG_TXD_0/RTS_2 | | ADC_6 | PWM_4 | | D0 | SDA_0 | +| GPIO_02 | | | | PWM_2 | | | | +| GPIO_05 | RXD_1 | CSI_0 | ADC_2 | PWM_2 | MCK_0 | | | +| GPIO_06 | TXD_1 | CLK_0 | | PWM_3 | TX_0 | | | +| GPIO_14 | LOG_RXD_0/CTS_2 | | | PWM_5 | | D1 | SCL_0 | +| GPIO_11 | TXD_2 | RXD_0 | ADC_5 | PWM_2 | RX_0 | CMD | | +| GPIO_12 | RXD_2 | CSI_0 | ADC_0 | PWM_3 | CLK_0 | CLK | | +| GPIO_13 | LOG_TXD_0/RTS_2 | | ADC_6 | PWM_4 | WS_0 | D0 | SDA_0 | -## 目录 +## Direction Structure -GenkiPi 的SDK软件包根目录所在位姿为`device/itcast/genkipi/`, 如下所示: +The root directory of GenkiPi SDK package is `device/itcast/genkipi/`: ```bash device/itcast/genkipi -├── BUILD.gn # GN构建脚本 -├── interfaces # 自定义接口 -└── sdk_liteos # Liteos内核目录 - ├── app # 应用层代码（其中包含demo程序为参考示例）。 - ├── boot # Flash bootloader代码。 - ├── build # SDK构建所需的库文件、链接文件、配置文件。 - ├── BUILD.gn # GN构建脚本 - ├── build_patch.sh # 用于解压uboot开源源码包和打patch。 - ├── build.sh # 启动编译脚本，同时支持“sh build.sh。 menuconfig”进行客制化配置。 - ├── components # SDK平台相关的组件。 - ├── config # SDK系统配置文件。 - ├── config.gni # 支持OpenHarmony配置文件。 - ├── factory.mk # 厂测版本编译脚本。 - ├── hm_build.sh # 适配OpenHarmony构建脚本。 - ├── include # API头文件存放目录。 - ├── license # SDK开源license声明。 - ├── Makefile # 支持make编译，使用“make”或“make all”启动编译。 - ├── non_factory.mk # 非厂测版本编译脚本。 - ├── platform # SDK平台相关的文件（包括：内核镜像、驱动模块等）。 - ├── SConstruct # SCons编译脚本。 - ├── third_party # 开源第三方软件目录。 - └── tools # SDK提供的Linux系统和Windows系统上使用的工具（包括：NV制作工具、签名工具、Menuconfig等）。 +├── BUILD.gn # GN build script +├── interfaces # custom interface +└── sdk_liteos # Liteos kernel directory + ├── app # Application layer code (including demo program as a reference example). + ├── boot # Flash bootloader code. + ├── build # The library files, link files, and configuration files needed for SDK building. + ├── BUILD.gn # GN build script + ├── build_patch.sh # Used to decompress uboot open source source package and patch. + ├── build.sh # Start the compilation script and support "sh build.sh. menuconfig" for customized configuration. + ├── components # SDK platform related components. + ├── config # SDK system configuration file. + ├── config.gni # Support OpenHarmony configuration file. + ├── factory.mk # The factory test version compilation script. + ├── hm_build.sh # Adapt to OpenHarmony build script. + ├── include # API header file storage directory. + ├── license # SDK open source license statement. + ├── Makefile # Support make compilation, use "make" or "make all" to start compilation. + ├── non_factory.mk # Non-factory test version compilation script. + ├── platform # SDK platform related files (including: kernel image, driver module, etc.). + ├── SConstruct # SCons compile script. + ├── third_party # Open source third-party software directory. + └── tools # Tools provided by the SDK on Linux and Windows systems (including: NV creation tools, signature tools, Menuconfig, etc.). ``` -## 编译指导 +## Compilation -### 源码下载 +### Source Download -1. repo工具准备。如果已经安装过repo工具，此步骤省略 +1. repo tool install。if had install it , omit this step. ```bash curl https://gitee.com/oschina/repo/raw/fork_flow/repo-py3 > repo @@ -77,7 +77,7 @@ device/itcast/genkipi python3 -m pip install -i https://repo.huaweicloud.com/repository/pypi/simple requests ``` -2. 源码下载 +2. download source ```bash repo init -u https://gitee.com/openharmony-sig/manifest.git -b master --no-repo-verify -m devboard_itcast_genkipi.xml @@ -85,25 +85,27 @@ device/itcast/genkipi repo forall -c 'git lfs pull' ``` -### 编译代码 +### Compile Code -1. 选择开发板 +1. choose devboard ```bash hb set ``` - 选中 itcast 下的genkipi 即可 + choose itcast genkipi -2. 编译 +2. compile ```bash hb build ``` -### 烧录 +### Burn Bin + +burn bin with Hiburn tool. + -通过 hiburn 工具将 out 目录下 allinOne.bin文件进行烧录 diff --git a/README.en.md b/README_ZH.md old mode 100755 new mode 100644 similarity index 30% rename from README.en.md rename to README_ZH.md index b4777e1695e8fbcd652b1cca74ab497b37b7995c..3d6d3346e65365aad69849a0be76ba4df23f856a --- a/README.en.md +++ b/README_ZH.md @@ -1,14 +1,14 @@ -# Itcast GenkiPi +# 传智教育元气派GenkiPi -- [Introduction](#section1) -- [Directory Structure](#section2) -- [Compilation](#section3) +- [简介](#section1) +- [目录](#section2) +- [编译指导](#section3) -## Introduction +## 简介 -GenkiPi development board is produced by Itcast Co., Ltd. It is equipped with OpenHarmony2.0 operating system; based on Hisilicon HI3861 module, 160MHz main frequency, SRAM 352KB, ROM 288KB, 2M Flash. 。It supports development protocols such as SPI, IIC, UART, ADC, and PWM, and is widely used in smart wear, smart security and industrial IoT scenarios. +元气派GenKiPi开发板由传智播客教育科技股份有限公司出品，搭载OpenHarmony2.0操作系统；基于海思HI3861模组, 160MHz主频、SRAM 352KB、ROM 288KB、2M Flash。支持SPI、IIC、UART、ADC、PWM等开发协议， 广泛适用于智能穿戴、智能安防和工业物联网场景。 ![](./asserts/board.png) @@ -20,55 +20,55 @@ GenkiPi development board is produced by Itcast Co., Ltd. It is equipped with O | GPIO_09 | RTS_2 | TXD_0 | ADC_4 | PWM_0 | MCK_0 | D2 | SCL_0 | | GPIO_03 | LOG_TXD_0 | | | | | | | | GPIO_04 | LOG_RXD_0 | | ADC_1 | | | | | -| GPIO_02 | | | | PWM_2 | MCK_0 | | | -| GPIO_05 | RXD_1 | CSI_0 | ADC_2 | PWM_2 | TX_0 | | | -| GPIO_06 | TXD_1 | CLK_0 | | PWM_3 | | | | -| GPIO_14 | LOG_RXD_0/CTS_2 | | | PWM_5 | RX_0 | D1 | SCL_0 | -| GPIO_11 | TXD_2 | RXD_0 | ADC_5 | PWM_2 | CLK_0 | CMD | | -| GPIO_12 | RXD_2 | CSI_0 | ADC_0 | PWM_3 | WS_0 | CLK | | -| GPIO_13 | LOG_TXD_0/RTS_2 | | ADC_6 | PWM_4 | | D0 | SDA_0 | +| GPIO_02 | | | | PWM_2 | | | | +| GPIO_05 | RXD_1 | CSI_0 | ADC_2 | PWM_2 | MCK_0 | | | +| GPIO_06 | TXD_1 | CLK_0 | | PWM_3 | TX_0 | | | +| GPIO_14 | LOG_RXD_0/CTS_2 | | | PWM_5 | | D1 | SCL_0 | +| GPIO_11 | TXD_2 | RXD_0 | ADC_5 | PWM_2 | RX_0 | CMD | | +| GPIO_12 | RXD_2 | CSI_0 | ADC_0 | PWM_3 | CLK_0 | CLK | | +| GPIO_13 | LOG_TXD_0/RTS_2 | | ADC_6 | PWM_4 | WS_0 | D0 | SDA_0 | -## Direction Structure +## 目录 -The root directory of GenkiPi SDK package is `device/itcast/genkipi/`: +GenkiPi 的SDK软件包根目录所在位姿为`device/itcast/genkipi/`, 如下所示: ```bash device/itcast/genkipi -├── BUILD.gn # GN build script -├── interfaces # custom interface -└── sdk_liteos # Liteos kernel directory - ├── app # Application layer code (including demo program as a reference example). - ├── boot # Flash bootloader code. - ├── build # The library files, link files, and configuration files needed for SDK building. - ├── BUILD.gn # GN build script - ├── build_patch.sh # Used to decompress uboot open source source package and patch. - ├── build.sh # Start the compilation script and support "sh build.sh. menuconfig" for customized configuration. - ├── components # SDK platform related components. - ├── config # SDK system configuration file. - ├── config.gni # Support OpenHarmony configuration file. - ├── factory.mk # The factory test version compilation script. - ├── hm_build.sh # Adapt to OpenHarmony build script. - ├── include # API header file storage directory. - ├── license # SDK open source license statement. - ├── Makefile # Support make compilation, use "make" or "make all" to start compilation. - ├── non_factory.mk # Non-factory test version compilation script. - ├── platform # SDK platform related files (including: kernel image, driver module, etc.). - ├── SConstruct # SCons compile script. - ├── third_party # Open source third-party software directory. - └── tools # Tools provided by the SDK on Linux and Windows systems (including: NV creation tools, signature tools, Menuconfig, etc.). +├── BUILD.gn # GN构建脚本 +├── interfaces # 自定义接口 +└── sdk_liteos # Liteos内核目录 + ├── app # 应用层代码（其中包含demo程序为参考示例）。 + ├── boot # Flash bootloader代码。 + ├── build # SDK构建所需的库文件、链接文件、配置文件。 + ├── BUILD.gn # GN构建脚本 + ├── build_patch.sh # 用于解压uboot开源源码包和打patch。 + ├── build.sh # 启动编译脚本，同时支持“sh build.sh。 menuconfig”进行客制化配置。 + ├── components # SDK平台相关的组件。 + ├── config # SDK系统配置文件。 + ├── config.gni # 支持OpenHarmony配置文件。 + ├── factory.mk # 厂测版本编译脚本。 + ├── hm_build.sh # 适配OpenHarmony构建脚本。 + ├── include # API头文件存放目录。 + ├── license # SDK开源license声明。 + ├── Makefile # 支持make编译，使用“make”或“make all”启动编译。 + ├── non_factory.mk # 非厂测版本编译脚本。 + ├── platform # SDK平台相关的文件（包括：内核镜像、驱动模块等）。 + ├── SConstruct # SCons编译脚本。 + ├── third_party # 开源第三方软件目录。 + └── tools # SDK提供的Linux系统和Windows系统上使用的工具（包括：NV制作工具、签名工具、Menuconfig等）。 ``` -## Compilation +## 编译指导 -### Source Download +### 源码下载 -1. repo tool install。if had install it , omit this step. +1. repo工具准备。如果已经安装过repo工具，此步骤省略 ```bash curl https://gitee.com/oschina/repo/raw/fork_flow/repo-py3 > repo @@ -77,7 +77,7 @@ device/itcast/genkipi python3 -m pip install -i https://repo.huaweicloud.com/repository/pypi/simple requests ``` -2. download source +2. 源码下载 ```bash repo init -u https://gitee.com/openharmony-sig/manifest.git -b master --no-repo-verify -m devboard_itcast_genkipi.xml @@ -85,27 +85,25 @@ device/itcast/genkipi repo forall -c 'git lfs pull' ``` -### Compile Code +### 编译代码 -1. choose devboard +1. 选择开发板 ```bash hb set ``` - choose itcast genkipi + 选中 itcast 下的genkipi 即可 -2. compile +2. 编译 ```bash hb build ``` -### Burn Bin - -burn bin with Hiburn tool. - +### 烧录 +通过 hiburn 工具将 out 目录下 allinOne.bin文件进行烧录