提交 a8cb06b3 编写于 作者: A armink

1、【更新】首页说明文档及API文档。

Signed-off-by: Narmink <armink.ztl@gmail.com>
上级 63260779
......@@ -6,9 +6,9 @@
EasyFlash是一款开源的轻量级嵌入式Flash存储器库,主要为MCU(Micro Control Unit)提供便捷、通用的上层应用接口,使得开发者更加高效实现基于的Flash存储器常见应用开发。该库目前提供 **三大实用功能**
- **Env** 小型KV数据库,支持 **写平衡(磨损平衡)** 模式
- **Env** 小型KV数据库,支持 **写平衡(磨损平衡)** **掉电保护** 模式
让Flash变为NoSQL(非关系型数据库)模型的小型键值(Key-Value)存储数据库。在产品上,能够更加简捷的实现 **设定参数****运行日志** 等信息掉电保存功能。
让Flash变为NoSQL(非关系型数据库)模型的小型键值(Key-Value)存储数据库。在产品上,能够更加简捷的实现 **设定参数****运行日志** 等信息掉电保存功能。
- **IAP** 在线升级再也不是难事儿
......@@ -89,7 +89,7 @@ Demo平台:STM32F103RET6 + RT-Thread 1.2.2 + Env(2K bytes)
EasyFlash is an open source lightweight embedded flash memory library. It provide convenient application interface for MCU (Micro Control Unit). The developers can achieve more efficient and common application development based on Flash memory. The library currently provides **Three useful features** :
- **Env(environment variables)** : A small KV database. Support **write balance mode(wear leveling)** .
- **Env(environment variables)** : A small KV database. Support **write balance mode(wear leveling)** and **power fail safeguard**.
Let Flash becomes a small NoSQL (non-relational databases) model and Key-Value stores database. You can be more simple to store **setting parameters** or **running logs** and other information which you want to power down to save.
......
......@@ -319,22 +319,12 @@ void ef_print(const char *format, ...)
- 默认状态:开启
- 操作方法:开启、关闭`EF_USING_ENV`宏即可
### 3.2 IAP功能
- 默认状态:开启
- 操作方法:开启、关闭`EF_USING_IAP`宏即可
### 3.3 Log功能
- 默认状态:开启
- 操作方法:开启、关闭`EF_USING_LOG`宏即可
### 3.4 环境变量的容量
#### 3.1.1 环境变量的容量
- 默认容量:2K Bytes
- 操作方法:修改`EF_USER_SETTING_ENV_SIZE`宏定义即可
### 3.5 磨损平衡/常规 模式
#### 3.1.2 磨损平衡/常规 模式
> 磨损平衡:由于flash在写操作之前需要擦除且使用寿命有限,所以需要设计合理的磨损平衡(写平衡)机制,来保证数据被安全的保存在未到擦写寿命的Flash区中。
......@@ -344,7 +334,22 @@ void ef_print(const char *format, ...)
> 注意:只能选择其中一种模式,两种模式不能同时使用
###
#### 3.1.3 掉电保护
> 掉电保护:Power Fail Safeguard,当此项设置为可用时,如果在环境变量保存过程中发生掉电,已保存在Flash中的环境变量将不会有丢失的危险。下次上电后,环境变量将会被自动还原至之前的状态。(注意:本保护是基于软件实现的保护功能,更加可靠的掉电保护功能需要通过硬件来实现)
- 默认状态:关闭
- 操作方法:开启、关闭`EF_ENV_USING_PFS_MODE`宏即可
### 3.2 IAP功能
- 默认状态:开启
- 操作方法:开启、关闭`EF_USING_IAP`宏即可
### 3.3 Log功能
- 默认状态:开启
- 操作方法:开启、关闭`EF_USING_LOG`宏即可
## 4、注意
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册