Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yushulx/docscan4nodejs
Node.js wrapper for Dynamsoft Service, supporting document scanning from TWAIN, WIA, ICA, SANE and eSCL scanners.
https://github.com/yushulx/docscan4nodejs
document escl ica sane scanner twain wia
Last synced: 4 days ago
JSON representation
Node.js wrapper for Dynamsoft Service, supporting document scanning from TWAIN, WIA, ICA, SANE and eSCL scanners.
- Host: GitHub
- URL: https://github.com/yushulx/docscan4nodejs
- Owner: yushulx
- License: mit
- Created: 2023-09-06T07:47:34.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-15T03:25:57.000Z (about 1 year ago)
- Last Synced: 2024-10-08T08:08:12.493Z (3 months ago)
- Topics: document, escl, ica, sane, scanner, twain, wia
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/docscan4nodejs
- Size: 70.3 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# docscan4nodejs
The package provides Node.js APIs for invoking **Dynamsoft Service REST API**. It helps developers to create **desktop** or **server-side** document scanning applications with ease.
## Supported Scanner Drivers
- TWAIN
- WIA
- SANE
- ICA
- eSCL
## Supported Platforms
- Windows
- Linux
- macOS
## Prerequisites
- Install Dynamsoft 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)
- Request a [free trial license](https://www.dynamsoft.com/customer/license/trialLicense?product=dwt) for Dynamsoft Service.
## Dynamsoft Service Configuration
After installing the Dynamsoft Service, navigate to `http://127.0.0.1:18625/` in a web browser to configure the host and port settings. The default host IP address is set to 127.0.0.1. If you wish to make the service accessible over the local network in your office or company, you can update the host setting to a LAN IP address, such as **192.168.8.72**.
## REST API Reference
By default, the REST API's host address is set to `http://127.0.0.1:18622`.
| Method | Endpoint | Description | Parameters | Response |
|--------|-----------------|-------------------------------|------------------------------------|-------------------------------|
| GET | `/DWTAPI/Scanners` | Get a list of scanners | None | `200 OK` with scanner list |
| POST | `/DWTAPI/ScanJobs` | Creates a scan job | `license`, `device`, `config` | `201 Created` with job ID |
| GET | `/DWTAPI/ScanJobs/:id/NextDocument`| Retrieves a document image | `id`: Job ID | `200 OK` with image stream |
| DELETE | `/DWTAPI/ScanJobs/:id`| Deletes a scan job | `id`: Job ID | `200 OK` |
## Node.js API
- `getDevices(host, scannerType)` - Get all available scanners. It returns an array of scanner objects.
- `scanDocument(host, parameters, timeout)` - Create a scanner job by feeding one or multiple physical documents. It returns the job id.
- `getImageFile(host, jobId, directory)` - Get one document image by job id. The directory specifies the physical location to save the images. It returns the image path.
- `getImageFiles(host, jobId, directory)` - Get document images by job id. The directory specifies the physical location to save the images. It returns an array of image paths.
- `deleteJob(host, jobId)` - Delete a scan job by job id. It can interrupt the scan process.
- `getImageStreams(host, jobId)` - Get document images by job id. It returns an array of image streams.
## Parameter Configuration
The parameter configuration is based on [Dynamsoft Web TWAIN documentation](https://www.dynamsoft.com/web-twain/docs/info/api/Interfaces.html#DeviceConfiguration). It controls the behavior of the scanner.
For example, you can set the resolution to 200 DPI and the pixel type to color:
```js
let parameters = {
license: "LICENSE-KEY",
device: devices[index].device,
};
parameters.config = {
IfShowUI: false,
PixelType: 2, // color
Resolution: 200,
IfFeederEnabled: false,
IfDuplexEnabled: false,
};
```
## Examples
Set the `LICENSE-KEY` before running the following examples.
- [Command-line](https://github.com/yushulx/dynamsoft-service-REST-API/tree/main/examples/command-line)
Get all available scanners
Acquire a Document
- [Web server](https://github.com/yushulx/dynamsoft-service-REST-API/tree/main/examples/web)
