diff --git a/README.md b/README.md index cda7de211b2732fa64bf7aef01620225d8aa8827..8239b0a7c19ff0c82046aabe12b8ef1023cae061 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Utils +# commonlibrary/utils_lite - [Overview](#section62661387114) - [Directory Structure](#section1464106163817) @@ -7,14 +7,14 @@ ## Overview -The Utils repository stores basic components of OpenHarmony. These basic components are used by OpenHarmony subsystems and upper-layer applications. +The utils_lite repository stores basic components of OpenHarmony. These basic components are used by OpenHarmony subsystems and upper-layer applications. -The Utils library provides the following capabilities on different platforms: +The utils_lite library provides the following capabilities on different platforms: -- 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 +- LiteOS Cortex-M \(Hi3861 platform\): file operations and timer +- LiteOS Cortex-A \(Hi3516 or Hi3518 platform\): timer and JavaScript APIs for device query and data storage -**Table 1** Utils capabilities +**Table 1** Utils_lite capabilities - - - - + - - - -

Module

@@ -25,13 +25,7 @@ The Utils library provides the following capabilities on different platforms:

KV store

-

LiteOS Cortex-M and LiteOS Cortex-A

-

Provides KV storage for applications.

-

File operation

LiteOS Cortex-M

@@ -53,13 +47,6 @@ The Utils library provides the following capabilities on different platforms:

Provides JavaScript APIs for obtaining device information and storing data.

System attribute dumping

-

LiteOS Cortex-M and LiteOS Cortex-A

-

Provides the command line tool for dumping system attributes.

-
@@ -79,9 +66,6 @@ commonlibrary/utils_lite/ # Root directory │ └── kvstorekit # KV store kit ├── kal # KAL directory │ └── timer # KAL implementation of the timer -├── kv_store # KV store implementation -│ ├── innerkits # Internal KV store APIs -│ └── src # KV store source file ├── memory │ └── include # Memory pool management APIs └── timer_task # Timer implementation @@ -89,22 +73,6 @@ commonlibrary/utils_lite/ # Root directory ## Usage -- **KV store** - - ``` - // Store or update the value of a key. - const char key1[] = "key_sample"; - const char defValue[] = "test case of key value store."; - int ret = UtilsSetValue(key1, defValue); - - // Obtain the value of the key. - char value1[32] = {0}; - ret = UtilsGetValue(key1, value1, 32); - - // Delete the value of the key. - UtilsDeleteValue(key1); - ``` - - **File operation** ``` @@ -142,6 +110,6 @@ commonlibrary/utils_lite/ # Root directory ## Repositories Involved -[Utils](https://gitee.com/openharmony/docs/blob/master/en/readme/utils.md) +[commonlibrary](https://gitee.com/openharmony/docs/blob/master/en/readme/commonlibrary.md) -[**utils\_native\_lite**](https://gitee.com/openharmony/utils_native_lite/blob/master/README.md) \ No newline at end of file +[**commonlibrary\_utils\_lite**](https://gitee.com/openharmony/commonlibrary_utils_lite) \ No newline at end of file diff --git a/README_zh.md b/README_zh.md index d3f8f164cdf4ef12c25848bff46b58097da3e009..ae66c5f87e225208ca5c7cdea4fac407bf5555a0 100644 --- a/README_zh.md +++ b/README_zh.md @@ -1,4 +1,4 @@ -# 项目介绍 +# 轻量级公共基础库 - [简介](#section62661387114) - [目录](#section1464106163817) @@ -7,14 +7,14 @@ ## 简介 -公共基础库存放OpenHarmony通用的基础组件。这些基础组件可被OpenHarmony各业务子系统及上层应用所使用。 +轻量级公共基础库存放OpenHarmony通用的基础组件。这些基础组件可被OpenHarmony各业务子系统及上层应用所使用。 -公共基础库在不同平台上提供的能力: +轻量级公共基础库在不同平台上提供的能力: -- LiteOS-M内核\(Hi3861平台\):KV\(key value\)存储、文件操作、定时器、Dump系统属性。 -- LiteOS-A内核\(Hi3516、Hi3518平台\):KV\(key value\)存储、定时器、JS API\(设备查询,数据存储\)、Dump系统属性。 +- LiteOS-M内核\(Hi3861平台\):文件操作、定时器。 +- LiteOS-A内核\(Hi3516、Hi3518平台\):定时器、JS API\(设备查询,数据存储\)。 -**表 1** 公共基础库功能 +**表 1** 轻量级公共基础库功能 - - - - + - - - -

模块

@@ -25,13 +25,7 @@

KV存储

-

LiteOS-M内核、LiteOS-A内核

-

为应用程序提供KV存储机制。

-

文件操作

LiteOS-M内核

@@ -53,20 +47,13 @@

提供获取设备信息,数据存储的JS API。

Dump系统属性

-

LiteOS-M内核、LiteOS-A内核

-

提供Dump系统属性的命令行工具。

-
## 目录 ``` -commonlibrary/utils_lite/ # 公共基础库根目录 +commonlibrary/utils_lite/ # 轻量级公共基础库根目录 ├── file # 文件接口实现 ├── hals # HAL目录 │ └── file # 文件操作硬件抽象层头文件 @@ -79,9 +66,6 @@ commonlibrary/utils_lite/ # 公共基础库根目录 │ └── kvstorekit # KV存储Kit ├── kal # KAL目录 │ └── timer # Timer的KAL实现 -├── kv_store # KV存储实现 -│ ├── innerkits # KV存储内部接口 -│ └── src # KV存储源文件 ├── memory │ └── include # 内存池管理接口 └── timer_task # Timer实现 @@ -89,22 +73,6 @@ commonlibrary/utils_lite/ # 公共基础库根目录 ## 使用 -- **KV存储** - - ``` - // 存储/更新key对应数据项 - const char key1[] = "key_sample"; - const char defValue[] = "test case of key value store."; - int ret = UtilsSetValue(key1, defValue); - - // 根据key获取对应数据项 - char value1[32] = {0}; - ret = UtilsGetValue(key1, value1, 32); - - // 删除key对应数据项 - UtilsDeleteValue(key1); - ``` - - **文件操作** ``` @@ -144,4 +112,4 @@ commonlibrary/utils_lite/ # 公共基础库根目录 [公共基础](https://gitee.com/openharmony/docs/blob/master/zh-cn/readme/%E5%85%AC%E5%85%B1%E5%9F%BA%E7%A1%80%E5%BA%93.md) -[**utils\_native\_lite**](https://gitee.com/openharmony/utils_native_lite/blob/master/README_zh.md) \ No newline at end of file +[**commonlibrary\_utils\_lite**](https://gitee.com/openharmony/commonlibrary_utils_lite) \ No newline at end of file