update library properties, examples and readme

Author: GogoVega

.github/CODEOWNERS

@@ -4,4 +4,6 @@
 # Permission by file type
 *.cpp   @GogoVega
 *.h     @GogoVega
+*.ino   @GogoVega
+*.json  @GogoVega
 *.md    @GogoVega

README.md

@@ -1,4 +1,4 @@
-# RFIDtoEEPROM
+# RFID to EEPROM
 
 <p align="left">
   <a href="https://github.com/GogoVega/RFIDtoEEPROM/releases/latest">
@@ -14,13 +14,11 @@
 
 Library to write an RFID Code in the [EEPROM](https://docs.arduino.cc/learn/built-in-libraries/eeprom) in order to check if the Code corresponds to a Code already saved.
 
-## Feature
-
-- Compatibility with I2C EEPROM.
-
 ## Usage
 
-This library is used for saving an RFID Code to your Arduino's **internal EEPROM** rather than your Code to avoid **showing your RFID Code**. To then check if the Code corresponds to a Code already registered.
+This library is used for saving an RFID Code to your Arduino's EEPROM or I2C EEPROM rather than your Code to avoid **showing your RFID Code**. To then check if the Code corresponds to a Code already registered.
+
+**Warning:** you must use the same number of bytes in your functions as defined in the Constructor and less than or equal to 16!
 
 ## How To Use
 
@@ -31,12 +29,61 @@ Go to the Libraries Manager on [PlatformIO](https://platformio.org/platformio-id
 Or use `platformIO Core CLI` and paste the following command:
 
 ```bash
-pio lib install "gogovega/RFID to EEPROM@^1.0.0"
+pio lib install "gogovega/RFID to EEPROM@^1.1.0"
 ```
 
 ## How It Works
 
+### Constructor
+
+- Internal EEPROM
+
+```cpp
+RFIDtoEEPROM(uint8_t byteNumber);
+```
+
+- I2C EEPROM
+
+```cpp
+RFIDtoEEPROM_I2C(eeprom_size_t eepromSize, uint8_t address, uint8_t byteNumber);
+```
+
+#### Set I2C BUS Speed
+
+```cpp
+void begin(twiClockFreq_t twiFreq);
+```
+
+#### Enumerations
+Use one of the enumerations below to set EEPROM Size:
+```
+{
+  RFIDtoEEPROM_I2C::kbits_2,
+  RFIDtoEEPROM_I2C::kbits_4,
+  RFIDtoEEPROM_I2C::kbits_8,
+  RFIDtoEEPROM_I2C::kbits_16,
+  RFIDtoEEPROM_I2C::kbits_32,
+  RFIDtoEEPROM_I2C::kbits_64,
+  RFIDtoEEPROM_I2C::kbits_128,
+  RFIDtoEEPROM_I2C::kbits_256,
+  RFIDtoEEPROM_I2C::kbits_512,
+  RFIDtoEEPROM_I2C::kbits_1024,
+  RFIDtoEEPROM_I2C::kbits_2048
+}
+```
+
+And use one of the enumerations below to set twiClock (Wire) Frequence:
+```
+{
+  RFIDtoEEPROM_I2C::twiClock100kHz,
+  RFIDtoEEPROM_I2C::twiClock400kHz
+}
+```
+
+### Functions
+
 This library contains several functions:
+
 | Name | Description |
 |---|---|
 | `CardNumber()` | Returns the number of Cards already registered. |
@@ -46,7 +93,21 @@ This library contains several functions:
 | `EraseAllCards()` | Resets all Cards to 0. |
 | `MaxCards()` | Returns the maximum number of recordable Cards. Currently **set to 255**. |
 
-**Note:** The EEPROM memory has a specified life of 100,000 write/erase cycles, so you may need to be careful about how often you write to it.
+**Note:** The EEPROM memory has a specified life of 100,000 write/erase cycles (depends on models), so you may need to be careful about how often you write to it.
+
+## Tested On
+
+- Atmel AT24C256
+
+## Future Features
+
+- Increase the number of recordable Cards (currently set to 255).
+- Improve error handling.
+
+## Limitations
+
+- The Number of Bytes in the UID must be less than or equal to 16!
+- The Number of recordable Cards is fixed at 255.
 
 ## License
 

docs/platformio.png

@@ -12,9 +12,9 @@
 * - Erase all Cards.
 *
 * Warning: you must use the same number of bytes in your functions as defined
-* in the constructor!
+* in the Constructor and less than or equal to 16!
 *
-* Create april 2022
+* Create April 2022
 *
 * Copyright (c) 2022 Gauthier Dandele
 *
@@ -24,12 +24,20 @@
 #include <RFIDtoEEPROM.h>
 
 #define NUMBYTES 4
-// By default, the Number of Bytes of ID = 4
+
+// By default, the Number of Bytes in the UID = 4
 RFIDtoEEPROM myCard(NUMBYTES);
 
+// Uncomment to use I2C EEPROM (EEPROMSize, I2CAddress, ByteNumber)
+// RFIDtoEEPROM_I2C myCard(RFIDtoEEPROM_I2C::kbits_256, 0x50, NUMBYTES);
+
 void setup() {
   Serial.begin(9600);
 
+  // Uncomment to use I2C EEPROM
+  // Wire.begin();
+  // myCard.begin();
+
   // Erase all Cards
   // myCard.EraseAllCards();
 

examples/basic_example/basic_example.ino

@@ -22,11 +22,10 @@
 *
 * More pin layouts for other boards can be found here: https://github.com/miguelbalboa/rfid#pin-layout
 *
-*
 * Warning: you must use the same number of bytes in your functions as defined
-* in the constructor!
+* in the Constructor and less than or equal to 16!
 *
-* Create april 2022
+* Create April 2022
 *
 * Copyright (c) 2022 Gauthier Dandele
 *
@@ -42,9 +41,12 @@
 
 MFRC522 rfid(SS_PIN, RST_PIN);
 
-// By default, the Number of Bytes of ID = 4
+// By default, the Number of Bytes in the UID = 4
 RFIDtoEEPROM myCard;
 
+// Uncomment to use I2C EEPROM (EEPROMSize, I2CAddress, ByteNumber)
+// RFIDtoEEPROM_I2C myCard(RFIDtoEEPROM_I2C::kbits_256, 0x50, NUMBYTES);
+
 byte Code[4];
 
 void setup() {
@@ -53,6 +55,10 @@ void setup() {
   SPI.begin();
   rfid.PCD_Init();
 
+  // Uncomment to use I2C EEPROM
+  // Wire.begin();
+  // myCard.begin();
+
   // Reset the Number of Cards
   // myCard.ClearCardNumber();
 

examples/mfrc522_example/mfrc522_example.ino

@@ -1,8 +1,8 @@
 {
   "name": "RFID to EEPROM",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Library to write an RFID code in the EEPROM in order to check if the code corresponds to a code already saved.",
-  "keywords": ["rfid", "eeprom"],
+  "keywords": ["rfid", "eeprom", "storage"],
   "repository":
   {
     "type": "git",
@@ -16,5 +16,6 @@
   },
   "license": "MIT",
   "frameworks": "arduino",
-  "platforms": "atmelavr"
+  "platforms": ["atmelavr", "atmelmegaavr", "espressif32", "espressif8266", "raspberrypi"],
+  "headers": "RFIDtoEEPROM.h"
 }

library.json

@@ -37,7 +37,6 @@ RFIDtoEEPROM_I2C::RFIDtoEEPROM_I2C(eeprom_size_t eepromSize, uint8_t address, ui
   _twoAddress = eepromSize > kbits_16 ? true : false;
 }
 
-
 /*!
     @brief Set the I2C communication frequency.
     @param twiFreq Frequency.