Class NVS

constructor

• new NVS(loader: SerialPort | ESPLoader): NVS

  Parameters

  • loader: SerialPort | ESPLoader

    ESPLoader from ESPTool library or WebSerial SerialPort

  Returns NVS

  Throws

  Argument is not an ESPLoader or a SerialPort

Readonlycache

[asyncIterator]

• "[asyncIterator]"(): AsyncIterator<[string, string, nvs_value], any, any>

  Asynchronously iterates over all NVS entries

  Returns AsyncIterator<[string, string, nvs_value], any, any>

all

• all(): Promise<void>

  Parses all NVS entries on device

  Returns Promise<void>

connect

• connect(): Promise<void>

  Connects to device

  Returns Promise<void>

fetchPartition

• fetchPartition(partitionName?: string, addr?: number): Promise<boolean>

  Fetches NVS partition from device If no partition have been specified before parsing, default NVS page will automatically be fetched from partition table

  Parameters

  • OptionalpartitionName: string

    Partition name to get the page addresses for

  • Optionaladdr: number

    Address of the partition table

  Returns Promise<boolean>

  Throws

  Partition already set

find

• find(namespace: string, key: string): Promise<nvs_entry | null>

  Gets the internal entry for the specified key in the specified namespace

  Parameters

  • namespace: string

    Namespace to find the key in

  • key: string

    Key to find the value for

  Returns Promise<nvs_entry | null>

  Found entry or null if not found

get

• get(namespace: string, key: string): Promise<nvs_value | null>

  Gets the value for the specified key in the specified namespace

  Parameters

  • namespace: string

    Namespace to find the key in

  • key: string

    Key to find the value for

  Returns Promise<nvs_value | null>

next

• next(): Promise<nvs_entry | null>

  Parses next NVS entry and adds it to the cache

  Returns Promise<nvs_entry | null>

  Parsed entry or null if no more entries are available on any of the registered NVS pages

setPartition

• setPartition(addr: number, len: number): void

  Specifies NVS partition to use If no partition have been specified before parsing, default NVS page will automatically be fetched from partition table

  Parameters

  • addr: number

    Address of an NVS partition

  • len: number

    Size of the NVS partition

  Returns void

  Throws

  Partition already set

toHTML

• toHTML(): Promise<HTMLTableElement>

  Gets all data as HTML table

  Returns Promise<HTMLTableElement>

toJSON

• toJSON(): Promise<{}>

  Gets all data as JSON

  Returns Promise<{}>