ESP32-Show_nvs_keys

initial release 04DEC2017 by Ed Smallenburg @Edzelf
modified 24FEB2018 for additional Error reporting, Data Display by @stickbreaker

Show all keys in ESP32 non volatile storage (NVS).

The NVS library is missing a function to list all keys (or a subset) present in the nvs. For some programs however, it is vital to know which keys are present. This demo shows all the keys in the NVS.

Simple sketch to reinit nvs provided byte @lbernstone

#include <nvs.h>
#include <nvs_flash.h>
void setup() {
    int err;
    err=nvs_flash_init();
    Serial.printf("nvs_flash_init: %d\n" ,err);
    err=nvs_flash_erase();
    Serial.printf("nvs_flash_erase: %d\n" ,err);
 }

Command available from Serial monitor:

Command:	Action
?	Display this help screen
show	Show NVS structure, and all Keys
init	Initialize NVS flash structure
erase	Erase existing Flash Structure

example of Normal Output


  SHOW NVS keys

Command:	Action

?		Display this help screen
show		Show NVS structure, and all Keys
init		Initialize NVS flash structure
erase		Erase existing Flash Structure

Partition nvs found, 5 pages (20480 bytes)

page[0].State=0xfffffffc INIT FULL  means FULL  Seqnr=0 
 Entry bitmap
   : Owning NameSpace index (hex)                     Status ('.' empty, '*' inuse, 'D' deleted)
  0: 00 01 01 00                   02             02 ****DDDDDD*DDDD*
 16: 02    02    02 02 02 02                         *D*D****DDDDDDDD
 32:                                                 DDDDDDDDDDDDDDDD
 48:                02 02 02       02 02 02 02 02 02 DDDDD***DD******
 64: 02 02 02 02 02 02 02 02                   00 03 ********DDDDDD**
 80: 03 03 FF FF FF FF FF FF FF FF FF FF FF FF FF FF **..............
 96: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF ................
112: FF FF FF FF FF FF FF FF FF FF FF FF FF FF       ..............

page[1].State=0xfffffffc INIT FULL  means FULL  Seqnr=1 
 Entry bitmap
   : Owning NameSpace index (hex)                     Status ('.' empty, '*' inuse, 'D' deleted)
  0: 03 03 03 03 03 03 03 03 03 03 03 03 03 03 03 03 ****************
 16: 03 03 03 03 03 03 03 03 03 03 03 03 03 03 03 03 ****************
 32: 03 03 03 03 03 03 03 03 03 03 03 03 03 03 03 03 ****************
 48: 03 03 03 03 03 03 03 03 03 03 03 03 03 02 02 02 ****************
 64: 02 02 02 02 02 02 02 02    02 02                ********D**DDDDD
 80:                                                 DDDDDDDDDDDDDDDD
 96:       02 02 02 02 02    02 02 FF FF FF FF FF FF DD*****D**......
112: FF FF FF FF FF FF FF FF FF FF FF FF FF FF       ..............

page[2].State=0xfffffffe INIT  means ACTIVE  Seqnr=2 
 Entry bitmap
   : Owning NameSpace index (hex)                     Status ('.' empty, '*' inuse, 'D' deleted)
  0: 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 ****************
 16: 02 02 02 02 02 02 02 FF FF FF FF FF FF FF FF FF *******.........
 32: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF ................
 48: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF ................
 64: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF ................
 80: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF ................
 96: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF ................
112: FF FF FF FF FF FF FF FF FF FF FF FF FF FF       ..............

page[3].State=0xffffffff  means UNINITIALIZED  Page[3] not active, State = 0xffffffff Seqnr=4294967295 
 Entry bitmap
   : Owning NameSpace index (hex)                     Status ('.' empty, '*' inuse, 'D' deleted)
  0: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF ................
 16: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF ................
 32: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF ................
 48: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF ................
 64: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF ................
 80: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF ................
 96: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF ................
112: FF FF FF FF FF FF FF FF FF FF FF FF FF FF       ..............

page[4].State=0xffffffff  means UNINITIALIZED  Page[4] not active, State = 0xffffffff Seqnr=4294967295 
 Entry bitmap
   : Owning NameSpace index (hex)                     Status ('.' empty, '*' inuse, 'D' deleted)
  0: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF ................
 16: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF ................
 32: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF ................
 48: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF ................
 64: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF ................
 80: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF ................
 96: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF ................
112: FF FF FF FF FF FF FF FF FF FF FF FF FF FF       ..............


Logical Page to Physical Sector
Page 0 -> 0
Page 1 -> 1
Page 2 -> 2
Page 3 -> 255
Page 4 -> 255

Found 3 Name Spaces:
     Name Space : index 
           misc = 1
   nvs.net80211 = 2
            phy = 3

Listing Entries of each NameSpace:
PAGE-ENTRY: KEYNAME type:DATATYPE data:VALUE(U8..U64) size=hex(BLOB,SZ)

NameSpace[  1]:            misc  
0-001:            log type:BLOB data:size=0010
02 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00  ................

NameSpace[  2]:    nvs.net80211  
0-010:   sta.authmode type:U8   data:1
0-015:        sta.pmk type:BLOB data:size=0020
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff  ................
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff  ................
0-018:      auto.conn type:U8   data:1
0-020:      sta.bssid type:BLOB data:size=0006
ff ff ff ff ff ff                                ......          
0-022:       sta.phym type:U8   data:3
0-023:      sta.phybw type:U8   data:2
0-053:        ap.ssid type:BLOB data:size=0024
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff  ................
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff  ................
ff ff ff ff                                      ....            
0-058:      ap.passwd type:BLOB data:size=0041
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff  ................
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff  ................
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff  ................
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff  ................
ff                                               .               
0-062:         ap.pmk type:BLOB data:size=0020
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff  ................
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff  ................
0-064:        ap.chan type:U8   data:1
0-065:    ap.authmode type:U8   data:0
0-066:      ap.hidden type:U8   data:0
0-067:    ap.max.conn type:U8   data:4
0-068:   bcn.interval type:U16  data:100
0-069:        ap.phym type:U8   data:3
0-070:       ap.phybw type:U8   data:2
0-071:     ap.sndchan type:U8   data:1
1-061:       sta.ssid type:BLOB data:size=0024
0b 00 00 00 42 65 6c 6b 69 6e 2e 34 36 34 43 00  ....Belkin.464C.
94 35 fc 3f 2c 1a fd 3f 58 1f 08 40 fa 6f 08 40  .5.?,..?X..@.o.@
30 05 06 00                                      0...

Example of Damaged NVS

// Show_nvs_keys Output, The ESP32 that generated this output has a damaged NVS partition.
// the page.Seqnr values should be inclusive of the partition size (0..4)
// With this damage, the report only accesses Logical Page Zero, (sector 0)

Partition nvs found, 20480 bytes
page[0].State=0xfffffffc INIT FULL  means FULL  Seqnr=0 
page[1].State=0xfffffffe INIT  means ACTIVE Sequence value InValid: page[1].Seqnr=5663 
page[2].State=0xffffffff  means UNINITIALIZED  Page[2] not active, State = 0xffffffff Seqnr=4294967295 
page[3].State=0xfffffffc INIT FULL  means FULL Sequence value InValid: page[3].Seqnr=183 
page[4].State=0xfffffffc INIT FULL  means FULL Sequence value InValid: page[4].Seqnr=5662 

Logical Page to Physical Sector
Page 0 -> 0
Page 1 -> 255
Page 2 -> 255
Page 3 -> 255
Page 4 -> 255

NAME SPACES
           misc = 1
   nvs.net80211 = 2
            phy = 3

NameSpace:            misc = 1

NameSpace:    nvs.net80211 = 2

NameSpace:             phy = 3

NameSpace:            misc 
0-001:            log type:BLOB data=size:0010
02 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00  ................

NameSpace:    nvs.net80211 
0-005:        country type:U8   data=0
0-011:   sta.authmode type:U8   data=1
0-016:        sta.pmk type:BLOB data=size:0020
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff  ................
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff  ................
0-019:      auto.conn type:U8   data=1
0-023:       sta.phym type:U8   data=3
0-024:      sta.phybw type:U8   data=2
0-050:        ap.ssid type:BLOB data=size:0024
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff  ................
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff  ................
ff ff ff ff                                      ....            
0-055:      ap.passwd type:BLOB data=size:0041
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff  ................
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff  ................
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff  ................
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff  ................
ff                                               .               
0-059:         ap.pmk type:BLOB data=size:0020
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff  ................
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff  ................
0-061:        ap.chan type:U8   data=1
0-062:    ap.authmode type:U8   data=0
0-063:      ap.hidden type:U8   data=0
0-064:    ap.max.conn type:U8   data=4
0-065:   bcn.interval type:U16  data=100
0-066:        ap.phym type:U8   data=3
0-067:       ap.phybw type:U8   data=2
0-068:     ap.sndchan type:U8   data=1

NameSpace:             phy

Name		Name	Last commit message	Last commit date
Latest commit History 15 Commits
Damaged-Nvs.txt		Damaged-Nvs.txt
README.md		README.md
Show_nvs_keys.ino		Show_nvs_keys.ino

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

ESP32-Show_nvs_keys

Simple sketch to reinit nvs provided byte @lbernstone

Command available from Serial monitor:

example of Normal Output

Example of Damaged NVS

About

Releases

Packages

Languages

stickbreaker/ESP32-Show_nvs_keys

Folders and files

Latest commit

History

Repository files navigation

ESP32-Show_nvs_keys

Simple sketch to reinit nvs provided byte @lbernstone

Command available from Serial monitor:

example of Normal Output

Example of Damaged NVS

About

Topics

Resources

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages