OLED tweaks part 2: Electric Boogaloo (ExpressLRS#1050)

FOG-Yamato · web-flow · commit a19505c4aa04 · 2021-11-05T11:06:20.000+10:00
* Fix OLED definitions for supported targets
Fix Ghost TX and TX Lite includes

* Fixed missed references to the old OLED defines
Added define macros to the XBMStrings
Moved includes into the header file

* Reverted OLED includes to the implementation file
diff --git a/src/include/target/BETAFPV_2400_TX_MICRO.h b/src/include/target/BETAFPV_2400_TX_MICRO.h
@@ -1,8 +1,7 @@
 #define DEVICE_NAME              "BETAFPV 2400TX Micro"
 
 // Any device features
-#define HAS_OLED
-#define HAS_OLED_I2C
+#define USE_OLED_I2C
 #define OLED_REVERSED
 
 // There is some special handling for this target
diff --git a/src/include/target/BETAFPV_900_TX_MICRO.h b/src/include/target/BETAFPV_900_TX_MICRO.h
@@ -4,8 +4,7 @@
 #define TARGET_TX_BETAFPV_900_MICRO_V1
 
 // Any device features
-#define HAS_OLED
-#define HAS_OLED_I2C
+#define USE_OLED_I2C
 #define OLED_REVERSED
   
 // GPIO pin definitions
diff --git a/src/include/target/DIY_2400_TX_ESP32_SX1280_E28.h b/src/include/target/DIY_2400_TX_ESP32_SX1280_E28.h
@@ -3,8 +3,7 @@
 #endif
 
 // Any device features
-#define HAS_OLED
-#define HAS_OLED_SPI
+#define USE_OLED_SPI
 
 // GPIO pin definitions
 #define GPIO_PIN_NSS            5
diff --git a/src/include/target/DIY_900_TX_TTGO_V1_SX127x.h b/src/include/target/DIY_900_TX_TTGO_V1_SX127x.h
@@ -2,8 +2,7 @@
 #define DEVICE_NAME "DIY900 TTGO V1"
 
 // Any device features
-#define HAS_OLED
-#define HAS_OLED_I2C
+#define USE_OLED_I2C
 
 // GPIO pin definitions
 #define GPIO_PIN_NSS 18
diff --git a/src/include/target/DIY_900_TX_TTGO_V2_SX127x.h b/src/include/target/DIY_900_TX_TTGO_V2_SX127x.h
@@ -2,8 +2,7 @@
 #define DEVICE_NAME "DIY900 TTGO V2"
 
 // Any device features
-#define HAS_OLED
-#define HAS_OLED_I2C
+#define USE_OLED_I2C
 
 // GPIO pin definitions
 #define GPIO_PIN_NSS 18
diff --git a/src/include/target/GHOST_2400_TX.h b/src/include/target/GHOST_2400_TX.h
@@ -1,11 +1,13 @@
-#define DEVICE_NAME              "Ghost 24TX"
-
+#if !defined(DEVICE_NAME)
+    #define DEVICE_NAME             "Ghost 24TX"
+#endif
 // There is some special handling for this target
 #define TARGET_TX_GHOST
 
 // Any device features
-#define HAS_OLED
-#define HAS_OLED_SPI
+#if !defined(USE_OLED_SPI_SMALL)
+    #define USE_OLED_SPI
+#endif
 
 // GPIO pin definitions
 #define GPIO_PIN_NSS                PA15
@@ -37,5 +39,4 @@
 #define MaxPower                    PWR_250mW
 #define POWER_OUTPUT_VALUES         {-16,-14,-11,-8,-4}
 
-#define HAS_OLED
 #define Regulatory_Domain_ISM_2400 1
diff --git a/src/include/target/GHOST_2400_TX_LITE.h b/src/include/target/GHOST_2400_TX_LITE.h
@@ -1,10 +1,6 @@
 // This target extends the GHOST_2400_TX target
-
-#undef DEVICE_NAME
 #define DEVICE_NAME              "Ghost 24TX Lite"
 
 // There is some special handling for this target
 #define TARGET_TX_GHOST_LITE
-
-#undef HAS_OLED_SPI  // We are extending ghost tx full so we have to remote this
-#define HAS_OLED_SPI_SMALL
+#define USE_OLED_SPI_SMALL
diff --git a/src/include/target/NamimnoRC_FLASH_2400_OLED_TX.h b/src/include/target/NamimnoRC_FLASH_2400_OLED_TX.h
@@ -2,7 +2,7 @@
 
 // Features
 #define USE_TX_BACKPACK
-#define USE_OLED
+#define USE_OLED_SPI
 
 // GPIO pin definitions
 #define GPIO_PIN_RST            21
diff --git a/src/include/target/NamimnoRC_VOYAGER_900_OLED_TX.h b/src/include/target/NamimnoRC_VOYAGER_900_OLED_TX.h
@@ -2,7 +2,7 @@
 
 // Features
 #define USE_TX_BACKPACK
-#define USE_OLED
+#define USE_OLED_SPI
 
 // GPIO pin definitions
 #define GPIO_PIN_RST            21
diff --git a/src/lib/OLED/OLED.cpp b/src/lib/OLED/OLED.cpp
@@ -14,40 +14,42 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 
-#ifdef HAS_OLED // This code will not be used if the hardware does not have a OLED display. Maybe a better way to blacklist it in platformio.ini?
+#if defined(USE_OLED_SPI) || defined(USE_OLED_SPI_SMALL) || defined(USE_OLED_I2C) // This code will not be used if the hardware does not have a OLED display. Maybe a better way to blacklist it in platformio.ini?
 
 // Default header files for Express LRS
 #include "targets.h"
-// OLED specific header files
+// OLED specific header files. 
 #include "OLED.h"
 #include <U8g2lib.h>    // Needed for the OLED drivers, this is a arduino package. It is maintained by platformIO
-#include "XBMStrings.h" // Contains all the express logos and animation for UI
+#include "XBMStrings.h" // Contains all the ELRS logos and animations for the UI
 
-#ifdef HAS_OLED_SPI_SMALL
-U8G2_SSD1306_128X32_UNIVISION_F_4W_SW_SPI u8g2(U8G2_R0, GPIO_PIN_OLED_SCK, GPIO_PIN_OLED_MOSI, GPIO_PIN_OLED_CS, GPIO_PIN_OLED_DC, GPIO_PIN_OLED_RST);
+#ifdef OLED_REVERSED
+    #define OLED_ROTATION U8G2_R2
+#else
+    #define OLED_ROTATION U8G2_R0
 #endif
 
-#ifdef HAS_OLED_SPI
-U8G2_SSD1306_128X64_NONAME_F_4W_SW_SPI u8g2(U8G2_R0, GPIO_PIN_OLED_SCK, GPIO_PIN_OLED_MOSI, GPIO_PIN_OLED_CS, GPIO_PIN_OLED_DC, GPIO_PIN_OLED_RST);
+#ifdef USE_OLED_SPI_SMALL
+U8G2_SSD1306_128X32_UNIVISION_F_4W_SW_SPI u8g2(OLED_ROTATION, GPIO_PIN_OLED_SCK, GPIO_PIN_OLED_MOSI, GPIO_PIN_OLED_CS, GPIO_PIN_OLED_DC, GPIO_PIN_OLED_RST);
 #endif
 
-#ifdef HAS_OLED_I2C
-#ifdef OLED_REVERSED
-U8G2_SSD1306_128X64_NONAME_F_HW_I2C u8g2(U8G2_R2, GPIO_PIN_OLED_RST, GPIO_PIN_OLED_SCK, GPIO_PIN_OLED_SDA);
-#else
-U8G2_SSD1306_128X64_NONAME_F_HW_I2C u8g2(U8G2_R0, GPIO_PIN_OLED_RST, GPIO_PIN_OLED_SCK, GPIO_PIN_OLED_SDA);
+#ifdef USE_OLED_SPI
+U8G2_SSD1306_128X64_NONAME_F_4W_SW_SPI u8g2(OLED_ROTATION, GPIO_PIN_OLED_SCK, GPIO_PIN_OLED_MOSI, GPIO_PIN_OLED_CS, GPIO_PIN_OLED_DC, GPIO_PIN_OLED_RST);
 #endif
-#endif 
 
+#ifdef USE_OLED_I2C
+U8G2_SSD1306_128X64_NONAME_F_HW_I2C u8g2(OLED_ROTATION, GPIO_PIN_OLED_RST, GPIO_PIN_OLED_SCK, GPIO_PIN_OLED_SDA);
+#endif
 
+#ifdef TARGET_TX_GHOST
 /**
  * helper function is used to draw xbmp on the OLED. 
  * x = x position of the image
  * y = y position of the image
  * size = demensions of the box size x size, this only works for square images 1:1
  * image = XBM character string
  */
-void helper(int x, int y, int size,  const unsigned char * image){
+static void helper(int x, int y, int size,  const unsigned char * image){
     u8g2.clearBuffer();
     u8g2.drawXBMP(x, y, size, size, image);
     u8g2.sendBuffer();
@@ -56,7 +58,7 @@ void helper(int x, int y, int size,  const unsigned char * image){
 /**
  *  ghostChase will only be called for ghost TX hardware.  
  */
-void ghostChase(){
+static void ghostChase(){
     // Using i < 16 and (i*4) to get 64 total pixels. Change to i < 32 (i*2) to slow animation. 
     for(int i = 0; i < 20; i++){
         u8g2.clearBuffer();
@@ -74,12 +76,13 @@ void ghostChase(){
      *  helper function just draw's the XBM strings.   
      */
     #ifndef TARGET_TX_GHOST_LITE
-    helper(38,12,40,elrs40);
-    helper(36,8,48,elrs48);
-    helper(34,4,56,elrs56);
-    helper(32,0,64,elrs64);
+        helper(38,12,40,elrs40);
+        helper(36,8,48,elrs48);
+        helper(34,4,56,elrs56);
+        helper(32,0,64,elrs64);
     #endif
 }
+#endif
 
 /**
  * Displays the ExpressLRS logo
@@ -90,10 +93,10 @@ void ghostChase(){
 void OLED::displayLogo(){
     u8g2.begin();
     u8g2.clearBuffer();
-    #if defined TARGET_TX_GHOST
+    #ifdef TARGET_TX_GHOST
         ghostChase();
     #else
-        #if defined HAS_OLED_SPI_SMALL
+        #ifdef USE_OLED_SPI_SMALL
             u8g2.drawXBM(48, 0, 32, 32, elrs32);
         #else
             u8g2.drawXBM(32, 0, 64, 64, elrs64);
@@ -113,27 +116,22 @@ void OLED::displayLogo(){
 void OLED::updateScreen(const char * power, const char * rate, const char * ratio, const char * commitStr){
     u8g2.clearBuffer();
 
-    #if defined HAS_OLED_SPI_SMALL
+    #ifdef USE_OLED_SPI_SMALL
         u8g2.setFont(u8g2_font_courR10_tr);
         u8g2.drawStr(0,15, rate);
-        u8g2.setFont(u8g2_font_courR10_tr);
         u8g2.drawStr(70,15 , ratio);
         u8g2.drawStr(0,32, power);
-        u8g2.setFont(u8g2_font_courR10_tr);
         u8g2.drawStr(70,32, commitStr);
     #else
         u8g2.setFont(u8g2_font_courR10_tr);
         u8g2.drawStr(0,10, "ExpressLRS");
-        u8g2.setFont(u8g2_font_courR08_tr);
-        u8g2.drawStr(0,24, "Ver: ");
-        u8g2.drawStr(38,24, commitStr);
-        u8g2.setFont(u8g2_font_courR10_tr);
         u8g2.drawStr(0,42, rate);
-        u8g2.setFont(u8g2_font_courR10_tr);
         u8g2.drawStr(70,42 , ratio);
         u8g2.drawStr(0,57, power);
         u8g2.setFont(u8g2_font_courR08_tr);
         u8g2.drawStr(70,53, "TLM");
+        u8g2.drawStr(0,24, "Ver: ");
+        u8g2.drawStr(38,24, commitStr);
     #endif
     u8g2.sendBuffer();
 }
diff --git a/src/lib/OLED/OLED.h b/src/lib/OLED/OLED.h
@@ -15,11 +15,6 @@
  */
 
 #pragma once
-// Default header files for Express LRS
-#include "targets.h"
-// OLED specific header files. 
-#include <U8g2lib.h>   // Needed for the OLED drivers, this is a arduino package. It is maintained by platformIO
-
 
 class OLED
 {
diff --git a/src/lib/OLED/XBMStrings.h b/src/lib/OLED/XBMStrings.h
diff --git a/src/lib/OLED/devOLED.cpp b/src/lib/OLED/devOLED.cpp
diff --git a/src/src/tx_main.cpp b/src/src/tx_main.cpp
diff --git a/src/targets/imrc.ini b/src/targets/imrc.ini
