V1.7.15 - Updates

- Fixed the EEPROM persistence failures on ESP boards.

Author: ClutchplateDude

Software/Arduino code/OpenAstroTracker/EPROMStore.cpp

@@ -0,0 +1,75 @@
+#include <EEPROM.h>
+#include "EPROMStore.hpp"
+#include "Utility.hpp"
+
+// The global instance of the platform-independant EEPROM class
+EPROMStore *EPROMStore::_eepromStore = NULL;
+
+// Initialize the EEPROM storage in a platform-independent abstraction
+void EPROMStore::initialize()
+{
+  LOGV2(DEBUG_VERBOSE, "EEPROM: Initialize. Instance is %s", _eepromStore == NULL ? "NULL" : "VALID");
+  if (_eepromStore == NULL)
+  {
+    LOGV1(DEBUG_VERBOSE, "EEPROM: Creating single instance");
+    _eepromStore = new EPROMStore();
+  }
+}
+
+// Get the instance of the EEPROM storage 
+EPROMStore *EPROMStore::Storage()
+{
+  return _eepromStore;
+}
+
+#ifdef ESPBOARD
+
+// Construct the EEPROM object for ESP boards, settign aside 32 bytes for storage
+EPROMStore::EPROMStore()
+{
+  LOGV1(DEBUG_VERBOSE, "EEPROM[ESP]: Startup with 32 bytes");
+  EEPROM.begin(32);
+}
+
+// Update the given location with the given value
+void EPROMStore::update(int location, uint8_t value)
+{
+  LOGV3(DEBUG_VERBOSE, "EEPROM[ESP]: Writing %x to %d", value, location);
+  EEPROM.write(location, value);
+  LOGV1(DEBUG_VERBOSE, "EEPROM[ESP]: Committing");
+  EEPROM.commit();
+}
+
+// Read the value at the given location 
+uint8_t EPROMStore::read(int location)
+{
+  uint8_t value;
+  value = EEPROM.read(location);
+  LOGV3(DEBUG_VERBOSE, "EEPROM[ESP]: Read %x from %d", value, location);
+  return value;
+}
+
+#else
+
+// Construct the EEPROM  object for non-ESP boards
+EPROMStore::EPROMStore()
+{
+  LOGV1(DEBUG_VERBOSE, "EEPROM[UNO]: Startup ");
+}
+
+// Update the given location with the given value
+void EPROMStore::update(int location, uint8_t value)
+{
+  LOGV3(DEBUG_VERBOSE, "EEPROM[UNO]: Writing %x to %d", value, location);
+  EEPROM.write(location, value);
+}
+
+// Read the value at the given location 
+uint8_t EPROMStore::read(int location)
+{
+  uint8_t value = EEPROM.read(location);
+  LOGV3(DEBUG_VERBOSE, "EEPROM[UNO]: Read %x from %d", value, location);
+  return value;
+}
+
+#endif

Software/Arduino code/OpenAstroTracker/EPROMStore.hpp

@@ -0,0 +1,18 @@
+#pragma once
+#include <Arduino.h>
+
+// Platform independant abstraction of the EEPROM storage capability of the boards.
+// This is needed because the ESP boards require two things that the Arduino boards don't:
+//  1) It wants to know how many bytes you want to use (at most)
+//  2) It wants you to call a commit() function after a write() to actual persist the data.
+class EPROMStore {
+  static EPROMStore *_eepromStore;
+public:
+  EPROMStore();
+  static void initialize();
+
+  void update(int location, uint8_t value);
+  uint8_t read(int location);
+  static EPROMStore* Storage();
+};
+

Software/Arduino code/OpenAstroTracker/Globals.cpp

@@ -1,10 +1,2 @@
 #include "Globals.hpp"
-#include <EEPROM.h>
-
-void EEPROMupdate(int loc, byte val)
-{
-  if (EEPROM.read(loc)!=val)
-  {
-    EEPROM.write(loc,val);  
-  }
-}
+#include "Utility.hpp"

Software/Arduino code/OpenAstroTracker/Globals.hpp

@@ -4,8 +4,6 @@
 #include <Arduino.h>
 #include <WString.h>
 
-void EEPROMupdate(int loc, byte val);
-
 // Set to 1 if you are in the northern hemisphere.
 #define NORTHERN_HEMISPHERE 1
 
@@ -33,7 +31,8 @@ extern byte PolarisRASecond;
 #define DEBUG_MOUNT_VERBOSE  0x10
 #define DEBUG_GENERAL        0x20
 #define DEBUG_MEADE          0x40
-#define DEBUG_ANY            0x7F
+#define DEBUG_VERBOSE        0x80
+#define DEBUG_ANY            0xFF
 
 // Bit Name                 Output
 //  0  DEBUG_INFO           General output, like startup variables and status
@@ -48,8 +47,10 @@ extern byte PolarisRASecond;
 // Note that if you use an app to control OAT, ANY debug output will likely confuse that app.
 // Debug output is useful if you are using Wifi to control the OAT or if you are issuing
 // manual commands via a terminal.
+//
 // #define DEBUG_LEVEL (DEBUG_SERIAL|DEBUG_WIFI|DEBUG_INFO|DEBUG_MOUNT|DEBUG_GENERAL)
 // #define DEBUG_LEVEL (DEBUG_ANY)
+// #define DEBUG_LEVEL (DEBUG_INFO|DEBUG_MOUNT|DEBUG_GENERAL)
 #define DEBUG_LEVEL (DEBUG_NONE)
 
 // Set this to 1 to run a key diagnostic. No tracker functions are on at all.
@@ -73,8 +74,8 @@ extern byte PolarisRASecond;
     #undef HEADLESS_CLIENT
     #define HEADLESS_CLIENT 1
     #define WIFI_ENABLED 
-    #define INFRA_SSID "yourSSID"
-    #define INFRA_WPAKEY "yourWPAkey"
+    #define INFRA_SSID "YouSSID"
+    #define INFRA_WPAKEY "YourWPAKey"
     #define OAT_WPAKEY "superSecret"
     #define HOSTNAME "OATerScope"
     // 0 - Infrastructure Only - Connecting to a Router

Software/Arduino code/OpenAstroTracker/LcdMenu.cpp

@@ -1,5 +1,5 @@
-#include <EEPROM.h>
 #include "Utility.hpp"
+#include "EPROMStore.hpp"
 #include "LcdMenu.hpp"
 
 #if HEADLESS_CLIENT == 0
@@ -20,7 +20,7 @@ LcdMenu::LcdMenu(byte cols, byte rows, int maxItems) : _lcd(8, 9, 4, 5, 6, 7) {
   _lastDisplay[1] = "";
   _menuItems = new MenuItem * [maxItems];  
 
-  _brightness = EEPROM.read(11);
+  _brightness = EPROMStore::Storage()->read(11);
   LOGV2(DEBUG_INFO, "LCD: Brightness from EEPROM is %d", _brightness);
   // pinMode(10, OUTPUT);
   // analogWrite(10, _brightness);
@@ -88,7 +88,7 @@ void LcdMenu::setBacklightBrightness(int level, bool persist) {
   LOGV2(DEBUG_INFO, "LCD: Wrote %d as brightness", _brightness  );
   if (persist) {
     LOGV2(DEBUG_INFO, "LCD: Saving %d as brightness", (_brightness & 0x00FF));
-    EEPROMupdate(11, (byte)(_brightness & 0x00FF));
+    EPROMStore::Storage()->update(11, (byte)(_brightness & 0x00FF));
   }
 }
 

Software/Arduino code/OpenAstroTracker/Mount.cpp

@@ -1,10 +1,9 @@
-#include <EEPROM.h>
-
 #include "InterruptCallback.hpp"
 
 #include "LcdMenu.hpp"
 #include "Mount.hpp"
 #include "Utility.hpp"
+#include "EPROMStore.hpp"
 
 //mountstatus
 #define STATUS_PARKED              0B0000000000000000
@@ -106,6 +105,18 @@ void Mount::startTimerInterrupts()
 
 }
 
+/////////////////////////////////
+//
+// readConfiguration
+//
+/////////////////////////////////
+void Mount::readConfiguration()
+{
+  LOGV1(DEBUG_INFO, "Mount: Reading configuration data from EEPROM");
+  readPersistentData();
+  LOGV1(DEBUG_INFO, "Mount: Done reading configuration data from EEPROM");
+}
+  
 /////////////////////////////////
 //
 // readPersistentData
@@ -124,29 +135,44 @@ void Mount::startTimerInterrupts()
 void Mount::readPersistentData()
 {
   // Read the magic marker byte and state
-  int marker = EEPROM.read(4) + EEPROM.read(5) * 256;
-  LOGV2(DEBUG_MOUNT_VERBOSE, "EEPROM: Marker: %x ", marker);
+  uint8_t markerLo=EPROMStore::Storage()->read(4);
+  uint8_t markerHi=EPROMStore::Storage()->read(5);
+  
+  uint16_t marker = (uint16_t)markerLo + (uint16_t)markerHi * 256;
+  LOGV4(DEBUG_INFO, "Mount: EEPROM: Marker: %x (L:%d  H:%d)", marker, markerLo, markerHi);
 
   if ((marker & 0xFF01) == 0xBE01) {
-    _stepsPerRADegree = EEPROM.read(6) + EEPROM.read(7) * 256;
-    LOGV2(DEBUG_MOUNT,"EEPROM: RA Marker OK! RA steps/deg is %d", _stepsPerRADegree);
+    _stepsPerRADegree = EPROMStore::Storage()->read(6) + EPROMStore::Storage()->read(7) * 256;
+    LOGV2(DEBUG_INFO,"Mount: EEPROM: RA Marker OK! RA steps/deg is %d", _stepsPerRADegree);
+  }
+  else{
+    LOGV1(DEBUG_INFO,"Mount: EEPROM: No stored value for RA steps");
   }
 
   if ((marker & 0xFF02) == 0xBE02) {
-    _stepsPerDECDegree = EEPROM.read(8) + EEPROM.read(9) * 256;
-    LOGV2(DEBUG_MOUNT,"EEPROM: DEC Marker OK! DEC steps/deg is %d", _stepsPerDECDegree);
+    _stepsPerDECDegree = EPROMStore::Storage()->read(8) + EPROMStore::Storage()->read(9) * 256;
+    LOGV2(DEBUG_INFO,"Mount: EEPROM: DEC Marker OK! DEC steps/deg is %d", _stepsPerDECDegree);
+  }
+  else{
+    LOGV1(DEBUG_INFO,"Mount: EEPROM: No stored value for DEC steps");
   }
 
   float speed = 1.0;
   if ((marker & 0xFF04) == 0xBE04) {
-    int adjust = EEPROM.read(0) + EEPROM.read(3) * 256;
+    int adjust = EPROMStore::Storage()->read(0) + EPROMStore::Storage()->read(3) * 256;
     speed = 1.0 + 1.0 * adjust / 10000.0;
-    LOGV3(DEBUG_MOUNT,"EEPROM: Speed Marker OK! Speed adjust is %d, speedFactor is %f", adjust, speed);
+    LOGV3(DEBUG_INFO,"Mount: EEPROM: Speed Marker OK! Speed adjust is %d, speedFactor is %f", adjust, speed);
+  }
+  else{
+    LOGV1(DEBUG_INFO,"Mount: EEPROM: No stored value for speed factor");
   }
 
   if ((marker & 0xFF08) == 0xBE08) {
-    _backlashCorrectionSteps = EEPROM.read(10) + EEPROM.read(11) * 256;
-    LOGV2(DEBUG_MOUNT,"EEPROM: Backlash Steps Marker OK! Backlash correction is %d", _backlashCorrectionSteps);
+    _backlashCorrectionSteps = EPROMStore::Storage()->read(10) + EPROMStore::Storage()->read(11) * 256;
+    LOGV2(DEBUG_INFO,"Mount: EEPROM: Backlash Steps Marker OK! Backlash correction is %d", _backlashCorrectionSteps);
+  }
+    else{
+    LOGV1(DEBUG_INFO,"Mount: EEPROM: No stored value for backlash correction");
   }
 
   setSpeedCalibration(speed, false);
@@ -159,15 +185,17 @@ void Mount::readPersistentData()
 /////////////////////////////////
 void Mount::writePersistentData(int which, int val)
 {
-  int flag = 0x00;
+  uint8_t flag = 0x00;
   int loByteLocation = 0;
   int hiByteLocation = 0;
 
   // If we're written something before...
-  if (EEPROM.read(5) == 0xBE) {
+  uint8_t magicMarker = EPROMStore::Storage()->read(5);
+  LOGV4(DEBUG_INFO,"Mount: EEPROM Write: Marker is %x, flag is %x (%d)", magicMarker, flag, flag);
+  if (magicMarker == 0xBE) {
     // ... read the current state ...
-    flag = EEPROM.read(4);
-    LOGV3(DEBUG_MOUNT,"EEPROM Write: Marker is 0xBE, flag is %x (%d)", flag, flag);
+    flag = EPROMStore::Storage()->read(4);
+    LOGV3(DEBUG_INFO,"Mount: EEPROM Write: Marker is 0xBE, flag is %x (%d)", flag, flag);
   }
   switch (which) {
     case RA_STEPS:
@@ -176,6 +204,7 @@ void Mount::writePersistentData(int which, int val)
       flag |= 0x01;
       loByteLocation = 6;
       hiByteLocation = 7;
+      LOGV2(DEBUG_INFO,"Mount: EEPROM Write: Updating RA steps to %d", val);
     }
     break;
     case DEC_STEPS:
@@ -184,6 +213,7 @@ void Mount::writePersistentData(int which, int val)
       flag |= 0x02;
       loByteLocation = 8;
       hiByteLocation = 9;
+      LOGV2(DEBUG_INFO,"Mount: EEPROM Write: Updating DEC steps to %d", val);
     }
     break;
     case SPEED_FACTOR_DECIMALS:
@@ -192,6 +222,7 @@ void Mount::writePersistentData(int which, int val)
       flag |= 0x04;
       loByteLocation = 0;
       hiByteLocation = 3;
+      LOGV2(DEBUG_INFO,"Mount: EEPROM Write: Updating Speed factor to %d", val);
     }
     break;
     case BACKLASH_CORRECTION:
@@ -200,19 +231,20 @@ void Mount::writePersistentData(int which, int val)
       flag |= 0x08;
       loByteLocation = 10;
       hiByteLocation = 11;
+      LOGV2(DEBUG_INFO,"Mount: EEPROM Write: Updating Backlash to %d", val);
     }
     break;
   }
 
-  LOGV3(DEBUG_MOUNT_VERBOSE,"EEPROM Write: New Marker is 0xBE, flag is %x (%d)", flag, flag);
+  LOGV3(DEBUG_INFO,"Mount: EEPROM Write: New Marker is 0xBE, flag is %x (%d)", flag, flag);
 
-  EEPROMupdate(4, flag);
-  EEPROMupdate(5, 0xBE);
+  EPROMStore::Storage()->update(4, flag);
+  EPROMStore::Storage()->update(5, 0xBE);
 
-  EEPROMupdate(loByteLocation, val & 0x00FF);
-  EEPROMupdate(hiByteLocation, (val >> 8) & 0x00FF);
+  EPROMStore::Storage()->update(loByteLocation, val & 0x00FF);
+  EPROMStore::Storage()->update(hiByteLocation, (val >> 8) & 0x00FF);
 
-  LOGV5(DEBUG_MOUNT,"EEPROM Write: wrote %x to %d and %x to %d", val & 0x00FF, loByteLocation, (val >> 8) & 0x00FF, hiByteLocation);
+  LOGV5(DEBUG_INFO,"Mount: EEPROM Write: Wrote %x to %d and %x to %d", val & 0x00FF, loByteLocation, (val >> 8) & 0x00FF, hiByteLocation);
 }
 
 /////////////////////////////////

Software/Arduino code/OpenAstroTracker/Mount.hpp

@@ -188,6 +188,9 @@ class Mount {
   // Called when startup is complete and the mount needs to start updating steppers.
   void  startTimerInterrupts();
 
+  // Read the saved configuration from persistent storage
+  void readConfiguration();
+  
 private:
 
   // Reads values from EEPROM that configure the mount (if previously stored)

Software/Arduino code/OpenAstroTracker/OpenAstroTracker.hpp

@@ -18,7 +18,7 @@
 
 #include "Globals.hpp"
 
-String version = "V1.7.14";
+String version = "V1.7.15";
 
 ///////////////////////////////////////////////////////////////////////////
 // Please see the Globals.h file for configuration of the firmware.