colorcal.py

   1 #!/usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3 #
   4 # (c) Copyright 2003-2009 Hewlett-Packard Development Company, L.P.
   5 #
   6 # This program is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 2 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program; if not, write to the Free Software
  18 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 #
  20 # Author: Don Welch
  21 #
  22
  23 __version__ = '3.0'
  24 __title__ = 'Printer Cartridge Color Calibration Utility'
  25 __mod__ = 'hp-colorcal'
  26 __doc__ = "Perform color calibration on HPLIP supported inkjet printers. (Note: Not all printers require the use of this utility)."
  27
  28 # Std Lib
  29 import sys
  30 import re
  31 import getopt
  32 import operator
  33 import os
  34
  35 # Local
  36 from base.g import *
  37 from base import device, status, utils, maint, tui, module
  38 from prnt import cups
  39
  40
  41 def enterAlignmentNumber(letter, hortvert, colors, minimum, maximum):
  42     return tui.enter_range("Enter the best aligned value for line %s (%d-%d or q=quit): " %
  43         (letter, minimum, maximum), minimum, maximum)
  44
  45 def enterPaperEdge(maximum):
  46     return tui.enter_range("Enter numbered arrow that is best aligned with the paper edge (1-%d or q=quit): " %
  47         maximum, 1, maximum)
  48
  49 def colorAdj(line, maximum):
  50     return tui.enter_range("Enter the numbered box on line %s that is best color matched to the background color (1-%d or q=quit): " %
  51         (line, maximum), 1, maximum)
  52
  53 def colorCal():
  54     return tui.enter_range("""Enter the numbered image labeled "1" thru "7" that is best color matched to the image labeled "X""", 1, 7)
  55
  56 def colorCal2():
  57     return tui.enter_range("""Select the number between 1 and 81 of the numbered patch that best matches the background.""", 1, 81)
  58
  59 def invalidPen():
  60     log.error("Invalid cartridge(s) installed.\nPlease install valid cartridges and try again.")
  61
  62 def photoPenRequired():
  63     log.error("Photo cartridge not installed.\nPlease install the photo cartridge and try again.")
  64
  65 def photoPenRequired2():
  66     log.error("Photo cartridge or photo blue cartridge not installed.\nPlease install the photo (or photo blue) cartridge and try again.")
  67
  68
  69 def colorCal4():
  70     log.info("""Instructions:\n1. Hold the calibration page at arm's length in front of your eyes.
  71 2. Tilt the page away from you. Look at the two large squares, each containing colored patches. For each large square, find the colored path that most closely matches the background color. Each patch has an associated letter and number.
  72 """)
  73     values = [0, 0, 0, 0]
  74     ok = True
  75     while True:
  76         x = raw_input(log.bold("""Enter the letter ('A' thru 'N') and number (1 thru 14) for the GRAY plot (eg, "C5") or "q" to quit: """))
  77
  78         if x.lower().strip() == 'q':
  79             ok = False
  80             break
  81
  82         if x.lower().strip() == 'd': # use defaults
  83             values[0], values[1] = -1, -1
  84             break
  85
  86         if len(x) < 2:
  87             log.error("You must enter at least two characters (a letter and a number)")
  88             continue
  89
  90         if len(x) > 3:
  91             log.error('Enter only a single letter and a one or two digit number (eg, "C5").')
  92             continue
  93
  94         letter = x[0].lower()
  95
  96         if letter not in 'abcdefghijklmn':
  97             log.error("You must enter a letter 'A' thru 'N'")
  98             continue
  99
 100         try:
 101             number = int(x[1:])
 102         except ValueError:
 103             log.error("You must enter a letter 'A' thru 'N' followed by a number 1 thru 14.")
 104             continue
 105
 106         if number < 0 or number > 14:
 107             log.error("You must enter a letter 'A' thru 'N' followed by a number 1 thru 14.")
 108             continue
 109
 110         values[0] = ord(str(letter).upper()) - ord('A')
 111         values[1] = number - 1
 112         break
 113
 114     if ok:
 115         while True:
 116             x = raw_input(log.bold("""Enter the letter ('P' thru 'V') and number (1 thru 7) for the COLOR plot (eg, "R3") or "q" to quit: """))
 117
 118             if x.lower().strip() == 'q':
 119                 ok = False
 120                 break
 121
 122             if x.lower().strip() == 'd': # use defaults
 123                 values[2], values[3] = -1, -1
 124                 break
 125
 126             if len(x) < 2:
 127                 log.error("You must enter at least two characters (a letter and a number)")
 128                 continue
 129
 130             if len(x) > 3:
 131                 log.error('Enter only a single letter and a one or two digit number (eg, "R3").')
 132                 continue
 133
 134             letter = x[0].lower()
 135
 136             if letter not in 'pqrstuv':
 137                 log.error("You must enter a letter 'P' thru 'V'")
 138                 continue
 139
 140             try:
 141                 number = int(x[1:])
 142             except ValueError:
 143                 log.error("You must enter a letter 'P' thru 'V' followed by a number 1 thru 7.")
 144                 continue
 145
 146             if number < 0 or number > 7:
 147                 log.error("You must enter a letter 'P' thru 'V' followed by a number 1 thru 7.")
 148                 continue
 149
 150             values[2] = ord(str(letter).upper()) - ord('P')
 151             values[3] = number - 1
 152             break
 153
 154     return ok, values
 155
 156
 157 try:
 158     mod = module.Module(__mod__, __title__, __version__, __doc__, None,
 159                         (INTERACTIVE_MODE, GUI_MODE), (UI_TOOLKIT_QT4,))
 160
 161     mod.setUsage(module.USAGE_FLAG_DEVICE_ARGS,
 162                  see_also_list=['hp-align', 'hp-clean', 'hp-linefeedcal',
 163                                 'hp-pqdiag'])
 164
 165     opts, device_uri, printer_name, mode, ui_toolkit, lang = \
 166         mod.parseStdOpts()
 167
 168     device_uri = mod.getDeviceUri(device_uri, printer_name,
 169         filter={'color-cal-type': (operator.ne, COLOR_CAL_TYPE_NONE)})
 170
 171     if mode == GUI_MODE:
 172         if not utils.canEnterGUIMode4():
 173             log.error("%s -u/--gui requires Qt4 GUI support. Entering interactive mode." % __mod__)
 174             mode = INTERACTIVE_MODE
 175
 176     if mode == INTERACTIVE_MODE:
 177         try:
 178             d = device.Device(device_uri, printer_name)
 179         except Error, e:
 180             log.error("Unable to open device: %s" % e.msg)
 181             sys.exit(1)
 182
 183         try:
 184             try:
 185                 d.open()
 186             except Error:
 187                 log.error("Unable to print to printer. Please check device and try again.")
 188                 sys.exit(1)
 189
 190             if d.isIdleAndNoError():
 191                 color_cal_type = d.mq.get('color-cal-type', COLOR_CAL_TYPE_NONE)
 192                 log.debug("Color calibration type=%d" % color_cal_type)
 193
 194                 if color_cal_type == COLOR_CAL_TYPE_UNSUPPORTED:
 195                     log.error("Color calibration through HPLIP not supported for this printer. Please use the printer's front panel to perform color calibration.")
 196
 197                 elif color_cal_type == COLOR_CAL_TYPE_DESKJET_450: #1
 198                     maint.colorCalType1(d, tui.load_paper_prompt, colorCal, photoPenRequired)
 199
 200                 elif color_cal_type == COLOR_CAL_TYPE_MALIBU_CRICK: #2
 201                     maint.colorCalType2(d, tui.load_paper_prompt, colorCal2, invalidPen)
 202
 203                 elif color_cal_type == COLOR_CAL_TYPE_STRINGRAY_LONGBOW_TORNADO: #2
 204                     maint.colorCalType3(d, tui.load_paper_prompt, colorAdj, photoPenRequired2)
 205
 206                 elif color_cal_type == COLOR_CAL_TYPE_CONNERY: # 4
 207                     maint.colorCalType4(d, tui.load_paper_prompt, colorCal4, None)
 208
 209                 elif color_cal_type == COLOR_CAL_TYPE_COUSTEAU: # 5
 210                     maint.colorCalType5(d, tui.load_paper_prompt)
 211
 212                 elif color_cal_type == COLOR_CAL_TYPE_CARRIER: # 6
 213                     maint.colorCalType6(d, tui.load_paper_prompt)
 214
 215                 elif color_cal_type == COLOR_CAL_TYPE_TYPHOON: # 7
 216                     maint.colorCalType7(d, tui.load_photo_paper_prompt)
 217
 218                 else:
 219                     log.error("Invalid color calibration type.")
 220
 221             else:
 222                 log.error("Device is busy or in an error state. Please check device and try again.")
 223                 sys.exit(1)
 224         finally:
 225             d.close()
 226
 227     else:
 228         try:
 229             from PyQt4.QtGui import QApplication
 230             from ui4.colorcaldialog import ColorCalDialog
 231         except ImportError:
 232             log.error("Unable to load Qt4 support. Is it installed?")
 233             sys.exit(1)
 234
 235         #try:
 236         if 1:
 237             app = QApplication(sys.argv)
 238
 239             dlg = ColorCalDialog(None, device_uri)
 240             dlg.show()
 241             try:
 242                 log.debug("Starting GUI loop...")
 243                 app.exec_()
 244             except KeyboardInterrupt:
 245                 sys.exit(0)
 246
 247         #finally:
 248         if 1:
 249             sys.exit(0)
 250
 251 except KeyboardInterrupt:
 252     log.error("User exit")
 253
 254 log.info("")
 255 log.info('Done.')