Python3

.gitignore

@@ -106,3 +106,4 @@ ENV/
 
 # from developer leogaube
 /useful_commands
+.DS_Store

frame.py

@@ -45,7 +45,7 @@
 parser = argparse.ArgumentParser(description="PhotoFrame - A RaspberryPi based digital photoframe",
                                  formatter_class=argparse.ArgumentDefaultsHelpFormatter)
 parser.add_argument('--logfile', default=None, help="Log to file instead of stdout")
-parser.add_argument('--port', default=7777, type=int, help="Port to listen on")
+parser.add_argument('--port', default=80, type=int, help="Port to listen on")
 parser.add_argument('--countdown', default=10, type=int, help="Set seconds to countdown before starting slideshow")
 parser.add_argument('--listen', default="0.0.0.0", help="Address to listen on")
 parser.add_argument('--debug', action='store_true', default=False, help='Enable loads more logging')
@@ -143,7 +143,7 @@ def setupWebserver(self, listen, port):
         self._loadRoute('keywords', 'RouteKeywords', self.serviceMgr, self.slideshow)
         self._loadRoute('orientation', 'RouteOrientation', self.cacheMgr)
         self._loadRoute('overscan', 'RouteOverscan', self.cacheMgr)
-        self._loadRoute('maintenance', 'RouteMaintenance', self.emulator, self.driverMgr, self.slideshow)
+        self._loadRoute('maintenance', 'RouteMaintenance', self.emulator, self.driverMgr, self.slideshow, self.timekeeperMgr)
         self._loadRoute('details', 'RouteDetails', self.displayMgr, self.driverMgr,
                         self.colormatch, self.slideshow, self.serviceMgr, self.settingsMgr)
         self._loadRoute('upload', 'RouteUpload', self.settingsMgr, self.driverMgr)

modules/colormatch.py

@@ -17,8 +17,10 @@
 import smbus
 import time
 import os
+import re
 import subprocess
 import logging
+from . import debug
 
 
 class colormatch(Thread):
@@ -27,8 +29,18 @@ def __init__(self, script, min=None, max=None):
         self.daemon = True
         self.sensor = False
         self.temperature = None
+        self.default_temp = 3350.0
         self.lux = None
+        self.sensor_scale = 6.0  # ToDo - set this from Configuration - This is (GA) from AMS App note DN40
+        self.lux_scale = 1.0  # ToDo - set this from Configuration - Monitor Brightness = lux * lux_scale
         self.script = script
+        self.mon_adjust = False
+        self.mon_min_bright = 0.0  # Can't get this through ddc - assume 0
+        self.mon_max_bright = 0.0
+        self.mon_min_temp = 0.0
+        self.mon_max_temp = 0.0
+        self.mon_temp_inc = 0.0
+        self.mon_max_inc = 126.0  # Can't get this through ddc - has to be set by hand for now
         self.void = open(os.devnull, 'wb')
         self.min = min
         self.max = max
@@ -38,6 +50,40 @@ def __init__(self, script, min=None, max=None):
             self.hasScript = os.path.exists(self.script)
         else:
             self.hasScript = False
+        if os.path.exists("/usr/bin/ddcutil") and os.path.exists("/dev/i2c-2"):
+            # Logic to read monitor adjustment ranges and increments from ddc channel
+            # This is written assuming the monitor is a HP Z24i - If the regex strings differ for other
+            #    monitors, then this section may need to be replicated and "ddcutil detect" used to
+            #    determine the monitor type.  At that point, it may be better to have a new module -
+            #    similar to self.script - or a data file/structure can be created with the regex expressions for
+            #    various monitors
+            self.mon_adjust = True
+            try:
+                temp_str = debug.subprocess_check_output(['/usr/bin/ddcutil', 'getvcp', '0B'])
+                self.mon_temp_inc = int(re.search('([0-9]*) (degree)', temp_str).group(1))
+                logging.debug('Monitor temp increment is %i' % self.mon_temp_inc)
+            except:
+                logging.exception('ddcutil is present but not getting temp increment from monitor. ')
+                self.mon_adjust = False
+            try:
+                temp_str = debug.subprocess_check_output(['/usr/bin/ddcutil', 'getvcp', '0C'])
+                self.mon_min_temp = int(re.search('([0-9]*) (\\+)', temp_str).group(1))
+                logging.debug('Monitor min temp is %i' % self.mon_min_temp)
+            except:
+                logging.exception('ddcutil is present but not getting min temp status from monitor. ')
+                self.mon_adjust = False
+            try:
+                temp_str = debug.subprocess_check_output(['/usr/bin/ddcutil', 'getvcp', '10'])
+                self.mon_max_bright = int(re.search('(max value \\= *) ([0-9]*)', temp_str).group(2))
+                logging.debug('Monitor max brightness is %i' % self.mon_max_bright)
+            except:
+                logging.exception('ddcutil is present but not getting brightness info from monitor')
+                self.mon_adjust = False
+            if self.mon_adjust == True:
+                logging.info('Monitor adjustments enabled')
+        else:
+            logging.debug('/usr/bin/ddcutil or /dev/i2c-2 not found - cannot adjust monitor')
+            self.mon_adjust = False
 
         self.start()
 
@@ -66,7 +112,7 @@ def setUpdateListener(self, listener):
     def adjust(self, filename, filenameTemp, temperature=None):
         if not self.allowAdjust or not self.hasScript:
             return False
-
+            
         if self.temperature is None or self.sensor is None:
             logging.debug('Temperature is %s and sensor is %s', repr(self.temperature), repr(self.sensor))
             return False
@@ -92,48 +138,82 @@ def adjust(self, filename, filenameTemp, temperature=None):
             logging.exception('Unable to run %s:', self.script)
             return False
 
-    # The following function (_temperature_and_lux) is lifted from the
-    # https://github.com/adafruit/Adafruit_CircuitPython_TCS34725 project and
-    # is under MIT license, this license ONLY applies to said function and no
-    # other part of this project.
-    #
-    # The MIT License (MIT)
-    #
-    # Copyright (c) 2017 Tony DiCola for Adafruit Industries
+    def adjustableMonitor(self):
+        return self.mon_adjust
+
+    def setMonBright(self):
+        brightness = self.lux * self.lux_scale
+        if brightness > self.mon_max_bright:
+            brightness = self.mon_max_bright
+        if brightness < self.mon_min_bright:
+            brightness = self.mon_min_bright
+        try:
+            debug.subprocess_call(['/usr/bin/ddcutil', 'setvcp', '10', repr(int(brightness))])
+            logging.debug('setMonBright set monitor to %s percent' % repr(int(brightness)))
+        except:
+            logging.debug('setMonBright failed to set monitor to %s' % repr(int(brightness)))
+            return False
+        return True
+
+    def setMonTemp(self):
+        temp = self.temperature
+        if self.max:
+            if temp > self.max:
+                temp = self.max
+        if self.min:
+            if temp < self.min:
+                temp = self.min
+        if temp > self.mon_max_temp:
+            temp = self.mon_max_temp
+        if temp < self.mon_min_temp:
+            temp = self.mon_min_temp
+        tempset = int((temp - self.mon_min_temp)/self.mon_temp_inc)
+        if tempset > self.mon_max_inc:
+            tempset = self.mon_max_inc
+        try:
+            debug.subprocess_call(['/usr/bin/ddcutil', 'setvcp', '0C', repr(tempset)])
+            logging.debug('setMonTempt set monitor to %s temp' % repr(temp))
+        except:
+            logging.debug('setMonTemp failed to set monitor to %s' % repr(temp))
+            return False
+        return True
+
+    ###################################################################################
+    # It seems that there is a widespread sharing of incorrect code to read the TCS3472.
     #
-    # Permission is hereby granted, free of charge, to any person obtaining a copy
-    # of this software and associated documentation files (the "Software"), to deal
-    # in the Software without restriction, including without limitation the rights
-    # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-    # copies of the Software, and to permit persons to whom the Software is
-    # furnished to do so, subject to the following conditions:
+    # The following is based on the equations and coefficients provided by the manufacturer
+    # (AMS) in their Application Note DN40-Rev 1.0 Appendix I
+    # While it's hard to test this without expensive equipment, I was able to get a temp reading
+    # very close to 2700K using LED lighting from a bulb with the same spec.
     #
-    # The above copyright notice and this permission notice shall be included in
-    # all copies or substantial portions of the Software.
+    # Note, if a sensor other than a TCS3472 is used, these will no longer be correct.
+    # However this is correct for TCS34721, TCS34723, TCS34725 and TCS34727
     #
-    # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-    # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-    # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-    # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-    # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-    # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-    # THE SOFTWARE.
-    def _temperature_and_lux(self, data):
-        """Convert the 4-tuple of raw RGBC data to color temperature and lux values. Will return
-           2-tuple of color temperature and lux."""
-        r, g, b, _ = data
-        x = -0.14282 * r + 1.54924 * g + -0.95641 * b
-        y = -0.32466 * r + 1.57837 * g + -0.73191 * b
-        z = -0.68202 * r + 0.77073 * g + 0.56332 * b
-        divisor = x + y + z
-        n = (x / divisor - 0.3320) / (0.1858 - y / divisor)
-        cct = 449.0 * n**3 + 3525.0 * n**2 + 6823.3 * n + 5520.33
-        return cct, y
-    ###################################################################################
-
-    # This function is mostly based of the example provided by Brad Berkland's blog:
-    # http://bradsrpi.blogspot.com/2013/05/tcs34725-rgb-color-sensor-raspberry-pi.html
+    # Finally, the vairable sensor_scale is used to compensate for light attenuation for sensors
+    # behind glass, or in some cases behind acrylic rods.
     #
+    def _temperature_and_lux(self, r, g, b, c, tms_gain, tms_atime):
+        itime = (256 - tms_atime) * 2.4
+        gain_table = {0: 1, 1: 4, 2: 16, 3: 60}
+        gain = gain_table[tms_gain]
+        if (self.sensor_scale <= 0):
+            cpl = 1.0  # protect from bad settings
+        else:
+            cpl = (gain * itime) / (self.sensor_scale * 310)
+        ir = float(r + g + b - c)/2
+        rp = float(r) - ir
+        gp = float(g) - ir
+        bp = float(b) - ir
+        lux = ((.136 * rp) + gp - (.444 * bp))/cpl
+        if (lux < 0):
+            lux = 0
+        if (rp == 0):
+            temp = self.default_temp
+        else:
+            temp = (3810 * ( bp / rp )) + 1391
+        return temp, lux
+
+
     def run(self):
         try:
             bus = smbus.SMBus(1)
@@ -149,41 +229,59 @@ def run(self):
             logging.info('ColorSensor not available')
             return
         ver = bus.read_byte(0x29)
-        # version # should be 0x44
-        if ver == 0x44:
+        # version # should be 0x44 or 0x4D
+        if (ver == 0x44) or (ver == 0x4D):
             # Make sure we have the needed script
-            if not os.path.exists(self.script):
+            if not (os.path.exists(self.script) or self.mon_adjust):
                 logging.info(
-                    'No color temperature script, download it from '
+                    'No color temperature script or adjustable monitor detected, download the script from '
                     'http://www.fmwconcepts.com/imagemagick/colortemp/index.php and save as "%s"' % self.script
                 )
                 self.allowAdjust = False
-            self.allowAdjust = True
-
+            else:
+                self.allowAdjust = True
+            self.sensor = True
+
+            # Configure Sensor
+            # Todo - The app note suggests checking the clear value, and if it's less than 100,
+            # to change the gain to increase sensitivity.  That's not yet implemented here.
+            # Lok here for algorithm:
+            # https://ams.com/documents/20143/36005/AmbientLightSensors_AN000171_2-00.pdf/9d1f1cd6-4b2d-1de7-368f-8b372f3d8517
+            #
+            tms_gain = 0x1    # Must be 0, 1, 2, 3 which become 1x, 4x, 16x, and 60x gain
+            tms_atime = 0x0   # Must be 0xFF, 0xF6, 0xDB, 0xC0, 0x00 which become 2.4, 24, 101, 154, 700ms
+            tms_wtime = 0xFF  # Must be 0xFF, 0xAB, 0x00 which become 2.4, 204 614ms
+
             bus.write_byte(0x29, 0x80 | 0x00)  # 0x00 = ENABLE register
             bus.write_byte(0x29, 0x01 | 0x02)  # 0x01 = Power on, 0x02 RGB sensors enabled
+            bus.write_byte(0x29, 0x80 | 0x01)  # 0x01 = ATIME (Integration time) register
+            bus.write_byte(0x29, tms_atime)
+            bus.write_byte(0x29, 0x80 | 0x03)  # 0x03 = WTIME (Wait) register
+            bus.write_byte(0x29, tms_wtime)
+            bus.write_byte(0x29, 0x80 | 0x0F)  # 0x0F = Control register
+            bus.write_byte(0x29, tms_gain)
+
+
             bus.write_byte(0x29, 0x80 | 0x14)  # Reading results start register 14, LSB then MSB
-            self.sensor = True
             logging.debug('TCS34725 detected, starting polling loop')
             while True:
                 data = bus.read_i2c_block_data(0x29, 0)
                 clear = clear = data[1] << 8 | data[0]
                 red = data[3] << 8 | data[2]
                 green = data[5] << 8 | data[4]
                 blue = data[7] << 8 | data[6]
-                if red > 0 and green > 0 and blue > 0 and clear > 0:
-                    temp, lux = self._temperature_and_lux((red, green, blue, clear))
-                    self.temperature = temp
-                    self.lux = lux
-                else:
-                    # All zero Happens when no light is available, so set temp to zero
-                    self.temperature = 0
-                    self.lux = 0
-
+
+                self.temperature, self.lux = self._temperature_and_lux(red, green, blue, clear, tms_gain, tms_atime)
+
                 if self.listener:
                     self.listener(self.temperature, self.lux)
+
+                if self.mon_adjust:
+                    logging.debug('Adjusting monitor to %3.2f lux and %5.0fK temp' % (self.lux, self.temperature))
+                    self.setMonBright()
+                    self.setMonTemp()
 
-                time.sleep(1)
+                time.sleep(15)  # Not sure how often it's acceptable to change monitor settings
         else:
             logging.info('No TCS34725 color sensor detected, will not compensate for ambient color temperature')
             self.sensor = False

modules/debug.py

@@ -35,11 +35,13 @@ def _stringify(args):
 
 def subprocess_call(cmds, stderr=None, stdout=None):
     return subprocess.call(cmds, stderr=stderr, stdout=stdout)
-
+    # TODO  Relocate to helper?  Convert to subprocess.run?  Add exception to collect output
+    # in an error log.  Add debug logging option as well?  Add **kwargs
 
 def subprocess_check_output(cmds, stderr=None):
     return subprocess.check_output(cmds, stderr=stderr).decode("utf-8")
-
+    # TODO basically same treatment as suborocess_call.  Although, with using subprocess.run,
+    # check output or not is just another arg.  So, this might just set that arg and subprocess_call.
 
 def stacktrace():
     title = 'Stacktrace of all running threads'
@@ -60,7 +62,8 @@ def logfile(all=False):
     if all:
         title = 'Last 100 lines from the system log (/var/log/syslog)'
         cmd = 'tail -n 100 /var/log/syslog'
-    lines = subprocess.check_output(cmd, shell=True)
+    lines = subprocess.check_output(cmd, shell=True).decode("utf-8")
+    # TODO - convert this to use a common subprocess._check_output dunction
     if lines:
         lines = lines.splitlines()
     suffix = '(size of logfile %d bytes, created %s)' % (stats.st_size,
@@ -70,7 +73,8 @@ def logfile(all=False):
 
 def version():
     title = 'Running version'
-    lines = subprocess.check_output('git log HEAD~1..HEAD ; echo "" ; git status', shell=True)
+    lines = subprocess.check_output('git log HEAD~1..HEAD ; echo "" ; git status', shell=True).decode("utf-8")
+    # TODO - convert this to use a common subprocess_check_output function
     if lines:
         lines = lines.splitlines()
     return (title, lines, None)

modules/display.py

@@ -184,7 +184,7 @@ def message(self, message, showConfig=True):
 
         url = 'caption:'
         if helper.getDeviceIp() is not None and showConfig:
-            url = 'caption:Configuration available at http://%s:7777' % helper.getDeviceIp()
+            url = 'caption:Configuration available at http://%s' % helper.getDeviceIp()
 
         args = [
             'convert',
@@ -229,8 +229,6 @@ def image(self, filename):
         args = [
             'convert',
             filename + '[0]',
-            '-resize',
-            '%dx%d' % (self.width, self.height),
             '-background',
             'black',
             '-gravity',