Renamed HEADLESS_CLIENT to DISPLAY_TYPE

Author: andre-stefanov

.github/workflows/platformio.yml

@@ -10,7 +10,7 @@ on:
 
 jobs:
   build:
-    name: ${{ matrix.board }} STEPPER=${{ matrix.stepper }} DRIVER=${{ matrix.driver }} GPS=${{ matrix.gps }} GYRO=${{ matrix.gyro }} ALTAZ=${{ matrix.azalt }} HEADLESS=${{ matrix.headless }}
+    name: ${{ matrix.board }} STEPPER=${{ matrix.stepper }} DRIVER=${{ matrix.driver }} GPS=${{ matrix.gps }} GYRO=${{ matrix.gyro }} ALTAZ=${{ matrix.azalt }} DISPLAY=${{ matrix.display }}
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -20,7 +20,7 @@ jobs:
         gps:      [0, 1]
         gyro:     [0, 1]
         azalt:    [0, 1]
-        headless: [0, 1]
+        display:  [0, 1]
         exclude:
           - { stepper: 1, driver: 0 } # NEMA17 & ULN2003
           - { stepper: 0, driver: 1 } # 28BYJ48 & GENERIC
@@ -50,4 +50,4 @@ jobs:
         -D USE_GPS=${{ matrix.gps }}
         -D USE_GYRO_LEVEL=${{ matrix.gyro }}
         -D AZIMUTH_ALTITUDE_MOTORS=${{ matrix.azalt }}
-        -D HEADLESS_CLIENT=${{ matrix.headless }}
+        -D DISPLAY_TYPE=${{ matrix.display }}

Software/Arduino code/OpenAstroTracker/Configuration.hpp

@@ -40,6 +40,11 @@
 #define NORTHERN_HEMISPHERE 1
 #endif
 
+// Used display
+#ifndef DISPLAY_TYPE
+#define DISPLAY_TYPE DISPLAY_TYPE_LCD_KEYPAD
+#endif
+
 // Used RA wheel version. Unless you printed your OAT before March 2020, you're using 
 // a version 2 or higher (software only differentiates between 1 and more than 1)
 #ifndef RA_WHEEL_VERSION

Software/Arduino code/OpenAstroTracker/Configuration_adv.hpp

@@ -2,6 +2,12 @@
 
 #include "Configuration.hpp"
 
+/**
+ * This file contains advanced configurations. Edit values here only if you know what you are doing. Invalid values
+ * can lead to OAT misbehaving very bad and in worst case could even lead to hardware damage. The default values here
+ * were chosen after many tests and can are currently concidered to work the best.
+ **/
+
 // This is how many steps your stepper needs for a full rotation.
 #if RA_STEPPER_TYPE == STEPPER_TYPE_28BYJ48
   #define RA_STEPPER_SPR            4096  // 28BYJ-48 = 4096  |  NEMA 0.9° = 400  |  NEMA 1.8° = 200
@@ -122,20 +128,6 @@
 #define DISPLAY_UPDATE_TIME 200
 
 
-////////////////////////////
-//
-// HEADLESS CLIENT
-// If you do not have a LCD shield on your Arduino Mega, set this to 1 on the line below. This is
-// useful if you are always going to run the mount from a laptop anyway.
-#ifndef HEADLESS_CLIENT
-#define HEADLESS_CLIENT 0
-#endif
-
-#ifdef __AVR_ATmega328P__   // UNO must use headless
-#undef HEADLESS_CLIENT
-#define HEADLESS_CLIENT 1
-#endif
-
 ////////////////////////////
 //
 // LCD BUTTON TEST
@@ -160,7 +152,8 @@
 #define ALTITUDE_ARC_SECONDS_PER_STEP (0.61761f)
 #define ALTITUDE_STEPS_PER_ARC_MINUTE (60.0f/ALTITUDE_ARC_SECONDS_PER_STEP)
 
-#if HEADLESS_CLIENT == 0 // <-- Ignore this line
+#if DISPLAY_TYPE > 0
+
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 //                         ///
 // FEATURE SUPPORT SECTION ///
@@ -171,9 +164,6 @@
 // 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).
 //
@@ -197,14 +187,17 @@
 // Set this to 1 to support INFO menu that displays various pieces of information about the mount. 
   #define SUPPORT_INFO_DISPLAY         1
 
-// Set this to 1 to support Serial Meade LX200 protocol support
-  #define SUPPORT_SERIAL_CONTROL       1
-
-#endif  // HEADLESS_CLIENT <-- Ignore this    
+#endif  // DISPLAY_TYPE
 
+// Enable Meade protocol communication over serial
+#ifdef __AVR_ATmega328P__
+#define SUPPORT_SERIAL_CONTROL 0
+#else 
+#define SUPPORT_SERIAL_CONTROL 1
+#endif
 
 
-#if defined(ESP8266) || defined(ESP32) // <-- ignore this line
+#if defined(ESP8266) || defined(ESP32)
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 //                //////////
 // WIFI SETTINGS  //////////
@@ -214,8 +207,8 @@
 //
 // Define some things, dont change: ///
 #define ESPBOARD
-#undef HEADLESS_CLIENT
-#define HEADLESS_CLIENT 1
+#undef DISPLAY_TYPE
+#define DISPLAY_TYPE DISPLAY_TYPE_NONE
 // #define BLUETOOTH_ENABLED
 #define WIFI_ENABLED 
 #if defined(ESP8266) 
@@ -306,15 +299,6 @@
 #error "Sorry, Arduino Uno only supports 28BYJ48 steppers."
 #endif
 
-
-
-////////////////////////////
-// Misc stuff, ignore
-
-#if HEADLESS_CLIENT == 1 
-#define SUPPORT_SERIAL_CONTROL 1
-#endif
-
 // Set this to 1 this to enable the heating menu
 // NOTE: Heating is currently not supported!
 #define SUPPORT_HEATING 0

Software/Arduino code/OpenAstroTracker/Constants.hpp

@@ -1,14 +1,20 @@
 #pragma once
 
 /*
-* This file contains constants that should not be changed.
+* This file contains constants that SHOULD NOT BE CHANGED by oat users!
+* If you are a developer and want to add new hardware support, add a
+* proper definition here with increased value.
 */
 
-// Supported stepper models, do not modify these values.
+// Supported display types
+#define DISPLAY_TYPE_NONE           0
+#define DISPLAY_TYPE_LCD_KEYPAD     1
+
+// Supported stepper models
 #define STEPPER_TYPE_28BYJ48  0
 #define STEPPER_TYPE_NEMA17   1
 
-// Supported stepper driver models, do not modify these values.
+// Supported stepper driver models
 #define DRIVER_TYPE_ULN2003              0
 #define DRIVER_TYPE_GENERIC              1
 #define DRIVER_TYPE_TMC2209_STANDALONE   2

Software/Arduino code/OpenAstroTracker/src/LcdMenu.cpp

@@ -2,7 +2,7 @@
 #include "EPROMStore.hpp"
 #include "LcdMenu.hpp"
 
-#if HEADLESS_CLIENT == 0
+#if DISPLAY_TYPE > 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/src/LcdMenu.hpp

@@ -2,7 +2,7 @@
 #define _LCDMENU_HPP_
 
 #include <Arduino.h>
-#if HEADLESS_CLIENT == 0
+#if DISPLAY_TYPE > 0
 #include <LiquidCrystal.h>
 #endif
 #include "../Configuration_adv.hpp"
@@ -77,7 +77,7 @@ class LcdMenu {
   void printChar(char ch);
 
 private:
-#if HEADLESS_CLIENT == 0
+#if DISPLAY_TYPE > 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/src/Mount.cpp

@@ -2259,7 +2259,7 @@ void Mount::moveSteppersTo(float targetRA, float targetDEC) {
 //
 /////////////////////////////////
 void Mount::displayStepperPosition() {
-#if HEADLESS_CLIENT == 0
+#if DISPLAY_TYPE > 0
 
   String disp;
 
@@ -2323,7 +2323,7 @@ void Mount::displayStepperPosition() {
 //
 /////////////////////////////////
 void Mount::displayStepperPositionThrottled() {
-#if HEADLESS_CLIENT == 0
+#if DISPLAY_TYPE > 0
   long elapsed = millis() - _lastDisplayUpdate;
   if (elapsed > DISPLAY_UPDATE_TIME) {
     displayStepperPosition();

Software/Arduino code/OpenAstroTracker/src/Mount.hpp

@@ -1,7 +1,7 @@
 #ifndef _MOUNT_HPP_
 #define _MOUNT_HPP_
 
-#if HEADLESS_CLIENT == 0
+#if DISPLAY_TYPE > 0
 #include <LiquidCrystal.h>
 #endif
 

Software/Arduino code/OpenAstroTracker/src/a_inits.hpp

@@ -1,7 +1,7 @@
 #pragma once
 
 #include <AccelStepper.h>
-#if HEADLESS_CLIENT == 0
+#if DISPLAY_TYPE > 0
 #include <LiquidCrystal.h>
 #endif
 #include "inc/Globals.hpp"

Software/Arduino code/OpenAstroTracker/src/b_setup.hpp

@@ -191,7 +191,7 @@ void finishSetup()
   lcdMenu.setCursor(5, 1);
   lcdMenu.printMenu(VERSION);
 
-  #if HEADLESS_CLIENT == 0
+  #if DISPLAY_TYPE > 0
     // Check for EEPROM reset (Button down during boot)
     if (lcdButtons.currentState() == btnDOWN){
       LOGV1(DEBUG_INFO, F("Erasing configuration in EEPROM!"));
@@ -278,7 +278,7 @@ void finishSetup()
   LOGV1(DEBUG_ANY, F("Start Tracking..."));
   mount.startSlewing(TRACKING);
 
-  #if HEADLESS_CLIENT == 0
+  #if DISPLAY_TYPE > 0
     LOGV1(DEBUG_ANY, F("Setup menu system..."));
 
     // Create the LCD top-level menu items