【ESP32】打造全网最强esp-idf基础教程——14.VFS与SPIFFS文件系统

VFS与SPIFFS文件系统

       这几天忙着搬砖,差点没时间更新博客了,所谓一日未脱贫,打工不能停,搬砖不狠,明天地位不稳呀。 不多说了,且看以下内容吧~

一、VFS虚拟文件系统
       先来看下文件系统的定义,文件系统是操作系统中用于组织、管理和存储持久性数据的一个关键组件。它是方法和数据结构的集合,使操作系统能够有效地在存储设备(如硬盘驱动器、固态硬盘、USB闪存驱动器等)上存储、检索和管理文件。
文件系统通常由三个主要部分组成:
       1)文件系统的接口:用户和应用程序与文件系统交互的方式。
       2)对对象操纵和管理的软件集合:实现文件创建、删除、读取、写入、重命名等操作的系统软件。
       3)对象及属性:实际存储的数据文件以及与之相关的元数据信息。

       当我们使用标准文件操作时,比如我们使用fwrite(buffer,size,count,file)函数时,我们不用关心到底是写入到磁盘上哪个地址,偏移量是多少等等诸如此类的硬件底层问题,因为这些操作文件系统已经帮我们处理好了,我们只需要关注往哪个文件写入什么内容,从哪个文件读取什么内容即可,文件系统帮我们把这些文件有效的管理组织起来,形成包括文件和目录的层次结构。

       在esp-idf中虚拟文件系统 (VFS) 组件为驱动程序提供一个统一接口,可以操作类文件对象。这类驱动程序可以是 FAT、SPIFFS 等真实文件系统,也可以是提供文件类接口的设备驱动程序。

       VFS 组件支持 C 库函数(如 fopen 和 fprintf 等)与文件系统 (FS) 驱动程序协同工作。在高层级,每个 FS 驱动程序均与某些路径前缀相关联。当一个 C 库函数需要打开文件时,VFS 组件将搜索与该文件所在文件路径相关联的 FS 驱动程序,并将调用传递给该驱动程序。针对该文件的读取、写入等其他操作的调用也将传递给这个驱动程序。

       例如,使用 /fat 前缀注册 FAT 文件系统驱动,之后即可调用 fopen("/fat/file.txt", "w")。之后,VFS 将调用FAT驱动的 open 函数,并将参数 /file.txt 和合适的打开模式传递给 open 函数;后续对返回的 FILE* 数据流调用C库函数也同样会传递给 FAT 驱动。
       如需注册 FS 驱动程序,应用程序首先要定义一个 esp_vfs_t 结构体实例,并用指向 FS API 的函数指针填充它。

        esp_vfs_t myfs = {    
       .flags = ESP_VFS_FLAG_DEFAULT,    
       .write = &myfs_write,    
       .open = &myfs_open,    
       .fstat = &myfs_fstat,    
       .close = &myfs_close,    
       .read = &myfs_read,
       };
       ESP_ERROR_CHECK(esp_vfs_register("/data", &myfs, NULL));

       在上述代码中需要用到 read、 write 或 read_p、 write_p,具体使用哪组函数由 FS 驱动程序 API 的声明方式决定。
       示例 1:声明 API 函数时不带额外的上下文指针参数,即 FS 驱动程序为单例模式,此时使用 write

       ssize_t myfs_write(int fd, const void * data, size_t size);
       // In definition of esp_vfs_t:    
       .flags = ESP_VFS_FLAG_DEFAULT,   
       .write = &myfs_write,// ... other members initialized
       // When registering FS, context pointer (third argument) is NULL:
       ESP_ERROR_CHECK(esp_vfs_register("/data", &myfs, NULL));

        示例 2:声明 API 函数时需要一个额外的上下文指针作为参数,即可支持多个 FS 驱动程序实例,此时使用 write_p

       ssize_t myfs_write(myfs_t* fs, int fd, const void * data, size_t size);
       // In definition of esp_vfs_t:    
       .flags = ESP_VFS_FLAG_CONTEXT_PTR,    
      .write_p = &myfs_write,// ... other members initialized
       // When registering FS, pass the FS context pointer into the third argument
       // (hypothetical myfs_mount function is used for illustrative purposes)
       myfs_t* myfs_inst1 = myfs_mount(partition1->offset, partition1->size);
       ESP_ERROR_CHECK(esp_vfs_register("/data1", &myfs, myfs_inst1));
       // Can register another instance:
       myfs_t* myfs_inst2 = myfs_mount(partition2->offset, partition2->size);
       ESP_ERROR_CHECK(esp_vfs_register("/data2", &myfs, myfs_inst2));

        已注册的 FS 驱动程序均有一个路径前缀与之关联,此路径前缀即为分区的挂载点。
如果挂载点中嵌套了其他挂载点,则在打开文件时使用具有最长匹配路径前缀的挂载点。

        例如,假设以下文件系统已在 VFS 中注册:ssize_t myfs_write(myfs_t* fs, int fd, const void * data, size_t size); 

       // In definition of esp_vfs_t:    
      .flags = ESP_VFS_FLAG_CONTEXT_PTR,    
      .write_p = &myfs_write,// ... other members initialized
      // When registering FS, pass the FS context pointer into the third argument
      // (hypothetical myfs_mount function is used for illustrative purposes)
      myfs_t* myfs_inst1 = myfs_mount(partition1->offset, partition1->size);
      ESP_ERROR_CHECK(esp_vfs_register("/data1", &myfs, myfs_inst1));
      // Can register another instance:
      myfs_t* myfs_inst2 = myfs_mount(partition2->offset, partition2->size);
      ESP_ERROR_CHECK(esp_vfs_register("/data2", &myfs, myfs_inst2));

      在 /data 下注册 FS 驱动程序1
      在 /data/static 下注册 FS 驱动程序2
      那么:
      打开 /data/log.txt 会调用驱动程序FS1;
      打开 /data/static/index.html 需调用驱动程序FS2;

      即便 FS驱动程序2中没有/index.html,也不会在FS驱动程序1中查找 /static/index.html。
      挂载点名称必须以路径分隔符 (/) 开头,且分隔符后至少包含一个字符。但在以下情况中,VFS 同样支持空的挂载点名称:1. 应用程序需要提供一个”最后方案“下使用的文件系统;2. 应用程序需要同时覆盖 VFS 功能。如果没有与路径匹配的前缀,就会使用到这种文件系统。 

      VFS 不会对路径中的点 (.) 进行特殊处理,也不会将 .. 视为对父目录的引用。在上述示例中,使用 /data/static/../log.txt 路径不会调用 FS 驱动程序 1 打开 /log.txt。特定的 FS 驱动程序(如 FATFS)可能以不同的方式处理文件名中的点。
      执行打开文件操作时,FS 驱动程序仅得到文件的相对路径(挂载点前缀已经被去除): 

      以 /data 为路径前缀注册 myfs 驱动;
      应用程序调用 fopen("/data/config.json", ...);
      VFS 调用 myfs_open("/config.json", ...);
      myfs 驱动打开 /config.json 文件。
      VFS 对文件路径长度没有限制,但文件系统路径前缀受 ESP_VFS_PATH_MAX 限制,即路径前缀上限为 ESP_VFS_PATH_MAX。各个文件系统驱动则可能会对自己的文件名长度设置一些限制。
      以上内容是我从官方资料中筛选出来的,大家可能看完了也不是很懂,但没关系,看不懂有两种方法,一是再几遍,二就是直接简单点,用代码演示一下。在代码演示之前,还需要讲解一个文件系统,那就是esp-idf里面的spiffs文件系统。 

       二、SPIFFS文件系统
       SPIFFS 是一个用于 SPI NOR flash 设备的嵌入式文件系统,支持磨损均衡、文件系统一致性检查等功能。在介绍ESP32分区表的时候,我们知道了分区类型Type有两种,一种是app,另一种是data,如果我们想要用到spiffs进行存储时,我们需要新建一个分区,然后指定Type=data,子类型Subtype=spiffs,表示此分区用于spiffs文件系统存储。

       目前spiffs文件系统使用有如下限制: 

  • 目前,SPIFFS 尚不支持目录,但可以生成扁平结构。如果 SPIFFS 挂载在 /spiffs 下,在 /spiffs/tmp/myfile.txt 路径下创建一个文件则会在 SPIFFS 中生成一个名为 /tmp/myfile.txt 的文件,而不是在 /spiffs/tmp 下生成名为 myfile.txt 的文件;
  • SPIFFS 并非实时栈,每次写操作耗时不等;
  • 目前,SPIFFS 尚不支持检测或处理已损坏的块。
  • SPIFFS 只能稳定地使用约 75% 的指定分区容量。
  • 当文件系统空间不足时,垃圾收集器会尝试多次扫描文件系统来寻找可用空间。根据所需空间的不同,写操作会被调用多次,每次函数调用将花费几秒。同一操作可能会花费不同时长的问题缘于 SPIFFS 的设计,且已在官方的 SPIFFS github 仓库 或是 https://github.com/espressif/esp-idf/issues/1737 中被多次报告。这个问题可以通过 SPIFFS 配置 部分缓解。
  • 当垃圾收集器尝试多次(默认为 10 次)扫描整个文件系统以回收空间时,在每次扫描期间,如果有可用的数据块,则垃圾收集器会释放一个数据块。因此,如果为垃圾收集器设置的最大运行次数为 n(可通过 SPIFFS_GC_MAX_RUNS 选项配置,该选项位于 SPIFFS 配置 中),那么 n 倍数据块大小的空间将可用于写入数据。如果尝试写入超过 n 倍数据块大小的数据,写入操作可能会失败并返回错误。
  • 如果 ESP32 在文件系统操作期间断电,可能会导致 SPIFFS 损坏。但是仍可通过 esp_spiffs_check 函数恢复文件系统。详情请参阅官方 SPIFFS FAQ。

三、程序例程
       由第一节可知,VFS是虚拟文件系统,它是一个抽象层概念,在注册时需要把它的操作具体关联到某种实际的存储介质,另外,如果我们要想使用SPIFFS文件系统进行存储,也需要配合VFS一起使用。在本例程中VFS与SPIFFS文件系统结合使用,在esp-idf中已经将VFS与SPIFFS的关联操作封装好,我们使用提供的接口就可以轻松的把SPIFF文件系统挂载,请看如下代码。具体代码在esp32-board/spiffs中

#include <stdio.h>
#include <string.h>
#include <sys/unistd.h>
#include <sys/stat.h>
#include "esp_err.h"
#include "esp_log.h"
#include "esp_spiffs.h"static const char *TAG = "spiffs";
void app_main(void)
{ESP_LOGI(TAG, "Initializing SPIFFS");esp_vfs_spiffs_conf_t conf = {.base_path = "/spiffs",   //可以认为挂着点,后续使用C库函数fopen("/spiffs/...").partition_label = NULL,  //指定spiffs分区,如果为NULL,则默认为分区表中第一个spiffs类型的分区.max_files = 5,           //最大可同时打开的文件数.format_if_mount_failed = true};//初始化和挂载spiffs分区esp_err_t ret = esp_vfs_spiffs_register(&conf);//失败处理if (ret != ESP_OK) {if (ret == ESP_FAIL) {ESP_LOGE(TAG, "Failed to mount or format filesystem");} else if (ret == ESP_ERR_NOT_FOUND) {ESP_LOGE(TAG, "Failed to find SPIFFS partition");} else {ESP_LOGE(TAG, "Failed to initialize SPIFFS (%s)", esp_err_to_name(ret));}return;}//执行SPIFFS文件系统检查ESP_LOGI(TAG, "Performing SPIFFS_check().");ret = esp_spiffs_check(conf.partition_label);//操作spiffs文件系统器件断电,可能会导致 SPIFFS 损坏,可通过esp_spiffs_check恢复if (ret != ESP_OK) {ESP_LOGE(TAG, "SPIFFS_check() failed (%s)", esp_err_to_name(ret));return;} else {ESP_LOGI(TAG, "SPIFFS_check() successful");}//获取SPIFFS可用区域大小size_t total = 0, used = 0;ret = esp_spiffs_info(conf.partition_label, &total, &used);if (ret != ESP_OK) {ESP_LOGE(TAG, "Failed to get SPIFFS partition information (%s). Formatting...", esp_err_to_name(ret));esp_spiffs_format(conf.partition_label);return;} else {ESP_LOGI(TAG, "Partition size: total: %d, used: %d", total, used);}//可用空间异常,执行SPIFFS检查if (used > total) {ESP_LOGW(TAG, "Number of used bytes cannot be larger than total. Performing SPIFFS_check().");ret = esp_spiffs_check(conf.partition_label);if (ret != ESP_OK) {ESP_LOGE(TAG, "SPIFFS_check() failed (%s)", esp_err_to_name(ret));return;} else {ESP_LOGI(TAG, "SPIFFS_check() successful");}}//结合VFS,可以使用标准C库函数进行文件读写ESP_LOGI(TAG, "Opening file");FILE* f = fopen("/spiffs/hello.txt", "w");if (f == NULL) {ESP_LOGE(TAG, "Failed to open file for writing");return;}fprintf(f, "Hello World!\n");fclose(f);ESP_LOGI(TAG, "File written");//检查/spiffs/foo.txt这个文件是否存在,如果存在删除它struct stat st;if (stat("/spiffs/foo.txt", &st) == 0) {// 删除/spiffs/foo.txt文件unlink("/spiffs/foo.txt");}//重命名文件ESP_LOGI(TAG, "Renaming file");if (rename("/spiffs/hello.txt", "/spiffs/foo.txt") != 0) {ESP_LOGE(TAG, "Rename failed");return;}//打开foo文件读取一行ESP_LOGI(TAG, "Reading file");f = fopen("/spiffs/foo.txt", "r");if (f == NULL) {ESP_LOGE(TAG, "Failed to open file for reading");return;}char line[64];fgets(line, sizeof(line), f);fclose(f);// strip newlinechar* pos = strchr(line, '\n');if (pos) {*pos = '\0';}ESP_LOGI(TAG, "Read from file: '%s'", line);//测试完成,卸载esp_vfs_spiffs_unregister(conf.partition_label);ESP_LOGI(TAG, "SPIFFS unmounted");
}

       首先我们需要包含esp_spiffs.h头文件,这个头文件声明了与spiffs和VFS关联的操作
       
esp_vfs_spiffs_conf_t结构体定义了一些内容配置,其中比较关键的是.base_path = "/spiffs",   //这个可以认为是挂着点,也就是后续可以使用C库函数fopen("/spiffs/...")打开文件的前缀。其余的参数大家看注释便知道是什么意思。 

       然后调用esp_vfs_spiffs_register函数把配置设置进去,这个函数会初始化SPIFFS文件系统,然后把底层对SPIFFS文件系统的读写操作注册到VFS,以及将SPIFFS文件系统挂载到指定的挂载点”/spiffs”。

       esp_spiffs_check函数会对SPIFFS分区进行检查,修复损坏的文件,清理未引用的页面等,官方推荐如果SPIFFS_info返回used大于total,或者获取到任何以下错误代码时:SPIFFS_ERR_NOT_FINALIZED、SPIFFS_ERR_NOT_INDEX、SPIFFS_ERR_IS_INDEX、SPIFFS_ERR_IS_FREE、SPIFFS_ERR_INDEX_SPAN_MISMATCH、SPIFFS_ERR_DATA_SPAN_MISMATCH、SPIFFS_ERR_INDEX_REF_FREE、SPIFFS_ERR_INDEX_REF_LU、SPIFFS_ERR_INDEX_REF_INVALID、SPIFFS_ERR_INDEX_FREE、SPIFFS_ERR_INDEX_LU、SPIFFS_ERR_INDEX_INVALID,都应运行检查。

       当挂载成功后,我们就可以使用fopen、fwrite、rename等这些C语言标准文件操作来对spiffs进行操作了,这部分不再叙述。
       在对操作完成后,使用
esp_vfs_spiffs_unregister卸载掉spiffs文件系统,这个函数的参数如果是NULL,则会对分区表中第一个spiffs分区进行操作,会检测这个分区是否已经挂载,如果挂载了就会卸载掉这个分区,如果没有则返回错误。

最后附上相关资料:

ESP32教程资料链接:
https://pan.baidu.com/s/1kCjD8yktZECSGmHomx_veg?pwd=q8er 
提取码:q8er 

配套源码下载地址:
esp32-board: esp32开发板配套的经典例程

鉴于实验需要开发板的支持,我也设计了一款ESP32开发板,包含部分传感器模块,1.69寸LCD高亮屏,Type-C一键下载,方便大家学习和做各种实验。开发板链接如下:

https://item.taobao.com/item.htm?ft=t&id=802401650392&spm=a21dvs.23580594.0.0.4fee645eXpkfcp&skuId=5635015963649
 

请大家多多支持。

       

 

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/863777.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

Python基础之模块和包

文章目录 1 模块和包1.1 模块和包1.1.1 模块1.1.2 包1.1.3 简单使用 1.2 import 语句1.2.1 import1.2.2 from … import 语句1.2.3 from … import * 语句 1.4 深入模块1.4.1 模块符号表1.4.2 __name__属性1.4.3 dir() 函数1.4.4 作用域 1.5 常用内置模块 1 模块和包 1.1 模块…

vue中【事件修饰符号】详解

在Vue中&#xff0c;事件修饰符是一种特殊的后缀&#xff0c;用于修改事件触发时的默认行为。以下是Vue中常见的事件修饰符的详细解释&#xff1a; .stop 调用event.stopPropagation()&#xff0c;阻止事件冒泡。当你在嵌套元素中都有相同的事件监听器&#xff08;如click事件…

FuzzyPID

#include <stdio.h> typedef struct FuzzyPID { int num_area ; //划分区域个数 //float e_max; //误差做大值 //float e_min; //误差最小值 //float ec_max; //误差变化最大值 //float ec_min; //误差变化最小值 //float kp_max, kp_min; float e_membership_valu…

AI模型的奥运会:谁将在OlympicArena中夺冠?

获取本文论文原文PDF&#xff0c;请在公众号【AI论文解读】留言&#xff1a;论文解读 引言&#xff1a;AI模型的奥林匹克级评测 评估和比较不同AI模型的性能始终是一个核心话题。随着技术的不断进步&#xff0c;这些模型在处理复杂任务的能力上有了显著的提升。为了更精确地衡…

Vue3学习笔记<->创建第一个vue项目(2)

新建一个项目目录 找一个盘新建一个目录&#xff0c;我这里在D盘创建一个vuedemo目录作为项目存放的目录。使用idea打开目录。   单击ieda底部的按钮“Terminal”&#xff0c;打开命令行窗口&#xff0c;如果命令行窗口当前目录不是“vuedemo”&#xff0c;就切换到“vuedem…

基于FastApi框架的后端服务实践案例

去年在做大模型部署和服务开发研究过程中,接触到如何将大模型的对话封装成服务,供任何消费端调用,详见之前的大模型应用文章,之后,为了实现NLP分词和实体识别,也基于tornado框架编写了后端服务,详见那篇文章,最近在利用python在做后端数据处理过程中,发现从响应性能、…

python基础:操作字典

1、遍历整个字典的键-值对 items()方法返回一个键-值对列表&#xff0c;for 循环依次将每个键—值对存储到指定的两个变量中。 使用元组和列表遍历方法遍历字典&#xff1a; user_0 { username: efermi, first: enrico, last: fermi, } for key, value in user_0.items():p…

qt文件如何打包成一个独立的exe文件

QT官方给我们安装好了打包软件&#xff0c;就在你QT安装的位置 把这个在cmd打开C:\Qt\6.7.1\mingw_64\bin\windeployqt6.exe&#xff08;或复制地址&#xff09; 然后把要打包项目的exe复制到新的空文件夹&#xff0c;再复制他的地址 按回车后生成新文件 再下载打包软件&#…

spring04事务

jdbcTemplate使用 <dependencies><dependency><groupId>org.springframework</groupId><artifactId>spring-jdbc</artifactId><version>6.0.4</version></dependency><dependency><groupId>mysql</group…

东方航空逆向

声明(lianxi a15018601872) 本文章中所有内容仅供学习交流使用&#xff0c;不用于其他任何目的&#xff0c;抓包内容、敏感网址、数据接口等均已做脱敏处理&#xff0c;严禁用于商业用途和非法用途&#xff0c;否则由此产生的一切后果均与作者无关&#xff01; …

【AIGC】AnimateAnyone:AI赋予静态照片生命力的魔法

摘要&#xff1a; 在人工智能技术的不断进步中&#xff0c;AnimateAnyone项目以其创新性和易用性脱颖而出&#xff0c;成为GitHub上备受瞩目的AI项目之一。由阿里巴巴智能计算研究院开发的这一技术&#xff0c;允许用户通过提供一张静态照片&#xff0c;快速生成动态角色。本文…

Shiro 简单入门

Apache Shiro 是一个强大且灵活的 Java 安全框架&#xff0c;用于处理身份验证、授权、加密和会话管理等任务。Shiro 的设计目标是提供一种简单而直观的方式来处理安全问题&#xff0c;使开发人员能够轻松集成和管理应用程序的安全性。以下是对 Shiro 的详细讲解&#xff1a; …

Linux实用命令练习

目录 一、常用命令 二、系统命令 三、用户和组 四、权限 五、文件相关命令 六、查找 七、正则表达式 八、输入输出重定向 九、进程控制 十、其他命令 1、远程文件复制&#xff1a;scp 2、locate查找 3、which命令 4、设置或显示环境变量&#xff1a;export 5、修…

学习Symfony框架

学习Symfony框架&#xff0c;一个流行的PHP Web应用框架&#xff0c;你可以遵循以下几个步骤来逐步掌握它&#xff1a; ### 1. 了解Symfony框架 - **研究架构和理念**&#xff1a;了解Symfony的设计原则&#xff0c;如可重用组件、模块化、面向对象编程、以及MVC&#xff08;模…

YOLO-V1

一、YOLO-V1整体思想与网络架构 1.1 YOLO算法整体思路解读 YOLO-V1: 经典的one-stage方法 把检测问题转化成回归问题&#xff0c;一个CNN就搞定了&#xff01; 可以对视频进行实时检测&#xff0c;应用领域非常广&#xff01; 核心思想&#xff1a; 1、预测一张图像中有哪些物…

kafka 集群 Topic 之 Partion 数据写入分布原理设计(六)

kafka 集群 Topic 之 Partion 数据写入分布原理设计(六) 集群中假如有三个节点,分别ip为200,201,202 创建topic 为test,默认分区2,副本2,在写入消息 到topic时,数据就转的过程是什么,则 partition存储数据分布是如何分布的,各个节点数据如何同步 的,isr如何实现的?…

11_电子设计教程基础篇(磁性元件)

文章目录 前言一、电感1、原理2、种类1、制作工艺2、用途 3、参数1、测试条件2、电感量L3、品质因素Q4、直流电阻&#xff08;DCR&#xff09;5、额定电流6、谐振频率SRF&#xff08;Self Resonant Frequency&#xff09;7、磁芯损耗 4、应用与选型 二、共模电感1、原理2、参数…

《昇思25天学习打卡营第15天 | 昇思MindSpore基于MindSpore的红酒分类实验》

15天 本节学了通过MindSpore的完成红酒分类。 1.K近邻算法&#xff08;K-Nearest-Neighbor, KNN&#xff09;是一种用于分类和回归的非参数统计方法&#xff0c;是机器学习最基础的算法之一。 1.1分类问题 1.2回归问题 1.3距离的定义 2.数据处理 2.1 数据准备 2.2 数据读取与处…

动画重定向——当给一个人物模型用别人物的动画时,会遇到人物与动画不匹配问题,怎么解决呢?

每日一句&#xff1a;实践出真知&#xff0c;试错方确信 目录 最开始我想的原因&#xff01; 分析一下动画相关参数 Animator组件参数详解&#xff1a; 人物模型的导入设置参数&#xff1a; Skinned Mesh Renderer组件详解: Skinned Mesh Renderer工作原理 设置Skinned …