Configuration

Modules
	Configuration Internals

Data Structures
struct	config_neopixel_phy_t
	Provides configuration of the NeoPixel PHY to support other chipsets. More...
struct	config_data_t
	Configuration structure. More...
struct	config_api_t
	Configuration instance API. More...

Macros
#define	CONFIG_DATA_VERSION   (1)

Functions
config_api_t const *	config (void)
	Get a pointer to the current API instance. More...
config_data_t const *	config_default (void)
	Get a pointer to the default configuration values. More...
config_data_t const *	config_get_or_default (void)
	Gets a pointer to the saved configuration values or the defaults if an error occurs. More...
void	config_register (config_api_t const *p_instance)
	Register an API to be used as the current instance. More...
pixelkey_error_t	config_validate (void)
	Validates and updates NV memory config if needed; can only be called after config_register.

Detailed Description

Function Documentation

config()

config_api_t const * config

(

void

)

Get a pointer to the current API instance.

Returns

pointer to instance.

config_default()

config_data_t const * config_default

(

void

)

Get a pointer to the default configuration values.

Returns

default config pointer.

config_get_or_default()

config_data_t const * config_get_or_default ( void  )

inline

Gets a pointer to the saved configuration values or the defaults if an error occurs.

Returns

Pointer to saved config or default values.

config_register()

void config_register

(

config_api_t const *

p_instance

)

Register an API to be used as the current instance.

Parameters

[in]

p_instance

Pointer to the API instance.