Introduction

The purpose of this library is to provide a client to the Scanner Access Now Easy (SANE) daemon. This allows Java programmers to obtain images from SANE image sources over a network.

For example, you can do the following:

SaneSession session = SaneSession.withRemoteSane(InetAddress.getByName("my-sane-server.intranet"));
List<SaneDevice> devices = session.listDevices();
SaneDevice device = ...;  // determine which device you want to use
device.open();

BufferedImage image = device.acquireImage();  // scan an image

See the CommonOperations wiki page for a fairly comprehensive introduction to using JFreeSane.

This code was written because we had a need to integrate image acquisition with a Java web application we are writing. As such we have an interest in continuing to add missing functionality.

Usage

The easiest way to get this software is using Maven. Put the following in your pom.xml:

<project>
  ...
  <dependencies>
     ...
     <dependency>
       <groupId>com.googlecode.jfreesane</groupId>
       <artifactId>jfreesane</artifactId>
       <version>0.6</version>
     </dependency>
   </dependencies>
</project>

Otherwise, you can just download the jar file and put it in your project's CLASSPATH. JFreeSane also depends on Google Guava, an excellent collection of Java libraries that you should be using in your project anyway. You will need to download the Guava JAR file and put that in your classpath as well.

Once JFreeSane is available on your classpath, see the CommonOperations wiki page for a tutorial on how to use it.

Also consider joining the jfreesane-discuss mailing list. It is a low-volume list where people can discuss JFreeSane, release announcements are made and issues are reported.

Limitations

JFreeSane currently cannot be used to obtain images from a handheld scanner.

JFreeSane currently does not support using SANE authenticated resources (i.e. a username and password).

JFreeSane must be used with a running SANE daemon. It will not run SANE for you. It cannot talk to your scanners without a SANE daemon.

Please contribute

If you've been looking for a Java SANE client and you're familiar with SANE, please consider contributing documentation or patches. The easiest way to get started with Eclipse is to do this:

$ hg clone https://jfreesane.googlecode.com/hg/ jfreesane
$ cd jfreesane
jfreesane$ mvn eclipse:configure-workspace -Declipse.workspace=/path/to/eclipse/workspace  # eclipse workspace, not working directory
jfreesane$ mvn eclipse:eclipse

# run eclipse, import existing project, specify this jfreesane directory as the project root
# start hacking