CDC Badge OS
Firmware for the CDC Badge v1.0 hardware security key
Loading...
Searching...
No Matches
cdc::ui::settings Namespace Reference

Functions

void init (hal::IDisplay *display, hal::ISleepController *sleep, LockScreenView *lockScreen)
 Initializes shared dependencies used by the settings handlers.
void processPendingBadgeText ()
 Processes the next pending badge-text wizard step.
void onBrightnessSave (uint16_t value)
 Persists and applies selected backlight value.
void onBrightnessChange (uint16_t value)
 Applies backlight preview without persisting.
uint16_t brightnessStepCallback (uint16_t current, bool increasing)
 Returns adaptive brightness step size.
void onSleepIntervalSave (uint16_t value)
 Saves lock-screen sleep interval in minutes.
void onTimezoneSave (uint16_t value)
 Saves timezone offset and refreshes lock-screen clock.
void onDateConfirm (uint8_t day, uint8_t month, uint16_t year)
 Applies confirmed date to system time.
void onTimeConfirm (uint8_t hour, uint8_t minute)
 Applies confirmed time to system clock.
void onPinChangeComplete (bool success)
 Handles completion of PIN-change flow.
void startBadgeTextEdit ()
 Starts badge-text editing wizard.
void saveDisplayField (const char *key, const char *value)
 Saves one display text field to NVS.
bool loadDisplayField (const char *key, char *out, size_t outSize)
 Reads one display text field from NVS into the caller buffer.
static void showBadgeTextStep (uint8_t step)
 Forward declarations for internal helper callbacks.
static void onBadgeNameSave (const char *text)
 Handles save callback for badge display name.
static void onBadgeInfoSave (const char *text)
 Handles save callback for badge info line 1.
static void onBadgeInfo2Save (const char *text)
 Handles save callback for badge info line 2.

Variables

static hal::IDisplays_display = nullptr
 External dependencies injected by AppUi.
static hal::ISleepControllers_sleep = nullptr
static LockScreenViews_lockScreen = nullptr
static constexpr uint8_t BADGE_STEP_NONE = 0
 Badge text editing workflow state.
static constexpr uint8_t BADGE_STEP_NAME = 1
static constexpr uint8_t BADGE_STEP_INFO = 2
static constexpr uint8_t BADGE_STEP_INFO2 = 3
static uint8_t s_badgeTextPendingStep = BADGE_STEP_NONE

Function Documentation

◆ brightnessStepCallback()

uint16_t cdc::ui::settings::brightnessStepCallback ( uint16_t current,
bool increasing )

Returns adaptive brightness step size.

Parameters
currentCurrent slider value.
increasingDirection flag.
Returns
Step size for next adjustment.

Definition at line 92 of file SettingsHandlers.cpp.

Referenced by cdc::ui::ui_init().

◆ init()

void cdc::ui::settings::init ( hal::IDisplay * display,
hal::ISleepController * sleep,
LockScreenView * lockScreen )

Initializes shared dependencies used by the settings handlers.

Parameters
displayDisplay service used for brightness and rendering-related settings.
sleepSleep controller used for auto-sleep configuration.
lockScreenLock screen view used to reflect updated badge text.
Returns
void

Definition at line 46 of file SettingsHandlers.cpp.

References cdc::ui::display, s_display, s_lockScreen, and s_sleep.

Referenced by cdc::ui::ui_init().

◆ loadDisplayField()

bool cdc::ui::settings::loadDisplayField ( const char * key,
char * out,
size_t outSize )

Reads one display text field from NVS into the caller buffer.

Parameters
keyNVS key for the field.
outDestination buffer.
outSizeCapacity of out in bytes.
Returns
true if a non-empty value was read.

Definition at line 289 of file SettingsHandlers.cpp.

Referenced by cdc::os_ui::SystemSettingsBackup::exportSystemSettings().

◆ onBadgeInfo2Save()

void cdc::ui::settings::onBadgeInfo2Save ( const char * text)
static

Handles save callback for badge info line 2.

Parameters
textSaved text value.
Returns
void

Definition at line 260 of file SettingsHandlers.cpp.

References BADGE_STEP_NONE, s_badgeTextPendingStep, s_lockScreen, and saveDisplayField().

Referenced by showBadgeTextStep().

◆ onBadgeInfoSave()

void cdc::ui::settings::onBadgeInfoSave ( const char * text)
static

Handles save callback for badge info line 1.

Parameters
textSaved text value.
Returns
void

Definition at line 249 of file SettingsHandlers.cpp.

References BADGE_STEP_INFO2, s_badgeTextPendingStep, s_lockScreen, and saveDisplayField().

Referenced by showBadgeTextStep().

◆ onBadgeNameSave()

void cdc::ui::settings::onBadgeNameSave ( const char * text)
static

Handles save callback for badge display name.

Parameters
textSaved text value.
Returns
void

Definition at line 238 of file SettingsHandlers.cpp.

References BADGE_STEP_INFO, s_badgeTextPendingStep, s_lockScreen, and saveDisplayField().

Referenced by showBadgeTextStep().

◆ onBrightnessChange()

void cdc::ui::settings::onBrightnessChange ( uint16_t value)

Applies backlight preview without persisting.

Parameters
valueSlider value in 0..10 scale.
Returns
void

Definition at line 80 of file SettingsHandlers.cpp.

References s_display.

Referenced by cdc::ui::ui_init().

◆ onBrightnessSave()

void cdc::ui::settings::onBrightnessSave ( uint16_t value)

Persists and applies selected backlight value.

Parameters
valueSlider value in 0..10 scale.
Returns
void

Definition at line 68 of file SettingsHandlers.cpp.

References s_display.

Referenced by cdc::ui::ui_init().

◆ onDateConfirm()

void cdc::ui::settings::onDateConfirm ( uint8_t day,
uint8_t month,
uint16_t year )

Applies confirmed date to system time.

Parameters
dayDay value.
monthMonth value.
yearYear value.
Returns
void

Definition at line 146 of file SettingsHandlers.cpp.

Referenced by cdc::ui::ui_init().

◆ onPinChangeComplete()

void cdc::ui::settings::onPinChangeComplete ( bool success)

Handles completion of PIN-change flow.

Parameters
successIndicates whether PIN change succeeded.
Returns
void

Definition at line 185 of file SettingsHandlers.cpp.

References cdc::ui::ViewStack::instance(), and cdc::ui::ViewStack::pop().

Referenced by cdc::ui::ui_init().

◆ onSleepIntervalSave()

void cdc::ui::settings::onSleepIntervalSave ( uint16_t value)

Saves lock-screen sleep interval in minutes.

Parameters
valueSleep interval in minutes.
Returns
void

Definition at line 108 of file SettingsHandlers.cpp.

References s_sleep.

Referenced by cdc::ui::ui_init().

◆ onTimeConfirm()

void cdc::ui::settings::onTimeConfirm ( uint8_t hour,
uint8_t minute )

Applies confirmed time to system clock.

Parameters
hourHour value.
minuteMinute value.
Returns
void

Definition at line 166 of file SettingsHandlers.cpp.

Referenced by cdc::ui::ui_init().

◆ onTimezoneSave()

void cdc::ui::settings::onTimezoneSave ( uint16_t value)

Saves timezone offset and refreshes lock-screen clock.

Parameters
valueSlider value mapped to UTC offset.
Returns
void

Definition at line 119 of file SettingsHandlers.cpp.

References cdc::hal::getRtcInstance(), and s_lockScreen.

Referenced by cdc::ui::ui_init().

◆ processPendingBadgeText()

void cdc::ui::settings::processPendingBadgeText ( )

Processes the next pending badge-text wizard step.

Returns
void

Definition at line 56 of file SettingsHandlers.cpp.

References BADGE_STEP_NONE, s_badgeTextPendingStep, and showBadgeTextStep().

Referenced by cdc::ui::ui_process().

◆ saveDisplayField()

void cdc::ui::settings::saveDisplayField ( const char * key,
const char * value )

Saves one display text field to NVS.

Parameters
keyNVS key for the field.
valueField value to persist.
Returns
void

Definition at line 272 of file SettingsHandlers.cpp.

Referenced by cdc::os_ui::SystemSettingsBackup::importSystemSettings(), onBadgeInfo2Save(), onBadgeInfoSave(), onBadgeNameSave(), and cdc::ui::ui_init().

◆ showBadgeTextStep()

void cdc::ui::settings::showBadgeTextStep ( uint8_t step)
static

Forward declarations for internal helper callbacks.

Shows one step of badge-text wizard.

Parameters
stepWizard step identifier.
Returns
void

Definition at line 203 of file SettingsHandlers.cpp.

References BADGE_STEP_INFO, BADGE_STEP_INFO2, BADGE_STEP_NAME, cdc::ui::LockScreenView::MAX_TEXT_LEN, onBadgeInfo2Save(), onBadgeInfoSave(), onBadgeNameSave(), s_lockScreen, cdc::ui::showT9Input(), and cdc::ui::tr().

Referenced by processPendingBadgeText(), and startBadgeTextEdit().

◆ startBadgeTextEdit()

void cdc::ui::settings::startBadgeTextEdit ( )

Starts badge-text editing wizard.

Returns
void

Definition at line 194 of file SettingsHandlers.cpp.

References BADGE_STEP_NAME, and showBadgeTextStep().

Referenced by cdc::ui::onSettingsSelect().

Variable Documentation

◆ BADGE_STEP_INFO

uint8_t cdc::ui::settings::BADGE_STEP_INFO = 2
staticconstexpr

Definition at line 27 of file SettingsHandlers.cpp.

Referenced by onBadgeNameSave(), and showBadgeTextStep().

◆ BADGE_STEP_INFO2

uint8_t cdc::ui::settings::BADGE_STEP_INFO2 = 3
staticconstexpr

Definition at line 28 of file SettingsHandlers.cpp.

Referenced by onBadgeInfoSave(), and showBadgeTextStep().

◆ BADGE_STEP_NAME

uint8_t cdc::ui::settings::BADGE_STEP_NAME = 1
staticconstexpr

Definition at line 26 of file SettingsHandlers.cpp.

Referenced by showBadgeTextStep(), and startBadgeTextEdit().

◆ BADGE_STEP_NONE

uint8_t cdc::ui::settings::BADGE_STEP_NONE = 0
staticconstexpr

Badge text editing workflow state.

Definition at line 25 of file SettingsHandlers.cpp.

Referenced by onBadgeInfo2Save(), and processPendingBadgeText().

◆ s_badgeTextPendingStep

uint8_t cdc::ui::settings::s_badgeTextPendingStep = BADGE_STEP_NONE
static

◆ s_display

hal::IDisplay* cdc::ui::settings::s_display = nullptr
static

External dependencies injected by AppUi.

Definition at line 18 of file SettingsHandlers.cpp.

Referenced by init(), onBrightnessChange(), and onBrightnessSave().

◆ s_lockScreen

LockScreenView* cdc::ui::settings::s_lockScreen = nullptr
static

◆ s_sleep

hal::ISleepController* cdc::ui::settings::s_sleep = nullptr
static

Definition at line 19 of file SettingsHandlers.cpp.

Referenced by init(), and onSleepIntervalSave().