Nathan Yonkee / Mbed OS OLED_128x64_I2C

Seeed Studio's 0.96" OLED module

Dependencies:   Adafruit_GFX

Fork of SSD1308_128x64_I2C by Wim Huiskamp

SSD1308.h@14:e283a41c5fbc, 2017-08-03 (annotated)

Committer:
Nathan Yonkee
Date:
Thu Aug 03 06:26:07 2017 -0600
Revision:
14:e283a41c5fbc
Parent:
10:74ef7544744e 
add Adafruit_GFX library

Who changed what in which revision?

UserRevisionLine numberNew contents of line
tulanthoar 7:dcff685d41a5 1 /** @file SSD1308 I2C device class header file
tulanthoar 7:dcff685d41a5 2 * Based on Solomon Systech SSD1308 datasheet, rev. 1, 10/2008
tulanthoar 7:dcff685d41a5 3 * The SSD1308 is used for example in the Seeed 128x64 OLED Display
tulanthoar 7:dcff685d41a5 4 * http://www.seeedstudio.com/depot/grove-oled-display-12864-p-781.html?cPath=163_167
tulanthoar 7:dcff685d41a5 5 */
tulanthoar 7:dcff685d41a5 6 // The original code by Andrew Schamp is using (and has been submitted as a part of) Jeff Rowberg's I2Cdevlib library,
tulanthoar 7:dcff685d41a5 7 // which should (hopefully) always be available at https://github.com/jrowberg/i2cdevlib
tulanthoar 7:dcff685d41a5 8 // Some parts also mashed up from Graphic Library for driving monochrome displays based on the PCD8544,
tulanthoar 7:dcff685d41a5 9 // Copyright (c) 2011, Wim De Roeve, who in turn did partial port of code found on
tulanthoar 7:dcff685d41a5 10 // http://serdisplib.sourceforge.net/ser/pcd8544.html#links and by Petras Saduikis <petras@petras.co.uk>
tulanthoar 7:dcff685d41a5 11 //
tulanthoar 7:dcff685d41a5 12 // Changelog:
tulanthoar 7:dcff685d41a5 13 // 2011-08-25 - Initial release by Andrew Schamp <schamp@gmail.com>
tulanthoar 7:dcff685d41a5 14 // 2012-06-19 - Ported to mbed and optimised (WH)
tulanthoar 7:dcff685d41a5 15 // 2013-07-12 - Minor comment fix and placeholder for SSD1306 (WH)
tulanthoar 7:dcff685d41a5 16 // 2015-01-01 - Switch for optimised I2C calls to test on F401 (WH)
tulanthoar 7:dcff685d41a5 17 //
tulanthoar 7:dcff685d41a5 18 /*
tulanthoar 7:dcff685d41a5 19 ================================================================================
tulanthoar 7:dcff685d41a5 20 I2Cdev device library code is placed under the MIT license
tulanthoar 7:dcff685d41a5 21 Copyright (c) 2011 Andrew Schamp
tulanthoar 7:dcff685d41a5 22 Copyright (c) 2012,2013 WH (mbed port)
tulanthoar 7:dcff685d41a5 23
tulanthoar 7:dcff685d41a5 24 Permission is hereby granted, free of charge, to any person obtaining a copy
tulanthoar 7:dcff685d41a5 25 of this software and associated documentation files (the "Software"), to deal
tulanthoar 7:dcff685d41a5 26 in the Software without restriction, including without limitation the rights
tulanthoar 7:dcff685d41a5 27 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
tulanthoar 7:dcff685d41a5 28 copies of the Software, and to permit persons to whom the Software is
tulanthoar 7:dcff685d41a5 29 furnished to do so, subject to the following conditions:
tulanthoar 7:dcff685d41a5 30
tulanthoar 7:dcff685d41a5 31 The above copyright notice and this permission notice shall be included in
tulanthoar 7:dcff685d41a5 32 all copies or substantial portions of the Software.
tulanthoar 7:dcff685d41a5 33
tulanthoar 7:dcff685d41a5 34 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
tulanthoar 7:dcff685d41a5 35 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
tulanthoar 7:dcff685d41a5 36 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
tulanthoar 7:dcff685d41a5 37 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
tulanthoar 7:dcff685d41a5 38 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
tulanthoar 7:dcff685d41a5 39 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
tulanthoar 7:dcff685d41a5 40 THE SOFTWARE.
tulanthoar 7:dcff685d41a5 41 ================================================================================
tulanthoar 7:dcff685d41a5 42 */
tulanthoar 7:dcff685d41a5 43
tulanthoar 7:dcff685d41a5 44 #ifndef SSD1308_H
tulanthoar 7:dcff685d41a5 45 #define SSD1308_H
tulanthoar 7:dcff685d41a5 46
tulanthoar 7:dcff685d41a5 47 // This is the I2C address (8 bit)
tulanthoar 7:dcff685d41a5 48 // There are two possible addresses: with D/C# (pin 13) grounded, the address is 0x78,
tulanthoar 7:dcff685d41a5 49 // with D/C# tied high it is 0x7A. Assume grounded by default.
tulanthoar 7:dcff685d41a5 50 #define SSD1308_SA0 0x78
tulanthoar 7:dcff685d41a5 51 #define SSD1308_SA1 0x7A
tulanthoar 7:dcff685d41a5 52 #define SSD1308_DEF_SA SSD1308_SA0
tulanthoar 7:dcff685d41a5 53
tulanthoar 7:dcff685d41a5 54 // Display dimensions
tulanthoar 7:dcff685d41a5 55 #define ROWS 64
tulanthoar 7:dcff685d41a5 56 #define COLUMNS 128
tulanthoar 7:dcff685d41a5 57 #define PAGES (ROWS / 8)
tulanthoar 7:dcff685d41a5 58 #define MAX_PAGE (PAGES - 1)
tulanthoar 7:dcff685d41a5 59 #define MAX_ROW (ROWS - 1)
tulanthoar 7:dcff685d41a5 60 #define MAX_COL (COLUMNS - 1)
tulanthoar 7:dcff685d41a5 61
tulanthoar 7:dcff685d41a5 62 // Character dimensions 8x8 font
tulanthoar 7:dcff685d41a5 63 #define CHARS (COLUMNS / FONT8x8_WIDTH)
tulanthoar 7:dcff685d41a5 64
tulanthoar 7:dcff685d41a5 65 // Command and Datamode
tulanthoar 7:dcff685d41a5 66 #define COMMAND_MODE 0x80 // continuation bit is set!
tulanthoar 7:dcff685d41a5 67 #define DATA_MODE 0x40
tulanthoar 7:dcff685d41a5 68
tulanthoar 7:dcff685d41a5 69 // Commands and Parameter defines
tulanthoar 7:dcff685d41a5 70 #define SET_LOWER_COLUMN 0x00 // | with lower nibble (Page mode only)
tulanthoar 7:dcff685d41a5 71 #define SET_HIGHER_COLUMN 0x10 // | with higher nibble (Page mode only)
tulanthoar 7:dcff685d41a5 72
tulanthoar 7:dcff685d41a5 73 #define HORIZONTAL_ADDRESSING_MODE 0x00
tulanthoar 7:dcff685d41a5 74 #define VERTICAL_ADDRESSING_MODE 0x01
tulanthoar 7:dcff685d41a5 75 #define PAGE_ADDRESSING_MODE 0x02
tulanthoar 7:dcff685d41a5 76 #define SET_MEMORY_ADDRESSING_MODE 0x20 // takes one byte as given above
tulanthoar 7:dcff685d41a5 77
tulanthoar 7:dcff685d41a5 78 #define SET_COLUMN_ADDRESS 0x21 // takes two bytes, start address and end address of display data RAM
tulanthoar 7:dcff685d41a5 79 #define SET_PAGE_ADDRESS 0x22 // takes two bytes, start address and end address of display data RAM
tulanthoar 7:dcff685d41a5 80
tulanthoar 7:dcff685d41a5 81 // Command maybe unsupported by SSD1308
tulanthoar 7:dcff685d41a5 82 #define FADE_INTERVAL_8_FRAMES 0x00
tulanthoar 7:dcff685d41a5 83 #define FADE_INTERVAL_16_FRAMES 0x01
tulanthoar 7:dcff685d41a5 84 #define FADE_INTERVAL_24_FRAMES 0x02
tulanthoar 7:dcff685d41a5 85 #define FADE_INTERVAL_32_FRAMES 0x03
tulanthoar 7:dcff685d41a5 86 #define FADE_INTERVAL_64_FRAMES 0x07
tulanthoar 7:dcff685d41a5 87 #define FADE_INTERVAL_128_FRAMES 0x0F
tulanthoar 7:dcff685d41a5 88 #define FADE_BLINK_DISABLE 0x00
tulanthoar 7:dcff685d41a5 89 #define FADE_OUT_ENABLE 0x20
tulanthoar 7:dcff685d41a5 90 #define BLINK_ENABLE 0x30
tulanthoar 7:dcff685d41a5 91 #define SET_FADE_BLINK 0x23 // takes one byte
tulanthoar 7:dcff685d41a5 92 // bit5-4 = 0, fade/blink mode
tulanthoar 7:dcff685d41a5 93 // bit3-0 = Time interval in frames
tulanthoar 7:dcff685d41a5 94
tulanthoar 7:dcff685d41a5 95 #define SET_DISPLAY_START_LINE 0x40 // | with a row number 0-63 to set start row. (Reset = 0)
tulanthoar 7:dcff685d41a5 96
tulanthoar 7:dcff685d41a5 97 #define SET_CONTRAST 0x81 // takes one byte, 0x00 - 0xFF
tulanthoar 7:dcff685d41a5 98
tulanthoar 7:dcff685d41a5 99 #define SET_SEGMENT_REMAP_0 0xA0 // column address 0 is mapped to SEG0 (Reset)
tulanthoar 7:dcff685d41a5 100 #define SET_SEGMENT_REMAP_127 0xA1 // column address 127 is mapped to SEG0
tulanthoar 7:dcff685d41a5 101
tulanthoar 7:dcff685d41a5 102 #define SET_DISPLAY_GDDRAM 0xA4 // restores display to contents of RAM
tulanthoar 7:dcff685d41a5 103 #define SET_ENTIRE_DISPLAY_ON 0xA5 // turns all pixels on, does not affect RAM
tulanthoar 7:dcff685d41a5 104
tulanthoar 7:dcff685d41a5 105 #define SET_NORMAL_DISPLAY 0xA6 // a databit of 1 indicates pixel 'ON'
tulanthoar 7:dcff685d41a5 106 #define SET_INVERSE_DISPLAY 0xA7 // a databit of 1 indicates pixel 'OFF'
tulanthoar 7:dcff685d41a5 107
tulanthoar 7:dcff685d41a5 108 #define SET_MULTIPLEX_RATIO 0xA8 // takes one byte, from 16xMUX to 64xMUX (MUX Ratio = byte+1; Default 64)
tulanthoar 7:dcff685d41a5 109
tulanthoar 7:dcff685d41a5 110 #define EXTERNAL_IREF 0x10
tulanthoar 7:dcff685d41a5 111 #define INTERNAL_IREF 0x00
tulanthoar 7:dcff685d41a5 112 #define SET_IREF_SELECTION 0xAD // sets internal or external Iref
tulanthoar 7:dcff685d41a5 113
tulanthoar 7:dcff685d41a5 114 #define SET_DISPLAY_POWER_OFF 0xAE
tulanthoar 7:dcff685d41a5 115 #define SET_DISPLAY_POWER_ON 0xAF
tulanthoar 7:dcff685d41a5 116
tulanthoar 7:dcff685d41a5 117 #define PAGE0 0x00
tulanthoar 7:dcff685d41a5 118 #define PAGE1 0x01
tulanthoar 7:dcff685d41a5 119 #define PAGE2 0x02
tulanthoar 7:dcff685d41a5 120 #define PAGE3 0x03
tulanthoar 7:dcff685d41a5 121 #define PAGE4 0x04
tulanthoar 7:dcff685d41a5 122 #define PAGE5 0x05
tulanthoar 7:dcff685d41a5 123 #define PAGE6 0x06
tulanthoar 7:dcff685d41a5 124 #define PAGE7 0x07
tulanthoar 7:dcff685d41a5 125 #define SET_PAGE_START_ADDRESS 0xB0 // | with a page number to get start address (Page mode only)
tulanthoar 7:dcff685d41a5 126
tulanthoar 7:dcff685d41a5 127 #define SET_COMMON_REMAP_0 0xC0 // row address 0 is mapped to COM0 (Reset)
tulanthoar 7:dcff685d41a5 128 #define SET_COMMON_REMAP_63 0xC8 // row address 63 is mapped to COM0
tulanthoar 7:dcff685d41a5 129
tulanthoar 7:dcff685d41a5 130 #define SET_DISPLAY_OFFSET 0xD3 // takes one byte from 0-63 for vertical shift, Reset = 0
tulanthoar 7:dcff685d41a5 131
tulanthoar 7:dcff685d41a5 132 #define SET_DISPLAY_CLOCK 0xD5 // takes one byte
tulanthoar 7:dcff685d41a5 133 // bit7-4 = Osc Freq DCLK (Reset = 1000b)
tulanthoar 7:dcff685d41a5 134 // bit3-0 = Divide ration (Reset = oooob, Ratio = 1)
tulanthoar 7:dcff685d41a5 135
tulanthoar 7:dcff685d41a5 136 #define SET_PRECHARGE_TIME 0xD9 // takes one byte
tulanthoar 7:dcff685d41a5 137 // bit7-4 = Phase2, upto 15 DCLKs (Reset = 0010b)
tulanthoar 7:dcff685d41a5 138 // bit3-0 = Phase1, upto 15 DCLKs (Reset = 0010b)
tulanthoar 7:dcff685d41a5 139
tulanthoar 7:dcff685d41a5 140
tulanthoar 7:dcff685d41a5 141 #define COMMON_BASE 0x02 //
tulanthoar 7:dcff685d41a5 142 #define COMMON_SEQUENTIAL 0x00 // Sequential common pins config
tulanthoar 7:dcff685d41a5 143 #define COMMON_ALTERNATIVE 0x10 // Odd/Even common pins config (Reset)
tulanthoar 7:dcff685d41a5 144 #define COMMON_LEFTRIGHT_NORMAL 0x00 // LeftRight Normal (Reset)
tulanthoar 7:dcff685d41a5 145 #define COMMON_LEFTRIGHT_FLIP 0x20 // LeftRight Flip
tulanthoar 7:dcff685d41a5 146 #define SET_COMMON_CONF 0xDA // takes one byte as given above
tulanthoar 7:dcff685d41a5 147
tulanthoar 7:dcff685d41a5 148
tulanthoar 7:dcff685d41a5 149 #define VCOMH_DESELECT_0_65_CODE 0x00
tulanthoar 7:dcff685d41a5 150 #define VCOMH_DESELECT_0_77_CODE 0x20
tulanthoar 7:dcff685d41a5 151 #define VCOMH_DESELECT_0_83_CODE 0x30
tulanthoar 7:dcff685d41a5 152 #define SET_VCOMH_DESELECT_LEVEL 0xDB // takes one byte as given above
tulanthoar 7:dcff685d41a5 153
tulanthoar 7:dcff685d41a5 154 #define NOP 0xE3
tulanthoar 7:dcff685d41a5 155
tulanthoar 7:dcff685d41a5 156 #define SCROLL_INTERVAL_5_FRAMES 0x00
tulanthoar 7:dcff685d41a5 157 #define SCROLL_INTERVAL_64_FRAMES 0x01
tulanthoar 7:dcff685d41a5 158 #define SCROLL_INTERVAL_128_FRAMES 0x02
tulanthoar 7:dcff685d41a5 159 #define SCROLL_INTERVAL_256_FRAMES 0x03
tulanthoar 7:dcff685d41a5 160 #define SCROLL_INTERVAL_3_FRAMES 0x04
tulanthoar 7:dcff685d41a5 161 #define SCROLL_INTERVAL_4_FRAMES 0x05
tulanthoar 7:dcff685d41a5 162 #define SCROLL_INTERVAL_25_FRAMES 0x06
tulanthoar 7:dcff685d41a5 163 #define SCROLL_INTERVAL_2_FRAMES 0x07
tulanthoar 7:dcff685d41a5 164
tulanthoar 7:dcff685d41a5 165 #define SET_RIGHT_HOR_SCROLL 0x26 // takes 6 bytes: 0x00, PageStart, Scroll_Interval, PageEnd, 0x00, 0xFF
tulanthoar 7:dcff685d41a5 166 #define SET_LEFT_HOR_SCROLL 0x27 // takes 6 bytes: 0x00, PageStart, Scroll_Interval, PageEnd, 0x00, 0xFF
tulanthoar 7:dcff685d41a5 167
tulanthoar 7:dcff685d41a5 168 #define SET_VERT_RIGHT_HOR_SCROLL 0x29 // takes 5 bytes: 0x00, PageStart, Scroll_Interval, PageEnd, VertOffset
tulanthoar 7:dcff685d41a5 169 #define SET_VERT_LEFT_HOR_SCROLL 0x2A // takes 5 bytes: 0x00, PageStart, Scroll_Interval, PageEnd, VertOffset
tulanthoar 7:dcff685d41a5 170
tulanthoar 7:dcff685d41a5 171 #define SET_DEACTIVATE_SCROLL 0x2E
tulanthoar 7:dcff685d41a5 172 #define SET_ACTIVATE_SCROLL 0x2F
tulanthoar 7:dcff685d41a5 173
tulanthoar 7:dcff685d41a5 174 #define SET_VERTICAL_SCROLL_AREA 0xA3 // takes 2 bytes: Rows in Top Area (Reset=0), Rows in Scroll Area (Reset=64)
tulanthoar 7:dcff685d41a5 175
tulanthoar 7:dcff685d41a5 176
tulanthoar 7:dcff685d41a5 177
tulanthoar 7:dcff685d41a5 178 /** Class to control an SSD1308 based oled Display
tulanthoar 7:dcff685d41a5 179 *
tulanthoar 7:dcff685d41a5 180 * Example:
tulanthoar 7:dcff685d41a5 181 * @code
tulanthoar 7:dcff685d41a5 182 * #include "mbed.h"
tulanthoar 7:dcff685d41a5 183 * #include "mbed_logo.h"
tulanthoar 7:dcff685d41a5 184 * #include "SSD1308.h"
tulanthoar 7:dcff685d41a5 185
tulanthoar 7:dcff685d41a5 186 * //Pin Defines for I2C Bus
tulanthoar 7:dcff685d41a5 187 * #define D_SDA p28
tulanthoar 7:dcff685d41a5 188 * #define D_SCL p27
tulanthoar 7:dcff685d41a5 189 * I2C i2c(D_SDA, D_SCL);
tulanthoar 7:dcff685d41a5 190 *
tulanthoar 7:dcff685d41a5 191 * // Host PC Communication channels
tulanthoar 7:dcff685d41a5 192 * Serial pc(USBTX, USBRX); // tx, rx
tulanthoar 7:dcff685d41a5 193 *
tulanthoar 7:dcff685d41a5 194 * // Instantiate OLED
tulanthoar 7:dcff685d41a5 195 * SSD1308 oled = SSD1308(i2c, SSD1308_SA0);
tulanthoar 7:dcff685d41a5 196 *
tulanthoar 7:dcff685d41a5 197 * int main() {
tulanthoar 7:dcff685d41a5 198 * pc.printf("OLED test start\r");
tulanthoar 7:dcff685d41a5 199 * oled.writeString(0, 0, "Hello World !");
tulanthoar 7:dcff685d41a5 200 * // oled.printf("Hello World !");
tulanthoar 7:dcff685d41a5 201 *
tulanthoar 7:dcff685d41a5 202 * oled.fillDisplay(0xAA);
tulanthoar 7:dcff685d41a5 203 * oled.setDisplayOff();
tulanthoar 7:dcff685d41a5 204 * wait(1);
tulanthoar 7:dcff685d41a5 205 * oled.setDisplayOn();
tulanthoar 7:dcff685d41a5 206 *
tulanthoar 7:dcff685d41a5 207 * oled.clearDisplay();
tulanthoar 7:dcff685d41a5 208 * oled.setDisplayInverse();
tulanthoar 7:dcff685d41a5 209 * wait(0.5);
tulanthoar 7:dcff685d41a5 210 * oled.setDisplayNormal();
tulanthoar 7:dcff685d41a5 211 *
tulanthoar 7:dcff685d41a5 212 * oled.writeBitmap((uint8_t*) mbed_logo);
tulanthoar 7:dcff685d41a5 213 *
tulanthoar 7:dcff685d41a5 214 * pc.printf("OLED test done\r\n");
tulanthoar 7:dcff685d41a5 215 * }
tulanthoar 7:dcff685d41a5 216 *
tulanthoar 7:dcff685d41a5 217 * @endcode
tulanthoar 7:dcff685d41a5 218 */
tulanthoar 7:dcff685d41a5 219 class SSD1308 : public Stream {
tulanthoar 7:dcff685d41a5 220 public:
tulanthoar 7:dcff685d41a5 221
tulanthoar 7:dcff685d41a5 222 /**
tulanthoar 7:dcff685d41a5 223 *@brief Constructor
tulanthoar 7:dcff685d41a5 224 *@param I2C &i2c reference to i2c,
tulanthoar 7:dcff685d41a5 225 *@param uint8_t deviceAddress slaveaddress (8bit to use for the controller (0x78 by default, assumes D/C# (pin 13) grounded)
tulanthoar 7:dcff685d41a5 226 */
tulanthoar 10:74ef7544744e 227 SSD1308(I2C * i2c, uint8_t address = SSD1308_DEF_SA);
tulanthoar 7:dcff685d41a5 228
tulanthoar 7:dcff685d41a5 229 // High Level methods
tulanthoar 7:dcff685d41a5 230
tulanthoar 7:dcff685d41a5 231 /** @brief High level Init, most settings remain at Power-On reset value
tulanthoar 7:dcff685d41a5 232 */
tulanthoar 7:dcff685d41a5 233 void initialize();
tulanthoar 7:dcff685d41a5 234
tulanthoar 7:dcff685d41a5 235 /** @brief clear the display
tulanthoar 7:dcff685d41a5 236 */
tulanthoar 7:dcff685d41a5 237 void clearDisplay();
tulanthoar 7:dcff685d41a5 238
tulanthoar 7:dcff685d41a5 239
tulanthoar 7:dcff685d41a5 240 /** @brief fill the display
tulanthoar 7:dcff685d41a5 241 * @param uint8_t pattern fillpattern vertical patch or 8 bits
tulanthoar 7:dcff685d41a5 242 * @param uint8_t start_page begin page (0..MAX_PAGE)
tulanthoar 7:dcff685d41a5 243 * @param uint8_t end_page end page (start_page..MAX_PAGE)
tulanthoar 7:dcff685d41a5 244 * @param uint8_t start_col begin column (0..MAX_COL)
tulanthoar 7:dcff685d41a5 245 * @param uint8_t end_col end column (start_col..MAX_COL)
tulanthoar 7:dcff685d41a5 246 */
tulanthoar 7:dcff685d41a5 247 void fillDisplay(uint8_t pattern = 0x00,
tulanthoar 7:dcff685d41a5 248 uint8_t start_page=0, uint8_t end_page=MAX_PAGE,
tulanthoar 7:dcff685d41a5 249 uint8_t start_col=0, uint8_t end_col=MAX_COL);
tulanthoar 7:dcff685d41a5 250
tulanthoar 7:dcff685d41a5 251
tulanthoar 7:dcff685d41a5 252 /** @brief write a bitmap to the display
tulanthoar 7:dcff685d41a5 253 * @param uint8_t* data pointer to bitmap
tulanthoar 7:dcff685d41a5 254 * @param uint8_t start_page begin page (0..MAX_PAGE)
tulanthoar 7:dcff685d41a5 255 * @param uint8_t end_page end page (start_page..MAX_PAGE)
tulanthoar 7:dcff685d41a5 256 * @param uint8_t start_col begin column (0..MAX_COL)
tulanthoar 7:dcff685d41a5 257 * @param uint8_t end_col end column (start_col..MAX_COL)
tulanthoar 7:dcff685d41a5 258 */
tulanthoar 7:dcff685d41a5 259 void writeBitmap(uint8_t* data,
tulanthoar 7:dcff685d41a5 260 uint8_t start_page=0, uint8_t end_page=MAX_PAGE,
tulanthoar 7:dcff685d41a5 261 uint8_t start_col=0, uint8_t end_col=MAX_COL);
tulanthoar 7:dcff685d41a5 262
tulanthoar 7:dcff685d41a5 263 /** @brief write a level meter to the display, Width is (PRG_MAX_SCALE + 2) pixels
tulanthoar 7:dcff685d41a5 264 * @param uint8_t page begin page (0..MAX_PAGE)
tulanthoar 7:dcff685d41a5 265 * @param uint8_t col begin column (0..MAX_COL)
tulanthoar 7:dcff685d41a5 266 * @param int percentage value (0..100)
tulanthoar 7:dcff685d41a5 267 */
tulanthoar 7:dcff685d41a5 268 void writeProgressBar(uint8_t page, uint8_t col, int percentage);
tulanthoar 7:dcff685d41a5 269
tulanthoar 7:dcff685d41a5 270
tulanthoar 7:dcff685d41a5 271 /** @brief write a level meter to the display, Width is (PRG_MAX_SCALE + 2) pixels
tulanthoar 7:dcff685d41a5 272 * @param uint8_t page begin page (0..MAX_PAGE)
tulanthoar 7:dcff685d41a5 273 * @param uint8_t col begin column (0..MAX_COL)
tulanthoar 7:dcff685d41a5 274 * @param int percentage value (0..100)
tulanthoar 7:dcff685d41a5 275 */
tulanthoar 7:dcff685d41a5 276 void writeLevelBar(uint8_t page, uint8_t col, int percentage);
tulanthoar 7:dcff685d41a5 277
tulanthoar 7:dcff685d41a5 278 //void setXY(uint8_t, uint8_t y);
tulanthoar 7:dcff685d41a5 279
tulanthoar 7:dcff685d41a5 280 // Select inverted or normal text
tulanthoar 7:dcff685d41a5 281 void setInverted(bool inverted) {
tulanthoar 7:dcff685d41a5 282 _inverted = inverted;
tulanthoar 7:dcff685d41a5 283 };
tulanthoar 7:dcff685d41a5 284
tulanthoar 7:dcff685d41a5 285 /** @brief Write single character to the display using the 8x8 fontable
tulanthoar 7:dcff685d41a5 286 * @brief Start at current cursor location
tulanthoar 7:dcff685d41a5 287 * @param char chr character to write
tulanthoar 7:dcff685d41a5 288 */
tulanthoar 7:dcff685d41a5 289 void writeChar(char chr);
tulanthoar 7:dcff685d41a5 290
tulanthoar 7:dcff685d41a5 291 /** @brief Write large character (16x24 font)
tulanthoar 7:dcff685d41a5 292 * @param uint8_t row row number (0...MAX_ROW)
tulanthoar 7:dcff685d41a5 293 * @param uint8_t col column number (0...MAX_COL)
tulanthoar 7:dcff685d41a5 294 * @param char chr Used for displaying numbers 0 - 9 and '+', '-', '.'
tulanthoar 7:dcff685d41a5 295 */
tulanthoar 7:dcff685d41a5 296 void writeBigChar(uint8_t row, uint8_t col, char chr);
tulanthoar 7:dcff685d41a5 297
tulanthoar 7:dcff685d41a5 298 /** @brief Write a string to the display using the 8x8 font
tulanthoar 7:dcff685d41a5 299 * @brief Start at selected cursor location, text will wrap around until it is done
tulanthoar 7:dcff685d41a5 300 * @param uint8_t row row number (0...ROWS/FONT_HEIGHT)
tulanthoar 7:dcff685d41a5 301 * @param uint8_t col column number (0...COLUMNS/FONT_WIDTH)
tulanthoar 7:dcff685d41a5 302 * @param const char * text pointer to text
tulanthoar 7:dcff685d41a5 303 */
tulanthoar 7:dcff685d41a5 304 void writeString(uint8_t row, uint8_t col, const char* txt);
tulanthoar 7:dcff685d41a5 305
tulanthoar 7:dcff685d41a5 306 // Stream implementation - provides printf() interface
tulanthoar 7:dcff685d41a5 307 // You would otherwise be forced to use writeChar() or writeString()
tulanthoar 7:dcff685d41a5 308 virtual int _putc(int value) {
tulanthoar 7:dcff685d41a5 309 writeChar(value);
tulanthoar 7:dcff685d41a5 310 return 1;
tulanthoar 7:dcff685d41a5 311 };
tulanthoar 7:dcff685d41a5 312 virtual int _getc() {
tulanthoar 7:dcff685d41a5 313 return -1;
tulanthoar 7:dcff685d41a5 314 };
tulanthoar 7:dcff685d41a5 315
tulanthoar 7:dcff685d41a5 316 // Future extension with graphics features
tulanthoar 7:dcff685d41a5 317 // this must be defined by the subclass
tulanthoar 7:dcff685d41a5 318 // virtual void drawPixel(int16_t x, int16_t y, uint16_t color) = 0;
tulanthoar 7:dcff685d41a5 319
tulanthoar 7:dcff685d41a5 320 // Medium Level methods
tulanthoar 7:dcff685d41a5 321
tulanthoar 7:dcff685d41a5 322 /** @brief Set Horizontal Addressing Mode (cursor incr left-to-right, top-to-bottom)
tulanthoar 7:dcff685d41a5 323 *
tulanthoar 7:dcff685d41a5 324 */
tulanthoar 7:dcff685d41a5 325 void setHorizontalAddressingMode();
tulanthoar 7:dcff685d41a5 326
tulanthoar 7:dcff685d41a5 327 /** @brief Set Vertical Addressing Mode (cursor incr top-to-bottom, left-to-right)
tulanthoar 7:dcff685d41a5 328 *
tulanthoar 7:dcff685d41a5 329 */
tulanthoar 7:dcff685d41a5 330 void setVerticalAddressingMode();
tulanthoar 7:dcff685d41a5 331
tulanthoar 7:dcff685d41a5 332 /** @brief Set Page Addressing Mode (cursor incr left-to-right)
tulanthoar 7:dcff685d41a5 333 *
tulanthoar 7:dcff685d41a5 334 */
tulanthoar 7:dcff685d41a5 335 void setPageAddressingMode();
tulanthoar 7:dcff685d41a5 336
tulanthoar 7:dcff685d41a5 337 /** @brief Set Addressing Mode
tulanthoar 7:dcff685d41a5 338 * @param uint8_t mode
tulanthoar 7:dcff685d41a5 339 */
tulanthoar 7:dcff685d41a5 340 void setMemoryAddressingMode(uint8_t mode);
tulanthoar 7:dcff685d41a5 341
tulanthoar 7:dcff685d41a5 342
tulanthoar 7:dcff685d41a5 343 /**
tulanthoar 7:dcff685d41a5 344 * @brief Set Column Start (for Page Addressing Mode only)
tulanthoar 7:dcff685d41a5 345 * @param uint8_t column column start (valid range 0..MAX_COLS)
tulanthoar 7:dcff685d41a5 346 */
tulanthoar 7:dcff685d41a5 347 void setColumnStartForPageAddressingMode(uint8_t column);
tulanthoar 7:dcff685d41a5 348
tulanthoar 7:dcff685d41a5 349 /**
tulanthoar 7:dcff685d41a5 350 * @brief Set Page Start (for Page Addressing Mode only)
tulanthoar 7:dcff685d41a5 351 * @param uint8_t page page start (valid range PAGE0 - PAGE7)
tulanthoar 7:dcff685d41a5 352 */
tulanthoar 7:dcff685d41a5 353 void setPageStartForPageAddressingMode(uint8_t page);
tulanthoar 7:dcff685d41a5 354
tulanthoar 7:dcff685d41a5 355
tulanthoar 7:dcff685d41a5 356
tulanthoar 7:dcff685d41a5 357 /** @param uint8_t start startcolumn (valid range 0..MAX_COL)
tulanthoar 7:dcff685d41a5 358 * @param uint8_t end endcolumn (valid range start..MAX_COL)
tulanthoar 7:dcff685d41a5 359 */
tulanthoar 7:dcff685d41a5 360 void setColumnAddress(uint8_t start, uint8_t end);
tulanthoar 7:dcff685d41a5 361
tulanthoar 7:dcff685d41a5 362 /** @param uint8_t start startpage (valid range 0..MAX_PAGE)
tulanthoar 7:dcff685d41a5 363 * @param uint8_t end endpage (valid range start..MAX_PAGE)
tulanthoar 7:dcff685d41a5 364 */
tulanthoar 7:dcff685d41a5 365 void setPageAddress(uint8_t start, uint8_t end);
tulanthoar 7:dcff685d41a5 366
tulanthoar 7:dcff685d41a5 367
tulanthoar 7:dcff685d41a5 368 /**
tulanthoar 7:dcff685d41a5 369 * @brief Set Display StartLine, takes one byte, 0x00-0x3F
tulanthoar 7:dcff685d41a5 370 * @param uint8_t line startline (valid range 0..MAX_ROWS)
tulanthoar 7:dcff685d41a5 371 */
tulanthoar 7:dcff685d41a5 372 void setDisplayStartLine(uint8_t line);
tulanthoar 7:dcff685d41a5 373
tulanthoar 7:dcff685d41a5 374 /** @brief Set Contrast
tulanthoar 7:dcff685d41a5 375 * @param uint8_t contrast (valid range 0x00 (lowest) - 0xFF (highest))
tulanthoar 7:dcff685d41a5 376 */
tulanthoar 7:dcff685d41a5 377 void setContrastControl(uint8_t contrast);
tulanthoar 7:dcff685d41a5 378
tulanthoar 7:dcff685d41a5 379
tulanthoar 7:dcff685d41a5 380 /** @brief Shows All Pixels On
tulanthoar 7:dcff685d41a5 381 */
tulanthoar 7:dcff685d41a5 382 void setEntireDisplayOn();
tulanthoar 7:dcff685d41a5 383
tulanthoar 7:dcff685d41a5 384 /** @brief Shows Pixels as RAM content
tulanthoar 7:dcff685d41a5 385 */
tulanthoar 7:dcff685d41a5 386 void setEntireDisplayRAM();
tulanthoar 7:dcff685d41a5 387
tulanthoar 7:dcff685d41a5 388 /** @brief Shows Pixels On or as RAM content
tulanthoar 7:dcff685d41a5 389 * @param bool on (true is All on, false is RAM content)
tulanthoar 7:dcff685d41a5 390 */
tulanthoar 7:dcff685d41a5 391 void setEntireDisplay(bool on);
tulanthoar 7:dcff685d41a5 392
tulanthoar 7:dcff685d41a5 393
tulanthoar 7:dcff685d41a5 394 // @brief Set Display line MPX Ratio, takes one byte, 0x00-0x3F
tulanthoar 7:dcff685d41a5 395 // @param uint8_t lines (valid range 0..MAX_ROWS)
tulanthoar 7:dcff685d41a5 396 void setMultiplexRatio(uint8_t lines);
tulanthoar 7:dcff685d41a5 397
tulanthoar 7:dcff685d41a5 398
tulanthoar 7:dcff685d41a5 399 /** @brief Sets Internal Iref
tulanthoar 7:dcff685d41a5 400 */
tulanthoar 7:dcff685d41a5 401 void setInternalIref();
tulanthoar 7:dcff685d41a5 402
tulanthoar 7:dcff685d41a5 403 /** @brief Sets External Iref (default)
tulanthoar 7:dcff685d41a5 404 */
tulanthoar 7:dcff685d41a5 405 void setExternalIref();
tulanthoar 7:dcff685d41a5 406
tulanthoar 7:dcff685d41a5 407
tulanthoar 7:dcff685d41a5 408 /** @brief Enable Display
tulanthoar 7:dcff685d41a5 409 */
tulanthoar 7:dcff685d41a5 410 void setDisplayOn();
tulanthoar 7:dcff685d41a5 411
tulanthoar 7:dcff685d41a5 412 /** @brief Disable Display
tulanthoar 7:dcff685d41a5 413 */
tulanthoar 7:dcff685d41a5 414 void setDisplayOff();
tulanthoar 7:dcff685d41a5 415
tulanthoar 7:dcff685d41a5 416 /** @brief Enable or Disable Display
tulanthoar 7:dcff685d41a5 417 * @param bool on
tulanthoar 7:dcff685d41a5 418 */
tulanthoar 7:dcff685d41a5 419 void setDisplayPower(bool on);
tulanthoar 7:dcff685d41a5 420
tulanthoar 7:dcff685d41a5 421 /** @brief Show White pixels on Black background
tulanthoar 7:dcff685d41a5 422 */
tulanthoar 7:dcff685d41a5 423 void setDisplayNormal();
tulanthoar 7:dcff685d41a5 424
tulanthoar 7:dcff685d41a5 425 /** @brief Show Black pixels on White background
tulanthoar 7:dcff685d41a5 426 */
tulanthoar 7:dcff685d41a5 427 void setDisplayInverse();
tulanthoar 7:dcff685d41a5 428
tulanthoar 7:dcff685d41a5 429 /** @brief Blink display by fading in and out over a set number of frames
tulanthoar 7:dcff685d41a5 430 * @param bool on
tulanthoar 7:dcff685d41a5 431 */
tulanthoar 7:dcff685d41a5 432 void setDisplayBlink(bool on);
tulanthoar 7:dcff685d41a5 433
tulanthoar 7:dcff685d41a5 434 /** @brief Fade out display in set number of frames
tulanthoar 7:dcff685d41a5 435 * @param bool on
tulanthoar 7:dcff685d41a5 436 */
tulanthoar 7:dcff685d41a5 437 void setDisplayFade(bool on);
tulanthoar 7:dcff685d41a5 438
tulanthoar 7:dcff685d41a5 439 /** @brief Display Flip (Left/Right, Up/Down)
tulanthoar 7:dcff685d41a5 440 * @param bool left flip Left/Right
tulanthoar 7:dcff685d41a5 441 * @param bool down flip Up/Down
tulanthoar 7:dcff685d41a5 442 */
tulanthoar 7:dcff685d41a5 443 void setDisplayFlip(bool left, bool down);
tulanthoar 7:dcff685d41a5 444
tulanthoar 7:dcff685d41a5 445 // Set vertical shift by COM from 0 - 63 (0x00 - 0x3F) (Reset = 0x00)
tulanthoar 7:dcff685d41a5 446 void setDisplayOffset(uint8_t offset);
tulanthoar 7:dcff685d41a5 447
tulanthoar 7:dcff685d41a5 448 // Oscillator freq 0x00-0x0F (reset 0x08)
tulanthoar 7:dcff685d41a5 449 // Divide ratio 0x00-0x0F, value +1 (reset 0x00)
tulanthoar 7:dcff685d41a5 450 void setDisplayClock(uint8_t divideRatio, uint8_t oscFreq);
tulanthoar 7:dcff685d41a5 451
tulanthoar 7:dcff685d41a5 452 // Phase1 0x01-0x0F period of up to 15 DCLK clocks (reset 0x02, 0 is invalid)
tulanthoar 7:dcff685d41a5 453 // Phase2 0x01-0x0F period of up to 15 DCLK clocks (reset 0x02, 0 is invalid)
tulanthoar 7:dcff685d41a5 454 void setPrechargePeriod(uint8_t phase1, uint8_t phase2);
tulanthoar 7:dcff685d41a5 455
tulanthoar 7:dcff685d41a5 456 // See defines above for levels
tulanthoar 7:dcff685d41a5 457 void setVcomhDeselectLevel(uint8_t level);
tulanthoar 7:dcff685d41a5 458
tulanthoar 7:dcff685d41a5 459
tulanthoar 7:dcff685d41a5 460 // Command for no-operation
tulanthoar 7:dcff685d41a5 461 void nop();
tulanthoar 7:dcff685d41a5 462
tulanthoar 7:dcff685d41a5 463
tulanthoar 7:dcff685d41a5 464 /** @brief Horizontal scroll by one column per interval
tulanthoar 7:dcff685d41a5 465 * @param bool left select Left/Right scroll
tulanthoar 7:dcff685d41a5 466 * @param uint8_t start_page begin page (0..MAX_PAGE)
tulanthoar 7:dcff685d41a5 467 * @param uint8_t end_page end page (start_page..MAX_PAGE)
tulanthoar 7:dcff685d41a5 468 * @param uint8_t interval scroll interval in frames (see codes above)
tulanthoar 7:dcff685d41a5 469 */
tulanthoar 7:dcff685d41a5 470 void setContinuousHorizontalScroll(bool left, uint8_t start_page, uint8_t end_page, uint8_t interval);
tulanthoar 7:dcff685d41a5 471
tulanthoar 7:dcff685d41a5 472
tulanthoar 7:dcff685d41a5 473 /** @brief Horizontal and Vertical scroll by one column per interval
tulanthoar 7:dcff685d41a5 474 * @param bool left select Left/Right scroll
tulanthoar 7:dcff685d41a5 475 * @param uint8_t start_page begin page (0..MAX_PAGE)
tulanthoar 7:dcff685d41a5 476 * @param uint8_t end_page end page (start_page..MAX_PAGE)
tulanthoar 7:dcff685d41a5 477 * @param uint8_t offset vert offset (0x01..0x63)
tulanthoar 7:dcff685d41a5 478 * @param uint8_t interval scroll interval in frames (see codes above)
tulanthoar 7:dcff685d41a5 479 */
tulanthoar 7:dcff685d41a5 480 void setContinuousVerticalAndHorizontalScroll(bool left, uint8_t start_page, uint8_t end_page,
tulanthoar 7:dcff685d41a5 481 uint8_t offset, uint8_t interval);
tulanthoar 7:dcff685d41a5 482
tulanthoar 7:dcff685d41a5 483 /** @brief Activate or Deactivate Horizontal and Vertical scroll
tulanthoar 7:dcff685d41a5 484 * @brief Note: after deactivating scrolling, the RAM data needs to be rewritten
tulanthoar 7:dcff685d41a5 485 * @param bool on activate scroll
tulanthoar 7:dcff685d41a5 486 */
tulanthoar 7:dcff685d41a5 487 void setDisplayScroll(bool on);
tulanthoar 7:dcff685d41a5 488
tulanthoar 7:dcff685d41a5 489
tulanthoar 7:dcff685d41a5 490 /** @brief Set Vertical scroll area
tulanthoar 7:dcff685d41a5 491 * @param uint8_t topRowsFixed fixed rows (0..MAX_ROW)
tulanthoar 7:dcff685d41a5 492 * @param uint8_t scrollRowsoffset scroll rows (topRowsFixed..MAX_ROW)
tulanthoar 7:dcff685d41a5 493 */
tulanthoar 7:dcff685d41a5 494 void setVerticalScrollArea(uint8_t topRowsFixed, uint8_t scrollRows);
tulanthoar 7:dcff685d41a5 495
tulanthoar 7:dcff685d41a5 496 private:
tulanthoar 7:dcff685d41a5 497
tulanthoar 7:dcff685d41a5 498 // Low Level methods
tulanthoar 7:dcff685d41a5 499
tulanthoar 7:dcff685d41a5 500 /** @brief Write command that has no parameters
tulanthoar 7:dcff685d41a5 501 */
tulanthoar 7:dcff685d41a5 502 void _sendCommand(uint8_t command);
tulanthoar 7:dcff685d41a5 503
tulanthoar 7:dcff685d41a5 504 /** @brief Write command that has one parameter
tulanthoar 7:dcff685d41a5 505 */
tulanthoar 7:dcff685d41a5 506 void _sendCommand(uint8_t command, uint8_t param1);
tulanthoar 7:dcff685d41a5 507
tulanthoar 7:dcff685d41a5 508 /** @brief Write command that has two parameters
tulanthoar 7:dcff685d41a5 509 */
tulanthoar 7:dcff685d41a5 510 void _sendCommand(uint8_t command, uint8_t param1, uint8_t param2);
tulanthoar 7:dcff685d41a5 511 // void sendCommands(uint8_t len, uint8_t* buf);
tulanthoar 7:dcff685d41a5 512
tulanthoar 7:dcff685d41a5 513 /** @brief Write command that has five parameters
tulanthoar 7:dcff685d41a5 514 */
tulanthoar 7:dcff685d41a5 515 void _sendCommand(uint8_t command, uint8_t param1, uint8_t param2,
tulanthoar 7:dcff685d41a5 516 uint8_t param3, uint8_t param4,
tulanthoar 7:dcff685d41a5 517 uint8_t param5);
tulanthoar 7:dcff685d41a5 518
tulanthoar 7:dcff685d41a5 519 /** @brief Write command that has six parameters
tulanthoar 7:dcff685d41a5 520 */
tulanthoar 7:dcff685d41a5 521 void _sendCommand(uint8_t command, uint8_t param1, uint8_t param2,
tulanthoar 7:dcff685d41a5 522 uint8_t param3, uint8_t param4,
tulanthoar 7:dcff685d41a5 523 uint8_t param5, uint8_t param6);
tulanthoar 7:dcff685d41a5 524
tulanthoar 7:dcff685d41a5 525 /** @brief Write databyte to display
tulanthoar 7:dcff685d41a5 526 * @brief Start at current cursor location
tulanthoar 7:dcff685d41a5 527 * @param uint8_t data databyte to write
tulanthoar 7:dcff685d41a5 528 */
tulanthoar 7:dcff685d41a5 529 void _sendData(uint8_t data);
tulanthoar 7:dcff685d41a5 530
tulanthoar 7:dcff685d41a5 531 /** @brief Write len bytes from buffer data to display,
tulanthoar 7:dcff685d41a5 532 * @brief Start at current cursor location
tulanthoar 7:dcff685d41a5 533 * @param uint8_t len number of bytes to write
tulanthoar 7:dcff685d41a5 534 * @param uint8_t* data pointer to data
tulanthoar 7:dcff685d41a5 535 */
tulanthoar 7:dcff685d41a5 536 void _sendData(uint8_t len, uint8_t* data);
tulanthoar 7:dcff685d41a5 537
tulanthoar 7:dcff685d41a5 538 /** @brief Low level Init
tulanthoar 7:dcff685d41a5 539 * @brief Init the configuration registers in accordance with the datasheet
tulanthoar 7:dcff685d41a5 540 */
tulanthoar 7:dcff685d41a5 541 void _init();
tulanthoar 7:dcff685d41a5 542
tulanthoar 10:74ef7544744e 543 I2C * _i2c; // I2C bus reference
tulanthoar 7:dcff685d41a5 544 uint8_t _readOpcode; // contains the I2C address of the device
tulanthoar 7:dcff685d41a5 545 uint8_t _writeOpcode; // contains the I2C address of the device
tulanthoar 7:dcff685d41a5 546
tulanthoar 7:dcff685d41a5 547 bool _inverted; // inverted or normal text
tulanthoar 7:dcff685d41a5 548 };
tulanthoar 7:dcff685d41a5 549
tulanthoar 7:dcff685d41a5 550 #endif