Skip to content

Commit

Permalink
fix(docs): rename task-handler.md to timer-handler.md (lvgl#3203)
Browse files Browse the repository at this point in the history
since all task facility is already switched to timer facility

Signed-off-by: Xiang Xiao <[email protected]>
  • Loading branch information
xiaoxiang781216 authored Mar 24, 2022
1 parent 378aaa6 commit a6368fe
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/intro/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ See the [Porting](/porting/display) section to learn more.
### My display driver is not called. What have I missed?
Be sure you are calling `lv_tick_inc(x)` in an interrupt and `lv_timer_handler()` in your main `while(1)`.

Learn more in the [Tick](/porting/tick) and [Task handler](/porting/task-handler) sections.
Learn more in the [Tick](/porting/tick) and [Timer handler](/porting/timer-handler) sections.

### Why is the display driver called only once? Only the upper part of the display is refreshed.
Be sure you are calling `lv_disp_flush_ready(drv)` at the end of your "*display flush callback*".
Expand Down
2 changes: 1 addition & 1 deletion docs/overview/timer.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# Timers

LVGL has a built-in timer system. You can register a function to have it be called periodically. The timers are handled and called in `lv_timer_handler()`, which needs to be called every few milliseconds.
See [Porting](/porting/task-handler) for more information.
See [Porting](/porting/timer-handler) for more information.

Timers are non-preemptive, which means a timer cannot interrupt another timer. Therefore, you can call any LVGL related function in a timer.

Expand Down
2 changes: 1 addition & 1 deletion docs/porting/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
display
indev
tick
task-handler
timer-handler
sleep
os
log
Expand Down
2 changes: 1 addition & 1 deletion docs/porting/project.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,4 @@ To use the graphics library you have to initialize it and setup required compone
2. Initialize your drivers.
3. Register the display and input devices drivers in LVGL. Learn more about [Display](/porting/display) and [Input device](/porting/indev) registration.
4. Call `lv_tick_inc(x)` every `x` milliseconds in an interrupt to report the elapsed time to LVGL. [Learn more](/porting/tick).
5. Call `lv_timer_handler()` every few milliseconds to handle LVGL related tasks. [Learn more](/porting/task-handler).
5. Call `lv_timer_handler()` every few milliseconds to handle LVGL related tasks. [Learn more](/porting/timer-handler).
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
```eval_rst
.. include:: /header.rst
:github_url: |github_link_base|/porting/task-handler.md
:github_url: |github_link_base|/porting/timer-handler.md
```
# Task Handler
# Timer Handler

To handle the tasks of LVGL you need to call `lv_timer_handler()` periodically in one of the following:
- *while(1)* of *main()* function
Expand Down

0 comments on commit a6368fe

Please sign in to comment.