SSD1306 OLED display driver  1.4.4
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 
146 uint8_t ssd1306_printFixed(uint8_t xpos, uint8_t y, const char ch[], EFontStyle style);
147 
159 uint8_t ssd1306_printFixed2x(uint8_t xpos, uint8_t y, const char ch[], EFontStyle style);
160 
169 uint8_t ssd1306_charF6x8(uint8_t x, uint8_t y,
170  const char ch[],
171  EFontStyle style
172 #ifdef __cplusplus
173  = STYLE_NORMAL
174 #endif
175  ) __attribute__ ((deprecated));
176 
185 uint8_t ssd1306_charF12x16(uint8_t xpos,
186  uint8_t y,
187  const char ch[],
188  EFontStyle style) __attribute__ ((deprecated));
189 
190 
203 uint8_t ssd1306_charF6x8_eol(uint8_t left,
204  uint8_t y,
205  const char ch[],
206  EFontStyle style,
207  uint8_t right) __attribute__ ((deprecated));
208 
209 
228 void ssd1306_setFixedFont(const uint8_t * progmemFont);
229 
240 void ssd1306_setFont6x8(const uint8_t * progmemFont) __attribute__ ((deprecated));
241 
254 void ssd1306_putPixel(uint8_t x, uint8_t y);
255 
270 void ssd1306_putPixels(uint8_t x, uint8_t y, uint8_t pixels);
271 
279 void ssd1306_drawRect(uint8_t x1, uint8_t y1, uint8_t x2, uint8_t y2);
280 
287 void ssd1306_drawHLine(uint8_t x1, uint8_t y1, uint8_t x2);
288 
295 void ssd1306_drawVLine(uint8_t x1, uint8_t y1, uint8_t y2);
296 
313 void ssd1306_drawBuffer(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *buf);
314 
318 #define ssd1306_drawCanvas(x, y, w, h, buf) ssd1306_drawBuffer(x, y, w, h, buf)
319 
329 void ssd1306_drawBitmap(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *buf);
330 
331 
340 void ssd1306_clearBlock(uint8_t x, uint8_t y, uint8_t w, uint8_t h);
341 
342 
350 void ssd1306_drawSpriteEx(uint8_t x, uint8_t y, uint8_t w, const uint8_t *sprite);
351 
357 void ssd1306_drawSprite(SPRITE *sprite);
358 
363 void ssd1306_eraseSprite(SPRITE *sprite);
364 
369 void ssd1306_eraseTrace(SPRITE *sprite);
370 
379 SPRITE ssd1306_createSprite(uint8_t x, uint8_t y, uint8_t w, const uint8_t *data);
380 
387 void ssd1306_replaceSprite(SPRITE *sprite, const uint8_t *data);
388 
393 // HIGH-LEVEL GRAPH FUNCTIONS
396 
405 typedef struct
406 {
408  const char **items;
410  uint8_t count;
412  uint8_t selection;
414  uint8_t oldSelection;
416  uint8_t scrollPosition;
417 } SAppMenu;
418 
428 void ssd1306_createMenu(SAppMenu *menu, const char **items, uint8_t count);
429 
436 void ssd1306_showMenu(SAppMenu *menu);
437 
444 void ssd1306_updateMenu(SAppMenu *menu);
445 
446 
453 uint8_t ssd1306_menuSelection(SAppMenu *menu);
454 
455 
463 void ssd1306_menuDown(SAppMenu *menu);
464 
465 
473 void ssd1306_menuUp(SAppMenu *menu);
474 
479 #ifdef __cplusplus
480 }
481 #endif
482 
483 #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:482
void ssd1306_negativeMode()
Definition: ssd1306.c:649
void ssd1306_setContrast(uint8_t contrast)
Definition: ssd1306.c:96
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:628
void ssd1306_drawHLine(uint8_t x1, uint8_t y1, uint8_t x2)
Definition: ssd1306.c:422
void ssd1306_displayOn()
Definition: ssd1306.c:91
void ssd1306_drawVLine(uint8_t x1, uint8_t y1, uint8_t y2)
Definition: ssd1306.c:433
void ssd1306_positiveMode()
Definition: ssd1306.c:654
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:414
SPRITE ssd1306_createSprite(uint8_t x, uint8_t y, uint8_t w, const uint8_t *data)
Definition: ssd1306.c:623
void ssd1306_drawSpriteEx(uint8_t x, uint8_t y, uint8_t w, const uint8_t *sprite)
Definition: ssd1306.c:519
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:458
uint8_t selection
currently selected item. Internally updated.
Definition: ssd1306.h:412
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:416
void ssd1306_clearBlock(uint8_t x, uint8_t y, uint8_t w, uint8_t h)
Definition: ssd1306.c:502
uint8_t count
count of menu items in the menu
Definition: ssd1306.h:410
void ssd1306_setFixedFont(const uint8_t *progmemFont)
Definition: ssd1306.c:393
uint8_t ssd1306_printFixed2x(uint8_t xpos, uint8_t y, const char ch[], EFontStyle style)
Definition: ssd1306.c:177
uint8_t ssd1306_charF6x8_eol(uint8_t left, uint8_t y, const char ch[], EFontStyle style, uint8_t right) __attribute__((deprecated))
Definition: ssd1306.c:378
void ssd1306_invertMode()
Definition: ssd1306.c:633
void ssd1306_setFont6x8(const uint8_t *progmemFont) __attribute__((deprecated))
Definition: ssd1306.c:401
uint8_t ssd1306_displayWidth()
Definition: ssd1306.c:48
void ssd1306_drawSprite(SPRITE *sprite)
Definition: ssd1306.c:532
void ssd1306_eraseTrace(SPRITE *sprite)
Definition: ssd1306.c:584
void ssd1306_drawBuffer(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *buf)
Definition: ssd1306.c:466
void ssd1306_eraseSprite(SPRITE *sprite)
Definition: ssd1306.c:560
void ssd1306_setPos(uint8_t x, uint8_t y)
void ssd1306_normalMode()
Definition: ssd1306.c:641
uint8_t ssd1306_charF12x16(uint8_t xpos, uint8_t y, const char ch[], EFontStyle style) __attribute__((deprecated))
Definition: ssd1306.c:303
void ssd1306_putPixel(uint8_t x, uint8_t y)
Definition: ssd1306.c:406
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:104
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:257
uint8_t oldSelection
selected item, when last redraw operation was performed. Internally updated.
Definition: ssd1306.h:414
const char ** items
list of menu items of the menu
Definition: ssd1306.h:408