Browse Source

ammendments to tmr API doc cleanup

devsaurus 7 years ago
parent
commit
0a0c7c0637
2 changed files with 2 additions and 2 deletions
  1. 1 1
      docs/en/modules/tmr.md
  2. 1 1
      docs/en/upload.md

+ 1 - 1
docs/en/modules/tmr.md

@@ -22,7 +22,7 @@ This is a convenience function combining [`tmr.register()`](#tmrregister) and [`
 To free up the resources with this timer when done using it, call [`tmr.unregister()`](#tmrunregister) on it. For one-shot timers this is not necessary, unless they were stopped before they expired.
 
 #### Syntax
-`tmr.register([id/ref], interval_ms, mode, func())`
+`tmr.alarm([id/ref], interval_ms, mode, func())`
 
 #### Parameters
 - `id`/`ref` timer id (0-6) or object, obsolete for OO API (→ [`tmr.create()`](#tmrcreate))

+ 1 - 1
docs/en/upload.md

@@ -70,7 +70,7 @@ tmr.create():alarm(1000, tmr.ALARM_AUTO, function(cb_timer)
         print("WiFi connection established, IP address: " .. wifi.sta.getip())
         print("You have 3 seconds to abort")
         print("Waiting...")
-        tmr.alarm(0, 3000, 0, startup)
+        tmr.create():alarm(3000, tmr.ALARM_SINGLE, startup)
     end
 end)
 ```