Merge pull request #54 from martincizek/fix-callback-docs

Make callbacks const-qualified. Fix invalid memory usage in callback examples.
PowerBroker2 · Feb 1, 2021 · d2112da · d2112da
2 parents 950e752 + b0eb300
commit d2112da
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 12 deletions.
diff --git a/examples/i2c_rx_data/i2c_rx_data.ino b/examples/i2c_rx_data/i2c_rx_data.ino
@@ -26,6 +26,9 @@ void hi()
   recSize = myTransfer.rxObj(arr, recSize);
   Serial.println(arr);
 }
+
+// supplied as a reference - persistent allocation required
+const functionPtr callbackArr[] = { hi };
 ///////////////////////////////////////////////////////////////////
 
 
@@ -34,8 +37,6 @@ void setup()
   Serial.begin(115200);
   Wire.begin(0);
 
-  functionPtr callbackArr[] = { hi };
-
   ///////////////////////////////////////////////////////////////// Config Parameters
   configST myConfig;
   myConfig.debug        = true;

diff --git a/examples/i2c_rx_datum/i2c_rx_datum.ino b/examples/i2c_rx_datum/i2c_rx_datum.ino
@@ -16,6 +16,9 @@ void hi()
   Serial.print(testStruct.z);
   Serial.println(testStruct.y);
 }
+
+// supplied as a reference - persistent allocation required
+const functionPtr callbackArr[] = { hi };
 ///////////////////////////////////////////////////////////////////
 
 
@@ -24,8 +27,6 @@ void setup()
   Serial.begin(115200);
   Wire.begin(0);
 
-  functionPtr callbackArr[] = { hi };
-
   ///////////////////////////////////////////////////////////////// Config Parameters
   configST myConfig;
   myConfig.debug        = true;

diff --git a/examples/uart_rx_with_callbacks/uart_rx_with_callbacks.ino b/examples/uart_rx_with_callbacks/uart_rx_with_callbacks.ino
@@ -9,6 +9,9 @@ void hi()
 {
   Serial.println("hi");
 }
+
+// supplied as a reference - persistent allocation required
+const functionPtr callbackArr[] = { hi };
 ///////////////////////////////////////////////////////////////////
 
 
@@ -17,8 +20,6 @@ void setup()
   Serial.begin(115200);
   Serial1.begin(115200);
 
-  functionPtr callbackArr[] = { hi };
-
   ///////////////////////////////////////////////////////////////// Config Parameters
   configST myConfig;
   myConfig.debug        = true;

diff --git a/src/Packet.h b/src/Packet.h
@@ -37,10 +37,10 @@ const uint8_t NUM_OVERHEAD    = 6;    // Delete
 
 struct configST
 {
-	Stream*      debugPort    = &Serial;
-	bool         debug        = true;
-	functionPtr* callbacks    = NULL;
-	uint8_t      callbacksLen = 0;
+	Stream*            debugPort    = &Serial;
+	bool               debug        = true;
+	const functionPtr* callbacks    = NULL;
+	uint8_t            callbacksLen = 0;
 };
 
 
@@ -160,8 +160,8 @@ class Packet
 	};
 	fsm state = find_start_byte;
 
-	functionPtr* callbacks    = NULL;
-	uint8_t      callbacksLen = 0;
+	const functionPtr* callbacks    = NULL;
+	uint8_t            callbacksLen = 0;
 
 	Stream* debugPort;
 	bool    debug = false;