EEPROM example README redaction
authorNathael Pajani <nathael.pajani@ed3l.fr>
Thu, 3 Nov 2022 16:27:03 +0000 (17:27 +0100)
committerNathael Pajani <nathael.pajani@ed3l.fr>
Tue, 8 Nov 2022 16:14:24 +0000 (17:14 +0100)
eeprom/README

index 0ce0401..decae8e 100644 (file)
@@ -19,6 +19,23 @@ Copyright 2013 Nathael Pajani <nathael.pajani@ed3l.fr>
  *
  *************************************************************************** */
 
-This example shows the support of the onboard I2C eeprom memory
+This example shows the support of the onboard I2C eeprom memory on the
+ GPIO-Demo module from Techno-Innov
+
+The default build will compile the "read eeprom" version of the binary.
+if you want to get the "write eeprom" version you need to build with
+"EEPROM_WRITE" defined (comment or remove the line which undefines it in
+main.c):
+#undef EEPROM_WRITE
+
+Flash and run the "write version" once, which will write the module description
+to the eeprom (MODULE_NAME, MODULE_VERSION, MODULE_SERIAL_NUM, and module
+capabilities), and send "EEPROM Write OK." on UART0 if everything went right.
+
+Then flash and run the "read version", which will read module description from
+the eeprom and display it on UART0:
+
+Module : GPIO Demo Module
+serial number: 42, version: 4, capabilities: 0x0007
+
 
-TODO