MirrorSave
/
nodemcu-firmware
mirror of https://github.com/nodemcu/nodemcu-firmware.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixes broken `tmr.alarm` (#3263) 

Co-authored-by: vsky <blue205@centrum.cz>
This commit is contained in:
Lukáš Voborský 2020-09-05 14:16:57 +02:00 committed by GitHub
parent e28cf8d983
commit 38f13a7e9f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
app/modules/tmr.c
View File

@ -132,26 +132,29 @@ static int tmr_start(lua_State* L){
luaL_argcheck(L, lua_isboolean(L, 2) || lua_isnil(L, 2), 2, "boolean expected");
int restart = lua_toboolean(L, 2);
lua_settop(L, 1); /* ignore any args after the userdata */
lua_settop(L, 1); /* we need to have userdata on top of the stack */
if (tmr->self_ref == LUA_NOREF)
tmr->self_ref = luaL_ref(L, LUA_REGISTRYINDEX);
//we return false if the timer is not idle
//we return false if the timer is not idle and is not to be restarted
int idle = tmr->mode&TIMER_IDLE_FLAG;
if(!(idle || restart)){
lua_pushboolean(L, 0);
lua_pushboolean(L, false);
}else{
if (!idle) {os_timer_disarm(&tmr->os);}
tmr->mode &= ~TIMER_IDLE_FLAG;
os_timer_arm(&tmr->os, tmr->interval, tmr->mode==TIMER_MODE_AUTO);
lua_pushboolean(L, true);
}
lua_pushboolean(L, !idle); /* false if the timer is not idle */
return 1;
}
// Lua: t:alarm( interval, repeat, function )
static int tmr_alarm(lua_State* L){
tmr_register(L);
/* remove tmr.alarm's other then the 1st UD parameters from Lua stack.
tmr.start expects UD and optional restart parameter. */
lua_settop(L, 1);
return tmr_start(L);
}

5
docs/modules/tmr.md
View File

@ -185,7 +185,8 @@ print( timeIt(function() tmr.ccount() end) )
### tobj:alarm()
This is a convenience function combining [`tobj:register()`](#tobjregister) and [`tobj:start()`](#tobjstart) into a single call.
This is a convenience function combining [`tobj:register()`](#tobjregister) and [`tobj:start()`](#tobjstart) into a single call. This is the reason why this method has the same parameters as `tobj:register()`.
If `tobj:alarm()` is invoked on an already running timer the timer is stopped, new parameters are set and timer is (re)started (similar to call `tobj:start(true)`).
To free up the resources with this timer when done using it, call [`tobj:unregister()`](#tobjunregister) on it. For one-shot timers this is not necessary, unless they were stopped before they expired.
@ -282,7 +283,7 @@ Starts or restarts a previously configured timer. If the timer is running the ti
- `restart` optional boolean parameter forcing to restart already running timer
#### Returns
`true` if the timer was started, `false` on error
`true` if the timer was (re)started, `false` on error
#### Example
```lua