directly allow animation live stream write

timhendriks93 · timhendriks93 · commit c3df1ff6006c · 2024-07-27T12:07:08.000+02:00
diff --git a/examples/AdafruitPCA9685/AdafruitPCA9685.ino b/examples/AdafruitPCA9685/AdafruitPCA9685.ino
@@ -10,9 +10,6 @@
 #include <Adafruit_PWMServoDriver.h>
 #include <BlenderServoAnimation.h>
 
-// Using the namespace to have short class references (Animation and Servo)
-using namespace BlenderServoAnimation;
-
 // PWM driver instance to set PWM output
 Adafruit_PWMServoDriver pwm = Adafruit_PWMServoDriver();
 
@@ -22,10 +19,16 @@ void move(byte servoID, int position) {
   pwm.setPWM(servoID, 0, position);
 }
 
-// Animation object to represent the original Blender animation
-Animation animation;
+// Animation object to control the animation
+BlenderServoAnimation::Animation animation;
+
+#define POWER_PIN 19
 
 void setup() {
+  // Set power pin
+  pinMode(POWER_PIN, OUTPUT);
+  digitalWrite(POWER_PIN, HIGH);
+
   // Set the position callback
   animation.onPositionChange(move);
 
diff --git a/examples/MultiplePCA9685/MultiplePCA9685.ino b/examples/MultiplePCA9685/MultiplePCA9685.ino
@@ -10,15 +10,12 @@
 #include <Adafruit_PWMServoDriver.h>
 #include <BlenderServoAnimation.h>
 
-// Using the namespace to have short class references (Animation and Servo)
-using namespace BlenderServoAnimation;
-
 // PWM driver instances to set PWM output
 Adafruit_PWMServoDriver pwmA(0x40);
 Adafruit_PWMServoDriver pwmB(0x41);
 
-// Animation object to represent the original Blender animation
-Animation animation;
+// Animation object to control the animation
+BlenderServoAnimation::Animation animation;
 
 // We use a struct to map a servo to a PCA9685 board and channel
 struct servoMapping {
diff --git a/examples/MultipleScenes/MultipleScenes.ino b/examples/MultipleScenes/MultipleScenes.ino
@@ -27,7 +27,7 @@ void move(byte servoID, int position) {
   myServo.writeMicroseconds(position);
 }
 
-// Animation object to represent the original Blender animation
+// Animation object to control the animation
 BlenderServoAnimation::Animation animation;
 
 void setup() {
diff --git a/examples/MultipleScenesSD/MultipleScenesSD.ino b/examples/MultipleScenesSD/MultipleScenesSD.ino
@@ -60,7 +60,7 @@ void changeSceneFile(byte prevSceneIndex, byte nextSceneIndex) {
   }
 }
 
-// Animation object to represent the original Blender animation
+// Animation object to control the animation
 BlenderServoAnimation::Animation animation;
 
 void setup() {
diff --git a/examples/MultipleScenesSD/README.md b/examples/MultipleScenesSD/README.md
@@ -4,4 +4,4 @@ Setting up a show consisting of 2 animations.
 
 By default, the 2 animations will be played synchronously in a loop.
 
-![Arduino Nano with servo](../../images/arduino-nano-with-servo.png)
+![Arduino Nano with servo](../../images/arduino-nano-with-sd-module.png)
diff --git a/examples/SDAnimation/README.md b/examples/SDAnimation/README.md
@@ -4,4 +4,4 @@ Using the standard Arduino servo library to send servo positions.
 
 The setup requires nothing but a micro controller and a single servo.
 
-![Arduino Nano with servo](../../images/arduino-nano-with-servo.png)
+![Arduino Nano with servo](../../images/arduino-nano-with-sd-module.png)
diff --git a/examples/SDAnimation/SDAnimation.ino b/examples/SDAnimation/SDAnimation.ino
@@ -36,7 +36,7 @@ void resetFile(byte prevSceneIndex, byte nextSceneIndex) {
   animationFile.seek(0);
 }
 
-// Animation object to represent the original Blender animation
+// Animation object to control the animation
 BlenderServoAnimation::Animation animation;
 
 void setup() {
diff --git a/examples/SerialLiveMode/SerialLiveMode.ino b/examples/SerialLiveMode/SerialLiveMode.ino
@@ -14,6 +14,8 @@
 #include <Servo.h>
 #endif
 
+#define SERVO_PIN 12
+
 // Servo object to send positions
 Servo myServo;
 
@@ -23,15 +25,15 @@ void move(byte servoID, int position) {
   myServo.writeMicroseconds(position);
 }
 
-// Animation object to represent the original Blender animation
+// Animation object to control the animation
 BlenderServoAnimation::Animation animation;
 
 void setup() {
   // Initialize serial communication
   Serial.begin(115200);
 
-  // Attach the servo to pin 12
-  myServo.attach(12);
+  // Attach the servo to the defined servo pin
+  myServo.attach(SERVO_PIN);
 
   // Set the position callback
   animation.onPositionChange(move);
diff --git a/examples/StandardServoLib/StandardServoLib.ino b/examples/StandardServoLib/StandardServoLib.ino
@@ -1,9 +1,6 @@
 /*
   Using the standard Arduino servo library to send servo positions.
-
-  Note the namespace BlenderServoAnimation which helps to distinguish
-  between the standard library servo class (Servo) and the servo
-  class of this library (BlenderServoAnimation::Servo).
+  The animation is played in a loop.
 */
 
 #include "simple.h"
@@ -15,6 +12,8 @@
 #include <Servo.h>
 #endif
 
+#define SERVO_PIN 12
+
 // Servo object to send positions
 Servo myServo;
 
@@ -24,12 +23,12 @@ void move(byte servoID, int position) {
   myServo.writeMicroseconds(position);
 }
 
-// Animation object to represent the original Blender animation
+// Animation object to control the animation
 BlenderServoAnimation::Animation animation;
 
 void setup() {
-  // Attach the servo to pin 12
-  myServo.attach(12);
+  // Attach the servo to the defined servo pin
+  myServo.attach(SERVO_PIN);
 
   // Set the position callback
   animation.onPositionChange(move);
diff --git a/examples/SwitchModeButton/SwitchModeButton.ino b/examples/SwitchModeButton/SwitchModeButton.ino
@@ -62,7 +62,7 @@ void modeChanged(byte prevMode, byte newMode) {
   }
 }
 
-// Animation object to represent the original Blender animation
+// Animation object to control the animation
 BlenderServoAnimation::Animation animation;
 
 // Callback to be triggered on a short button press
diff --git a/examples/WebSocketLiveMode/WebSocketLiveMode.ino b/examples/WebSocketLiveMode/WebSocketLiveMode.ino
@@ -13,6 +13,8 @@
 #include <ESP32Servo.h>
 #include <WiFi.h>
 
+#define SERVO_PIN 12
+
 // Change to your SSID and password
 const char *ssid = "SSID";
 const char *password = "PASSWORD";
@@ -30,27 +32,25 @@ void move(byte servoID, int position) {
   myServo.writeMicroseconds(position);
 }
 
-// Animation object to represent the original Blender animation
+// Animation object to control the animation
 BlenderServoAnimation::Animation animation;
 
-// AnimationData instance acting as a middleware between web socket and
-// animation instance
-BlenderServoAnimation::AnimationData liveStream;
-
-// Handler function writing data to the live stream instance when receiving data
+// Callback function writing live stream data to the animation
 void onWebSocketEvent(AsyncWebSocket *server, AsyncWebSocketClient *client,
                       AwsEventType type, void *arg, uint8_t *data, size_t len) {
   if (type != WS_EVT_DATA) {
     return;
   }
 
   for (size_t i = 0; i < len; i++) {
-    liveStream.writeByte(data[i]);
+    animation.writeLiveStream(data[i]);
   }
 }
 
 void setup() {
   Serial.begin(9600);
+  while (!Serial) {
+  };
 
   WiFi.begin(ssid, password);
   while (WiFi.status() != WL_CONNECTED) {
@@ -65,14 +65,14 @@ void setup() {
   server.addHandler(&ws);
   server.begin();
 
-  // Attach the servo to pin 12
-  myServo.attach(12);
+  // Attach the servo to the defined servo pin
+  myServo.attach(SERVO_PIN);
 
   // Set the position callback
   animation.onPositionChange(move);
 
   // Trigger the animation live mode
-  animation.live(liveStream);
+  animation.live();
 }
 
 void loop() {
diff --git a/images/arduino-nano-with-sd-module.png b/images/arduino-nano-with-sd-module.png
diff --git a/images/arduino-nano-with-servo-and-button.png b/images/arduino-nano-with-servo-and-button.png
diff --git a/images/arduino-nano-with-servo.png b/images/arduino-nano-with-servo.png
diff --git a/images/esp32-with-servo.png b/images/esp32-with-servo.png
diff --git a/src/BlenderServoAnimation.h b/src/BlenderServoAnimation.h
@@ -1,3 +1,2 @@
 #include "internal/Animation.h"
-#include "internal/AnimationData.h"
 #include <Arduino.h>
diff --git a/src/internal/Animation.cpp b/src/internal/Animation.cpp
@@ -2,14 +2,15 @@
 #include "AnimationData.h"
 #include <Arduino.h>
 
-using namespace BlenderServoAnimation;
+using BlenderServoAnimation::Animation;
+using BlenderServoAnimation::Scene;
 
 Animation::~Animation() {
   if (this->scenes) {
     delete[] this->scenes;
   }
 
-  if (this->liveStream != nullptr && this->isOneTimeLiveStream) {
+  if (this->liveStream != nullptr) {
     delete this->liveStream;
   }
 
@@ -189,25 +190,38 @@ void Animation::stop() {
   this->changeMode(MODE_STOP);
 }
 
-void Animation::live(Stream &stream) {
+void Animation::live() {
   if (this->mode != MODE_DEFAULT) {
     return;
   }
 
-  this->liveStream = new AnimationData(&stream);
-  this->isOneTimeLiveStream = true;
+  if (this->liveStream != nullptr) {
+    delete this->liveStream;
+  }
+
+  this->liveStream = new AnimationData();
   this->changeMode(MODE_LIVE);
 }
 
-void Animation::live(AnimationData &data) {
+void Animation::live(Stream &stream) {
   if (this->mode != MODE_DEFAULT) {
     return;
   }
 
-  this->liveStream = &data;
+  if (this->liveStream != nullptr) {
+    delete this->liveStream;
+  }
+
+  this->liveStream = new AnimationData(&stream);
   this->changeMode(MODE_LIVE);
 }
 
+void Animation::writeLiveStream(byte value) {
+  if (this->liveStream != nullptr) {
+    this->liveStream->writeByte(value);
+  }
+}
+
 byte Animation::getMode() {
   return this->mode;
 }
@@ -286,7 +300,6 @@ void Animation::handlePlayMode(unsigned long currentMicros) {
 
   if (!this->scene) {
     this->changeMode(MODE_DEFAULT);
-    return;
   }
 }
 
@@ -327,7 +340,7 @@ void Animation::changeMode(byte mode) {
   byte prevMode = this->mode;
   this->mode = mode;
 
-  if (prevMode == MODE_LIVE && this->isOneTimeLiveStream) {
+  if (prevMode == MODE_LIVE) {
     delete this->liveStream;
     this->liveStream = nullptr;
   }
diff --git a/src/internal/Animation.h b/src/internal/Animation.h
@@ -39,8 +39,9 @@ class Animation {
   void loop();
   void pause();
   void stop();
+  void live();
   void live(Stream &stream);
-  void live(AnimationData &data);
+  void writeLiveStream(byte value);
   void setDefaultServoThreshold(byte value);
   void setServoThreshold(byte id, byte value);
   void setServoOffset(byte id, int offset);
@@ -60,7 +61,6 @@ class Animation {
 
   AnimationData *liveStream = nullptr;
 
-  bool isOneTimeLiveStream = false;
   bool *playedIndexes = nullptr;
 
   mcb modeCallback = nullptr;
diff --git a/src/internal/AnimationData.cpp b/src/internal/AnimationData.cpp
@@ -1,7 +1,7 @@
 #include "AnimationData.h"
 #include <Arduino.h>
 
-using namespace BlenderServoAnimation;
+using BlenderServoAnimation::AnimationData;
 
 AnimationData::AnimationData() {
 }
diff --git a/src/internal/Command.cpp b/src/internal/Command.cpp
@@ -1,7 +1,7 @@
 #include "Command.h"
 #include <Arduino.h>
 
-using namespace BlenderServoAnimation;
+using BlenderServoAnimation::Command;
 
 void Command::write(byte value) {
   if (value == START_MARKER) {
diff --git a/src/internal/Scene.cpp b/src/internal/Scene.cpp
@@ -3,7 +3,7 @@
 #include "Servo.h"
 #include <Arduino.h>
 
-using namespace BlenderServoAnimation;
+using BlenderServoAnimation::Scene;
 
 Scene::Scene(ServoManager *servoManager, AnimationData *data, byte fps,
              int frames) {
diff --git a/src/internal/Servo.cpp b/src/internal/Servo.cpp
@@ -2,7 +2,7 @@
 #include "typedefs.h"
 #include <Arduino.h>
 
-using namespace BlenderServoAnimation;
+using BlenderServoAnimation::Servo;
 
 Servo::Servo(byte id, pcb positionCallback, byte threshold) {
   this->id = id;
diff --git a/src/internal/ServoManager.cpp b/src/internal/ServoManager.cpp
@@ -2,7 +2,8 @@
 #include "Servo.h"
 #include <Arduino.h>
 
-using namespace BlenderServoAnimation;
+using BlenderServoAnimation::ServoManager;
+using BlenderServoAnimation::Servo;
 
 ServoManager::~ServoManager() {
   if (this->servos) {

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ void move(byte servoID, int position) {`
`27`	`27`	`myServo.writeMicroseconds(position);`
`28`	`28`	`}`
`29`	`29`
`30`		`-// Animation object to represent the original Blender animation`
	`30`	`+// Animation object to control the animation`
`31`	`31`	`BlenderServoAnimation::Animation animation;`
`32`	`32`
`33`	`33`	`void setup() {`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ void changeSceneFile(byte prevSceneIndex, byte nextSceneIndex) {`
`60`	`60`	`}`
`61`	`61`	`}`
`62`	`62`
`63`		`-// Animation object to represent the original Blender animation`
	`63`	`+// Animation object to control the animation`
`64`	`64`	`BlenderServoAnimation::Animation animation;`
`65`	`65`
`66`	`66`	`void setup() {`
Original file line number	Diff line number	Diff line change
`@@ -4,4 +4,4 @@ Setting up a show consisting of 2 animations.`
`4`	`4`
`5`	`5`	`By default, the 2 animations will be played synchronously in a loop.`
`6`	`6`
`7`		`-![Arduino Nano with servo](../../images/arduino-nano-with-servo.png)`
	`7`	`+![Arduino Nano with servo](../../images/arduino-nano-with-sd-module.png)`
Original file line number	Diff line number	Diff line change
`@@ -4,4 +4,4 @@ Using the standard Arduino servo library to send servo positions.`
`4`	`4`
`5`	`5`	`The setup requires nothing but a micro controller and a single servo.`
`6`	`6`
`7`		`-![Arduino Nano with servo](../../images/arduino-nano-with-servo.png)`
	`7`	`+![Arduino Nano with servo](../../images/arduino-nano-with-sd-module.png)`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ void resetFile(byte prevSceneIndex, byte nextSceneIndex) {`
`36`	`36`	`animationFile.seek(0);`
`37`	`37`	`}`
`38`	`38`
`39`		`-// Animation object to represent the original Blender animation`
	`39`	`+// Animation object to control the animation`
`40`	`40`	`BlenderServoAnimation::Animation animation;`
`41`	`41`
`42`	`42`	`void setup() {`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ void modeChanged(byte prevMode, byte newMode) {`
`62`	`62`	`}`
`63`	`63`	`}`
`64`	`64`
`65`		`-// Animation object to represent the original Blender animation`
	`65`	`+// Animation object to control the animation`
`66`	`66`	`BlenderServoAnimation::Animation animation;`
`67`	`67`
`68`	`68`	`// Callback to be triggered on a short button press`