319 lines
9.5 KiB
C++
319 lines
9.5 KiB
C++
/* Arduino SSD1306Ascii Library
|
|
* Copyright (C) 2015 by William Greiman
|
|
*
|
|
* This file is part of the Arduino SSD1306Ascii Library
|
|
*
|
|
* 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 the Arduino SSD1306Ascii Library. If not, see
|
|
* <http://www.gnu.org/licenses/>.
|
|
*/
|
|
/**
|
|
* @file SSD1306Ascii.h
|
|
* @brief Base class for ssd1306 displays.
|
|
*/
|
|
#ifndef SSD1306Ascii_h
|
|
#define SSD1306Ascii_h
|
|
#include "Arduino.h"
|
|
#include "SSD1306init.h"
|
|
#include "fonts/allFonts.h"
|
|
//------------------------------------------------------------------------------
|
|
/** SSD1306Ascii version */
|
|
#define SDD1306_ASCII_VERSION 1.1.0
|
|
//------------------------------------------------------------------------------
|
|
// Configuration options.
|
|
/** Set Scrolling mode for new line.
|
|
*
|
|
* If INCLUDE_SCROLLING is defined to be zero, new line will not scroll
|
|
* the display and code for scrolling will not be included. This option
|
|
* will save some code space and one byte of RAM.
|
|
*
|
|
* If INCLUDE_SCROLLING is defined to be one, the scroll feature will
|
|
* be included but not enabled. A call to setScroll() will be required
|
|
* to enable scrolling.
|
|
*
|
|
* If INCLUDE_SCROLLING is defined to be two, the scroll feature will
|
|
* be included and enabled. A call to setScroll() will be required
|
|
* to disable scrolling.
|
|
*/
|
|
#define INCLUDE_SCROLLING 1
|
|
|
|
/** Use larger faster I2C code. */
|
|
#define OPTIMIZE_I2C 1
|
|
|
|
/** Define OPTIMIZE_AVR_SPI non-zero for a faster smaller AVR SPI code.
|
|
* Warning AVR will not use SPI transactions.
|
|
*/
|
|
#define OPTIMIZE_AVR_SPI 1
|
|
//------------------------------------------------------------------------------
|
|
// Values for writeDisplay() mode parameter.
|
|
/** Write to Command register. */
|
|
#define SSD1306_MODE_CMD 0
|
|
/** Write one byte to display RAM. */
|
|
#define SSD1306_MODE_RAM 1
|
|
/** Write to display RAM with possible buffering. */
|
|
#define SSD1306_MODE_RAM_BUF 2
|
|
//-----------------------------------------------------------------------------
|
|
/**
|
|
* @brief Reset the display controller.
|
|
*
|
|
* @param[in] rst Reset pin number.
|
|
*/
|
|
inline void oledReset(uint8_t rst) {
|
|
pinMode(rst, OUTPUT);
|
|
digitalWrite(rst, LOW);
|
|
delay(10);
|
|
digitalWrite(rst, HIGH);
|
|
delay(10);
|
|
}
|
|
//------------------------------------------------------------------------------
|
|
/**
|
|
* @class SSD1306Ascii
|
|
* @brief SSD1306 base class
|
|
*/
|
|
class SSD1306Ascii : public Print {
|
|
public:
|
|
SSD1306Ascii() : m_magFactor(1), m_font(0) {}
|
|
/**
|
|
* @brief Determine the width of a character.
|
|
*
|
|
* @param[in] c Character code.
|
|
* @return Width of the character in pixels.
|
|
*/
|
|
uint8_t charWidth(uint8_t c);
|
|
/**
|
|
* @brief Clear the display and set the cursor to (0, 0).
|
|
*/
|
|
void clear();
|
|
/**
|
|
* @brief Clear a region of the display.
|
|
*
|
|
* @param[in] c0 Starting column.
|
|
* @param[in] c1 Ending column.
|
|
* @param[in] r0 Starting row;
|
|
* @param[in] r1 Ending row;
|
|
* @note The final cursor position will be (c0, r0).
|
|
*/
|
|
void clear(uint8_t c0, uint8_t c1, uint8_t r0, uint8_t r1);
|
|
/**
|
|
* @brief Clear a field of n fieldWidth() characters.
|
|
*
|
|
* @param[in] col Field start column.
|
|
*
|
|
* @param[in] row Field start row.
|
|
*
|
|
* @param[in] n Number of characters in the field.
|
|
*
|
|
*/
|
|
void clearField(uint8_t col, uint8_t row, uint8_t n);
|
|
/**
|
|
* @brief Clear the display to the end of the current line.
|
|
* @note The number of rows cleared will be determined by the height
|
|
* of the current font.
|
|
* @note The cursor will be returned to the original position.
|
|
*/
|
|
void clearToEOL();
|
|
/**
|
|
* @return The current column in pixels.
|
|
*/
|
|
uint8_t col() {return m_col;}
|
|
/**
|
|
* @return The display hight in pixels.
|
|
*/
|
|
uint8_t displayHeight() {return m_displayHeight;}
|
|
/**
|
|
* @brief Set display to normal or 180 degree remap mode.
|
|
*
|
|
* @param[in] mode true for normal mode, false for remap mode.
|
|
*
|
|
* @note Adafruit and many ebay displays use remap mode.
|
|
* Use normal mode to rotate these displays 180 degrees.
|
|
*/
|
|
void displayRemap(bool mode);
|
|
/**
|
|
* @return The display height in rows with eight pixels to a row.
|
|
*/
|
|
uint8_t displayRows() {return m_displayHeight/8;}
|
|
/**
|
|
* @return The display width in pixels.
|
|
*/
|
|
uint8_t displayWidth() {return m_displayWidth;}
|
|
/**
|
|
* @brief Width of a field in pixels.
|
|
*
|
|
* @param[in] n Number of characters in the field.
|
|
*
|
|
* @return Width of the field.
|
|
*/
|
|
size_t fieldWidth(uint8_t n);
|
|
/**
|
|
* @return The current font pointer.
|
|
*/
|
|
const uint8_t* font() {return m_font;}
|
|
/**
|
|
* @return The count of characters in a font.
|
|
*/
|
|
uint8_t fontCharCount();
|
|
/**
|
|
* @return The first character in a font.
|
|
*/
|
|
char fontFirstChar();
|
|
/**
|
|
* @return The current font height in pixels.
|
|
*/
|
|
uint8_t fontHeight();
|
|
/**
|
|
* @return The number of eight pixel rows required to display a character
|
|
* in the current font.
|
|
*/
|
|
uint8_t fontRows() {return (fontHeight() + 7)/8;}
|
|
/**
|
|
* @return The maximum width of characters in the current font.
|
|
*/
|
|
uint8_t fontWidth();
|
|
/**
|
|
* @brief Set the cursor position to (0, 0).
|
|
*/
|
|
void home() {setCursor(0, 0);}
|
|
/**
|
|
* @brief Initialize the display controller.
|
|
*
|
|
* @param[in] dev A display initialization structure.
|
|
*/
|
|
void init(const DevType* dev);
|
|
/**
|
|
* @return letter-spacing in pixels with magnification factor.
|
|
*/
|
|
uint8_t letterSpacing() {return m_magFactor*m_letterSpacing;}
|
|
/**
|
|
* @return The character magnification factor.
|
|
*/
|
|
uint8_t magFactor() {return m_magFactor;}
|
|
/**
|
|
* @return the current row number with eight pixels to a row.
|
|
*/
|
|
uint8_t row() {return m_row;}
|
|
/**
|
|
* @brief Set the character magnification factor to one.
|
|
*/
|
|
void set1X() {m_magFactor = 1;}
|
|
/**
|
|
* @brief Set the character magnification factor to two.
|
|
*/
|
|
void set2X() {m_magFactor = 2;}
|
|
/**
|
|
* @brief Set the current column number.
|
|
*
|
|
* @param[in] col The desired column number in pixels.
|
|
*/
|
|
void setCol(uint8_t col);
|
|
/**
|
|
* @brief Set the display contrast.
|
|
*
|
|
* @param[in] value The contrast level in th range 0 to 255.
|
|
*/
|
|
void setContrast(uint8_t value);
|
|
/**
|
|
* @brief Set the cursor position.
|
|
*
|
|
* @param[in] col The column number in pixels.
|
|
* @param[in] row the row number in eight pixel rows.
|
|
*/
|
|
void setCursor(uint8_t col, uint8_t row);
|
|
/**
|
|
* @brief Set the current font.
|
|
*
|
|
* @param[in] font Pointer to a font table.
|
|
*/
|
|
void setFont(const uint8_t* font);
|
|
/**
|
|
* @brief Set letter-spacing. setFont() will restore default letter-spacing.
|
|
*
|
|
* @param[in] pixels letter-spacing in pixels before magnification.
|
|
*/
|
|
void setLetterSpacing(uint8_t pixels) {m_letterSpacing = pixels;}
|
|
/**
|
|
* @brief Set the current row number.
|
|
*
|
|
* @param[in] row the row number in eight pixel rows.
|
|
*/
|
|
void setRow(uint8_t row);
|
|
#if INCLUDE_SCROLLING
|
|
/**
|
|
* @brief Enable or disable scroll mode.
|
|
*
|
|
* @param[in] enable true enable scroll on new line false disable scroll.
|
|
* @note Scroll mode is only supported on 64 pixel high displays.
|
|
* Using setRow() or setCursor() will be unpredictable in scroll mode.
|
|
* You must use a font with an integral number of line on
|
|
* the display.
|
|
*/
|
|
void setScroll(bool enable);
|
|
#endif // INCLUDE_SCROLLING
|
|
/**
|
|
* @brief Write a command byte to the display controller.
|
|
*
|
|
* @param[in] c The command byte.
|
|
* @note The byte will immediately be sent to the controller.
|
|
*/
|
|
void ssd1306WriteCmd(uint8_t c) {writeDisplay(c, SSD1306_MODE_CMD);}
|
|
/**
|
|
* @brief Write a byte to RAM in the display controller.
|
|
*
|
|
* @param[in] c The data byte.
|
|
* @note The byte will immediately be sent to the controller.
|
|
*/
|
|
void ssd1306WriteRam(uint8_t c);
|
|
/**
|
|
* @brief Write a byte to RAM in the display controller.
|
|
*
|
|
* @param[in] c The data byte.
|
|
* @note The byte may be buffered until a call to ssd1306WriteCmd
|
|
* or ssd1306WriteRam.
|
|
*/
|
|
void ssd1306WriteRamBuf(uint8_t c);
|
|
/**
|
|
* @param[in] str The pointer to string.
|
|
* @return the width of the string in pixels.
|
|
*/
|
|
size_t strWidth(const char* str);
|
|
/**
|
|
* @brief Display a character.
|
|
*
|
|
* @param[in] c The character to display.
|
|
* @return the value one.
|
|
*/
|
|
size_t write(uint8_t c);
|
|
/**
|
|
* @brief Display a string.
|
|
*
|
|
* @param[in] s The string to display.
|
|
* @return The length of the string.
|
|
*/
|
|
size_t write(const char* s);
|
|
|
|
private:
|
|
uint16_t fontSize();
|
|
virtual void writeDisplay(uint8_t b, uint8_t mode) = 0;
|
|
uint8_t m_col; // Cursor column.
|
|
uint8_t m_row; // Cursor RAM row.
|
|
uint8_t m_displayWidth; // Display width.
|
|
uint8_t m_displayHeight; // Display height.
|
|
uint8_t m_colOffset; // Column offset RAM to SEG.
|
|
uint8_t m_letterSpacing; // lerret-spacing in pixels.
|
|
uint8_t m_magFactor; // Magnification factor.
|
|
#if INCLUDE_SCROLLING
|
|
uint8_t m_scroll; // Scroll mode
|
|
#endif // INCLUDE_SCROLLING
|
|
const uint8_t* m_font; // Current font.
|
|
};
|
|
#endif // SSD1306Ascii_h
|