Skip to content

Added isKey method to Preferences #4441

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
merged 6 commits into from
Nov 3, 2020
Merged

Added isKey method to Preferences #4441

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1e4f2c7
Added isKey method to Preferences
lbernstone Oct 24, 2020
754f629
Changed to assert against ESP_OK
lbernstone Oct 26, 2020
6480c97
Merge branch 'master' into Prefs_isKey
me-no-dev Nov 3, 2020
0cf8fbb
Update Preferences.h
me-no-dev Nov 3, 2020
947ea9c
Update Preferences.cpp
me-no-dev Nov 3, 2020
1f7f250
Added a check that key length is <16
lbernstone Nov 3, 2020
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
22 changes: 21 additions & 1 deletion libraries/Preferences/src/Preferences.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

#include "nvs.h"

const char * nvs_errors[] = { "OTHER", "NOT_INITIALIZED", "NOT_FOUND", "TYPE_MISMATCH", "READ_ONLY", "NOT_ENOUGH_SPACE", "INVALID_NAME", "INVALID_HANDLE", "REMOVE_FAILED", "KEY_TOO_LONG", "PAGE_FULL", "INVALID_STATE", "INVALID_LENGHT"};
const char * nvs_errors[] = { "OTHER", "NOT_INITIALIZED", "NOT_FOUND", "TYPE_MISMATCH", "READ_ONLY", "NOT_ENOUGH_SPACE", "INVALID_NAME", "INVALID_HANDLE", "REMOVE_FAILED", "KEY_TOO_LONG", "PAGE_FULL", "INVALID_STATE", "INVALID_LENGTH"};
#define nvs_error(e) (((e)>ESP_ERR_NVS_BASE)?nvs_errors[(e)&~(ESP_ERR_NVS_BASE)]:nvs_errors[0])

Preferences::Preferences()
Expand Down Expand Up @@ -280,6 +280,26 @@ size_t Preferences::putBytes(const char* key, const void* value, size_t len){
return len;
}

bool Preferences::isKey(const char* key) {
if(!_started || !key){
return false;
}
int8_t mt1; uint8_t mt2; int16_t mt3; uint16_t mt4;
int32_t mt5; uint32_t mt6; int64_t mt7; uint64_t mt8;
size_t len = 0;
if(!nvs_get_i8(_handle, key, &mt1)) return true;
if(!nvs_get_u8(_handle, key, &mt2)) return true;
if(!nvs_get_i16(_handle, key, &mt3)) return true;
if(!nvs_get_u16(_handle, key, &mt4)) return true;
if(!nvs_get_i32(_handle, key, &mt5)) return true;
if(!nvs_get_u32(_handle, key, &mt6)) return true;
if(!nvs_get_i64(_handle, key, &mt7)) return true;
if(!nvs_get_u64(_handle, key, &mt8)) return true;
if(!nvs_get_str(_handle, key, NULL, &len)) return true;
if(!nvs_get_blob(_handle, key, NULL, &len)) return true;
return false;
}

/*
* Get a key value
* */
Expand Down
3 changes: 2 additions & 1 deletion libraries/Preferences/src/Preferences.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ class Preferences {
size_t putString(const char* key, String value);
size_t putBytes(const char* key, const void* value, size_t len);

bool isKey(const char* key);
int8_t getChar(const char* key, int8_t defaultValue = 0);
uint8_t getUChar(const char* key, uint8_t defaultValue = 0);
int16_t getShort(const char* key, int16_t defaultValue = 0);
Expand All @@ -63,7 +64,7 @@ class Preferences {
bool getBool(const char* key, bool defaultValue = false);
size_t getString(const char* key, char* value, size_t maxLen);
String getString(const char* key, String defaultValue = String());
size_t getBytesLength(const char* key);
size_t getBytesLength(const char* key);
size_t getBytes(const char* key, void * buf, size_t maxLen);
size_t freeEntries();
};
Expand Down