Chapter 2. API Reference
(continued from previous page)
+---------------------+--------------------------------------------------------
,→------------+
| --keygen | Generates key for encrypting NVS partition ␣
,→ |
+---------------------+--------------------------------------------------------
,→------------+
| --inputkey INPUTKEY | File having key for encrypting NVS partition ␣
,→ |
+---------------------+--------------------------------------------------------
,→------------+
| --outdir OUTDIR | Output directory to store files created ␣
,→ |
| | (Default: current directory) ␣
,→ |
+---------------------+--------------------------------------------------------
,→------------+
You can run the utility to generate factory images for each device using the command below. A sample CSV file is
provided with the utility:
python mfg_gen.py generate samples/sample_config.csv samples/sample_values_
,→singlepage_blob.csv Sample 0x3000
The master value CSV file should have the path in the file type relative to the directory from which you are running
the utility.
To generate encrypted factory images for each device:
You can run the utility to encrypt factory images for each device using the command below. A sample CSV file is
provided with the utility:
• Encrypt by allowing the utility to generate encryption keys:
python mfg_gen.py generate samples/sample_config.csv samples/sample_values_
,→singlepage_blob.csv Sample 0x3000 --keygen
Note: Encryption key of the following format <outdir>/keys/keys-<prefix>-<fileid>.bin is cre-
ated.
Note: This newly created file having encryption keys in keys/ directory is compatible with NVS key-partition
structure. Refer to NVS key partition for more details.
• Encrypt by providing the encryption keys as input binary file:
python mfg_gen.py generate samples/sample_config.csv samples/sample_values_
,→singlepage_blob.csv Sample 0x3000 --inputkey keys/sample_keys.bin
To generate only encryption keys: Usage:
python mfg_gen.py generate-key [-h] [--keyfile KEYFILE] [--outdir OUTDIR]
Optional Arguments:
+--------------------+---------------------------------------------------------
,→-------------+
| Parameter | Description ␣
,→ |
+====================+======================================================================+
| -h, --help | show this help message and exit ␣
,→ |
(continues on next page)
Espressif Systems 704
Submit Document Feedback
Release v4.4