Polishing the library

README.md

@@ -42,4 +42,6 @@ See the [example sketches](https://github.com/PowerBroker2/SerialTransfer/tree/m
 
 # ***NOTE:***
 
-SPITransfer.h and it's associated features are not supported for the Arduino Nano 33 BLE or DUE.
+SPITransfer.h and it's associated features are not supported for the ESP8266, Arduino Nano 33 BLE or DUE.
+
+Should the automatic detection of SPI support fail you can define the macro `SPI_TRANSFER` to `1` to forcefully enable SPI or to `0` to forcefully disable it.

examples/i2c_rx_data/i2c_rx_data.ino

@@ -3,51 +3,41 @@
 
 I2CTransfer myTransfer;
 
-struct STRUCT {
-  char z;
-  float y;
+struct STRUCT
+{
+	char  z;
+	float y;
 } testStruct;
 
 char arr[6];
 
 
 /////////////////////////////////////////////////////////////////// Callbacks
-void hi()
+void handlePacket(Packet& packet)
 {
-  // use this variable to keep track of how many
-  // bytes we've processed from the receive buffer
-  uint16_t recSize = 0;
-
-  recSize = myTransfer.rxObj(testStruct, recSize);
-  Serial.print(testStruct.z);
-  Serial.print(testStruct.y);
-  Serial.print(" | ");
+	packet.rxObj(testStruct);
+	Serial.print(testStruct.z);
+	Serial.print(testStruct.y);
+	Serial.print(" | ");
 
-  recSize = myTransfer.rxObj(arr, recSize);
-  Serial.println(arr);
+	packet.rxObj(arr);
+	Serial.println(arr);
 }
 ///////////////////////////////////////////////////////////////////
 
 
 void setup()
 {
-  Serial.begin(115200);
-  Wire.begin(0);
-
-  functionPtr callbackArr[] = { hi };
-
-  ///////////////////////////////////////////////////////////////// Config Parameters
-  configST myConfig;
-  myConfig.debug        = true;
-  myConfig.callbacks    = callbackArr;
-  myConfig.callbacksLen = sizeof(callbackArr) / sizeof(functionPtr);
-  /////////////////////////////////////////////////////////////////
-
-  myTransfer.begin(Wire, myConfig);
+	Serial.begin(115200);
+	Wire.begin(0);
+
+	// Serial is the debug serial port. If you don't want to enable debugging, you can remove it
+	myTransfer.begin(Wire, Serial);
+	myTransfer.addCallback(handlePacket);
 }
 
 
 void loop()
 {
-  // Do nothing
+	myTransfer.tick();
 }

examples/i2c_rx_datum/i2c_rx_datum.ino

@@ -3,41 +3,37 @@
 
 I2CTransfer myTransfer;
 
-struct STRUCT {
-  char z;
-  float y;
+struct STRUCT
+{
+	char  z;
+	float y;
 } testStruct;
 
 
 /////////////////////////////////////////////////////////////////// Callbacks
-void hi()
+void handlePacket(Packet& packet)
 {
-  myTransfer.rxObj(testStruct);
-  Serial.print(testStruct.z);
-  Serial.println(testStruct.y);
+	packet.rxObj(testStruct);
+	Serial.print(testStruct.z);
+	Serial.print(testStruct.y);
 }
 ///////////////////////////////////////////////////////////////////
 
 
 void setup()
 {
-  Serial.begin(115200);
-  Wire.begin(0);
-
-  functionPtr callbackArr[] = { hi };
-
-  ///////////////////////////////////////////////////////////////// Config Parameters
-  configST myConfig;
-  myConfig.debug        = true;
-  myConfig.callbacks    = callbackArr;
-  myConfig.callbacksLen = sizeof(callbackArr) / sizeof(functionPtr);
-  /////////////////////////////////////////////////////////////////
-
-  myTransfer.begin(Wire, myConfig);
+	Serial.begin(115200);
+	Wire.begin(0);
+
+	Wire.begin(0);
+
+	// Serial is the debug serial port. If you don't want to enable debugging, you can remove it
+	myTransfer.begin(Wire, Serial);
+	myTransfer.addCallback(handlePacket);
 }
 
 
 void loop()
 {
-  // Do nothing
+	myTransfer.tick();
 }

examples/i2c_tx_data/i2c_tx_data.ino

@@ -3,39 +3,37 @@
 
 I2CTransfer myTransfer;
 
-struct STRUCT {
-  char z;
-  float y;
+struct STRUCT
+{
+	char  z;
+	float y;
 } testStruct;
 
 char arr[] = "hello";
 
 
 void setup()
 {
-  Serial.begin(115200);
-  Wire.begin();
+	Serial.begin(115200);
+	Wire.begin();
 
-  myTransfer.begin(Wire);
+	// Serial is the debug serial port. If you don't want to enable debugging, you can remove it
+	myTransfer.begin(Wire, Serial);
 
-  testStruct.z = '$';
-  testStruct.y = 4.5;
+	testStruct.z = '$';
+	testStruct.y = 4.5;
 }
 
 
 void loop()
 {
-  // use this variable to keep track of how many
-  // bytes we're stuffing in the transmit buffer
-  uint16_t sendSize = 0;
-
-  ///////////////////////////////////////// Stuff buffer with struct
-  sendSize = myTransfer.txObj(testStruct, sendSize);
+	///////////////////////////////////////// Stuff buffer with struct
+	myTransfer.txObj(testStruct);
 
-  ///////////////////////////////////////// Stuff buffer with array
-  sendSize = myTransfer.txObj(arr, sendSize);
+	///////////////////////////////////////// Stuff buffer with array
+	myTransfer.txObj(arr);
 
-  ///////////////////////////////////////// Send buffer
-  myTransfer.sendData(sendSize);
-  delay(500);
+	///////////////////////////////////////// Send buffer
+	myTransfer.sendPacket();
+	delay(500);
 }

examples/i2c_tx_datum/i2c_tx_datum.ino

@@ -3,26 +3,28 @@
 
 I2CTransfer myTransfer;
 
-struct STRUCT {
-  char z;
-  float y;
+struct STRUCT
+{
+	char  z;
+	float y;
 } testStruct;
 
 
 void setup()
 {
-  Serial.begin(115200);
-  Wire.begin();
+	Serial.begin(115200);
+	Wire.begin();
 
-  myTransfer.begin(Wire);
+	// Serial is the debug serial port. If you don't want to enable debugging, you can remove it
+	myTransfer.begin(Wire, Serial);
 
-  testStruct.z = '$';
-  testStruct.y = 4.5;
+	testStruct.z = '$';
+	testStruct.y = 4.5;
 }
 
 
 void loop()
 {
-  myTransfer.sendDatum(testStruct);
-  delay(500);
+	myTransfer.sendObj(testStruct);
+	delay(500);
 }

examples/spi_rx_data/spi_rx_data.ino

@@ -3,51 +3,33 @@
 
 SPITransfer myTransfer;
 
-struct STRUCT {
-  char z;
-  float y;
+struct STRUCT
+{
+	char  z;
+	float y;
 } testStruct;
 
 char arr[6];
 
-volatile bool procNewPacket = false;
-
 
 void setup()
 {
-  Serial.begin(115200);
-
-  SPCR |= bit (SPE);
-  pinMode(MISO, OUTPUT);
-  SPI.attachInterrupt();
-
-  myTransfer.begin(SPI);
-}
+	Serial.begin(115200);
 
+	pinMode(MISO, OUTPUT);
 
-void loop()
-{
-  if(procNewPacket)
-  {
-    procNewPacket = false;
-
-    // use this variable to keep track of how many
-    // bytes we've processed from the receive buffer
-    uint16_t recSize = 0;
-
-    recSize = myTransfer.rxObj(testStruct, recSize);
-    Serial.print(testStruct.z);
-    Serial.print(testStruct.y);
-    Serial.print(" | ");
-
-    recSize = myTransfer.rxObj(arr, recSize);
-    Serial.println(arr);
-  }
+	// Serial is the debug serial port. If you don't want to enable debugging, you can remove it
+	myTransfer.begin(SPI, Serial);
 }
 
 
-ISR (SPI_STC_vect)
+void loop()
 {
-  if(myTransfer.available())
-    procNewPacket = true;
+	myTransfer.rxObj(testStruct);
+	Serial.print(testStruct.z);
+	Serial.print(testStruct.y);
+	Serial.print(" | ");
+
+	myTransfer.rxObj(arr);
+	Serial.println(arr);
 }

examples/spi_rx_datum/spi_rx_datum.ino

@@ -3,41 +3,27 @@
 
 SPITransfer myTransfer;
 
-struct STRUCT {
-  char z;
-  float y;
+struct STRUCT
+{
+	char  z;
+	float y;
 } testStruct;
 
-volatile bool procNewPacket = false;
-
 
 void setup()
 {
-  Serial.begin(115200);
-
-  SPCR |= bit (SPE);
-  pinMode(MISO, OUTPUT);
-  SPI.attachInterrupt();
-
-  myTransfer.begin(SPI);
-}
+	Serial.begin(115200);
 
+	pinMode(MISO, OUTPUT);
 
-void loop()
-{
-  if(procNewPacket)
-  {
-    procNewPacket = false;
-
-    myTransfer.rxObj(testStruct);
-    Serial.print(testStruct.z);
-    Serial.println(testStruct.y);
-  }
+	// Serial is the debug serial port. If you don't want to enable debugging, you can remove it
+	myTransfer.begin(SPI, Serial);
 }
 
 
-ISR (SPI_STC_vect)
+void loop()
 {
-  if(myTransfer.available())
-    procNewPacket = true;
+	myTransfer.rxObj(testStruct);
+	Serial.print(testStruct.z);
+	Serial.print(testStruct.y);
 }