From 0a0c7c0637ae00d55461abed5f147c22f6e00b3e Mon Sep 17 00:00:00 2001 From: devsaurus Date: Wed, 4 Jan 2017 10:32:55 +0100 Subject: [PATCH] ammendments to tmr API doc cleanup --- docs/en/modules/tmr.md | 2 +- docs/en/upload.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/modules/tmr.md b/docs/en/modules/tmr.md index 1fd043ba..919682d2 100644 --- a/docs/en/modules/tmr.md +++ b/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)) diff --git a/docs/en/upload.md b/docs/en/upload.md index 20dbb3d8..565a55bb 100644 --- a/docs/en/upload.md +++ b/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) ```