App:Library:LVGL:docs:Overview:Timers

提供: robot-jp wiki
ナビゲーションに移動検索に移動

https://docs.lvgl.io/8.2/overview/timer.html

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 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.

LVGLはタイマーシステムを内蔵しています。

関数を登録することで、定期的に呼び出されるようにすることができます。

タイマーはlv_timer_handler()の中で処理され、数ミリ秒ごとに呼ばれる必要があります。

詳しくは移植を参照してください。

タイマーはノンプリエンプティブです。つまり、タイマーは他のタイマーを中断することができません。

したがって、タイマーの中でLVGLに関連するあらゆる関数を呼び出すことができます。

戻る : Previous


Create a timer

英文 自動翻訳

To create a new timer, use lv_timer_create(timer_cb, period_ms, user_data).

It will create an lv_timer_t * variable, which can be used later to modify the parameters of the timer. lv_timer_create_basic() can also be used.

This allows you to create a new timer without specifying any parameters.

A timer callback should have a void (*lv_timer_cb_t)(lv_timer_t *); prototype.

For example: 

 void my_timer(lv_timer_t * timer)
 {
   /*Use the user_data*/
   uint32_t * user_data = timer->user_data;
   printf("my_timer called with user data: %d\n", *user_data);
 
   /*Do something with LVGL*/
   if(something_happened) {
     something_happened = false;
     lv_btn_create(lv_scr_act(), NULL);
   }
 }
 
 ...
 
 static uint32_t user_data = 10;
 lv_timer_t * timer = lv_timer_create(my_timer, 500,  &user_data);
タイマーを新規に作成するには、lv_timer_create(timer_cb, period_ms, user_data)を使用します。

これはlv_timer_t * 変数を作成し、後でタイマーのパラメータを変更するために使用することができます。

lv_timer_create_basic()も使用可能です。

これは、パラメータを指定せずに新しいタイマーを作成することができます。

タイマーのコールバックは、void (*lv_timer_cb_t)(lv_timer_t *); のプロトタイプを持つ必要があります。

例えば
 void my_timer(lv_timer_t * timer)
 {
   /*Use the user_data*/
   uint32_t * user_data = timer->user_data;
   printf("my_timer called with user data: %d\n", *user_data);
 
   /*Do something with LVGL*/
   if(something_happened) {
     something_happened = false;
     lv_btn_create(lv_scr_act(), NULL);
   }
 }
 
 ...
 
 static uint32_t user_data = 10;
 lv_timer_t * timer = lv_timer_create(my_timer, 500,  &user_data);
戻る : Previous


Ready and Reset

英文 自動翻訳

lv_timer_ready(timer) makes a timer run on the next call of lv_timer_handler().

lv_timer_reset(timer) resets the period of a timer.

It will be called again after the defined period of milliseconds has elapsed.

lv_timer_ready(timer) は、次のlv_timer_handler()のコールでタイマーを実行させる。

lv_timer_reset(timer) は、タイマーの周期をリセットします。

定義されたミリ秒の期間が経過すると、再び呼び出されます。

戻る : Previous


Set parameters

英文 自動翻訳

You can modify some timer parameters later:

  • lv_timer_set_cb(timer, new_cb)
  • lv_timer_set_period(timer, new_period)
 タイマーのパラメータは後で変更することができます．
  • lv_timer_set_cb(timer, new_cb)
  • lv_timer_set_period(timer, new_period)
戻る : Previous


Repeat count

英文 自動翻訳

You can make a timer repeat only a given number of times with lv_timer_set_repeat_count(timer, count).

The timer will automatically be deleted after it's called the defined number of times.

Set the count to -1 to repeat indefinitely.

lv_timer_set_repeat_count(timer, count)で指定した回数だけタイマーを繰り返すようにすることができます。

タイマーは指定された回数だけ呼び出された後、自動的に削除されます。

カウントを-1にすると、無限に繰り返すことができます。

戻る : Previous


Measure idle time

英文 自動翻訳

You can get the idle percentage time of lv_timer_handler with lv_timer_get_idle().

Note that, it doesn't measure the idle time of the overall system, only lv_timer_handler.

It can be misleading if you use an operating system and call lv_timer_handler in a timer, as it won't actually measure the time the OS spends in an idle thread.

lv_timer_handler のアイドルパーセント時間は lv_timer_get_idle()で得ることができます。

注意：これはシステム全体のアイドル時間を測定しているわけではなく、 lv_timer_handler のみを測定しています。

OSを使用していて、タイマーでlv_timer_handler を呼び出す場合、OSがアイドルスレッドで過ごす時間を実際に測定しないので、誤解を招く可能性があります。

戻る : Previous


Asynchronous calls

英文 自動翻訳

In some cases, you can't perform an action immediately.

For example, you can't delete an object because something else is still using it, or you don't want to block the execution now.


For these cases, lv_async_call(my_function, data_p) can be used to call my_function on the next invocation of lv_timer_handler. data_p will be passed to the function when it's called.


Note that only the data pointer is saved, so you need to ensure that the variable will be "alive" while the function is called.

It can be static, global or dynamically allocated data.

For example: 

 void my_screen_clean_up(void * scr)
 {
   /*Free some resources related to `scr`*/
 
   /*Finally delete the screen*/
   lv_obj_del(scr);  
 }
 
 ...
 
 /*Do something with the object on the current screen*/
 
 /*Delete screen on next call of `lv_timer_handler`, not right now.*/
 lv_async_call(my_screen_clean_up, lv_scr_act());
 
 /*The screen is still valid so you can do other things with it*/


If you just want to delete an object and don't need to clean anything up in my_screen_cleanup you could just use lv_obj_del_async which will delete the object on the next call to lv_timer_handler.

場合によっては、アクションをすぐに実行できないことがあります。

たとえば、他のユーザーがまだオブジェクトを使用しているため、または実行をブロックしたくないために、オブジェクトを削除することはできません。


このような場合、lv_async_call(my_function, data_p)を使用すると、次にlv_timer_handlerを呼び出したときにmy_function を呼び出すことができます。data_pは、関数が呼び出されたときに渡されます。


データポインターのみが保存されることに注意してください。そのため、関数の呼び出し中に変数が"alive"されるようにする必要があります。

静的、グローバル、または動的に割り当てられたデータです。

例:
 void my_screen_clean_up(void * scr)
 {
   /*Free some resources related to `scr`*/
 
   /*Finally delete the screen*/
   lv_obj_del(scr);  
 }
 
 ...
 
 /*Do something with the object on the current screen*/
 
 /*Delete screen on next call of `lv_timer_handler`, not right now.*/
 lv_async_call(my_screen_clean_up, lv_scr_act());
 
 /*The screen is still valid so you can do other things with it*/


オブジェクトを削除したいだけで、my_screen_cleanup 内をクリーンアップする必要がない場合は、lv_obj_del_async を使用すれば、次にlv_timer_handlerを呼び出したときにオブジェクトが削除されます。

戻る : Previous


API

英文 自動翻訳

Typedefs

typedef void (*lv_timer_cb_t)(struct _lv_timer_t*)

Timers execute this type of functions.

typedef struct _lv_timer_t lv_timer_t

Descriptor of a lv_timer

Functions

void _lv_timer_core_init(void)

Init the lv_timer module


lv_timer_t *lv_timer_create_basic(void)

Create an "empty" timer. It needs to initialized with at least lv_timer_set_cb and lv_timer_set_period
Returns
pointer to the created timer

lv_timer_t *lv_timer_create(lv_timer_cb_t timer_xcb, uint32_t period, void *user_data)

Create a new lv_timer
Parameters
  • timer_xcb -- a callback to call periodically. (the 'x' in the argument name indicates that it's not a fully generic function because it not follows the func_name(object, callback, ...) convention)
  • period -- call period in ms unit
  • user_data -- custom parameter
Returns
pointer to the new timer

void lv_timer_del(lv_timer_t *timer)

Delete a lv_timer
Parameters
timer -- pointer to an lv_timer

void lv_timer_pause(lv_timer_t *timer)

Pause/resume a timer.
Parameters
timer -- pointer to an lv_timer

void lv_timer_resume(lv_timer_t *timer)

void lv_timer_set_cb(lv_timer_t *timer, lv_timer_cb_t timer_cb)

Set the callback the timer (the function to call periodically)
Parameters
  • timer -- pointer to a timer
  • timer_cb -- the function to call periodically

void lv_timer_set_period(lv_timer_t *timer, uint32_t period)

Set new period for a lv_timer
Parameters
  • timer -- pointer to a lv_timer
  • period -- the new period

void lv_timer_ready(lv_timer_t *timer)

Make a lv_timer ready. It will not wait its period.
Parameters
timer -- pointer to a lv_timer.

void lv_timer_set_repeat_count(lv_timer_t *timer, int32_t repeat_count)

Set the number of times a timer will repeat.
Parameters
  • timer -- pointer to a lv_timer.
  • repeat_count -- -1 : infinity; 0 : stop ; n>0: residual times

void lv_timer_reset(lv_timer_t *timer)

Reset a lv_timer. It will be called the previously set period milliseconds later.
Parameters
timer -- pointer to a lv_timer.

void lv_timer_enable(bool en)

Enable or disable the whole lv_timer handling
Parameters
en -- true: lv_timer handling is running, false: lv_timer handling is suspended

uint8_t lv_timer_get_idle(void)

Get idle percentage
Returns
the lv_timer idle in percentage

lv_timer_t *lv_timer_get_next(lv_timer_t *timer)

Iterate through the timers
Parameters
timer -- NULL to start iteration or the previous return value to get the next timer
Returns
the next timer or NULL if there is no more timer

struct _lv_timer_t

#include <lv_timer.h>
Descriptor of a lv_timer
Public Members
uint32_t period
How often the timer should run
uint32_t last_run
Last time the timer ran
lv_timer_cb_t timer_cb
Timer function
void *user_data
Custom user data
int32_t repeat_count
1: One time; -1 : infinity; n>0: residual times
uint32_t paused

Typedefs

typedef void (*lv_async_cb_t)(void*)

Type for async callback.

Functions

lv_res_t lv_async_call(lv_async_cb_t async_xcb, void *user_data)

Call an asynchronous function the next time lv_timer_handler() is run.
This function is likely to return before the call actually happens!
Parameters
  • async_xcb -- a callback which is the task itself. (the 'x' in the argument name indicates that it's not a fully generic function because it not follows the func_name(object, callback, ...) convention)
  • user_data -- custom parameter
 Typedefs

typedef void (*lv_timer_cb_t)(struct _lv_timer_t*)

タイマはこのような機能を担っています。

typedef struct _lv_timer_t lv_timer_t

lv_timer の記述子。

Functions

void _lv_timer_core_init(void)

lv_timer モジュールの初期化


lv_timer_t *lv_timer_create_basic(void)

空の」タイマーを作成します。少なくともlv_timer_set_cb とlv_timer_set_periodで初期化されている必要があります。
Returns
作成されたタイマへのポインタ

lv_timer_t *lv_timer_create(lv_timer_cb_t timer_xcb, uint32_t period, void *user_data)

lv_timerを新規に作成します。
Parameters
  • timer_xcb -- 定期的に呼び出すコールバック。(引数名の「x」は、func_name(object, callback, ...)の規約に従っていないため、完全な汎用関数でないことを示しています)
  • period -- 呼び出し時間（ms単位
  • user_data -- カスタムパラメータ
Returns
新しいタイマへのポインタ

void lv_timer_del(lv_timer_t *timer)

Delete a lv_timer
Parameters
timer -- lv_timerへのポインタ

void lv_timer_pause(lv_timer_t *timer)

タイマーを一時停止／再開する。
Parameters
timer -- lv_timerへのポインタ

void lv_timer_resume(lv_timer_t *timer)

void lv_timer_set_cb(lv_timer_t *timer, lv_timer_cb_t timer_cb)

コールバックにタイマーを設定する（定期的に呼び出す関数）。
Parameters
  • timer -- タイマーのポインタ
  • timer_cb -- 定期的に呼び出す関数

void lv_timer_set_period(lv_timer_t *timer, uint32_t period)

lv_timerに新しい周期を設定する。
Parameters
  • timer -- lv_timerへのポインタ
  • period -- 新しい期間

void lv_timer_ready(lv_timer_t *timer)

lv_timerを準備します。それはその期間を待たないだろう。
Parameters
timer -- lv_timerへのポインタ。

void lv_timer_set_repeat_count(lv_timer_t *timer, int32_t repeat_count)

タイマーを繰り返す回数を設定します。
Parameters
  • timer -- lv_timerへのポインタ。
  • repeat_count -- -1:無限; 0:停止; n>0:残差時間

void lv_timer_reset(lv_timer_t *timer)

lv_timerをリセットします。これは、事前に設定されたperiodミリ秒後に呼び出されます。
Parameters
timer -- lv_timerへのポインタ。

void lv_timer_enable(bool en)

lv_timer処理全体を有効または無効にする
Parameters
en -- true:lv_timer処理が実行中、
false:lv_timer処理が中断されます。

uint8_t lv_timer_get_idle(void)

アイドルパーセンテージの取得
Returns
lv_timerアイドル時間のパーセンテージ

lv_timer_t *lv_timer_get_next(lv_timer_t *timer)

タイマーを反復する
Parameters
timer -- 反復を開始する場合はNULL、次のタイマーを取得する場合は前の戻り値
Returns
次のタイマー、またはタイマーがない場合はNULL

struct _lv_timer_t

#include <lv_timer.h>
lv_timerの記述子
Public Members
uint32_t period
タイマーを実行する頻度
uint32_t last_run
前回タイマーが実行された時刻
lv_timer_cb_t timer_cb
タイマー機能
void *user_data
カスタム・ユーザー・データ
int32_t repeat_count
1:1回; -1:無限; n>0:残差時間
uint32_t paused

Typedefs

typedef void (*lv_async_cb_t)(void*)

非同期コールバックの型。

Functions

lv_res_t lv_async_call(lv_async_cb_t async_xcb, void *user_data)

次にlv_timer_handler () が実行された時に非同期関数をコールします。 この関数は、呼び出しが実際に発生する前に返される可能性があります。
Parameters
  • async_xcb--タスク自体のコールバック。(引数名の'x'は、func_name(object, callback, ...)の規約に従っていないため、完全なジェネリック関数ではないことを示します。)
  • user_data -- カスタムパラメータ


戻る : Previous

「https://robot-jp.com/wiki/index.php?title=App:Library:LVGL:docs:Overview:Timers&oldid=4086」から取得