cw: Documentation

Charles Weir · Charles Weir · commit b05d32a28655 · 2014-02-23T19:44:11.000Z
diff --git a/BrickPython/CommandLineApplication.py b/BrickPython/CommandLineApplication.py
@@ -0,0 +1,25 @@
+# CommandLineApplication class.  Provides a dummy scheduler for BrickPiWrapper.
+# Applications using the BrickPi derive from this, implementing appropriate functionality.
+
+
+import Tkinter as tk
+
+from BrickPiWrapper import *
+import logging
+
+class CommandLineApplication(BrickPiWrapper):
+    '''
+    Main application class for command-line only apps.  Doesn't support user input.
+    '''
+
+    def __init__(self, sensorConfiguration={}):
+        '''Initialization: *sensorConfiguration* is a map, e.g. {PORT_1: TYPE_SENSOR_ULTRASONIC_CONT }
+        as passed to BrickPiWrapper'''
+        BrickPiWrapper.__init__(self, sensorConfiguration )
+
+    def mainloop(self):
+        'The main loop for the application - call this after initialization.  Never returns.'
+        while True:
+            self.doWork()
+            time.sleep(self.timeMillisToNextCall() / 1000.0)
+
diff --git a/BrickPython/TkApplication.py b/BrickPython/TkApplication.py
@@ -58,3 +58,4 @@ def onKeyPress(self, event):
             return False
         return True
 
+
diff --git a/ExamplePrograms/SimpleApp.py b/ExamplePrograms/SimpleApp.py
@@ -2,21 +2,22 @@
 
 
 import sortOutPythonPaths
-from BrickPython.TkApplication import *
+from BrickPython.CommandLineApplication import *
 
-class SimpleApp(TkApplication):
+class SimpleApp(CommandLineApplication):
     def __init__(self):
-        TkApplication.__init__(self)
+        CommandLineApplication.__init__(self)
         self.addSensorCoroutine( self.doActivity() )
 
     def doActivity(self):
         'Coroutine to rotate a motor forward and backward'
         motorA = self.motor('A')
         motorA.zeroPosition()
         while True:
+            print 'a'
             for i in motorA.moveTo( 2*90 ):
                 yield
-
+            print 'b'
             for i in motorA.moveTo( 0 ):
                 yield
 
diff --git a/docs/BrickPython.rst b/docs/BrickPython.rst
@@ -3,27 +3,32 @@ BrickPython API
 
 This describes the BrickPython API in detail.
 
-:mod:`Scheduler` Module
------------------------
+:mod:`Scheduler`
+----------------
 .. automodule:: Scheduler
 
 
-:mod:`BrickPiWrapper` Module
-----------------------------
+:mod:`BrickPiWrapper`
+---------------------
 .. automodule:: BrickPiWrapper
 
 
-:mod:`TkApplication` Module
-----------------------------
+:mod:`TkApplication`
+--------------------
 .. automodule:: TkApplication
 
 
-:mod:`Motor` Module
-----------------------------
+:mod:`CommandLineApplication`
+-----------------------------
+.. automodule:: CommandLineApplication
+
+
+:mod:`Motor`
+------------
 .. automodule:: Motor
 
 
-:mod:`Sensor` Module
-----------------------------
+:mod:`Sensor`
+-------------
 .. automodule:: Sensor
 
diff --git a/docs/introduction.rst b/docs/introduction.rst
@@ -118,6 +118,8 @@ Other Integrations
 Integrations with other frameworks, or non at all, are equally straightforward.   The framework must call the
 method Scheduler.doWork regularly, pausing for Scheduler.timeMillisToNextCall() after each call.
 
+For example `CommandLineApplication` provides a scheduler for applications that don't require user input.
+
 Motors and Sensors
 ==================
 
diff --git a/docs/programmingWithCoroutines.rst b/docs/programmingWithCoroutines.rst
@@ -8,12 +8,12 @@ A simple example
 
 Here's a simple application, from ``ExamplePrograms/SimpleApp.py``::
 
-	from BrickPython.TkApplication import *
+	from BrickPython.CommandLineApplication import *
 
-	class SimpleApp(TkApplication):
+	class SimpleApp(CommandLineApplication):
 	    def __init__(self):
-	        TkApplication.__init__(self)
-	        self.addSensorCoroutine( self.doActivity() ) #A
+	        CommandLineApplication.__init__(self)
+	        self.addSensorCoroutine( self.doActivity() )  #A
 
 	    def doActivity(self):
 	    	'Coroutine to rotate a motor forward and backward'
@@ -29,6 +29,8 @@ Here's a simple application, from ``ExamplePrograms/SimpleApp.py``::
 	if __name__ == "__main__":
 	    SimpleApp().mainloop()
 
+It uses the simplest scheduler - the CommandLineApplication.
+
 Line A creates a coroutine from the coroutine method doActivity() and adds it to the scheduler.   A coroutine must have
 one or more `yield` calls, such as the one at line D, and the scheduler can then call it using 'next()'
 - see, for example https://wiki.python.org/moin/Generators

Original file line number	Diff line number	Diff line change
`@@ -58,3 +58,4 @@ def onKeyPress(self, event):`
`58`	`58`	`return False`
`59`	`59`	`return True`
`60`	`60`
	`61`	`+`