esp-idf/components/nvs_flash/nvs_partition_parser/README.rst

NVS Partition Parser Utility
============================

:link_to_translation:`zh_CN:[中文]`

Introduction
------------

The utility :component_file:`nvs_flash/nvs_partition_parser/nvs_read.py` loads and parses an NVS storage partition for easier debugging and data extraction. The utility also features integrity check which scans the partition for potential errors.

Encrypted Partitions
--------------------

This utility does not support decryption. To decrypt the NVS partition, please use the :doc:`NVS Partition Generator Utility </api-reference/storage/nvs_partition_gen>` which does support NVS partition encryption and decryption.

Usage
-----

The utility provides six different output styles with `-d` or `--dump` option:
    - `all` (default) - Prints all entries with metadata.
    - `written` - Prints only written entries with metadata.
    - `minimal` - Prints written `namespace:key = value` pairs.
    - `namespaces` - Prints all written namespaces
    - `blobs` - Prints all blobs and strings (reconstructs them if they are chunked).
    - `storage_info` - Prints entry states count for every page.

.. note:: There is also a `none` option which will not print anything. This can be used with the integrity check option if the NVS partition contents are irrelevant.

The utility also provides an integrity check feature via the `-i` or `--integrity-check` option. This feature scans through the entire partition and prints potential errors. It can be used with the `-d none` option which will print only the potential errors.
add: data classes for parsing NVS binary data add: functions to print formatted NVS data add: color support via ANSI escape sequences add: documentation 2022-04-14 06:08:26 -04:00			`NVS Partition Parser Utility`
			`============================`

Docs: Add CN translation for nvs_partition_parser/README.rst 2022-09-19 23:19:24 -04:00			:link_to_translation:`zh_CN:[中文]`

add: data classes for parsing NVS binary data add: functions to print formatted NVS data add: color support via ANSI escape sequences add: documentation 2022-04-14 06:08:26 -04:00			`Introduction`
			`------------`

Docs: Add CN translation for nvs_partition_parser/README.rst 2022-09-19 23:19:24 -04:00			The utility :component_file:`nvs_flash/nvs_partition_parser/nvs_read.py` loads and parses an NVS storage partition for easier debugging and data extraction. The utility also features integrity check which scans the partition for potential errors.
add: data classes for parsing NVS binary data add: functions to print formatted NVS data add: color support via ANSI escape sequences add: documentation 2022-04-14 06:08:26 -04:00
Docs: Add CN translation for nvs_partition_parser/README.rst 2022-09-19 23:19:24 -04:00			`Encrypted Partitions`
add: data classes for parsing NVS binary data add: functions to print formatted NVS data add: color support via ANSI escape sequences add: documentation 2022-04-14 06:08:26 -04:00			`--------------------`

Docs: Add CN translation for nvs_partition_parser/README.rst 2022-09-19 23:19:24 -04:00			This utility does not support decryption. To decrypt the NVS partition, please use the :doc:`NVS Partition Generator Utility </api-reference/storage/nvs_partition_gen>` which does support NVS partition encryption and decryption.
add: data classes for parsing NVS binary data add: functions to print formatted NVS data add: color support via ANSI escape sequences add: documentation 2022-04-14 06:08:26 -04:00
			`Usage`
			`-----`

Docs: Add CN translation for nvs_partition_parser/README.rst 2022-09-19 23:19:24 -04:00			The utility provides six different output styles with `-d` or `--dump` option:
			- `all` (default) - Prints all entries with metadata.
			- `written` - Prints only written entries with metadata.
			- `minimal` - Prints written `namespace:key = value` pairs.
add: data classes for parsing NVS binary data add: functions to print formatted NVS data add: color support via ANSI escape sequences add: documentation 2022-04-14 06:08:26 -04:00			- `namespaces` - Prints all written namespaces
Docs: Add CN translation for nvs_partition_parser/README.rst 2022-09-19 23:19:24 -04:00			- `blobs` - Prints all blobs and strings (reconstructs them if they are chunked).
			- `storage_info` - Prints entry states count for every page.
add: data classes for parsing NVS binary data add: functions to print formatted NVS data add: color support via ANSI escape sequences add: documentation 2022-04-14 06:08:26 -04:00
Docs: Add CN translation for nvs_partition_parser/README.rst 2022-09-19 23:19:24 -04:00			.. note:: There is also a `none` option which will not print anything. This can be used with the integrity check option if the NVS partition contents are irrelevant.
add: data classes for parsing NVS binary data add: functions to print formatted NVS data add: color support via ANSI escape sequences add: documentation 2022-04-14 06:08:26 -04:00
Docs: Add CN translation for nvs_partition_parser/README.rst 2022-09-19 23:19:24 -04:00			The utility also provides an integrity check feature via the `-i` or `--integrity-check` option. This feature scans through the entire partition and prints potential errors. It can be used with the `-d none` option which will print only the potential errors.