{"id":6827,"date":"2020-11-16T11:21:35","date_gmt":"2020-11-16T19:21:35","guid":{"rendered":"https:\/\/visualgdb.com\/w\/?p=6827"},"modified":"2020-11-16T11:21:35","modified_gmt":"2020-11-16T19:21:35","slug":"accessing-spiffs-partitions-from-esp32-arduino-projects","status":"publish","type":"post","link":"https:\/\/visualgdb.com\/tutorials\/arduino\/esp32\/spiffs\/","title":{"rendered":"Accessing SPIFFS Partitions from ESP32 Arduino Projects"},"content":{"rendered":"

This tutorial shows how to add an SPIFFS data partition to an ESP32 Arduino project in order to store various resources. We will show how to add 2 sample files to the partition, program it into the FLASH memory and use the SPIFFS API to read the file contents programmatically.<\/p>\n

Before you begin, install VisualGDB 5.5 or later.<\/p>\n

    \n
  1. Start Visual Studio and open VisualGDB Arduino Project Wizard:\"\"<\/a><\/li>\n
  2. Enter the name and location of the project you would like to create:\"\"<\/a><\/li>\n
  3. Although the ESP32 Arduino platform comes with its own SPIFFS sample that can be cloned via the VisualGDB Arduino wizard, we will instead show how to add SPIFFS support from scratch, so select “Create a new ‘Blinking LED’ project<\/strong>“:\"\"<\/a><\/li>\n
  4. On the next page pick your ESP32 board. It is also recommended to select the COM port where the target prints the output:\"\"<\/a><\/li>\n
  5. Finally, select debugging settings that work with your target and press “Finish”:\"\"<\/a><\/li>\n
  6. VisualGDB will create a basic LEDBlink<\/strong> sketch. Erase the contents of setup()<\/strong> and loop()<\/strong> functions and include the <SPIFFS.h><\/strong> file:\"\"<\/a><\/li>\n
  7. Locate the SPIFFS Partition<\/strong> node in Solution Explorer. Right-click on it and select “Add->New Item<\/strong>“: \"\"<\/a><\/li>\n
  8. Enter “file1.txt” as the file name: \"\"<\/a><\/li>\n
  9. VisualGDB will create a new file placing it in the “<Project Directory>\\data<\/strong>” folder. Open it via Solution Explorer and add a few lines to it:\"\"<\/a><\/li>\n
  10. Similarly, create a file2.txt<\/strong> file containing different lines: \"\"<\/a><\/li>\n
  11. Now we will show how to read the SPIFFS contents programmatically. First of all, make sure that the COM port is set correctly on the Arduino Project<\/strong> page of VisualGDB Project Properties:\"\"<\/a><\/li>\n
  12. Then enable the Arduino Serial Terminal as shown below: \"\"<\/a><\/li>\n
  13. Finally, add the following code inside the setup()<\/strong> function:\n
        Serial.begin(115200);\r\n    if (!SPIFFS.begin(false))\r\n    {\r\n        Serial.println(\"SPIFFS Mount Failed\");\r\n        return;\r\n    }\r\n\r\n    File rootDir = SPIFFS.open(\"\/\");\r\n    if (rootDir)\r\n    {\r\n        for (File file = rootDir.openNextFile(); file; file = rootDir.openNextFile())\r\n        {\r\n            Serial.printf(\"[%s (%d bytes)]\\r\\n\", file.name(), file.size());\r\n            while (file.available())\r\n            {\r\n                String str = file.readStringUntil('\\n');\r\n                Serial.printf(\"\\t%s\\r\\n\", str.c_str());\r\n            }\r\n        }\r\n    }<\/pre>\n
    The code mounts the SPIFFS partition and then iterates over all files, printing their contents line-by-line.<\/li>\n
  14. Set a breakpoint on the file.available()<\/strong> call and press F5 to start debugging. The breakpoint will trigger on the first file:\"\"<\/a><\/li>\n
  15. You can step through the sketch, or let it run till the end to observe the complete listing of all files:\"\"<\/a><\/li>\n
  16. Now we will show how to program the SPIFFS partition separately from the program itself. Change some of the lines in file2.txt<\/strong> so that we could observe the differences: \"\"<\/a><\/li>\n
  17. Right-click on the SPIFFS Partition<\/strong> in Solution Explorer and select “Program FLASH Memory<\/strong>“:\"\"<\/a><\/li>\n
  18. VisualGDB will automatically update and program the SPIFFS image, leaving the program itself unchanged:\"\"<\/a><\/li>\n
  19. Open the serial terminal without starting another debug session via a context menu command on the project node:\"\"<\/a><\/li>\n
  20. Although we have not rebuilt or reprogrammed the program itself, the output will now show the second version of the file that was successfully programmed into the FLASH memory:\"\"<\/a><\/li>\n<\/ol>\n","protected":false},"excerpt":{"rendered":"
    This tutorial shows how to add an SPIFFS data partition to an ESP32 Arduino project in order to store various<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[169],"tags":[170,138,225],"_links":{"self":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts\/6827"}],"collection":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/comments?post=6827"}],"version-history":[{"count":1,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts\/6827\/revisions"}],"predecessor-version":[{"id":6851,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts\/6827\/revisions\/6851"}],"wp:attachment":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/media?parent=6827"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/categories?post=6827"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/tags?post=6827"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}