SSD1306 OLED display driver  1.4.10
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(void);
58 
62 void ssd1306_displayOn(void);
63 
68 void ssd1306_setContrast(uint8_t contrast);
69 
75 void ssd1306_invertMode(void);
76 
81 void ssd1306_normalMode(void);
82 
92 void ssd1306_flipHorizontal(uint8_t mode);
93 
103 void ssd1306_flipVertical(uint8_t mode);
104 
108 uint8_t ssd1306_displayHeight(void);
109 
113 uint8_t ssd1306_displayWidth(void);
114 
119 // DIRECT GRAPH FUNCTIONS
122 
133 void ssd1306_setPos(uint8_t x, uint8_t y);
134 
138 void ssd1306_fillScreen(uint8_t fill_Data);
139 
143 void ssd1306_clearScreen(void);
144 
149 void ssd1306_negativeMode(void);
150 
155 void ssd1306_positiveMode(void);
156 
171 uint8_t ssd1306_printFixed(uint8_t xpos, uint8_t y, const char ch[], EFontStyle style);
172 
187 uint8_t ssd1306_printFixed2x(uint8_t xpos, uint8_t y, const char ch[], EFontStyle style) __attribute__ ((deprecated));
188 
208 uint8_t ssd1306_printFixedN(uint8_t xpos, uint8_t y, const char ch[], EFontStyle style, uint8_t factor);
209 
218 uint8_t ssd1306_charF6x8(uint8_t x, uint8_t y,
219  const char ch[],
220  EFontStyle style
221 #ifdef __cplusplus
222  = STYLE_NORMAL
223 #endif
224  ) __attribute__ ((deprecated));
225 
234 uint8_t ssd1306_charF12x16(uint8_t xpos,
235  uint8_t y,
236  const char ch[],
237  EFontStyle style) __attribute__ ((deprecated));
238 
239 
252 uint8_t ssd1306_charF6x8_eol(uint8_t left,
253  uint8_t y,
254  const char ch[],
255  EFontStyle style,
256  uint8_t right) __attribute__ ((deprecated));
257 
276 void ssd1306_setFixedFont(const uint8_t * progmemFont);
277 
288 void ssd1306_setFont6x8(const uint8_t * progmemFont) __attribute__ ((deprecated));
289 
302 void ssd1306_putPixel(uint8_t x, uint8_t y);
303 
318 void ssd1306_putPixels(uint8_t x, uint8_t y, uint8_t pixels);
319 
327 void ssd1306_drawRect(uint8_t x1, uint8_t y1, uint8_t x2, uint8_t y2);
328 
341 void ssd1306_drawLine(uint8_t x1, uint8_t y1, uint8_t x2, uint8_t y2);
342 
349 void ssd1306_drawHLine(uint8_t x1, uint8_t y1, uint8_t x2);
350 
357 void ssd1306_drawVLine(uint8_t x1, uint8_t y1, uint8_t y2);
358 
375 void ssd1306_drawBuffer(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *buf);
376 
380 #define ssd1306_drawCanvas(x, y, w, h, buf) ssd1306_drawBuffer(x, y, w, h, buf)
381 
391 void ssd1306_drawBitmap(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *buf);
392 
402 void gfx_drawMonoBitmap(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buf);
403 
412 void ssd1306_clearBlock(uint8_t x, uint8_t y, uint8_t w, uint8_t h);
413 
421 void ssd1306_drawSpriteEx(uint8_t x, uint8_t y, uint8_t w, const uint8_t *sprite);
422 
428 void ssd1306_drawSprite(SPRITE *sprite);
429 
434 void ssd1306_eraseSprite(SPRITE *sprite);
435 
440 void ssd1306_eraseTrace(SPRITE *sprite);
441 
450 SPRITE ssd1306_createSprite(uint8_t x, uint8_t y, uint8_t w, const uint8_t *data);
451 
458 void ssd1306_replaceSprite(SPRITE *sprite, const uint8_t *data);
459 
464 // HIGH-LEVEL GRAPH FUNCTIONS
467 
476 typedef struct
477 {
479  const char **items;
481  uint8_t count;
483  uint8_t selection;
485  uint8_t oldSelection;
487  uint8_t scrollPosition;
488 } SAppMenu;
489 
499 void ssd1306_createMenu(SAppMenu *menu, const char **items, uint8_t count);
500 
507 void ssd1306_showMenu(SAppMenu *menu);
508 
515 void ssd1306_updateMenu(SAppMenu *menu);
516 
523 uint8_t ssd1306_menuSelection(SAppMenu *menu);
524 
532 void ssd1306_menuDown(SAppMenu *menu);
533 
541 void ssd1306_menuUp(SAppMenu *menu);
542 
547 #ifdef __cplusplus
548 }
549 #endif
550 
551 #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:180
void ssd1306_drawBitmap(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *buf)
Definition: ssd1306.c:642
uint8_t ssd1306_displayWidth(void)
Definition: ssd1306.c:50
unsigned int lcduint_t
Definition: io.h:42
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:260
void ssd1306_negativeMode(void)
Definition: ssd1306.c:880
void ssd1306_replaceSprite(SPRITE *sprite, const uint8_t *data)
Definition: ssd1306.c:843
void ssd1306_drawHLine(uint8_t x1, uint8_t y1, uint8_t x2)
Definition: ssd1306.c:582
void gfx_drawMonoBitmap(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buf)
Definition: ssd1306.c:661
uint8_t ssd1306_displayHeight(void)
Definition: ssd1306.c:45
void ssd1306_drawVLine(uint8_t x1, uint8_t y1, uint8_t y2)
Definition: ssd1306.c:593
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:509
SPRITE ssd1306_createSprite(uint8_t x, uint8_t y, uint8_t w, const uint8_t *data)
Definition: ssd1306.c:838
void ssd1306_drawLine(uint8_t x1, uint8_t y1, uint8_t x2, uint8_t y2)
Definition: ssd1306.c:537
void ssd1306_drawSpriteEx(uint8_t x, uint8_t y, uint8_t w, const uint8_t *sprite)
Definition: ssd1306.c:734
void ssd1306_invertMode(void)
Definition: ssd1306.c:848
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:618
void ssd1306_flipVertical(uint8_t mode)
performs vertical flip
Definition: ssd1306.c:872
uint8_t selection
currently selected item. Internally updated.
Definition: ssd1306.h:483
void ssd1306_createMenu(SAppMenu *menu, const char **items, uint8_t count)
Definition: ssd1306_menu.c:41
void ssd1306_clearScreen(void)
Definition: ssd1306.c:71
uint8_t scrollPosition
position of menu scrolling. Internally updated
Definition: ssd1306.h:487
void ssd1306_positiveMode(void)
Definition: ssd1306.c:885
void ssd1306_clearBlock(uint8_t x, uint8_t y, uint8_t w, uint8_t h)
Definition: ssd1306.c:717
uint8_t count
count of menu items in the menu
Definition: ssd1306.h:481
void ssd1306_setFixedFont(const uint8_t *progmemFont)
Definition: ssd1306.c:488
int lcdint_t
Definition: io.h:40
uint8_t ssd1306_charF6x8_eol(uint8_t left, uint8_t y, const char ch[], EFontStyle style, uint8_t right) __attribute__((deprecated))
Definition: ssd1306.c:473
void ssd1306_setFont6x8(const uint8_t *progmemFont) __attribute__((deprecated))
Definition: ssd1306.c:496
void ssd1306_drawSprite(SPRITE *sprite)
Definition: ssd1306.c:747
void ssd1306_eraseTrace(SPRITE *sprite)
Definition: ssd1306.c:799
void ssd1306_drawBuffer(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *buf)
Definition: ssd1306.c:626
void ssd1306_eraseSprite(SPRITE *sprite)
Definition: ssd1306.c:775
void ssd1306_displayOn(void)
Definition: ssd1306.c:93
void ssd1306_setPos(uint8_t x, uint8_t y)
uint8_t ssd1306_charF12x16(uint8_t xpos, uint8_t y, const char ch[], EFontStyle style) __attribute__((deprecated))
Definition: ssd1306.c:398
void ssd1306_putPixel(uint8_t x, uint8_t y)
Definition: ssd1306.c:501
uint8_t ssd1306_menuSelection(SAppMenu *menu)
Definition: ssd1306_menu.c:107
void ssd1306_menuDown(SAppMenu *menu)
Definition: ssd1306_menu.c:112
void ssd1306_flipHorizontal(uint8_t mode)
performs horizontal flip
Definition: ssd1306.c:864
uint8_t ssd1306_printFixed(uint8_t xpos, uint8_t y, const char ch[], EFontStyle style)
Definition: ssd1306.c:106
void ssd1306_normalMode(void)
Definition: ssd1306.c:856
EFontStyle
void ssd1306_menuUp(SAppMenu *menu)
Definition: ssd1306_menu.c:124
void ssd1306_displayOff(void)
Definition: ssd1306.c:87
uint8_t ssd1306_charF6x8(uint8_t x, uint8_t y, const char ch[], EFontStyle style=STYLE_NORMAL) __attribute__((deprecated))
Definition: ssd1306.c:352
uint8_t oldSelection
selected item, when last redraw operation was performed. Internally updated.
Definition: ssd1306.h:485
const char ** items
list of menu items of the menu
Definition: ssd1306.h:479