Vintasoft Web TWAIN service (Linux edition)
In This Topic
VintaSoft Web TWAIN service (Linux edition) is the Linux service that provides Web API for accessing TWAIN, SANE and eSCL image scanners for all users of Linux computer.
VintaSoft Web TWAIN service (Linux edition) is a native Linux application, which is compiled using .NET 8.0, and it can be used on Linux (Ubuntu 23/22/20/18; Debian 12/11/10; Fedora 39/38/37/36) computer.
VintaSoft Web TWAIN service (Linux edition) provides the access to 64-bit TWAIN and SANE image scanners, eSCL image scanners.
VintaSoft Web TWAIN service (Linux edition) can be accessed via HTTPS protocol using URL "https://localhost:25329/api/VintasoftTwainApi" or via HTTP protocol using URL "http://localhost:25319/api/VintasoftTwainApi".
Network ports 25319 and 25329 can be changed after installation of VintaSoft Web TWAIN service (Linux edition).
1. Installation of Vintasoft Web TWAIN service (Linux edition) to a Debian/Ubuntu computer
For installing VintaSoft Web Twain service (Linux edition) to your Debian/Ubuntu computer you should do the following steps:
-
Download DEB-package VintasoftWebTwainService-15.2.0.deb from URL: https://www.vintasoft.com/zip/VintasoftWebTwainService-15.2.0.deb
-
Run the following command in console:
sudo dpkg -i VintasoftWebTwainService-15.2.0.deb
Files of Vintasoft Web TWAIN service (Linux edition) will be installed into folder "/opt/vintasoft/VintasoftWebTwainService/".
2. Uninstallation of Vintasoft Web TWAIN service (Linux edition) from Debian/Ubuntu computer
For uninstalling VintaSoft Web Twain service (Linux edition) from your Debian/Ubuntu computer you should do the following steps:
-
Run the following command in console:
sudo dpkg -r VintasoftWebTwainService
3. Installation of Vintasoft Web TWAIN service (Linux edition) to a Fedora computer
For installing VintaSoft Web Twain service (Linux edition) to your Fedora computer you should do the following steps:
-
Download RPM-package VintasoftWebTwainService-15.2.0.rpm from URL: https://www.vintasoft.com/zip/VintasoftWebTwainService-15.2.0.rpm
-
Run the following command in console:
sudo rpm -i VintasoftWebTwainService-15.2.0.rpm
Files of Vintasoft Web TWAIN service (Linux edition) will be installed into folder "/opt/vintasoft/VintasoftWebTwainService/".
4. Uninstallation of Vintasoft Web TWAIN service (Linux edition) from Fedora computer
For uninstalling VintaSoft Web Twain service (Linux edition) from your Fedora computer you should do the following steps:
-
Run the following command in console:
sudo rpm -e VintasoftWebTwainService
5. Initialization of Vintasoft Web TWAIN service (Linux edition)
Vintasoft Web TWAIN service (Linux edition) has initialization file - "VintasoftWebTwainService.ini" file, which is located in folder "/opt/vintasoft/VintasoftWebTwainService/".
"VintasoftWebTwainService.ini" file can contain the following settings:
- HTTPSERVICEPORT - defines the network port for web server that serves HTTP requests to the service. Default value is 25319.
- HTTPSSERVICEPORT - defines the network port for web server that serves HTTPS requests to the service. Default value is 25329.
- ISTWAINSUPPORTENABLED - defines a value whether TWAIN support is enabled. 0 - TWAIN support is disabled; 1 - TWAIN support is enabled.
- ISSANESUPPORTENABLED - defines a value whether SANE support is enabled. 0 - SANE support is disabled; 1 - SANE support is enabled.
- ISESCLSUPPORTENABLED - defines a value whether eSCL support is enabled. 0 - eSCL support is disabled; 1 - eSCL support is enabled.
-
LOGGING - defines the logging mode for the service. This parameter can have the following values: 0 - logging is disabled; 1 - logging is enabled; 2 - extended logging is enabled. Default value is 0.
If logging is enabled, the service saves log-information for TWAIN devices to a log-file "C:\Users\%USERNAME%\AppData\Local\Temp\VSWebTwainService64-debug.log".
If logging is enabled, the service saves log-information for SANE devices to a log-file "C:\Users\%USERNAME%\AppData\Local\Temp\VSWebSaneService64-debug.log".
If logging is enabled, the service saves log-information for eSCL devices to a log-file "C:\Users\%USERNAME%\AppData\Local\Temp\VSWebEsclService-debug.log".
- ALLOWABLESESSIONINACTIVITYTIME - defines the interval, in milliseconds, during which the session must be refreshed, i.e. marked as active. Default value is 120000 milliseconds (2 minutes). Minimum value is 100, maximum value is 3600000.
6. Getting information about the status of Vintasoft Web TWAIN service
Vintasoft Web TWAIN service (Linux edition) consists from web TWAIN service (files VintasoftAspNetCoreTwainService64 and VintasoftAspNetCoreTwainService64.dll), which serves web requests to TWAIN, SANE and eSCL image scanners.
Information about status of web TWAIN service (VintasoftAspNetCoreTwainService64 file) is saved into log-file "/opt/vintasoft/VintasoftWebTwainService/logs/VintasoftAspNetCoreTwainService64.log".
Debug information about work with 64-bit TWAIN devices is saved into log-file "/opt/vintasoft/VintasoftWebTwainService/logs/VSWebTwainService64-debug.log" if TWAIN logging is enabled.
Debug information about work with 64-bit SANE devices is saved into log-file "/opt/vintasoft/VintasoftWebTwainService/logs/VSWebSaneService64-debug.log" if TWAIN logging is enabled.
Debug information about work with eSCL devices is saved into log-file "/opt/vintasoft/VintasoftWebTwainService/logs/VSWebEsclService-debug.log" if TWAIN logging is enabled.
7. Troubleshooting
7.1 VintaSoft Web TWAIN service is not available
If you have installed VintaSoft Web TWAIN service (Linux edition) to your Linux computer, but still see the error message that service is not available, please do the following steps:
-
Unregister the Vintasoft Web TWAIN service (Linux edition) using the following console command:
sudo /opt/vintasoft/VintasoftWebTwainService/VintasoftAspNetCoreTwainService64 /unregister
-
Register the Vintasoft Web TWAIN service (Linux edition) using the following console command:
sudo /opt/vintasoft/VintasoftWebTwainService/VintasoftAspNetCoreTwainService64 /register
- Open URL "https://localhost:25329/api/VintasoftTwainApi/Status" and see information about the online status of Vintasoft Web TWAIN service.
7.2. TWAIN/SANE image scanner works not correctly
If VintaSoft Web TWAIN service (Linux edition) is working, but you have a problem with TWAIN image scanner, we recommend you to try the following things:
-
Get the latest version of TWAIN driver for your TWAIN image scanner from web site of TWAIN image scanner manufacturer and re-install the TWAIN driver.
-
Make sure you have the latest version of VintaSoft Web Twain service (Linux edition).
-
If you still have the problem, please send information about your problem to our support team and we will try to help you.
We need:
- Snippet of your code. Working project which demonstrates the problem will be welcome.
- Log-file generated by VintaSoft Web Twain service. Please read how to enable logging for VintaSoft Web Twain service (Linux edition) in "Initialization of Vintasoft Web TWAIN service" section above.
If you can get device list in your web application but you cannot acquire images from SANE device, please do the following steps:
-
Install "xsane" application if "xsane" is not installed on your Linux computer. Run "xsane" application and try to acquire images from your SANE image scanner using "xsane".
-
If "xsane" cannot acquire images from your SANE device, you need try to update SANE driver for your SANE image scanner.
-
If "xsane" can acquire images from your SANE device, make sure you have the latest version of VintaSoft Web Twain service (Linux edition).
-
If you still have the problem, please send information about your problem to our support team and we will try to help you.
We need:
- Snippet of your code. Working project which demonstrates the problem will be welcome.
- Log-file generated by VintaSoft Web Twain service. Please read how to enable logging for VintaSoft Web Twain service (Linux edition) in "Initialization of Vintasoft Web TWAIN service" section above.