Vamos a programar #96 - Guardando configuraciones en la EEPROM de arduino.

 Hola de nuevo a todos, el día de hoy vamos a continuar con mas sobre la EEPROM de arduino. EN el post anterior vimos cuales son las funciones disponibles para trabajar con ella (y nada mas) pero no vimos ningún ejemplo practico.

Para el ejemplo del día de hoy vamos a suponer que queremos guardar una configuración simple donde solo tenemos dos ajustes. El primero será una cadena de texto de longitud 5 y la segunda un entero (en arduino por default los enteros son de 16 bits para los modelos UNO). Para eso podemos crear código cómo el que sigue.

#include <EEPROM.h>

//Para limpiar la memoria, solo deberia de ser usado una vez
//Se puede quitar los comentarios, compilar y subir a arduino y despues del primer uso 
//Eliminarse o comentarse de nuevo para no gastar la vida util de la memoria EEPROM
// for (int i = 0 ; i < EEPROM.length() ; i++) {
  // EEPROM.write(i, 0);
// }


int CheckData = EEPROM.get(0, CheckData);

struct MySettings{
char MyName[20];
int MyValue;
};

void setup() {
  int Address = 0;

  Serial.begin(9600);
  while (!Serial) {
    ; 
  }

  if (CheckData > -1)
  {
    Serial.println("Al parecer no se guardado la configuracion antes");
    EEPROM.put(Address , int(-1));
    Address += sizeof(CheckData); 
    MySettings SavSettings = {
      "XWORK",
      88
    };
    EEPROM.put(Address , SavSettings);
    Serial.println("Guardado");
  }else{
    Serial.println("Parece haber datos validos de configuracion");
    Address += sizeof(CheckData); 
    MySettings SavSettings;
    EEPROM.get(Address , SavSettings);
    Serial.println(SavSettings.MyName);
    Serial.println(SavSettings.MyValue);
    Serial.println("Cargado");
  }
}

void loop() {


}

Antes que nada, hay que tomar un par de consideraciones. A pesar de que tenemos un numero de "seguridad", lo ideal seria limpiar la memoria EEPROM una vez antes de hacer uso de ella, así sabríamos que es lo que contiene antes de hacer uso de ella, si no lo hacemos, no podemos asegurar que es lo que hay y a la hora de revisar podríamos tener un valor válido para "CheckData" pero no significaría que existan datos útiles para cargar. En los ejemplos de arduino existe un sketch llamado "eeprom_clear" y su función es esa, la de definir todos los bytes a 0. La otra consideración es que usamos directamente las funciones "EEPROM.get()" y "EEPROM.put()" y la ventaja de estas es que acepta tipos y estructuras, pero sobre todo, solo actualiza los valores si son diferentes a los que se encuentran guardados (lo que incrementa el tiempo de vida de la EEPROM).

Ahora si veamos cómo es que funciona el código. Para empezar, primero creamos una variable llamada "CheckData" y su valor será lo que este guardado en la memoria EEPROM en la dirección 0. Hay que recordar que la función "EEPROM.get()" toma dos parámetros, el primero será la dirección en la cual va a leer y el segundo el tamaño de los datos en este caso espera un tipo y "CheckData" es del tipo "int". Una vez que tenemos ese valor, creamos una estructura llamada "MySettings" que contendrá dos campos, el primero un arreglo del tipo "char" con una longitud de 20 llamado "MyName" y el segundo un entero llamado "MyValue" del tipo "int".

Dentro de la función "setup()", lo primero que hacemos es revisar el valor de "CheckData", esta variable la usaremos cómo comprobador, en est caso comprobamos que su valor sea mayor que 0, si es así, asumimos que no hemos guardado los datos antes, por lo que procedemos a hacerlo. Cómo lo primero que hicimos fue cargar el número de comprobación "CheckData", entonces es lo primero que hacemos es guardar esa variable con un valor de -1 en la direccion 0 (para este momento la variable "Address" es 0), una vez que se escribió, hay que movernos. Un poco mas arriba mencioné que Arduino UNO usa dos bytes para guardar los enteros, pero cómo es poco practico movernos "de byte en byte", usaremos la función "sizeof()", esta recibe cómo parámetro un tipo y devuelve su longitud en bytes, entonces lo que hacemos, es simplemente asignar el resultado de la llamada a la función "Address".

Una vez que esta guardado el número de comprobación, podemos guardar nuestros datos, para eso primero creamos una variable de nuestra estructura, en este caso "SavSettings" y le asignamos valores. Con los valores asignados, procedemos a guardarlos usando "EEPROM.put()". Cómo primer parámetro (dirección en donde guardar), le asignaremos la variable "Address" y cómo segundo parámetro, "SavSettings".

Si la comprobación dice que ya hay valores validos, simplemente leemos los datos que estén después de "CheckData" usando "EEPROM.get()" con parámetros "Address" para la dirección y "SavSettings" cómo el tipo que se va a leer. AL finalizar la lectura, simplemente los ponemos en el monitor serie y los mostramos.

Ahora solo a manera de ejemplo, veamos el caso para guardar dos  campos diferentes.

#include <EEPROM.h>

//Para limpiar la memoria, solo deberia de ser usado una vez
//Se puede quitar los comentarios, compilar y subir a arduino y despues del primer uso 
//Eliminarse o comentarse de nuevo para no gastar la vida util de la memoria EEPROM
// for (int i = 0 ; i < EEPROM.length() ; i++) {
  // EEPROM.write(i, 0);
// }


int CheckData = EEPROM.get(0, CheckData);

struct MySettings{
char MyName[20];
int MyValue;
};

void setup() {
  int Address = 0;

  Serial.begin(9600);
  while (!Serial) {
    ; 
  }

  if (CheckData > -1)
  {
    Serial.println("Al parecer no se guardado la configuracion antes");
    EEPROM.put(Address , int(-1));
    Address += sizeof(CheckData); 
    MySettings SavSettings = {
      "XWORK",
      88
    };
    EEPROM.put(Address , SavSettings);
    Address += sizeof(MySettings);
    MySettings SavSettings2 = {
      "MPM88",
      90
    };
    EEPROM.put(Address , SavSettings2);
    Serial.println("Guardado");
  }else{
    Serial.println("Parece haber datos validos de configuracion");
    Address += sizeof(CheckData); 
    MySettings SavSettings;
    MySettings SavSettings2;
    EEPROM.get(Address , SavSettings);
    Serial.println("Datos 1");
    Serial.println(SavSettings.MyName);
    Serial.println(SavSettings.MyValue);
    
    Address += sizeof(MySettings);
    EEPROM.get(Address , SavSettings2);
    Serial.println("Datos 2");
    Serial.println(SavSettings2.MyName);
    Serial.println(SavSettings2.MyValue);
    Serial.println("Cargado");
  }
}

void loop() {

}

Lo importante del ejemplo anterior es que para leer el segundo campo, simplemente debemos de hacer uso de "sizeof()" pasando cómo parámetro la estructura "MySettings" para establecer el inicio de la siguiente dirección.

Y bien, por ahora es todo. Cómo de costumbre, puedes bajar el código de mi dropbox para probarlo.

Los leo luego.