Merge branch 'develop'

Author: elcojacobs

BrewPiUtil.py

@@ -126,7 +126,7 @@ def setupSerial(config, baud_rate=57600, time_out=0.1):
             else:
                 port = portSetting
             try:
-                ser = serial.Serial(port, baudrate=baud_rate, timeout=time_out)
+                ser = serial.Serial(port, baudrate=baud_rate, timeout=time_out, writeTimeout=0)
                 if ser:
                     break
             except (IOError, OSError, serial.SerialException) as e:

brewpi.py

@@ -77,7 +77,7 @@ def printStdErr(*objs):
 # Settings will be read from controller, initialize with same defaults as controller
 # This is mainly to show what's expected. Will all be overwritten on the first update from the controller
 
-compatibleHwVersion = "0.2.4"
+compatibleHwVersion = "0.4.0"
 
 # Control Settings
 cs = dict(mode='b', beerSet=20.0, fridgeSet=20.0)

programController.py

@@ -220,7 +220,7 @@ def program(self, hexFile, system1File, system2File, restoreWhat):
 
             myDir = os.path.dirname(os.path.abspath(__file__))
             flashDfuPath = os.path.join(myDir, 'utils', 'flashDfu.py')
-            command = sys.executable + ' ' + flashDfuPath + " --autodfu --file={0}".format(os.path.dirname(hexFile))
+            command = sys.executable + ' ' + flashDfuPath + " --autodfu --noreset --file={0}".format(os.path.dirname(hexFile))
             if platform.system() == "Linux":
                 command =  'sudo ' + command
 
@@ -268,12 +268,13 @@ def program(self, hexFile, system1File, system2File, restoreWhat):
 
             printStdErr("Waiting for device to reset.")
 
+        time.sleep(10) # give time to reboot
+
         if not self.open_serial_with_retry(self.config, 57600, 0.2):
             printStdErr("Error opening serial port after programming. Program script will exit. Settings are not restored.")
             printStdErr("If your device stopped working, use flashDfu.py to restore it.")
             return False
 
-        time.sleep(1)
         self.fetch_new_version()
         self.reset_settings()
         if self.restoreSettings or self.restoreDevices:

utils/flashDfu.py

@@ -42,15 +42,16 @@
 # Read in command line arguments
 try:
     opts, args = getopt.getopt(sys.argv[1:], "hf:t:ma",
-                               ['help', 'file=', 'multi', 'tag=', 'testmode', 'autodfu', 'testmode'])
+                               ['help', 'file=', 'system=', 'multi', 'tag=', 'testmode', 'autodfu', 'testmode', 'noreset'])
 except getopt.GetoptError:
-    print "Unknown parameter, available Options: --file, --multi, --tag --autodfu --testmode"
+    print "Unknown parameter, available Options: --file, --system, --multi, --tag --autodfu --testmode --noreset"
 
     sys.exit()
 
 multi = False
 testMode = False
 autoDfu = False
+noReset = False
 tag = None
 # binaries for system update
 system1 = None
@@ -64,31 +65,46 @@
     if o in ('-h', '--help'):
         print "\n Available command line options: "
         print "--help: print this help message"
-        print "--file: path to .bin file to flash instead of the latest release on GitHub"
         print "--tag: specify which tag to download from github"
+        print "--file: path to .bin file to flash instead of the latest release on GitHub.\n" \
+              "If this is a directory, search for binary and system update files."
+        print "--system: path to system binaries to update the system firmware on the photon."
         print "--multi: keep the script alive to flash multiple devices"
         print "--autodfu: automatically reboot photon in DFU mode by opening serial port at 14400 baud"
         print "--testmode: set controller o test mode after flashing"
+        print "--noreset: do not reset EEPROM after flashing"
 
         exit()
-    # supply a config file
+    # supply a binary file
     if o in ('-f', '--file'):
         print("Using local files instead of downloading a release. \n")
         if os.path.isdir(a):
             for file in os.listdir(a):
                 if all(x in file for x in ['brewpi', '.bin']):
                     binFile = os.path.join(os.path.abspath(a), file)
+        else:
+            binFile = os.path.abspath(a)
+        if not os.path.exists(binFile):
+            print('ERROR: Binary file "%s" was not found!' % binFile)
+            exit(1)
+    # supply a system update directory
+    if o in ('-s', '--system'):
+        print("Using local files for system update instead of downloading from GitHub.\n")
+        if os.path.isdir(a):
+            for file in os.listdir(a):
                 if all(x in file for x in ['system', 'part1', '.bin']):
                     system1 = os.path.join(os.path.abspath(a), file)
                 if all(x in file for x in ['system', 'part2', '.bin']):
                     system2 = os.path.join(os.path.abspath(a), file)
         else:
-            binFile = os.path.abspath(a)
-        if not os.path.exists(binFile):
-            print('ERROR: Binary file(s) "%s" was not found!' % binFile)
+            print('ERROR: System binaries location {0} is not a directory!' % a)
+        if not os.path.exists(system1):
+            print('ERROR: System binary 1 "%s" was not found!' % binFile)
             exit(1)
-        if os.path.exists(system1) and os.path.exists(system2):
-            print('System update files found, will update system part before flashing user binary. \n')
+        if not os.path.exists(system2):
+            print('ERROR: System binary 2 "%s" was not found!' % binFile)
+            exit(1)
+
     # send quit instruction to all running instances of BrewPi
     if o in ('-m', '--multi'):
         multi = True
@@ -102,6 +118,8 @@
     if o in ('-a', '--autodfu'):
         autoDfu = True
         print "Will automatically reboot newly detected photons into DFU mode"
+    if o in ('--noreset'):
+        noReset = True
 
 dfuPath = "dfu-util"
 # check whether dfu-util can be found
@@ -179,10 +197,12 @@
 
         # download latest binary from GitHub if file not specified
         if not binFile:
-            print "Downloading latest firmware..."
             if tag is None:
+                print "Downloading latest firmware..."
                 tag = releases.getLatestTag()
                 print "Latest stable version on GitHub: " + tag
+            else:
+                print "Downloading release " + tag
 
             binFile = releases.getBin(tag, [type, 'brewpi', '.bin'])
             if binFile:
@@ -192,14 +212,22 @@
                 exit(1)
 
             if type == 'photon':
-                system1 = releases.getBin(tag, ['photon', 'system-part1', '.bin'])
-                system2 = releases.getBin(tag, ['photon', 'system-part2', '.bin'])
-
+                if LooseVersion(tag) > LooseVersion('0.2.11'): # 0.2.11 was compiled against non-forward compatible system
+                    latestSystemTag = releases.getLatestTagForSystem()
+                else:
+                    latestSystemTag = tag
+                print ("Updated system firmware for the photon found in release {0}".format(latestSystemTag))
+                system1 = releases.getBin(latestSystemTag, ['photon', 'system-part1', '.bin'])
+                system2 = releases.getBin(latestSystemTag, ['photon', 'system-part2', '.bin'])
                 if system1:
-                    print "Release contains updated system firmware for the photon"
+                    print "Downloaded new system firmware to:\n"
+                    print "{0} and\n".format(system1)
                     if not system2:
                         print "Error: system firmware part2 not found in release"
-                        exit()
+                        exit(1)
+                else:
+                    print "{0} and\n".format(system2)
+
 
         if binFile:
             if type == 'core':
@@ -218,26 +246,29 @@
                 p = subprocess.Popen(dfuPath + " -d 0x2B04:0xD006 -a 0 -s 0x80A0000:leave -D {0}".format(binFile), shell=True)
                 p.wait()
 
-            print "Programming done, now resetting EEPROM to defaults"
-            # reset EEPROM to defaults
-            configFile = util.scriptPath() + '/settings/config.cfg'
-            config = util.readCfgWithDefaults(configFile)
-            programmer = SerialProgrammer.create(config, "core")
+            print "Programming done"
 
-            # open serial port
-            print "Opening serial port"
-            retries = 10
-            while retries > 0:
-                if programmer.open_serial(config, 57600, 0.2):
-                    break
-                retries -= 1
-                time.sleep(1)
-            if retries > 0:
-                programmer.fetch_version("Success! ")
-                programmer.reset_settings(testMode)
-                serialPorts = autoSerial.detect_all_ports() # update serial ports here so device will not be seen as new
-            else:
-                print "Could not open serial port after programming"
+            if not noReset:
+                print "Now resetting EEPROM to defaults"
+                # reset EEPROM to defaults
+                configFile = util.scriptPath() + '/settings/config.cfg'
+                config = util.readCfgWithDefaults(configFile)
+                programmer = SerialProgrammer.create(config, type)
+
+                # open serial port
+                print "Opening serial port"
+                retries = 10
+                while retries > 0:
+                    if programmer.open_serial(config, 57600, 0.2):
+                        break
+                    retries -= 1
+                    time.sleep(1)
+                if retries > 0:
+                    programmer.fetch_version("Success! ")
+                    programmer.reset_settings(testMode)
+                    serialPorts = autoSerial.detect_all_ports() # update serial ports here so device will not be seen as new
+                else:
+                    print "Could not open serial port after programming"
         else:
             print "found DFU device, but no binary specified for flashing"
         if not multi:
@@ -261,8 +292,13 @@
                     ser = serial.Serial(port)
                     try:
                         ser.setBaudrate(14400) # this triggers a reboot in DFU mode
+                        time.sleep(1)
+                        ser.close()
                     except ValueError:
                         pass # because device reboots while reconfiguring an exception is thrown, ignore
-                    ser.close()
+                    if ser.isOpen():
+                        ser.close()
+                    ser.setBaudrate(57600) # don't leave serial port at 14400, or a reboot will be triggered later
+
 
     time.sleep(1)

utils/gitHubReleases.py

@@ -31,9 +31,8 @@ def download(self, url, path):
     def update(self):
         self.releases = json.load(urllib2.urlopen(self.url + "/releases"))
 
-    # writes .bin in release tagged with tag to directory
-    # defaults to ./downloads/tag_name/ as download location
-    def getBin(self, tag, wordsInFileName, path = None):
+    # Finds a binary for a certain tag on GitHub
+    def getBinUrl(self, tag, wordsInFileName):
         try:
             match = (release for release in self.releases if release["tag_name"] == tag).next()
         except StopIteration:
@@ -48,6 +47,12 @@ def getBin(self, tag, wordsInFileName, path = None):
             if all(word.lower() in urlFileName.lower() for word in wordsInFileName):
                 downloadUrl = url
 
+        return downloadUrl
+
+    # writes .bin in release tagged with tag to directory
+    # defaults to ./downloads/tag_name/ as download location
+    def getBin(self, tag, wordsInFileName, path=None):
+        downloadUrl = self.getBinUrl(tag, wordsInFileName)
         if not downloadUrl:
             return None
 
@@ -68,6 +73,16 @@ def getLatestTag(self):
                 break
         return release["tag_name"]
 
+    def getLatestTagForSystem(self):
+        for release in self.releases:
+            # search for stable release
+            tag = release["tag_name"]
+            if release["prerelease"] == True:
+                continue
+            if self.getBinUrl(tag, ['photon', 'system-part1', '.bin']):
+                return tag
+        return None
+
     def getTags(self):
         return self.releases[0]["tag_name"]
 

utils/updateFirmware.py

@@ -126,16 +126,19 @@ def updateFromGitHub(userInput = False, restoreSettings = True, restoreDevices =
         printStdErr("Error: Device family {0} not recognized".format(family))
         return -1
 
-
     if boardName == "Photon":
-        system1 = releases.getBin(tag, ['photon', 'system-part1', '.bin'])
-        system2 = releases.getBin(tag, ['photon', 'system-part2', '.bin'])
-        if system1:
-            printStdErr("Release contains updated system firmware for the photon")
-            if not system2:
-                printStdErr("Error: system firmware part2 not found in release")
-                return -1
-
+        latestSystemTag = releases.getLatestTagForSystem()
+        if hwVersion.isNewer(latestSystemTag):
+            printStdErr("Updated system firmware for the photon found in release {0}".format(latestSystemTag))
+            system1 = releases.getBin(latestSystemTag, ['photon', 'system-part1', '.bin'])
+            system2 = releases.getBin(latestSystemTag, ['photon', 'system-part2', '.bin'])
+            if system1:
+                printStdErr("Downloaded new system firmware to:\n")
+                printStdErr("{0} and\n".format(system1))
+                if not system2:
+                    printStdErr("{0}\n".format(system2))
+                    printStdErr("Error: system firmware part2 not found in release")
+                    return -1
 
     if localFileName:
         printStdErr("Latest firmware downloaded to " + localFileName)