***************************************************************************
Unified Gutenprint/CUPS backend for various Dye-Sublimation photo printers
Copyright (c) 2007-2015 Solomon Peachy <pizza@shaftnet.org>
This free software comes with ABSOLUTELY NO WARRANTY!
Licensed under the GNU GPL, see the 'COPYING' file for more details.
The latest version can be found at
http://git.shaftnet.org/cgit/selphy_print.git
For a list of known bugs and development plans, see:
http://bugs.shaftnet.org/index.php?project=4
***************************************************************************
If you do not have one of the printers listed below, this backend is
not relevant for you and you can just ignore all of this.
Supported Printers:
Canon SELPHY ES series
Canon SELPHY CP series (except CP820, and CP910)
Kodak Professional 1400
Kodak 605 Photo Printer
Kodak 805 Photo Printer
Kodak 6800 Photo Printer
Kodak 6850 Photo Printer
Shinko CHC-S2145 (aka "Sinfonia S2")
Sony UP-DR150
Sony UP-DR200
DNP DS40/DS80/DS-RX1/DS620
Citizen CX/CX-W/CY
Citizen CW-01
Mitsubishi CP-9550D/DW/DW-S/DZ/DZ-S
Mitsubishi CP-3800DW
Work-in-progress Printers:
DNP DS80DX
Mitsubishi CP-D70DW, CP-D707DW, CP-K60DW-S, and CP-D80DW
Kodak 305
Fuji ASK-300
Citizen CW-02, and CX2
Olmec OP900/OP900II
ICI Imagedata OP900
Sony UP-CR10L (aka DNP DS-SL10)
Shinko CHC-S1245 (aka Sinfonia E1)
Shinko CHC-S6245 (aka Sinfonia CE1)
Shinko CHC-S6145 (aka Sinfonia CS2)
Shinko CHC-S6145-5A (aka Sinfonia CS2-c)
Kodak 8810
Kodak 7000/7010/7015
Ciaat Brava 21 (Rebadged S6145)
***************************************************************************
This intelligent backend is needed to utilize many common dye-sublimation
photo printers under Linux, OSX, and other UNIX-like operating systems.
Although these printers advertise themselves as standard USB Printer Class
devices, they do not actually obey those specifications and require
special two-way handshaking in order to successfully print.
This backend can only be used in conjunction with Gutenprint 5.2.10 or
newer. Please see the Gutenprint README file (section II D) for more
information on use of this backend and integration into CUPS.
Although this backend is bundled with Gutenprint, this repository is
considered the canonical upstream source where all development occurs.
As such, when compared to the current Gutenprint release, the code found
here is often newer, with additional features or device support. At the
same time, it may have half-developed features that don't quite work,
with giant bugs that come out at midnight to eat your cat.
On that note, please keep in mind that this software distributed
in the hope that it will be useful, but WITHOUT ANY WARRANTY WHATSOEVER.
***************************************************************************
This backend also supports a "standalone" mode that performs various
utility functions for selected printers, such as querying status and
configuring various parameters. The exact commands supported for each
printer are documented below.
***************************************************************************
Compilation:
This tool requires libusb 1.0 to build. We highly recommend
v1.0.16 or newer due to general stability improvements. Versions
older than 1.0.10 will require -DLIBUSB_PRE_1_0_10 to be defined
(see the Makefile).
To further complicate things, libusb-1.0 had a temporary fork called
libusbx, but that was merged back into libusb as of v1.0.18.
Consequently, your distribution package for libusb-1.0 may be
called libusbx instead.
Fedora/RedHat:
yum install libusbx-devel libusb1-devel
Debian/Ubuntu
apt-get install libusbx-dev libusb-1.0-0-dev
And all you need to do after that is type 'make'
***************************************************************************
CUPS backend usage:
DEVICE_URI=someuri \
gutenprint52+usb job-id user title num-copies options [ filename ]
***************************************************************************
Standalone usage:
This backend is set up as a multi-call executable; that is to say
behaivor changes based on the name used to invoke the executable.
When compiled, a set of symlinks are created, corresponding to each
of the internal backends. Alternatively you may set the BACKEND
environment variable to force a specific backend to be used. These
commands are equivalent:
BACKEND=backend gutenprint52+usb [ arguments ]
backend [ arguments ]
All backends support the following invocations:
backend [ arguments ]
backend [ arguments ] filename
backend [ arguments ] - < filename
somecommand | backend [ arguments ] -
The 'filename' here refers to the raw spool data generated by
Gutenprint (eg via its gimp plugin) or the Windows print-to-file
output.
All global arguments:
-D Increment debug level [1]
-G Display GPL text
-f Enable fast return mode if possible [2]
-S serno Use SerialNum 'serno' [3]
-V extra_vid [4]
-P extra_pid [4]
-T extra_type [4]
-d numcopies Print 'numcopies' of the supplied job
[1] This argument can be repeated to increase the debug level.
Alternatively, the 'DYESUB_DEBUG' environment variable can be
used.
[2] This terminates the backend as soon as the printer has
acknowledged the print job, without waiting for the print job
to complete. This can also be enabled by setting the
'FAST_RETURN' environment variable. This is the default behavior
when using this backend with CUPS. Not all backends support
fast return.
[3] If you have multiple models of the same printer family connected
simultaneously, the backend will choose the first one it finds.
If you wish to target a specific device, you may specify its
serial number with this switch, or using the 'SERIAL' environment
variable. For example, these are equivalent:
SERIAL=N782 backend filename [ arguments ]
backend -S N782 filename [ arguments ]
[4] All backends support an additional operational mode, to test out
unknown models. To use this mode, specify the VID, PID and its
internal device type as arguments or environment variables:
EXTRA_VID=04a9 EXTRA_PID=3ab1 EXTRA_TYPE=7 backend filename
backend -V 04a9 -P 3ab1 -T 7 filename
The VID and PID are specified in hexidecimal, and the TYPE is
the P_XXX enumeration defined in backend_common.h. The '7' in this
example corresponds to most Canon SELPHY CP models, and is what you
would use if you were trying to get the backend to detect an
otherwise unrecognized SELPHY CP model.
If you are able to successfuly print using this technique,
please let us know so we can add the apppriate entry to the
internal database.
Finally, some backends support additional arguments; see below:
***************************************************************************
BACKEND=canonselphy
Verified supported printers:
ES1, ES2, ES3, ES30, ES40, CP-10, CP-100, CP-200, CP-300, CP-330,
CP400, CP500, CP510, CP710, CP720, CP730, CP740, CP750, CP760, CP770,
CP780, CP790, CP800, CP900
Unverified/untested, but should work: (let us know, please!)
ES20, CP-220, CP520, CP530, CP600, CP810
NOT supported: (Printer does not need a backend)
CP820, CP910
This backend does not support additional commands.
***************************************************************************
BACKEND=kodak1400
Verified supported printers:
Kodak 1400
Kodak 805
Valid commands:
-C filename Set tone curve [1]
Notes:
[1] Format of curvedata file:
256 entries each of Yellow, Magenta, Cyan mappings:
Values are unsigned 16-bit big endian, between 0 and ???
(unsure as to the bit usage)
***************************************************************************
BACKEND=kodak6800
Verified supported printers:
Kodak 6800
Kodak 6850
Development was sponsored by:
LiveLink Technology [ www.livelinktechnology.net ]
Valid commands:
-c filename Query tone curve [1]
-C filename Set tone curve [1]
-m Query supported media
-s Query printer status
-X id Cancel print job 'id' [2]
Notes:
[1] Format of curvedata file:
256 entries each of Yellow, Magenta, Cyan mappings:
Values are unsigned 16-bit big endian, between 0 and 16383
(ie 14-bit)
[2] Job ID is the Internal Job ID (reported via status)
This cancels a multi-copy print job.
To see which jobs are active/pending, see the output of the
'-s' command, specifically the 'Bank' output.
***************************************************************************
BACKEND=kodak605
Verified supported printers:
Kodak 605
Unsupported printers (Unknown VID/PID):
Kodak 7000/7010/7015
Valid commands:
-C filename Set tone curve [1]
-m Query supported media
-s Query printer status
Notes:
[1] Format of curvedata file:
256 entries each of Yellow, Magenta, Cyan mappings:
Values are unsigned 16-bit big endian, between 0 and ???
(unsure as to the bit usage)
***************************************************************************
BACKEND=shinkos2145
Verified supported printers:
Shinko CHC-S2145 (aka "Sinfonia S2")
Development was initially sponsored by:
LiveLink Technology [ www.livelinktechnology.net ]
In order to use this backend, you will need to ensure the printer is
configured to use the 'DRV' (as opposed to 'DLL') operating mode. See
the printer documentation for details on how to set this.
Valid commands:
-b [ 0 | 1 ] Disable or Enable the printer control panel.
-c filename Query User tone curve from flash [1]
-C filename Store User tone curve in flash [1]
-e Query Error log
-F Flash printer LEDs for 5 seconds
-i Query printer firmware information
-l filename Query Current tone curve from RAM [1]
-L filename Store Current tone curve in RAM [1]
-m Query media information
-r Reset User tone curve to default [4]
-R Reset printer to factory defaults
-s Query printer status
-u Query user string
-U somestring Set user string to 'somestring'
-X id Cancel print job 'id' [3]
Notes:
[1] Format of curvedata file:
256 entries each of Yellow, Magenta, Cyan mappings:
Values are unsigned 16-bit big endian, between 0 and 2047
(ie only 11 bits used)
[3] Job ID is the Internal Job ID (reported via status)
This cancels a multi-copy print job.
To see which jobs are active/pending, see the output of the
'-s' command, specifically the 'Bank' output.
[4] Default printer tone curve is a linear 'val << 3'
***************************************************************************
BACKEND=shinkos1245
Low-level documentation was provided by Sinfonia, Inc. Thank you!
Work-in-process printers:
Shinko CHC-S1245 (aka "Sinfonia E1")
Valid commands:
-s Query printer status
-m Query media information
-u Query user string
-U somestring Set user string to 'somestring'
-X id Cancel print job 'id' [1]
-F Tone curve commands affect FINE table
-c filename Query User tone curve from flash [2]
-C filename Store User tone curve in flash [2]
-l filename Query Current tone curve from RAM [2]
-L filename Store Current tone curve in RAM [2]
[1] Job ID is the Internal Job ID (reported via status)
This cancels a multi-copy print job.
To see which jobs are active/pending, see the output of the
'-s' command, specifically the 'Bank' output.
[2] Format of tone curve file:
256 entries each of Yellow, Magenta, Cyan mappings:
Values are unsigned 16-bit big endian, between 0 and 16383
(ie only 14 bits used)
***************************************************************************
BACKEND=shinkos6145
Low-level documentation was provided by Sinfonia, Inc. Thank you!
Work-in-process printers:
Shinko CHC-S6145 (aka "Sinfonia CS2")
Ciaat Brava 21
***VERY IMPORTANT*** At the moment, this backend is only able to
query printer statistics and issue various commands. In order to
print, this backend requires a proprietary library
(libS6145ImageProcess) to transform the input data into a form the
printer can use.
This library was provided to the authors of this in binary form, and
without redistribution permissions.
If you obtain this library along with *written permission* from
Sinfonia Technology Co. LTD to use and/or redistribute it,
as an additional permission under the GPLv3 section 7, you
may combine and/or redistribute this backend along with the library.
For the full text of the license exception, see the comments in the
header of backend_shinkos6145.c
Ideally, Sinfonia could be convinced to release source code to this
library under a suitable license, but I have been informed they are
unable to do so due to legal considerations. Meanwhile, work is
slowly under way to reverse-engineer this proprietary, binary
library and write a Free Software replacement.
Valid commands:
-c filename Query User tone curve from flash [1]
-C filename Store User tone curve in flash [1]
-e Query Error log
-F Flash printer LEDs for 5 seconds
-i Query printer firmware information
-k num Specify standby delay (5-240 minutes)
-l filename Query Current tone curve from RAM [1]
-L filename Store Current tone curve in RAM [1]
-m Query media information
-r Reset User tone curve to default [3]
-R Reset printer to factory defaults
-s Query printer status
-X id Cancel print job 'id' [2]
Notes:
[1] Format of curvedata file:
256 entries each of Yellow, Magenta, Cyan mappings:
Values are unsigned 16-bit big endian, between 0 and 2047
(ie only 11 bits used)
[2] Job ID is the Internal Job ID (reported via status)
This cancels a multi-copy print job.
To see which jobs are active/pending, see the output of the
'-s' command, specifically the 'Bank' output.
[3] Default printer tone curve is a linear 'val << 3'
***************************************************************************
BACKEND=shinkos6245
Low-level documentation was provided by Sinfonia, Inc. Thank you!
Work-in-process printers:
Shinko CHC-S6245 (aka "Sinfonia CE1")
Unsupported printers (Unknown VID/PID):
Kodak 8810
Valid commands:
-c filename Query User tone curve from flash [1]
-C filename Store User tone curve in flash [1]
-e Query Error log
-F Flash printer LEDs for 5 seconds
-i Query printer firmware information
-k num Specify standby delay (5-240 minutes)
-l filename Query Current tone curve from RAM [1]
-L filename Store Current tone curve in RAM [1]
-m Query media information
-r Reset User tone curve to default [3]
-R Reset printer to factory defaults
-s Query printer status
-X id Cancel print job 'id' [2]
Notes:
[1] Format of curvedata file:
256 entries each of Yellow, Magenta, Cyan mappings:
Values are unsigned 16-bit big endian, between 0 and 2047
(ie only 11 bits used)
[2] Job ID is the Internal Job ID (reported via status)
This cancels a multi-copy print job.
To see which jobs are active/pending, see the output of the
'-s' command, specifically the 'Bank' output.
[3] Default printer tone curve is a linear 'val << 3'
***************************************************************************
BACKEND=sonyupdr150
Verified supported printers:
Sony UP-DR150
Sony UP-DR200
Unverified/untested, but should work: (Need USB PIDs)
Sony UP-CR10L
DNP DS-SL10
This backend does not support additional commands.
***************************************************************************
BACKEND=mitsu70x
Supported and tested printers:
Mitsubishi CP-D70DW
Mitsubishi CP-D707DW
Work-in-progress printers (bugs):
Mitsubishi CP-K60DW-S
Kodak 305
Unsupported printers (Unknown VID/PID):
Mitsubishi CP-D80DW
Fuji ASK-300
Valid commands:
-s Query printer status (Only partially decoded)
***************************************************************************
BACKEND=mitsu9550
Supported and tested printers:
Mitsubishi CP-9550DZ/DZS/DW-S
Work-in-progress printers:
Mitsubishi CP-9550D/DW
Valid commands:
-s Query printer status
-m Query printer media
***************************************************************************
BACKEND=dnpds40
Verified supported printers:
DNP DS40
DNP DS80
DNP DS-RX1
DNP DS620
Citizen CX
Citizen CX-W
Citizen CY
Theoretically supported printers: (Untested)
Mitsubishi CP-3800DW
Work-in-progress printers: (USB PIDs unknown)
Citizen CW-02/OP900II
Citizen CX2 (?)
DNP DS80DX
Development was initially sponsored by:
Marco Di Antonio
LiveLink Technology [ www.livelinktechnology.net ]
This backend supports additional commands:
dnpds40 [command [arg] ]
Valid commands:
-i Query printer information (resolution, etc)
-I Query printer sensor information
-n Query printer counters
-N [ A | B | M ] Reset Counter A/B/M [2]
-p num Set 'P' counter to 'num' [2]
-s Query printer status
-k num Specify standby delay (1-99 minutes, 0 disables) [1]
-K num Keep Media Status Across Power Cycles (1 yes, 0 no) [1]
-x num Set USB iSerialNumber reporting (1 yes, 0 no) [1]
Notes:
[1] Only supported by DNP-DS620
[2] Certain printer features may require updating the printer firmware
***************************************************************************
BACKEND=citizencw01
Verified supported printers:
Citizen CW-01
Work-in-progress printers: (USB PIDs unknown)
Olmec OP900
ICI Imagedata OP900
This backend supports additional commands:
cw01 [command [arg] ]
Valid commands:
-i Query printer information (resolution, etc)
-n Query printer counters
-s Query printer status
-N [ A | B ] Reset Counter A/B
***************************************************************************
Solomon Peachy
6b8491bcad