diff options
| author | Ryan Caltabiano <rcalt2vt@gmail.com> | 2019-04-19 23:44:09 +0200 |
|---|---|---|
| committer | skullydazed <skullydazed@users.noreply.github.com> | 2019-04-20 17:05:10 +0200 |
| commit | 33e27b2a830dc5d24a6f93c95f8fced8bb9ae80f (patch) | |
| tree | aaa8e1eda3e143d454ea547dba8450cacf2ce0a7 | |
| parent | dd3a813f871b911012da55a499955307c309a7a5 (diff) | |
| download | qmk_firmware-33e27b2a830dc5d24a6f93c95f8fced8bb9ae80f.tar.gz qmk_firmware-33e27b2a830dc5d24a6f93c95f8fced8bb9ae80f.tar.xz | |
Fixing readme from feedback
| -rw-r--r-- | docs/feature_oled_driver.md | 22 |
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 @@ To 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.: ``` -BOOTMAGIC_ENABLE = no -MOUSEKEY_ENABLE = no -STENO_ENABLE = no -EXTRAKEY_ENABLE = yes OLED_DRIVER_ENABLE = yes ``` @@ -36,8 +32,8 @@ void oled_task_user(void) { oled_write_P(PSTR("ADJ\n"), false); break; default: - // Or use the write_ln shortcut - oled_write_P(PSTR("Undefined\n"), false); + // Or use the write_ln shortcut over adding '\n' to the end of your string + oled_write_ln_P(PSTR("Undefined"), false); } // Host Keyboard LED Status @@ -49,6 +45,20 @@ void oled_task_user(void) { #endif ``` +## Logo Example + +In 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: + +```C++ +static void render_logo(void) { + static const char PROGMEM qmk_logo[] = { + 0x80,0x81,0x82,0x83,0x84,0x85,0x86,0x87,0x88,0x89,0x8a,0x8b,0x8c,0x8d,0x8e,0x8f,0x90,0x91,0x92,0x93,0x94, + 0xa0,0xa1,0xa2,0xa3,0xa4,0xa5,0xa6,0xa7,0xa8,0xa9,0xaa,0xab,0xac,0xad,0xae,0xaf,0xb0,0xb1,0xb2,0xb3,0xb4, + 0xc0,0xc1,0xc2,0xc3,0xc4,0xc5,0xc6,0xc7,0xc8,0xc9,0xca,0xcb,0xcc,0xcd,0xce,0xcf,0xd0,0xd1,0xd2,0xd3,0xd4,0}; + + oled_write_P(qmk_logo, false); +} +``` ## Other Examples |