add generic live stream implementation

Author: timhendriks93

.gitignore

@@ -3,3 +3,5 @@
 .vscode/c_cpp_properties.json
 .vscode/launch.json
 .vscode/ipch
+examples/*/.vscode
+examples/*/.gitignore

src/BlenderServoAnimation.h

@@ -1,4 +1,5 @@
 #include "animation/Animation.h"
 #include "servo/Servo.h"
 #include "show/Show.h"
+#include "live/Live.h"
 #include <Arduino.h>

src/animation/Animation.cpp

@@ -111,8 +111,8 @@ void Animation::handleStopMode() {
 }
 
 void Animation::handleLiveMode() {
-  while (this->serial->available() > 0) {
-    this->command.read(this->serial);
+  while (this->liveStream->available() > 0) {
+    this->command.read(this->liveStream);
 
     if (!this->command.isComplete() || !this->command.isValid()) {
       continue;
@@ -168,12 +168,12 @@ void Animation::stop(byte stepDelay) {
   this->changeMode(MODE_STOP);
 }
 
-void Animation::live(Stream &serial) {
+void Animation::live(Stream &liveStream) {
   if (this->mode != MODE_DEFAULT) {
     return;
   }
 
-  this->serial = &serial;
+  this->liveStream = &liveStream;
   this->changeMode(MODE_LIVE);
 }
 

src/animation/Animation.h

@@ -29,7 +29,7 @@ class Animation {
   unsigned long lastMicros;
 
   Servo *servos[MAX_SERVO_COUNT] = {};
-  Stream *serial;
+  Stream *liveStream;
   Command command;
   mcb modeCallback = nullptr;
 
@@ -57,7 +57,7 @@ class Animation {
   void pause();
   void loop(unsigned long currentMicros = micros());
   void stop(byte stepDelay = 20);
-  void live(Stream &serial);
+  void live(Stream &liveStream);
 
   byte getFPS();
   byte getMode();

src/command/Command.cpp

@@ -3,8 +3,8 @@
 
 using namespace BlenderServoAnimation;
 
-void Command::read(Stream *serial) {
-  byte receivedByte = serial->read();
+void Command::read(Stream *liveStream) {
+  byte receivedByte = liveStream->read();
 
   if (!this->receiving && receivedByte != START_MARKER) {
     return;

src/command/Command.h

@@ -25,7 +25,7 @@ class Command {
   bool complete = false;
 
 public:
-  void read(Stream *serial);
+  void read(Stream *liveStream);
 
   bool isValid();
   bool isComplete();

src/live/Live.cpp

@@ -0,0 +1,41 @@
+#include "Live.h"
+#include <Arduino.h>
+
+using namespace BlenderServoAnimation;
+
+int Live::available() {
+  return this->readIndex != this->writeIndex;
+}
+
+int Live::peek() {
+  return this->buffer[this->readIndex];
+}
+
+int Live::read() {
+  int value = this->buffer[this->readIndex++];
+
+  if (this->readIndex >= BUFFER_SIZE) {
+    this->readIndex = 0;
+  }
+
+  return value;
+}
+
+size_t Live::write(uint8_t value) {
+  this->buffer[this->writeIndex++] = value;
+
+  if (this->writeIndex >= BUFFER_SIZE) {
+    this->writeIndex = 0;
+  }
+
+  return 1;
+}
+
+void Live::flush() {
+  for (int i = 0; i < BUFFER_SIZE; i++) {
+    this->buffer[i] = 0;
+  }
+
+  this->readIndex = 0;
+  this->writeIndex = 0;
+}

test/SerialMock.h src/live/Live.htest/SerialMock.h renamed to src/live/Live.h

@@ -1,15 +1,17 @@
 #include <Arduino.h>
 
-#ifndef BlenderServoAnimation_Serial_Mock_H
-#define BlenderServoAnimation_Serial_Mock_H
+#ifndef BlenderServoAnimation_Live_H
+#define BlenderServoAnimation_Live_H
 
-class SerialMock : public Stream {
+namespace BlenderServoAnimation {
+
+class Live : public Stream {
 private:
   static const byte BUFFER_SIZE = 20;
 
   byte buffer[BUFFER_SIZE];
-  byte readIndex = 0;
   byte writeIndex = 0;
+  byte readIndex = 0;
 
 public:
   int available();
@@ -23,4 +25,6 @@ class SerialMock : public Stream {
   void flush();
 };
 
+} // namespace BlenderServoAnimation
+
 #endif

src/show/Show.cpp

@@ -113,7 +113,7 @@ void Show::stop(byte stepDelay) {
   this->changeMode(MODE_STOP);
 }
 
-void Show::live(Stream &serial) {
+void Show::live(Stream &liveStream) {
   if (!this->hasAnimations() || this->mode != MODE_DEFAULT) {
     return;
   }
@@ -122,7 +122,7 @@ void Show::live(Stream &serial) {
     this->animation = this->animations[this->playIndex];
   }
 
-  this->animation->live(serial);
+  this->animation->live(liveStream);
   this->changeMode(MODE_LIVE);
 }
 

src/show/Show.h

@@ -52,7 +52,7 @@ class Show {
   void loop(unsigned long currentMicros = micros());
   void pause();
   void stop(byte stepDelay = 20);
-  void live(Stream &serial);
+  void live(Stream &liveStream);
   void reset();
 
   bool hasAnimations();