M4_Eyes.ino: add a set of user_callable functions to control the eyes: eyesWide, eyesBlink, eyesToCorner, eyesNormal

file.cpp: add additional user_setup function that passes in the configuration
file.cpp: add some accessor functions that use dwim()
globals.h: declarations of new functions
user_watch.cpp: fix case on HeatSensor.h for case-sensitive compilation systems
user_watch.cpp: convert to using new eyesToCorner()
user_*.cpp: add user_setup(doc) function
new user_wiichuck.cpp: connects to WiiChuck that controls eyes and NeoPixel strip

Author: TonyLHansen

M4_Eyes/M4_Eyes.ino

@@ -133,6 +133,33 @@ uint32_t availableRAM(void) {
   return &top - (char *)sbrk(0); // Top of stack minus end of heap
 }
 
+// USER CALLABLE FUNCTIONS
+
+// set the booped flag
+void eyesWide(bool t) {
+  booped = t;
+}
+
+// start a blink
+void eyesBlink() {
+     timeToNextBlink = 0;
+}
+
+// force the eyes to a position on the screen
+void eyesToCorner(float x, float y, bool immediate) {
+  moveEyesRandomly = false;
+  eyeTargetX = x;
+  eyeTargetY = y;
+  if (immediate) 
+    eyeMoveDuration = 0;
+}
+
+// return the eyes to normal random movement
+void eyesNormal() {
+  moveEyesRandomly = true;
+}
+
+
 // SETUP FUNCTION - CALLED ONCE AT PROGRAM START ---------------------------
 
 void setup() {
@@ -884,7 +911,8 @@ void loop() {
               lightSensorPin = -1; // Stop trying to use the light sensor
             } else {
               lastLightReadTime = t - LIGHT_INTERVAL + 30000; // Try again in 30 ms
-            } }
+            }
+	  }
         }
         irisValue = (irisValue * 0.97) + (lastLightValue * 0.03); // Filter response for smooth reaction
       } else {

M4_Eyes/file.cpp

@@ -283,6 +283,7 @@ void loadConfig(char *filename) {
 #endif // ADAFRUIT_MONSTER_M4SK_EXPRESS
     }
     file.close();
+    user_setup(doc);
   } else {
     Serial.println("Can't open config file, using default settings");
   }
@@ -454,3 +455,15 @@ ImageReturnCode loadTexture(char *filename, uint16_t **data,
 
   return status;
 }
+
+// Utility functions for use by user functions to grab an integer value from the config file 
+// using dwim() and providing a default value.
+int32_t getDocInt(StaticJsonDocument<2048> &doc, const char *nm, int32_t def) {
+  return dwim(doc[nm], def);
+}
+int32_t getDocInt(StaticJsonDocument<2048> &doc, const char *nm, const char *nm2, int32_t def) {
+  return dwim(doc[nm][nm2], def);
+}
+int32_t getDocInt(StaticJsonDocument<2048> &doc, const char *nm, const char *nm2, const char *nm3, int32_t def) {
+  return dwim(doc[nm][nm2][nm3], def);
+}

M4_Eyes/globals.h

@@ -72,7 +72,7 @@ GLOBAL_VAR float     trackFactor         GLOBAL_INIT(0.5);
 
 // Random eye motion: provided by the base project, but overridable by user code.
 GLOBAL_VAR bool      moveEyesRandomly    GLOBAL_INIT(true);   // Clear to suppress random eye motion and let user code control it
-GLOBAL_VAR float     eyeTargetX          GLOBAL_INIT(0.0);  // THen set these continuously in user_loop.
+GLOBAL_VAR float     eyeTargetX          GLOBAL_INIT(0.0);  // Then set these continuously in user_loop.
 GLOBAL_VAR float     eyeTargetY          GLOBAL_INIT(0.0);  // Range is from -1.0 to +1.0.
 
 // Pin definition stuff will go here
@@ -210,6 +210,9 @@ extern bool            filesystem_change_flag GLOBAL_INIT(true);
 extern void            loadConfig(char *filename);
 extern ImageReturnCode loadEyelid(char *filename, uint8_t *minArray, uint8_t *maxArray, uint8_t init, uint32_t maxRam);
 extern ImageReturnCode loadTexture(char *filename, uint16_t **data, uint16_t *width, uint16_t *height, uint32_t maxRam);
+extern int32_t         getDocInt(StaticJsonDocument<2048> &doc, const char *nm, int32_t def);
+extern int32_t         getDocInt(StaticJsonDocument<2048> &doc, const char *nm, const char *nm2, int32_t def);
+extern int32_t         getDocInt(StaticJsonDocument<2048> &doc, const char *nm, const char *nm2, const char *nm3, int32_t def);
 
 // Functions in memory.cpp
 extern uint32_t        availableRAM(void);
@@ -232,5 +235,13 @@ extern float           screen2map(int in);
 extern float           map2screen(int in);
 
 // Functions in user.cpp
+#include <ArduinoJson.h>          // JSON config file functions
 extern void            user_setup(void);
+extern void            user_setup(StaticJsonDocument<2048> &doc);
 extern void            user_loop(void);
+
+// user callable functions
+extern void eyesWide(bool);
+extern void eyesBlink();
+extern void eyesToCorner(float x, float y, bool immediate);
+extern void eyesNormal();

M4_Eyes/user.cpp

@@ -15,6 +15,12 @@
 void user_setup(void) {
 }
 
+// Called once after the processing of the configuration file. This allows
+// user configuration to also be done based on the config file.
+#include <ArduinoJson.h>          // JSON config file functions
+void user_setup(StaticJsonDocument<2048> &doc) {
+}
+
 // Called periodically during eye animation. This is invoked in the
 // interval before starting drawing on the last eye (left eye on MONSTER
 // M4SK, sole eye on HalloWing M0) so it won't exacerbate visible tearing

M4_Eyes/user_fizzgig.cpp

@@ -60,6 +60,12 @@ void user_setup(void) {
   }
 }
 
+// Called once after the processing of the configuration file. This allows
+// user configuration to also be done based on the config file.
+#include <ArduinoJson.h>          // JSON config file functions
+void user_setup(StaticJsonDocument<2048> &doc) {
+}
+
 void user_loop(void) {
   if(playing) {
     // While WAV is playing, wiggle servo between middle and open-mouth positions:

M4_Eyes/user_hid.cpp

@@ -38,6 +38,12 @@ void user_setup(void) {
   while( !USBDevice.mounted() ) delay(1);
 }
 
+// Called once after the processing of the configuration file. This allows
+// user configuration to also be done based on the config file.
+#include <ArduinoJson.h>          // JSON config file functions
+void user_setup(StaticJsonDocument<2048> &doc) {
+}
+
 void user_loop(void) {
   if ( !usb_hid.ready() ) {
     Serial.println("not ready");

M4_Eyes/user_neopixel.cpp

@@ -14,6 +14,12 @@ void user_setup(void) {
 
 long firstPixelHue = 0;
 
+// Called once after the processing of the configuration file. This allows
+// user configuration to also be done based on the config file.
+#include <ArduinoJson.h>          // JSON config file functions
+void user_setup(StaticJsonDocument<2048> &doc) {
+}
+
 void user_loop(void) {
   for(int i=0; i<strip.numPixels(); i++) { // For each pixel in strip...
     // Offset pixel hue by an amount to make one full revolution of the

M4_Eyes/user_touchneopixels.cpp

@@ -245,6 +245,12 @@ void user_setup(void) {
   changeBehavior(0, micros());
 }
 
+// Called once after the processing of the configuration file. This allows
+// user configuration to also be done based on the config file.
+#include <ArduinoJson.h>          // JSON config file functions
+void user_setup(StaticJsonDocument<2048> &doc) {
+}
+
 void user_loop(void) {
   uint32_t elapsedSince = micros();
   if(elapsedSince - lastTouchSample > TOUCH_SAMPLE_TIME) {

M4_Eyes/user_watch.cpp

@@ -2,7 +2,7 @@
 // CORRESPONDING LINE IN HeatSensor.cpp MUST ALSO BE ENABLED!
 
 #include "globals.h"
-#include "heatSensor.h"
+#include "HeatSensor.h"
 
 // For heat sensing
 HeatSensor heatSensor;
@@ -25,6 +25,11 @@ void user_setup(void) {
   heatSensor.setup();
 }
 
+// Called once after the processing of the configuration file. This allows
+// user configuration to also be done via the config file.
+void user_setup(StaticJsonDocument<2048> &doc) {
+}
+
 // Called periodically during eye animation. This is invoked in the
 // interval before starting drawing on the last eye (left eye on MONSTER
 // M4SK, sole eye on HalloWing M0) so it won't exacerbate visible tearing
@@ -35,8 +40,7 @@ void user_loop(void) {
   heatSensor.find_focus();
 
   // Set values for the new X and Y.
-  eyeTargetX = heatSensor.x;
-  eyeTargetY = -heatSensor.y;
+  eyesToCorner(heatSensor.x, -heatSensor.y, false);
 }
 
 #endif // 0