Collaboration diagram for NVM:

Functions
void	zaf_nvm_app_set_default_configuration (void)
	Used by the application to execute actions after a set default configuration.

void	zaf_nvm_app_reset (void)
	Used by the application to execute actions after a application reset.

void	zaf_nvm_app_load_configuration (void)
	Used by the application to execute actions after a load configuration.

void	zaf_nvm_app_load_configuration_migration (uint32_t current_version, uint32_t saved_version)
	Used by the application to execute actions when the current version differs from the saved version.

void	zafi_nvm_app_set_default_configuration (void)
	Resets configuration to default values.

void	zafi_nvm_app_reset (void)
	Resets the NVM file system.

void	zafi_nvm_app_load_configuration (void)
	Loads the default configuration common for all applications.

bool	ZAF_nvm_init (void)
	Opens file system for ZAF.

bool	ZAF_nvm_erase (void)
	Erases application nvm. (Does nothing on 800s since it has 1 shared nvm for application and protocol.)

zpal_status_t	ZAF_nvm_erase_object (zpal_nvm_object_key_t key)
	Erases an object from application nvm.

zpal_status_t	ZAF_nvm_read (zpal_nvm_object_key_t key, void *object, size_t object_size)
	Reads an object from application nvm.

zpal_status_t	ZAF_nvm_read_object_part (zpal_nvm_object_key_t key, void *object, size_t offset, size_t size)
	Reads part of an object from application nvm.

zpal_status_t	ZAF_nvm_write (zpal_nvm_object_key_t key, const void *object, size_t object_size)
	Writes an object to application nvm.

zpal_status_t	ZAF_nvm_get_object_size (zpal_nvm_object_key_t key, size_t *len)
	Get the object size identified with a given key from NVM.

bool	ZAF_nvm_app_init (void)
	Opens file system for application.

bool	ZAF_nvm_app_erase (void)
	Erases application nvm. (Does nothing on 800s since it has 1 shared nvm for application and protocol.)

zpal_status_t	ZAF_nvm_app_erase_object (zpal_nvm_object_key_t key)
	Erases an object from application nvm.

zpal_status_t	ZAF_nvm_app_read (zpal_nvm_object_key_t key, void *object, size_t object_size)
	Reads an object from application nvm.

zpal_status_t	ZAF_nvm_app_read_object_part (zpal_nvm_object_key_t key, void *object, size_t offset, size_t size)
	Reads part of an object from application nvm.

zpal_status_t	ZAF_nvm_app_write (zpal_nvm_object_key_t key, const void *object, size_t object_size)
	Writes an object to application nvm.

zpal_status_t	ZAF_nvm_app_get_object_size (zpal_nvm_object_key_t key, size_t *len)
	Get the object size identified with a given key from NVM.

Detailed Description

Function Documentation

◆ ZAF_nvm_app_erase()

bool ZAF_nvm_app_erase ( void )

Erases application nvm. (Does nothing on 800s since it has 1 shared nvm for application and protocol.)

Returns: true on successful erase

◆ ZAF_nvm_app_erase_object()

zpal_status_t ZAF_nvm_app_erase_object ( zpal_nvm_object_key_t key )

Erases an object from application nvm.

Parameters

[in] key Object key.

Returns: status of erase operation

◆ ZAF_nvm_app_get_object_size()

zpal_status_t ZAF_nvm_app_get_object_size	(	zpal_nvm_object_key_t	key,
		size_t *	len )

Get the object size identified with a given key from NVM.

Parameters

[in]	key	Object key.
[out]	len	Object size.

Returns: status of operation

◆ ZAF_nvm_app_init()

bool ZAF_nvm_app_init ( void )

Opens file system for application.

Returns: bool true if zpal_nvm_init() succeeded else false.

◆ zaf_nvm_app_load_configuration()

void zaf_nvm_app_load_configuration ( void )

Used by the application to execute actions after a load configuration.

◆ zaf_nvm_app_load_configuration_migration()

void zaf_nvm_app_load_configuration_migration	(	uint32_t	current_version,
		uint32_t	saved_version )

Used by the application to execute actions when the current version differs from the saved version.

Parameters

current_version	Version returned by zpal_get_app_version
saved_version	Version stored in ZAF_FILE_ID_APP_VERSION

◆ ZAF_nvm_app_read()

zpal_status_t ZAF_nvm_app_read	(	zpal_nvm_object_key_t	key,
		void *	object,
		size_t	object_size )

Reads an object from application nvm.

Parameters

[in]	key	Object key.
[out]	object	Address of array where object can be written to.
[in]	object_size	Size of the stored object.

Returns: status of read operation

◆ ZAF_nvm_app_read_object_part()

zpal_status_t ZAF_nvm_app_read_object_part	(	zpal_nvm_object_key_t	key,
		void *	object,
		size_t	offset,
		size_t	size )

Reads part of an object from application nvm.

Parameters

[in]	key	Object key.
[out]	object	Address of array where part of object can be written to.
[in]	offset	The offset in object where part shall be read from.
[in]	size	Size of the object part.

Returns: status of read operation

◆ zaf_nvm_app_reset()

void zaf_nvm_app_reset ( void )

Used by the application to execute actions after a application reset.

◆ zaf_nvm_app_set_default_configuration()

void zaf_nvm_app_set_default_configuration ( void )

Used by the application to execute actions after a set default configuration.

◆ ZAF_nvm_app_write()

zpal_status_t ZAF_nvm_app_write	(	zpal_nvm_object_key_t	key,
		const void *	object,
		size_t	object_size )

Writes an object to application nvm.

Parameters

[in]	key	Object key.
[out]	object	Address of array of object that is written.
[in]	object_size	Size of the stored object.

Returns: status of write operation

◆ ZAF_nvm_erase()

bool ZAF_nvm_erase ( void )

Erases application nvm. (Does nothing on 800s since it has 1 shared nvm for application and protocol.)

Returns: true on successful erase

◆ ZAF_nvm_erase_object()

zpal_status_t ZAF_nvm_erase_object ( zpal_nvm_object_key_t key )

Erases an object from application nvm.

Parameters

[in] key Object key.

Returns: status of erase operation

◆ ZAF_nvm_get_object_size()

zpal_status_t ZAF_nvm_get_object_size	(	zpal_nvm_object_key_t	key,
		size_t *	len )

Get the object size identified with a given key from NVM.

Parameters

[in]	key	Object key.
[out]	len	Object size.

Returns: status of operation

◆ ZAF_nvm_init()

bool ZAF_nvm_init ( void )

Opens file system for ZAF.

Returns: bool true if zpal_nvm_init() succeeded else false.

◆ ZAF_nvm_read()

zpal_status_t ZAF_nvm_read	(	zpal_nvm_object_key_t	key,
		void *	object,
		size_t	object_size )

Reads an object from application nvm.

Parameters

[in]	key	Object key.
[out]	object	Address of array where object can be written to.
[in]	object_size	Size of the stored object.

Returns: status of read operation

◆ ZAF_nvm_read_object_part()

zpal_status_t ZAF_nvm_read_object_part	(	zpal_nvm_object_key_t	key,
		void *	object,
		size_t	offset,
		size_t	size )

Reads part of an object from application nvm.

Parameters

[in]	key	Object key.
[out]	object	Address of array where part of object can be written to.
[in]	offset	The offset in object where part shall be read from.
[in]	size	Size of the object part.

Returns: status of read operation

◆ ZAF_nvm_write()

zpal_status_t ZAF_nvm_write	(	zpal_nvm_object_key_t	key,
		const void *	object,
		size_t	object_size )

Writes an object to application nvm.

Parameters

[in]	key	Object key.
[out]	object	Address of array of object that is written.
[in]	object_size	Size of the stored object.

Returns: status of write operation

◆ zafi_nvm_app_load_configuration()

void zafi_nvm_app_load_configuration ( void )

Loads the default configuration common for all applications.

Remarks: If no settings are found, the application file system will be erased and default values will be written.; Internal function. Don't invoke from application.

◆ zafi_nvm_app_reset()

void zafi_nvm_app_reset ( void )

Resets the NVM file system.

Remarks: Internal function only

◆ zafi_nvm_app_set_default_configuration()

void zafi_nvm_app_set_default_configuration ( void )

Resets configuration to default values.

Remarks: Internal function only

Add application specific functions here to initialize configuration values stored in persistent memory. Will be called at any of the following events:

Network Exclusion
Network Secure Inclusion (after S2 bootstrapping complete)
Device Reset Locally

Trident IoT Z-Wave SDK

Functions

Detailed Description

Function Documentation

◆ ZAF_nvm_app_erase()

◆ ZAF_nvm_app_erase_object()

◆ ZAF_nvm_app_get_object_size()

◆ ZAF_nvm_app_init()

◆ zaf_nvm_app_load_configuration()

◆ zaf_nvm_app_load_configuration_migration()

◆ ZAF_nvm_app_read()

◆ ZAF_nvm_app_read_object_part()

◆ zaf_nvm_app_reset()

◆ zaf_nvm_app_set_default_configuration()

◆ ZAF_nvm_app_write()

◆ ZAF_nvm_erase()

◆ ZAF_nvm_erase_object()

◆ ZAF_nvm_get_object_size()

◆ ZAF_nvm_init()

◆ ZAF_nvm_read()

◆ ZAF_nvm_read_object_part()

◆ ZAF_nvm_write()

◆ zafi_nvm_app_load_configuration()

◆ zafi_nvm_app_reset()

◆ zafi_nvm_app_set_default_configuration()