qmk/qmk_firmware

[Bug] Oled scrolling won't resume after oled_timeout.

Open

#20,458 opened on Apr 15, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C (43,867 forks)batch import
bughelp wanted

Repository metrics

Stars
 (20,368 stars)
PR merge metrics
 (Avg merge 20d 9h) (27 merged PRs in 30d)

Description

Describe the Bug

A scrolling oled screen enabled with oled_scroll_left()/oled_scroll_right() won't resume scrolling after OLED_TIMEOUT.

Keyboard Used

draculad

Link to product page (if applicable)

No response

Operating System

No response

qmk doctor Output

No response

Is AutoHotKey / Karabiner installed

  • AutoHotKey (Windows)
  • Karabiner (macOS)

Other keyboard-related software installed

No response

Additional Context

I took a look into drivers/oled/ssd1306_sh1106.c and the problem seems to be oled_off() does stop the oleds but keeps the oled_scrolling variable to true and due to that, posterior calls to oled_scroll_right() and oled_scroll_left() do nothing.

I fixed it in a naive way ignoring the oled_scrolling check: https://pastebin.com/raw/Z91cjUTma

Contributor guide

Research direction
Inspect oled off() and oled scroll left/right() in drivers/oled/ssd1306 sh1106.c. The oled off() function sets oled scrolling to true but does not stop scrolling, so subsequent scroll calls see oled scrolling true and skip. Examine the provided fix at https://pastebin.com/raw/Z91cjUTma for a solution: reset oled scrolling to false in oled off() or remove the check in the scroll functions.
Tech stack
c
Domain
None
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
CGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85