SSD1306 OLED display driver  1.4.0
This library is developed to control SSD1306 i2c/spi OLED 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/sh1106_128x64.h"
38 #include "lcd/pcd8544_84x48.h"
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
45 // DISPLAY CONTROL FUNCTIONS
47 
56 void ssd1306_displayOff();
57 
61 void ssd1306_displayOn();
62 
67 void ssd1306_invertMode();
68 
72 void ssd1306_normalMode();
73 
77 uint8_t ssd1306_displayHeight();
78 
82 uint8_t ssd1306_displayWidth();
83 
88 // DIRECT GRAPH FUNCTIONS
91 
102 void ssd1306_setPos(uint8_t x, uint8_t y);
103 
107 void ssd1306_fillScreen(uint8_t fill_Data);
108 
112 void ssd1306_clearScreen();
113 
118 void ssd1306_negativeMode();
119 
124 void ssd1306_positiveMode();
125 
137 uint8_t ssd1306_printFixed(uint8_t xpos, uint8_t y, const char ch[], EFontStyle style);
138 
150 uint8_t ssd1306_printFixed2x(uint8_t xpos, uint8_t y, const char ch[], EFontStyle style);
151 
160 uint8_t ssd1306_charF6x8(uint8_t x, uint8_t y,
161  const char ch[],
162  EFontStyle style
163 #ifdef __cplusplus
164  = STYLE_NORMAL
165 #endif
166  );
167 
176 uint8_t ssd1306_charF12x16(uint8_t xpos,
177  uint8_t y,
178  const char ch[],
179  EFontStyle style);
180 
181 
194 uint8_t ssd1306_charF6x8_eol(uint8_t left,
195  uint8_t y,
196  const char ch[],
197  EFontStyle style,
198  uint8_t right);
199 
200 
219 void ssd1306_setFixedFont(const uint8_t * progmemFont);
220 
231 void ssd1306_setFont6x8(const uint8_t * progmemFont);
232 
245 void ssd1306_putPixel(uint8_t x, uint8_t y);
246 
261 void ssd1306_putPixels(uint8_t x, uint8_t y, uint8_t pixels);
262 
270 void ssd1306_drawRect(uint8_t x1, uint8_t y1, uint8_t x2, uint8_t y2);
271 
278 void ssd1306_drawHLine(uint8_t x1, uint8_t y1, uint8_t x2);
279 
286 void ssd1306_drawVLine(uint8_t x1, uint8_t y1, uint8_t y2);
287 
304 void ssd1306_drawBuffer(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *buf);
305 
309 #define ssd1306_drawCanvas(x, y, w, h, buf) ssd1306_drawBuffer(x, y, w, h, buf)
310 
320 void ssd1306_drawBitmap(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *buf);
321 
322 
331 void ssd1306_clearBlock(uint8_t x, uint8_t y, uint8_t w, uint8_t h);
332 
333 
341 void ssd1306_drawSpriteEx(uint8_t x, uint8_t y, uint8_t w, const uint8_t *sprite);
342 
348 void ssd1306_drawSprite(SPRITE *sprite);
349 
354 void ssd1306_eraseSprite(SPRITE *sprite);
355 
360 void ssd1306_eraseTrace(SPRITE *sprite);
361 
370 SPRITE ssd1306_createSprite(uint8_t x, uint8_t y, uint8_t w, const uint8_t *data);
371 
378 void ssd1306_replaceSprite(SPRITE *sprite, const uint8_t *data);
379 
384 // HIGH-LEVEL GRAPH FUNCTIONS
387 
396 typedef struct
397 {
399  const char **items;
401  uint8_t count;
403  uint8_t selection;
405  uint8_t oldSelection;
407  uint8_t scrollPosition;
408 } SAppMenu;
409 
419 void ssd1306_createMenu(SAppMenu *menu, const char **items, uint8_t count);
420 
427 void ssd1306_showMenu(SAppMenu *menu);
428 
435 void ssd1306_updateMenu(SAppMenu *menu);
436 
437 
444 uint8_t ssd1306_menuSelection(SAppMenu *menu);
445 
446 
454 void ssd1306_menuDown(SAppMenu *menu);
455 
456 
464 void ssd1306_menuUp(SAppMenu *menu);
465 
470 #ifdef __cplusplus
471 }
472 #endif
473 
474 #endif // _SSD1306_H_
void ssd1306_showMenu(SAppMenu *menu)
Definition: ssd1306_menu.c:77
void ssd1306_drawBitmap(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *buf)
Definition: ssd1306.c:473
void ssd1306_negativeMode()
Definition: ssd1306.c:631
void ssd1306_displayOff()
Definition: ssd1306.c:85
uint8_t ssd1306_displayHeight()
Definition: ssd1306.c:43
void ssd1306_replaceSprite(SPRITE *sprite, const uint8_t *data)
Definition: ssd1306.c:616
void ssd1306_drawHLine(uint8_t x1, uint8_t y1, uint8_t x2)
Definition: ssd1306.c:413
void ssd1306_setFont6x8(const uint8_t *progmemFont)
Definition: ssd1306.c:392
uint8_t ssd1306_charF6x8_eol(uint8_t left, uint8_t y, const char ch[], EFontStyle style, uint8_t right)
Definition: ssd1306.c:370
void ssd1306_displayOn()
Definition: ssd1306.c:91
void ssd1306_drawVLine(uint8_t x1, uint8_t y1, uint8_t y2)
Definition: ssd1306.c:424
void ssd1306_positiveMode()
Definition: ssd1306.c:636
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:405
SPRITE ssd1306_createSprite(uint8_t x, uint8_t y, uint8_t w, const uint8_t *data)
Definition: ssd1306.c:611
void ssd1306_drawSpriteEx(uint8_t x, uint8_t y, uint8_t w, const uint8_t *sprite)
Definition: ssd1306.c:507
void ssd1306_fillScreen(uint8_t fill_Data)
Definition: ssd1306.c:53
void ssd1306_drawRect(uint8_t x1, uint8_t y1, uint8_t x2, uint8_t y2)
Definition: ssd1306.c:449
uint8_t selection
currently selected item. Internally updated.
Definition: ssd1306.h:403
void ssd1306_createMenu(SAppMenu *menu, const char **items, uint8_t count)
Definition: ssd1306_menu.c:41
void ssd1306_clearScreen()
Definition: ssd1306.c:69
uint8_t scrollPosition
position of menu scrolling. Internally updated
Definition: ssd1306.h:407
uint8_t ssd1306_charF12x16(uint8_t xpos, uint8_t y, const char ch[], EFontStyle style)
Definition: ssd1306.c:295
uint8_t ssd1306_charF6x8(uint8_t x, uint8_t y, const char ch[], EFontStyle style=STYLE_NORMAL)
Definition: ssd1306.c:249
void ssd1306_clearBlock(uint8_t x, uint8_t y, uint8_t w, uint8_t h)
Definition: ssd1306.c:490
uint8_t count
count of menu items in the menu
Definition: ssd1306.h:401
void ssd1306_setFixedFont(const uint8_t *progmemFont)
Definition: ssd1306.c:385
uint8_t ssd1306_printFixed2x(uint8_t xpos, uint8_t y, const char ch[], EFontStyle style)
Definition: ssd1306.c:169
void ssd1306_invertMode()
Definition: ssd1306.c:621
uint8_t ssd1306_displayWidth()
Definition: ssd1306.c:48
void ssd1306_drawSprite(SPRITE *sprite)
Definition: ssd1306.c:520
void ssd1306_eraseTrace(SPRITE *sprite)
Definition: ssd1306.c:572
void ssd1306_drawBuffer(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *buf)
Definition: ssd1306.c:457
void ssd1306_eraseSprite(SPRITE *sprite)
Definition: ssd1306.c:548
void ssd1306_setPos(uint8_t x, uint8_t y)
void ssd1306_normalMode()
Definition: ssd1306.c:626
void ssd1306_putPixel(uint8_t x, uint8_t y)
Definition: ssd1306.c:397
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:96
EFontStyle
void ssd1306_menuUp(SAppMenu *menu)
Definition: ssd1306_menu.c:124
uint8_t oldSelection
selected item, when last redraw operation was performed. Internally updated.
Definition: ssd1306.h:405
const char ** items
list of menu items of the menu
Definition: ssd1306.h:399