https://github.com/yushulx/flutter_twain_scanner
Flutter wrapper for Dynamic Web TWAIN Service, supporting document scanning from TWAIN, WIA, ICA, SANE and eSCL scanners.
https://github.com/yushulx/flutter_twain_scanner
document escl ica sane scanner twain wia
Last synced: 5 months ago
JSON representation
Flutter wrapper for Dynamic Web TWAIN Service, supporting document scanning from TWAIN, WIA, ICA, SANE and eSCL scanners.
- Host: GitHub
- URL: https://github.com/yushulx/flutter_twain_scanner
- Owner: yushulx
- License: mit
- Created: 2022-12-30T14:25:25.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-05-08T01:03:09.000Z (about 1 year ago)
- Last Synced: 2025-05-08T02:19:39.089Z (about 1 year ago)
- Topics: document, escl, ica, sane, scanner, twain, wia
- Language: C++
- Homepage: https://pub.dev/packages/flutter_twain_scanner
- Size: 7.77 MB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Flutter Document Scanner SDK for TWAIN, WIA, SANE, ICA and eSCL Scanners
A Flutter plugin that enables you to develop cross-platform applications for digitizing documents from **TWAIN (32-bit/64-bit)**, **WIA**, **SANE**, **ICA** and **eSCL** scanners. The plugin offers callable methods for both [open-source TWAIN](https://github.com/twain/twain-samples) (**64-bit only**) and the **Dynamic Web TWAIN Service REST API**.
## ⚙️ Prerequisites
### ✅ Install Dynamic Web TWAIN Service
- **Windows**: [Dynamsoft-Service-Setup.msi](https://demo.dynamsoft.com/DWT/DWTResources/dist/DynamsoftServiceSetup.msi)
- **macOS**: [Dynamsoft-Service-Setup.pkg](https://demo.dynamsoft.com/DWT/DWTResources/dist/DynamsoftServiceSetup.pkg)
- **Linux**:
- [Dynamsoft-Service-Setup.deb](https://demo.dynamsoft.com/DWT/DWTResources/dist/DynamsoftServiceSetup.deb)
- [Dynamsoft-Service-Setup-arm64.deb](https://demo.dynamsoft.com/DWT/DWTResources/dist/DynamsoftServiceSetup-arm64.deb)
- [Dynamsoft-Service-Setup-mips64el.deb](https://demo.dynamsoft.com/DWT/DWTResources/dist/DynamsoftServiceSetup-mips64el.deb)
- [Dynamsoft-Service-Setup.rpm](https://demo.dynamsoft.com/DWT/DWTResources/dist/DynamsoftServiceSetup.rpm)
### 🔑 Get a License
Request a [free trial license](https://www.dynamsoft.com/customer/license/trialLicense/?product=dcv&package=cross-platform).
## 🧩 Configuration
After installation, open `http://127.0.0.1:18625/` in your browser to configure the **host** and **port** settings.
> By default, the service is bound to `127.0.0.1`. To access it across the LAN, change the host to your local IP (e.g., `192.168.8.72`).
## 📡 REST API Endpoints
[https://www.dynamsoft.com/web-twain/docs/info/api/restful.html](https://www.dynamsoft.com/web-twain/docs/info/api/restful.html)
## 📚 API Reference for Dynamic Web TWAIN Service
### Scanner Methods
| Method | Description |
|--------|-------------|
| `Future> getDevices(String host, [int? scannerType])` | Get a list of scanning devices |
| `Future> createJob(String host, Map parameters)` | Create a scanning job |
| `Future> checkJob(String host, String jobId)` | Check the status of a scan job |
| `Future> updateJob(String host, String jobId, Map parameters)` | Update a scan job (e.g., cancel it) |
| `Future deleteJob(String host, String jobId)` | Delete a scan job |
| `Future> getImageFiles(String host, String jobId, String directory)` | Download and save scanned images |
| `Future> getImageStreams(String host, String jobId)` | Get scanned images as byte streams |
| `Future> getImageInfo(String host, String jobId)` | Get info about the next scanned image |
| `Future> getScannerCapabilities(String host, String jobId)` | Get supported scanner settings |
The scanner parameter configuration is based on [Dynamsoft Web TWAIN documentation](https://www.dynamsoft.com/web-twain/docs/info/api/Interfaces.html#DeviceConfiguration).
### Document Methods
| Method | Description |
|--------|-------------|
| `Future> createDocument(String host, Map parameters)` | Create a document |
| `Future> getDocumentInfo(String host, String docId)` | Get document metadata |
| `Future deleteDocument(String host, String docId)` | Delete a document |
| `Future getDocumentFile(String host, String docId, String directory)` | Download a document PDF to local disk |
| `Future getDocumentStream(String host, String docId)` | Get a document as a byte stream |
| `Future> insertPage(String host, String docId, Map parameters)` | Insert a new page into a document |
| `Future deletePage(String host, String docId, String pageId)` | Delete a page from a document |
## 🖥️ API Reference for Open Source TWAIN (Windows 64-bit only)
### Scanner Methods
| Method | Description |
|--------|-------------|
| `Future> getDataSources()` | Get a list of TWAIN compatible scanners |
| `Future> scanDocument(int sourceIndex)` | Scan documents from a selected scanner |