Merge remote-tracking branch 'parallax/demo' into demo

Author: PropGit

BlocklyLogger.py

@@ -6,14 +6,17 @@
 
 import os
 import logging
-from sys import platform
+import platform
+
 
 __author__ = 'Jim Ewald'
 
+
 # Platform constants
-PLATFORM_LINUX = 'linux2'
-PLATFORM_MACOS = 'darwin'
-PLATFORM_WINDOWS = 'win32'
+PLATFORM_LINUX = 'Linux'
+PLATFORM_MACOS = 'MacOS'
+PLATFORM_DARWIN = 'MacOS'
+PLATFORM_WINDOWS = 'Windows'
 
 # Default log path for each platform
 DEFAULT_PATH_MACOS = '/Library/Logs/Parallax'
@@ -23,6 +26,8 @@
 # Resulting path for log file
 path = None
 
+loglevel = logging.DEBUG
+
 
 def init(filename = 'BlocklyPropClient.log'):
     global path
@@ -42,11 +47,12 @@ def emit(self, record):
     disable_filelogging = False
 
     # Set correct log file location
-    if platform == PLATFORM_MACOS:
+    system = platform.system()
+    if (system == PLATFORM_MACOS) or (system == PLATFORM_DARWIN):
         logfile_name = __set_macos_logpath(filename)
-    elif platform == PLATFORM_WINDOWS:
+    elif system == PLATFORM_WINDOWS:
         logfile_name = __set_windows_logpath(filename)
-    elif platform == PLATFORM_LINUX:
+    elif system == PLATFORM_LINUX:
         logfile_name = __set_linux_logpath(filename)
 
     # Verify that we have a valid location
@@ -58,11 +64,11 @@ def emit(self, record):
 
     # Create a logger
     logger = logging.getLogger('blockly')
-    logger.setLevel(logging.DEBUG)
+    logger.setLevel(loglevel)
 
     # create a console handler for error-level events
     console = logging.StreamHandler()
-    console.setLevel(logging.ERROR)
+    console.setLevel(loglevel)
 
     # create a logging format
     formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
@@ -72,7 +78,7 @@ def emit(self, record):
     #  Log file is overwritten each time the app runs.
     if not disable_filelogging:
         handler = logging.FileHandler(logfile_name, mode='w')
-        handler.setLevel(logging.DEBUG)
+        handler.setLevel(loglevel)
         handler.setFormatter(formatter)
         logger.addHandler(handler)
 

BlocklyPropClient.py

@@ -1,6 +1,12 @@
 """
     BlocklyProp Client
 
+    0.5.3  February 22, 2017
+    - Correct error in path to propeller-load executable.
+    - Detect condition where serial port has disappeared
+    - Correct error where browser request for specific port
+      speed was disregarded.
+
 """
 import Tkinter as tk
 import ttk as ttk
@@ -23,19 +29,29 @@
 __author__ = 'Michel & Vale'
 
 PORT = 6009
-VERSION = "0.5.2"
+
+# -----------------------------------------------------------------------
+# NOTE:
+#
+# Please verify that the version number in the local about.txt and the
+# ./package/win0resources/blocklypropclient-installer.iss
+# -----------------------------------------------------------------------
+VERSION = "0.5.3"
 
 
 # Enable logging for functions outside of the class definition
-module_logger = logging.getLogger('blockly')
+module_logger = None
 
 
 class BlocklyPropClient(tk.Tk):
     def __init__(self, *args, **kwargs):
+        global module_logger
 
         # Enable application logging
         BlocklyLogger.init()
         self.logger = logging.getLogger('blockly.main')
+        module_logger = logging.getLogger('blockly')
+
         self.logger.info('Creating logger.')
 
         BlocklyHardware.init()
@@ -45,11 +61,13 @@ def __init__(self, *args, **kwargs):
 
         # initialize values
         self.version = 0.0
+        self.app_version = "0.0"
         self.connected = False
 
-        # Path
+        # Path to where application was launched
         self.appdir = os.path.dirname(sys.argv[0])
         self.logger.info('Logging is enabled')
+        self.logger.info('Application launched from %s', self.appdir)
 
         # initialize config variables
         self.ip_address = tk.StringVar()
@@ -62,21 +80,28 @@ def __init__(self, *args, **kwargs):
 
         self.title("BlocklyProp")
 
-        # Set icon
+        # Set icon for Windows platform
         self.logger.info('Operating system is %s', os.name)
         if "nt" == os.name:
             self.wm_iconbitmap(bitmap='blocklyprop.ico')
-        else:
-            #self.wm_iconbitmap(bitmap = "@myicon.xbm")
-            pass
 
+        # Init the system
         self.initialize()
         self.initialize_menu()
-        # Verify the hardware is connected and available
 
+    # Set the application version and app_version values
     def set_version(self, version):
-        self.logger.info('Application version is %s', version)
-        self.version = version
+        # The application version number was converted to a traditional 'major'.'minor'.'patch_level'
+        # format. There is code in the BlocklyProp Javascript that expects the version number as a
+        # float. We handle that issue here.
+        ver_elements = VERSION.split('.')
+        if len(ver_elements) >= 2:
+            n_version = float(ver_elements[0] + '.' + ver_elements[1])
+        else:
+            n_version = 0.4
+
+        self.version = n_version
+        self.app_version = version
 
     def initialize(self):
         self.logger.info('Initializing the UI')
@@ -188,17 +213,19 @@ def handle_connect(self):
         self.logger.info('Connect state is: %s', self.connected)
 
         if self.connected:
+            self.logger.debug('Terminating server process')
             BlocklyServer.stop(self.q)
             self.server_process.terminate()
             self.connected = False
+
+            # Set the connect/disconnect button text to the alternate state
             self.btn_connect['text'] = "Connect"
         else:
             # read entered values and start server
             self.server_process = multiprocessing.Process(
                 target=BlocklyServer.main,
                 args=(int(self.port.get()), self.version, self.q))
 
-           # self.server_process = threading.Thread(target=BlocklyServer.main, args=(int(self.port.get()), self.version)) #, kwargs={'out':self.stdoutToQueue})
             self.server_process.start()
 
             self.connected = True
@@ -222,23 +249,27 @@ def handle_code_browser(self):
     def handle_client_code_browser(self):
         webbrowser.open_new('http://github.com/parallaxinc/BlocklyPropClient')
 
+    # Open the application About dialog box
     def about_info(self):
         try:
             with open(self.appdir + '/about.txt', 'r') as about_file:
                 tkMessageBox.showinfo("About BlocklyProp", about_file.read())
-        except:
+        except OSError:
             tkMessageBox.showinfo("About BlocklyProp", "About file is missing")
 
+    # Open the application Quit dialog box and process user selection
     def handle_close(self):
         self.logger.info('Opening Quit dialog')
 
         if tkMessageBox.askokcancel("Quit?", "Are you sure you want to quit?"):
-            self.logger.info('Quitting')
             # stop server if running
             if self.connected:
-               # BlocklyServer.stop()
+                self.logger.info('Terminating server process')
                 self.server_process.terminate()
+
             self.quit()
+        else:
+            self.logger.debug('Cancelling application quit request')
 
     def text_catcher(self):
         try:
@@ -252,8 +283,8 @@ def text_catcher(self):
                     self.ent_log.yview_pickplace("end")
                     self.ent_log['state'] = 'disabled'
         except EOFError:
-            print('EOF Error')
-#            self.logger.error('Unexpected end of file encountered')
+            # print('EOF Error')
+            self.logger.error('Unexpected end of file encountered')
 
 
 if __name__ == '__main__':

BlocklyServer.py

@@ -13,6 +13,7 @@
 __author__ = 'Michel'
 
 PORT = 6009
+
 # Enable logging for functions outside of the class definition
 module_logger = logging.getLogger('blockly.server')
 
@@ -32,6 +33,7 @@ def __init__(self, version, queue):
     @cherrypy.tools.allow(methods=['GET'])
     def index(self):
         cherrypy.response.headers['Access-Control-Allow-Origin'] = '*'
+
         serverinfo = {
             "server": "BlocklyPropHTTP",
             "version": self.version
@@ -50,13 +52,19 @@ def ports(self):
         self.logger.debug('Port list retreived')
 
         ports = self.propellerLoad.get_ports()
-        filtered_ports = []
-        for port in ports:
-            self.logger.debug('Port %s discovered.', port)
-            if ' bt ' not in port.lower() and 'bluetooth' not in port.lower():
-                self.logger.debug('Port %2 appended to list.', port)
-                filtered_ports.append(port)
-        return filtered_ports
+        if len(ports) > 0:
+            filtered_ports = []
+            for port in ports:
+                self.logger.debug('Port %s discovered.', port)
+                if ' bt ' not in port.lower() and 'bluetooth' not in port.lower():
+                    self.logger.debug('Port %2 appended to list.', port)
+                    filtered_ports.append(port)
+            return filtered_ports
+        else:
+            # No useable ports detected. Need to determine how the browser
+            # handles an empty list of available ports.
+            self.logger.debug('No ports detected. Replying with /dev/null')
+            return '/dev/null'
 
 
     @cherrypy.expose(alias='load.action')

PropellerLoad.py

@@ -18,10 +18,10 @@ def __init__(self):
         self.logger.info('Creating loader logger.')
 
         self.propeller_load_executables = {
-            "Windows": "/propeller-tools/windows/propeller-load.exe",
-            "Linux": "/propeller-tools/linux/propeller-load",
-            "MacOS": "/propeller-tools/mac/propeller-load",
-            "Darwin": "/propeller-tools/mac/propeller-load"
+            "Windows":  "/propeller-tools/windows/propeller-load.exe",
+            "Linux":    "/propeller-tools/linux/propeller-load",
+            "MacOS":    "/propeller-tools/mac/propeller-load",
+            "Darwin":   "/propeller-tools/mac/propeller-load"
         }
 
         self.load_actions = {
@@ -30,12 +30,12 @@ def __init__(self):
         }
 
         if not platform.system() in self.propeller_load_executables:
-            #showerror("Unsupported", platform.system() + " is currently unsupported")
+            self.logger.error('The %s platform is not supported at this time.', platform.system())
             print("Unsupported", platform.system() + " is currently unsupported")
             exit(1)
 
         self.appdir = os.getcwd()
-        self.appdir = os.path.dirname(sys.argv[0])
+        # self.appdir = os.path.dirname(sys.argv[0])
 
     def get_ports(self):
         self.logger.info('Getting ports')
@@ -50,20 +50,14 @@ def get_ports(self):
 
             process = subprocess.Popen([self.appdir + self.propeller_load_executables[platform.system()], "-P"], stdout=subprocess.PIPE, stderr=subprocess.PIPE, startupinfo=startupinfo)
             out, err = process.communicate()
-
+            self.logger.debug('Loader complete: Error code %s returned.', err)
             self.ports = out.splitlines()
             return self.ports
         else:
             self.logger.info("Enumerating host ports")
-            ports = [port for (port, driver, usb) in list_ports.comports()]
-            #self.appdir +
-            #process = subprocess.Popen([self.appdir + self.propeller_load_executables[platform.system()], "-P"], stdout=subprocess.PIPE)
 
-            #out, err = process.communicate()
-#        return json.dumps(out.splitlines())
-            #ports = []
-            #for port in out.splitlines():
-            #    ports.append(port[port.index('/'):])
+            ports = [port for (port, driver, usb) in list_ports.comports()]
+            self.logger.debug('Port count: %s', len(ports))
 
             self.ports = ports
             return ports
@@ -73,8 +67,11 @@ def load(self, action, file_to_load, com_port):
         self.loading = True
 
         executable = self.appdir + self.propeller_load_executables[platform.system()]
+        self.logger.debug('Loader executable path is: %s)', executable)
+
         executing_data = [executable, "-r"]
         executing_data.extend(self.load_actions[action]["compile-options"])
+        self.logger.debug('Loader commandline is: %s', executing_data)
 
         if com_port is not None:
             self.logger.info("Talking to com port.")

README.md

@@ -15,6 +15,17 @@ BlocklyPropClient is written using Python v2.7.
 
 Installations are self-contained; no extra dependencies are required except for USB drivers for Parallax development boards.
 
+## Running on Linux
+You will first have to install some python dependencies before you can run BlocklyPropClient.
+
+* ws4py
+* pyserial
+* cherrypy
+
+These can all be installed using the auto-installer by running the following in the terminal: 'python InstallDependencies.py'
+
+Then execute: python BlocklyPropClient.py
+
 
 # Developers
 ------------