nvs.h File Reference

#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>
#include "esp_err.h"

Go to the source code of this file.

Data Structures
struct	nvs_entry_info_t
struct	nvs_stats_t

Macros
#define	ESP_ERR_NVS_BASE   0x1100
#define	ESP_ERR_NVS_NOT_INITIALIZED   (ESP_ERR_NVS_BASE + 0x01)
#define	ESP_ERR_NVS_NOT_FOUND   (ESP_ERR_NVS_BASE + 0x02)
#define	ESP_ERR_NVS_TYPE_MISMATCH   (ESP_ERR_NVS_BASE + 0x03)
#define	ESP_ERR_NVS_READ_ONLY   (ESP_ERR_NVS_BASE + 0x04)
#define	ESP_ERR_NVS_NOT_ENOUGH_SPACE   (ESP_ERR_NVS_BASE + 0x05)
#define	ESP_ERR_NVS_INVALID_NAME   (ESP_ERR_NVS_BASE + 0x06)
#define	ESP_ERR_NVS_INVALID_HANDLE   (ESP_ERR_NVS_BASE + 0x07)
#define	ESP_ERR_NVS_REMOVE_FAILED   (ESP_ERR_NVS_BASE + 0x08)
#define	ESP_ERR_NVS_KEY_TOO_LONG   (ESP_ERR_NVS_BASE + 0x09)
#define	ESP_ERR_NVS_PAGE_FULL   (ESP_ERR_NVS_BASE + 0x0a)
#define	ESP_ERR_NVS_INVALID_STATE   (ESP_ERR_NVS_BASE + 0x0b)
#define	ESP_ERR_NVS_INVALID_LENGTH   (ESP_ERR_NVS_BASE + 0x0c)
#define	ESP_ERR_NVS_NO_FREE_PAGES   (ESP_ERR_NVS_BASE + 0x0d)
#define	ESP_ERR_NVS_VALUE_TOO_LONG   (ESP_ERR_NVS_BASE + 0x0e)
#define	ESP_ERR_NVS_PART_NOT_FOUND   (ESP_ERR_NVS_BASE + 0x0f)
#define	ESP_ERR_NVS_NEW_VERSION_FOUND   (ESP_ERR_NVS_BASE + 0x10)
#define	ESP_ERR_NVS_XTS_ENCR_FAILED   (ESP_ERR_NVS_BASE + 0x11)
#define	ESP_ERR_NVS_XTS_DECR_FAILED   (ESP_ERR_NVS_BASE + 0x12)
#define	ESP_ERR_NVS_XTS_CFG_FAILED   (ESP_ERR_NVS_BASE + 0x13)
#define	ESP_ERR_NVS_XTS_CFG_NOT_FOUND   (ESP_ERR_NVS_BASE + 0x14)
#define	ESP_ERR_NVS_ENCR_NOT_SUPPORTED   (ESP_ERR_NVS_BASE + 0x15)
#define	ESP_ERR_NVS_KEYS_NOT_INITIALIZED   (ESP_ERR_NVS_BASE + 0x16)
#define	ESP_ERR_NVS_CORRUPT_KEY_PART   (ESP_ERR_NVS_BASE + 0x17)
#define	ESP_ERR_NVS_CONTENT_DIFFERS   (ESP_ERR_NVS_BASE + 0x18)
#define	ESP_ERR_NVS_WRONG_ENCRYPTION   (ESP_ERR_NVS_BASE + 0x19)
#define	NVS_DEFAULT_PART_NAME   "nvs"
#define	NVS_PART_NAME_MAX_SIZE   16
#define	NVS_KEY_NAME_MAX_SIZE   16
#define	NVS_NS_NAME_MAX_SIZE   NVS_KEY_NAME_MAX_SIZE

Typedefs
typedef uint32_t	nvs_handle_t
typedef struct nvs_opaque_iterator_t *	nvs_iterator_t

Enumerations
enum	nvs_open_mode_t {   NVS_READONLY = 0 ,   NVS_READWRITE = 1 }
enum	nvs_type_t {   NVS_TYPE_U8 = 0x01 ,   NVS_TYPE_I8 = 0x11 ,   NVS_TYPE_U16 = 0x02 ,   NVS_TYPE_I16 = 0x12 ,   NVS_TYPE_U32 = 0x04 ,   NVS_TYPE_I32 = 0x14 ,   NVS_TYPE_U64 = 0x08 ,   NVS_TYPE_I64 = 0x18 ,   NVS_TYPE_STR = 0x21 ,   NVS_TYPE_BLOB = 0x42 ,   NVS_TYPE_ANY = 0xFF }

Functions
esp_err_t	nvs_open (const char *namespace_name, nvs_open_mode_t open_mode, nvs_handle_t *out_handle)
esp_err_t	nvs_open_from_partition (const char *part_name, const char *namespace_name, nvs_open_mode_t open_mode, nvs_handle_t *out_handle)
void	nvs_close (nvs_handle_t handle)
esp_err_t	nvs_commit (nvs_handle_t handle)
esp_err_t	nvs_set_i8 (nvs_handle_t handle, const char *key, int8_t value)
esp_err_t	nvs_set_u8 (nvs_handle_t handle, const char *key, uint8_t value)
esp_err_t	nvs_set_i16 (nvs_handle_t handle, const char *key, int16_t value)
esp_err_t	nvs_set_u16 (nvs_handle_t handle, const char *key, uint16_t value)
esp_err_t	nvs_set_i32 (nvs_handle_t handle, const char *key, int32_t value)
esp_err_t	nvs_set_u32 (nvs_handle_t handle, const char *key, uint32_t value)
esp_err_t	nvs_set_i64 (nvs_handle_t handle, const char *key, int64_t value)
esp_err_t	nvs_set_u64 (nvs_handle_t handle, const char *key, uint64_t value)
esp_err_t	nvs_set_str (nvs_handle_t handle, const char *key, const char *value)
esp_err_t	nvs_set_blob (nvs_handle_t handle, const char *key, const void *value, size_t length)
esp_err_t	nvs_get_i8 (nvs_handle_t handle, const char *key, int8_t *out_value)
esp_err_t	nvs_get_u8 (nvs_handle_t handle, const char *key, uint8_t *out_value)
esp_err_t	nvs_get_i16 (nvs_handle_t handle, const char *key, int16_t *out_value)
esp_err_t	nvs_get_u16 (nvs_handle_t handle, const char *key, uint16_t *out_value)
esp_err_t	nvs_get_i32 (nvs_handle_t handle, const char *key, int32_t *out_value)
esp_err_t	nvs_get_u32 (nvs_handle_t handle, const char *key, uint32_t *out_value)
esp_err_t	nvs_get_i64 (nvs_handle_t handle, const char *key, int64_t *out_value)
esp_err_t	nvs_get_u64 (nvs_handle_t handle, const char *key, uint64_t *out_value)
esp_err_t	nvs_get_str (nvs_handle_t handle, const char *key, char *out_value, size_t *length)
esp_err_t	nvs_get_blob (nvs_handle_t handle, const char *key, void *out_value, size_t *length)
esp_err_t	nvs_erase_key (nvs_handle_t handle, const char *key)
esp_err_t	nvs_erase_all (nvs_handle_t handle)
esp_err_t	nvs_get_stats (const char *part_name, nvs_stats_t *nvs_stats)
esp_err_t	nvs_get_used_entry_count (nvs_handle_t handle, size_t *used_entries)
esp_err_t	nvs_entry_find (const char *part_name, const char *namespace_name, nvs_type_t type, nvs_iterator_t *output_iterator)
esp_err_t	nvs_entry_next (nvs_iterator_t *iterator)
esp_err_t	nvs_entry_info (const nvs_iterator_t iterator, nvs_entry_info_t *out_info)
void	nvs_release_iterator (nvs_iterator_t iterator)

Macro Definition Documentation

ESP_ERR_NVS_BASE

#define ESP_ERR_NVS_BASE   0x1100

ESP_ERR_NVS_NOT_INITIALIZED

#define ESP_ERR_NVS_NOT_INITIALIZED   (ESP_ERR_NVS_BASE + 0x01)

ESP_ERR_NVS_NOT_FOUND

#define ESP_ERR_NVS_NOT_FOUND   (ESP_ERR_NVS_BASE + 0x02)

ESP_ERR_NVS_TYPE_MISMATCH

#define ESP_ERR_NVS_TYPE_MISMATCH   (ESP_ERR_NVS_BASE + 0x03)

ESP_ERR_NVS_READ_ONLY

#define ESP_ERR_NVS_READ_ONLY   (ESP_ERR_NVS_BASE + 0x04)

ESP_ERR_NVS_NOT_ENOUGH_SPACE

#define ESP_ERR_NVS_NOT_ENOUGH_SPACE   (ESP_ERR_NVS_BASE + 0x05)

ESP_ERR_NVS_INVALID_NAME

#define ESP_ERR_NVS_INVALID_NAME   (ESP_ERR_NVS_BASE + 0x06)

ESP_ERR_NVS_INVALID_HANDLE

#define ESP_ERR_NVS_INVALID_HANDLE   (ESP_ERR_NVS_BASE + 0x07)

ESP_ERR_NVS_REMOVE_FAILED

#define ESP_ERR_NVS_REMOVE_FAILED   (ESP_ERR_NVS_BASE + 0x08)

ESP_ERR_NVS_KEY_TOO_LONG

#define ESP_ERR_NVS_KEY_TOO_LONG   (ESP_ERR_NVS_BASE + 0x09)

ESP_ERR_NVS_PAGE_FULL

#define ESP_ERR_NVS_PAGE_FULL   (ESP_ERR_NVS_BASE + 0x0a)

ESP_ERR_NVS_INVALID_STATE

#define ESP_ERR_NVS_INVALID_STATE   (ESP_ERR_NVS_BASE + 0x0b)

ESP_ERR_NVS_INVALID_LENGTH

#define ESP_ERR_NVS_INVALID_LENGTH   (ESP_ERR_NVS_BASE + 0x0c)

ESP_ERR_NVS_NO_FREE_PAGES

#define ESP_ERR_NVS_NO_FREE_PAGES   (ESP_ERR_NVS_BASE + 0x0d)

ESP_ERR_NVS_VALUE_TOO_LONG

#define ESP_ERR_NVS_VALUE_TOO_LONG   (ESP_ERR_NVS_BASE + 0x0e)

ESP_ERR_NVS_PART_NOT_FOUND

#define ESP_ERR_NVS_PART_NOT_FOUND   (ESP_ERR_NVS_BASE + 0x0f)

ESP_ERR_NVS_NEW_VERSION_FOUND

#define ESP_ERR_NVS_NEW_VERSION_FOUND   (ESP_ERR_NVS_BASE + 0x10)

ESP_ERR_NVS_XTS_ENCR_FAILED

#define ESP_ERR_NVS_XTS_ENCR_FAILED   (ESP_ERR_NVS_BASE + 0x11)

ESP_ERR_NVS_XTS_DECR_FAILED

#define ESP_ERR_NVS_XTS_DECR_FAILED   (ESP_ERR_NVS_BASE + 0x12)

ESP_ERR_NVS_XTS_CFG_FAILED

#define ESP_ERR_NVS_XTS_CFG_FAILED   (ESP_ERR_NVS_BASE + 0x13)

ESP_ERR_NVS_XTS_CFG_NOT_FOUND

#define ESP_ERR_NVS_XTS_CFG_NOT_FOUND   (ESP_ERR_NVS_BASE + 0x14)

ESP_ERR_NVS_ENCR_NOT_SUPPORTED

#define ESP_ERR_NVS_ENCR_NOT_SUPPORTED   (ESP_ERR_NVS_BASE + 0x15)

ESP_ERR_NVS_KEYS_NOT_INITIALIZED

#define ESP_ERR_NVS_KEYS_NOT_INITIALIZED   (ESP_ERR_NVS_BASE + 0x16)

ESP_ERR_NVS_CORRUPT_KEY_PART

#define ESP_ERR_NVS_CORRUPT_KEY_PART   (ESP_ERR_NVS_BASE + 0x17)

ESP_ERR_NVS_CONTENT_DIFFERS

#define ESP_ERR_NVS_CONTENT_DIFFERS   (ESP_ERR_NVS_BASE + 0x18)

ESP_ERR_NVS_WRONG_ENCRYPTION

#define ESP_ERR_NVS_WRONG_ENCRYPTION   (ESP_ERR_NVS_BASE + 0x19)

NVS_DEFAULT_PART_NAME

#define NVS_DEFAULT_PART_NAME   "nvs"

NVS_PART_NAME_MAX_SIZE

#define NVS_PART_NAME_MAX_SIZE   16

NVS_KEY_NAME_MAX_SIZE

#define NVS_KEY_NAME_MAX_SIZE   16

NVS_NS_NAME_MAX_SIZE

#define NVS_NS_NAME_MAX_SIZE   NVS_KEY_NAME_MAX_SIZE

Typedef Documentation

nvs_handle_t

typedef uint32_t nvs_handle_t

nvs_iterator_t

typedef struct nvs_opaque_iterator_t* nvs_iterator_t

Enumeration Type Documentation

nvs_open_mode_t

enum nvs_open_mode_t

Enumerator
NVS_READONLY
NVS_READWRITE

nvs_type_t

enum nvs_type_t

Enumerator
NVS_TYPE_U8
NVS_TYPE_I8
NVS_TYPE_U16
NVS_TYPE_I16
NVS_TYPE_U32
NVS_TYPE_I32
NVS_TYPE_U64
NVS_TYPE_I64
NVS_TYPE_STR
NVS_TYPE_BLOB
NVS_TYPE_ANY

Function Documentation

nvs_open()

esp_err_t nvs_open	(	const char *	namespace_name,
		nvs_open_mode_t	open_mode,
		nvs_handle_t *	out_handle
	)

nvs_open_from_partition()

esp_err_t nvs_open_from_partition	(	const char *	part_name,
		const char *	namespace_name,
		nvs_open_mode_t	open_mode,
		nvs_handle_t *	out_handle
	)

nvs_close()

void nvs_close

(

nvs_handle_t

handle

)

nvs_commit()

esp_err_t nvs_commit

(

nvs_handle_t

handle

)

nvs_set_i8()

esp_err_t nvs_set_i8	(	nvs_handle_t	handle,
		const char *	key,
		int8_t	value
	)

nvs_set_u8()

esp_err_t nvs_set_u8	(	nvs_handle_t	handle,
		const char *	key,
		uint8_t	value
	)

nvs_set_i16()

esp_err_t nvs_set_i16	(	nvs_handle_t	handle,
		const char *	key,
		int16_t	value
	)

nvs_set_u16()

esp_err_t nvs_set_u16	(	nvs_handle_t	handle,
		const char *	key,
		uint16_t	value
	)

nvs_set_i32()

esp_err_t nvs_set_i32	(	nvs_handle_t	handle,
		const char *	key,
		int32_t	value
	)

nvs_set_u32()

esp_err_t nvs_set_u32	(	nvs_handle_t	handle,
		const char *	key,
		uint32_t	value
	)

nvs_set_i64()

esp_err_t nvs_set_i64	(	nvs_handle_t	handle,
		const char *	key,
		int64_t	value
	)

nvs_set_u64()

esp_err_t nvs_set_u64	(	nvs_handle_t	handle,
		const char *	key,
		uint64_t	value
	)

nvs_set_str()

esp_err_t nvs_set_str	(	nvs_handle_t	handle,
		const char *	key,
		const char *	value
	)

nvs_set_blob()

esp_err_t nvs_set_blob	(	nvs_handle_t	handle,
		const char *	key,
		const void *	value,
		size_t	length
	)

nvs_get_i8()

esp_err_t nvs_get_i8	(	nvs_handle_t	handle,
		const char *	key,
		int8_t *	out_value
	)

nvs_get_u8()

esp_err_t nvs_get_u8	(	nvs_handle_t	handle,
		const char *	key,
		uint8_t *	out_value
	)

nvs_get_i16()

esp_err_t nvs_get_i16	(	nvs_handle_t	handle,
		const char *	key,
		int16_t *	out_value
	)

nvs_get_u16()

esp_err_t nvs_get_u16	(	nvs_handle_t	handle,
		const char *	key,
		uint16_t *	out_value
	)

nvs_get_i32()

esp_err_t nvs_get_i32	(	nvs_handle_t	handle,
		const char *	key,
		int32_t *	out_value
	)

nvs_get_u32()

esp_err_t nvs_get_u32	(	nvs_handle_t	handle,
		const char *	key,
		uint32_t *	out_value
	)

nvs_get_i64()

esp_err_t nvs_get_i64	(	nvs_handle_t	handle,
		const char *	key,
		int64_t *	out_value
	)

nvs_get_u64()

esp_err_t nvs_get_u64	(	nvs_handle_t	handle,
		const char *	key,
		uint64_t *	out_value
	)

nvs_get_str()

esp_err_t nvs_get_str	(	nvs_handle_t	handle,
		const char *	key,
		char *	out_value,
		size_t *	length
	)

nvs_get_blob()

esp_err_t nvs_get_blob	(	nvs_handle_t	handle,
		const char *	key,
		void *	out_value,
		size_t *	length
	)

nvs_erase_key()

esp_err_t nvs_erase_key	(	nvs_handle_t	handle,
		const char *	key
	)

nvs_erase_all()

esp_err_t nvs_erase_all

(

nvs_handle_t

handle

)

nvs_get_stats()

esp_err_t nvs_get_stats	(	const char *	part_name,
		nvs_stats_t *	nvs_stats
	)

nvs_get_used_entry_count()

esp_err_t nvs_get_used_entry_count	(	nvs_handle_t	handle,
		size_t *	used_entries
	)

nvs_entry_find()

esp_err_t nvs_entry_find	(	const char *	part_name,
		const char *	namespace_name,
		nvs_type_t	type,
		nvs_iterator_t *	output_iterator
	)

nvs_entry_next()

esp_err_t nvs_entry_next

(

nvs_iterator_t *

iterator

)

nvs_entry_info()

esp_err_t nvs_entry_info	(	const nvs_iterator_t	iterator,
		nvs_entry_info_t *	out_info
	)

nvs_release_iterator()

void nvs_release_iterator

(

nvs_iterator_t

iterator

)