|
1 | 1 | NVS Table Editor |
2 | 2 | ================ |
3 | 3 |
|
4 | | -The NVS Table Editor helps create a binary file based on key-value pairs provided in a CSV file. The resulting binary file is compatible with the NVS architecture as defined in `ESP-IDF Non Volatile Storage <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/storage/nvs_flash.html>`_. The expected CSV format is: |
| 4 | +:link_to_translation:`zh_CN:[中文]` |
| 5 | + |
| 6 | +The NVS Table Editor helps create a binary file based on key-value pairs provided in a CSV file. The resulting binary file is compatible with the NVS architecture as defined in ESP-IDF `Non-Volatile Storage <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/storage/nvs_flash.html>`_. The expected CSV format is: |
5 | 7 |
|
6 | 8 | .. code-block:: text |
7 | 9 |
|
8 | | - key,type,encoding,value <-- column header (must be the first line) |
9 | | - namespace_name,namespace,, <-- First entry must be of type "namespace" |
10 | | - key1,data,u8,1 |
11 | | - key2,file,string,/path/to/file |
| 10 | + key,type,encoding,value <-- column header (must be the first line) |
| 11 | + namespace_name,namespace,, <-- First entry must be of type "namespace" |
| 12 | + key1,data,u8,1 |
| 13 | + key2,file,string,/path/to/file |
| 14 | +
|
| 15 | +.. note:: |
12 | 16 |
|
13 | | -.. note:: This is based on ESP-IDF `NVS Partition Generator Utility <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/storage/nvs_partition_gen.html>`_. |
| 17 | + This is based on ESP-IDF `NVS Partition Generator Utility <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/storage/nvs_partition_gen.html>`_. |
14 | 18 |
|
15 | 19 | Steps |
16 | 20 | ----- |
17 | 21 |
|
18 | | -1. Right-click on a project in the *Project Explorer*. |
19 | | -2. Click on the *ESP-IDF > NVS Table Editor* menu option: |
| 22 | +1. Right-click on a project in the Project Explorer. |
| 23 | +2. Click on the ``ESP-IDF: NVS Table Editor`` menu option. |
| 24 | + |
| 25 | + .. image:: https://user-images.githubusercontent.com/24419842/216114697-9f231211-f5dd-431b-9432-93ecc656cfec.png |
| 26 | + :alt: NVS Table Editor menu option |
20 | 27 |
|
21 | | - .. image:: https://user-images.githubusercontent.com/24419842/216114697-9f231211-f5dd-431b-9432-93ecc656cfec.png |
22 | | - :alt: NVS Table Editor menu option |
| 28 | +3. Make desired changes to the CSV data. |
| 29 | +4. Save changes by clicking the ``Save`` button. If everything is correct, you will see an information message at the top of the dialog: |
23 | 30 |
|
24 | | -3. Make desired changes to the CSV data. |
25 | | -4. Save changes by clicking the *Save* button. If everything is correct, you will see an information message at the top of the dialog: |
| 31 | + .. image:: https://user-images.githubusercontent.com/24419842/216115906-9bb4fe55-293b-4c6b-8d22-0aa3520581ab.png |
| 32 | + :alt: Save confirmation in NVS Table Editor |
26 | 33 |
|
27 | | - .. image:: https://user-images.githubusercontent.com/24419842/216115906-9bb4fe55-293b-4c6b-8d22-0aa3520581ab.png |
28 | | - :alt: Save confirmation in NVS Table Editor |
| 34 | +5. Generate the partition binary. Choose ``Encrypt`` to encrypt the binary, and disable the ``Generate Key`` option if you want to use your own key. An information message will appear at the top of the dialog showing the result of the generated binaries. Hover over the message to view the full content if it is truncated: |
29 | 35 |
|
30 | | -5. Generate the partition binary (choose *Encrypt* to encrypt the binary, and disable the *Generate Key* option to use your own key if desired). You will see an information message at the top of the dialog about the result of the generated binaries. Hover over the message if it's too long to read fully: |
| 36 | + .. image:: https://user-images.githubusercontent.com/24419842/216117261-9bee798a-3a9e-4be5-9466-fc9d3847834b.png |
| 37 | + :alt: Binary generation result in NVS Table Editor |
31 | 38 |
|
32 | | - .. image:: https://user-images.githubusercontent.com/24419842/216117261-9bee798a-3a9e-4be5-9466-fc9d3847834b.png |
33 | | - :alt: Binary generation result in NVS Table Editor |
| 39 | + .. note:: |
34 | 40 |
|
35 | | - .. note:: If there are any errors, they will be highlighted. Hover over the error icon to read more about the error. You will also see an error message at the top of |
| 41 | + If there are any errors, they will be highlighted. Hover over the error icon to read more about the error. An error message will also appear at the top of the dialog. |
0 commit comments