put common types into namespace

Author: timhendriks93

examples/MultipleScenesSD/MultipleScenesSD.ino

@@ -16,7 +16,7 @@
 
 #define SERVO_PIN 3
 #define CS_PIN 4
-#define SCENE_AMOUNT = 2
+#define SCENE_AMOUNT 2
 
 // Servo object to send positions
 Servo myServo;

src/BlenderServoAnimation.cpp

@@ -1,9 +1,6 @@
 #include "BlenderServoAnimation.h"
-#include "AnimationData.h"
 #include <Arduino.h>
 
-using BlenderServoAnimationLibrary::Scene;
-
 BlenderServoAnimation::~BlenderServoAnimation() {
   if (this->scenes) {
     delete[] this->scenes;
@@ -322,16 +319,16 @@ Scene *BlenderServoAnimation::getCurrentScene() {
   return this->scene;
 }
 
-void BlenderServoAnimation::onPositionChange(pcb positionCallback) {
-  this->servoManager.setPositionCallback(positionCallback);
+void BlenderServoAnimation::onPositionChange(PositionCallback callback) {
+  this->servoManager.setPositionCallback(callback);
 }
 
-void BlenderServoAnimation::onModeChange(mcb modeCallback) {
-  this->modeCallback = modeCallback;
+void BlenderServoAnimation::onModeChange(ModeCallback callback) {
+  this->modeCallback = callback;
 }
 
-void BlenderServoAnimation::onSceneChange(scb sceneCallback) {
-  this->sceneCallback = sceneCallback;
+void BlenderServoAnimation::onSceneChange(SceneCallback callback) {
+  this->sceneCallback = callback;
 }
 
 void BlenderServoAnimation::changeMode(byte mode) {

src/BlenderServoAnimation.h

@@ -1,7 +1,7 @@
 #include "AnimationData.h"
 #include "Scene.h"
 #include "ServoManager.h"
-#include "typedefs.h"
+#include "CommonTypes.h"
 #include <Arduino.h>
 #include <stdarg.h>
 
@@ -11,6 +11,9 @@
 using BlenderServoAnimationLibrary::AnimationData;
 using BlenderServoAnimationLibrary::Scene;
 using BlenderServoAnimationLibrary::ServoManager;
+using BlenderServoAnimationLibrary::ModeCallback;
+using BlenderServoAnimationLibrary::PositionCallback;
+using BlenderServoAnimationLibrary::SceneCallback;
 
 class BlenderServoAnimation {
 
@@ -31,9 +34,9 @@ class BlenderServoAnimation {
 
   void addScene(const byte *data, int size, byte fps, int frames);
   void addScene(Stream &stream, byte fps, int frame);
-  void onPositionChange(pcb positionCallback);
-  void onModeChange(mcb modeCallback);
-  void onSceneChange(scb sceneCallback);
+  void onPositionChange(PositionCallback callback);
+  void onModeChange(ModeCallback callback);
+  void onSceneChange(SceneCallback callback);
   void run(unsigned long currentMicros = micros());
   void play();
   void playSingle(byte index);
@@ -65,8 +68,8 @@ class BlenderServoAnimation {
 
   bool *playedIndexes = nullptr;
 
-  mcb modeCallback = nullptr;
-  scb sceneCallback = nullptr;
+  ModeCallback modeCallback = nullptr;
+  SceneCallback sceneCallback = nullptr;
 
   byte mode = MODE_DEFAULT;
 

src/CommonTypes.h

@@ -0,0 +1,14 @@
+#include <Arduino.h>
+
+#ifndef BlenderServoAnimationLibrary_CommonTypes_H
+#define BlenderServoAnimationLibrary_CommonTypes_H
+
+namespace BlenderServoAnimationLibrary {
+
+typedef void (*ModeCallback)(byte, byte); // Mode callback
+typedef void (*PositionCallback)(byte, int);  // Position callback
+typedef void (*SceneCallback)(byte, byte); // Scene callback
+
+} // BlenderServoAnimationLibrary
+
+#endif

src/Scene.cpp

@@ -1,6 +1,4 @@
 #include "Scene.h"
-#include "Command.h"
-#include "Servo.h"
 #include <Arduino.h>
 
 using BlenderServoAnimationLibrary::Scene;

src/Servo.cpp

@@ -1,12 +1,11 @@
 #include "Servo.h"
-#include "typedefs.h"
 #include <Arduino.h>
 
 using BlenderServoAnimationLibrary::Servo;
 
-Servo::Servo(byte id, pcb positionCallback, byte threshold) {
+Servo::Servo(byte id, PositionCallback callback, byte threshold) {
   this->id = id;
-  this->positionCallback = positionCallback;
+  this->positionCallback = callback;
   this->setThreshold(threshold);
 }
 
@@ -53,8 +52,8 @@ bool Servo::isNeutral() {
   return this->currentPosition == this->neutralPosition;
 }
 
-void Servo::setPositionCallback(pcb positionCallback) {
-  this->positionCallback = positionCallback;
+void Servo::setPositionCallback(PositionCallback callback) {
+  this->positionCallback = callback;
 }
 
 void Servo::setThreshold(byte value) {

src/Servo.h

@@ -1,4 +1,4 @@
-#include "typedefs.h"
+#include "CommonTypes.h"
 #include <Arduino.h>
 
 #ifndef BlenderServoAnimationLibrary_Servo_H
@@ -9,13 +9,13 @@ namespace BlenderServoAnimationLibrary {
 class Servo {
 
 public:
-  Servo(byte id, pcb positionCallback, byte threshold = 0);
+  Servo(byte id, PositionCallback callback, byte threshold = 0);
 
   void move(int position, bool useOffset = true);
   void moveTowardsNeutral();
   void setThreshold(byte value);
   void setOffset(int offset);
-  void setPositionCallback(pcb positionCallback);
+  void setPositionCallback(PositionCallback callback);
 
   bool isNeutral();
 
@@ -32,7 +32,7 @@ class Servo {
   int currentPosition = -1;
   int offset = 0;
 
-  pcb positionCallback = nullptr;
+  PositionCallback positionCallback = nullptr;
 
   bool positionExceedsThreshold(int position);
 };

src/ServoManager.cpp

@@ -1,5 +1,4 @@
 #include "ServoManager.h"
-#include "Servo.h"
 #include <Arduino.h>
 
 using BlenderServoAnimationLibrary::Servo;
@@ -11,11 +10,11 @@ ServoManager::~ServoManager() {
   }
 }
 
-void ServoManager::setPositionCallback(pcb positionCallback) {
-  this->positionCallback = positionCallback;
+void ServoManager::setPositionCallback(PositionCallback callback) {
+  this->positionCallback = callback;
 
   for (byte i = 0; i < this->servoAmount; i++) {
-    this->servos[i]->setPositionCallback(positionCallback);
+    this->servos[i]->setPositionCallback(callback);
   }
 }
 

src/ServoManager.h

@@ -1,7 +1,7 @@
 #include "AnimationData.h"
 #include "Command.h"
 #include "Servo.h"
-#include "typedefs.h"
+#include "CommonTypes.h"
 #include <Arduino.h>
 
 #ifndef BlenderServoAnimationLibrary_ServoManager_H
@@ -14,7 +14,7 @@ class ServoManager {
 public:
   ~ServoManager();
 
-  void setPositionCallback(pcb positionCallback);
+  void setPositionCallback(PositionCallback callback);
   void setDefaultThreshold(byte value);
   void setThreshold(byte servoId, byte value);
   void setOffset(byte servoId, int offset);
@@ -28,7 +28,7 @@ class ServoManager {
 
   Command command;
 
-  pcb positionCallback = nullptr;
+  PositionCallback positionCallback = nullptr;
 
   byte servoAmount = 0;
   byte defaultThreshold = 0;

src/typedefs.h

@@ -139,10 +139,10 @@ void test_move_towards_neutral_with_offset(void) {
 
 int main(int argc, char **argv) {
   UNITY_BEGIN();
-  // RUN_TEST(test_move);
-  // RUN_TEST(test_move_towards_neutral);
-  // RUN_TEST(test_threshold);
-  // RUN_TEST(test_offset);
+  RUN_TEST(test_move);
+  RUN_TEST(test_move_towards_neutral);
+  RUN_TEST(test_threshold);
+  RUN_TEST(test_offset);
   RUN_TEST(test_move_towards_neutral_with_offset);
   UNITY_END();
 }