__doc__ switch, make importable, and easy to test

This commit is contained in:
Metallicow 2014-06-01 08:18:13 -06:00
parent f94cc975a2
commit 9500e98433

View File

@ -1,8 +1,18 @@
""" __doc__ = """
switch.py switch.py
========= =========
Light up all the leds when the USR switch on the pyboard is pressed. Light up some leds when the USR switch on the pyboard is pressed.
Example Usage::
Micro Python v1.0.1 on 2014-05-12; PYBv1.0 with STM32F405RG
Type "help()" for more information.
>>> import switch
>>> switch.run_loop([2, 3])
Loop started.
Press Ctrl+C to break out of the loop.
""" """
import pyb import pyb
@ -12,18 +22,25 @@ red_led = pyb.LED(1)
green_led = pyb.LED(2) green_led = pyb.LED(2)
orange_led = pyb.LED(3) orange_led = pyb.LED(3)
blue_led = pyb.LED(4) blue_led = pyb.LED(4)
leds = [red_led, green_led, orange_led, blue_led] all_leds = [red_led, green_led, orange_led, blue_led]
while 1: def run_loop(use_leds=[]):
if switch(): """
## red_led.on() Start the loop.
## green_led.on()
## orange_led.on() :param `use_leds`: Which leds to light up upon switch press.
## blue_led.on() :type `use_leds`: list of integers [1-4]
[led.on() for led in leds] """
else: print('Loop started.\nPress Ctrl+C to break out of the loop.')
## red_led.off() leds = [all_leds[i - 1] for i in use_leds]
## green_led.off() while 1:
## orange_led.off() try:
## blue_led.off() if switch():
[led.off() for led in leds] [led.on() for led in leds]
else:
[led.off() for led in leds]
except OSError: # VCPInterrupt # Ctrl+C in interpreter mode.
break
if __name__ == '__main__':
run_loop()