From e7f953bf9a8664760a77c5a47e36eaae2c8531cf Mon Sep 17 00:00:00 2001 From: "ester.zhou" Date: Sat, 2 Apr 2022 17:44:30 +0800 Subject: [PATCH] update doc Signed-off-by: ester.zhou --- en/device-dev/device-dev-guide.md | 175 +++++------------------------- 1 file changed, 30 insertions(+), 145 deletions(-) diff --git a/en/device-dev/device-dev-guide.md b/en/device-dev/device-dev-guide.md index ce89a3ec9b..774caeee0c 100644 --- a/en/device-dev/device-dev-guide.md +++ b/en/device-dev/device-dev-guide.md @@ -1,4 +1,4 @@ -# Overview +# Overview This topic provides a panorama of all documents for you to obtain helpful information quickly. These documents are classified based on your learning progress and development scenarios of OpenHarmony. @@ -12,161 +12,46 @@ To make the integration simple and easy on different hardware, OpenHarmony defin - Mini system - A mini system runs on the devices whose memory is greater than or equal to 128 KiB and that are equipped with MCU processors such as Arm Cortex-M and 32-bit RISC-V. This system provides multiple lightweight network protocols and graphics frameworks, and a wide range of read/write components for the IoT bus. Typical products include connection modules, sensors, and wearables for smart home. + A mini system fits into the devices that come with Micro Controller Units (MCUs), such as Arm Cortex-M and 32-bit RISC-V processors, and memory greater than or equal to 128 KiB. This system provides multiple lightweight network protocols, a graphics framework, and a wide range of read/write components with the IoT bus. Typical products include connection modules, sensors, and wearables for smart home. - Small system - A small system runs on the devices whose memory is greater than or equal to 1 MiB and that are equipped with application processors such as Arm Cortex-A. This system provides higher security capabilities, standard graphics frameworks, and video encoding and decoding capabilities. Typical products include smart home IP cameras, electronic cat eyes, and routers, and event data recorders \(EDRs\) for smart travel. + A small system fits into the devices that come with application processors, such as Arm Cortex-A, and memory greater than or equal to 1 MiB. This system provides higher security capabilities, standard graphics frameworks, and video encoding and decoding capabilities. Typical products include smart home IP cameras, electronic cat eyes, and routers, and event data recorders (EDRs) for easy travel. - Standard system - A standard system runs on the devices whose memory is greater than or equal to 128 MiB and that are equipped with application processors such as Arm Cortex-A. This system provides a complete application framework supporting the enhanced interaction, 3D GPU, hardware composer, diverse components, and rich animations. This system applies to high-end refrigerator displays. + A standard system fits into the devices that come with application processors, such as Arm Cortex-A, and memory greater than or equal to 128 MiB. This system provides a complete application framework supporting enhanced interactions, 3D GPU, hardware composer, diverse components, and various animations. Typical products include high-end refrigerator displays. -In addition, OpenHarmony provides a series of optional system components that can be configured as required to support feature extension and customization. These system components are combined to form a series of system capabilities that, for better understanding, are described as features or functions for you to choose. +In addition, OpenHarmony provides a wide array of system components that can be configured as required to support feature extension and customization. These system components are combined to form a series of system capabilities that, for better understanding, are described as features or functions for you to choose. ## Document Outline - [Mini and Small System Development Guidelines](#table3762949121211) - [Standard System Development Guidelines](#table17667535516) -**Table 1** Mini and small system development guidelines \(reference memory < 128 MB\) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Topic

-

Development Scenario

-

Documents

-

About OpenHarmony

-

Getting familiar with OpenHarmony

-		 -

Development resources

-

Preparing for your development

-		 -

Quick start

-

Getting started with setup, build, burning, debugging, and running of OpenHarmony

-

Mini and Small Systems

-

Basic capabilities

-

Using basic capabilities of OpenHarmony

-		 -

Advanced development

-

Developing smart devices based on system capabilities

-		 -

Porting and adaptation

-
  • Porting and adapting the OpenHarmony to an SoC
  • Porting and adapting the OpenHarmony to a third-party library
-		 -

Contributing components

-

Contributing components to OpenHarmony

-		 -

Reference

-

Referring to development specifications

-		 -
- -**Table 2** Standard system development guidelines \(reference memory ≥ 128 MB\) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Topic

-

Development Scenario

-

Documents

-

About OpenHarmony

-

Getting familiar with OpenHarmony

-		 -

Development resources

-

Preparing for your development

-		 -

Quick start

-

Getting started with setup, build, burning, debugging, and running of OpenHarmony

-

Standard System

-

Basic capabilities

-

Using basic capabilities of OpenHarmony

-		 -

Advanced development

-

Developing smart devices based on system capabilities

-		 -

Porting and adaptation

-

Porting and adapting the OpenHarmony to a third-party library

-		 -

Contributing components

-

Contributing components to OpenHarmony

-		 -

Reference

-

Referring to development specifications

-		 -
- +**Table 1** Mini and small system development guidelines (reference memory < 128 MB) + +| Topic| Development Scenario| Related Documentation| +| -------- | -------- | -------- | +| About OpenHarmony| Getting familiar with OpenHarmony| - [About OpenHarmony](https://gitee.com/openharmony)
- [Glossary](../glossary.md) | +| Development resources| Preparing for your development| - [Obtaining Source Code](get-code/sourcecode-acquire.md)
- [Obtaining Tools](get-code/gettools-acquire.md) | +| Getting started| Getting started with setup, build, burning, debugging, and running of OpenHarmony| [Mini and Small Systems](quickstart/quickstart-lite.md)| +| Basic capabilities| Using basic capabilities of OpenHarmony| - [Kernel for Mini System](kernel/kernel-mini-overview.md)
- [Kernel for Small System](kernel/kernel-small-overview.md)
- [HDF](driver/driver-hdf-overview.md)
- [Subsystems](subsystems/subsys-build-mini-lite.md)
- [Security Guidelines](security/security-guidelines-overall.md)
- [Privacy Protection](security/security-privacy-protection.md)| +| Advanced development| Developing smart devices based on system capabilities| - [WLAN-connected Products](guide/device-wlan-led-control.md)
- [Cameras Without a Screen](guide/device-iotcamera-control-overview.md)
- [Cameras with a Screen](guide/device-camera-control-overview.md) | +| Porting and adaptation| - Porting and adapting OpenHarmony to an SoC
- Porting and adapting OpenHarmony to a third-party library| - [Mini System SoC Porting](porting/oem_transplant_chip_prepare_knows.md)
- [Small System SoC Porting](porting/porting-smallchip-prepare-needs.md)
- [Third-Party Library Porting for Mini and Small Systems](porting/porting-thirdparty-overview.md) | +| Contributing components| Contributing components to OpenHarmony| - [HPM Part Overview](hpm-part/hpm-part-about.md)
- [HPM Part Development](hpm-part/hpm-part-development.md)
- [HPM Part Reference](hpm-part/hpm-part-reference.md) | +| Reference| Referring to development specifications| - [API References](https://gitee.com/link?target=https%3A%2F%2Fdevice.harmonyos.com%2Fen%2Fdocs%2Fdevelop%2Fapiref%2Fjs-framework-file-0000000000616658)
- [FAQs](faqs/faqs-overview.md) | + + +**Table 2** Standard system development guidelines (reference memory ≥ 128 MB) +| Topic| Development Scenario| Related Documentation| +| -------- | -------- | -------- | +| About OpenHarmony| Getting familiar with OpenHarmony| - [About OpenHarmony](https://gitee.com/openharmony)
- [Glossary](../glossary.md) | +| Development resources| Preparing for your development| - [Obtaining Source Code](get-code/sourcecode-acquire.md)
- [Obtaining Tools](get-code/gettools-acquire.md) | +| Getting started| Getting started with setup, build, burning, debugging, and running of OpenHarmony| [Standard System](quick-start/)| +| Basic capabilities| Using basic capabilities of OpenHarmony| - [Kernel Development](kernel/kernel-standard.md)
- [HDF](driver/driver-hdf-overview.md)
- [Subsystems](subsystems/subsys-build-standard-large.md)
- [Security Guidelines](security/security-guidelines-overall.md)
- [Privacy Protection](security/security-privacy-protection.md)| +| Advanced development| Developing smart devices based on system capabilities| - [Development Guidelines on Clock Apps](guide/device-clock-guide.md)
- [Development Example for Platform Drivers](guide/device-driver-demo.md)
- [Development Example for Peripheral Drivers](guide/device-outerdriver-demo.md) | +| Porting and adaptation| Porting and adapting OpenHarmony to a third-party library| - [Standard System Porting Guide](porting/standard-system-porting-guide.md)
- [A Method for Rapidly Porting the OpenHarmony Linux Kernel](porting/porting-linux-kernel.md) | +| Contributing components| Contributing components to OpenHarmony| - [HPM Part Overview](hpm-part/hpm-part-about.md)
- [HPM Part Development](hpm-part/hpm-part-development.md)
- [HPM Part Reference](hpm-part/hpm-part-reference.md) | +| Reference| Referring to development specifications| - [API References](https://gitee.com/link?target=https%3A%2F%2Fdevice.harmonyos.com%2Fen%2Fdocs%2Fdevelop%2Fapiref%2Fjs-framework-file-0000000000616658)
- [FAQs](faqs/faqs-overview.md) | -- GitLab