Settings specific macros. More...

Macros
#define	ZOS_NVM_MAX_SIZE 264
	The size of NVM memory section in bytes.

#define	ZOS_NVM_GET_REF(ptr) zn_nvm_get_cache_reference((uint8_t**)&ptr)
	This is a helper macro for zn_nvm_get_cache_reference()

#define	BUILD_CHECK_NVM_SIZE(custom_nvm_struct) BUILD_ASSERTION(sizeof(custom_nvm_struct) <= ZOS_NVM_MAX_SIZE)
	This is a compile-time check to ensure the NVM data struct has not overflowed ZOS_NVM_MAX_SIZE.

#define	ZOS_VERIFY_SETTING_STR(setting, val) zn_settings_set_str(setting, val)
	Verify the result of setting a string setting, print message on failure. More...

#define	ZOS_VERIFY_SETTING_UINT32(setting, val) zn_settings_set_uint32(setting, val)
	Verify the result of setting a uint32 setting, print message on failure. More...

#define	ZOS_GET_SETTING_STR(setting, buffer) zn_settings_get_print_str(setting, buffer, sizeof(buffer))
	Return a NVM setting as string. More...

Detailed Description

Settings specific macros.

Macro Definition Documentation

#define ZOS_GET_SETTING_STR	(	`setting,`
		`buffer`
	)	zn_settings_get_print_str(setting, buffer, sizeof(buffer))

Return a NVM setting as string.

Parameters

`setting`	The setting string to get
`buffer`	Buffer to hold setting's string value

Examples:: basic/display_stream/display_stream.c, basic/http_stream/http_stream.c, basic/softap_tcp_server/softap_tcp_server.c, basic/web_setup/web_setup.c, basic/websocket_server/websocket_server.c, demo/accelerometer_stream/accelerometer_stream.c, demo/led_matrix/led_matrix.c, and demo/moray3d/moray3d.c.

#define ZOS_VERIFY_SETTING_STR	(	`setting,`
		`val`
	)	zn_settings_set_str(setting, val)

Verify the result of setting a string setting, print message on failure.

ZAP must be built with debugging enabled for macro to take effect

#define ZOS_VERIFY_SETTING_UINT32	(	`setting,`
		`val`
	)	zn_settings_set_uint32(setting, val)

Verify the result of setting a uint32 setting, print message on failure.

ZAP must be built with debugging enabled for macro to take effect