search

abusenius / insaned

Simple daemon for polling button presses on SANE scanners
GNU General Public License v2.0
43 stars 13 forks source link

readme

Insaned

Insaned is a simple linux daemon for polling button presses on SANE scanners.

Build Status Coverity Scan Build Status

Description

Insaned periodically polls your scanner using the SANE library and runs the corresponding event handler script when a button is pressed. Because of this, button presses are only detected every N milliseconds, so you will have to press and hold the button for at most N milliseconds until an event is fired. Insaned does only fire the same event once in 2500 ms to prevent unwanted repetitions.

It should work with all backends that expose buttons as "Sensors". The daemon reads the value of all sensors every N milliseconds (default: 500) and starts an event handler script named by the sensor name. Polling does not result in a noticeable CPU load, but produces some I/O load. Therefore, it might not be a good idea to run this daemon on a laptop, since it will probably prevent USB bus from entering a low power mode or even keep the laptop awake (not tested yet).

Currently, insaned was tested on:

Why

I've tried scanbuttond and scanbd.

Supported devices

You can check if SANE exposes sensors of your scanner by running:

scanimage -A

You should be able to see a list of detected sensors and their current state. If you press and hold a button while running scanimage -A, you should be able to see a different sensor value.

For example, this is the output for my scanner, when I press the "file" button (note the [yes]):

All options specific to device `genesys:libusb:001:003':
  Scan Mode:
...
<snip>
...
  Sensors:
    --scan[=(yes|no)] [no] [hardware]
        Scan button
    --file[=(yes|no)] [yes] [hardware]
        File button
    --email[=(yes|no)] [no] [hardware]
        Email button
    --copy[=(yes|no)] [no] [hardware]
        Copy button
    --extra[=(yes|no)] [no] [hardware]
        Extra button
  Buttons:
    --clear-calibration
        Clear calibration cache

In this case, insaned detects all of my 5 buttons and emits events named "scan", "file", "email", "copy" and "extra".

Event Handler Scripts

Event handler scripts are simple shell scripts. Insaned searches for them in /etc/insaned/events/ directory (configurable). The daemon passes current SANE device name as the first and only argument to the script, in case you need to distinguish between several scanners.

All event handler scripts have to exist and have to have the executable flag set, otherwise insaned will print warnings. Create an empty executable file to silence the warning, e.g. like this:

touch /etc/insaned/events/scan
chmod +x /etc/insaned/events/scan

Dependencies

Installation

To compile insaned, run:

make

in the project directory. The daemon will be created in the project directory and called "insaned". You can run it in foreground for testing purposes as follows:

./insaned --dont-fork --events-dir=$PWD/events --log-file=$PWD/log.log -vv

See also

./insaned --help --list-sensors

for more details.

Tips and tricks

If you happen to have a system where SANE headers (sane/sane.h) and libraries (libsane.so) are installed in an unusual location and simple make fails to compile insaned, try to provide paths to headers and libraries as follows:

CXXFLAGS=-I/path/to/your/usr/include LDFLAGS=-L/path/to/your/usr/lib make

Gentoo Linux

  1. Add media-gfx/insaned/insaned-0.0.3.ebuild to media-gfx/insaned in your local overlay.
  2. cd $YOUR_OVERLAY/media-gfx/insaned
  3. ebuild insaned-0.0.3.ebuild manifest
  4. emerge insaned

Ubuntu Linux (64 bit)

  1. Download insaned_0.0.3-0ubuntu1_amd64.deb
  2. sudo dpkg -i insaned_0.0.3-0ubuntu1_amd64.deb

FreeBSD

  1. Use gmake instead of make to compile insaned.
  2. If gmake also doesn't work, see Tips and tricks above
  3. In order to automatically start insaned when the scanner is connected or turned on and stop it when the scanner is disconnected/turned off use provided devd/insaned.conf example

Side note

I am not responsible for any physical or mental damage insaned might cause to you, your hardware or your pet. Use it on your own risk.

That said, any help is welcomed. Feel free to contact me if you have any comments/suggestions/patches. Especially interesting are reports if it works with another scanners. Please make sure to include the output of "insaned -L" to your report, and, if you have any problems, also the output of "scanimage -A".

TODO

The following features are planned: