Add example for SLIP encoding.

Author: bakercp

examples/PacketSerialReverseEchoSLIP/PacketSerialReverseEchoSLIP.ino

@@ -0,0 +1,92 @@
+// =============================================================================
+//
+// Copyright (c) 2012-2016 Christopher Baker <http://christopherbaker.net>
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+//
+// =============================================================================
+
+
+#include <PacketSerial.h>
+
+
+// The PacketSerial object.
+// It cleverly wraps one of the Serial objects.
+// While it is still possible to use the Serial object
+// directly, it is recommended that the user let the
+// PacketSerial object manage all serial communication.
+// Thus the user should not call Serial.write(), etc.
+// Additionally the user should not use the serialEvent()
+// callbacks.
+SLIPPacketSerial serial;
+
+
+void setup()
+{
+  // We must specify a packet handler method so that
+  serial.setPacketHandler(&onPacket);
+  serial.begin(115200);
+}
+
+
+void loop()
+{
+  // Do other things here.
+
+  // The update() method attempts to read in
+  // any incoming serial data and emits packets via
+  // the user's onPacket(const uint8_t* buffer, size_t size)
+  // method registered with the setPacketHandler() method.
+  //
+  // The update() method should be called at the end of the loop().
+  serial.update();
+}
+
+// This is our packet callback.
+// The buffer is delivered already decoded.
+void onPacket(const uint8_t* buffer, size_t size)
+{
+  // Make a temporary buffer.
+  uint8_t tmp[size];
+
+  // Copy the packet into our temporary buffer.
+  memcpy(tmp, buffer, size);
+
+  // Reverse our temporaray buffer.
+  reverse(tmp, size);
+
+  // Send the reversed buffer back.
+  // The send() method will encode the buffer
+  // as a packet, set packet markers, etc.
+  serial.send(tmp, size);
+}
+
+/// \brief A simple array reversal method.
+void reverse(uint8_t* buffer, size_t size)
+{
+  uint8_t tmp;
+
+  for (int i=0; i < size / 2; i++)
+  {
+    tmp = buffer[i];
+    buffer[i] = buffer[size-i-1];
+    buffer[size-i-1] = tmp;
+  }
+}
+