Skip to content

docs: document intentional masking in get_str() behavior #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gdellis merged 1 commit into from
Apr 19, 2026
Merged

docs: document intentional masking in get_str() behavior #72

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions firmware/main/config.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,15 @@ class Config {
static esp_err_t get_spreading_factor (uint8_t& sf);
static esp_err_t set_spreading_factor (uint8_t sf);

/**
* @brief Get device name from NVS
* @param name Buffer to store device name
* @param max_len Maximum buffer size
* @return ESP_OK on success, error code otherwise
* @note If key not found in NVS, returns default name "PetTracker" and ESP_OK.
* Callers who need to distinguish "stored value" vs "default" should use
* nvs_get_str() directly.
*/
static esp_err_t get_device_name (char* name, size_t max_len);
static esp_err_t set_device_name (const char* name);

Expand Down
Loading