aboutsummaryrefslogtreecommitdiff
path: root/docs/feature_oled_driver.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/feature_oled_driver.md')
-rw-r--r--docs/feature_oled_driver.md22
1 files changed, 16 insertions, 6 deletions
diff --git a/docs/feature_oled_driver.md b/docs/feature_oled_driver.md
index 7011f1457..fcc19515a 100644
--- a/docs/feature_oled_driver.md
+++ b/docs/feature_oled_driver.md
@@ -11,10 +11,6 @@
11To enable the OLED feature, there are three steps. First, when compiling your keyboard, you'll need to set `OLED_DRIVER_ENABLE=yes` in `rules.mk`, e.g.: 11To enable the OLED feature, there are three steps. First, when compiling your keyboard, you'll need to set `OLED_DRIVER_ENABLE=yes` in `rules.mk`, e.g.:
12 12
13``` 13```
14BOOTMAGIC_ENABLE = no
15MOUSEKEY_ENABLE = no
16STENO_ENABLE = no
17EXTRAKEY_ENABLE = yes
18OLED_DRIVER_ENABLE = yes 14OLED_DRIVER_ENABLE = yes
19``` 15```
20 16
@@ -36,8 +32,8 @@ void oled_task_user(void) {
36 oled_write_P(PSTR("ADJ\n"), false); 32 oled_write_P(PSTR("ADJ\n"), false);
37 break; 33 break;
38 default: 34 default:
39 // Or use the write_ln shortcut 35 // Or use the write_ln shortcut over adding '\n' to the end of your string
40 oled_write_P(PSTR("Undefined\n"), false); 36 oled_write_ln_P(PSTR("Undefined"), false);
41 } 37 }
42 38
43 // Host Keyboard LED Status 39 // Host Keyboard LED Status
@@ -49,6 +45,20 @@ void oled_task_user(void) {
49#endif 45#endif
50``` 46```
51 47
48## Logo Example
49
50In the default font, ranges in the font file are reserved for a QMK Logo. To Render this logo to the oled screen, use the following code example:
51
52```C++
53static void render_logo(void) {
54 static const char PROGMEM qmk_logo[] = {
55 0x80,0x81,0x82,0x83,0x84,0x85,0x86,0x87,0x88,0x89,0x8a,0x8b,0x8c,0x8d,0x8e,0x8f,0x90,0x91,0x92,0x93,0x94,
56 0xa0,0xa1,0xa2,0xa3,0xa4,0xa5,0xa6,0xa7,0xa8,0xa9,0xaa,0xab,0xac,0xad,0xae,0xaf,0xb0,0xb1,0xb2,0xb3,0xb4,
57 0xc0,0xc1,0xc2,0xc3,0xc4,0xc5,0xc6,0xc7,0xc8,0xc9,0xca,0xcb,0xcc,0xcd,0xce,0xcf,0xd0,0xd1,0xd2,0xd3,0xd4,0};
58
59 oled_write_P(qmk_logo, false);
60}
61```
52 62
53## Other Examples 63## Other Examples
54 64