diff options
| author | Albert Y <76888457+filterpaper@users.noreply.github.com> | 2022-01-27 23:56:20 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-01-27 15:56:20 +0000 |
| commit | 0f0e90971b6da2b1a125acc1620c3d33d0f1864c (patch) | |
| tree | d65cbc478a620cd8aca300462819f78a37a23b7a /docs/feature_oled_driver.md | |
| parent | d55337ba4dae45f327b0dd6a9317cd9739f36520 (diff) | |
| download | qmk_firmware-0f0e90971b6da2b1a125acc1620c3d33d0f1864c.tar.gz qmk_firmware-0f0e90971b6da2b1a125acc1620c3d33d0f1864c.zip | |
[Docs] OLED documentation edits (#15977)
* Clarify OLED_TIMEOUT
* Add a section on logo file location
Diffstat (limited to 'docs/feature_oled_driver.md')
| -rw-r--r-- | docs/feature_oled_driver.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/feature_oled_driver.md b/docs/feature_oled_driver.md index 0c926f674..0d04f007f 100644 --- a/docs/feature_oled_driver.md +++ b/docs/feature_oled_driver.md | |||
| @@ -84,6 +84,8 @@ static void render_logo(void) { | |||
| 84 | } | 84 | } |
| 85 | ``` | 85 | ``` |
| 86 | 86 | ||
| 87 | ?> The default font file is located at `drivers/oled/glcdfont.c` and its location can be overwritten with the `OLED_FONT_H` configuration option. Font file content can be edited with external tools such as [Helix Font Editor](https://helixfonteditor.netlify.app/) and [Logo Editor](https://joric.github.io/qle/). | ||
| 88 | |||
| 87 | ## Buffer Read Example | 89 | ## Buffer Read Example |
| 88 | For some purposes, you may need to read the current state of the OLED display | 90 | For some purposes, you may need to read the current state of the OLED display |
| 89 | buffer. The `oled_read_raw` function can be used to safely read bytes from the | 91 | buffer. The `oled_read_raw` function can be used to safely read bytes from the |
| @@ -162,7 +164,7 @@ These configuration options should be placed in `config.h`. Example: | |||
| 162 | |`OLED_FONT_END` |`223` |The ending character index for custom fonts | | 164 | |`OLED_FONT_END` |`223` |The ending character index for custom fonts | |
| 163 | |`OLED_FONT_WIDTH` |`6` |The font width | | 165 | |`OLED_FONT_WIDTH` |`6` |The font width | |
| 164 | |`OLED_FONT_HEIGHT` |`8` |The font height (untested) | | 166 | |`OLED_FONT_HEIGHT` |`8` |The font height (untested) | |
| 165 | |`OLED_TIMEOUT` |`60000` |Turns off the OLED screen after 60000ms of keyboard inactivity. Helps reduce OLED Burn-in. Set to 0 to disable. | | 167 | |`OLED_TIMEOUT` |`60000` |Turns off the OLED screen after 60000ms of screen update inactivity. Helps reduce OLED Burn-in. Set to 0 to disable. | |
| 166 | |`OLED_FADE_OUT` |*Not defined* |Enables fade out animation. Use together with `OLED_TIMEOUT`. | | 168 | |`OLED_FADE_OUT` |*Not defined* |Enables fade out animation. Use together with `OLED_TIMEOUT`. | |
| 167 | |`OLED_FADE_OUT_INTERVAL` |`0` |The speed of fade out animation, from 0 to 15. Larger values are slower. | | 169 | |`OLED_FADE_OUT_INTERVAL` |`0` |The speed of fade out animation, from 0 to 15. Larger values are slower. | |
| 168 | |`OLED_SCROLL_TIMEOUT` |`0` |Scrolls the OLED screen after 0ms of OLED inactivity. Helps reduce OLED Burn-in. Set to 0 to disable. | | 170 | |`OLED_SCROLL_TIMEOUT` |`0` |Scrolls the OLED screen after 0ms of OLED inactivity. Helps reduce OLED Burn-in. Set to 0 to disable. | |