SSD1306 OLED display driver  1.4.12
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 "ssd1331_api.h"
33 #include "nano_gfx_types.h"
34 #include "ssd1306_fonts.h"
35 #include "i2c/ssd1306_i2c_conf.h"
36 #include "spi/ssd1306_spi_conf.h"
37 #include "lcd/oled_ssd1306.h"
38 #include "lcd/oled_ssd1331.h"
39 #include "lcd/oled_ssd1351.h"
40 #include "lcd/oled_sh1106.h"
41 #include "lcd/lcd_pcd8544.h"
42 
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
46 
48 #define RGB_COLOR8(r,g,b) ( (r & 0xE0) | ((g >> 3)&0x1C) | (b>>6) )
49 
51 #define RGB_COLOR16(r,g,b) ( ((r<<8) & 0xF800) | ((g << 3)&0x07E0) | (b>>3) )
52 
54 // DISPLAY CONTROL FUNCTIONS
56 
65 void ssd1306_displayOff(void);
66 
70 void ssd1306_displayOn(void);
71 
76 void ssd1306_setContrast(uint8_t contrast);
77 
83 void ssd1306_invertMode(void);
84 
89 void ssd1306_normalMode(void);
90 
100 void ssd1306_flipHorizontal(uint8_t mode);
101 
111 void ssd1306_flipVertical(uint8_t mode);
112 
116 uint8_t ssd1306_displayHeight(void);
117 
121 uint8_t ssd1306_displayWidth(void);
122 
127 // DIRECT GRAPH FUNCTIONS
130 
141 void ssd1306_setPos(uint8_t x, uint8_t y);
142 
146 void ssd1306_fillScreen(uint8_t fill_Data);
147 
151 void ssd1306_clearScreen(void);
152 
157 void ssd1306_negativeMode(void);
158 
163 void ssd1306_positiveMode(void);
164 
179 uint8_t ssd1306_printFixed(uint8_t xpos, uint8_t y, const char *ch, EFontStyle style);
180 
195 uint8_t ssd1306_printFixed2x(uint8_t xpos, uint8_t y, const char ch[], EFontStyle style) __attribute__ ((deprecated));
196 
216 uint8_t ssd1306_printFixedN(uint8_t xpos, uint8_t y, const char ch[], EFontStyle style, uint8_t factor);
217 
226 uint8_t ssd1306_charF6x8(uint8_t x, uint8_t y,
227  const char ch[],
228  EFontStyle style
229 #ifdef __cplusplus
230  = STYLE_NORMAL
231 #endif
232  ) __attribute__ ((deprecated));
233 
242 uint8_t ssd1306_charF12x16(uint8_t xpos,
243  uint8_t y,
244  const char ch[],
245  EFontStyle style) __attribute__ ((deprecated));
246 
247 
260 uint8_t ssd1306_charF6x8_eol(uint8_t left,
261  uint8_t y,
262  const char ch[],
263  EFontStyle style,
264  uint8_t right) __attribute__ ((deprecated));
265 
284 void ssd1306_setFixedFont(const uint8_t * progmemFont);
285 
296 void ssd1306_setFont6x8(const uint8_t * progmemFont) __attribute__ ((deprecated));
297 
310 void ssd1306_putPixel(uint8_t x, uint8_t y);
311 
326 void ssd1306_putPixels(uint8_t x, uint8_t y, uint8_t pixels);
327 
335 void ssd1306_drawRect(uint8_t x1, uint8_t y1, uint8_t x2, uint8_t y2);
336 
349 void ssd1306_drawLine(uint8_t x1, uint8_t y1, uint8_t x2, uint8_t y2);
350 
357 void ssd1306_drawHLine(uint8_t x1, uint8_t y1, uint8_t x2);
358 
365 void ssd1306_drawVLine(uint8_t x1, uint8_t y1, uint8_t y2);
366 
383 void ssd1306_drawBuffer(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *buf);
384 
388 #define ssd1306_drawCanvas(x, y, w, h, buf) ssd1306_drawBuffer(x, y, w, h, buf)
389 
399 void ssd1306_drawBitmap(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *buf);
400 
410 void gfx_drawMonoBitmap(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buf);
411 
420 void ssd1306_clearBlock(uint8_t x, uint8_t y, uint8_t w, uint8_t h);
421 
429 void ssd1306_drawSpriteEx(uint8_t x, uint8_t y, uint8_t w, const uint8_t *sprite);
430 
436 void ssd1306_drawSprite(SPRITE *sprite);
437 
442 void ssd1306_eraseSprite(SPRITE *sprite);
443 
448 void ssd1306_eraseTrace(SPRITE *sprite);
449 
458 SPRITE ssd1306_createSprite(uint8_t x, uint8_t y, uint8_t w, const uint8_t *data);
459 
466 void ssd1306_replaceSprite(SPRITE *sprite, const uint8_t *data);
467 
472 // HIGH-LEVEL GRAPH FUNCTIONS
475 
484 typedef struct
485 {
487  const char **items;
489  uint8_t count;
491  uint8_t selection;
493  uint8_t oldSelection;
495  uint8_t scrollPosition;
496 } SAppMenu;
497 
507 void ssd1306_createMenu(SAppMenu *menu, const char **items, uint8_t count);
508 
515 void ssd1306_showMenu(SAppMenu *menu);
516 
523 void ssd1306_updateMenu(SAppMenu *menu);
524 
531 uint8_t ssd1306_menuSelection(SAppMenu *menu);
532 
540 void ssd1306_menuDown(SAppMenu *menu);
541 
549 void ssd1306_menuUp(SAppMenu *menu);
550 
555 #ifdef __cplusplus
556 }
557 #endif
558 
559 #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:177
void ssd1306_drawBitmap(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *buf)
Definition: ssd1306.c:627
uint8_t ssd1306_displayWidth(void)
Definition: ssd1306.c:51
unsigned int lcduint_t
Definition: io.h:42
void ssd1306_setContrast(uint8_t contrast)
Definition: ssd1306.c:97
uint8_t ssd1306_printFixedN(uint8_t xpos, uint8_t y, const char ch[], EFontStyle style, uint8_t factor)
Definition: ssd1306.c:255
void ssd1306_negativeMode(void)
Definition: ssd1306.c:855
void ssd1306_replaceSprite(SPRITE *sprite, const uint8_t *data)
Definition: ssd1306.c:818
void ssd1306_drawHLine(uint8_t x1, uint8_t y1, uint8_t x2)
Definition: ssd1306.c:570
void gfx_drawMonoBitmap(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buf)
Definition: ssd1306.c:645
uint8_t ssd1306_displayHeight(void)
Definition: ssd1306.c:46
void ssd1306_drawVLine(uint8_t x1, uint8_t y1, uint8_t y2)
Definition: ssd1306.c:580
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:498
SPRITE ssd1306_createSprite(uint8_t x, uint8_t y, uint8_t w, const uint8_t *data)
Definition: ssd1306.c:813
void ssd1306_drawLine(uint8_t x1, uint8_t y1, uint8_t x2, uint8_t y2)
Definition: ssd1306.c:525
void ssd1306_drawSpriteEx(uint8_t x, uint8_t y, uint8_t w, const uint8_t *sprite)
Definition: ssd1306.c:716
uint8_t ssd1306_printFixed(uint8_t xpos, uint8_t y, const char *ch, EFontStyle style)
Definition: ssd1306.c:105
void ssd1306_invertMode(void)
Definition: ssd1306.c:823
void ssd1306_fillScreen(uint8_t fill_Data)
Definition: ssd1306.c:56
void ssd1306_drawRect(uint8_t x1, uint8_t y1, uint8_t x2, uint8_t y2)
Definition: ssd1306.c:604
void ssd1306_flipVertical(uint8_t mode)
performs vertical flip
Definition: ssd1306.c:847
uint8_t selection
currently selected item. Internally updated.
Definition: ssd1306.h:491
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:495
void ssd1306_positiveMode(void)
Definition: ssd1306.c:860
void ssd1306_clearBlock(uint8_t x, uint8_t y, uint8_t w, uint8_t h)
Definition: ssd1306.c:700
uint8_t count
count of menu items in the menu
Definition: ssd1306.h:489
void ssd1306_setFixedFont(const uint8_t *progmemFont)
Definition: ssd1306.c:478
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:463
void ssd1306_setFont6x8(const uint8_t *progmemFont) __attribute__((deprecated))
Definition: ssd1306.c:486
void ssd1306_drawSprite(SPRITE *sprite)
Definition: ssd1306.c:728
void ssd1306_eraseTrace(SPRITE *sprite)
Definition: ssd1306.c:776
void ssd1306_drawBuffer(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *buf)
Definition: ssd1306.c:612
void ssd1306_eraseSprite(SPRITE *sprite)
Definition: ssd1306.c:754
void ssd1306_displayOn(void)
Definition: ssd1306.c:92
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:390
void ssd1306_putPixel(uint8_t x, uint8_t y)
Definition: ssd1306.c:491
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:839
void ssd1306_normalMode(void)
Definition: ssd1306.c:831
EFontStyle
void ssd1306_menuUp(SAppMenu *menu)
Definition: ssd1306_menu.c:124
void ssd1306_displayOff(void)
Definition: ssd1306.c:86
uint8_t ssd1306_charF6x8(uint8_t x, uint8_t y, const char ch[], EFontStyle style=STYLE_NORMAL) __attribute__((deprecated))
Definition: ssd1306.c:345
uint8_t oldSelection
selected item, when last redraw operation was performed. Internally updated.
Definition: ssd1306.h:493
const char ** items
list of menu items of the menu
Definition: ssd1306.h:487