NVS Partition Editor

[中文]

The ESP-IDF: Open NVS Partition Editor command allows you to create a NVS partition binary file based on key-value pairs in a CSV file.

The resulting binary file is compatible with the NVS architecture defined in ESP-IDF Non-Volatile Storage Library.

The expected CSV format is as follows:

key,type,encoding,value     <-- column header (must be the first line)
namespace_name,namespace,,  <-- First entry must be of type "namespace"
key1,data,u8,1
key2,file,string,/path/to/file

  1. Go to View > Command Palette.

  2. Type ESP-IDF: Open NVS Partition Editor and select the command to create a new file or right-click an existing partition table CSV file.

  3. If creating a new file, choose the file name. It will be created in the current editor directory.

    Note

    Ensure the first two lines of the existing CSV file match the expected CSV format above.

  4. Make desired changes to CSV file.

    Note

    Ensure the partition size is sufficient for the inserted data.

    ../_images/nvs_partition_editor.png

  5. Save the CSV data. The first save will create the CSV file.

  6. (OPTIONAL) Enable encryption of the binary. If encryption is enabled, you can disable the generate key option to use your own key. In this case, set the key’s absolute path.

  7. Generate the partition binary.

This feature is based on ESP-IDF NVS Partition Generator Utility.

Make sure the extension is configured as shown in Install ESP-IDF and Tools documentation for this feature to work properly.