Merge branch 'sparkfun:main' into main

Author: giminotron5

.github/workflows/add_issue_to_project.yml

@@ -0,0 +1,18 @@
+name: Add new issue to our main project
+
+on:
+  issues:
+    types:
+      - opened
+
+jobs:
+  add-to-project:
+    name: Add issue to project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/add-to-project@main
+        with:
+          # You can target a project in a different organization
+          # to the issue
+          project-url: https://github.com/orgs/sparkfun/projects/19
+          github-token: ${{ secrets.DEFECT_ADD_TO_PROJECT }}

README.md

@@ -5,13 +5,41 @@ SparkFun External EEPROM Arduino Library
 
 [*SparkFun Qwiic EEPROM (COM-18355)*](https://www.sparkfun.com/products/18355)
 
-A simple to use I2C library for talking to any EEPROM. It uses the same template system found in the Arduino EEPROM library so you can use the same get() and put() functions.
+A simple-to-use I2C library for talking to any EEPROM. It uses the same template system found in the Arduino EEPROM library so you can use the same get() and put() functions.
 
 Various external EEPROMs have various interface specs (overall size, page size, write times, etc). This library works with all types and allows the various settings to be set at runtime. All read and write restrictions associated with pages are taken care of. You can access the external memory as if it was contiguous.
 
-Best used with the Qwiic EEPROM: https://www.sparkfun.com/products/14764
+Once the library has been started, the memory type needs to be set, the following is an example for the [Qwiic 24xx512 EEPROM](https://www.sparkfun.com/products/18355):
 
-For a list of all the EEPROM datasheets, please see [this repo](https://github.com/sparkfun/SparkFun_External_EEPROM_Arduino_Library_Docs). We don't want to store the PDFs in the library repo, otherwise every user will have to download all the PDFs just to install the library.
+    myMem.setMemoryType(512); 
+
+Where *512* is the model (ie, 24LC**512**). Setting the memory type configures the memory size in bytes, the number of address bytes, and the page size in bytes. The following memory types are valid: 0, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1025, 2048
+
+* **0** - 24xx00 / ie [24LC00](https://github.com/sparkfun/SparkFun_External_EEPROM_Arduino_Library_Docs/blob/main/24LC00%20-%20128.pdf)
+* **1** - 24xx01 / ie [24LC01B](https://github.com/sparkfun/SparkFun_External_EEPROM_Arduino_Library_Docs/blob/main/24LC01%20-%201k.pdf)
+* **2** - 24xx02 / ie [24LC02B](https://github.com/sparkfun/SparkFun_External_EEPROM_Arduino_Library_Docs/blob/main/24LC02%20-%202k.pdf)
+* **4** - 24xx04 / ie [CAT24C04](https://github.com/sparkfun/SparkFun_External_EEPROM_Arduino_Library_Docs/blob/main/24LC04%20-%204k%20Onsemi.PDF)
+* **8** - 24xx08 / ie [BR24G08](https://github.com/sparkfun/SparkFun_External_EEPROM_Arduino_Library_Docs/blob/main/24LC08%20-%208k%20Rohm.pdf)
+* **16** - 24xx16 / ie [24AA16](https://github.com/sparkfun/SparkFun_External_EEPROM_Arduino_Library_Docs/blob/main/24LC16%20-%2016k.pdf)
+* **32** - 24xx32 / ie [24LC32A](https://github.com/sparkfun/SparkFun_External_EEPROM_Arduino_Library_Docs/blob/main/24LC32%20-%2032k.pdf)
+* **64** - 24xx64 / ie [24FC64](https://github.com/sparkfun/SparkFun_External_EEPROM_Arduino_Library_Docs/blob/main/24LC64%20-%2064k.pdf)
+* **128** - 24xx128 / ie [24LC128](https://github.com/sparkfun/SparkFun_External_EEPROM_Arduino_Library_Docs/blob/main/24LC128-%20128k.pdf)
+* **256** - 24xx256 / ie [24AA256](https://github.com/sparkfun/SparkFun_External_EEPROM_Arduino_Library_Docs/blob/main/24LC256%20-%20256k.pdf)
+* **512** - 24xx512 / ie [24C512C](https://github.com/sparkfun/SparkFun_External_EEPROM_Arduino_Library_Docs/blob/main/24LC512%20-%20512k.pdf)
+* **1025** - 24xx1025 / ie [24LC1025](https://github.com/sparkfun/SparkFun_External_EEPROM_Arduino_Library_Docs/blob/main/24LC1024%20-%201Mbit.pdf)
+* **2048** - 24xx2048 / ie [AT24CM02](https://github.com/sparkfun/SparkFun_External_EEPROM_Arduino_Library_Docs/blob/main/24LC2048%20-%202Mbit.pdf)
+
+For a list of all the EEPROM datasheets, please see [this repo](https://github.com/sparkfun/SparkFun_External_EEPROM_Arduino_Library_Docs). We don't want to store the PDFs in the library repo, otherwise, every user will have to download all the PDFs just to install the library.
+
+Alternatively, the individual settings can be set. If setMemorySizeBytes/setAddressBytes/setPageSizeBytes() are called, they will overwrite any previous settings set by `setMemoryType()`.
+
+    myMem.setMemorySizeBytes(65536);
+    myMem.setAddressBytes(2); // Set address bytes and page size after MemorySizeBytes()
+    myMem.setPageSizeBytes(128);
+
+Set the memory type, or set the memory settings, but not both.
+
+This library is best used with the [Qwiic EEPROM](https://www.sparkfun.com/products/18355).
 
 This library can be installed via the Arduino Library manager. Search for **SparkFun External EEPROM**.
 

examples/Example1_BasicReadWrite/Example1_BasicReadWrite.ino

@@ -6,7 +6,7 @@
   License: This code is public domain but you buy me a beer if you use this
   and we meet someday (Beerware license).
   Feel like supporting our work? Buy a board from SparkFun!
-  https://www.sparkfun.com/products/14764
+  https://www.sparkfun.com/products/18355
 
   This example demonstrates how to read and write various variables to memory.
 
@@ -48,10 +48,9 @@ void setup()
   // 24xx1025 - 1024000 bit / 128000 byte - 2 address byte, 128 byte page
   // 24xxM02 - 2097152 bit / 262144 byte - 2 address bytes, 256 byte page
 
-  // Valid types: 24xx00, 01, 02, 04, 08, 16, 32, 64, 128, 256, 512, 1025, 2048
-  // myMem.setMemoryType(16); 
+  // Setting the memory type configures the memory size in bytes, the number of address bytes, and the page size in bytes.
 
-  // Default to the Qwiic 24xx512 EEPROM: https://www.sparkfun.com/products/14764
+  // Default to the Qwiic 24xx512 EEPROM: https://www.sparkfun.com/products/18355
   myMem.setMemoryType(512); // Valid types: 0, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1025, 2048
 
   if (myMem.begin() == false)

examples/Example2_AdvancedI2C/Example2_AdvancedI2C.ino

@@ -6,7 +6,7 @@
   License: This code is public domain but you buy me a beer if you use this 
   and we meet someday (Beerware license).
   Feel like supporting our work? Buy a board from SparkFun!
-  https://www.sparkfun.com/products/14764
+  https://www.sparkfun.com/products/18355
 
   This example demonstrates how to pass a custom EEPROM address and Wire.
 
@@ -42,7 +42,7 @@ void setup()
 //  Wire1.setClock(400000); //set I2C communication to 400kHz
   Wire1.begin();
 
-  // Default to the Qwiic 24xx512 EEPROM: https://www.sparkfun.com/products/14764
+  // Default to the Qwiic 24xx512 EEPROM: https://www.sparkfun.com/products/18355
   myMem.setMemoryType(512); // Valid types: 0, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1025, 2048
 
   #define EEPROM_ADDRESS 0b1010001 //0b1010(A2 A1 A0): A standard I2C EEPROM with the ADR0 bit set to VCC

examples/Example3_SettingsStruc/Example3_SettingsStruc.ino

@@ -6,7 +6,7 @@
   License: This code is public domain but you buy me a beer if you use this
   and we meet someday (Beerware license).
   Feel like supporting our work? Buy a board from SparkFun!
-  https://www.sparkfun.com/products/14764
+  https://www.sparkfun.com/products/18355
 
   This example demonstrates how to record various user settings easily to EEPROM.
 
@@ -50,7 +50,7 @@ void setup()
 
   Wire.begin();
 
-  // Default to the Qwiic 24xx512 EEPROM: https://www.sparkfun.com/products/14764
+  // Default to the Qwiic 24xx512 EEPROM: https://www.sparkfun.com/products/18355
   myMem.setMemoryType(512); // Valid types: 0, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1025, 2048
 
   if (myMem.begin() == false)

examples/Example4_DetectSettings/Example4_DetectSettings.ino

@@ -56,9 +56,9 @@ void setup()
   Serial.print("Detected pageSizeBytes: ");
   Serial.println(myMem.detectPageSizeBytes());
 
-  //detectWriteTimeMs is *not* automatically called at begin() and is
-  //generally not needed. Write times are guaranteed to be under 5ms,
-  //and we use polling by default so its use is limited.
+  //The EEPROM write time is 5 ms for all EEPROMs currently manufactured. 
+  //Automatically detecting the write time is therefore not generally needed,
+  //but it's here if needed.
   Serial.print("Detected page write time (ms): ");
   Serial.println(myMem.detectWriteTimeMs());
 

examples/Example7_AutoDetectionTest/Example7_AutoDetectionTest.ino

@@ -126,14 +126,14 @@ void setup()
   myMem.write(0, myValue1); //(location, data)
 
   byte myRead1 = myMem.read(0);
-  Serial.print("I read: ");
+  Serial.print("I read (should be 200): ");
   Serial.println(myRead1);
 
   int myValue2 = -366;
   myMem.put(10, myValue2); //(location, data)
   int myRead2;
   myMem.get(10, myRead2); //location to read, thing to put data into
-  Serial.print("I read: ");
+  Serial.print("I read (should be -366): ");
   Serial.println(myRead2);
 
   if (myMem.getMemorySizeBytes() > 16)
@@ -142,7 +142,7 @@ void setup()
     myMem.put(20, myValue3); //(location, data)
     float myRead3;
     myMem.get(20, myRead3); //location to read, thing to put data into
-    Serial.print("I read: ");
+    Serial.print("I read (should be -7.35): ");
     Serial.println(myRead3);
 
     String myString = "Hi, I am just a simple test string"; //34 characters