Lưu cài đặt trên ESP32 bằng Preferences
Hoặc xem mọi bài học.
- 526linh kiện trên bàn làm mạch
- 46bo mạch đang chạy
- 1.00xthời gian thực, trên mọi bo mạch
Thư viện Preferences là cách một sketch ESP32 ghi nhớ một số hay một chuỗi sau khi mất điện: mật khẩu WiFi, giá trị hiệu chuẩn, một bộ đếm. Nó đi kèm core ESP32 nên không cần cài gì. Bạn mở một namespace bằng begin(), lưu và đọc giá trị theo khóa bằng các lệnh put và get đúng kiểu, rồi đóng bằng end(). Bên dưới, giá trị nằm trong NVS, một kho khóa-giá trị nhỏ trong flash.
Mạch ở trên chỉ là một ESP32 DevKit; Serial Monitor là toàn bộ giao diện. Bên dưới là bộ đếm khởi động kinh điển, chuỗi với giá trị mặc định, các quy tắc khiến put trả về 0, và so sánh với EEPROM.
Bộ đếm khởi động
Đây là ví dụ hầu hết tutorial bắt đầu. begin("my-app", false) mở namespace "my-app" để ghi, tạo nó lần đầu. getUInt("counter", 0) đọc khóa, hoặc 0 nếu chưa có. Sketch cộng một, in ra, lưu bằng putUInt() rồi đóng namespace.
Trên bo mạch, mỗi lần reset và mỗi lần mất điện in ra số tiếp theo. Ở đây lần chạy đầu in "Boot count: 1", và với ESP.restart() sau mỗi lần đếm nó in "Boot count: 2" rồi "Boot count: 3", vì khởi động lại vẫn giữ giá trị đã lưu. ESP32 của Mokxi không có flash phía sau, nên Preferences nằm trong RAM: chúng sống sót qua ESP.restart(), còn một lần Chạy mới hay nút EN thì bắt đầu lại từ 1. Các lệnh và kết quả là của core; chỉ thời gian sống là ngắn hơn.
#include <Preferences.h>
Preferences prefs;
void setup() {
Serial.begin(115200);
prefs.begin("my-app", false);
unsigned int count = prefs.getUInt("counter", 0);
count++;
Serial.printf("Boot count: %u\n", count);
prefs.putUInt("counter", count);
prefs.end();
if (count < 3) {
delay(100);
ESP.restart();
}
}
void loop() {
}Mở sketch này trong trình soạn codeChỉ riêng phần code: trình soạn code sẽ tự đặt bo mạch và các linh kiện mà nó đọc được từ sketch.
Chuỗi, giá trị mặc định và các kiểu khác
Mỗi kiểu có cặp lệnh riêng: putInt/getInt, putUInt, putLong, putFloat, putBool, putString/getString và putBytes cho struct. Đọc một khóa bằng đúng kiểu đã lưu. Một float lưu bằng putFloat("t", 21.5) đọc lại từ getFloat("t", 0) được 21.50.
Mọi lệnh get nhận một giá trị mặc định, trả về khi khóa chưa có, nên lần chạy đầu của sketch không cần xử lý riêng. Sau putString("ssid", "HomeNet"), getString("ssid", "none") in "HomeNet" còn getString("pass", "none") in "none". Đó là mẫu cho cài đặt WiFi: đọc với giá trị mặc định trong setup(), chỉ hỏi lại khi nhận được mặc định.
isKey("ssid") in 1 khi khóa còn tồn tại; sau remove("ssid") nó in 0. clear() xóa mọi khóa trong namespace đang mở và không đụng đến các khóa khác.
#include <Preferences.h>
Preferences prefs;
void setup() {
Serial.begin(115200);
prefs.begin("wifi", false);
prefs.putString("ssid", "HomeNet");
Serial.println(prefs.getString("ssid", "none"));
Serial.println(prefs.getString("pass", "none"));
Serial.println(prefs.isKey("ssid"));
prefs.remove("ssid");
Serial.println(prefs.isKey("ssid"));
prefs.end();
}
void loop() {
}Mở sketch này trong trình soạn codeChỉ riêng phần code: trình soạn code sẽ tự đặt bo mạch và các linh kiện mà nó đọc được từ sketch.
Lưu cả struct bằng putBytes
Khi một sketch có nhiều thiết lập, gom chúng vào một struct và lưu bằng một lệnh duy nhất sẽ gọn gàng hơn là dùng một key cho từng thiết lập. putBytes(key, &settings, sizeof(settings)) lưu các byte của struct đúng như chúng nằm trong bộ nhớ, còn getBytes(key, &settings, sizeof(settings)) sao chép chúng trở lại. Cả hai đều trả về số byte đã di chuyển. Trong sketch dưới đây, mỗi lệnh trả về 8, tức kích thước của một int và một float trên ESP32, và struct đọc lại có brightness là 180 và offset là -1.50.
Hãy so getBytesLength(key) với sizeof trước khi tin vào giá trị đọc được. Nếu sau này bạn thêm một trường vào struct, bản đã lưu từ phiên bản cũ sẽ ngắn hơn, và khi đọc nó, trường mới sẽ giữ nguyên giá trị cũ trong bộ nhớ. Ở lần chạy đầu tiên, key chưa tồn tại, getBytesLength() trả về 0, và sketch giữ lại các giá trị mặc định ban đầu. Ở đây nó in ra 0 trước lần put đầu tiên và 8 sau đó.
#include <Preferences.h>
struct Settings {
int brightness;
float offset;
};
Preferences prefs;
Settings settings = {128, 0.0};
void setup() {
Serial.begin(115200);
prefs.begin("my-app", false);
Serial.println(prefs.getBytesLength("settings"));
Settings changed = {180, -1.5};
Serial.println(prefs.putBytes("settings", &changed, sizeof(changed)));
Serial.println(prefs.getBytesLength("settings"));
if (prefs.getBytesLength("settings") == sizeof(settings)) {
Serial.println(prefs.getBytes("settings", &settings, sizeof(settings)));
}
Serial.println(settings.brightness);
Serial.println(settings.offset);
prefs.end();
}
void loop() {
}Mở sketch này trong trình soạn codeChỉ riêng phần code: trình soạn code sẽ tự đặt bo mạch và các linh kiện mà nó đọc được từ sketch.
Khi một put trả về 0
Mỗi lệnh put trả về số byte đã lưu, và 0 khi không lưu gì. putUInt() trả về 4 với một key hợp lệ. Bốn lỗi khiến nó trả về 0, và mỗi lỗi đều được tạo ra cố ý ở đây:
A key longer than 15 characters. "key_with_15chrs" stored 4 bytes; "a_key_with_16chr", one character longer, returned 0. Namespaces have the same limit, and begin("a_namespace_too_long", false) returned 0, so every call after it failed too. A namespace opened read-only: after begin("wifi", true), putUInt("x", 1) returned 0 while gets still worked. And no begin() at all: putUInt("x", 1) returned 0 and getUInt("x", 7) gave back the default, 7.
Key thuộc về từng namespace. Một key lưu dưới "wifi" sẽ không tìm thấy được từ "other", vốn trả về giá trị mặc định là 99. Hai thư viện có thể cùng dùng một key tên "mode" mà không xung đột, miễn là chúng dùng các namespace khác nhau.
Preferences hay EEPROM trên ESP32?
ESP32 không có chip EEPROM. EEPROM.h trên ESP32 được mô phỏng trong một partition của flash: bạn phải gọi EEPROM.begin(size) trước và EEPROM.commit() sau khi ghi, nếu không sẽ không có gì được lưu. Ở đây EEPROM.write(0, 42), rồi commit(), trả về 1, và read(0) cho ra 42. Nó tồn tại cho các sketch chuyển từ Uno sang.
Với code mới, Preferences là lựa chọn tốt hơn. Bạn lưu theo tên thay vì theo địa chỉ, mỗi giá trị giữ nguyên kiểu của nó, và NVS phân tán các lần ghi ra các trang của partition, điều này quan trọng vì flash sẽ hỏng sau nhiều chu kỳ xóa. Dù dùng cách nào, hãy chỉ ghi khi một giá trị thay đổi, chứ không phải ở mỗi vòng lặp loop().
Mở mạch này trong trình soạn thảo. ESP32 DevKit: Serial Monitor, được nối như khi nó chạy ở đầu trang này. Hãy thay đổi một linh kiện hoặc một giá trị rồi chạy lại.
Câu hỏi
Thư viện ESP32 Preferences lưu dữ liệu ở đâu?
Trong NVS, một kho key-value nằm trong một partition của flash, nên các giá trị vẫn còn sau khi reset hoặc mất điện. Trong Mokxi chúng được giữ trong RAM, sống sót qua ESP.restart() nhưng không qua một lần Chạy mới.
Why does my Preferences put return 0?
Key hoặc namespace dài hơn 15 ký tự, begin() chưa được gọi hoặc thất bại, hoặc namespace được mở chỉ đọc bằng begin(name, true).
Làm thế nào để lưu một chuỗi với ESP32 Preferences?
prefs.putString("ssid", value) để lưu và prefs.getString("ssid", "none") để đọc lại, với "none" được trả về khi nó chưa từng được lưu.
Nên dùng Preferences hay EEPROM trên ESP32?
Preferences. ESP32 không có EEPROM, và EEPROM.h chỉ mô phỏng một EEPROM trong flash và cần commit(). Preferences lưu các giá trị có kiểu, theo tên.
Link ESP32 preferences cho Arduino IDE là gì?
Đó là URL của boards manager, đặt vào cửa sổ Preferences của chính IDE: https://espressif.github.io/arduino-esp32/package_esp32_index.json, theo hướng dẫn cài đặt của Espressif.
Tiếp tục nào
Thông tin trên trang này lấy từ đâu
Lắp mạch này ngoài đời
Mở trình soạn thảo, đổi một giá trị và xem con số thay đổi theo. Không cần cài gì, không cần tài khoản.