Skip to content

Commit 3b4e0fe

Browse files
committed
Update README.md
1 parent 006195f commit 3b4e0fe

1 file changed

Lines changed: 6 additions & 36 deletions

File tree

README.md

Lines changed: 6 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -287,11 +287,11 @@ There are 4 timer functions to make timing operations simple to use in your code
287287

288288

289289

290-
## blink(ms)
290+
## blink(ms, mode)
291291

292292
##### Description
293293

294-
This function sets the duration in milliseconds that the returned value is true after the set timer mode - onPress( 0), onRelease (1), onChange (2). Useful to blink an LED.
294+
This function sets the duration in milliseconds that the returned value is true. The mode parameter sets what blink responds to: onPress( 0), onRelease (1), onChange (2).
295295

296296
##### Syntax
297297

@@ -301,14 +301,16 @@ This function sets the duration in milliseconds that the returned value is true
301301

302302
**ms:** The number of milliseconds *(unsigned int)*
303303

304+
**mode:** Blink onPress( 0), onRelease (1), onChange (2) *(byte)*
305+
304306
##### Returns
305307

306-
*true* or *false*, depending on whether the elapsed time has expired after any state change. *(bool)*
308+
*true* or *false*, depending on whether the elapsed time has expired after any state change set by the mode parameter. *(bool)*
307309

308310
##### Example
309311

310312
```c++
311-
digitalWrite(ledPin, blink(100)); // blink an LED for 100ms just after each state change
313+
digitalWrite(ledPin, blink(100)); // blink an LED for 100ms just after state change set by mode
312314
```
313315
314316
@@ -458,38 +460,6 @@ None.
458460

459461

460462

461-
## setTimerMode()
462-
463-
##### Description
464-
465-
Sets the timer mode to start onPress (0), onRelease (1) or onChange (2).
466-
467-
##### Syntax
468-
469-
`myInput.setTimerMode(0);`
470-
471-
##### Returns
472-
473-
None.
474-
475-
476-
477-
## getTimerMode()
478-
479-
##### Description
480-
481-
Gets the timer mode to start onPress (0), onRelease (1) or onChange (2).
482-
483-
##### Syntax
484-
485-
`myInput.getTimerMode();`
486-
487-
##### Returns
488-
489-
Timer Mode *(byte)*.
490-
491-
492-
493463
## getElapsedMs(()
494464

495465
##### Description

0 commit comments

Comments
 (0)