SSD1306Controller.h

Go to the documentation of this file.

/*
  Created by Fabrizio Di Vittorio (fdivitto2013@gmail.com) - <http://www.fabgl.com>
  Copyright (c) 2019-2022 Fabrizio Di Vittorio.
  All rights reserved.
 
 
* Please contact fdivitto2013@gmail.com if you need a commercial license.
 
 
* This library and related software is available under GPL v3.
 
  FabGL 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.
 
  FabGL 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 FabGL.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 
#pragma once
 
 
 
#ifdef ARDUINO
 
 
#include <stdint.h>
#include <stddef.h>
 
#include "freertos/FreeRTOS.h"
 
#include "fabglconf.h"
#include "fabutils.h"
#include "displaycontroller.h"
#include "comdrivers/tsi2c.h"
 
 
 
 
namespace fabgl {
 
 
 
enum class SSD1306Orientation {
  Normal,             
  ReverseHorizontal,  
  ReverseVertical,    
  Rotate180,          
};
 
 
class SSD1306Controller : public GenericBitmappedDisplayController {
 
public:
 
  // unwanted methods
  SSD1306Controller(SSD1306Controller const&)   = delete;
  void operator=(SSD1306Controller const&)      = delete;
 
 
  SSD1306Controller();
 
  ~SSD1306Controller();
 
  void begin(I2C * i2c, int address = 0x3C, gpio_num_t resetGPIO = GPIO_UNUSED);
 
  void begin();
 
  void end();
 
  void setResolution(char const * modeline, int viewPortWidth = -1, int viewPortHeight = -1, bool doubleBuffered = false);
 
  bool available() { return m_screenBuffer != nullptr; }
 
  // abstract method of BitmappedDisplayController
  void suspendBackgroundPrimitiveExecution();
 
  // abstract method of BitmappedDisplayController
  void resumeBackgroundPrimitiveExecution();
 
  // abstract method of BitmappedDisplayController
  NativePixelFormat nativePixelFormat() { return NativePixelFormat::Mono; }
 
  virtual int colorsCount()             { return 2; }
 
  void setScreenCol(int value);
 
  void setScreenRow(int value);
 
  int screenCol() { return m_screenCol; }
 
  int screenRow() { return m_screenRow; }
 
  void readScreen(Rect const & rect, RGB888 * destBuf);
 
  void invert(bool value);
 
  void setOrientation(SSD1306Orientation value);
 
 
private:
 
  // abstract method of BitmappedDisplayController
  int getBitmapSavePixelSize() { return 1; }
 
 
  bool SSD1306_sendData(uint8_t * buf, int count, uint8_t ctrl);
  bool SSD1306_sendCmd(uint8_t c);
  bool SSD1306_sendCmd(uint8_t c1, uint8_t c2);
  bool SSD1306_sendCmd(uint8_t c1, uint8_t c2, uint8_t c3);
 
  void SSD1306_hardReset();
  bool SSD1306_softReset();
 
  void SSD1306_sendScreenBuffer(Rect updateRect);
 
  void sendRefresh();
 
  void setupOrientation();
 
  void allocScreenBuffer();
 
  static void updateTaskFunc(void * pvParameters);
 
  // abstract method of BitmappedDisplayController
  void setPixelAt(PixelDesc const & pixelDesc, Rect & updateRect);
 
  // abstract method of BitmappedDisplayController
  void clear(Rect & updateRect);
 
  // abstract method of BitmappedDisplayController
  void drawEllipse(Size const & size, Rect & updateRect);
 
  void VScroll(int scroll, Rect & updateRect);
  
  void HScroll(int scroll, Rect & updateRect);
 
  // abstract method of BitmappedDisplayController
  void drawGlyph(Glyph const & glyph, GlyphOptions glyphOptions, RGB888 penColor, RGB888 brushColor, Rect & updateRect);
 
  // abstract method of BitmappedDisplayController
  void swapBuffers();
 
  // abstract method of BitmappedDisplayController
  void invertRect(Rect const & rect, Rect & updateRect);
 
  // abstract method of BitmappedDisplayController
  void copyRect(Rect const & source, Rect & updateRect);
 
  // abstract method of BitmappedDisplayController
  void swapFGBG(Rect const & rect, Rect & updateRect);
 
  // abstract method of BitmappedDisplayController
  void absDrawLine(int X1, int Y1, int X2, int Y2, RGB888 color);
 
  // abstract method of BitmappedDisplayController
  void rawFillRow(int y, int x1, int x2, RGB888 color);
 
  void rawFillRow(int y, int x1, int x2, uint8_t pattern);
 
  void rawInvertRow(int y, int x1, int x2);
 
  // abstract method of BitmappedDisplayController
  void rawDrawBitmap_Native(int destX, int destY, Bitmap const * bitmap, int X1, int Y1, int XCount, int YCount);
 
  // abstract method of BitmappedDisplayController
  void rawDrawBitmap_Mask(int destX, int destY, Bitmap const * bitmap, void * saveBackground, int X1, int Y1, int XCount, int YCount);
 
  // abstract method of BitmappedDisplayController
  void rawDrawBitmap_RGBA2222(int destX, int destY, Bitmap const * bitmap, void * saveBackground, int X1, int Y1, int XCount, int YCount);
 
  // abstract method of BitmappedDisplayController
  void rawDrawBitmap_RGBA8888(int destX, int destY, Bitmap const * bitmap, void * saveBackground, int X1, int Y1, int XCount, int YCount);
 
  void rawCopyRow(int x1, int x2, int srcY, int dstY);
 
 
  I2C *              m_i2c;
  uint8_t            m_i2cAddress;
  gpio_num_t         m_resetGPIO;
 
  uint8_t *          m_screenBuffer;
 
  int16_t            m_screenWidth;
  int16_t            m_screenHeight;
  int16_t            m_screenCol;
  int16_t            m_screenRow;
 
  TaskHandle_t       m_updateTaskHandle;
 
  volatile int       m_updateTaskFuncSuspended;             // 0 = enabled, >0 suspended
  volatile bool      m_updateTaskRunning;
 
  SSD1306Orientation m_orientation;
 
};
 
 
} // end of namespace
 
 
 
#endif // #ifdef ARDUINO