CommandStation-EX/SSD1306Ascii.h

/* Based on Arduino SSD1306Ascii Library, Copyright (C) 2015 by William Greiman
 * Modifications (C) 2021 Neil McKechnie
 *
 * This Library 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.
 *
 * This Library 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 software.  If not, see
 * <http://www.gnu.org/licenses/>.
 */

#ifndef SSD1306Ascii_h
#define SSD1306Ascii_h

#include "Arduino.h"
#include "FSH.h"
#include "LCDDisplay.h"

#include "I2CManager.h"
#include "DIAG.h"

// Uncomment to remove lower-case letters to save 108 bytes of flash
//#define NOLOWERCASE

//------------------------------------------------------------------------------
// Device initialization structure.

struct DevType {
  /* Pointer to initialization command bytes. */
  const uint8_t* initcmds;
  /* Number of initialization bytes */
  const uint8_t initSize;
  /* Width of the display in pixels */
  const uint8_t lcdWidth;
  /** Height of the display in pixels. */
  const uint8_t lcdHeight;
  /* Column offset RAM to display.  Used to pick start column of SH1106. */
  const uint8_t colOffset;
};

// Constructor
class SSD1306AsciiWire : public LCDDisplay {
 public:

  // Constructor
  SSD1306AsciiWire(int width, int height);

  // Initialize the display controller.
  void begin(const DevType* dev, uint8_t i2cAddr);

  // Clear the display and set the cursor to (0, 0).
  void clearNative();

  // Set cursor to start of specified text line
  void setRowNative(byte line);

  // Initialize the display controller.
  void init(const DevType* dev);
  
  // Write one character to OLED
  size_t writeNative(uint8_t c);

  // Display characteristics / initialisation
  static const DevType FLASH Adafruit128x32;
  static const DevType FLASH Adafruit128x64;
  static const DevType FLASH SH1106_132x64;

 private:
  // Cursor column.
  uint8_t m_col;
  // Cursor RAM row.
  uint8_t m_row;
  // Display width.
  uint8_t m_displayWidth;
  // Display height.
  uint8_t m_displayHeight;
  // Column offset RAM to SEG.
  uint8_t m_colOffset = 0;
  // Current font.
  const uint8_t* const m_font = System5x7;

  // Only fixed size 5x7 fonts in a 6x8 cell are supported.
  static const uint8_t fontWidth = 5;
  static const uint8_t fontHeight = 7;
  static const uint8_t letterSpacing = 1;
  static const uint8_t m_fontFirstChar = 0x20;
  static const uint8_t m_fontCharCount = 0x61;

  uint8_t m_i2cAddr;

  uint8_t outputBuffer[fontWidth+letterSpacing+1];

  static const uint8_t blankPixels[];

  static const uint8_t System5x7[];
  static const uint8_t FLASH Adafruit128xXXinit[];
  static const uint8_t FLASH SH1106_132x64init[];
};

#endif  // SSD1306Ascii_h