sane-pixma(5)

1sane-pixma(5)            SANE Scanner Access Now Easy            sane-pixma(5)
2
3
4

NAME

6       sane-pixma - SANE backend for Canon PIXMA Multi-Functions Printers
7                    MP, MX, ImageCLASS and I-SENSYS series
8

DESCRIPTION

10       The  sane-pixma  library  implements  a  SANE (Scanner Access Now Easy)
11       backend that provides access  to  Canon  PIXMA  multi-function  devices
12       (All-in-one  printers).   The backend implements both USB interface and
13       Network LAN interface using Canon's BJNP protocol.  Currently, the fol‐
14       lowing models work with this backend:
15
16              PIXMA MP140, MP150, MP160, MP170, MP180, MP190
17              PIXMA MP210, MP220, MP240, MP250, MP260, MP270
18              PIXMA MP450, MP460, MP470, MP480, MP490
19              PIXMA MP500, MP510, MP520, MP530, MP540, MP550, MP560
20              PIXMA MP600, MP600R, MP610, MP620, MP630, MP640, MP710
21              PIXMA MP800, MP800R, MP810, MP830, MP960, MP970, MP980, MP990
22              PIXMA MX300, MX310, MX330, MX700, MX850, MX860, MX7600
23              MultiPASS MP700, MP730, PIXMA MP750 (no grayscale)
24              ImageCLASS MF3110, MF3240, MF4010, MF4018, MF4120, MF4122
25              ImageCLASS MF4140, MF4150, MF4270, MF4350d, MF4370dn, MF4380dn
26              ImageCLASS MF4660, MF4690, MF5770, D480
27              I-SENSYS MF4320d, MF4330d
28              CanoScan 8800F
29
30       The  following  models are not well tested and/or the scanner sometimes
31       hangs and must be switched off and on.
32
33              SmartBase MP360, MP370, MP390
34              MultiPASS PIXMA MP760, PIXMA MP780
35
36       The following models may use the same Pixma protocol  as  those  listed
37       above,  but  have  not  yet  been  reported  to work (or not). They are
38       declared in the backend so that  they  get  recognized  and  activated.
39       Feedback in the Sane-dev mailing list welcome.
40
41              PIXMA MP740
42              PIXMA MX320
43              ImageCLASS MF5630, MF5650, MF5730, MF5750, MF8170c
44
45       The backend supports:
46
47              *  resolutions  of  75,  150, 300, 600, 1200, 2400, and 4800 DPI
48              (some maybe buggy),
49              * color and grayscale mode,
50              * a custom gamma table,
51              * Automatic Document Feeder, Simplex and Duplex.
52              * Transparency Unit, 24 or 48 bits depth.
53
54       The device name for USB devices is  in  the  form  pixma:xxxxyyyy_zzzzz
55       where  x,  y  and z are vendor ID, product ID and serial number respec‐
56       tively.  Example: pixma:04A91709_123456 is a MP150.
57
58       Device names for BJNP devices is in  the  form  pixma:aaaa_bbbbb  where
59       aaaa is the scanners model and bbbb is the hostname or ip-adress.
60
61       This  backend, based on cloning original Canon drivers protocols, is in
62       a production stage. Designed has been carried out without any  applica‐
63       ble  manufacturer  documentation, probably never available. However, we
64       have tested it as well as we could, but it may not work in every situa‐
65       tions. You will find an up-to-date status at the project homepage. (See
66       below).  Users feedback is essential to help improve features and  per‐
67       formances.
68

OPTIONS

70       Besides "well-known" options (e.g. resolution, mode etc.) pixma backend
71       also provides the following  options  for  button  handling,  i.e.  the
72       options might change in the future.
73       Button  scan  is disabled on MAC OS X due to darwin libusb not handling
74       timeouts in usb interrupt reads.
75
76       button-controlled
77              This option can be used in combination with scanadf(1) and scan‐
78              image(1)  in  batch mode, for example when you want to scan many
79              photos or multiple-page documents. If it is enabled (i.e. is set
80              to  true  or yes), the backend waits before every scan until the
81              user presses the "SCAN" button (for  MP150)  or  the  color-scan
82              button  (for other models). Just put the first page in the scan‐
83              ner, press the button, then the next page, press the button  and
84              so on. When you finished, press the gray-scan button. (For MP150
85              you have to stop the frontend by pressing Ctrl-C for example.)
86
87       button-update button-1 button-2
88              These options are interesting for developers.  To  check  button
89              status:  (1)  set button-1 and button-2 to zero, (2) set button-
90              update (Its type is SANE_TYPE_BUTTON.),  (3)  get  button-1  and
91              button-2.   If  the result is not zero, the corresponding button
92              was pressed.
93

FILES

95       /usr/lib64/sane/libsane-pixma.a
96              The static library implementing this backend.
97
98       /usr/lib64/sane/libsane-pixma.so
99              The shared library implementing this backend (present on systems
100              that support dynamic loading).
101
102       /etc/sane.d/pixma.conf
103              The   backend   configuration  file  (see  also  description  of
104              SANE_CONFIG_DIR below). The files contains an optional  list  of
105              scanners.  Normally  only scanners that can not be auto-detected
106              because they are on a different subnet shall be listed here.  If
107              your  OS  does not allow enumeration of interfaces (i.e. it does
108              not support the getifaddrs() function) you may need to add  your
109              scanner here as well.  Scanners shall be listed as:
110
111              bjnp://<host>
112              where  host  is  the hostname or IP address of the scanner, e.g.
113              bjnp://10.0.1.4 or  bjnp://myscanner.mydomain.org.  Define  each
114              scanner on a new line.
115

USB SUPPORT

117       USB scanners will be auto-detected and require no configuration.
118

NETWORKING SUPPORT

120       The  pixma  backend supports network scanners using the so called Canon
121       BJNP protocol.  Configuration is  normally  not  required.   The  pixma
122       backend  will  auto-detect your scanner if it is within the same subnet
123       as your computer if your OS does support this.
124
125       If your scanner can not be auto-detected, you can add it to  the  pixma
126       configuration file (see above).
127

FIREWALLING FOR NETWORKED SCANNERS

129       The  sane  pixma backend communicates with port 8612 on the scanner. So
130       you will have to allow outgoing traffic TO port 8612 on the common sub‐
131       net for scanning.
132
133       Scanner detection is slightly more complicated. The pixma backend sends
134       a broadcast on all direct connected subnets it can find (provided  your
135       OS  allows  for  enumeration  of all interfaces). The broadcast is sent
136       FROM port 8612 TO port 8612 on the broadcast address of each interface.
137       The  outgoing  packets  will  be  allowed  by the rule described above.
138       Responses from the scanner are sent back to the computer TO port  8612.
139       Connection  tracking  however does not see a match as the response does
140       not come from the broadcast address but from the scanners own  address.
141       You  will therefore have to allow incoming packets TO port 8612 on your
142       computer.
143
144       So in short: open the firewall for all traffic from  your  computer  to
145       port 8612 AND to port 8612 to your computer.
146
147       With  the  firewall  rules above there is no need to add the scanner to
148       the pixma.conf file, unless the scanner is on a  network  that  is  not
149       directly connected to your computer.
150

ENVIRONMENT

152       SANE_DEBUG_PIXMA
153              If  the  library  was  compiled with debug support enabled, this
154              environment variable controls the debug level for this  backend.
155              Higher value increases the verbosity.
156
157              0  print nothing (default)
158              1  print error and warning messages (recommended)
159              2  print informational messages
160              3  print debug-level messages
161              11 dump USB/BJNP traffics
162              21 full dump USB/BJNP traffic
163
164       PIXMA_EXPERIMENT
165              Setting  to a non-zero value will enable the support for experi‐
166              mental models.  You should also set SANE_DEBUG_PIXMA to 11.
167
168       SANE_CONFIG_DIR
169              This environment variable specifies the list of directories that
170              may contain the configuration file.  Under UNIX, the directories
171              are separated by a colon (`:'), under OS/2, they  are  separated
172              by a semi-colon (`;').  If this variable is not set, the config‐
173              uration file is searched in two default directories: first,  the
174              current working directory (".") and then in /etc/sane.d.  If the
175              value of the environment variable ends with the directory  sepa‐
176              rator character, then the default directories are searched after
177              the explicitly  specified  directories.   For  example,  setting
178              SANE_CONFIG_DIR  to  "/tmp/config:"  would result in directories
179              "tmp/config", ".", and "/etc/sane.d"  being  searched  (in  this
180              order).
181

AUTHORS

194       Wittawat Yamwong, Nicolas Martin, Dennis Lou, Louis Lagendijk
195
196       We  would  like to thank all testers and helpers. Without them we could
197       not be able to write subdrivers for models we don't have. See also  the
198       project homepage.
199
200
201
202                                  8 Jan 2010                     sane-pixma(5)