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

Merge pull request #1265 from pjsg/fix-rotary-doc 

Fixed the rotary documentation to match the implementation
This commit is contained in:
Johny Mattsson 2016-04-26 16:41:31 +10:00
parent 09ba1fc897 45722f3d79
commit 3ec58852c9
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/en/modules/rotary.md
View File

@ -64,8 +64,8 @@ Sets a callback on specific events.
If the callback is None or omitted, then the registration is cancelled.
The callback will be invoked with three arguments when the event happens. The first argument is the
current position of the rotary switch, the second is the eventtype, and the third is the time when the event happened.
The callback will be invoked with three arguments when the event happens. The first argument is the eventtype,
the second is the current position of the rotary switch, and the third is the time when the event happened.
The position is tracked
and is represented as a signed 32-bit integer. Increasing values indicate clockwise motion. The time is the number of microseconds represented
@ -73,7 +73,7 @@ in a 32-bit integer. Note that this wraps every hour or so.
#### Example
rotary.on(0, rotary.ALL, function (pos, type, when)
rotary.on(0, rotary.ALL, function (type, pos, when)
print "Position=" .. pos .. " event type=" .. type .. " time=" .. when
end)