summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDamien George <damien.p.george@gmail.com>2014-04-21 18:28:23 +0100
committerDamien George <damien.p.george@gmail.com>2014-04-21 18:28:23 +0100
commit46e1f26615a75c6dafe87c82c9ab641eec39acb9 (patch)
tree4ab27bfb6064a9add073f7d1fd4adb9c750ff1df
parent6125ba4a7f9d757abd89f85745f458e52e2ef6fb (diff)
stmhal, usrsw: Update comments for new switch API.
-rw-r--r--stmhal/usrsw.c16
1 files changed, 6 insertions, 10 deletions
diff --git a/stmhal/usrsw.c b/stmhal/usrsw.c
index fd90aaf2a..088b53ad1 100644
--- a/stmhal/usrsw.c
+++ b/stmhal/usrsw.c
@@ -14,19 +14,15 @@
// Usage Model:
//
-// pyb.switch() returns True if the user switch is pressed, False otherwise.
-//
-// pyb.switch(callback) will register a callback to be called when the user
-// switch is pressed.
-//
-// pyb.switch(None) will remove the callback.
+// sw = pyb.Switch() # create a switch object
+// sw() # get state (True if pressed, False otherwise)
+// sw.callback(f) # register a callback to be called when the
+// # switch is pressed down
+// sw.callback(None) # remove the callback
//
// Example:
//
-// def switch_pressed():
-// print("User Switch pressed")
-//
-// pyb.switch(switch_pressed)
+// pyb.Switch().callback(lambda: pyb.LED(1).toggle())
// this function inits the switch GPIO so that it can be used
void switch_init0(void) {