SSD1306 OLED display driver  1.4.6
This library is developed to control SSD1306/SSD1331 RGB i2c/spi OLED displays and spi PCD8544 LED display
ssd1306.h
Go to the documentation of this file.
1 /*
2  MIT License
3 
4  Copyright (c) 2016-2018, Alexey Dynda
5 
6  Permission is hereby granted, free of charge, to any person obtaining a copy
7  of this software and associated documentation files (the "Software"), to deal
8  in the Software without restriction, including without limitation the rights
9  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  copies of the Software, and to permit persons to whom the Software is
11  furnished to do so, subject to the following conditions:
12 
13  The above copyright notice and this permission notice shall be included in all
14  copies or substantial portions of the Software.
15 
16  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  SOFTWARE.
23 */
29 #ifndef _SSD1306_H_
30 #define _SSD1306_H_
31 
32 #include "nano_gfx_types.h"
33 #include "i2c/ssd1306_i2c_conf.h"
34 #include "spi/ssd1306_spi_conf.h"
35 #include "lcd/ssd1306_128x64.h"
36 #include "lcd/ssd1306_128x32.h"
37 #include "lcd/ssd1331_96x64.h"
38 #include "lcd/sh1106_128x64.h"
39 #include "lcd/pcd8544_84x48.h"
40 
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44 
46 // DISPLAY CONTROL FUNCTIONS
48 
57 void ssd1306_displayOff();
58 
62 void ssd1306_displayOn();
63 
68 void ssd1306_setContrast(uint8_t contrast);
69 
75 void ssd1306_invertMode();
76 
81 void ssd1306_normalMode();
82 
86 uint8_t ssd1306_displayHeight();
87 
91 uint8_t ssd1306_displayWidth();
92 
97 // DIRECT GRAPH FUNCTIONS
100 
111 void ssd1306_setPos(uint8_t x, uint8_t y);
112 
116 void ssd1306_fillScreen(uint8_t fill_Data);
117 
121 void ssd1306_clearScreen();
122 
127 void ssd1306_negativeMode();
128 
133 void ssd1306_positiveMode();
134 
149 uint8_t ssd1306_printFixed(uint8_t xpos, uint8_t y, const char ch[], EFontStyle style);
150 
165 uint8_t ssd1306_printFixed2x(uint8_t xpos, uint8_t y, const char ch[], EFontStyle style) __attribute__ ((deprecated));
166 
186 uint8_t ssd1306_printFixedN(uint8_t xpos, uint8_t y, const char ch[], EFontStyle style, uint8_t factor);
187 
196 uint8_t ssd1306_charF6x8(uint8_t x, uint8_t y,
197  const char ch[],
198  EFontStyle style
199 #ifdef __cplusplus
200  = STYLE_NORMAL
201 #endif
202  ) __attribute__ ((deprecated));
203 
212 uint8_t ssd1306_charF12x16(uint8_t xpos,
213  uint8_t y,
214  const char ch[],
215  EFontStyle style) __attribute__ ((deprecated));
216 
217 
230 uint8_t ssd1306_charF6x8_eol(uint8_t left,
231  uint8_t y,
232  const char ch[],
233  EFontStyle style,
234  uint8_t right) __attribute__ ((deprecated));
235 
236 
255 void ssd1306_setFixedFont(const uint8_t * progmemFont);
256 
267 void ssd1306_setFont6x8(const uint8_t * progmemFont) __attribute__ ((deprecated));
268 
281 void ssd1306_putPixel(uint8_t x, uint8_t y);
282 
297 void ssd1306_putPixels(uint8_t x, uint8_t y, uint8_t pixels);
298 
306 void ssd1306_drawRect(uint8_t x1, uint8_t y1, uint8_t x2, uint8_t y2);
307 
308 
321 void ssd1306_drawLine(uint8_t x1, uint8_t y1, uint8_t x2, uint8_t y2);
322 
329 void ssd1306_drawHLine(uint8_t x1, uint8_t y1, uint8_t x2);
330 
337 void ssd1306_drawVLine(uint8_t x1, uint8_t y1, uint8_t y2);
338 
355 void ssd1306_drawBuffer(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *buf);
356 
360 #define ssd1306_drawCanvas(x, y, w, h, buf) ssd1306_drawBuffer(x, y, w, h, buf)
361 
371 void ssd1306_drawBitmap(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *buf);
372 
373 
382 void ssd1306_clearBlock(uint8_t x, uint8_t y, uint8_t w, uint8_t h);
383 
384 
392 void ssd1306_drawSpriteEx(uint8_t x, uint8_t y, uint8_t w, const uint8_t *sprite);
393 
399 void ssd1306_drawSprite(SPRITE *sprite);
400 
405 void ssd1306_eraseSprite(SPRITE *sprite);
406 
411 void ssd1306_eraseTrace(SPRITE *sprite);
412 
421 SPRITE ssd1306_createSprite(uint8_t x, uint8_t y, uint8_t w, const uint8_t *data);
422 
429 void ssd1306_replaceSprite(SPRITE *sprite, const uint8_t *data);
430 
435 // HIGH-LEVEL GRAPH FUNCTIONS
438 
447 typedef struct
448 {
450  const char **items;
452  uint8_t count;
454  uint8_t selection;
456  uint8_t oldSelection;
458  uint8_t scrollPosition;
459 } SAppMenu;
460 
470 void ssd1306_createMenu(SAppMenu *menu, const char **items, uint8_t count);
471 
478 void ssd1306_showMenu(SAppMenu *menu);
479 
486 void ssd1306_updateMenu(SAppMenu *menu);
487 
488 
495 uint8_t ssd1306_menuSelection(SAppMenu *menu);
496 
497 
505 void ssd1306_menuDown(SAppMenu *menu);
506 
507 
515 void ssd1306_menuUp(SAppMenu *menu);
516 
521 #ifdef __cplusplus
522 }
523 #endif
524 
525 #endif // _SSD1306_H_
void ssd1306_showMenu(SAppMenu *menu)
Definition: ssd1306_menu.c:77
uint8_t ssd1306_printFixed2x(uint8_t xpos, uint8_t y, const char ch[], EFontStyle style) __attribute__((deprecated))
Definition: ssd1306.c:179
void ssd1306_drawBitmap(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *buf)
Definition: ssd1306.c:641
void ssd1306_negativeMode()
Definition: ssd1306.c:808
void ssd1306_setContrast(uint8_t contrast)
Definition: ssd1306.c:98
uint8_t ssd1306_printFixedN(uint8_t xpos, uint8_t y, const char ch[], EFontStyle style, uint8_t factor)
Definition: ssd1306.c:259
void ssd1306_displayOff()
Definition: ssd1306.c:87
uint8_t ssd1306_displayHeight()
Definition: ssd1306.c:45
void ssd1306_replaceSprite(SPRITE *sprite, const uint8_t *data)
Definition: ssd1306.c:787
void ssd1306_drawHLine(uint8_t x1, uint8_t y1, uint8_t x2)
Definition: ssd1306.c:581
void ssd1306_displayOn()
Definition: ssd1306.c:93
void ssd1306_drawVLine(uint8_t x1, uint8_t y1, uint8_t y2)
Definition: ssd1306.c:592
void ssd1306_positiveMode()
Definition: ssd1306.c:813
void ssd1306_updateMenu(SAppMenu *menu)
Definition: ssd1306_menu.c:88
void ssd1306_putPixels(uint8_t x, uint8_t y, uint8_t pixels)
Definition: ssd1306.c:508
SPRITE ssd1306_createSprite(uint8_t x, uint8_t y, uint8_t w, const uint8_t *data)
Definition: ssd1306.c:782
void ssd1306_drawLine(uint8_t x1, uint8_t y1, uint8_t x2, uint8_t y2)
Definition: ssd1306.c:536
void ssd1306_drawSpriteEx(uint8_t x, uint8_t y, uint8_t w, const uint8_t *sprite)
Definition: ssd1306.c:678
void ssd1306_fillScreen(uint8_t fill_Data)
Definition: ssd1306.c:55
void ssd1306_drawRect(uint8_t x1, uint8_t y1, uint8_t x2, uint8_t y2)
Definition: ssd1306.c:617
uint8_t selection
currently selected item. Internally updated.
Definition: ssd1306.h:454
void ssd1306_createMenu(SAppMenu *menu, const char **items, uint8_t count)
Definition: ssd1306_menu.c:41
void ssd1306_clearScreen()
Definition: ssd1306.c:71
uint8_t scrollPosition
position of menu scrolling. Internally updated
Definition: ssd1306.h:458
void ssd1306_clearBlock(uint8_t x, uint8_t y, uint8_t w, uint8_t h)
Definition: ssd1306.c:661
uint8_t count
count of menu items in the menu
Definition: ssd1306.h:452
void ssd1306_setFixedFont(const uint8_t *progmemFont)
Definition: ssd1306.c:487
uint8_t ssd1306_charF6x8_eol(uint8_t left, uint8_t y, const char ch[], EFontStyle style, uint8_t right) __attribute__((deprecated))
Definition: ssd1306.c:472
void ssd1306_invertMode()
Definition: ssd1306.c:792
void ssd1306_setFont6x8(const uint8_t *progmemFont) __attribute__((deprecated))
Definition: ssd1306.c:495
uint8_t ssd1306_displayWidth()
Definition: ssd1306.c:50
void ssd1306_drawSprite(SPRITE *sprite)
Definition: ssd1306.c:691
void ssd1306_eraseTrace(SPRITE *sprite)
Definition: ssd1306.c:743
void ssd1306_drawBuffer(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *buf)
Definition: ssd1306.c:625
void ssd1306_eraseSprite(SPRITE *sprite)
Definition: ssd1306.c:719
void ssd1306_setPos(uint8_t x, uint8_t y)
void ssd1306_normalMode()
Definition: ssd1306.c:800
uint8_t ssd1306_charF12x16(uint8_t xpos, uint8_t y, const char ch[], EFontStyle style) __attribute__((deprecated))
Definition: ssd1306.c:397
void ssd1306_putPixel(uint8_t x, uint8_t y)
Definition: ssd1306.c:500
uint8_t ssd1306_menuSelection(SAppMenu *menu)
Definition: ssd1306_menu.c:107
void ssd1306_menuDown(SAppMenu *menu)
Definition: ssd1306_menu.c:112
uint8_t ssd1306_printFixed(uint8_t xpos, uint8_t y, const char ch[], EFontStyle style)
Definition: ssd1306.c:106
EFontStyle
void ssd1306_menuUp(SAppMenu *menu)
Definition: ssd1306_menu.c:124
uint8_t ssd1306_charF6x8(uint8_t x, uint8_t y, const char ch[], EFontStyle style=STYLE_NORMAL) __attribute__((deprecated))
Definition: ssd1306.c:351
uint8_t oldSelection
selected item, when last redraw operation was performed. Internally updated.
Definition: ssd1306.h:456
const char ** items
list of menu items of the menu
Definition: ssd1306.h:450