【增加】增加英文 readme

README.md

@@ -1,78 +1,81 @@
-# 基于 EasyFlash 的 ulog 插件
-## 1、介绍
+# Ulog plugin based on EasyFlash
 
-ulog 是 RT-Thread 全新的日志组件，其前后端分离式设计，使得更多的后端可以轻松的对接上去。该软件包主要实现了 **ulog 的 Flash 后端** 以及 **ulog 的过滤器参数存储** 两大功能，它的底层基于 Flash 闪存库 [EasyFlash](https://github.com/armink/EasyFlash) ，使得来自于 ulog 的日志及过滤参数可以轻松保存在 Flash 上。其主要功能特点如下：
+[中文页](README_ZH.md) | English
 
-- 资源占用小，与 EasyFlash 的 ENV 及 LOG 功能无缝对接；
-- 日志采用循环替换方式进行存储，当日志分区满了以后，会自动删除最久的日志；
-- 已存储的历史日志支持读取到 RT-Thread 控制台中，便于阅读、调试；
-- 可选择性的读取近期一部分日志到 RT-Thread 控制台中；
-- 开机自动装载已保存的 ulog 过滤参数；
-- 所有功能提供了 Finsh/MSH 命令，支持：日志读取，日志清理，保存过滤参数。
+## 1. Introduction
 
-### 1.1 许可证
+ulog is a brand new log component of RT-Thread. Its front-end and back-end separation design allows more back-ends to be easily connected. This software package mainly implements the two functions of **ulog's Flash backend** and **ulog's filter parameter storage**. Its bottom layer is based on the Flash flash library [EasyFlash](https://github.com/armink) /EasyFlash) makes it easy to save logs and filter parameters from ulog on Flash. Its main features are as follows:
 
-本软件包遵循 MIT 许可，详见 `LICENSE` 文件。
+- Small resource occupation, seamless connection with ENV and LOG functions of EasyFlash;
+- Logs are stored in a circular replacement method. When the log partition is full, the oldest log will be automatically deleted;
+- The stored history log can be read into the RT-Thread console for easy reading and debugging;
+- Optionally read a part of recent logs to the RT-Thread console;
+- Automatically load the saved ulog filter parameters at startup;
+- All functions provide Finsh/MSH commands, support: log reading, log cleaning, saving filter parameters.
 
-### 1.2 依赖
+### 1.1 License
+
+This package complies with the MIT license, see the `LICENSE` file for details.
+
+### 1.2 Dependency
 
 - RT-Thread 3.1.1+
 - EasyFlash 3.0.0+
 
-## 2、如何打开
+## 2. How to open
 
-使用本软件包需要在 RT-Thread 的包管理器中选择它，具体路径如下：
+To use this package, you need to select it in the package manager of RT-Thread. The specific path is as follows:
 
 ```
 RT-Thread online packages
     tools packages --->
         [*] ulog_easyflash: The ulog flash plugin by EasyFlash.
-            [*]   Enable the flash backend for ulog
-            [*]   Save the ulog filter configuration to flash
-            Version (latest)  --->
+            [*] Enable the flash backend for ulog
+            [*] Save the ulog filter configuration to flash
+            Version (latest) --->
 ```
 
-- `Enable the flash backend for ulog`：开启 ulog 的 flash 后端功能；
-- `Save the ulog filter configuration to flash`：开启保存 ulog 过滤参数的功能。
+- `Enable the flash backend for ulog`: Enable the flash backend function of ulog;
+- `Save the ulog filter configuration to flash`: Turn on the function of saving ulog filter parameters.
 
-然后让 RT-Thread 的包管理器自动更新，或者使用 `pkgs --update` 命令更新包到 BSP 中。
+Then let RT-Thread's package manager automatically update, or use the `pkgs --update` command to update the package to the BSP.
 
-> **注意** ：
+> **Note**:
 >
-> - 如果之前未开启 EasyFlash 的 LOG 功能，开启本软件包后，需要在 EasyFlash 选项中配置日志区域大小，配置名称为： Saved log area size。
-> - 使用保存过滤参数功能前，需保证 ulog 那边开启了运行时过滤功能，配置名称为：Enable runtime log filter.
+>- If the LOG function of EasyFlash has not been enabled before, after opening this software package, you need to configure the log area size in the EasyFlash options. The configuration name is: Saved log area size.
+>- Before using the function of saving filter parameters, ensure that the runtime filter function is enabled on the ulog side, and the configuration name is: Enable runtime log filter.
 
-## 3、使用说明
+## 3. Instructions for use
 
-### 3.1 Flash 后端初始化
+### 3.1 Flash backend initialization
 
-需要在应用层调用 `ulog_ef_backend_init()` 初始化函数即可。如果项目开启了组件自动初始化，甚至连这个函数都无需调用，软件包里已经为这个函数添加了组件初始化功能。
+You need to call the initialization function `ulog_ef_backend_init()` at the application layer. If the project enables automatic component initialization, even this function does not need to be called. The component initialization function has been added to this function in the software package.
 
-### 3.2 设定 Flash 日志保存级别
+### 3.2 Set Flash log save level
 
-通过该函数：`void ulog_ef_log_lvl_set(rt_uint32_t level)` ，可以设定想要保存到 Flash 里的日志级别，低于该级别的日志将被 **丢弃** 。举例：设定只保存警告（含）以上级别的日志，可以执行如下代码 ： 
+Through this function: `void ulog_ef_log_lvl_set(rt_uint32_t level)`, you can set the log level you want to save to Flash. Logs below this level will be **discarded**. Example: To set to save only the logs at the warning level and above, you can execute the following code:
 
 ```c
-ulog_ef_log_lvl_set(LOG_LVL_WARNING)；
+ulog_ef_log_lvl_set(LOG_LVL_WARNING);
 ```
 
-### 3.3 装载 ulog 过滤参数
+### 3.3 Load ulog filter parameters
 
-通过该函数：`void ulog_ef_filter_cfg_load(void)` ，可以转载 Flash 中已经存储的 ulog 过滤参数。如果项目开启了组件自动初始化，这个函数会在上电时自动运行。
+Through this function: `void ulog_ef_filter_cfg_load(void)`, you can reprint the ulog filtering parameters already stored in Flash. If the project has enabled component auto-initialization, this function will run automatically upon power-up.
 
-### 3.4 保存 ulog 过滤参数
+### 3.4 Save ulog filter parameters
 
-通过该函数：`void ulog_ef_filter_cfg_save(void)` ，可以将 ulog 已设定的过滤参数保存至 flash 中，该函数也有对应的 Finsh/MSH 命令：`ulog_filter_save` ，需要保存时，执行一下即可。
+Through this function: `void ulog_ef_filter_cfg_save(void)`, you can save the filtering parameters that ulog has set to flash. This function also has a corresponding Finsh/MSH command: `ulog_filter_save`. When you need to save, just execute it.
 
-### 3.5 Finsh/MSH 命令的使用
+### 3.5 Use of Finsh/MSH commands
 
-Flash 日志相关的命令格式为 `ulog_flash <read|clean>` 
+The command format related to Flash log is `ulog_flash <read|clean>`
 
-#### 3.5.1 历史日志读取
+#### 3.5.1 Historical log reading
 
-历史日志存到 Flash 后，可以通过下面的命令读取到控制台上，方便开发者回顾日志，分析问题。
+After the history log is saved in Flash, it can be read to the console through the following command, which is convenient for developers to review the log and analyze the problem.
 
-- 读取全部的历史日志，输入命令：`ulog_flash read`
+- To read all historical logs, enter the command: `ulog_flash read`
 
 ```shell
 msh />ulog_flash read
@@ -82,7 +85,7 @@ msh />ulog_flash read
 msh />
 ```
 
-- 读取近期的 200 字节日志，输入命令：`ulog_flash read 200`
+- To read the recent 200-byte log, enter the command: `ulog_flash read 200`
 
 ```shell
 msh />ulog_flash read 200
@@ -92,9 +95,9 @@ log_w(50): RT-Thread is an open source IoT operating system from China.
 msh />
 ```
 
-#### 3.5.2 清空历史日志
+#### 3.5.2 Clear history log
 
-当需要清空日志区的全部历史日志时，可以输入命令： `ulog_flash clean`
+When you need to clear all historical logs in the log area, you can enter the command: `ulog_flash clean`
 
 ```shell
 msh />ulog_flash clean
@@ -102,11 +105,11 @@ msh />ulog_flash clean
 msh />
 ```
 
-稍等片刻，日志清理完成将会显示清理成功的提示。
+Wait for a while, the log cleaning is complete, a prompt of successful cleaning will be displayed.
 
-#### 3.5.3 保存 ulog 的过滤参数至 Flash
+#### 3.5.3 Save ulog filter parameters to Flash
 
-在调试开发过程中，ulog 的过滤参数设定完成后，如果需要保存，可以输入命令：`ulog_filter_save` 。保存完完成后，重启再次使用 `ulog_filter` 命令，可以看到之前保存的过滤参数。
+In the debugging and development process, after the ulog filter parameters are set, if you need to save, you can enter the command: `ulog_filter_save`. After saving, restart and use the `ulog_filter` command again, you can see the previously saved filter parameters.
 
 ```shell
 msh />ulog_filter_save
@@ -116,11 +119,11 @@ msh />ulog_filter_save
 msh />
 ```
 
-## 4、注意事项
+## 4. Matters needing attention
 
-- 使用本软件包前，需保证依赖的选项被提前打开，否则在 menuconfig 无法看到选项。
+- Before using this package, make sure that the dependent options are opened in advance, otherwise the options cannot be seen in menuconfig.
 
-## 5、联系方式 & 感谢
+## 5. Contact & Thanks
 
-* 维护：[armink](https://github.com/armink)
-* 主页：https://github.com/armink-rtt-pkgs/ulog_easyflash
+* Maintenance: [armink](https://github.com/armink)
+* Homepage: https://github.com/armink-rtt-pkgs/ulog_easyflash

README_ZH.md

@@ -0,0 +1,129 @@
+# 基于 EasyFlash 的 ulog 插件
+
+中文页 | [English](README.md)
+
+## 1、介绍
+
+ulog 是 RT-Thread 全新的日志组件，其前后端分离式设计，使得更多的后端可以轻松的对接上去。该软件包主要实现了 **ulog 的 Flash 后端** 以及 **ulog 的过滤器参数存储** 两大功能，它的底层基于 Flash 闪存库 [EasyFlash](https://github.com/armink/EasyFlash) ，使得来自于 ulog 的日志及过滤参数可以轻松保存在 Flash 上。其主要功能特点如下：
+
+- 资源占用小，与 EasyFlash 的 ENV 及 LOG 功能无缝对接；
+- 日志采用循环替换方式进行存储，当日志分区满了以后，会自动删除最久的日志；
+- 已存储的历史日志支持读取到 RT-Thread 控制台中，便于阅读、调试；
+- 可选择性的读取近期一部分日志到 RT-Thread 控制台中；
+- 开机自动装载已保存的 ulog 过滤参数；
+- 所有功能提供了 Finsh/MSH 命令，支持：日志读取，日志清理，保存过滤参数。
+
+### 1.1 许可证
+
+本软件包遵循 MIT 许可，详见 `LICENSE` 文件。
+
+### 1.2 依赖
+
+- RT-Thread 3.1.1+
+- EasyFlash 3.0.0+
+
+## 2、如何打开
+
+使用本软件包需要在 RT-Thread 的包管理器中选择它，具体路径如下：
+
+```
+RT-Thread online packages
+    tools packages --->
+        [*] ulog_easyflash: The ulog flash plugin by EasyFlash.
+            [*]   Enable the flash backend for ulog
+            [*]   Save the ulog filter configuration to flash
+            Version (latest)  --->
+```
+
+- `Enable the flash backend for ulog`：开启 ulog 的 flash 后端功能；
+- `Save the ulog filter configuration to flash`：开启保存 ulog 过滤参数的功能。
+
+然后让 RT-Thread 的包管理器自动更新，或者使用 `pkgs --update` 命令更新包到 BSP 中。
+
+> **注意** ：
+>
+> - 如果之前未开启 EasyFlash 的 LOG 功能，开启本软件包后，需要在 EasyFlash 选项中配置日志区域大小，配置名称为： Saved log area size。
+> - 使用保存过滤参数功能前，需保证 ulog 那边开启了运行时过滤功能，配置名称为：Enable runtime log filter.
+
+## 3、使用说明
+
+### 3.1 Flash 后端初始化
+
+需要在应用层调用 `ulog_ef_backend_init()` 初始化函数即可。如果项目开启了组件自动初始化，甚至连这个函数都无需调用，软件包里已经为这个函数添加了组件初始化功能。
+
+### 3.2 设定 Flash 日志保存级别
+
+通过该函数：`void ulog_ef_log_lvl_set(rt_uint32_t level)` ，可以设定想要保存到 Flash 里的日志级别，低于该级别的日志将被 **丢弃** 。举例：设定只保存警告（含）以上级别的日志，可以执行如下代码 ： 
+
+```c
+ulog_ef_log_lvl_set(LOG_LVL_WARNING)；
+```
+
+### 3.3 装载 ulog 过滤参数
+
+通过该函数：`void ulog_ef_filter_cfg_load(void)` ，可以转载 Flash 中已经存储的 ulog 过滤参数。如果项目开启了组件自动初始化，这个函数会在上电时自动运行。
+
+### 3.4 保存 ulog 过滤参数
+
+通过该函数：`void ulog_ef_filter_cfg_save(void)` ，可以将 ulog 已设定的过滤参数保存至 flash 中，该函数也有对应的 Finsh/MSH 命令：`ulog_filter_save` ，需要保存时，执行一下即可。
+
+### 3.5 Finsh/MSH 命令的使用
+
+Flash 日志相关的命令格式为 `ulog_flash <read|clean>` 
+
+#### 3.5.1 历史日志读取
+
+历史日志存到 Flash 后，可以通过下面的命令读取到控制台上，方便开发者回顾日志，分析问题。
+
+- 读取全部的历史日志，输入命令：`ulog_flash read`
+
+```shell
+msh />ulog_flash read
+10-23 10:28:51.618 D/example tshell: LOG_D(1): RT-Thread is an open source IoT operating system from China.
+10-23 10:28:51.618 I/example tshell: LOG_I(1): RT-Thread is an open source IoT
+......
+msh />
+```
+
+- 读取近期的 200 字节日志，输入命令：`ulog_flash read 200`
+
+```shell
+msh />ulog_flash read 200
+log_w(50): RT-Thread is an open source IoT operating system from China.
+10-23 19:37:05.137 E/test tshell: ulog_e(50): RT-Thread is an open source IoT operating system from China.
+
+msh />
+```
+
+#### 3.5.2 清空历史日志
+
+当需要清空日志区的全部历史日志时，可以输入命令： `ulog_flash clean`
+
+```shell
+msh />ulog_flash clean
+10-24 10:00:22.307 I/easyflash tshell: All logs which in flash is clean OK.
+msh />
+```
+
+稍等片刻，日志清理完成将会显示清理成功的提示。
+
+#### 3.5.3 保存 ulog 的过滤参数至 Flash
+
+在调试开发过程中，ulog 的过滤参数设定完成后，如果需要保存，可以输入命令：`ulog_filter_save` 。保存完完成后，重启再次使用 `ulog_filter` 命令，可以看到之前保存的过滤参数。
+
+```shell
+msh />ulog_filter_save
+[Flash] (../packages/EasyFlash-latest/src/ef_env.c:821) Calculate ENV CRC32 number is 0x10C41F91.
+[Flash] (../packages/EasyFlash-latest/src/ef_env.c:774) Erased ENV OK.
+[Flash] (../packages/EasyFlash-latest/src/ef_env.c:788) Saved ENV OK.
+msh />
+```
+
+## 4、注意事项
+
+- 使用本软件包前，需保证依赖的选项被提前打开，否则在 menuconfig 无法看到选项。
+
+## 5、联系方式 & 感谢
+
+* 维护：[armink](https://github.com/armink)
+* 主页：https://github.com/armink-rtt-pkgs/ulog_easyflash