/home/runner/work/DCCEXSimpleThrottle/DCCEXSimpleThrottle/U8G2SH1106Display.h

Go to the documentation of this file.

/*
 *  © 2024 Peter Cole
 *  © 2023 Peter Cole
 *
 *  This is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  It is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this code.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef U8G2SH1106DISPLAY_H
#define U8G2SH1106DISPLAY_H
 
#include "Defines.h"
#include "DisplayInterface.h"
#include <U8g2lib.h>
#if (OLED_CONNECTION == OLED_SPI)
#include <SPI.h>
#endif // OLED_CONNECTION
 
class U8G2SH1106Display : public DisplayInterface {
public:
  U8G2SH1106Display();
 
  void begin() override;
 
  void clear() override;
 
  void displayStartupScreen(const char *headerText, const char *version) override;
 
  void displayProgressScreen(const char *activity, uint8_t counter) override;
 
  void displayErrorScreen(const char *errorText) override;
 
  void displayMenuScreen(const char *menuName, BaseMenuItem *firstMenuItem, uint8_t selectedItemIndex,
                         bool selectionChanged) override;
 
  void displayThrottleScreen(const char *locoName, uint8_t speed, Direction direction, TrackPower trackPower,
                             bool speedChanged, bool directionChange, bool trackPowerChanged) override;
 
private:
  U8G2 *_oled;
  const uint8_t *_defaultFont;
  const uint8_t *_menuFont;
  const uint8_t *_speedFont;
  const uint8_t *_throttleFont;
 
  uint8_t _calculateMenuItemsPerPage();
 
  uint16_t _calculateHeaderHeight();
 
  uint16_t _calculateMenuItemHeight();
 
  uint16_t _calculateMenuFooterHeight();
 
  void _clearDisplay();
 
  void _displayHeader(const char *headerText);
 
  void _displayStartupInfo(const char *version);
 
  uint8_t _displayMenuItems(BaseMenuItem *firstMenuItem, uint8_t selectedItemIndex);
 
  void _displayMenuFooter();
 
  void _displayPageNumber(uint8_t pageNumber);
 
  void _displayProgress(uint8_t counter);
 
  void _displayErrorMessage(const char *errorMessage);
 
  void _displayLocoSpeed(uint8_t speed);
 
  void _displayLocoDirection(Direction direction);
 
  void _displayLocoName(const char *name);
 
  void _displayTrackPowerState(TrackPower trackPower);
};
 
#endif // U8G2SH1106DISPLAY_H