diff options
| author | XScorpion2 <rcalt2vt@gmail.com> | 2019-08-25 14:37:55 -0500 |
|---|---|---|
| committer | Drashna Jaelre <drashna@live.com> | 2019-08-25 12:37:55 -0700 |
| commit | 957070a6b5886719557b6880afa7e3716548c18a (patch) | |
| tree | 68adde454ad00f5c74538b0927f76b7db7afcb09 /docs | |
| parent | f22c5c17b6fe069bec1241262a1c27eb89d3d3af (diff) | |
| download | qmk_firmware-957070a6b5886719557b6880afa7e3716548c18a.tar.gz qmk_firmware-957070a6b5886719557b6880afa7e3716548c18a.zip | |
Added OLED Display autoscroll during periods of OLED data inactivity (#6546)
* Added OLED Display autoscroll during periods of OLED data inactivity.
* Fixing compile errors
* Feedback from review
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/feature_oled_driver.md | 24 |
1 files changed, 13 insertions, 11 deletions
diff --git a/docs/feature_oled_driver.md b/docs/feature_oled_driver.md index 9d19beedb..623f1816a 100644 --- a/docs/feature_oled_driver.md +++ b/docs/feature_oled_driver.md | |||
| @@ -96,17 +96,19 @@ void oled_task_user(void) { | |||
| 96 | 96 | ||
| 97 | ## Basic Configuration | 97 | ## Basic Configuration |
| 98 | 98 | ||
| 99 | | Define | Default | Description | | 99 | | Define | Default | Description | |
| 100 | |------------------------|-------------------|----------------------------------------------------------------------------------------------------------------------------| | 100 | |----------------------------|-------------------|----------------------------------------------------------------------------------------------------------------------------| |
| 101 | | `OLED_DISPLAY_ADDRESS` | `0x3C` | The i2c address of the OLED Display | | 101 | | `OLED_DISPLAY_ADDRESS` | `0x3C` | The i2c address of the OLED Display | |
| 102 | | `OLED_FONT_H` | `"glcdfont.c"` | The font code file to use for custom fonts | | 102 | | `OLED_FONT_H` | `"glcdfont.c"` | The font code file to use for custom fonts | |
| 103 | | `OLED_FONT_START` | `0` | The starting characer index for custom fonts | | 103 | | `OLED_FONT_START` | `0` | The starting characer index for custom fonts | |
| 104 | | `OLED_FONT_END` | `224` | The ending characer index for custom fonts | | 104 | | `OLED_FONT_END` | `224` | The ending characer index for custom fonts | |
| 105 | | `OLED_FONT_WIDTH` | `6` | The font width | | 105 | | `OLED_FONT_WIDTH` | `6` | The font width | |
| 106 | | `OLED_FONT_HEIGHT` | `8` | The font height (untested) | | 106 | | `OLED_FONT_HEIGHT` | `8` | The font height (untested) | |
| 107 | | `OLED_DISABLE_TIMEOUT` | *Not defined* | Disables the built in OLED timeout feature. Useful when implementing custom timeout rules. | | 107 | | `OLED_TIMEOUT` | `60000` | Turns off the OLED screen after 60000ms of keyboard inactivity. Helps reduce OLED Burn-in. Set to 0 to disable. | |
| 108 | | `OLED_IC` | `OLED_IC_SSD1306` | Set to `OLED_IC_SH1106` if you're using the SH1106 OLED controller. | | 108 | | `OLED_SCROLL_TIMEOUT` | `0` | Scrolls the OLED screen after 0ms of OLED inactivity. Helps reduce OLED Burn-in. Set to 0 to disable. | |
| 109 | | `OLED_COLUMN_OFFSET` | `0` | (SH1106 only.) Shift output to the right this many pixels.<br />Useful for 128x64 displays centered on a 132x64 SH1106 IC. | | 109 | | `OLED_SCROLL_TIMEOUT_RIGHT`| *Not defined* | Scroll timeout direction is right when defined, left when undefined. | |
| 110 | | `OLED_IC` | `OLED_IC_SSD1306` | Set to `OLED_IC_SH1106` if you're using the SH1106 OLED controller. | | ||
| 111 | | `OLED_COLUMN_OFFSET` | `0` | (SH1106 only.) Shift output to the right this many pixels.<br />Useful for 128x64 displays centered on a 132x64 SH1106 IC. | | ||
| 110 | 112 | ||
| 111 | ## 128x64 & Custom sized OLED Displays | 113 | ## 128x64 & Custom sized OLED Displays |
| 112 | 114 | ||