openharmony/utils_native_lite
1
0
Fork 0
mirror of https://github.com/openharmony/utils_native_lite.git synced 2026-07-18 12:34:40 -04:00
Code Issues Packages Projects Releases Wiki Activity

Description:update utils readme

Browse Source 
Feature or Bugfix:Feature
Binary Source:Huawei
PrivateCode(Yes/No):Yes

Change-Id: I9914439cf12b7d15e800f2fffcb8c8467f0071e0
ChangeID:13287268
This commit is contained in:
liubeibei
2021-03-16 21:13:43 +08:00
committed by mamingshuai
parent 3a8f73a00e
commit b8716da5e5
2 changed files with 17 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+9 -19
View File
@@ -11,7 +11,7 @@ The Utils repository stores basic components of OpenHarmony. These basic compone
The Utils library provides the following capabilities on different platforms:
- LiteOS Cortex-M \(Hi3861 platform\): key value \(KV\) store, file operations, timer, IoT peripheral control, and system attribute dumping
- LiteOS Cortex-M \(Hi3861 platform\): key value \(KV\) store, file operations, timer, and system attribute dumping
- LiteOS Cortex-A \(Hi3516 or Hi3518 platform\): KV store, timer, JavaScript APIs for device query and data storage, and system attribute dumping
**Table 1** Utils capabilities
@@ -53,13 +53,6 @@ The Utils library provides the following capabilities on different platforms:
<td class="cellrowborder" valign="top" width="54.010000000000005%" headers="mcps1.2.4.1.3 "><p id="en-us_topic_0000001052623010_p1550005422814"><a name="en-us_topic_0000001052623010_p1550005422814"></a><a name="en-us_topic_0000001052623010_p1550005422814"></a>Provides JavaScript APIs for obtaining device information and storing data.</p>
</td>
</tr>
<tr id="en-us_topic_0000001052623010_row1763022010287"><td class="cellrowborder" valign="top" width="21.22%" headers="mcps1.2.4.1.1 "><p id="en-us_topic_0000001052623010_p463052016289"><a name="en-us_topic_0000001052623010_p463052016289"></a><a name="en-us_topic_0000001052623010_p463052016289"></a>IoT peripheral control</p>
</td>
<td class="cellrowborder" valign="top" width="24.77%" headers="mcps1.2.4.1.2 "><p id="en-us_topic_0000001052623010_p1163032011284"><a name="en-us_topic_0000001052623010_p1163032011284"></a><a name="en-us_topic_0000001052623010_p1163032011284"></a>LiteOS Cortex-M</p>
</td>
<td class="cellrowborder" valign="top" width="54.010000000000005%" headers="mcps1.2.4.1.3 "><p id="en-us_topic_0000001052623010_p5630820102812"><a name="en-us_topic_0000001052623010_p5630820102812"></a><a name="en-us_topic_0000001052623010_p5630820102812"></a>Provides the capability of performing operations for peripherals.</p>
</td>
</tr>
<tr id="en-us_topic_0000001052623010_row5553145162815"><td class="cellrowborder" valign="top" width="21.22%" headers="mcps1.2.4.1.1 "><p id="en-us_topic_0000001052623010_p106300200288"><a name="en-us_topic_0000001052623010_p106300200288"></a><a name="en-us_topic_0000001052623010_p106300200288"></a>System attribute dumping</p>
</td>
<td class="cellrowborder" valign="top" width="24.77%" headers="mcps1.2.4.1.2 "><p id="en-us_topic_0000001052623010_p16300204280"><a name="en-us_topic_0000001052623010_p16300204280"></a><a name="en-us_topic_0000001052623010_p16300204280"></a>LiteOS Cortex-M and LiteOS Cortex-A</p>
@@ -73,27 +66,26 @@ The Utils library provides the following capabilities on different platforms:
## Directory Structure<a name="section1464106163817"></a>
```
utils/native/lite/ # Root directory
utils/native/lite/ # Root directory
├── file # Implementation of the file system APIs
├── hals # HAL directory
│ └── file # Header files of the hardware abstraction layer for file operations
│ └── file # Header files of the hardware abstraction layer for file operations
├── include # Header files of external APIs
├── js # JavaScript APIs
│ └── builtin
│ └── builtin
│ ├── common
│ ├── deviceinfokit # Device information kit
│ ├── filekit # File kit
│ └── kvstorekit # KV store kit
├── kal # KAL directory
├── kal # KAL directory
│ └── timer # KAL implementation of the timer
├── kv_store # KV store implementation
├── kv_store # KV store implementation
│ ├── innerkits # Internal KV store APIs
│ └── src # KV store source file
├── memory
│ └── include # Memory pool management APIs
├── os_dump # System attribute dumping
├── timer_task # Timer implementation
└── unittest # Self-test cases
├── os_dump # System attribute dumping
└── timer_task # Timer implementation
```
## Usage<a name="section25021123178"></a>
@@ -165,9 +157,7 @@ utils/native/lite/ # Root directory
## Repositories Involved<a name="section4571352889"></a>
[utils](https://gitee.com/openharmony/docs/blob/master/en/readme/utils.md)
[Utils](https://gitee.com/openharmony/docs/blob/master/en/readme/utils.md)
utils\_native\_lite
[iothardware\_peripheral](https://gitee.com/openharmony/iothardware_peripheral/blob/master/README.md)
README_zh.md
+8 -18
View File
@@ -11,7 +11,7 @@
公共基础库在不同平台上提供的能力：
- LiteOS-M内核\(Hi3861平台\)：KV\(key value\)存储、文件操作、定时器、IoT外设控制、Dump系统属性。
- LiteOS-M内核\(Hi3861平台\)：KV\(key value\)存储、文件操作、定时器、Dump系统属性。
- LiteOS-A内核\(Hi3516、Hi3518平台\)：KV\(key value\)存储、定时器、JS API\(设备查询，数据存储\)、Dump系统属性。
**表 1** 公共基础库功能
@@ -53,13 +53,6 @@
<td class="cellrowborder" valign="top" width="54.010000000000005%" headers="mcps1.2.4.1.3 "><p id="zh-cn_topic_0000001052623010_p1550005422814"><a name="zh-cn_topic_0000001052623010_p1550005422814"></a><a name="zh-cn_topic_0000001052623010_p1550005422814"></a>提供获取设备信息，数据存储的JS API。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001052623010_row1763022010287"><td class="cellrowborder" valign="top" width="21.22%" headers="mcps1.2.4.1.1 "><p id="zh-cn_topic_0000001052623010_p463052016289"><a name="zh-cn_topic_0000001052623010_p463052016289"></a><a name="zh-cn_topic_0000001052623010_p463052016289"></a>IoT外设控制</p>
</td>
<td class="cellrowborder" valign="top" width="24.77%" headers="mcps1.2.4.1.2 "><p id="zh-cn_topic_0000001052623010_p1163032011284"><a name="zh-cn_topic_0000001052623010_p1163032011284"></a><a name="zh-cn_topic_0000001052623010_p1163032011284"></a>LiteOS-M内核</p>
</td>
<td class="cellrowborder" valign="top" width="54.010000000000005%" headers="mcps1.2.4.1.3 "><p id="zh-cn_topic_0000001052623010_p5630820102812"><a name="zh-cn_topic_0000001052623010_p5630820102812"></a><a name="zh-cn_topic_0000001052623010_p5630820102812"></a>IoT外设控制模块提供对外围设备的操作能力。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001052623010_row5553145162815"><td class="cellrowborder" valign="top" width="21.22%" headers="mcps1.2.4.1.1 "><p id="zh-cn_topic_0000001052623010_p106300200288"><a name="zh-cn_topic_0000001052623010_p106300200288"></a><a name="zh-cn_topic_0000001052623010_p106300200288"></a>Dump系统属性</p>
</td>
<td class="cellrowborder" valign="top" width="24.77%" headers="mcps1.2.4.1.2 "><p id="zh-cn_topic_0000001052623010_p16300204280"><a name="zh-cn_topic_0000001052623010_p16300204280"></a><a name="zh-cn_topic_0000001052623010_p16300204280"></a>LiteOS-M内核、LiteOS-A内核</p>
@@ -73,27 +66,26 @@
## 目录<a name="section1464106163817"></a>
```
utils/native/lite/ # 公共基础库根目录
utils/native/lite/ # 公共基础库根目录
├── file # 文件接口实现
├── hals # HAL目录
│ └── file # 文件操作硬件抽象层头文件
│ └── file # 文件操作硬件抽象层头文件
├── include # 公共基础库对外接口文件
├── js # JS API目录
│ └── builtin
│ └── builtin
│ ├── common
│ ├── deviceinfokit # 设备信息Kit
│ ├── filekit # 文件Kit
│ └── kvstorekit # KV存储Kit
├── kal # KAL目录
├── kal # KAL目录
│ └── timer # Timer的KAL实现
├── kv_store # KV存储实现
├── kv_store # KV存储实现
│ ├── innerkits # KV存储内部接口
│ └── src # KV存储源文件
├── memory
│ └── include # 内存池管理接口
├── os_dump # Dump系统属性
├── timer_task # Timer实现
└── unittest # 公共基础库自测试用例
├── os_dump # Dump系统属性
└── timer_task # Timer实现
```
## 使用<a name="section25021123178"></a>
@@ -169,5 +161,3 @@ utils/native/lite/ # 公共基础库根目录
utils\_native\_lite
[iothardware\_peripheral](https://gitee.com/openharmony/iothardware_peripheral/blob/master/README_zh.md)