Tie in enable/disable for charlcd writes

Author: brentru

src/components/i2c/WipperSnapper_I2C.cpp

@@ -856,7 +856,7 @@ bool WipperSnapper_Component_I2C::initI2CDevice(
     _charLcd = new WipperSnapper_I2C_Driver_Out_CharLcd(this->_i2c, i2cAddress);
     _charLcd->ConfigureCharLcd(
         msgDeviceInitReq->i2c_output_add.config.char_lcd_config.rows,
-        msgDeviceInitReq->i2c_output_add.config.char_lcd_config.columns, true);
+        msgDeviceInitReq->i2c_output_add.config.char_lcd_config.columns);
     if (!_charLcd->begin()) {
       WS_DEBUG_PRINTLN("ERROR: Failed to initialize Character LCD!");
       _busStatusResponse =
@@ -867,9 +867,9 @@ bool WipperSnapper_Component_I2C::initI2CDevice(
     WS_DEBUG_PRINTLN("Char LCD Display Initialized Successfully!");
   } else if (strcmp("7seg", msgDeviceInitReq->i2c_device_name) == 0) {
     _sevenSeg = new WipperSnapper_I2C_Driver_Out_7Seg(this->_i2c, i2cAddress);
-    _sevenSeg->ConfigureCharLcd(
-        msgDeviceInitReq->i2c_output_add.config.char_lcd_config.rows,
-        msgDeviceInitReq->i2c_output_add.config.char_lcd_config.columns, true);
+    _sevenSeg->ConfigureI2CBackpack(
+        msgDeviceInitReq->i2c_output_add.config.led_backpack_config.brightness,
+        msgDeviceInitReq->i2c_output_add.config.led_backpack_config.alignment);
     if (!_sevenSeg->begin()) {
       WS_DEBUG_PRINTLN("ERROR: Failed to initialize 7-Segement LED Matrix!");
       _busStatusResponse =

src/components/i2c/drivers/WipperSnapper_I2C_Driver_Out.h

@@ -53,26 +53,6 @@ class WipperSnapper_I2C_Driver_Out : public WipperSnapper_I2C_Driver {
     // noop
   }
 
-  /*!
-      @brief    Writes a floating point value to an i2c output device.
-      @param    value
-                  The value to be displayed. Only the first four digits are
-     displayed.
-  */
-  virtual void WriteValue(float value) {
-    // noop
-  }
-
-  /*!
-      @brief    Writes a floating point value to an i2c output device.
-      @param    value
-                  The value to be displayed. Only the first four digits are
-     displayed.
-  */
-  virtual void WriteValue(int32_t value) {
-    // noop
-  }
-
   /*!
       @brief    Configures a LED backpack.
       @param    brightness
@@ -100,29 +80,10 @@ class WipperSnapper_I2C_Driver_Out : public WipperSnapper_I2C_Driver {
       @returns  True if the message was written successfully, False otherwise.
   */
   bool WriteLedBackpack(wippersnapper_i2c_v1_LedBackpackWrite *msg_write) {
-    // Check if we should adjust brightness
     if (msg_write->adjust_brightness)
       SetLedBackpackBrightness((uint8_t)msg_write->brightness);
 
-    // Write the message to a LED backpack
-    switch (msg_write->which_message) {
-    case wippersnapper_i2c_v1_LedBackpackWrite_text_tag:
-      WS_DEBUG_PRINTLN("[i2c] Writing text to LED backpack...");
-      WriteMessage(msg_write->message.text);
-      break;
-    case wippersnapper_i2c_v1_LedBackpackWrite_number_int_tag:
-      WS_DEBUG_PRINTLN("[i2c] Writing int to LED backpack...");
-      WriteValue(msg_write->message.number_int);
-      break;
-    case wippersnapper_i2c_v1_LedBackpackWrite_number_float_tag:
-      WS_DEBUG_PRINTLN("[i2c] Writing float to LED backpack...");
-      WriteValue(msg_write->message.number_float);
-      break;
-    default:
-      WS_DEBUG_PRINTLN("[i2c] ERROR: Unable to determine message type!");
-      return false;
-      break;
-    }
+    WriteMessage(msg_write->message.text);
     return true;
   }
 
@@ -132,26 +93,31 @@ class WipperSnapper_I2C_Driver_Out : public WipperSnapper_I2C_Driver {
                   The number of rows in the LCD.
       @param    cols
                   The number of columns in the LCD.
-      @param    enable_backlight
-                  True if the backlight is enabled, False otherwise.
   */
-  virtual void ConfigureCharLcd(uint32_t rows, uint32_t cols,
-                                bool enable_backlight) {
+  virtual void ConfigureCharLcd(uint32_t rows, uint32_t cols) {
+    // noop
+  }
+
+  /*!
+      @brief    Turns the character LCD backlight on or off.
+      @param    enable
+                  True to enable the backlight, false to disable it.
+  */
+  void EnableCharLcdBacklight(bool enable) {
     // noop
   }
 
   /*!
       @brief    Writes a message to the LCD.
       @param    write_char_lcd
                 Points to a CharLCDWrite message.
-      @returns  True if the message was written successfully, False otherwise.
+      @param    enable_backlight
+                True if the backlight should be enabled, false otherwise.
   */
-  bool WriteMessageCharLCD(wippersnapper_i2c_v1_CharLCDWrite *write_char_lcd) {
+  void WriteMessageCharLCD(wippersnapper_i2c_v1_CharLcdWrite *write_char_lcd,
+                           bool enable_backlight = true) {
+    EnableCharLcdBacklight(enable_backlight);
     WriteMessage(write_char_lcd->message);
-    // NOTE: While this isn't calling any other funcs in here and ret'ing true,
-    // I want to keep this function high-level for when we implement backlight
-    // color and scrolling.
-    return true;
   }
 };
 

src/components/i2c/drivers/WipperSnapper_I2C_Driver_Out_7Seg.h

@@ -170,31 +170,6 @@ class WipperSnapper_I2C_Driver_Out_7Seg : public WipperSnapper_I2C_Driver_Out {
     _matrix->writeDisplay();
   }
 
-  /*!
-      @brief    Writes a floating point value to the 7-segment display.
-      @param    value
-                  The value to be displayed. Only the first four digits are
-      displayed.
-  */
-  void WriteValue(float value) {
-    char message[8 + 1];
-    snprintf(message, sizeof(message), "%.2f",
-             value); // Less precision for 7-segment
-    WriteMessage(message);
-  }
-
-  /*!
-      @brief    Writes an integer value to the 7-segment display.
-      @param    value
-                  The value to be displayed. Only the first four digits are
-      displayed.
-  */
-  void WriteValue(int32_t value) {
-    char message[LED_MAX_CHARS + 1];
-    snprintf(message, sizeof(message), "%ld", value);
-    WriteMessage(message);
-  }
-
 protected:
   Adafruit_7segment *_matrix =
       nullptr;         ///< ptr to a 7-segment LED matrix object

src/components/i2c/drivers/WipperSnapper_I2C_Driver_Out_CharLcd.h

@@ -27,15 +27,13 @@ class WipperSnapper_I2C_Driver_Out_CharLcd
     : public WipperSnapper_I2C_Driver_Out {
 
 public:
-  /*******************************************************************************/
   /*!
       @brief    Constructor for a LCD character display.
       @param    i2c
                 The I2C interface.
       @param    sensorAddress
                 7-bit device address.
   */
-  /*******************************************************************************/
   WipperSnapper_I2C_Driver_Out_CharLcd(TwoWire *i2c, uint16_t sensorAddress)
       : WipperSnapper_I2C_Driver_Out(i2c, sensorAddress) {
     _i2c = i2c;
@@ -59,7 +57,7 @@ class WipperSnapper_I2C_Driver_Out_CharLcd
   bool begin() {
     _lcd = new Adafruit_LiquidCrystal(_sensorAddress, _i2c);
     bool did_begin = _lcd->begin(_cols, _rows);
-    if (did_begin && _enable_backlight) {
+    if (did_begin) {
       _lcd->setBacklight(HIGH);
     }
     return did_begin;
@@ -72,13 +70,26 @@ class WipperSnapper_I2C_Driver_Out_CharLcd
                 The number of rows in the LCD.
       @param   cols
               The number of columns in the LCD.
-      @param   enable_backlight
-              True if the backlight is enabled, False otherwise.
   */
-  void ConfigureCharLcd(uint8_t rows, uint8_t cols, bool enable_backlight) {
+  void ConfigureCharLcd(uint8_t rows, uint8_t cols) {
     _rows = rows;
     _cols = cols;
-    _enable_backlight = enable_backlight;
+  }
+
+  /*!
+    @brief    Turns the character LCD backlight on or off.
+    @param    enable
+                True to enable the backlight, false to disable it.
+  */
+  void EnableCharLcdBacklight(bool enable) {
+    if (_lcd == nullptr)
+      return;
+
+    if (enable) {
+      _lcd->setBacklight(HIGH);
+    } else {
+      _lcd->setBacklight(LOW);
+    }
   }
 
   /*!
@@ -93,11 +104,6 @@ class WipperSnapper_I2C_Driver_Out_CharLcd
     // Before writing, let's clear the display
     _lcd->clear();
 
-    // TODO: Remove all the prints!
-    // Print the message to the serial
-    Serial.print("Writing message to Char. LCD: ");
-    Serial.println(message);
-
     size_t message_length = strlen(message);
     size_t cur_idx = 0; // Current index in the message
 
@@ -128,10 +134,9 @@ class WipperSnapper_I2C_Driver_Out_CharLcd
 
 protected:
   Adafruit_LiquidCrystal *_lcd =
-      nullptr;            ///< Pointer to the Adafruit_LiquidCrystal object
-  uint8_t _rows;          ///< Number of rows in the display
-  uint8_t _cols;          ///< Number of columns in the display
-  bool _enable_backlight; ///< Flag to enable/disable backlight
+      nullptr;   ///< Pointer to the Adafruit_LiquidCrystal object
+  uint8_t _rows; ///< Number of rows in the display
+  uint8_t _cols; ///< Number of columns in the display
 };
 
 #endif // WIPPERSNAPPER_I2C_DRIVER_OUT_CHARLCD_H

src/components/i2c/drivers/WipperSnapper_I2C_Driver_Out_QuadAlphaNum.h

@@ -157,30 +157,6 @@ class WipperSnapper_I2C_Driver_Out_QuadAlphaNum
     _alpha4->writeDisplay();
   }
 
-  /*!
-      @brief    Writes a floating point value to the quad alphanumeric display.
-      @param    value
-                  The value to be displayed. Only the first four digits are
-      displayed.
-  */
-  void WriteValue(float value) {
-    char message[8 + 1];
-    snprintf(message, sizeof(message), "%.5f", value);
-    WriteMessage(message);
-  }
-
-  /*!
-      @brief    Writes an integer value to the quad alphanumeric display.
-      @param    value
-                  The value to be displayed. Only the first four digits are
-      displayed.
-  */
-  void WriteValue(int32_t value) {
-    char message[LED_MAX_CHARS + 1];
-    snprintf(message, sizeof(message), "%ld", value);
-    WriteMessage(message);
-  }
-
 protected:
   Adafruit_AlphaNum4 *_alpha4 =
       nullptr;         ///< ptr to a 4-digit alphanumeric display object