Merge branch 'release/0.3.4'

Author: elcojacobs

.gitignore

@@ -32,3 +32,4 @@ sftp-config.json
 requirements.txt
 !.gitignore
 .idea/
+utils/downloads/

BrewPiProcess.py

@@ -72,6 +72,8 @@ def quit(self):
             else:
                 print "Could not connect to socket of BrewPi process, maybe it just started and is not listening yet."
                 print "Could not send quit message to BrewPi instance with pid %d!" % self.pid
+                print "Killing it instead!"
+                self.kill()
                 return False
 
     def kill(self):
@@ -115,7 +117,14 @@ def update(self):
         Returns: list of BrewPiProcess objects
         """
         bpList = []
-        matching = [p for p in psutil.process_iter() if any('python' in p.name() and 'brewpi.py'in s for s in p.cmdline())]
+        matching = []
+
+        # some OS's (OS X) do not allow processes to read info from other processes. 
+        try:
+            matching = [p for p in psutil.process_iter() if any('python' in p.name() and 'brewpi.py'in s for s in p.cmdline())]
+        except psutil.AccessDenied:
+            pass
+
         for p in matching:
             bp = self.parseProcess(p)
             bpList.append(bp)

BrewPiUtil.py

@@ -97,7 +97,8 @@ def scriptPath():
 def removeDontRunFile(path='/var/www/do_not_run_brewpi'):
     if os.path.isfile(path):
         os.remove(path)
-        print "BrewPi set to be automatically restarted by cron"
+        if not sys.platform.startswith('win'): # cron not available
+            print "BrewPi script will restart automatically."
     else:
         print "File do_not_run_brewpi does not exist at " + path
 
@@ -107,17 +108,28 @@ def setupSerial(config):
     conn = None
     port = config['port']
     dumpSerial = config.get('dumpSerial', False)
+
+    error1 = None
+    error2 = None
     # open serial port
-    try:
-        ser = serial.Serial(port, 57600, timeout=0.1)  # use non blocking serial.
-    except (OSError, serial.SerialException) as e:
-        logMessage("Error opening serial port. Trying alternative serial port {0}.\n({1})".format(config['altport'], str(e)))
+    tries = 0
+    while ser is None and tries < 10:
         try:
-            port = config['altport']
+            port = config['port']
             ser = serial.Serial(port, 57600, timeout=0.1)  # use non blocking serial.
         except (OSError, serial.SerialException) as e:
-            logMessage("Error opening alternative serial port. Script will exit. Is your controller connected via USB?\n({0})".format(str(e)))
-            exit(1)
+            error1 = '{0}.\n({1})'.format(port, str(e))
+            try:
+                port = config['altport']
+                ser = serial.Serial(port, 57600, timeout=0.1)  # use non blocking serial.
+
+            except (OSError, serial.SerialException) as e:
+                error2 = '{0}.\n({1})'.format(port, str(e))
+
+        tries += 1
+        if not ser:
+            time.sleep(1)
+
 
     # yes this is monkey patching, but I don't see how to replace the methods on a dynamically instantiated type any other way
     if dumpSerial:
@@ -134,4 +146,14 @@ def writeAndDump(data):
             sys.stderr.write(data)
         ser.read = readAndDump
         ser.write = writeAndDump
+
+    if not ser:
+        logMessage("Error opening serial port {0}:".format(error1))
+        logMessage("Error opening alternative serial port {0}:".format(error2))
+
     return ser, conn
+
+# remove extended ascii characters from string, because they can raise UnicodeDecodeError later
+def asciiToUnicode(s):
+    s = s.replace(chr(0xB0),'&deg')
+    return unicode(s, 'ascii', 'ignore')

LogMessages.h

@@ -23,7 +23,7 @@
 	A copy of this file is included with the python script, so it can parse it to extract the log strings.
 	The python script receives the messages as a few IDs and values in a JSON string.
 	It uses this file to expand that to the full message.
-	Not storing the full strings, but only the ID on the Arduino saves a lot of PROGMEM space.
+	Not storing the full strings, but only the ID on the controller saves a lot of PROGMEM space.
 	At startup the python script extracts the version number from this file and compares it to its own local copy.
 	It will give a warning when the two strings do not match.
 */
@@ -57,7 +57,7 @@ enum errorMessages{
 enum warningMessages{
 // PiLink.cpp
 	MSG(WARNING_COULD_NOT_PROCESS_SETTING, "Could not process setting"),
-	MSG(WARNING_INVALID_COMMAND, "Invalid command received by Arduino: %c", character),
+	MSG(WARNING_INVALID_COMMAND, "Invalid command received by controller: %c", character),
 
 // OneWireTempSensor.cpp	
 	MSG(WARNING_TEMP_SENSOR_DISCONNECTED, "Temperature sensor disconnected pin %d, address %s", pinNr, addressString),

MigrateSettings.py

@@ -0,0 +1,198 @@
+# Copyright 2013 BrewPi
+# This file is part of BrewPi.
+
+# BrewPi is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# BrewPi is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with BrewPi.  If not, see <http://www.gnu.org/licenses/>.
+
+from collections import namedtuple, OrderedDict
+from distutils.version import LooseVersion
+import unittest
+
+# SetttingMigrate containes 3 values:
+# key: the JSON key for the version in maxVersion
+# minVersion: the minimum version to restore from. Use 0 when all are valid.
+# maxVersion: the maximum version to restore to. Use 1000 when the most current release is still valid
+# alias: alternative keys from previous versions that should be interpreted as new key
+#
+SettingMigrate = namedtuple('SettingMigrate', ['key', 'minVersion', 'maxVersion', 'aliases'])
+
+MigrateSettingsDefaultRestoreValidity = [
+    SettingMigrate('tempFormat', '0', '1000', []),
+    SettingMigrate('tempSetMin', '0', '1000', []),
+    SettingMigrate('tempSetMax', '0', '1000', []),
+    SettingMigrate('Kp', '0', '1000', []),
+    SettingMigrate('Ki', '0', '1000', []),
+    SettingMigrate('Kd', '0', '1000', []),
+    SettingMigrate('iMaxErr', '0', '1000', []),
+    SettingMigrate('pidMax', '0.2.4', '1000', []),
+    SettingMigrate('idleRangeH', '0', '1000', []),
+    SettingMigrate('idleRangeL', '0', '1000', []),
+    SettingMigrate('heatTargetH', '0', '1000', []),
+    SettingMigrate('heatTargetL', '0', '1000', []),
+    SettingMigrate('coolTargetH', '0', '1000', []),
+    SettingMigrate('coolTargetL', '0', '1000', []),
+    SettingMigrate('maxHeatTimeForEst', '0', '1000', []),
+    SettingMigrate('maxCoolTimeForEst', '0', '1000', []),
+    SettingMigrate('fridgeFastFilt', '0.2.0', '1000', []),
+    SettingMigrate('fridgeSlowFilt', '0.2.0', '1000', []),
+    SettingMigrate('fridgeSlopeFilt', '0.2.0', '1000', []),
+    SettingMigrate('beerFastFilt', '0.2.0', '1000', []),
+    SettingMigrate('beerSlowFilt', '0.2.3', '1000', []),
+    SettingMigrate('beerSlopeFilt', '0.2.3', '1000', []),
+    SettingMigrate('lah', '0', '1000', []),
+    SettingMigrate('hs', '0', '1000', []),
+    SettingMigrate('heatEst', '0', '1000', []),
+    SettingMigrate('coolEst', '0', '1000', []),
+    SettingMigrate('fridgeSet', '0', '1000', []),
+    SettingMigrate('beerSet', '0', '1000', []),
+    SettingMigrate('mode', '0', '1000', [])
+]
+
+class MigrateSettings:
+
+    def __init__(self, rv = None):
+        '''
+        :param rv: list of SettingMigrate namedtuples in the order they need to be restored
+        '''
+        if(rv == None):
+            self.restoreValidity = MigrateSettingsDefaultRestoreValidity
+        else:
+            self.restoreValidity = rv
+
+    def getKeyValuePairs(self, oldSettings, oldVersion, newVersion):
+        '''
+        Settings are in order to restore them and are read from the old settings
+        Versions are compared to see which settings are still considered valid
+
+        Keyword arguments:
+        :param oldSettings: a dict of settings
+        :param oldVersion: a string with the old version number
+        :param newVersion: a string with the new version number
+        :return keyValuePairs: OrderedDict of settings to restore
+        :return oldSettings: settings that are not restored
+        '''
+        keyValuePairs = OrderedDict()
+        oldSettingsCopy = oldSettings.copy() # get copy because we are removing items from the dict
+        for setting in self.restoreValidity:
+            for oldKey in [setting.key] + setting.aliases:
+                if oldKey in oldSettingsCopy:
+                    if (LooseVersion(oldVersion) >= LooseVersion(setting.minVersion) and
+                            LooseVersion(newVersion) <= LooseVersion(setting.maxVersion)):
+                        keyValuePairs[setting.key] = oldSettingsCopy.pop(oldKey)
+                        break
+        return keyValuePairs, oldSettingsCopy
+
+
+
+class TestSettingsMigrate(unittest.TestCase):
+
+    def testMinVersion(self):
+        ''' Test if key is omitted when oldVersion < minVersion'''
+        mg = MigrateSettings([
+            SettingMigrate('key1', '0.2.0', '1000', []),
+            SettingMigrate('key2', '0.1.1', '1000', []),
+            ])
+        oldSettings = {'key1': 1, 'key2': 2}
+        restored, omitted = mg.getKeyValuePairs(oldSettings, '0.1.8', '0.3.0')
+        self.assertEqual(restored,
+                         OrderedDict([('key2', 2)]),
+                         "Should only return key2")
+
+
+    def testMaxVersion(self):
+        ''' Test if key is omitted when newVersion > maxVersion'''
+        mg = MigrateSettings([
+            SettingMigrate('key1', '0.2.0', '0.3.0', []),
+            SettingMigrate('key2', '0.1.1', '1000', []),
+            ])
+        oldSettings = {'key1': 1, 'key2': 2}
+        restored, omitted = mg.getKeyValuePairs(oldSettings, '0.3.0', '0.4.0')
+        self.assertEqual(restored,
+                         OrderedDict([('key2', 2)]),
+                         "Should only return key2")
+
+    def testReturningNotRestored(self):
+        mg = MigrateSettings([
+            SettingMigrate('key1', '0.2.0', '0.3.0', []),
+            SettingMigrate('key2', '0.1.1', '1000', []),
+            ])
+        oldSettings = {'key1': 1, 'key2': 2}
+        restored, omitted = mg.getKeyValuePairs(oldSettings, '0.3.0', '0.4.0')
+        self.assertEqual(restored,
+                         OrderedDict([('key2', 2)]),
+                         "Should only return key2")
+
+
+
+    def testAliases(self):
+        ''' Test if aliases for old keys result in the new key being returned with the old value'''
+        mg = MigrateSettings([ SettingMigrate('key1', '0', '1000', ['key1a', 'key1b'])])
+        oldSettings = {'key1a': 1}
+        restored, omitted = mg.getKeyValuePairs(oldSettings, '1', '1')
+        self.assertEqual(restored, OrderedDict([('key1', 1)]))
+
+
+    def testBrewPiFilters(self):
+        ''' Test if filters are only restored when old version > 0.2. The filter format was different earlier'''
+        mg = MigrateSettings()
+        oldSettings = {'fridgeFastFilt': 4}
+        for oldVersion in ['0.1.0', '0.1.9', '0.1', '0.1.9.1']:
+            restored, omitted = mg.getKeyValuePairs(oldSettings, oldVersion, '0.2.8')
+            self.assertFalse('fridgeFastFilt' in restored,
+                            "Filter settings should be omitted when older than version 0.2.0" +
+                             ", failed on version " + oldVersion)
+        for oldVersion in ['0.2.0', '0.2.4', '0.3', '1.0']:
+            restored, omitted = mg.getKeyValuePairs(oldSettings, oldVersion, '2.0')
+            self.assertTrue('fridgeFastFilt' in restored,
+                            "Filter settings should be used when restoring from newer than version 0.2.0" +
+                            ", failed on version " + oldVersion)
+
+
+    def testPidMax(self):
+        ''' Test if filters are only restored when old version > 0.2.4 It was not outputed correctly earlier'''
+        mg = MigrateSettings()
+        oldSettings = {'pidMax': 10.0}
+        for oldVersion in ['0.1.0', '0.2', '0.2.3']:
+            restored, omitted = mg.getKeyValuePairs(oldSettings, oldVersion, '0.2.8')
+            self.assertFalse('pidMax' in restored,
+                            "pidMax can only be trusted from version 0.2.4 or higher" +
+                             ", failed on version " + oldVersion)
+        for oldVersion in ['0.2.4', '0.2.5', '0.3', '1.0']:
+            restored, omitted = mg.getKeyValuePairs(oldSettings, oldVersion, '2.0')
+            self.assertTrue('pidMax' in restored,
+                            "pidMax should be restored when restoring form version " + oldVersion)
+
+
+    def testAllBrewPiSettings(self):
+        ''' Test that when restoring from version 0.2.7 to 0.2.7 all settings are migrated'''
+        from random import randint
+
+        mg = MigrateSettings()
+        oldSettings = dict()
+        for setting in mg.restoreValidity:
+            oldSettings[setting.key] = randint(0,100) # use random integer for old settings
+        restored, omitted = mg.getKeyValuePairs(oldSettings, '0.2.7', '0.2.7')
+
+        self.assertEqual(len(restored), len(oldSettings), "old and new settings should have same nr or items")
+
+        count = 0
+        for setting in restored:
+            if count == 0:
+                self.assertEqual(setting, 'tempFormat', "tempFormat should be restored as first setting")
+            self.assertEqual(restored[setting], oldSettings[setting], "old value and restored value do not match")
+            count += 1
+
+
+if __name__ == "__main__":
+    unittest.main()
+