fix #42 ReadObject, WriteObject (#43)

- fix #42 ReadObject, WriteObject for FRAM32
- add examples
- minor edits

CHANGELOG.md

@@ -5,6 +5,13 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [0.5.4] - 2023-09-16
+- fix #42 ReadObject, WriteObject for FRAM32
+- add examples
+- minor edits
+
+----
+
 ## [0.5.4] - 2023-09-04
 - merge #39 add **read64(), write64()**  (kudos to pvogt09)
 - merge #40 add **MB85RC64V** info (kudos to pvogt09)
@@ -15,7 +22,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - improved readability parameter names
 - update readme.md
 
-
 ## [0.5.3] - 2023-04-28
 - major redo FRAM9 and FRAM11, see #35
 - update FRAM32 to match FRAM

FRAM.cpp

@@ -1,7 +1,7 @@
 //
 //    FILE: FRAM.cpp
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.5.4
+// VERSION: 0.6.0
 //    DATE: 2018-01-24
 // PURPOSE: Arduino library for I2C FRAM
 //     URL: https://github.com/RobTillaart/FRAM_I2C
@@ -346,12 +346,12 @@ void FRAM::sleep()
 
 
 //  page 12 datasheet   trec <= 400us
-bool FRAM::wakeup(uint32_t trec)
+bool FRAM::wakeup(uint32_t timeRecover)
 {
   bool b = isConnected();  //  wakeup
-  if (trec == 0) return b;
+  if (timeRecover == 0) return b;
   //  wait recovery time
-  delayMicroseconds(trec);
+  delayMicroseconds(timeRecover);
   return isConnected();    //  check recovery OK
 }
 
@@ -586,20 +586,6 @@ int32_t FRAM32::readLine(uint32_t memAddr, char * buffer, uint16_t bufferLength)
 }
 
 
-template <class T> uint32_t FRAM32::writeObject(uint32_t memAddr, T &obj)
-{
-  write(memAddr, (uint8_t *) &obj, sizeof(obj));
-  return memAddr + sizeof(obj);
-};
-
-
-template <class T> uint32_t FRAM32::readObject(uint32_t memAddr, T &obj)
-{
-  read(memAddr, (uint8_t *) &obj, sizeof(obj));
-  return memAddr + sizeof(obj);
-}
-
-
 uint32_t FRAM32::clear(uint8_t value)
 {
   uint8_t buffer[16];

FRAM.h

@@ -2,7 +2,7 @@
 //
 //    FILE: FRAM.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.5.4
+// VERSION: 0.6.0
 //    DATE: 2018-01-24
 // PURPOSE: Arduino library for I2C FRAM
 //     URL: https://github.com/RobTillaart/FRAM_I2C
@@ -12,7 +12,7 @@
 #include "Wire.h"
 
 
-#define FRAM_LIB_VERSION              (F("0.5.4"))
+#define FRAM_LIB_VERSION              (F("0.6.0"))
 
 
 #define FRAM_OK                         0
@@ -83,6 +83,7 @@ class FRAM
   int32_t readLine(uint16_t memAddr, char * buffer, uint16_t bufferLength);
 
 
+  //  template function must be in .h file
   template <class T> uint16_t writeObject(uint16_t memAddr, T &obj)
   {
     write(memAddr, (uint8_t *) &obj, sizeof(obj));
@@ -117,11 +118,10 @@ class FRAM
   void     setSizeBytes(uint32_t value);
 
 
-
   //  SLEEP - 0.3.6
   void sleep();
-  //  trec <= 400us  P12
-  bool wakeup(uint32_t trec = 400);
+  //  timeRecover <= 400us  see trec P12
+  bool wakeup(uint32_t timeRecover = 400);
 
 
 protected:
@@ -173,8 +173,19 @@ class FRAM32 : public FRAM
   //  buffer needs one place for end char '\0'.
   int32_t readLine(uint32_t memAddr, char * buffer, uint16_t bufferLength);
 
-  template <class T> uint32_t writeObject(uint32_t memAddr, T &obj);
-  template <class T> uint32_t readObject(uint32_t memAddr, T &obj);
+
+  //  template function must be in .h file
+  template <class T> uint32_t writeObject(uint32_t memAddr, T &obj)
+  {
+    write(memAddr, (uint8_t *) &obj, sizeof(obj));
+    return memAddr + sizeof(obj);
+  };
+
+  template <class T> uint32_t readObject(uint32_t memAddr, T &obj)
+  {
+    read(memAddr, (uint8_t *) &obj, sizeof(obj));
+    return memAddr + sizeof(obj);
+  }
 
   uint32_t clear(uint8_t value = 0);  // fills FRAM with value
 

README.md

@@ -121,7 +121,7 @@ In the **FRAM32** class these functions have an **uin32_t memAddr**.
   - **clear()** does not work for **MB85RC128A** unless **setSizeBytes()** is used.
 
 
-(Template functions, see issue #13)
+(Template functions, see issue #13, #42)
 - **uint16_t writeObject(uint16_t memAddr, T &obj)** writes an object to memAddr (and following bytes).
   - Returns memAddr + sizeof(obj) to get the next address to write to.
 - **uint16_t readObject(uint16_t memAddr, T &obj)** reads an object from memAddr and next bytes.
@@ -177,7 +177,6 @@ Will work only if a writeProtectPin was defined in **begin()**
   - Returns false if the writeProtectPin was not defined.
 
 
-
 ### Metadata
 
 These may not work for devices that have no **deviceID** register.  

examples/FRAM11_writeObject/FRAM11_writeObject.ino

@@ -0,0 +1,90 @@
+//
+//    FILE: FRAM11_writeObject.ino
+//  AUTHOR: Rob Tillaart
+// PURPOSE: demo writing reading objects
+//     URL: https://github.com/RobTillaart/FRAM_I2C
+//
+// experimental
+
+
+#include "FRAM.h"
+
+FRAM11 fram;
+
+uint32_t start;
+uint32_t stop;
+
+uint32_t sizeInBytes = 0;
+
+
+void setup()
+{
+  Serial.begin(115200);
+  Serial.println(__FILE__);
+  Serial.print("FRAM_LIB_VERSION: ");
+  Serial.println(FRAM_LIB_VERSION);
+
+  Wire.begin();
+
+  int rv = fram.begin(0x50);
+  if (rv != 0)
+  {
+    Serial.print("INIT ERROR: ");
+    Serial.println(rv);
+  }
+
+  //  get size in bytes
+  sizeInBytes = fram.getSize() * 1024;
+  //  clear FRAM
+  for (uint32_t addr = 0; addr < sizeInBytes; addr++)
+  {
+    fram.write8(addr, 0x00);
+  }
+
+  test_float();
+  test_struct();
+
+}
+
+
+void loop()
+{
+}
+
+
+void test_float()
+{
+  float x = 3.14159265;
+  Serial.println(x, 6);
+  fram.writeObject(100, x);
+
+  x = 1.0/x;
+  Serial.println(x, 6);
+
+  fram.readObject(100, x);
+  Serial.println(x, 6);
+}
+
+struct point
+{
+  float x;
+  float y;
+  float z;
+} P = {3.91, 5.24, 7.58};
+
+void test_struct()
+{
+  Serial.println(P.x);
+  Serial.println(P.y);
+  Serial.println(P.z);
+  fram.writeObject(50, P);
+
+  struct point Q;
+  fram.readObject(50, Q);
+  Serial.println(Q.x);
+  Serial.println(Q.y);
+  Serial.println(Q.z);
+}
+
+
+// -- END OF FILE --

examples/FRAM32_Performance/FRAM32_Performance.ino

@@ -14,7 +14,7 @@ FRAM32 fram;
 uint32_t start;
 uint32_t stop;
 
-int ar[600];  // 1200 bytes
+int ar[600];  //  1200 bytes
 
 
 void setup()
@@ -35,7 +35,7 @@ void setup()
   }
   else
   {
-    for (int s = 1; s < 9; s++)  // test up to 800 KB
+    for (int s = 1; s < 9; s++)  //  test up to 800 KB
     {
       uint32_t speed = s * 100000UL;
       Serial.print("CLOCK: ");
@@ -94,4 +94,4 @@ void testReadWriteLarge()
 }
 
 
-// -- END OF FILE --
+//  -- END OF FILE --

examples/FRAM32_writeObject/FRAM32_writeObject.ino

@@ -0,0 +1,90 @@
+//
+//    FILE: FRAM32_writeObject.ino
+//  AUTHOR: Rob Tillaart
+// PURPOSE: demo writing reading objects
+//     URL: https://github.com/RobTillaart/FRAM_I2C
+//
+// experimental
+
+
+#include "FRAM.h"
+
+FRAM32 fram;
+
+uint32_t start;
+uint32_t stop;
+
+uint32_t sizeInBytes = 0;
+
+
+void setup()
+{
+  Serial.begin(115200);
+  Serial.println(__FILE__);
+  Serial.print("FRAM_LIB_VERSION: ");
+  Serial.println(FRAM_LIB_VERSION);
+
+  Wire.begin();
+
+  int rv = fram.begin(0x50);
+  if (rv != 0)
+  {
+    Serial.print("INIT ERROR: ");
+    Serial.println(rv);
+  }
+
+  //  get size in bytes
+  sizeInBytes = fram.getSize() * 1024;
+  //  clear FRAM
+  for (uint32_t addr = 0; addr < sizeInBytes; addr++)
+  {
+    fram.write8(addr, 0x00);
+  }
+
+  test_float();
+  test_struct();
+
+}
+
+
+void loop()
+{
+}
+
+
+void test_float()
+{
+  float x = 3.14159265;
+  Serial.println(x, 6);
+  fram.writeObject(100, x);
+
+  x = 1.0/x;
+  Serial.println(x, 6);
+
+  fram.readObject(100, x);
+  Serial.println(x, 6);
+}
+
+struct point
+{
+  float x;
+  float y;
+  float z;
+} P = {3.91, 5.24, 7.58};
+
+void test_struct()
+{
+  Serial.println(P.x);
+  Serial.println(P.y);
+  Serial.println(P.z);
+  fram.writeObject(50, P);
+
+  struct point Q;
+  fram.readObject(50, Q);
+  Serial.println(Q.x);
+  Serial.println(Q.y);
+  Serial.println(Q.z);
+}
+
+
+//  -- END OF FILE --

examples/testFRAMPerformance/testFRAMPerformance.ino

@@ -14,7 +14,7 @@ FRAM fram;
 uint32_t start;
 uint32_t stop;
 
-int ar[600];  // 1200 bytes
+int ar[600];  //  1200 bytes
 
 
 void setup()

library.json

@@ -15,7 +15,7 @@
     "type": "git",
     "url": "https://github.com/RobTillaart/FRAM_I2C.git"
   },
-  "version": "0.5.4",
+  "version": "0.6.0",
   "license": "MIT",
   "frameworks": "*",
   "platforms": "*",

library.properties

@@ -1,5 +1,5 @@
 name=FRAM_I2C
-version=0.5.4
+version=0.6.0
 author=Rob Tillaart <[email protected]>
 maintainer=Rob Tillaart <[email protected]>
 sentence=Arduino library for I2C FRAM for persistent storage.