File espos_config_desc.h¶

FileList > espos_config > include > espos_config_desc.h

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

Classes¶

Type	Name
struct	espos_cfg_display_t
struct	espos_cfg_key_t
struct	espos_cfg_ns_t

Public Types¶

Type	Name
union	espos_cfg_scalar_t
enum	espos_cfg_type_t

Public Attributes¶

Type	Name
const size_t	espos_cfg_namespace_count
const espos_cfg_ns_t	espos_cfg_namespaces
const char	espos_cfg_schema_etag
const char	espos_cfg_schema_json
const size_t	espos_cfg_schema_json_len

Macros¶

Type	Name
define	ESPOS_CFG_FLAG_READ_ONLY `(1u << 2)`
define	ESPOS_CFG_FLAG_RESTART_REQUIRED `(1u << 1) /\* change takes effect after reboot \*/`
define	ESPOS_CFG_FLAG_SECRET `(1u << 0) /\* redacted on export, sentinel ignored on import \*/`
define	ESPOS_CFG_NS_NAME_MAX `15`
define	ESPOS_CFG_RUNTIME_ID_MAX `12`
define	ESPOS_CFG_RUNTIME_NS_PREFIX `"f\_"`
define	ESPOS_CFG_VERSION_KEY `"config\_version"`

Public Types Documentation¶

union espos_cfg_scalar_t¶

enum espos_cfg_type_t¶

enum espos_cfg_type_t {
    ESPOS_CFG_TYPE_BOOL = 1,
    ESPOS_CFG_TYPE_INT,
    ESPOS_CFG_TYPE_FLOAT,
    ESPOS_CFG_TYPE_STRING,
    ESPOS_CFG_TYPE_BLOB
};

Public Attributes Documentation¶

variable espos_cfg_namespace_count¶

const size_t espos_cfg_namespace_count;

variable espos_cfg_namespaces¶

const espos_cfg_ns_t espos_cfg_namespaces[];

variable espos_cfg_schema_etag¶

const char espos_cfg_schema_etag[];

variable espos_cfg_schema_json¶

const char espos_cfg_schema_json[];

variable espos_cfg_schema_json_len¶

const size_t espos_cfg_schema_json_len;

Macro Definition Documentation¶

define ESPOS_CFG_FLAG_READ_ONLY¶

#define ESPOS_CFG_FLAG_READ_ONLY `(1u << 2)`

define ESPOS_CFG_FLAG_RESTART_REQUIRED¶

#define ESPOS_CFG_FLAG_RESTART_REQUIRED `(1u << 1) /* change takes effect after reboot */`

define ESPOS_CFG_FLAG_SECRET¶

#define ESPOS_CFG_FLAG_SECRET `(1u << 0) /* redacted on export, sentinel ignored on import */`

define ESPOS_CFG_NS_NAME_MAX¶

#define ESPOS_CFG_NS_NAME_MAX `15`

define ESPOS_CFG_RUNTIME_ID_MAX¶

#define ESPOS_CFG_RUNTIME_ID_MAX `12`

define ESPOS_CFG_RUNTIME_NS_PREFIX¶

#define ESPOS_CFG_RUNTIME_NS_PREFIX `"f_"`

define ESPOS_CFG_VERSION_KEY¶

#define ESPOS_CFG_VERSION_KEY `"config_version"`

The documentation for this class was generated from the following file espos_config/include/espos_config_desc.h