V1.7.11 - Updates

- Changed all #defines and #ifdefs to use use numbers and #if statements. Makes it easier to see what to configure instead of everything looking like comments.

Author: ClutchplateDude

Software/Arduino code/OpenAstroTracker/Globals.hpp

@@ -57,33 +57,17 @@ extern byte PolarisRASecond;
 // Set to 1 to reverse the direction of DEC motor
 #define INVERT_DEC_DIR 0
 
-////////////////////////////////////////////////////////////////
-//
-// FEATURE SUPPORT SECTION
-//
-// Since the Arduino Uno has very little memory (32KB code, 2KB data) all features
-// stretch the Uno a little too far. So in order to save memory we allow you to enable 
-// and disable features to help manage memory usage.
-// If you run the tracker with an Arduino Mega, you can uncomment all the features.
-//
-// If you would like to drive your OAT mount with only the LCD Shield, 
-// you should comment out SUPPORT_SERIAL_CONTROL
-//
-// If you feel comfortable with configuring the OAT at startup manually, you should comment 
-// out SUPPORT_GUIDED_STARTUP (maybe after you've used it for a while you know what to do).
-//
-// The POI menu can take a little data memory and you may not need it. If not, you can comment
-// out SUPPORT_POINTS_OF_INTEREST
-//
-////////////////////////////////////////////////////////////////
-
-// If you do not have a LCD shield on your Arduino Uno, uncomment the line below. This is
+// If you do not have a LCD shield on your Arduino Uno, set this to 1 on the line below. This is
 // useful if you are always going to run the mount from a laptop anyway.
-// #define HEADLESS_CLIENT
+#define HEADLESS_CLIENT 0
+
+// This is set to 1 for boards that do not support interrupt timers
+#define RUN_STEPPERS_IN_MAIN_LOOP 0
 
 #if defined(ESP8266) || defined(ESP32)
     #define ESPBOARD
-    #define HEADLESS_CLIENT
+    #undef HEADLESS_CLIENT
+    #define HEADLESS_CLIENT 1
     #define WIFI_ENABLED 
     #define INFRA_SSID "yourSSID"
     #define INFRA_WPAKEY "yourWPAkey"
@@ -94,39 +78,60 @@ extern byte PolarisRASecond;
     // 2 - Attempt Infrastructure, Fail over to AP Mode.
     #define WIFI_MODE 2 
     #if defined(ESP8266) 
-        #define RUN_STEPPERS_IN_MAIN_LOOP
+        #undef RUN_STEPPERS_IN_MAIN_LOOP
+        #define RUN_STEPPERS_IN_MAIN_LOOP 1
     #endif
 #endif
 
 
-// Uncomment this to enable the heating menu
+////////////////////////////////////////////////////////////////
+//
+// FEATURE SUPPORT SECTION
+//
+// Since the Arduino Uno has very little memory (32KB code, 2KB data) all features
+// stretch the Uno a little too far. So in order to save memory we allow you to enable 
+// and disable features to help manage memory usage.
+// If you run the tracker with an Arduino Mega, you can set all the features to 1.
+//
+// If you would like to drive your OAT mount with only the LCD Shield, or are on a Uno,
+// you should set SUPPORT_SERIAL_CONTROL to 0
+//
+// If you feel comfortable with configuring the OAT at startup manually, you should set
+// SUPPORT_GUIDED_STARTUP to 0 (maybe after you've used it for a while you know what to do).
+//
+// The POI menu can take a little data memory and you may not need it. If not, you can set
+// SUPPORT_POINTS_OF_INTEREST to 0
+//
+////////////////////////////////////////////////////////////////
+
+// Set this to 1 this to enable the heating menu
 // NOTE: Heating is currently not supported!
-// #define SUPPORT_HEATING
+#define SUPPORT_HEATING 0
 
-#ifndef HEADLESS_CLIENT
+#if HEADLESS_CLIENT == 0
 
-    // Uncomment to support Guided Startup 
-    #define SUPPORT_GUIDED_STARTUP
+    // Set this to 1 to support Guided Startup 
+    #define SUPPORT_GUIDED_STARTUP 1
 
-    // Uncomment to support full GO (was POI) menu. 
-    // If this is commented out you still have a GO menu that has Home and Park.
-    #define SUPPORT_POINTS_OF_INTEREST
+    // Set this to 1 to support full GO (was POI) menu. 
+    // If this is set to 0 you still have a GO menu that has Home and Park.
+    #define SUPPORT_POINTS_OF_INTEREST 1
 
-    // Uncomment to support CTRL menu, allowing you to manually slew the mount with the buttons. 
-    #define SUPPORT_MANUAL_CONTROL
+    // Set this to 1 to support CTRL menu, allowing you to manually slew the mount with the buttons. 
+    #define SUPPORT_MANUAL_CONTROL 1
 
-    // Uncomment to support CAL menu, allowing you to calibrate various things
-    #define SUPPORT_CALIBRATION
+    // Set this to 1 to support CAL menu, allowing you to calibrate various things
+    #define SUPPORT_CALIBRATION 1
 
-    // Uncomment to support INFO menu that displays various pieces of information about the mount. 
-    #define SUPPORT_INFO_DISPLAY
+    // Set this to 1 to support INFO menu that displays various pieces of information about the mount. 
+    #define SUPPORT_INFO_DISPLAY 1
 
-    // Uncomment to support Serial Meade LX200 protocol support
-    #define SUPPORT_SERIAL_CONTROL
+    // Set this to 1 to support Serial Meade LX200 protocol support
+    #define SUPPORT_SERIAL_CONTROL 1
 
 #else
     // If we are making a headleass (no screen, no keyboard) client, always enable Serial.
-    #define SUPPORT_SERIAL_CONTROL
-#endif
+    #define SUPPORT_SERIAL_CONTROL 1
+#endif  // HEADLESS_CLIENT
 
-#endif
+#endif // _GLOBALS_HPP

Software/Arduino code/OpenAstroTracker/LcdMenu.cpp

@@ -1,7 +1,7 @@
 #include "Utility.hpp"
 #include "LcdMenu.hpp"
 
-#ifndef HEADLESS_CLIENT
+#if HEADLESS_CLIENT == 0
 
 // Class that drives the LCD screen with a menu
 // You add a string and an id item and this class handles the display and navigation

Software/Arduino code/OpenAstroTracker/LcdMenu.hpp

@@ -2,7 +2,7 @@
 #define _LCDMENU_HPP_
 
 #include <Arduino.h>
-#ifndef HEADLESS_CLIENT
+#if HEADLESS_CLIENT == 0
 #include <LiquidCrystal.h>
 #endif
 #include "Globals.hpp"
@@ -69,7 +69,7 @@ class LcdMenu {
   void printChar(char ch);
 
 private:
-#ifndef HEADLESS_CLIENT
+#if HEADLESS_CLIENT == 0
   LiquidCrystal _lcd;   // The LCD screen that we'll display the menu on
   MenuItem** _menuItems;  // The first menu item (linked list)
   byte _numMenuItems;

Software/Arduino code/OpenAstroTracker/MeadeCommandProcessor.cpp

@@ -364,7 +364,7 @@ MeadeCommandProcessor* MeadeCommandProcessor::instance() {
 MeadeCommandProcessor::MeadeCommandProcessor(Mount* mount, LcdMenu* lcdMenu) {
   _mount = mount;
 
-  // In HEADLESS_CLIENT, the lcdMenu is just an empty shell class to save having to null check everywhere
+  // In HEADLESS_CLIENT mode, the lcdMenu is just an empty shell class to save having to null check everywhere
   _lcdMenu = lcdMenu;
 }
 

Software/Arduino code/OpenAstroTracker/Mount.cpp

@@ -127,7 +127,7 @@ void Mount::readPersistentData()
 {
   // Read the magic marker byte and state
   int marker = EEPROM.read(4) + EEPROM.read(5) * 256;
-#ifdef DEBUG_MODE
+#if DEBUG_LEVEL&DEBUG_MOUNT_VERBOSE
   logv("EEPROM: Marker: %x ", marker);
 #endif
 
@@ -218,7 +218,7 @@ void Mount::writePersistentData(int which, int val)
     break;
   }
 
-#ifdef DEBUG_MODE
+#if DEBUG_LEVEL&DEBUG_MOUNT_VERBOSE
   logv("EEPROM Write: New Marker is 0xBE, flag is %x (%d)", flag, flag);
 #endif
 
@@ -1196,7 +1196,7 @@ void Mount::loop() {
 
   // Since some of the boards cannot process timer interrupts at the required 
   // speed (or at all), we'll just stick to deterministic calls here.
-  #ifdef RUN_STEPPERS_IN_MAIN_LOOP 
+  #if RUN_STEPPERS_IN_MAIN_LOOP == 1
   interruptLoop();
   #endif
 
@@ -1533,7 +1533,7 @@ void Mount::moveSteppersTo(float targetRA, float targetDEC) {
 //
 /////////////////////////////////
 void Mount::displayStepperPosition() {
-#ifndef HEADLESS_CLIENT
+#if HEADLESS_CLIENT == 0
 
   String disp;
 
@@ -1563,7 +1563,7 @@ void Mount::displayStepperPosition() {
     _lcdMenu->printMenu(String(scratchBuffer));
   }
   else {
-#ifdef SUPPORT_SERIAL_CONTROL
+#if SUPPORT_SERIAL_CONTROL == 1
     if (inSerialControl) {
       sprintf(scratchBuffer, " RA: %s", RAString(LCD_STRING | CURRENT_STRING).c_str());
       _lcdMenu->setCursor(0, 0);
@@ -1592,7 +1592,7 @@ void Mount::displayStepperPosition() {
 //
 /////////////////////////////////
 void Mount::displayStepperPositionThrottled() {
-#ifndef HEADLESS_CLIENT
+#if HEADLESS_CLIENT == 0
   long elapsed = millis() - _lastDisplayUpdate;
   if (elapsed > DISPLAY_UPDATE_TIME) {
     displayStepperPosition();

Software/Arduino code/OpenAstroTracker/OpenAstroTracker.hpp

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

Software/Arduino code/OpenAstroTracker/OpenAstroTracker.ino

@@ -1,3 +1,4 @@
+// Configuration is now done in OpenAstroTracker.hpp and Globals.hpp 
 #include "OpenAstroTracker.hpp"
 #include "a_inits.hpp"
 #include "b_setup.hpp"

Software/Arduino code/OpenAstroTracker/a_inits.hpp

@@ -179,7 +179,7 @@
 // How many menu items at most?
 #define MAXMENUITEMS 10
 
-#ifdef SUPPORT_GUIDED_STARTUP
+#if SUPPORT_GUIDED_STARTUP == 1
 bool inStartup = true;        // Start with a guided startup
 #else
 bool inStartup = false;        // Start with a guided startup
@@ -204,7 +204,7 @@ int DECselect;
 // HA variables
 int HAselect;
 
-#ifdef SUPPORT_HEATING
+#if SUPPORT_HEATING == 1
 // HEAT menu variables
 int heatselect;   // Which stepper are we changing?
 int RAheat = 0;   // Are we heating the RA stepper?

Software/Arduino code/OpenAstroTracker/b_setup.hpp

@@ -133,7 +133,7 @@ void finishSetup()
   lcdMenu.printMenu("OpenAstroTracker");
   lcdMenu.setCursor(0, 1);
   lcdMenu.printMenu("     " + version);
-#ifndef HEADLESS_CLIENT
+#if HEADLESS_CLIENT == 0
   unsigned long now = millis();
 #endif
   // Create the command processor singleton
@@ -181,32 +181,32 @@ void finishSetup()
   // Start the tracker.
   mount.startSlewing(TRACKING);
 
-#ifndef HEADLESS_CLIENT
+#if HEADLESS_CLIENT == 0
   // Create the LCD top-level menu items
   lcdMenu.addItem("RA", RA_Menu);
   lcdMenu.addItem("DEC", DEC_Menu);
 
-#ifdef SUPPORT_POINTS_OF_INTEREST
+#if SUPPORT_POINTS_OF_INTEREST == 1
   lcdMenu.addItem("GO", POI_Menu);
 #else
   lcdMenu.addItem("GO", Home_Menu);
 #endif
 
   lcdMenu.addItem("HA", HA_Menu);
 
-#ifdef SUPPORT_HEATING
+#if SUPPORT_HEATING == 1
   lcdMenu.addItem("HEA", Heat_Menu);
 #endif
 
-#ifdef SUPPORT_MANUAL_CONTROL
+#if SUPPORT_MANUAL_CONTROL == 1
   lcdMenu.addItem("CTRL", Control_Menu);
 #endif
 
-#ifdef SUPPORT_CALIBRATION
+#if SUPPORT_CALIBRATION == 1
   lcdMenu.addItem("CAL", Calibration_Menu);
 #endif
 
-#ifdef SUPPORT_INFO_DISPLAY
+#if SUPPORT_INFO_DISPLAY == 1
   lcdMenu.addItem("INFO", Status_Menu);
 #endif
 

Software/Arduino code/OpenAstroTracker/c65_startup.hpp

@@ -1,7 +1,7 @@
 #pragma once
 
-#ifndef HEADLESS_CLIENT
-#ifdef SUPPORT_GUIDED_STARTUP
+#if HEADLESS_CLIENT == 0
+#if SUPPORT_GUIDED_STARTUP == 1
 //////////////////////////////////////////////////////////////
 // This file contains the Starup 'wizard' that guides you through initial setup