EasyFlash 技术文档

EasyFlash 技术文档

EasyFlash Lightweight IoT device information storage solution: KV/IAP/LOG. | 轻量级物联网设备信息存储方案：参数存储、在线升级及日志存储 ，全新一代版本请移步至 https://github.com/armink/FlashDB 项目地址: https://gitcode.com/gh_mirrors/ea/EasyFlash

安装指南

1. 克隆仓库: 使用Git克隆EasyFlash到本地。

   git clone https://github.com/armink/EasyFlash.git
   

2. 依赖项: 确保您有一个支持的目标MCU开发环境，以及可能需要的SPI Flash驱动库如SFUD。

3. 配置移植: 修改easyflash/port/ef_port.c文件，根据您的目标硬件实现Flash的擦除、写入、读取和打印函数。

4. 整合到项目: 将EasyFlash整个目录集成到您的嵌入式项目中，确保正确链接相关源文件。

项目的使用说明

环境变量（Env）

• 初始化: 在应用程序启动初期调用EF_Init()。
• 添加环境变量:

  EF_Set("temp", "123");
  

• 获取环境变量:

  char temp[32];
  if(EF_Get("temp", temp, sizeof(temp))) {
      printf("Temperature: %s\n", temp);
  }
  

• 删除环境变量:

  EF_Del("temp");
  

在线升级（IAP）

• 准备升级: 实现或调用IAP相关接口，比如设置升级路径和检查新固件。
• 执行升级:

  EF_IapStartUpgrade();
  

日志（Log）

• 启用日志到Flash: 配置日志记录选项以便写入Flash，通常与EasyLogger结合使用。
• 记录日志:

  LOG_INFO("Starting application...");
  

项目API使用文档

详细的API文档位于项目目录下的\docs\zh\api.md文件中，涵盖了所有核心函数的详细说明和示例用法，包括但不限于EF_Init, EF_Set, EF_Get, EF_Del, EF_IapStartUpgrade等。

项目安装方式

• 直接在您的项目中包含EasyFlash的所有必要的源代码文件。
• 针对您的具体编译环境调整构建系统，确保所有的 .c 文件被编译，且对应的 .h 头文件路径已加入到编译器的搜索路径中。
• 对于特定的硬件平台，如STM32系列，可能还需要配置相应的硬件抽象层(HAL)或标准外设库(SPL)。

通过遵循上述步骤，您可以顺利地在您的嵌入式项目中集成并利用EasyFlash的功能。记住，深入了解各功能模块的具体API和潜在的移植需求，是充分利用此库的关键。

EasyFlash Lightweight IoT device information storage solution: KV/IAP/LOG. | 轻量级物联网设备信息存储方案：参数存储、在线升级及日志存储 ，全新一代版本请移步至 https://github.com/armink/FlashDB 项目地址: https://gitcode.com/gh_mirrors/ea/EasyFlash