Skip to content

Commit 2a19b6f

Browse files
pennampennam
authored
Merge pull request #284 from andreagilardoni/preferences
Preferences api introduction
2 parents f28e72d + 4ff07e7 commit 2a19b6f

File tree

12 files changed

+1363
-61
lines changed

12 files changed

+1363
-61
lines changed

‎.github/workflows/compile-examples.yml

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,26 @@ jobs:
2929

3030
env:
3131
SKETCHES_REPORTS_PATH: sketches-reports
32-
32+
UNIVERSAL_SKETCH_PATHS: |
33+
- examples/AP_SimpleWebServer
34+
- examples/ConnectNoEncryption
35+
- examples/ConnectWithWEP
36+
- examples/ConnectWithWPA
37+
- examples/ConnectWithWPA2Enterprise
38+
- examples/Prefs2Struct
39+
- examples/ScanNetworks
40+
- examples/ScanNetworksAdvanced
41+
- examples/SimpleWebServerWiFi
42+
- examples/WiFiAdvancedChatServer
43+
- examples/WiFiChatServer
44+
- examples/WiFiPing
45+
- examples/WiFiSSLClient
46+
- examples/WiFiStorage
47+
- examples/WiFiUdpNtpClient
48+
- examples/WiFiUdpSendReceiveString
49+
- examples/WiFiWebClient
50+
- examples/WiFiWebClientRepeating
51+
- examples/WiFiWebServer
3352
strategy:
3453
fail-fast: false
3554

@@ -56,6 +75,35 @@ jobs:
5675
- name: arduino:mbed_nano
5776
artifact-name-suffix: arduino-mbed_nano-nanorp2040connect
5877

78+
include:
79+
# mkrwifi1010
80+
- board:
81+
fqbn: arduino:samd:mkrwifi1010
82+
sketch-paths: |
83+
- examples/PreferencesCounter
84+
- examples/PreferencesValidation
85+
# mkrvidor4000
86+
- board:
87+
fqbn: arduino:samd:mkrvidor4000
88+
sketch-paths: |
89+
- examples/PreferencesCounter
90+
- examples/PreferencesValidation
91+
# nano_33_iot
92+
- board:
93+
fqbn: arduino:samd:nano_33_iot
94+
sketch-paths: |
95+
- examples/PreferencesCounter
96+
- examples/PreferencesValidation
97+
# uno2018
98+
- board:
99+
fqbn: arduino:megaavr:uno2018:mode=on
100+
# nanorp2040connect
101+
- board:
102+
fqbn: arduino:mbed_nano:nanorp2040connect
103+
sketch-paths: |
104+
- examples/PreferencesCounter
105+
- examples/PreferencesValidation
106+
59107
steps:
60108
- name: Checkout
61109
uses: actions/checkout@v4
@@ -71,7 +119,7 @@ jobs:
71119
# Install library dependencies.
72120
- name: VidorPeripherals
73121
sketch-paths: |
74-
- ./examples/
122+
${{ matrix.sketch-paths }}
75123
enable-deltas-report: true
76124
sketches-report-path: ${{ env.SKETCHES_REPORTS_PATH }}
77125

‎examples/PreferencesCounter/PreferencesCounter.ino

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
/*
2+
Microcontroller startup counter example with ESP32 Preferences library.
3+
4+
This simple example demonstrates using the Preferences library to store how many times
5+
the microcontroller has booted. The Preferences library is a wrapper around the Non-volatile
6+
storage on ESP32 processor.
7+
8+
created for arduino-esp32 09 Feb 2017
9+
by Martin Sloup (Arcao)
10+
*/
11+
12+
#include <WiFiPreferences.h>
13+
14+
Preferences preferences;
15+
16+
void setup() {
17+
Serial.begin(115200);
18+
while(!Serial);
19+
Serial.println();
20+
21+
// Open Preferences with my-app namespace. Each application module, library, etc
22+
// has to use a namespace name to prevent key name collisions. We will open storage in
23+
// RW-mode (second parameter has to be false).
24+
// Note: Namespace name is limited to 15 chars.
25+
if (!preferences.begin("my-app1", false)) {
26+
Serial.println("Cannot initialize preferences");
27+
Serial.println("Make sure your WiFi firmware version is greater than 0.3.0");
28+
while(1) {};
29+
}
30+
31+
// Serial.println(">Clear");
32+
// preferences.clear();
33+
// Serial.println("<Clear");
34+
35+
36+
// Remove all preferences under the opened namespace
37+
//preferences.clear();
38+
39+
// Or remove the counter key only
40+
//preferences.remove("counter");
41+
42+
// Get the counter value, if the key does not exist, return a default value of 0
43+
// Note: Key name is limited to 15 chars.
44+
unsigned int counter = preferences.getUInt("counter2", 0);
45+
46+
// Increase counter by 1
47+
counter++;
48+
49+
// Print the counter to Serial Monitor
50+
Serial.print("Current counter value: ");
51+
Serial.println(counter, HEX);
52+
53+
// Store the counter to the Preferences
54+
preferences.putUInt("counter2", counter);
55+
56+
// Close the Preferences
57+
preferences.end();
58+
59+
// Wait 10 seconds
60+
Serial.println("Restarting in 10 seconds...");
61+
delay(10000);
62+
63+
// Reset
64+
NVIC_SystemReset();
65+
}
66+
67+
void loop() {}

‎examples/PreferencesValidation/PreferencesValidation.ino

Lines changed: 250 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,250 @@
1+
/*
2+
This example showcases the usage of Preferences api. This is meant to check the apis are working
3+
4+
created for arduino 06/11/2024
5+
by Andrea Gilardoni
6+
*/
7+
#include "test.h"
8+
9+
Preferences preferences;
10+
11+
void setup() {
12+
Serial.begin(115200);
13+
while(!Serial);
14+
Serial.println();
15+
16+
// Open Preferences with my-app namespace. Each application module, library, etc
17+
// has to use a namespace name to prevent key name collisions. We will open storage in
18+
// RW-mode (second parameter has to be false).
19+
// Note: Namespace name is limited to 15 chars.
20+
if (!preferences.begin("my-app", false)) {
21+
Serial.println("Cannot initialize preferences");
22+
Serial.println("Make sure your WiFi firmware version is greater than 0.3.0");
23+
while(1) {};
24+
}
25+
26+
// Remove all preferences under the opened namespace
27+
Serial.print("Clearing content of kvstore: ");
28+
Serial.println(preferences.clear());
29+
30+
Serial.println("Testing Char operations");
31+
if(!test_preferences<char>(0x50,
32+
std::bind(&Preferences::putChar, &preferences, std::placeholders::_1, std::placeholders::_2),
33+
[&preferences](const char* key) { // we need a lambda, because it requires a default value from apis
34+
return preferences.getChar(key);
35+
}, &preferences)) {
36+
37+
Serial.println("Char test failed");
38+
preferences.remove(KEY);
39+
}
40+
41+
Serial.println();
42+
Serial.println();
43+
Serial.println();
44+
45+
Serial.println("Testing UChar operations");
46+
if(!test_preferences<char>(0x50,
47+
std::bind(&Preferences::putUChar, &preferences, std::placeholders::_1, std::placeholders::_2),
48+
[&preferences](const char* key) { // we need a lambda, because it requires a default value from apis
49+
return preferences.getUChar(key);
50+
}, &preferences)) {
51+
52+
Serial.println("UChar test failed");
53+
preferences.remove(KEY);
54+
}
55+
56+
Serial.println();
57+
Serial.println();
58+
Serial.println();
59+
60+
Serial.println("Testing Short operations");
61+
if(!test_preferences<int16_t>(0x5050,
62+
std::bind(&Preferences::putShort, &preferences, std::placeholders::_1, std::placeholders::_2),
63+
[&preferences](const char* key) { // we need a lambda, because it requires a default value from apis
64+
return preferences.getShort(key);
65+
}, &preferences)) {
66+
67+
Serial.println("Short test failed");
68+
preferences.remove(KEY);
69+
}
70+
71+
Serial.println();
72+
Serial.println();
73+
Serial.println();
74+
75+
Serial.println("Testing UShort operations");
76+
if(!test_preferences<uint16_t>(0x5050,
77+
std::bind(&Preferences::putUShort, &preferences, std::placeholders::_1, std::placeholders::_2),
78+
[&preferences](const char* key) { // we need a lambda, because it requires a default value from apis
79+
return preferences.getUShort(key);
80+
}, &preferences)) {
81+
82+
Serial.println("UShort test failed");
83+
preferences.remove(KEY);
84+
}
85+
86+
Serial.println();
87+
Serial.println();
88+
Serial.println();
89+
90+
Serial.println("Testing Int operations");
91+
if(!test_preferences<int32_t>(0x50505050,
92+
std::bind(&Preferences::putInt, &preferences, std::placeholders::_1, std::placeholders::_2),
93+
[&preferences](const char* key) { // we need a lambda, because it requires a default value from apis
94+
return preferences.getInt(key);
95+
}, &preferences)) {
96+
97+
Serial.println("Int test failed");
98+
preferences.remove(KEY);
99+
}
100+
101+
Serial.println();
102+
Serial.println();
103+
Serial.println();
104+
105+
Serial.println("Testing UInt operations");
106+
if(!test_preferences<uint32_t>(0x50505050,
107+
std::bind(&Preferences::putUInt, &preferences, std::placeholders::_1, std::placeholders::_2),
108+
[&preferences](const char* key) { // we need a lambda, because it requires a default value from apis
109+
return preferences.getUInt(key);
110+
}, &preferences)) {
111+
112+
Serial.println("UInt test failed");
113+
preferences.remove(KEY);
114+
}
115+
116+
Serial.println();
117+
Serial.println();
118+
Serial.println();
119+
120+
Serial.println("Testing Long operations");
121+
if(!test_preferences<int32_t>(0x50505050,
122+
std::bind(&Preferences::putLong, &preferences, std::placeholders::_1, std::placeholders::_2),
123+
[&preferences](const char* key) { // we need a lambda, because it requires a default value from apis
124+
return preferences.getLong(key);
125+
}, &preferences)) {
126+
127+
Serial.println("Long test failed");
128+
preferences.remove(KEY);
129+
}
130+
131+
Serial.println();
132+
Serial.println();
133+
Serial.println();
134+
135+
Serial.println("Testing ULong operations");
136+
if(!test_preferences<uint32_t>(0x50505050,
137+
std::bind(&Preferences::putULong, &preferences, std::placeholders::_1, std::placeholders::_2),
138+
[&preferences](const char* key) { // we need a lambda, because it requires a default value from apis
139+
return preferences.getULong(key);
140+
}, &preferences)) {
141+
142+
Serial.println("ULong test failed");
143+
preferences.remove(KEY);
144+
}
145+
146+
Serial.println();
147+
Serial.println();
148+
Serial.println();
149+
150+
Serial.println("Testing Long64 operations");
151+
if(!test_preferences<int64_t>(0x5050505050505050,
152+
std::bind(&Preferences::putLong64, &preferences, std::placeholders::_1, std::placeholders::_2),
153+
[&preferences](const char* key) { // we need a lambda, because it requires a default value from apis
154+
return preferences.getLong64(key);
155+
}, &preferences)) {
156+
157+
Serial.println("Long64 test failed");
158+
preferences.remove(KEY);
159+
}
160+
161+
Serial.println();
162+
Serial.println();
163+
Serial.println();
164+
165+
Serial.println("Testing ULong64 operations");
166+
if(!test_preferences<uint64_t>(0x5050505050505050,
167+
std::bind(&Preferences::putULong64, &preferences, std::placeholders::_1, std::placeholders::_2),
168+
[&preferences](const char* key) { // we need a lambda, because it requires a default value from apis
169+
return preferences.getULong64(key);
170+
}, &preferences)) {
171+
172+
Serial.println("ULong64 test failed");
173+
preferences.remove(KEY);
174+
}
175+
176+
Serial.println();
177+
Serial.println();
178+
Serial.println();
179+
180+
Serial.println("Testing Float operations");
181+
if(!test_preferences<float>(0x50505050,
182+
std::bind(&Preferences::putFloat, &preferences, std::placeholders::_1, std::placeholders::_2),
183+
[&preferences](const char* key) { // we need a lambda, because it requires a default value from apis
184+
return preferences.getFloat(key);
185+
}, &preferences)) {
186+
187+
Serial.println("Float test failed");
188+
preferences.remove(KEY);
189+
}
190+
191+
Serial.println();
192+
Serial.println();
193+
Serial.println();
194+
195+
Serial.println("Testing Double operations");
196+
if(!test_preferences<double>(0x5050505050505050,
197+
std::bind(&Preferences::putDouble, &preferences, std::placeholders::_1, std::placeholders::_2),
198+
[&preferences](const char* key) { // we need a lambda, because it requires a default value from apis
199+
return preferences.getDouble(key);
200+
}, &preferences)) {
201+
202+
Serial.println("Double test failed");
203+
preferences.remove(KEY);
204+
}
205+
206+
Serial.println();
207+
Serial.println();
208+
Serial.println();
209+
210+
Serial.println("Testing Bool operations");
211+
if(!test_preferences<bool>(true,
212+
std::bind(&Preferences::putBool, &preferences, std::placeholders::_1, std::placeholders::_2),
213+
[&preferences](const char* key) { // we need a lambda, because it requires a default value from apis
214+
return preferences.getBool(key);
215+
}, &preferences)) {
216+
217+
Serial.println("Bool test failed");
218+
preferences.remove(KEY);
219+
}
220+
221+
Serial.println();
222+
Serial.println();
223+
Serial.println();
224+
225+
Serial.println("Testing String operations");
226+
if(!test_preferences("la mia stringsa asdasdafasdjdsnajdnaskjlasda\n\n\r\nsdafasdjdsnajdnaskjlasdasdafasdjdsnajdnaskjlasdasdafasdjdsnajdnaskjlasdasdafasdjdsnajdnaskjlasdasdafasdjdsnajdnaskjl\r\nOK\r\nERROR",
227+
&preferences)) {
228+
Serial.println("String test failed");
229+
preferences.remove(KEY);
230+
}
231+
232+
Serial.println();
233+
Serial.println();
234+
Serial.println();
235+
236+
Serial.println("Testing byte buffer operations");
237+
uint8_t buffer[] = {0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F, 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1A, 0x1B, 0x1C, 0x1D, 0x1E, 0x1F, 0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2A, 0x2B, 0x2C, 0x2D, 0x2E, 0x2F, 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3A, 0x3B, 0x3C, 0x3D, 0x3E, 0x3F, 0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48, 0x49, 0x4A, 0x4B, 0x4C, 0x4D, 0x4E, 0x4F, 0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58, 0x59, 0x5A, 0x5B, 0x5C, 0x5D, 0x5E, 0x5F, 0x60, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x6A, 0x6B, 0x6C, 0x6D, 0x6E, 0x6F, 0x70, 0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78, 0x79, 0x7A, 0x7B, 0x7C, 0x7D, 0x7E, 0x7F, 0x80, 0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87, 0x88, 0x89, 0x8A, 0x8B, 0x8C, 0x8D, 0x8E, 0x8F, 0x90, 0x91, 0x92, 0x93, 0x94, 0x95, 0x96, 0x97, 0x98, 0x99, 0x9A, 0x9B, 0x9C, 0x9D, 0x9E, 0x9F, 0xA0, 0xA1, 0xA2, 0xA3, 0xA4, 0xA5, 0xA6, 0xA7, 0xA8, 0xA9, 0xAA, 0xAB, 0xAC, 0xAD, 0xAE, 0xAF, 0xB0, 0xB1, 0xB2, 0xB3, 0xB4, 0xB5, 0xB6, 0xB7, 0xB8, 0xB9, 0xBA, 0xBB, 0xBC, 0xBD, 0xBE, 0xBF, 0xC0, 0xC1, 0xC2, 0xC3, 0xC4, 0xC5, 0xC6, 0xC7, 0xC8, 0xC9, 0xCA, 0xCB, 0xCC, 0xCD, 0xCE, 0xCF, 0xD0, 0xD1, 0xD2, 0xD3, 0xD4, 0xD5, 0xD6, 0xD7, 0xD8, 0xD9, 0xDA, 0xDB, 0xDC, 0xDD, 0xDE, 0xDF, 0xE0, 0xE1, 0xE2, 0xE3, 0xE4, 0xE5, 0xE6, 0xE7, 0xE8, 0xE9, 0xEA, 0xEB, 0xEC, 0xED, 0xEE, 0xEF, 0xF0, 0xF1, 0xF2, 0xF3, 0xF4, 0xF5, 0xF6, 0xF7, 0xF8, 0xF9, 0xFA, 0xFB, 0xFC, 0xFD, 0xFE, 0xFF, 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F, 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1A, 0x1B, 0x1C, 0x1D, 0x1E, 0x1F, 0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2A, 0x2B};
238+
if(!test_preferences(buffer, sizeof(buffer), &preferences)) {
239+
Serial.println("byte buffer test failed");
240+
preferences.remove(KEY);
241+
}
242+
243+
Serial.print("\n\nNumber of free entries: ");
244+
Serial.println(preferences.freeEntries());
245+
246+
preferences.end();
247+
Serial.println("\n\nTesting finished");
248+
}
249+
250+
void loop() {}

0 commit comments

Comments
 (0)