Skip to content
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

Create overloads to allow float values to be saved in NVS #349

Merged
merged 3 commits into from
Dec 5, 2024
Merged

Create overloads to allow float values to be saved in NVS #349

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
19cc7e9
Create overloads to allow float values to be saved in NVS
SamAtBackbone Dec 5, 2024
d1e62f1
Remove test for sizeof float = uint32
SamAtBackbone Dec 5, 2024
90a60a0
Move implementation from nvs to nvs_handle
SamAtBackbone Dec 5, 2024
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
57 changes: 57 additions & 0 deletions components/nvs/include/nvs_handle_espp.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,23 @@ class NvsHandle : public BaseComponent {
/// @param[out] ec Saves a std::error_code representing success or failure
void get(std::string_view key, bool &value, std::error_code &ec) { get(key.data(), value, ec); }

/// @brief Reads a float from the NVS
/// @param[in] key NVS Key of the variable to read
/// @param[out] value Float variable to read
/// @param[out] ec Saves a std::error_code representing success or failure
void get(const char *key, float &value, std::error_code &ec) {
uint32_t u32;
get(key, u32, ec);
if(!ec)
memcpy(&value, &u32, sizeof(float));
}

/// @brief Reads a float from the NVS
/// @param[in] key NVS Key of the variable to read
/// @param[out] value Float variable to read
/// @param[out] ec Saves a std::error_code representing success or failure
void get(std::string_view key, float &value, std::error_code &ec) { get(key.data(), value, ec); }

/// @brief Reads a string from the NVS
/// @param[in] key NVS Key of the string to read
/// @param[inout] value string to read
Expand Down Expand Up @@ -206,6 +223,30 @@ class NvsHandle : public BaseComponent {
get(key.data(), value, default_value, ec);
}

/// @brief Reads a float from the NVS
/// @param[in] key NVS Key of the bool to read
/// @param[out] value float to read
/// @param[in] default_value Default value to return if key is not found
/// @param[out] ec Saves a std::error_code representing success or failure
/// @details Read the key/variable pair
void get(const char *key, float &value, const float default_value, std::error_code &ec) {
uint32_t u32;
uint32_t u32_default;
memcpy(&u32_default, &default_value, sizeof(uint32_t));
get(key, u32, u32_default, ec);
if(!ec)
memcpy(&value, &u32, sizeof(float));
}

/// @brief Reads a float from the NVS
/// @param[in] key NVS Key of the float to read
/// @param[out] value float to read
/// @param[in] default_value Default value to return if key is not found
/// @param[out] ec Saves a std::error_code representing success or failure
void get(std::string_view key, float &value, const float default_value, std::error_code &ec) {
get(key.data(), value, default_value, ec);
}

/// @brief Reads a string from the NVS
/// @param[in] key NVS Key of the string to read
/// @param[out] value string to read
Expand Down Expand Up @@ -293,6 +334,22 @@ class NvsHandle : public BaseComponent {
set<uint8_t>(key, u8, ec);
}

/// @brief Set a float in the NVS
/// @param[in] key NVS Key of the float to set
/// @param[in] value float to set
/// @param[out] ec Saves a std::error_code representing success or failure
void set(std::string_view key, float value, std::error_code &ec) { set(key.data(), value, ec); }

/// @brief Set a float in the NVS
/// @param[in] key NVS Key of the float to set
/// @param[in] value float to set
/// @param[out] ec Saves a std::error_code representing success or failure
void set(const char *key, float value, std::error_code &ec) {
uint32_t u32;
memcpy(&u32, &value, sizeof(uint32_t));
set(key, u32, ec);
}

/// @brief Set a string in the NVS
/// @param[in] key NVS Key of the string to set
/// @param[in] value string to set
Expand Down
Loading