aboutsummaryrefslogtreecommitdiff
path: root/libraries/EEPROM/examples/eeprom_reference
diff options
context:
space:
mode:
authorChris--A <chris@genx.biz>2015-03-24 13:58:01 +1000
committerChris--A <chris@genx.biz>2015-03-24 13:58:01 +1000
commit5da9792cd61b5ba9eed9fb80874edb52081d6232 (patch)
tree13ea73606522e092346c2b9c84020870e8efae72 /libraries/EEPROM/examples/eeprom_reference
parent26577474efcb8874dad687467a8ba2f01678ff4c (diff)
Fixed EEPROM examples and added readme
Diffstat (limited to 'libraries/EEPROM/examples/eeprom_reference')
-rw-r--r--libraries/EEPROM/examples/eeprom_reference/eeprom_reference.ino93
1 files changed, 0 insertions, 93 deletions
diff --git a/libraries/EEPROM/examples/eeprom_reference/eeprom_reference.ino b/libraries/EEPROM/examples/eeprom_reference/eeprom_reference.ino
deleted file mode 100644
index bcf84d6..0000000
--- a/libraries/EEPROM/examples/eeprom_reference/eeprom_reference.ino
+++ /dev/null
@@ -1,93 +0,0 @@
-/***
- eeprom_reference example.
-
- This example shows how to use the EEPROM
- reference object EERef, which allows usage
- similar to using a simple char (uint8_t in this case).
-
- Running this sketch is not necessary, this is
- simply highlighting certain programming methods.
-
- Written by Christopher Andrews 2015
- Released under MIT licence.
-***/
-
-#include <EEPROM.h>
-
-void setup() {
-
-
- /***
- To create a reference to an EEPROM cell, simply create an EERef variable.
- To let it know which cell you want to reference, you can simply assign the
- address when you create it.
- ***/
-
- EERef ref = 0;
-
- /***
- An equivalent way is by calling the constructor directly:
- EERef ref( 0 );
- ***/
-
- /** Using the reference **/
-
- /***
- Updating cell data.
- To prevent unnecessary wear on the EEPROM cells
- this function will only write the data when it
- is different to what is already stored.
- ***/
-
- ref.update( 44 ); //May write 44 if not present.
- ref.update( 44 ); //This second call will not write anything.
-
- /***
- Assign values directly to the EEPROM cell.
-
- You can use any form of assignment that would otherwise be available
- to a standard uint8_t:
-
- *=
- /=
- +=
- -=
- ^=
- %=
- &=
- |=
- <<=
- >>=
-
- ***/
-
- ref = 4; /***
- Take care to notice, this changes the EEPROM cell data, it does not
- change the index of the cell referenced by 'ref'.
-
- Only the initial declaration like 'EERef ref = 0;' will set the address.
- Using an assignment anywhere else modifies the referenced cell.
- To modify the referenced address after declaring your variable see below.
- ***/
-
- /***
- Changing the referenced object.
- The class has a member named 'index' which is an integer you can modify.
- ***/
-
- ref.index++; //Move reference to the next cell.
-
-
- /***
- Grouping of references.
-
- Using EERef objects you can create a contiguous array referencing
- non-contiguous EEPROM cells.
- ***/
-
- EERef array[] = { 0, 20, 40, 60, 80 };
-
-
-} //End of setup function.
-
-void loop(){} \ No newline at end of file