Merge pull request #103 from OpenAstroTech/rename-headless-to-display-type

Renamed HEADLESS_CLIENT to DISPLAY_TYPE

Author: ClutchplateDude

.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
@@ -30,6 +30,7 @@ jobs:
           - { board: esp32, gps: 1 }
           - { board: esp32, gyro: 1 }
           - { board: esp32, azalt: 1 }
+          - { board: esp32, display: 1 }
 
     steps:
     - uses: actions/checkout@v1
@@ -50,4 +51,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,29 +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
-
-////////////////////////////
-//
-// ARDUINO RGB LCD SHIELD I2C
-// There are two different chips supported by the LiquidTWI2 library,
-// check the marking on your shield
-#define I2C_DISPLAY 0
-#define I2C_TYPE_MCP23008 0
-#define I2C_TYPE_MCP23017 1
-
-#ifdef __AVR_ATmega328P__   // UNO must use headless
-#undef HEADLESS_CLIENT
-#define HEADLESS_CLIENT 1
-#endif
-
 ////////////////////////////
 //
 // LCD BUTTON TEST
@@ -169,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 ///
@@ -180,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).
 //
@@ -206,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  //////////
@@ -223,8 +207,6 @@
 //
 // Define some things, dont change: ///
 #define ESPBOARD
-#undef HEADLESS_CLIENT
-#define HEADLESS_CLIENT 1
 // #define BLUETOOTH_ENABLED
 #define WIFI_ENABLED 
 #if defined(ESP8266) 
@@ -315,15 +297,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,16 +1,35 @@
 #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.
-#define STEPPER_TYPE_28BYJ48  0
-#define STEPPER_TYPE_NEMA17   1
+/**
+ * Supported display types. Use one of these values for DISPLAY_TYPE configuration matching your used display.
+ * 
+ * DISPLAY_TYPE_NONE:                       No display. Use this if you don't use any display.
+ * DISPLAY_TYPE_LCD_KEYPAD:                 1602 LCD Keypad shield which can be mounted directly to an Arduino UNO / Mega boards.
+ *                                          Example: https://www.digikey.com/en/products/detail/dfrobot/DFR0009/7597118
+ * DISPLAY_TYPE_LCD_KEYPAD_I2C_MCP23008:    RGB LCD Keypad shield based on the MCP23008 I/O Expander. It can be mounted 
+ *                                          directly to an Arduino UNO / Mega boards and controlled over I2C.
+ * DISPLAY_TYPE_LCD_KEYPAD_I2C_MCP23017:    RGB LCD Keypad shield based on the MCP23017 I/O Expander. It can be mounted 
+ *                                          directly to an Arduino UNO / Mega boards and controlled over I2C.                                         
+ **/
+#define DISPLAY_TYPE_NONE                       0
+#define DISPLAY_TYPE_LCD_KEYPAD                 1
+#define DISPLAY_TYPE_LCD_KEYPAD_I2C_MCP23008    2
+#define DISPLAY_TYPE_LCD_KEYPAD_I2C_MCP23017    3
 
-// Supported stepper driver models, do not modify these values.
-#define DRIVER_TYPE_ULN2003              0
-#define DRIVER_TYPE_GENERIC              1
-#define DRIVER_TYPE_TMC2209_STANDALONE   2
-#define DRIVER_TYPE_TMC2209_UART         3
 
+// Supported stepper models
+#define STEPPER_TYPE_28BYJ48    0
+#define STEPPER_TYPE_NEMA17     1
+
+
+// Supported stepper driver models
+#define DRIVER_TYPE_ULN2003             0
+#define DRIVER_TYPE_GENERIC             1
+#define DRIVER_TYPE_TMC2209_STANDALONE  2
+#define DRIVER_TYPE_TMC2209_UART        3

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

@@ -2,24 +2,24 @@
 #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
 // Create a new menu, using the given number of LCD display columns and rows
-#if I2C_DISPLAY == 0
+#if DISPLAY_TYPE == DISPLAY_TYPE_LCD_KEYPAD
 LcdMenu::LcdMenu(byte cols, byte rows, int maxItems) : _lcd(8, 9, 4, 5, 6, 7)
 {
   _cols = cols;
   _rows = rows;
   _maxItems = maxItems;
 }
-#else
+#elif DISPLAY_TYPE == DISPLAY_TYPE_LCD_KEYPAD_I2C_MCP23008 || DISPLAY_TYPE == DISPLAY_TYPE_LCD_KEYPAD_I2C_MCP23017
 LcdMenu::LcdMenu(byte cols, byte rows, int maxItems) : _lcd(0x20)
 {
-  #if I2C_DISPLAY == 1 && I2C_TYPE_MCP23017 == 1
+  #if DISPLAY_TYPE == DISPLAY_TYPE_LCD_KEYPAD_I2C_MCP23017
   _lcd.setMCPType(LTI_TYPE_MCP23017);
-  #elif I2C_DISPLAY == 1 && I2C_TYPE_MCP23008 == 1
+  #elif DISPLAY_TYPE == DISPLAY_TYPE_LCD_KEYPAD_I2C_MCP23008
   _lcd.setMCPType(LTI_TYPE_MCP23008);
   #endif
 
@@ -44,7 +44,7 @@ void LcdMenu::startup()
   _lastDisplay[1] = "";
   _menuItems = new MenuItem *[_maxItems];
 
-  #if I2C_DISPLAY == 1 // TODO, store custom color
+  #if DISPLAY_TYPE == DISPLAY_TYPE_LCD_KEYPAD_I2C_MCP23008 || DISPLAY_TYPE == DISPLAY_TYPE_LCD_KEYPAD_I2C_MCP23017
   _lcd.setBacklight(RED);
   #endif
 
@@ -264,7 +264,7 @@ void LcdMenu::printAt(int col, int row, char ch)
   printChar(ch);
 }
 
-#if I2C_DISPLAY == 1
+#if DISPLAY_TYPE == DISPLAY_TYPE_LCD_KEYPAD_I2C_MCP23008 || DISPLAY_TYPE == DISPLAY_TYPE_LCD_KEYPAD_I2C_MCP23017
 uint8_t LcdMenu::readButtons()
 {
   return _lcd.readButtons();

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

@@ -3,13 +3,12 @@
 #include <Arduino.h>
 #include "../Configuration_adv.hpp"
 
-#if HEADLESS_CLIENT == 0 && I2C_DISPLAY == 1
-#include <LiquidTWI2.h>
-#elif HEADLESS_CLIENT == 0 && I2C_DISPLAY == 0
+#if DISPLAY_TYPE == DISPLAY_TYPE_LCD_KEYPAD
 #include <LiquidCrystal.h>
+#elif DISPLAY_TYPE == DISPLAY_TYPE_LCD_KEYPAD_I2C_MCP23008 || DISPLAY_TYPE == DISPLAY_TYPE_LCD_KEYPAD_I2C_MCP23017
+#include <LiquidTWI2.h>
 #endif
 
-
 // A single menu item (like RA, HEAT, POL, etc.)
 // The ID is just a number, it has no relevance for the order of the items
 // The display is what is shown on the menu.
@@ -77,7 +76,7 @@ class LcdMenu {
   // Print a character at a specific position
   void printAt(int col, int row, char ch);
 
-  #if I2C_DISPLAY == 1
+  #if DISPLAY_TYPE == DISPLAY_TYPE_LCD_KEYPAD_I2C_MCP23008 || DISPLAY_TYPE == DISPLAY_TYPE_LCD_KEYPAD_I2C_MCP23017
   uint8_t readButtons();
   #endif
 
@@ -86,17 +85,18 @@ class LcdMenu {
   void printChar(char ch);
 
 private:
-#if HEADLESS_CLIENT == 0
+#if DISPLAY_TYPE > 0
 
   byte _cols;
   byte _rows;
   byte _maxItems;
 
-  #if I2C_DISPLAY == 0
+  #if DISPLAY_TYPE == DISPLAY_TYPE_LCD_KEYPAD
     LiquidCrystal _lcd;   // The LCD screen that we'll display the menu on
-  #else
+  #elif DISPLAY_TYPE == DISPLAY_TYPE_LCD_KEYPAD_I2C_MCP23008 || DISPLAY_TYPE == DISPLAY_TYPE_LCD_KEYPAD_I2C_MCP23017
     LiquidTWI2 _lcd;   // The LCD screen that we'll display the menu on
   #endif
+  
   MenuItem** _menuItems;  // The first menu item (linked list)
   byte _numMenuItems;
   byte _activeMenuIndex;

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

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

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/Utility.hpp

@@ -179,8 +179,8 @@ class LcdButtons {
 private:
   void checkKey() {
 
-    #if HEADLESS_CLIENT == 0
-    #if I2C_DISPLAY == 1
+    #if DISPLAY_TYPE > 0
+    #if DISPLAY_TYPE == DISPLAY_TYPE_LCD_KEYPAD_I2C_MCP23008 || DISPLAY_TYPE == DISPLAY_TYPE_LCD_KEYPAD_I2C_MCP23017
     uint8_t buttons = _lcdMenu->readButtons();
     _currentKey = btnNONE;
     if (buttons)