Scanners: Difference between revisions

(7 intermediate revisions by 6 users not shown)

Line 1:

==Installing scanner support==

Scanner support is provided by the SANE library. To enable scanner support, amend ~~<tt>~~/etc/nixos/configuration.nix<~~/tt>:~~

Scanner support is provided by the [http://www.sane-project.org SANE] library. To enable scanner support, amend your system configuration like so:

{{file|/etc/nixos/configuration.nix|nix|<nowiki>

~~<syntaxhighlight lang="nix"~~>

{

...

hardware.sane.enable = true;

hardware.sane.enable = true; # enables support for SANE scanners

...

}

</~~syntaxhighlight~~>

</nowiki>}}

Users in the <code>scanner</code> group will gain access to the scanner, or the <code>lp</code> group if it’s also a printer. To add yourself to these groups, amend your system configuration as follows:

~~It is also very likely that users will required to be~~ in the ~~following groups~~ <tt>scanner</tt> ~~and~~ <tt>lp</tt>, ~~so you can for example configure it~~ as ~~follow on NixOs (don't forget to login/logout after rebuilding NixOs)~~:

{{file|/etc/nixos/configuration.nix|nix|<nowiki>

<~~syntaxhighlight lang="nix"~~>

{

...

users.users.YOURUSERNAME.extraGroups = [ "scanner" "lp" ];

...

}

</~~syntaxhighlight~~>

</nowiki>}}

{{Tip|The detection of installed backends by SANE depends on the <tt>LD_LIBRARY_PATH</tt> environment variable, which is set at login. You will need to '''logout''' and '''login''' again for backend changes to take effect after ~~<tt>nixos-rebuild switch</tt>~~.}}

{{Tip|The detection of installed backends by SANE depends on the <code>LD_LIBRARY_PATH</code> environment variable, which is set at login. You will need to '''logout''' and '''login''' again for backend changes to take effect after evaluation.}}

==Testing scanner support==

Line 30:

Line 25:

</syntaxhighlight>

If you can only see scanners when running as root, try adding the user to the <tt>scanner</tt> or <tt>lp</tt> either using the ~~configuration~~ given above, or ~~using the following code~~ (beware, don't forget to logout/login after running this command):

If you can only see scanners when running as root, try adding the user to the <tt>scanner</tt> or <tt>lp</tt> groups, either using the method given above, or as follows (beware, don't forget to logout/login after running this command):

$ sudo usermod -a -G scanner,lp username

Line 36:

Line 31:

==Supported backends==

See the [http://www.sane-project.org/sane-supported-devices.html Supported Devices] page to ~~see~~ if your scanner is supported. Some backends are proprietary and are not installed by default; see below. You may also be interested by "driverless" scanning (see below) if your scanner ~~support the~~ Apple AirScan and/or ~~the~~ Microsoft WSD~~, Apple maintains a list of compatible devices [https://support.apple.com/en-us/HT201311 here]~~.

See the [http://www.sane-project.org/sane-supported-devices.html Supported Devices] page to check if your scanner is supported. Some backends are proprietary and are not installed by default; see below. You may also be interested in "driverless" scanning (see below) if your scanner supports Apple AirScan and/or Microsoft WSD.

===Driverless Apple AirScan and Microsoft WSD===

A large number of printers now support "driverless" scanning. As explained [https://github.com/alexpevzner/sane-airscan on the sane-airscan backend project]:

A large number of printers now support "driverless" scanning. As explained [https://github.com/alexpevzner/sane-airscan at the sane-airscan backend project]:

Line 46:

Line 41:

* Apple AirScan or AirPrint scanning (official protocol name is eSCL)

* Microsoft WSD, or WS-Scan (~~term WSD means "~~Web Services for Devices)

* Microsoft WSD, or WS-Scan (Web Services for Devices)

This backend implements both protocols, choosing automatically between them. It was successfully tested with many devices from ~~'''~~Brother, Canon, Dell, Kyocera, Lexmark, Epson, HP, Panasonic, Ricoh, Samsung and Xerox~~'''~~ both in WSD and eSCL modes.

This backend implements both protocols, choosing automatically between them. It was successfully tested with many devices from Brother, Canon, Dell, Kyocera, Lexmark, Epson, HP, Panasonic, Ricoh, Samsung and Xerox, both in WSD and eSCL modes.

For eSCL devices, Apple maintains a [https://support.apple.com/en-us/HT201311 ~~'''~~comprehensive list of compatible devices~~'''~~]~~, but please note, this~~ list ~~contains not only~~ scanners and ~~MFP, but~~ pure printers ~~as well~~.

For eSCL devices, Apple maintains a [https://support.apple.com/en-us/HT201311 comprehensive list of compatible devices]. This list has scanners, multifunction devices and pure printers.

</blockquote>

~~To enable~~ Apple ~~AirScan/Microsoft WSD "driverless" scanning: use~~ the <tt>sane-airscan</tt> ~~drivers~~:

eSCL/Apple Airscan scanners should be found natively by the default escl backend. However, the <tt>sane-airscan</tt> third party backend is more actively maintained and you may have better luck using it:

hardware.sane.extraBackends = [ pkgs.sane-airscan ];

services.udev.packages = [ pkgs.sane-airscan ];

</syntaxhighlight>

It can be that your scanner is found twice (once by <tt>escl</tt> and once by <tt>airscan</tt>, in this case disable <tt>escl</tt>:

hardware.sane.disabledDefaultBackends = [ "escl" ];

</syntaxhighlight>

To detect Microsoft WSD "driverless" scanning, also use the <tt>sane-airscan</tt> backend.

If the scanner is connected by USB, also set the following option:

services.ipp-usb.enable=true;

</syntaxhighlight>

Line 124:

Line 132:

<ol>

<li>~~You need to install a special version of~~ xsane~~, which you can enable~~ by ~~amending~~ <tt>/etc/nixos/configuration.nix</tt> ~~as follows~~:

<li>Enable GIMP support in xsane by editing <tt>/etc/nixos/configuration.nix.</tt> Remove <tt>pkgs.xsane</tt> from your package list, and use the following instead:

<syntaxhighlight lang="nix">{

...

#...

~~nixpkgs~~.~~config.packageOverrides~~ = ~~pkgs: {~~

environment.systemPackages = [

~~xsaneGimp =~~ pkgs.xsane.override { gimpSupport = true; };

(pkgs.xsane.override { gimpSupport = true; })

};

];

...

#...

}</syntaxhighlight></li>

<li>Rebuild: <syntaxhighlight lang="console">$ sudo nixos-rebuild switch</syntaxhighlight></li>

Line 140:

Line 148:

==Network scanning==

If ~~NixOs~~ cannot find a scanner located on your network, you may be interested in adding in your <tt>configuration.nix</tt>:

If NixOS cannot find a scanner located on your network, you may be interested in adding in your <tt>configuration.nix</tt>:

<syntaxhighlight lang="nix">{

Line 166:

Line 174:

==Using the scanner button==

Many scanners feature a hardware button which makes for very convenient operation, especially in combination with an automated document processing system like <tt>paperless</tt>. NixOS includes the scanner button daemon <tt>scanbd</tt> which can be used for this purpose; however, its setup isn't terribly user friendly.

Line 358:

Line 367:

};

}</syntaxhighlight>

==See also==

Line 365:

Line 373:

* [https://download.tuxfamily.org/xcfaudio/ Misc Agfa Snapscan] | [https://ipfs.io/ipfs/QmZJ2SfpfYUAS23TujhcdLpTox1SW3Dw3MoCej9GAfs4ya IPFS mirror]

~~[[Category:Configuration]]~~[[Category:Hardware]]

[[Category:Hardware]]

@@ Line 1: / Line 1: @@
 ==Installing scanner support==
-Scanner support is provided by the SANE library. To enable scanner support, amend <tt>/etc/nixos/configuration.nix</tt>:
+Scanner support is provided by the [http://www.sane-project.org SANE] library. To enable scanner support, amend your system configuration like so:
+{{file|/etc/nixos/configuration.nix|nix|<nowiki>
-<syntaxhighlight lang="nix">
 {
    ...
-   hardware.sane.enable = true;
+   hardware.sane.enable = true; # enables support for SANE scanners
    ...
 }
-</syntaxhighlight>
+</nowiki>}}
+Users in the <code>scanner</code> group will gain access to the scanner, or the <code>lp</code> group if it’s also a printer. To add yourself to these groups, amend your system configuration as follows:
-It is also very likely that users will required to be in the following groups <tt>scanner</tt> and <tt>lp</tt>, so you can for example configure it as follow on NixOs (don't forget to login/logout after rebuilding NixOs):
+{{file|/etc/nixos/configuration.nix|nix|<nowiki>
-<syntaxhighlight lang="nix">
 {
    ...
-    users.users.YOURUSERNAME.extraGroups = [ "scanner" "lp" ];
+  users.users.YOURUSERNAME.extraGroups = [ "scanner" "lp" ];
    ...
 }
-</syntaxhighlight>
+</nowiki>}}
 {{evaluate}}
-{{Tip|The detection of installed backends by SANE depends on the <tt>LD_LIBRARY_PATH</tt> environment variable, which is set at login. You will need to '''logout''' and '''login''' again for backend changes to take effect after <tt>nixos-rebuild switch</tt>.}}
+{{Tip|The detection of installed backends by SANE depends on the <code>LD_LIBRARY_PATH</code> environment variable, which is set at login. You will need to '''logout''' and '''login''' again for backend changes to take effect after evaluation.}}
 ==Testing scanner support==
@@ Line 30: / Line 25: @@
 </syntaxhighlight>
-If you can only see scanners when running as root, try adding the user to the <tt>scanner</tt> or <tt>lp</tt> either using the configuration given above, or using the following code (beware, don't forget to logout/login after running this command):
+If you can only see scanners when running as root, try adding the user to the <tt>scanner</tt> or <tt>lp</tt> groups, either using the method given above, or as follows (beware, don't forget to logout/login after running this command):
 <syntaxhighlight lang="console">
 $ sudo usermod -a -G scanner,lp username
@@ Line 36: / Line 31: @@
 ==Supported backends==
-See the [http://www.sane-project.org/sane-supported-devices.html Supported Devices] page to see if your scanner is supported. Some backends are proprietary and are not installed by default; see below. You may also be interested by "driverless" scanning (see below) if your scanner support the Apple AirScan and/or the Microsoft WSD, Apple maintains a list of compatible devices [https://support.apple.com/en-us/HT201311 here].
+See the [http://www.sane-project.org/sane-supported-devices.html Supported Devices] page to check if your scanner is supported. Some backends are proprietary and are not installed by default; see below. You may also be interested in "driverless" scanning (see below) if your scanner supports Apple AirScan and/or Microsoft WSD.
 ===Driverless Apple AirScan and Microsoft WSD===
-A large number of printers now support "driverless" scanning. As explained  [https://github.com/alexpevzner/sane-airscan on the sane-airscan backend project]:
+A large number of printers now support "driverless" scanning. As explained [https://github.com/alexpevzner/sane-airscan at the sane-airscan backend project]:
 <blockquote>
@@ Line 46: / Line 41: @@
 * Apple AirScan or AirPrint scanning (official protocol name is eSCL)
-* Microsoft WSD, or WS-Scan (term WSD means "Web Services for Devices)
+* Microsoft WSD, or WS-Scan (Web Services for Devices)
-This backend implements both protocols, choosing automatically between them. It was successfully tested with many devices from '''Brother, Canon, Dell, Kyocera, Lexmark, Epson, HP, Panasonic, Ricoh, Samsung and Xerox''' both in WSD and eSCL modes.
+This backend implements both protocols, choosing automatically between them. It was successfully tested with many devices from Brother, Canon, Dell, Kyocera, Lexmark, Epson, HP, Panasonic, Ricoh, Samsung and Xerox, both in WSD and eSCL modes.
-For eSCL devices, Apple maintains a [https://support.apple.com/en-us/HT201311 '''comprehensive list of compatible devices'''], but please note, this list contains not only scanners and MFP, but pure printers as well.
+For eSCL devices, Apple maintains a [https://support.apple.com/en-us/HT201311 comprehensive list of compatible devices]. This list has scanners, multifunction devices and pure printers.
 </blockquote>
-To enable Apple AirScan/Microsoft WSD "driverless" scanning: use the <tt>sane-airscan</tt> drivers:
+eSCL/Apple Airscan scanners should be found natively by the default escl backend. However, the <tt>sane-airscan</tt> third party backend is more actively maintained and you may have better luck using it:
 <syntaxhighlight lang="nix">
 hardware.sane.extraBackends = [ pkgs.sane-airscan ];
+services.udev.packages = [ pkgs.sane-airscan ];
+</syntaxhighlight>
+It can be that your scanner is found twice (once by <tt>escl</tt> and once by <tt>airscan</tt>, in this case disable <tt>escl</tt>:
+<syntaxhighlight lang="nix">
+hardware.sane.disabledDefaultBackends = [ "escl" ];
+</syntaxhighlight>
+To detect Microsoft WSD "driverless" scanning, also use the <tt>sane-airscan</tt> backend.
+If the scanner is connected by USB, also set the following option:
+<syntaxhighlight lang="nix">
+services.ipp-usb.enable=true;
 </syntaxhighlight>
@@ Line 124: / Line 132: @@
 <ol>
-<li>You need to install a special version of xsane, which you can enable by amending <tt>/etc/nixos/configuration.nix</tt> as follows:
+<li>Enable GIMP support in xsane by editing <tt>/etc/nixos/configuration.nix.</tt> Remove <tt>pkgs.xsane</tt> from your package list, and use the following instead:
 <syntaxhighlight lang="nix">{
-   ...
+   #...
-   nixpkgs.config.packageOverrides = pkgs: {
+   environment.systemPackages = [
-     xsaneGimp = pkgs.xsane.override { gimpSupport = true; };
+     (pkgs.xsane.override { gimpSupport = true; })
-   };
+   ];
-   ...
+   #...
 }</syntaxhighlight></li>
 <li>Rebuild: <syntaxhighlight lang="console">$ sudo nixos-rebuild switch</syntaxhighlight></li>
@@ Line 140: / Line 148: @@
 ==Network scanning==
-If NixOs cannot find a scanner located on your network, you may be interested in adding in your <tt>configuration.nix</tt>:
+If NixOS cannot find a scanner located on your network, you may be interested in adding in your <tt>configuration.nix</tt>:
 <syntaxhighlight lang="nix">{
@@ Line 166: / Line 174: @@
 ==Using the scanner button==
+{{WOC}}
 Many scanners feature a hardware button which makes for very convenient operation, especially in combination with an automated document processing system like <tt>paperless</tt>.  NixOS includes the scanner button daemon <tt>scanbd</tt> which can be used for this purpose; however, its setup isn't terribly user friendly.
@@ Line 358: / Line 367: @@
        };
 }</syntaxhighlight>
 ==See also==
@@ Line 365: / Line 373: @@
 * [https://download.tuxfamily.org/xcfaudio/ Misc Agfa Snapscan] | [https://ipfs.io/ipfs/QmZJ2SfpfYUAS23TujhcdLpTox1SW3Dw3MoCej9GAfs4ya IPFS mirror]
-[[Category:Configuration]][[Category:Hardware]]
+[[Category:Hardware]]