SSD1306 OLED display driver  1.6.99
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 "lcd/lcd_common.h"
36 #include "lcd/oled_ssd1306.h"
37 #include "lcd/oled_ssd1331.h"
38 #include "lcd/oled_ssd1351.h"
39 #include "lcd/oled_sh1106.h"
40 #include "lcd/lcd_pcd8544.h"
41 #include "lcd/lcd_il9163.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 
69 void ssd1306_displayOff(void);
70 
74 void ssd1306_displayOn(void);
75 
80 void ssd1306_setContrast(uint8_t contrast);
81 
87 void ssd1306_invertMode(void);
88 
93 void ssd1306_normalMode(void);
94 
104 void ssd1306_flipHorizontal(uint8_t mode);
105 
115 void ssd1306_flipVertical(uint8_t mode);
116 
121 uint8_t ssd1306_displayHeight(void);
122 
127 uint8_t ssd1306_displayWidth(void);
128 
133 // DIRECT GRAPH FUNCTIONS
136 
155 void ssd1306_setPos(uint8_t x, uint8_t y);
156 
160 void ssd1306_fillScreen(uint8_t fill_Data);
161 
165 void ssd1306_clearScreen(void);
166 
171 void ssd1306_negativeMode(void);
172 
177 void ssd1306_positiveMode(void);
178 
193 uint8_t ssd1306_printFixed(uint8_t xpos, uint8_t y, const char *ch, EFontStyle style);
194 
210 uint8_t ssd1306_printFixed2x(uint8_t xpos, uint8_t y, const char ch[], EFontStyle style) __attribute__ ((deprecated));
211 
231 uint8_t ssd1306_printFixedN(uint8_t xpos, uint8_t y, const char ch[], EFontStyle style, uint8_t factor);
232 
240 void ssd1306_setCursor(lcdint_t x, lcdint_t y);
241 
249 size_t ssd1306_write(uint8_t ch);
250 
258 size_t ssd1306_print(const char ch[]);
259 
269 uint8_t ssd1306_charF6x8(uint8_t x, uint8_t y,
270  const char ch[],
271  EFontStyle style
272 #ifdef __cplusplus
273  = STYLE_NORMAL
274 #endif
275  ) __attribute__ ((deprecated));
276 
286 uint8_t ssd1306_charF12x16(uint8_t xpos,
287  uint8_t y,
288  const char ch[],
289  EFontStyle style) __attribute__ ((deprecated));
290 
291 
305 uint8_t ssd1306_charF6x8_eol(uint8_t left,
306  uint8_t y,
307  const char ch[],
308  EFontStyle style,
309  uint8_t right) __attribute__ ((deprecated));
310 
329 void ssd1306_setFixedFont(const uint8_t * progmemFont);
330 
342 void ssd1306_setFont6x8(const uint8_t * progmemFont) __attribute__ ((deprecated));
343 
356 void ssd1306_putPixel(uint8_t x, uint8_t y);
357 
372 void ssd1306_putPixels(uint8_t x, uint8_t y, uint8_t pixels);
373 
381 void ssd1306_drawRect(uint8_t x1, uint8_t y1, uint8_t x2, uint8_t y2);
382 
395 void ssd1306_drawLine(uint8_t x1, uint8_t y1, uint8_t x2, uint8_t y2);
396 
403 void ssd1306_drawHLine(uint8_t x1, uint8_t y1, uint8_t x2);
404 
411 void ssd1306_drawVLine(uint8_t x1, uint8_t y1, uint8_t y2);
412 
429 void ssd1306_drawBuffer(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *buf);
430 
449 void ssd1306_drawBufferFast(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buf);
450 
454 #define ssd1306_drawCanvas(x, y, w, h, buf) ssd1306_drawBuffer(x, y, w, h, buf)
455 
465 void ssd1306_drawBitmap(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *buf);
466 
476 void gfx_drawMonoBitmap(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buf);
477 
486 void ssd1306_clearBlock(uint8_t x, uint8_t y, uint8_t w, uint8_t h);
487 
495 void ssd1306_drawSpriteEx(uint8_t x, uint8_t y, uint8_t w, const uint8_t *sprite);
496 
502 void ssd1306_drawSprite(SPRITE *sprite);
503 
508 void ssd1306_eraseSprite(SPRITE *sprite);
509 
514 void ssd1306_eraseTrace(SPRITE *sprite);
515 
524 SPRITE ssd1306_createSprite(uint8_t x, uint8_t y, uint8_t w, const uint8_t *data);
525 
532 void ssd1306_replaceSprite(SPRITE *sprite, const uint8_t *data);
533 
535 // HIGH-LEVEL GRAPH FUNCTIONS
537 
541 typedef struct
542 {
544  const char **items;
546  uint8_t count;
548  uint8_t selection;
550  uint8_t oldSelection;
552  uint8_t scrollPosition;
553 } SAppMenu;
554 
564 void ssd1306_createMenu(SAppMenu *menu, const char **items, uint8_t count);
565 
574 void ssd1306_showMenu(SAppMenu *menu);
575 
584 void ssd1331_showMenu8(SAppMenu *menu);
585 
592 void ssd1306_updateMenu(SAppMenu *menu);
593 
602 void ssd1331_updateMenu8(SAppMenu *menu);
603 
612 uint8_t ssd1306_menuSelection(SAppMenu *menu);
613 
621 void ssd1306_menuDown(SAppMenu *menu);
622 
630 void ssd1306_menuUp(SAppMenu *menu);
631 
636 #ifdef __cplusplus
637 }
638 #endif
639 
640 #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:157
void ssd1306_drawSprite(SPRITE *sprite)
void ssd1306_putPixels(uint8_t x, uint8_t y, uint8_t pixels)
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:114
uint8_t ssd1306_menuSelection(SAppMenu *menu)
Definition: ssd1306_menu.c:152
size_t ssd1306_write(uint8_t ch)
Prints single character to display at current cursor position.
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:42
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:92
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 ssd1331_showMenu8(SAppMenu *menu)
Definition: ssd1306_menu.c:103
void ssd1306_flipHorizontal(uint8_t mode)
performs horizontal flip
void ssd1306_positiveMode(void)
uint8_t selection
currently selected item. Internally updated.
Definition: ssd1306.h:548
uint8_t scrollPosition
position of menu scrolling. Internally updated
Definition: ssd1306.h:552
void ssd1306_fillScreen(uint8_t fill_Data)
void ssd1306_setCursor(lcdint_t x, lcdint_t y)
Sets cursor position for text mode print functions.
void ssd1306_menuUp(SAppMenu *menu)
Definition: ssd1306_menu.c:169
uint8_t count
count of menu items in the menu
Definition: ssd1306.h:546
void ssd1306_setFixedFont(const uint8_t *progmemFont)
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))
size_t ssd1306_print(const char ch[])
Prints null-terminated string to display at current cursor position.
void ssd1331_updateMenu8(SAppMenu *menu)
Definition: ssd1306_menu.c:133
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:550
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:544
void ssd1306_clearBlock(uint8_t x, uint8_t y, uint8_t w, uint8_t h)
void ssd1306_setPos(uint8_t x, uint8_t y)