simplify src structure and rename live classes

Author: timhendriks93

examples/LiveModeESP32WebSocket/LiveModeESP32WebSocket.ino

@@ -39,7 +39,7 @@ BlenderServoAnimation::Servo myBlenderServo(0, move);
 
 // Live mode stream instance acting as a middleware between web socket and
 // animation object
-BlenderServoAnimation::Live live;
+BlenderServoAnimation::LiveStream liveStream;
 
 // Handler function writing data to the live stream instance when receiving data
 void onWebSocketEvent(AsyncWebSocket *server, AsyncWebSocketClient *client,
@@ -49,7 +49,7 @@ void onWebSocketEvent(AsyncWebSocket *server, AsyncWebSocketClient *client,
   }
 
   for (size_t i = 0; i < len; i++) {
-    live.write(data[i]);
+    liveStream.write(data[i]);
   }
 }
 
@@ -76,7 +76,7 @@ void setup() {
   animation.addServo(myBlenderServo);
 
   // Trigger the animation live mode
-  animation.live(live);
+  animation.live(liveStream);
 }
 
 void loop() {

src/animation/Animation.cpp src/Animation.cppsrc/animation/Animation.cpp renamed to src/Animation.cpp

@@ -1,5 +1,5 @@
-#include "animation/Animation.h"
-#include "servo/Servo.h"
+#include "Animation.h"
+#include "Servo.h"
 #include <Arduino.h>
 
 using namespace BlenderServoAnimation;
@@ -112,14 +112,14 @@ void Animation::handleStopMode() {
 
 void Animation::handleLiveMode() {
   while (this->liveStream->available() > 0) {
-    this->command.read(this->liveStream);
+    this->liveCommand.read(this->liveStream);
 
-    if (!this->command.isComplete() || !this->command.isValid()) {
+    if (!this->liveCommand.isComplete() || !this->liveCommand.isValid()) {
       continue;
     }
 
-    byte id = this->command.getServoID();
-    int position = this->command.getServoPosition();
+    byte id = this->liveCommand.getServoID();
+    int position = this->liveCommand.getServoPosition();
 
     for (int i = 0; i < MAX_SERVO_COUNT; i++) {
       Servo *servo = this->servos[i];

src/animation/Animation.h src/Animation.hsrc/animation/Animation.h renamed to src/Animation.h

@@ -1,5 +1,5 @@
-#include "command/Command.h"
-#include "servo/Servo.h"
+#include "LiveCommand.h"
+#include "Servo.h"
 #include <Arduino.h>
 #include <stdarg.h>
 
@@ -30,7 +30,7 @@ class Animation {
 
   Servo *servos[MAX_SERVO_COUNT] = {};
   Stream *liveStream;
-  Command command;
+  LiveCommand liveCommand;
   mcb modeCallback = nullptr;
 
   void changeMode(byte mode);

src/BlenderServoAnimation.h

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

src/command/Command.cpp src/LiveCommand.cppsrc/command/Command.cpp renamed to src/LiveCommand.cpp

@@ -1,9 +1,9 @@
-#include "command/Command.h"
+#include "LiveCommand.h"
 #include <Arduino.h>
 
 using namespace BlenderServoAnimation;
 
-void Command::read(Stream *liveStream) {
+void LiveCommand::read(Stream *liveStream) {
   byte receivedByte = liveStream->read();
 
   if (!this->receiving && receivedByte != START_MARKER) {
@@ -29,20 +29,20 @@ void Command::read(Stream *liveStream) {
   }
 }
 
-bool Command::isValid() {
+bool LiveCommand::isValid() {
   return this->receivedBytes[0] == START_MARKER &&
          this->receivedBytes[LENGTH - 1] == END_MARKER;
 }
 
-bool Command::isComplete() {
+bool LiveCommand::isComplete() {
   return this->complete;
 }
 
-byte Command::getServoID() {
+byte LiveCommand::getServoID() {
   return this->receivedBytes[INDEX_SERVO_ID];
 }
 
-int Command::getServoPosition() {
+int LiveCommand::getServoPosition() {
   return this->receivedBytes[INDEX_POSITION_BYTE] |
          this->receivedBytes[INDEX_POSITION_SIG_BYTE] << BITS;
 }

src/command/Command.h src/LiveCommand.hsrc/command/Command.h renamed to src/LiveCommand.h

@@ -5,7 +5,7 @@
 
 namespace BlenderServoAnimation {
 
-class Command {
+class LiveCommand {
 
 private:
   static const byte START_MARKER = 0x3C;

src/live/Live.cpp src/LiveStream.cppsrc/live/Live.cpp renamed to src/LiveStream.cpp

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

src/live/Live.h src/LiveStream.hsrc/live/Live.h renamed to src/LiveStream.h

@@ -5,7 +5,7 @@
 
 namespace BlenderServoAnimation {
 
-class Live : public Stream {
+class LiveStream : public Stream {
 private:
   static const byte BUFFER_SIZE = 20;
 

src/servo/Servo.cpp src/Servo.cppsrc/servo/Servo.cpp renamed to src/Servo.cpp

@@ -1,4 +1,4 @@
-#include "servo/Servo.h"
+#include "Servo.h"
 #include <Arduino.h>
 
 using namespace BlenderServoAnimation;