forked from espressif/arduino-esp32
Add EEPROMClass and examples (#1034)
* enchanced EEPROMClass * Added eeprom examles and modified partition * added eeprom class and extra examples * No changes * No changes * added eeprom class and examples * fixed typo * length() returns user-defined sector size * updated and annotated example
This commit is contained in:
Ifediora Elochukwu C
committed by
Me No Dev
Me No Dev
parent
694c3a453f
commit
3310e2e31d
@ -1,7 +1,10 @@
|
||||
/*
|
||||
EEPROM.cpp -ported by Paolo Becchi to Esp32
|
||||
Op
|
||||
from esp8266 EEPROM emulation
|
||||
EEPROM.h -ported by Paolo Becchi to Esp32 from esp8266 EEPROM
|
||||
-Modified by Elochukwu Ifediora <ifedioraelochukwuc@gmail.com>
|
||||
|
||||
Uses a one sector flash partition defined in partition table
|
||||
OR
|
||||
Multiple sector flash partitions defined by the name column in the partition table
|
||||
|
||||
Copyright (c) 2014 Ivan Grokhotkov. All rights reserved.
|
||||
This file is part of the esp8266 core for Arduino environment.
|
||||
@ -29,21 +32,37 @@
|
||||
static const char* TAG = "eeprom";
|
||||
|
||||
EEPROMClass::EEPROMClass(uint32_t sector)
|
||||
: _sector(sector)
|
||||
, _data(0)
|
||||
, _size(0)
|
||||
, _dirty(false)
|
||||
: _sector(sector)
|
||||
, _data(0)
|
||||
, _size(0)
|
||||
, _dirty(false)
|
||||
, _name("eeprom")
|
||||
{
|
||||
}
|
||||
|
||||
EEPROMClass::EEPROMClass(const char* name, uint32_t user_defined_size)
|
||||
: _sector(0)
|
||||
, _data(0)
|
||||
, _size(0)
|
||||
, _dirty(false)
|
||||
, _name(name)
|
||||
, _user_defined_size(user_defined_size)
|
||||
{
|
||||
}
|
||||
|
||||
EEPROMClass::EEPROMClass(void)
|
||||
: _sector(0)// (((uint32_t)&_SPIFFS_end - 0x40200000) / SPI_FLASH_SEC_SIZE))
|
||||
, _data(0)
|
||||
, _size(0)
|
||||
, _dirty(false)
|
||||
: _sector(0)// (((uint32_t)&_SPIFFS_end - 0x40200000) / SPI_FLASH_SEC_SIZE))
|
||||
, _data(0)
|
||||
, _size(0)
|
||||
, _dirty(false)
|
||||
, _name("eeprom")
|
||||
{
|
||||
}
|
||||
|
||||
EEPROMClass::~EEPROMClass() {
|
||||
// end();
|
||||
}
|
||||
|
||||
bool EEPROMClass::begin(size_t size) {
|
||||
if (size <= 0) {
|
||||
return false;
|
||||
@ -51,7 +70,8 @@ bool EEPROMClass::begin(size_t size) {
|
||||
if (size > SPI_FLASH_SEC_SIZE) {
|
||||
size = SPI_FLASH_SEC_SIZE;
|
||||
}
|
||||
_mypart = esp_partition_find_first(ESP_PARTITION_TYPE_DATA,ESP_PARTITION_SUBTYPE_ANY, EEPROM_FLASH_PARTITION_NAME);
|
||||
// _mypart = esp_partition_find_first(ESP_PARTITION_TYPE_DATA,ESP_PARTITION_SUBTYPE_ANY, EEPROM_FLASH_PARTITION_NAME);
|
||||
_mypart = esp_partition_find_first(ESP_PARTITION_TYPE_DATA, ESP_PARTITION_SUBTYPE_ANY, _name);
|
||||
if (_mypart == NULL) {
|
||||
return false;
|
||||
}
|
||||
@ -62,12 +82,12 @@ bool EEPROMClass::begin(size_t size) {
|
||||
}
|
||||
|
||||
_data = new uint8_t[size];
|
||||
_size = size;
|
||||
_size = size;
|
||||
bool ret = false;
|
||||
if (esp_partition_read (_mypart,0, (void *) _data,_size)==ESP_OK) {
|
||||
ret=true;
|
||||
if (esp_partition_read (_mypart, 0, (void *) _data, _size) == ESP_OK) {
|
||||
ret = true;
|
||||
}
|
||||
|
||||
|
||||
return ret;
|
||||
}
|
||||
|
||||
@ -98,7 +118,7 @@ uint8_t EEPROMClass::read(int address) {
|
||||
void EEPROMClass::write(int address, uint8_t value) {
|
||||
if (address < 0 || (size_t)address >= _size)
|
||||
return;
|
||||
if(!_data)
|
||||
if (!_data)
|
||||
return;
|
||||
|
||||
// Optimise _dirty. Only flagged if data written is different.
|
||||
@ -121,20 +141,20 @@ bool EEPROMClass::commit() {
|
||||
|
||||
|
||||
if (esp_partition_erase_range(_mypart, 0, SPI_FLASH_SEC_SIZE) != ESP_OK)
|
||||
{
|
||||
log_e( "partition erase err.");
|
||||
{
|
||||
log_e( "partition erase err.");
|
||||
}
|
||||
else
|
||||
{
|
||||
if (esp_partition_write(_mypart, 0, (void *)_data, _size) == ESP_ERR_INVALID_SIZE)
|
||||
{
|
||||
log_e( "error in Write");
|
||||
}
|
||||
else
|
||||
{
|
||||
_dirty = false;
|
||||
ret = true;
|
||||
}
|
||||
if (esp_partition_write(_mypart, 0, (void *)_data, _size) == ESP_ERR_INVALID_SIZE)
|
||||
{
|
||||
log_e( "error in Write");
|
||||
}
|
||||
else
|
||||
{
|
||||
_dirty = false;
|
||||
ret = true;
|
||||
}
|
||||
}
|
||||
|
||||
return ret;
|
||||
@ -145,6 +165,286 @@ uint8_t * EEPROMClass::getDataPtr() {
|
||||
return &_data[0];
|
||||
}
|
||||
|
||||
/*
|
||||
Get EEPROM total size in byte defined by the user
|
||||
*/
|
||||
uint16_t EEPROMClass::length ()
|
||||
{
|
||||
return _user_defined_size;
|
||||
}
|
||||
|
||||
/*
|
||||
Read 'value' from 'address'
|
||||
*/
|
||||
uint8_t EEPROMClass::readByte (int address)
|
||||
{
|
||||
uint8_t value;
|
||||
return EEPROMClass::readAll (address, value);
|
||||
}
|
||||
|
||||
int8_t EEPROMClass::readChar (int address)
|
||||
{
|
||||
int8_t value;
|
||||
return EEPROMClass::readAll (address, value);
|
||||
}
|
||||
|
||||
uint8_t EEPROMClass::readUChar (int address)
|
||||
{
|
||||
uint8_t value;
|
||||
return EEPROMClass::readAll (address, value);
|
||||
}
|
||||
|
||||
int16_t EEPROMClass::readShort (int address)
|
||||
{
|
||||
int16_t value;
|
||||
return EEPROMClass::readAll (address, value);
|
||||
}
|
||||
|
||||
uint16_t EEPROMClass::readUShort (int address)
|
||||
{
|
||||
uint16_t value;
|
||||
return EEPROMClass::readAll (address, value);
|
||||
}
|
||||
|
||||
int32_t EEPROMClass::readInt (int address)
|
||||
{
|
||||
int32_t value;
|
||||
return EEPROMClass::readAll (address, value);
|
||||
}
|
||||
|
||||
uint32_t EEPROMClass::readUInt (int address)
|
||||
{
|
||||
uint32_t value;
|
||||
return EEPROMClass::readAll (address, value);
|
||||
}
|
||||
|
||||
int32_t EEPROMClass::readLong (int address)
|
||||
{
|
||||
int32_t value;
|
||||
return EEPROMClass::readAll (address, value);
|
||||
}
|
||||
|
||||
uint32_t EEPROMClass::readULong (int address)
|
||||
{
|
||||
uint32_t value;
|
||||
return EEPROMClass::readAll (address, value);
|
||||
}
|
||||
|
||||
int64_t EEPROMClass::readLong64 (int address)
|
||||
{
|
||||
int64_t value;
|
||||
return EEPROMClass::readAll (address, value);
|
||||
}
|
||||
|
||||
uint64_t EEPROMClass::readULong64 (int address)
|
||||
{
|
||||
uint64_t value;
|
||||
return EEPROMClass::readAll (address, value);
|
||||
}
|
||||
|
||||
float_t EEPROMClass::readFloat (int address)
|
||||
{
|
||||
float_t value;
|
||||
return EEPROMClass::readAll (address, value);
|
||||
}
|
||||
|
||||
double_t EEPROMClass::readDouble (int address)
|
||||
{
|
||||
double_t value;
|
||||
return EEPROMClass::readAll (address, value);
|
||||
}
|
||||
|
||||
bool EEPROMClass::readBool (int address)
|
||||
{
|
||||
int8_t value;
|
||||
return EEPROMClass::readAll (address, value) ? 1 : 0;
|
||||
}
|
||||
|
||||
size_t EEPROMClass::readString (int address, char* value, size_t maxLen)
|
||||
{
|
||||
if (!value)
|
||||
return 0;
|
||||
|
||||
if (address < 0 || address + maxLen > _size)
|
||||
return 0;
|
||||
|
||||
uint16_t len;
|
||||
for (len = 0; len <= _size; len++)
|
||||
if (_data[address + len] == 0)
|
||||
break;
|
||||
|
||||
if (address + len > _size)
|
||||
return 0;
|
||||
|
||||
memcpy((uint8_t*) value, _data + address, len);
|
||||
return len;
|
||||
}
|
||||
|
||||
String EEPROMClass::readString (int address)
|
||||
{
|
||||
if (address < 0 || address > _size)
|
||||
return String(0);
|
||||
|
||||
uint16_t len;
|
||||
for (len = 0; len <= _size; len++)
|
||||
if (_data[address + len] == 0)
|
||||
break;
|
||||
|
||||
if (address + len > _size)
|
||||
return String(0);
|
||||
|
||||
char value[len + 1];
|
||||
memcpy((uint8_t*) value, _data + address, len);
|
||||
value[len + 1] = 0;
|
||||
return String(value);
|
||||
}
|
||||
|
||||
size_t EEPROMClass::readBytes (int address, void* value, size_t maxLen)
|
||||
{
|
||||
if (!value || !maxLen)
|
||||
return 0;
|
||||
|
||||
if (address < 0 || address + maxLen > _size)
|
||||
return 0;
|
||||
|
||||
memcpy((void*) value, _data + address, maxLen);
|
||||
return maxLen;
|
||||
}
|
||||
|
||||
template <class T> T EEPROMClass::readAll (int address, T &value)
|
||||
{
|
||||
if (address < 0 || address + sizeof(T) > _size)
|
||||
return value;
|
||||
|
||||
memcpy((uint8_t*) &value, _data + address, sizeof(T));
|
||||
return value;
|
||||
}
|
||||
|
||||
/*
|
||||
Write 'value' to 'address'
|
||||
*/
|
||||
size_t EEPROMClass::writeByte (int address, uint8_t value)
|
||||
{
|
||||
return EEPROMClass::writeAll (address, value);
|
||||
}
|
||||
|
||||
size_t EEPROMClass::writeChar (int address, int8_t value)
|
||||
{
|
||||
return EEPROMClass::writeAll (address, value);
|
||||
}
|
||||
|
||||
size_t EEPROMClass::writeUChar (int address, uint8_t value)
|
||||
{
|
||||
return EEPROMClass::writeAll (address, value);
|
||||
}
|
||||
|
||||
size_t EEPROMClass::writeShort (int address, int16_t value)
|
||||
{
|
||||
return EEPROMClass::writeAll (address, value);
|
||||
}
|
||||
|
||||
size_t EEPROMClass::writeUShort (int address, uint16_t value)
|
||||
{
|
||||
return EEPROMClass::writeAll (address, value);
|
||||
}
|
||||
|
||||
size_t EEPROMClass::writeInt (int address, int32_t value)
|
||||
{
|
||||
return EEPROMClass::writeAll (address, value);
|
||||
}
|
||||
|
||||
size_t EEPROMClass::writeUInt (int address, uint32_t value)
|
||||
{
|
||||
return EEPROMClass::writeAll (address, value);
|
||||
}
|
||||
|
||||
size_t EEPROMClass::writeLong (int address, int32_t value)
|
||||
{
|
||||
return EEPROMClass::writeAll (address, value);
|
||||
}
|
||||
|
||||
size_t EEPROMClass::writeULong (int address, uint32_t value)
|
||||
{
|
||||
return EEPROMClass::writeAll (address, value);
|
||||
}
|
||||
|
||||
size_t EEPROMClass::writeLong64 (int address, int64_t value)
|
||||
{
|
||||
return EEPROMClass::writeAll (address, value);
|
||||
}
|
||||
|
||||
size_t EEPROMClass::writeULong64 (int address, uint64_t value)
|
||||
{
|
||||
return EEPROMClass::writeAll (address, value);
|
||||
}
|
||||
|
||||
size_t EEPROMClass::writeFloat (int address, float_t value)
|
||||
{
|
||||
return EEPROMClass::writeAll (address, value);
|
||||
}
|
||||
|
||||
size_t EEPROMClass::writeDouble (int address, double_t value)
|
||||
{
|
||||
return EEPROMClass::writeAll (address, value);
|
||||
}
|
||||
|
||||
size_t EEPROMClass::writeBool (int address, bool value)
|
||||
{
|
||||
int8_t Bool;
|
||||
value ? Bool = 1 : Bool = 0;
|
||||
return EEPROMClass::writeAll (address, Bool);
|
||||
}
|
||||
|
||||
size_t EEPROMClass::writeString (int address, const char* value)
|
||||
{
|
||||
if (!value)
|
||||
return 0;
|
||||
|
||||
if (address < 0 || address > _size)
|
||||
return 0;
|
||||
|
||||
uint16_t len;
|
||||
for (len = 0; len <= _size; len++)
|
||||
if (value[len] == 0)
|
||||
break;
|
||||
|
||||
if (address + len > _size)
|
||||
return 0;
|
||||
|
||||
memcpy(_data + address, (const uint8_t*) value, len + 1);
|
||||
_dirty = true;
|
||||
return strlen(value);
|
||||
}
|
||||
|
||||
size_t EEPROMClass::writeString (int address, String value)
|
||||
{
|
||||
return EEPROMClass::writeString (address, value.c_str());
|
||||
}
|
||||
|
||||
size_t EEPROMClass::writeBytes (int address, const void* value, size_t len)
|
||||
{
|
||||
if (!value || !len)
|
||||
return 0;
|
||||
|
||||
if (address < 0 || address + len > _size)
|
||||
return 0;
|
||||
|
||||
memcpy(_data + address, (const void*) value, len);
|
||||
_dirty = true;
|
||||
return len;
|
||||
}
|
||||
|
||||
template <class T> T EEPROMClass::writeAll (int address, const T &value)
|
||||
{
|
||||
if (address < 0 || address + sizeof(T) > _size)
|
||||
return value;
|
||||
|
||||
memcpy(_data + address, (const uint8_t*) &value, sizeof(T));
|
||||
_dirty = true;
|
||||
|
||||
return sizeof (value);
|
||||
}
|
||||
|
||||
#if !defined(NO_GLOBAL_INSTANCES) && !defined(NO_GLOBAL_EEPROM)
|
||||
EEPROMClass EEPROM;
|
||||
#endif
|
||||
|
||||
Reference in New Issue
Block a user