This is the v1.23.0 version of the MicroPython documentation. The latest development version of this page may be more current.

class Switch – switch object

A Switch object is used to control a push-button switch.

Usage:

sw = pyb.Switch()       # create a switch object
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

Example:

pyb.Switch().callback(lambda: pyb.LED(1).toggle())

Constructors

class pyb.Switch

Create and return a switch object.

Methods

Switch.__call__()

Call switch object directly to get its state: True if pressed down, False otherwise.

Switch.value()

Get the switch state. Returns True if pressed down, otherwise False.

Switch.callback(fun)

Register the given function to be called when the switch is pressed down. If fun is None, then it disables the callback.