- Modified button example to be the task detailed in the pyControl manuscript. Added version of button example using named rather than * imports to allow users to compare the resulting code.

Author: ThomasAkam

pyControl/utility.py

@@ -1,3 +1,6 @@
+# Module imported by the user into their task file which contains the 
+# functions, classes and variables used in task files.
+
 import pyb
 import math
 from . import framework as fw

tasks/example/button.py

@@ -1,38 +1,41 @@
-# A simple state machine which turns the blue LED on the pyboard on and off when the
-# usr pushbutton on the pyboard is pressed.  Does not require any hardware except a
-# micropython board.
+# A simple state machine which turns the blue LED on the pyboard on for 1 
+# second when the usr pushbutton on the pyboard is pressed three times.  
+# Does not require any hardware except a micropython board.
 
-from pyControl.utility import *
-from devices import *
-
-# Define hardware (normally done in seperate hardware definition file).
-
-pyboard_button = Digital_input('X17', falling_event='button_press', pull='up')  # USR button on pyboard.
-
-blue_LED = Digital_output('B4')
-
-# States and events.
+from pyControl.utility import * 
+from devices import * 
 
-states= ['LED_on',
-         'LED_off']
-
-events = ['button_press']
-
-initial_state = 'LED_off'
-
-# Define behaviour.
-
-def LED_on(event):
-    if event == 'entry':
-        blue_LED.on()
-    elif event == 'exit':
-        blue_LED.off()
-    elif event == 'button_press':
-        goto_state('LED_off')
-
-def LED_off(event):
-    if event == 'button_press':
-        goto_state('LED_on')
-
-def run_end():  # Turn off hardware at end of run.
-    blue_LED.off()
+# Define hardware 
+  
+button = Digital_input('X17', rising_event='button_press', pull='up') # pyboard usr button.
+LED    = Digital_output('B4') 
+  
+# States and events. 
+  
+states = ['LED_on', 
+          'LED_off'] 
+  
+events = ['button_press'] 
+  
+initial_state = 'LED_off' 
+  
+# Variables 
+  
+v.press_n = 0 
+  
+# State behaviour functions. 
+  
+def LED_off(event): 
+    if event == 'button_press': 
+        v.press_n = v.press_n + 1
+        print('Press number {}'.format(v.press_n))
+        if v.press_n == 3: 
+            goto_state('LED_on') 
+  
+def LED_on(event): 
+    if event == 'entry': 
+        LED.on() 
+        timed_goto_state('LED_off', 1*second) 
+        v.press_n = 0 
+    elif event == 'exit': 
+        LED.off() 

tasks/example/button_named_imports.py

@@ -0,0 +1,42 @@
+# Identical to the button example but using named imports rather
+# than the 'from module import *' syntax.  This way is more 
+# 'Pythonic' but results somewhat more verbose task code.  You can 
+# use whichever import style you prefer in your task code.
+
+import pyControl.utility as pc 
+import devices as dv
+  
+# Define hardware 
+  
+button = dv.Digital_input('X17', rising_event='button_press', pull='up') # pyboard usr button.
+LED    = dv.Digital_output('B4') 
+  
+# States and events. 
+  
+states = ['LED_on', 
+          'LED_off'] 
+  
+events = ['button_press'] 
+  
+initial_state = 'LED_off' 
+  
+# Variables 
+  
+pc.v.press_n = 0 
+  
+# State behaviour functions. 
+  
+def LED_off(event): 
+    if event == 'button_press': 
+        pc.v.press_n = pc.v.press_n + 1
+        pc.print('Press number {}'.format(pc.v.press_n))
+        if pc.v.press_n == 3: 
+            pc.goto_state('LED_on') 
+  
+def LED_on(event): 
+    if event == 'entry': 
+        LED.on() 
+        pc.timed_goto_state('LED_off', 1*pc.second) 
+        pc.v.press_n = 0 
+    elif event == 'exit': 
+        LED.off()