Commit 45722f3d authored by philip's avatar philip
Browse files

Fixed the documentation to match the implementation

parent 09ba1fc8
...@@ -64,8 +64,8 @@ Sets a callback on specific events. ...@@ -64,8 +64,8 @@ Sets a callback on specific events.
If the callback is None or omitted, then the registration is cancelled. 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 The callback will be invoked with three arguments when the event happens. The first argument is the eventtype,
current position of the rotary switch, the second is the eventtype, and the third is the time when the event happened. the second is the current position of the rotary switch, and the third is the time when the event happened.
The position is tracked 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 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. ...@@ -73,7 +73,7 @@ in a 32-bit integer. Note that this wraps every hour or so.
#### Example #### 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 print "Position=" .. pos .. " event type=" .. type .. " time=" .. when
end) end)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment