Scanners - Revision history

Clean.lock: Add example for network-attached epkowa scanner

2025-09-28T00:16:53Z

Add example for network-attached epkowa scanner

← Older revision		Revision as of 00:16, 28 September 2025
Line 72:		Line 72:

	===Epson===		===Epson===
	If your scanner is listed as supported by the <tt>epkowa</tt> backend:		If your scanner is listed as supported by the <tt>epkowa</tt> backend and is connected by USB or SCSI:

	<syntaxhighlight lang="nix">hardware.sane.extraBackends = [ pkgs.epkowa ];</syntaxhighlight>		<syntaxhighlight lang="nix">hardware.sane.extraBackends = [ pkgs.epkowa ];</syntaxhighlight>

			If your scanner is listed as supported by the <tt>epkowa</tt> backend and is on the network,
			substitute the host name or IP address in:

			<syntaxhighlight lang="nix">
			hardware.sane.extraBackends = [
			(pkgs.epkowa.overrideAttrs (oldAttrs: {
			postInstall = oldAttrs.postInstall + ''
			echo "net epson10a2e0.local" >> $out/etc/sane.d/epkowa.conf
			'';
			}))
			];
			</syntaxhighlight>

	Some other scanners (see [https://gitlab.com/utsushi/utsushi/blob/master/README list]) need the <tt>utsushi</tt> backend:		Some other scanners (see [https://gitlab.com/utsushi/utsushi/blob/master/README list]) need the <tt>utsushi</tt> backend:

DoggoBit: Mark wall of config

2025-08-25T19:11:33Z

Mark wall of config

← Older revision		Revision as of 19:11, 25 August 2025
Line 174:		Line 174:

	==Using the scanner button==		==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.		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 366:		Line 367:
	};		};
	}</syntaxhighlight>		}</syntaxhighlight>


	==See also==		==See also==

Starfish2228: /* GIMP support */ Fix code example

2025-01-30T15:01:25Z

GIMP support: Fix code example

← Older revision		Revision as of 15:01, 30 January 2025
Line 132:		Line 132:

	<ol>		<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">{		<syntaxhighlight lang="nix">{
	...		#...
	~~nixpkgs~~.~~config.packageOverrides~~ = ~~pkgs: {~~		environment.systemPackages = [
	~~xsaneGimp =~~ pkgs.xsane.override { gimpSupport = true; };		(pkgs.xsane.override { gimpSupport = true; })
	};		];
	...		#...
	}</syntaxhighlight></li>		}</syntaxhighlight></li>
	<li>Rebuild: <syntaxhighlight lang="console">$ sudo nixos-rebuild switch</syntaxhighlight></li>		<li>Rebuild: <syntaxhighlight lang="console">$ sudo nixos-rebuild switch</syntaxhighlight></li>
Line 148:		Line 148:
	==Network scanning==		==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">{		<syntaxhighlight lang="nix">{

Mic92: /* Supported backends */

2024-08-12T10:49:06Z

Supported backends

← Older revision		Revision as of 10:49, 12 August 2024
Line 52:		Line 52:
	<syntaxhighlight lang="nix">		<syntaxhighlight lang="nix">
	hardware.sane.extraBackends = [ pkgs.sane-airscan ];		hardware.sane.extraBackends = [ pkgs.sane-airscan ];
			services.udev.packages = [ pkgs.sane-airscan ];
	</syntaxhighlight>		</syntaxhighlight>

Klinger at 19:59, 19 April 2024

2024-04-19T19:59:57Z

← Older revision		Revision as of 19:59, 19 April 2024
Line 372:		Line 372:
	* [https://download.tuxfamily.org/xcfaudio/ Misc Agfa Snapscan] \| [https://ipfs.io/ipfs/QmZJ2SfpfYUAS23TujhcdLpTox1SW3Dw3MoCej9GAfs4ya IPFS mirror]		* [https://download.tuxfamily.org/xcfaudio/ Misc Agfa Snapscan] \| [https://ipfs.io/ipfs/QmZJ2SfpfYUAS23TujhcdLpTox1SW3Dw3MoCej9GAfs4ya IPFS mirror]

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

imported>Symphorien: explain escl vs airscan

2024-02-07T18:32:47Z

explain escl vs airscan

← Older revision		Revision as of 18:32, 7 February 2024
Line 48:		Line 48:
	</blockquote>		</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">		<syntaxhighlight lang="nix">
	hardware.sane.extraBackends = [ pkgs.sane-airscan ];		hardware.sane.extraBackends = [ pkgs.sane-airscan ];
	</syntaxhighlight>		</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:		If the scanner is connected by USB, also set the following option:

imported>Skylark: Copyedit (no changes in content) + remove duplication of Apple list

2023-10-16T12:41:28Z

Copyedit (no changes in content) + remove duplication of Apple list

← Older revision		Revision as of 12:41, 16 October 2023
Line 25:		Line 25:
	</syntaxhighlight>		</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">		<syntaxhighlight lang="console">
	$ sudo usermod -a -G scanner,lp username		$ sudo usermod -a -G scanner,lp username
Line 31:		Line 31:

	==Supported backends==		==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===		===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>		<blockquote>
Line 41:		Line 41:

	* Apple AirScan or AirPrint scanning (official protocol name is eSCL)		* 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>		</blockquote>

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

	<syntaxhighlight lang="nix">		<syntaxhighlight lang="nix">
Line 54:		Line 54:
	</syntaxhighlight>		</syntaxhighlight>

	If the scanner is an USB ~~scanner~~, also set the following option:		If the scanner is connected by USB, also set the following option:
	<syntaxhighlight lang="nix">		<syntaxhighlight lang="nix">
	services.ipp-usb.enable=true;		services.ipp-usb.enable=true;

imported>Jiltq: syntax + wording + parity with manual

2023-10-11T17:44:25Z

syntax + wording + parity with manual

← Older revision		Revision as of 17:44, 11 October 2023
Line 1:		Line 1:
	==Installing scanner support==		==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}}		{{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==		==Testing scanner support==

imported>Symphorien: usb case for driverless printing

2022-12-11T16:56:48Z

usb case for driverless printing

← Older revision		Revision as of 16:56, 11 December 2022
Line 57:		Line 57:
	<syntaxhighlight lang="nix">		<syntaxhighlight lang="nix">
	hardware.sane.extraBackends = [ pkgs.sane-airscan ];		hardware.sane.extraBackends = [ pkgs.sane-airscan ];
			</syntaxhighlight>

			If the scanner is an USB scanner, also set the following option:
			<syntaxhighlight lang="nix">
			services.ipp-usb.enable=true;
	</syntaxhighlight>		</syntaxhighlight>

imported>Artturin at 19:06, 23 April 2022

2022-04-23T19:06:25Z

← Older revision		Revision as of 19:06, 23 April 2022
Line 36:		Line 36:

	==Supported backends==		==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 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].

	===Driverless Apple AirScan and Microsoft WSD===		===Driverless Apple AirScan and Microsoft WSD===
Line 79:		Line 79:
	<syntaxhighlight lang="nix">{		<syntaxhighlight lang="nix">{
	hardware.sane.enable = true;		hardware.sane.enable = true;
			hardware.sane.drivers.scanSnap.enable = true;
			# the below may be necessary
	nixpkgs.config.sane.snapscanFirmware = pkgs.fetchurl {		nixpkgs.config.sane.snapscanFirmware = pkgs.fetchurl {
	# https://wiki.ubuntuusers.de/Scanner/Epson_Perfection/#Unterstuetzte-Geraete		# https://wiki.ubuntuusers.de/Scanner/Epson_Perfection/#Unterstuetzte-Geraete
Line 91:		Line 93:
	<syntaxhighlight lang="nix">{		<syntaxhighlight lang="nix">{
	...		...
	imports = [		imports = [
	<nixpkgs/nixos/modules/services/hardware/sane_extra_backends/brscan4.nix>		<nixpkgs/nixos/modules/services/hardware/sane_extra_backends/brscan4.nix>
	./hardware-configuration.nix		./hardware-configuration.nix
	];		];
	...		...
	}</syntaxhighlight>		}</syntaxhighlight>

Line 127:		Line 129:
	...		...
	nixpkgs.config.packageOverrides = pkgs: {		nixpkgs.config.packageOverrides = pkgs: {
	xsaneGimp = pkgs.xsane.override { gimpSupport = true; };		xsaneGimp = pkgs.xsane.override { gimpSupport = true; };
	};		};
	...		...