fix #83, update readme.md (#85)

- fix #83, update readme.md (thanks to TonyRiddiough)
- add calculatePageSize(deviceSize) to replace getPageSize(deviceSize) prep.
- update GitHub actions
- minor update examples
- minor edits

Author: RobTillaart

.github/workflows/arduino-lint.yml

@@ -6,8 +6,8 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 5
     steps:
-      - uses: actions/checkout@v4
-      - uses: arduino/arduino-lint-action@v1
+      - uses: actions/checkout@v5
+      - uses: arduino/arduino-lint-action@v2
         with:
           library-manager: update
           compliance: strict

.github/workflows/arduino_test_runner.yml

@@ -8,7 +8,7 @@ jobs:
     timeout-minutes: 20
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6

.github/workflows/jsoncheck.yml

@@ -5,13 +5,15 @@ on:
     paths:
       - '**.json'
   pull_request:
+    paths:
+      - '**.json'
 
 jobs:
   test:
     runs-on: ubuntu-latest
     timeout-minutes: 5
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: json-syntax-check
         uses: limitusus/json-syntax-check@v2
         with:

CHANGELOG.md

@@ -6,10 +6,16 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [1.9.4] - 2025-08-27
+- fix #83, update readme.md (thanks to TonyRiddiough)
+- add calculatePageSize(deviceSize) to replace getPageSize(deviceSize) prep.
+- update GitHub actions
+- minor update examples
+- minor edits
+
 ## [1.9.3] - 2025-08-01
 - update readme.md
 
-
 ## [1.9.2] - 2024-11-25
 - fix #79, wrong default in constructor - kudos to ekinohito
 

I2C_eeprom.cpp

@@ -45,7 +45,7 @@ I2C_eeprom::I2C_eeprom(const uint8_t deviceAddress, const uint32_t deviceSize, T
 {
   _deviceAddress = deviceAddress;
   _deviceSize = setDeviceSize(deviceSize);
-  _pageSize = getPageSize(_deviceSize);
+  _pageSize = calculatePageSize(_deviceSize);
   _wire = wire;
 
   //  Chips 16 Kbit (2048 Bytes) or smaller only have one-word addresses.
@@ -296,7 +296,7 @@ bool I2C_eeprom::updateBlockVerify(const uint16_t memoryAddress, const uint8_t *
 //   24LC01      128 B    YES
 uint32_t I2C_eeprom::determineSize(const bool debug)
 {
-  // try to read a byte to see if connected
+  //  try to read a byte to see if connected
   if (! isConnected()) return 0;
 
   uint8_t patAA = 0xAA;
@@ -308,7 +308,7 @@ uint32_t I2C_eeprom::determineSize(const bool debug)
 
     //  store old values
     bool addressSize = _isAddressSizeTwoWords;
-    _isAddressSizeTwoWords = size > I2C_DEVICESIZE_24LC16;  // 2048
+    _isAddressSizeTwoWords = size > I2C_DEVICESIZE_24LC16;  //  2048
     uint8_t buf = readByte(size);
 
     //  test folding
@@ -338,7 +338,7 @@ uint32_t I2C_eeprom::determineSize(const bool debug)
 //  new 1.8.1 #61
 //  updated 1.8.2 #63
 //
-// Returns:
+//  Returns:
 //  0 if device size cannot be determined or device is not online
 //  1 if device has default bytes in first dataFirstBytes bytes [0-BUFSIZE]
 //      Write some dataFirstBytes to the first bytes and retry or use the determineSize method
@@ -402,14 +402,14 @@ uint32_t I2C_eeprom::determineSizeNoWrite()
     _isAddressSizeTwoWords = (size >= I2C_DEVICESIZE_24LC16);  //  == 2048
 
     //  Try to read last byte of the block, should return length of 0 when fails for single byte devices
-    //  Will return the same dataFirstBytes as initially read on other devices 
+    //  Will return the same dataFirstBytes as initially read on other devices
     //  as the data pointer could not be moved to the requested position
     delay(2);
     uint16_t bSize = readBlock(size, dataMatch, BUFSIZE);
 
     if (bSize == BUFSIZE && memcmp(dataFirstBytes, dataMatch, BUFSIZE) != 0)
     {
-        //  Read is performed just over size (size + BUFSIZE), 
+        //  Read is performed just over size (size + BUFSIZE),
         //  this will only work for devices with mem > size;
         //  therefore return size * 2
         _isAddressSizeTwoWords = addressSize;
@@ -433,16 +433,23 @@ uint8_t I2C_eeprom::getPageSize()
 }
 
 
-uint8_t I2C_eeprom::getPageSize(uint32_t deviceSize)
+uint8_t I2C_eeprom::calculatePageSize(uint32_t deviceSize)
 {
     //  determine page size from device size
     //  based on Microchip 24LCXX data sheets.
     if (deviceSize <= I2C_DEVICESIZE_24LC02) return 8;
     if (deviceSize <= I2C_DEVICESIZE_24LC16) return 16;
     if (deviceSize <= I2C_DEVICESIZE_24LC64) return 32;
     if (deviceSize <= I2C_DEVICESIZE_24LC256) return 64;
-    //  I2C_DEVICESIZE_24LC512
-    return 128;
+    if (deviceSize <= I2C_DEVICESIZE_24LC512) return 128;
+    //  Error.
+    return 0;
+}
+
+
+uint8_t I2C_eeprom::getPageSize(uint32_t deviceSize)
+{
+    return calculatePageSize(deviceSize);
 }
 
 
@@ -469,7 +476,7 @@ uint32_t I2C_eeprom::setDeviceSize(uint32_t deviceSize)
 
 uint8_t I2C_eeprom::setPageSize(uint8_t pageSize)
 {
-  // force power of 2.
+  //  force power of 2.
   if (pageSize >= 128) {
       _pageSize = 128;
   }
@@ -616,7 +623,7 @@ int I2C_eeprom::_WriteBlock(const uint16_t memoryAddress, const uint8_t * buffer
 
   _lastWrite = micros();
 
-  yield();     // For OS scheduling
+  yield();     //  For OS scheduling
 
 //  if (rv != 0)
 //  {
@@ -627,7 +634,7 @@ int I2C_eeprom::_WriteBlock(const uint16_t memoryAddress, const uint8_t * buffer
 //      SPRN("\t");
 //      SPRNL(rv);
 //    }
-//    return -(abs(rv));  // error
+//    return -(abs(rv));  //  error
 //  }
   return rv;
 }
@@ -728,9 +735,9 @@ void I2C_eeprom::_waitEEReady()
   {
     if (isConnected()) return;
     //  TODO remove pre 1.7.4 code
-    // _wire->beginTransmission(_deviceAddress);
-    // int x = _wire->endTransmission();
-    // if (x == 0) return;
+    //  _wire->beginTransmission(_deviceAddress);
+    //  int x = _wire->endTransmission();
+    //  if (x == 0) return;
     yield();     //  For OS scheduling
   }
   return;

I2C_eeprom.h

@@ -2,7 +2,7 @@
 //
 //    FILE: I2C_eeprom.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 1.9.3
+// VERSION: 1.9.4
 // PURPOSE: Arduino Library for external I2C EEPROM 24LC256 et al.
 //     URL: https://github.com/RobTillaart/I2C_EEPROM
 
@@ -11,7 +11,7 @@
 #include "Wire.h"
 
 
-#define I2C_EEPROM_VERSION          (F("1.9.3"))
+#define I2C_EEPROM_VERSION          (F("1.9.4"))
 
 #define I2C_DEVICESIZE_24LC512      65536
 #define I2C_DEVICESIZE_24LC256      32768
@@ -74,17 +74,17 @@ class I2C_eeprom
     * It will try to guess page size and address word size based on the size of the device.
     *
     * @param deviceAddress Byte address of the device.
-    * @param deviceSize    Max size in bytes of the device (divide your device size in Kbits by 8)
+    * @param deviceSize    Max size in bytes of the device (divide your device size in Kbits by 8 to get Kbytes)
     * @param wire          Select alternative Wire interface
     */
   I2C_eeprom(const uint8_t deviceAddress, const uint32_t deviceSize, TwoWire *wire = &Wire);
 
-  //  use default I2C pins.
   bool     begin(int8_t writeProtectPin = -1);
   bool     isConnected();
   uint8_t  getAddress();
 
 
+  //  user is responsible that address is in range of the EEPROM used.
   //  writes a byte to memoryAddress
   //  returns I2C status, 0 = OK
   int      writeByte(const uint16_t memoryAddress, const uint8_t value);
@@ -123,11 +123,13 @@ class I2C_eeprom
 
 
   //  Meta data functions
-  uint32_t determineSize(const bool debug = false);
-  uint32_t determineSizeNoWrite();
   uint32_t getDeviceSize();
   uint8_t  getPageSize();
+  uint8_t  calculatePageSize(uint32_t deviceSize);
+  [[deprecated("Use calculatePageSize(deviceSize) instead.")]]
   uint8_t  getPageSize(uint32_t deviceSize);
+  uint32_t determineSizeNoWrite();
+  uint32_t determineSize(const bool debug = false);
   uint32_t getLastWrite();
 
 

I2C_eeprom_cyclic_store.h

@@ -5,6 +5,7 @@
 // VERSION: 1.0.0
 // PURPOSE: Supplemental utility class for I2C_EEPROM library
 //
+//     URL: https://github.com/RobTillaart/I2C_EEPROM
 
 
 #include <I2C_eeprom.h>