Skip to content

Python binding for the Sane API (using ctypes) and abstration layers

License

Notifications You must be signed in to change notification settings

kingmoonracer/pyinsane

 
 

Repository files navigation

PyInsane

Description

Python implementation of the Sane API (using ctypes) and abstration layer.

The code is divided in 3 layers:

  • rawapi : Ctypes binding to the raw Sane API
  • abstract : An Object-Oriented layer that simplifies the use of the Sane API and try to avoid possible misuse of the Sane API. When scanning, it also takes care of returning a PIL image.
  • abstract_th : The Sane API is not thread-safe and cannot be used in a multi-threaded environment easily. This layer solves this problem but using a fully dedicated thread.

Dependencies

libsane

Installation

$ sudo python ./setup.py install

Unit tests

$ python ./run_tests.py

Unit tests require at least one scanner with a flatbed and an ADF (Automatic Document Feeder).

If possible, they should be run with at least 2 scanners connected. The first that appear in "scanimage -L" must be the one with the ADF.

My current setup:

  • HP Officejet 4500 G510g (Flatbed + ADF)
  • HP Deskjet 2050 J510 series (Flatbed)

Usage

Scanner detection

import pyinsane.abstract as pyinsane

devices = pyinsane.get_devices()
assert(len(devices) > 0)
device = devices[0]
print "I'm going to use the following scanner: %s" % (str(device))
scanner_id = device.name

or if you already know its name/id:

import pyinsane.abstract as pyinsane

device = pyinsane.Scanner(name="somethingsomething")
print "I'm going to use the following scanner: %s" % (str(device))

Simple scan

device.options['resolution'].value = 300
# Beware: Some scanner have "Lineart" or "Gray" as default mode
device.options['mode'].value = 'Color'
scan_instance = device.scan(multiple=False)
try:
	while True:
		scan_instance.read()
except EOFError:
	pass
image = scan_instance.get_img()

Multiple scans using an automatic document feeder (ADF)

if not "ADF" in device.options['source'].constraint:
	print "No document feeder found"
	return

device.options['source'].value = "ADF"
# Beware: Some scanner have "Lineart" or "Gray" as default mode
device.options['mode'].value = 'Color'
scan_instance = device.scan(multiple=True)
try:
	while True:
		try:
			scan_instance.read()
		except EOFError:
			print ("Got a page ! (current number of pages read: %d)"
				   % (scan_instance.get_nb_img()))
except StopIteration:
	print "Document feeder is now empty"
for idx in range(0, scan_instance.get_nb_img())
	image = scan_instance.get_img(idx)

Abstract_th

import pyinsane.abstract_th as pyinsane

# When imported, it will start a new thread, dedicated to Sane.
# Its API is the same than for pyinsane.abstract. You can use it the
# same way.
# Note however that the Sane thread can only do one thing at a time,
# so some function call may be on hold on a semaphore for some times.

Licence

GPL v3 2012(c) Jerome Flesch (jflesch@gmail.com)

About

Python binding for the Sane API (using ctypes) and abstration layers

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%