A setting's row of the schema: its key, unit, category, type, range, step, default and options. Its label and help line are ui_text.def's (settings_label(), settings_help()). More...

#include <settings.h>

Data Fields
const char *	key
const char *	unit
setting_cat_t	cat
setting_type_t	type
float	min
float	max
float	step
float	def
const char const	options
uint8_t	option_count
float	off_below

Detailed Description

A setting's row of the schema: its key, unit, category, type, range, step, default and options. Its label and help line are ui_text.def's (settings_label(), settings_help()).

Field Documentation

◆ cat

setting_cat_t setting_def_t::cat

the category the setting is listed in

◆ def

float setting_def_t::def

the default value

◆ key

const char* setting_def_t::key

NVS key, 15 chars or fewer

◆ max

float setting_def_t::max

the highest value

◆ min

float setting_def_t::min

the lowest value

◆ off_below

float setting_def_t::off_below

A number whose values between 0 and this are not taken: 0 is "off" and the next value up is this one. 0 for none.

◆ option_count

uint8_t setting_def_t::option_count

number of options in options

◆ options

const char* const* setting_def_t::options

SET_TYPE_ENUM only

◆ step

float setting_def_t::step

the step of the value's keys and slider

◆ type

setting_type_t setting_def_t::type

the type of the value

◆ unit

const char* setting_def_t::unit

shown beside the value; "" none

The documentation for this struct was generated from the following file:

shared/settings/include/settings.h

Data Fields