APPENDIX
C
Optical Scanners
Revised: February 16, 2016
Appendix Overview
An optical scanner can be connected to the IEC to allow end users to scan a document at the kiosk.
This appendix explains how to implement optical scanners connected to the IECs.
Topics in this appendix include:
•
“Optical Scanner Compatibility”
•
“Optical Scanner Implementation”
– “global.scanner Object”
– “Best Practices and Tips”
– “Testing the Scanner Widget”
Optical Scanner Compatibility
Refer to Appendix A for the list of optical scanners that have been tested with the IEC.
Note
Other scanner models may also be compatible.
Optical Scanner Implementation
global.scanner Object
The global.scanner object implements an interface for optical scanners allowing an application displayed
on a kiosk to scan and manipulate a document. The scanner library used is from SANE and the list of
compatible devices can be found here: http://www.sane-project.org/sane-supported-devices.html
The global.scanner object code is:
interface Scanner
Cisco Interactive Experience Client User Guide
C-1
Appendix C
Optical Scanners
Optical Scanner Implementation
{
attribute uint dpiX;
attribute uint dpiY;
attribute bool color;
attribute string source;
readonly attribute List<String> devices;
readonly attribute List<String> sources;
readonly attribute string lastError;
readonly attribute string base64Data;
readonly attribute bool busy;
void setCurrentScanner(in string deviceName);
signals:
void finished();
void error(out string error);
slots:
start();
stop();
shutdown();
};
Table C-1
Variable
Description
dpiX
DPI X of the selected scanner
dpiY
DPI Y of the selected scanner
color
Is selected scanner in color mode
source
Document source
devices
List of available scanners
sources
List of available document sources
lastError
Last error occurred
base64Data
Scanned image as base64 JPEG data
busy
Check if the scanner is busy
setCurrentScanner(in string deviceName)
Set the current scanner to use. You need to call
this method before scanning.
finished()
The scanner has finished scanning
error(out string error)
An error has occurred
start()
Start scanning from the selected scanner and
document source
stop()
Stop scanning
shutdown()
Shutdown scanning subsystem and reset all
internal caches
Cisco Interactive Experience Client User Guide
C-2
global.scanner Object Variables
Appendix C
Optical Scanners
Optical Scanner Implementation
Best Practices and Tips
•
Make sure to have the location of the file as a URL.
•
Copy the above contents to an HTML file and transfer the file to a web server from where it can be
accessed.
•
The scanner must be connected to the IEC. Reboot the IEC after connecting the scanner.
Testing the Scanner Widget
There are two ways to test the scanner widget:
1.
Using the policy:
1.
Create a policy with startup URL as the URL of the scanner HTML and apply the policy
As a result, the IEC boots up with the scanner policy loaded.
2.
Using the Kiosk menu:
1.
On the IEC, press Ctl + Alt + S and then choose Kiosk
2.
Enter the scanner widget URL
3.
Reboot the IEC
As a result, the IEC boots up with the scanner URL loaded.
Cisco Interactive Experience Client User Guide
C-3
Appendix C
Optical Scanner Implementation
Cisco Interactive Experience Client User Guide
C-4
Optical Scanners