diff options
| author | Damien George | 2017-06-15 17:34:51 +1000 |
|---|---|---|
| committer | Damien George | 2017-06-15 17:34:51 +1000 |
| commit | fd860dc552b2ec53df8c6ce7e1245206719d469b (patch) | |
| tree | f0e1fa830f923ebc76d8815c4a30772853696219 /docs/library | |
| parent | 4abe3731e3fbce88c2efa265950c5e13b30426d6 (diff) | |
stmhal: Add .value() method to Switch object, to mirror Pin and Signal.
Diffstat (limited to 'docs/library')
| -rw-r--r-- | docs/library/pyb.Switch.rst | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/library/pyb.Switch.rst b/docs/library/pyb.Switch.rst index bc62b6eee..0d5dc63b7 100644 --- a/docs/library/pyb.Switch.rst +++ b/docs/library/pyb.Switch.rst @@ -8,7 +8,8 @@ A Switch object is used to control a push-button switch. Usage:: sw = pyb.Switch() # create a switch object - sw() # get state (True if pressed, False otherwise) + sw.value() # get state (True if pressed, False otherwise) + sw() # shorthand notation to get the switch state sw.callback(f) # register a callback to be called when the # switch is pressed down sw.callback(None) # remove the callback @@ -34,6 +35,10 @@ Methods Call switch object directly to get its state: ``True`` if pressed down, ``False`` otherwise. +.. method:: Switch.value() + + Get the switch state. Returns `True` if pressed down, otherwise `False`. + .. method:: Switch.callback(fun) Register the given function to be called when the switch is pressed down. |
