Gutenprint + CUPS backends for Dye Sublimation printers
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
selphy_print/README

1313 lines
42 KiB

***************************************************************************
Unified Gutenprint/CUPS backend for various Dye-Sublimation photo printers
Copyright (c) 2007-2021 Solomon Peachy <pizza@shaftnet.org>
This free software comes with ABSOLUTELY NO WARRANTY and is licensed under
the GNU GPL (v3 or later); see the 'COPYING' file for more details.
SPDX-License-Identifier: GPL-3.0+
10 years ago
The latest version can be found at
https://git.shaftnet.org/cgit/selphy_print.git
For a list of known bugs and development plans, see:
https://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:
10 years ago
Canon SELPHY ES series
Canon SELPHY CP series
6 years ago
Ciaat Brava 21
Citizen CW-01
Citizen CW-02 / OP900II
6 years ago
DNP DS40 / Citizen CX
DNP DS80 / Citizen CX-W
DNP DS80DX
DNP DS-RX1 / DS-RX1HS / Citizen CY / CY-02
DNP DS620 / DS620A / Citizen CX-02
DNP DS820 / DS820A / Citizen CX-02W
DNP QW410 / Citizen CZ-01
Fujifilm ASK-300
HiTi P510 series
HiTi P520L
HiTi P525L
10 years ago
Kodak Professional 1400
Kodak 305 Photo Printer
Kodak 605 Photo Printer
10 years ago
Kodak 805 Photo Printer
Kodak 6800 Photo Printer
Kodak 6850 Photo Printer
Kodak 7000 Photo Printer
Kodak 8800 / 9810
Kodak 8810 Photo Printer
Magicard Tango 2E
Mitsubishi CP30DW
Mitsubishi CP3800DW
Mitsubishi CP9550D/DW/DW-S/DZ/DZ-S
Mitsubishi CP9600D/DW
Mitsubishi CP-D70DW and CP-D707DW
Mitsubishi CP-D70DW-S and CP-D707DW-S
Mitsubishi CP-D80DW
Mitsubishi CP-D90DW
Mitsubishi CP-K60DW-S
Mitsubishi CP-M1A / CP-M1E
Mitsubishi CP-M15
Mitsubishi P95DW
Mitsubishi P93DW
Olmec OP1000
Shinko CHC-S1245 (aka Sinfonia E1 and DNP Q8)
Shinko CHC-S2145 (aka Sinfonia S2)
Shinko CHC-S6145 (aka Sinfonia CS2)
Shinko CHC-S6245 (aka Sinfonia CE1)
Sony UP-CR10L (aka DNP DS-SL10)
Sony UP-CX1
3 years ago
Sony UP-DR80MD
Sony UP-DR150
Sony UP-DR200
Sony UP-D895
Sony UP-D897
Sony UP-D898 series
Sony UP-971AD
Stryker SDP1000
Work-in-progress Printers:
DNP M4 / Q4
DNP M8
Fujifilm ASK-500
HiTi M610 (not X610!)
HiTi P530D
HiTi P720L / P728L
HiTi P750L
6 years ago
HiTi P910L
HiTi CS-200e / CS-220e
6 years ago
ICI Imagedata OP900
Kodak 6900 / 6950
Kodak 7010 / 7015
Magicard Rio 2E (and other Magicard models)
Mitsubishi CP3020D/DE and CP3020DA/DAE
Mitsubishi CP9000DW, CP9500DW, and CP9600DW-S
Mitsubishi CP9800DW, CP9800DW-S, CP9810DW, and CP9820DW-S
Olmec OP900
Shinko CHC-S2245 (aka Sinfonia S3)
Shinko CHC-S6145-5A (aka Sinfonia CS2-c)
Sony UP-CR20L (aka DNP DS-SL20)
3 years ago
Sony UP-DR80
Sony UP-970AD / UP-990AD
Sony UP-991AD
***************************************************************************
This intelligent backend is needed to utilize many common dye-sublimation
photo printers under Linux, OSX, and other UNIX-like operating systems.
2 years ago
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.
9 years ago
2 years ago
This backend only handles the low-level communication with these
printers; it is not able to "render" arbitrary image data into a
format these printers will accept, along with associated printing
parameters/options.
6 years ago
Consequently, this backend can only be used in conjunction with
Gutenprint (http://gimp-print.sf.net), version 5.2.10 or newer. Code
2 years ago
snapshots of this backend are bundled with Gutenprint, although this
repository is the canonical upstream source and is developed
2 years ago
independently.
6 years ago
As such, when compared to any given Gutenprint release, the code found
2 years ago
here has additional features, device support, and bugfixes. 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.
So, while it is safe to use code in this repository with an older
Gutenprint release, supporting for newer models or printing options
that affect image rendering willl likely requires up-to-date
Gutenprint code,
Most printer support in selphy_print (and Gutenprint) was developed
without any assistance from the printer manufactuers, relying on
reverse-engineering and a great deal of experimentation.
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 most models, such as querying status and
configuring 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.
Additionally, you will need the CUPS development packages installed,
so we can figure out how the local CUPS instance is configured.
6 years ago
Lastly, in order to integrate the backend into an existing Gutenprint
installation you will need to install the Gutenprint development
headers.
Fedora/RedHat:
yum install libusb1-devel cups-devel gutenprint-devel
Debian/Ubuntu
apt-get install libusb-1.0-0-dev libcups2-dev libgutenprint-dev
All you need to do after that is type 'make'
Compilation for Windows:
This is highly experimental.
Currently only MinGW is supported. You will need the 'libltdl' and
'libusbx' MinGW packages.
Once the necessary packages are installed, run 'mingw64-make' and
everything should compile cleanly.
Please note that actually running this under Windows will require
use/installation of a generic USB driver such as WINUSB. For more
information, see:
http://zadig.akeo.ie
Another note. If you are using a NEC/Renesas USB 3.0 host
controller, you will need to ensure that it is using up-to-date
drivers or no devices will enumerate. For more information, see:
https://github.com/libusb/libusb/wiki/Windows
***************************************************************************
CUPS backend usage:
10 years ago
DEVICE_URI=someuri \
gutenprint53+usb job-id user title num-copies options [ filename ]
10 years ago
The backend generates output for CUPS to parse, including logging
3 years ago
print counts, reporting loaded media types, and remaining media counts.
6 years ago
Please note that this backend merely handles the low-level
communication with the printer! Actually generating print jobs requires
use of Gutenprint compiled with support for CUPS.
6 years ago
DEVICE_URI=someuri CONTENT_TYPE=application/vnd.cups-command \
gutenprint53+usb job-id user title num-copies options [ filename ]
This parses a CUPS command file and performs actions listed in the file.
Implemented commands:
ReportLevels Report the marker (ie media) type and levels.
Other commands may be implemented in the future. Individual printer
models may not implement these commands.
Other Notes:
'someuri' is the URI returned by the backend when it probes for supported
devices. is invoked by calling the backend with no arguments.
The backend supports multiple URI schemes. First, the "modern" one:
gutenprint53+usb://backendname/serialnum
And the old/legacy/classic ones:
gutenprint52+usb://manufacturer/model/?backend=backendname&serial=serialnum
gutenprint52+usb://manufacturer/model/?serial=serialnum&backend=backendname
The URI scheme generated at device probing depends on the version of
gutenprint installed. By default, the modern scheme is used when compiled
against Gutenprint 5.3 or newer, and the legacy scheme is used with
Gutenprint 5.2.
Regardless of the scheme generated at probe time, the backend will continue
to detect and parse both schemes indefinitely as to not break backwards
compatibility with existing deployments. To manually switch the URI
scheme type generated at runtime, set the OLD_URI_SCHEME environment
variable to either 0 or 1, as appropriate.
***************************************************************************
Standalone usage:
10 years ago
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 the generic
name of 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 ]
The 'backend' name is any one of the names listed when invoking the
executable with no arguments. For example:
./dnpds40
DEBUG: Multi-Call Dye-sublimation CUPS Backend version 0.88
[ ... ]
DEBUG: Standalone DNP DS-series / Citizen C-series backend version 0.106
DEBUG: supporting: dnp_citizen dnpds40 dnpds80 dnpds80dx dnpds620 dnpds820 dnprx1 citizencw01 citizencw02 citizencx02
[ ... ]
The first entry after 'supporting' is the generic backend name, while
the others correspond to specific models the backend supports. Any one
can be used as the 'backend' name.
10 years ago
All backends support the following invocations:
10 years ago
backend [ arguments ]
backend [ arguments ] filename
backend [ arguments ] - < filename
somecommand | backend [ arguments ] -
10 years ago
The 'filename' here refers to the raw spool data generated by
Gutenprint (eg via its gimp plugin) or the Windows print-to-file
10 years ago
output.
All global arguments:
-D Increment debug level [1]
-G Display GPL text
-f Enable fast return mode if possible [2]
-d numcopies Print 'numcopies' of the supplied job
-v Silence all output except for warnings/errors
[1] This argument can be repeated to increase the debug level.
Alternatively, the 'DYESUB_DEBUG' environment variable can be
used. For example, '-DDD' and 'DYESUB_DEBUG=3' are equivalent.
DYESUB_DEBUG=1 Enable debug output
DYESUB_DEBUG=2 Dump contents of short messges
DYESUB_DEBUG=3 Dump contents of all messages
[2] This terminates the backend as soon as the printer has
accepted the print job, without waiting for the print job
to complete. Not all printers support this feature. This
can also be enabled by setting the 'FAST_RETURN' environment
variable. This is the default behavior when using this backend
with CUPS.
Finally, some backends support additional arguments; see their details
below.
***************************************************************************
Other Environment Variables:
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 using the 'SERIAL' environment variable. For example:
SERIAL=N782 backend filename [ arguments ]
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 environment variables:
EXTRA_VID=04a9 EXTRA_PID=3ab1 EXTRA_TYPE=7 backend 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.
For debugging USB operation, there following environment variables
can be set:
MAX_XFER_SIZE Maximum transfer size, in bytes.
XFER_TIMEOUT Timeout, in milliseconds, for all USB operations
for example:
MAX_XFER_SIZE=32768 XFER_TIMEOUT=30000 backend filename
To change the location of backend data at runtime, set CORRTABLE_PATH
to the appropriate directory.
Finally, BACKEND_QUIET can be set to a non-zero value to silence all
output other than warnings and errors.
***************************************************************************
Standalone status queries:
If you just want to query the printer and media status in a
printer-independent manner, the backend supports reporting a standard
set of data in either textual or JSON format. This is used with the
BACKEND_STATS_ONLY environment variable:
BACKEND_STATS_ONLY=? BACKEND=backend [SERIAL=??] ./gutenprint53+usb
BACKEND_STATS_ONLY=? [SERIAL=??] ./backend
BACKEND_STATS_ONLY=1 will report in textual format, for example:
Backend: HiTi Photo Printers
Version: 0.100 / 0.16
Timestamp: 2019-1 2-13 14:54:28
Manufacturer: HiTi
Model: HiTi:Usb Photo Printer:HiTi P520L
Serial Number: 2WC4A1013968279
Firmware Version: 1.21.0.i
Printer Status: Idle
Lifetime Prints: 194
Media 0 Type: 4x6
Media 0 Level: 313 / 500
BACKEND_STATS_ONLY=2 will report in JSON format, for example:
{
"backend": "HiTi Photo Printers",
"version": "0.100 / 0.16",
"timestamp": "2019-12-13 14:57:38",
"manufacturer": "HiTi",
"model": "HiTi:Usb Photo Printer:HiTi P520L",
"serial": "2WC4A1013968279",
"firmware": "1.21.0.i",
"status": "Idle",
"counters": {
"lifetime": 194
},
"media": [
{
"type": "4x6",
"level": "OK",
"levelnow": 313,
"levelmax": 500
}
]
}
***************************************************************************
10 years ago
BACKEND=canonselphy
Model IDs recognized:
canon-cp10 canon-cp100 canon-cp200 canon-cp220 canon-cp300 canon-cp330
canon-cp400 canon-cp500 canon-cp510 canon-cp520 canon-cp530 canon-cp600
canon-cp710 canon-cp720 canon-cp730 canon-cp740 canon-cp750 canon-cp760
canon-cp770 canon-cp780 canon-cp790 canon-cp800 canon-cp810 canon-cp900
canon-es1 canon-es2 canon-es20 canon-es3 canon-es30 canon-es40
Model IDs for backwards compatibility with older releases:
selphycp10 selphycp100 selphycp200 selphycp220 selphycp300 selphycp330
selphycp400 selphycp500 selphycp510 selphycp520 selphycp530 selphycp600
selphycp710 selphycp720 selphycp730 selphycp740 selphycp750 selphycp760
selphycp770 selphycp780 selphycp790 selphycp800 selphycp810 selphycp900
selphyes1 selphyes2 selphyes20 selphyes3 selphyes30 selphyes40
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
Untested, but expected to work:
ES20, CP-220, CP520, CP530, CP600, CP810
Valid commands:
-R Reset printer to factory defaults
-s Query printer status
Notes:
3 years ago
* The SELPHY ES3 and ES30 cannot report the loaded media type
* All models can report media empty, but not quantity remaining
***************************************************************************
BACKEND=canonselphyneo
Model IDs recognized:
canon-cp820 canon-cp910 canon-cp1000 canon-cp1200 canon-cp1300 canon-cp1500
Model IDs for backwards compatibility with older releases:
selphycp820 selphycp910 selphycp1000 selphycp1200 selphycp1300
Verified supported printers:
CP1000, CP1200, CP1300
Untested, but expected to work:
CP820, CP910, CP1500
Valid commands:
-R Reset printer to factory defaults
-s Query printer status
Notes:
* All models can report media empty, but not quantity remaining
***************************************************************************
10 years ago
BACKEND=kodak1400
Additional model IDs recognized:
kodak-1400 kodak-805
mitsubishi-3020d mitsubishi-3020da, mitsubishi-3020dae mitsubishi-3020de
mitsubishi-3020du
Model IDs for backwards compatibility with older releases:
kodak1400 kodak805 mitsu3020d mitsu3020da
10 years ago
Verified supported printers:
10 years ago
Kodak 1400
Kodak 805
Work-in-progress printers:
Mitsubishi CP3020D/DE
Mitsubishi CP3020DA/DAE
Valid commands:
-C filename Set tone curve [1]
Notes:
3 years ago
* These models cannot report media type or remaining levels,
but are able to report out of media conditions.
[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=kodak68x0
Model IDs recognized:
kodak-6800 kodak-6850
Model IDs for backwards compatibility with older releases:
kodak6800 kodak6850
10 years ago
Verified supported printers:
Kodak 6800
Kodak 6850
Development was sponsored in part by:
LiveLink Technology [ www.livelinktechnology.net ]
Valid commands:
-c filename Query tone curve [1]
-C filename Set tone curve [1]
-l filename Query Current tone curve from RAM [1]
-L filename Store Current tone curve in RAM [1]
-m Query media information
-s Query printer status
-R Reset printer to factory defaults
-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
Additional model IDs recognized:
kodak-605, kodak-7000, kodak-7010, kodak-7015,
Verified supported printers:
Kodak 605
Kodak 7000
Work-in-progress printers:
Kodak 7010/7015
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 [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 ???
(unsure as to the bit usage)
[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=kodak8800
Additional model IDs recognized:
kodak-8800, kodak-9810
Verified Supported printers:
Kodak 8800/9810
Valid commands:
-e [ 1|2|3 ] Query error logs
-i Query printer info
-m Query media info
-n Query counters
-X id Cancel job (0 for all/current)
***************************************************************************
10 years ago
BACKEND=shinkos2145
Model IDs recognized:
shinko-chcs2145 sinfonia-chcs2145 olmec-op1000
10 years ago
Verified supported printers:
Shinko CHC-S2145 (aka "Sinfonia S2")
Olmec OP1000
Development was sponsored in part 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!
Model IDs recognized:
shinko-chcs1245 sinfonia-chcs1245
Verified supported printers:
Shinko CHC-S1245 (aka "Sinfonia E1")
Unsupported printers (unknown VID/PID):
DNP Q8
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]
-R Reset printer to factory defaults
-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]