SSD1306 OLED display driver  1.5.6
This library is developed to control SSD1306/SSD1331/SSD1351/IL9163/PCD8554 RGB i2c/spi LED displays
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 #include "lcd/lcd_il9163.h"
43 
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47 
49 #define RGB_COLOR8(r,g,b) ( (r & 0xE0) | ((g >> 3)&0x1C) | (b>>6) )
50 
52 #define RGB_COLOR16(r,g,b) ( ((r<<8) & 0xF800) | ((g << 3)&0x07E0) | (b>>3) )
53 
55 // DISPLAY CONTROL FUNCTIONS
57 
70 void ssd1306_displayOff(void);
71 
75 void ssd1306_displayOn(void);
76 
81 void ssd1306_setContrast(uint8_t contrast);
82 
88 void ssd1306_invertMode(void);
89 
94 void ssd1306_normalMode(void);
95 
105 void ssd1306_flipHorizontal(uint8_t mode);
106 
116 void ssd1306_flipVertical(uint8_t mode);
117 
122 uint8_t ssd1306_displayHeight(void);
123 
128 uint8_t ssd1306_displayWidth(void);
129 
134 // DIRECT GRAPH FUNCTIONS
137 
156 void ssd1306_setPos(uint8_t x, uint8_t y);
157 
161 void ssd1306_fillScreen(uint8_t fill_Data);
162 
166 void ssd1306_clearScreen(void);
167 
172 void ssd1306_negativeMode(void);
173 
178 void ssd1306_positiveMode(void);
179 
194 uint8_t ssd1306_printFixed(uint8_t xpos, uint8_t y, const char *ch, EFontStyle style);
195 
211 uint8_t ssd1306_printFixed2x(uint8_t xpos, uint8_t y, const char ch[], EFontStyle style) __attribute__ ((deprecated));
212 
232 uint8_t ssd1306_printFixedN(uint8_t xpos, uint8_t y, const char ch[], EFontStyle style, uint8_t factor);
233 
243 uint8_t ssd1306_charF6x8(uint8_t x, uint8_t y,
244  const char ch[],
245  EFontStyle style
246 #ifdef __cplusplus
247  = STYLE_NORMAL
248 #endif
249  ) __attribute__ ((deprecated));
250 
260 uint8_t ssd1306_charF12x16(uint8_t xpos,
261  uint8_t y,
262  const char ch[],
263  EFontStyle style) __attribute__ ((deprecated));
264 
265 
279 uint8_t ssd1306_charF6x8_eol(uint8_t left,
280  uint8_t y,
281  const char ch[],
282  EFontStyle style,
283  uint8_t right) __attribute__ ((deprecated));
284 
303 void ssd1306_setFixedFont(const uint8_t * progmemFont);
304 
316 void ssd1306_setFont6x8(const uint8_t * progmemFont) __attribute__ ((deprecated));
317 
330 void ssd1306_putPixel(uint8_t x, uint8_t y);
331 
346 void ssd1306_putPixels(uint8_t x, uint8_t y, uint8_t pixels);
347 
355 void ssd1306_drawRect(uint8_t x1, uint8_t y1, uint8_t x2, uint8_t y2);
356 
369 void ssd1306_drawLine(uint8_t x1, uint8_t y1, uint8_t x2, uint8_t y2);
370 
377 void ssd1306_drawHLine(uint8_t x1, uint8_t y1, uint8_t x2);
378 
385 void ssd1306_drawVLine(uint8_t x1, uint8_t y1, uint8_t y2);
386 
403 void ssd1306_drawBuffer(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *buf);
404 
423 void ssd1306_drawBufferFast(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buf);
424 
428 #define ssd1306_drawCanvas(x, y, w, h, buf) ssd1306_drawBuffer(x, y, w, h, buf)
429 
439 void ssd1306_drawBitmap(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *buf);
440 
450 void gfx_drawMonoBitmap(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buf);
451 
460 void ssd1306_clearBlock(uint8_t x, uint8_t y, uint8_t w, uint8_t h);
461 
469 void ssd1306_drawSpriteEx(uint8_t x, uint8_t y, uint8_t w, const uint8_t *sprite);
470 
476 void ssd1306_drawSprite(SPRITE *sprite);
477 
482 void ssd1306_eraseSprite(SPRITE *sprite);
483 
488 void ssd1306_eraseTrace(SPRITE *sprite);
489 
498 SPRITE ssd1306_createSprite(uint8_t x, uint8_t y, uint8_t w, const uint8_t *data);
499 
506 void ssd1306_replaceSprite(SPRITE *sprite, const uint8_t *data);
507 
509 // HIGH-LEVEL GRAPH FUNCTIONS
511 
515 typedef struct
516 {
518  const char **items;
520  uint8_t count;
522  uint8_t selection;
524  uint8_t oldSelection;
526  uint8_t scrollPosition;
527 } SAppMenu;
528 
538 void ssd1306_createMenu(SAppMenu *menu, const char **items, uint8_t count);
539 
546 void ssd1306_showMenu(SAppMenu *menu);
547 
554 void ssd1306_updateMenu(SAppMenu *menu);
555 
562 uint8_t ssd1306_menuSelection(SAppMenu *menu);
563 
571 void ssd1306_menuDown(SAppMenu *menu);
572 
580 void ssd1306_menuUp(SAppMenu *menu);
581 
586 #ifdef __cplusplus
587 }
588 #endif
589 
590 #endif // _SSD1306_H_
void ssd1306_drawRect(uint8_t x1, uint8_t y1, uint8_t x2, uint8_t y2)
void ssd1306_menuDown(SAppMenu *menu)
Definition: ssd1306_menu.c:112
void ssd1306_drawSprite(SPRITE *sprite)
void ssd1306_putPixels(uint8_t x, uint8_t y, uint8_t pixels)
unsigned int lcduint_t
Definition: io.h:42
uint8_t ssd1306_charF6x8_eol(uint8_t left, uint8_t y, const char ch[], EFontStyle style, uint8_t right) __attribute__((deprecated))
void gfx_drawMonoBitmap(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buf)
void ssd1306_eraseSprite(SPRITE *sprite)
void ssd1306_eraseTrace(SPRITE *sprite)
void ssd1306_invertMode(void)
void ssd1306_drawBufferFast(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buf)
void ssd1306_flipVertical(uint8_t mode)
performs vertical flip
void ssd1306_drawHLine(uint8_t x1, uint8_t y1, uint8_t x2)
void ssd1306_updateMenu(SAppMenu *menu)
Definition: ssd1306_menu.c:88
uint8_t ssd1306_menuSelection(SAppMenu *menu)
Definition: ssd1306_menu.c:107
void ssd1306_putPixel(uint8_t x, uint8_t y)
void ssd1306_clearScreen(void)
uint8_t ssd1306_printFixed2x(uint8_t xpos, uint8_t y, const char ch[], EFontStyle style) __attribute__((deprecated))
void ssd1306_negativeMode(void)
void ssd1306_createMenu(SAppMenu *menu, const char **items, uint8_t count)
Definition: ssd1306_menu.c:41
void ssd1306_drawLine(uint8_t x1, uint8_t y1, uint8_t x2, uint8_t y2)
void ssd1306_drawSpriteEx(uint8_t x, uint8_t y, uint8_t w, const uint8_t *sprite)
uint8_t ssd1306_printFixedN(uint8_t xpos, uint8_t y, const char ch[], EFontStyle style, uint8_t factor)
void ssd1306_showMenu(SAppMenu *menu)
Definition: ssd1306_menu.c:77
void ssd1306_displayOn(void)
void ssd1306_drawBitmap(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *buf)
uint8_t ssd1306_displayWidth(void)
void ssd1306_drawVLine(uint8_t x1, uint8_t y1, uint8_t y2)
void ssd1306_flipHorizontal(uint8_t mode)
performs horizontal flip
void ssd1306_positiveMode(void)
uint8_t selection
currently selected item. Internally updated.
Definition: ssd1306.h:522
uint8_t scrollPosition
position of menu scrolling. Internally updated
Definition: ssd1306.h:526
void ssd1306_fillScreen(uint8_t fill_Data)
void ssd1306_menuUp(SAppMenu *menu)
Definition: ssd1306_menu.c:124
uint8_t count
count of menu items in the menu
Definition: ssd1306.h:520
void ssd1306_setFixedFont(const uint8_t *progmemFont)
int lcdint_t
Definition: io.h:40
void ssd1306_replaceSprite(SPRITE *sprite, const uint8_t *data)
uint8_t ssd1306_charF12x16(uint8_t xpos, uint8_t y, const char ch[], EFontStyle style) __attribute__((deprecated))
uint8_t ssd1306_displayHeight(void)
void ssd1306_drawBuffer(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *buf)
SPRITE ssd1306_createSprite(uint8_t x, uint8_t y, uint8_t w, const uint8_t *data)
uint8_t ssd1306_charF6x8(uint8_t x, uint8_t y, const char ch[], EFontStyle style=STYLE_NORMAL) __attribute__((deprecated))
EFontStyle
void ssd1306_setFont6x8(const uint8_t *progmemFont) __attribute__((deprecated))
void ssd1306_normalMode(void)
uint8_t oldSelection
selected item, when last redraw operation was performed. Internally updated.
Definition: ssd1306.h:524
void ssd1306_displayOff(void)
void ssd1306_setContrast(uint8_t contrast)
uint8_t ssd1306_printFixed(uint8_t xpos, uint8_t y, const char *ch, EFontStyle style)
const char ** items
list of menu items of the menu
Definition: ssd1306.h:518
void ssd1306_clearBlock(uint8_t x, uint8_t y, uint8_t w, uint8_t h)
void ssd1306_setPos(uint8_t x, uint8_t y)