kopia lustrzana https://github.com/espressif/esp-idf
docs: update cn trans nvs_partition_tool/readme
rodzic
87bdcc89d0
commit
0fc2fbe83f
|
@ -6,9 +6,7 @@ NVS Partition Parser Utility
|
|||
Introduction
|
||||
------------
|
||||
|
||||
The utility :component_file:`nvs_flash/nvs_partition_parser/nvs_tool.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.
|
||||
Data blobs are encoded in `base64` format.
|
||||
The utility :component_file:`nvs_flash/nvs_partition_parser/nvs_tool.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. Data blobs are encoded in `base64` format.
|
||||
|
||||
Encrypted Partitions
|
||||
--------------------
|
||||
|
@ -18,11 +16,11 @@ This utility does not support decryption. To decrypt the NVS partition, please u
|
|||
Usage
|
||||
-----
|
||||
|
||||
There are 2 output format styles available with `-f` or `--format` option:
|
||||
There are two output format styles available with the `-f` or `--format` option:
|
||||
- `json` - All of the output is printed as a JSON.
|
||||
- `text` - The output is printed as a human-readable text with different selectable output styles mentioned below.
|
||||
|
||||
For the `text` output format the utility provides six different output styles with `-d` or `--dump` option:
|
||||
For the `text` output format, the utility provides six different output styles with the `-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.
|
||||
|
|
|
@ -6,7 +6,7 @@ NVS 分区解析程序
|
|||
介绍
|
||||
-------
|
||||
|
||||
NVS 分区解析程序 :component_file:`nvs_flash/nvs_partition_parser/nvs_read.py` 加载并解析 NVS 存储分区,以便于调试和数据提取。该程序还支持完整性检查功能,可扫描分区中可能存在的错误。
|
||||
NVS 分区解析程序 :component_file:`nvs_flash/nvs_partition_parser/nvs_read.py` 加载并解析 NVS 存储分区,以便于调试和数据提取。该程序还支持完整性检查功能,可扫描分区中可能存在的错误。Blob 数据以 `base64` 格式进行编码。
|
||||
|
||||
加密分区
|
||||
-----------
|
||||
|
@ -16,7 +16,11 @@ NVS 分区解析程序 :component_file:`nvs_flash/nvs_partition_parser/nvs_read.
|
|||
使用方法
|
||||
-----------
|
||||
|
||||
该程序通过 `-d` 或 `-dump` 选项提供了六种不同的输出方式:
|
||||
该程序提供了 `-f` 或 `-format` 选项,对应两种不同的输出格式:
|
||||
- `json` - 所有输出均以 JSON 格式打印。
|
||||
- `text` - 输出以可读文本的格式打印,有以下输出格式可选。
|
||||
|
||||
针对 `text` 输出格式,该程序提供了 `-d` 或 `-dump` 选项,包含六种不同的输出方式:
|
||||
- `all` (默认) - 打印所有带有元数据的条目。
|
||||
- `written` - 只打印带有元数据的写入条目。
|
||||
- `minimal` - 打印写入的 `namespace:key = value` 对。
|
||||
|
@ -24,6 +28,6 @@ NVS 分区解析程序 :component_file:`nvs_flash/nvs_partition_parser/nvs_read.
|
|||
- `blobs` - 打印所有 blob 和字符串(若 blob 和字符串是以分块的形式,则对其进行重组)。
|
||||
- `storage_info` - 打印每一页面的条目状态计数。
|
||||
|
||||
.. 注意:: 该程序还提供 `none` 选项,该选项不会打印任何东西。如果 NVS 分区的内容并不相关,可以将该选项和完整性检查选项一起使用。
|
||||
.. 注意:: 该程序还提供 `none` 选项,该选项不会打印任何内容。如果 NVS 分区的内容并不相关,可以将该选项和完整性检查选项一起使用。
|
||||
|
||||
该程序支持完整性检查功能,选择选项 `-i` 或 `--integrity-check` 即可运行。此功能可扫描整个分区,并打印出可能存在的错误。当此功能和 `-d none` 一起使用时,可只打印可能存在的错误。
|
||||
该程序支持完整性检查功能,选择选项 `-i` 或 `--integrity-check` 即可运行(该选项会导致 `json` 输出格式无效,因此只适用于 `text` 格式)。此功能可扫描整个分区,并打印出可能存在的错误。当此功能和 `-d none` 一起使用时,可只打印可能存在的错误。
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
#!/usr/bin/env python3
|
||||
# SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
|
||||
# SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
import binascii
|
||||
import json
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
#!/usr/bin/env python3
|
||||
# SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
|
||||
# SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
import argparse
|
||||
import os
|
||||
|
|
Ładowanie…
Reference in New Issue