node-hp-scan-to 1.8.0 → 1.9.1

package/README.md

@@ -5,7 +5,6 @@
 ![npm](https://img.shields.io/npm/v/node-hp-scan-to)
 [![npm](https://img.shields.io/npm/dt/node-hp-scan-to)](https://www.npmjs.com/package/node-hp-scan-to)
 [![Docker Pulls](https://img.shields.io/docker/pulls/manuc66/node-hp-scan-to)](https://hub.docker.com/repository/docker/manuc66/node-hp-scan-to)
-[![Gitter](https://badges.gitter.im/node-hp-scan-to/community.svg)](https://gitter.im/node-hp-scan-to/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 [![CodeFactor](https://www.codefactor.io/repository/github/manuc66/node-hp-scan-to/badge)](https://www.codefactor.io/repository/github/manuc66/node-hp-scan-to)
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fmanuc66%2Fnode-hp-scan-to.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fmanuc66%2Fnode-hp-scan-to?ref=badge_shield)
 
@@ -13,7 +12,8 @@
 
 Unlike the original HP program, `node-hp-scan-to` is cross-platform and can be run on a bare-metal desktop or server, or in a container on Docker or Kubernetes. It can also be integrated with third-party document management solutions such as [Paperless-ngx](https://docs.paperless-ngx.com/) and [Nextcloud](https://Nextcloud.com/).
 
-**Disclaimer:** `node-hp-scan-to` is not endorsed by nor affiliated with HP. The reverse engineering of the original HP Windows application's interaction with the device has been done independently.
+**Disclaimer:** _This project is neither endorsed by nor affiliated with Hewlett-Packard (HP). Any mention or reference to HP is purely descriptive and non-commercial. All reverse engineering of HP's official Windows application and its interaction with devices has been performed independently without cooperation from HP. __This software is provided as-is for educational and personal use only__._
+
 
 <!-- TOC -->
 
@@ -34,6 +34,7 @@ Unlike the original HP program, `node-hp-scan-to` is cross-platform and can be r
     - [Example for Docker](#example-for-docker)
     - [Example for Docker Compose](#example-for-docker-compose)
   - [Run with Kubernetes](#run-with-kubernetes)
+  - [Configure](#Configure)
 - [Build Source Code](#build-source-code)
   - [Debugging](#debugging)
 - [💖 Support this project](#-support-this-project)
@@ -55,9 +56,9 @@ This app has been developed and tested with the following HP All-in-One Printers
 
 Users have reported it also working on:
 
-- HP DeskJet 3050 (J610a), 3775, 4670, 5525
-- HP Envy 4504, 4520, 7640
-- HP OfficeJet 250 Mobile, 3830, 5230, 5740, 6700 Premium, 6950, 8010 series, 8025e, 9012e
+- HP DeskJet 3050 (J610a),3522, 3775, 4670, 5525
+- HP Envy 4504, 4520, 5530, 7640
+- HP OfficeJet 250 Mobile, 3830, 5230, 5740, 6700 Premium, 6950, Pro 7730, 8010 series, 8025e, 9012e
 - HP PageWide 377dw MFP
 
 There is a good chance it also works on other unlisted HP All-in-One Printer.
@@ -81,6 +82,16 @@ There is a good chance it also works on other unlisted HP All-in-One Printer.
   - Local folders
   - [Paperless-ngx API](https://docs.paperless-ngx.com/api/) upload
   - [Nextcloud WebDAV](https://docs.Nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) upload
+ 
+### Emulated Duplex Scanning Feature
+
+The emulated duplex scanning feature allows users to efficiently scan both sides of a document, even on devices that do not natively support duplex scanning.
+
+When enabled (as an opt-in feature), it adds an extra entry in the list of scan destinations, labeled with the "duplex" suffix. When you select this option for the first time, the device scans the front side of the document.
+
+After the front side is scanned, if you choose the duplex option again, the device will trigger a second scan and produce an assembled output.
+
+If you decide not to scan the back side immediately, the front side scan will be saved in the system and will remain there until you either scan the back side or perform a single side scan instead.
 
 ## Installation
 
@@ -100,6 +111,19 @@ There is a good chance it also works on other unlisted HP All-in-One Printer.
 
 - For running with Docker Compose, see the [Example for Docker Compose](#example-for-docker-compose) section
 
+### Using Arch Linux (AUR)
+
+- The package is available in the Arch User Repository (AUR) as `node-hp-scan-to`
+
+- Install it using your preferred AUR helper, for example:
+  ```bash
+  yay -S node-hp-scan-to
+  ```
+  or
+  ```bash
+  paru -S node-hp-scan-to
+  ```
+
 ## Usage
 
 ### Command Line (CLI)
@@ -121,27 +145,28 @@ Example usage:
 
 Run `npx node-hp-scan-to --help` to see the full list of options below:
 
-| Option                          | Description                                                                                                      | Example/Default                                      |
-|---------------------------------|------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|
-| `-a`, `--address`               | Printer IP address.                                                                                              | `-a 192.168.0.5` (no default)                        |
-| `-d`, `--directory`             | Directory to save scanned documents. Defaults to `/tmp/scan-to-pc<random value>` if not set.                     | `-d /tmp/scan-to-pc1234`                             |
-| `-D`, `--debug`                 | Enable debug logging.                                                                                            | `-D` (disabled by default)                          |
-| `-h`, `--height`                | Scan height in pixels. Defaults to 3507.                                                                         | `-h 3507`                                            |
-| `-k`, `--keep-files`            | Retain scanned files after uploading to Paperless-ngx or Nextcloud (disabled by default).                        | `-k` (disabled by default)                          |
-| `-l`, `--label`                 | The name of the computer running this app. Defaults to the hostname.                                             | `-l <hostname>` (default: system hostname)           |
-| `-n`, `--name`                  | Printer name (quote if it contains spaces).                                                                      | `-n "Officejet 6500 E710n-z"` (no default)           |
-| `-o`, `--paperless-token`       | Paperless-ngx API token.                                                                                         | `-o xxxxxxxxxxxx` (no default)                      |
-| `-p`, `--pattern`               | Filename pattern (no extension). Use quotes for static text, supports date/time masks (see [dateformat docs](https://www.npmjs.com/package/dateformat#mask-options)). Defaults to `scan<increasing number>_page<page number>`. | `-p scan1_page1`                                    |
-| `-r`, `--resolution`            | Scan resolution in DPI. Defaults to 200.                                                                         | `-r 200`                                             |
+| Option                                | Description                                                                                                      | Example/Default                                                   |
+|---------------------------------------|------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------|
+| `-a`, `--address`                     | Printer IP address.                                                                                              | `-a 192.168.0.5` (no default)                                     |
+| `-d`, `--directory`                   | Directory to save scanned documents. Defaults to `/tmp/scan-to-pc<random value>` if not set.                     | `-d /tmp/scan-to-pc1234`                                          |
+| `-D`, `--debug`                       | Enable debug logging.                                                                                            | `-D` (disabled by default)                                        |
+| `-h`, `--height`                      | Scan height in pixels. Defaults to 3507.                                                                         | `-h 3507`                                                         |
+| `-k`, `--keep-files`                  | Retain scanned files after uploading to Paperless-ngx or Nextcloud (disabled by default).                        | `-k` (disabled by default)                                        |
+| `-l`, `--label`                       | The name of the computer running this app. Defaults to the hostname.                                             | `-l <hostname>` (default: system hostname)                        |
+| `-n`, `--name`                        | Printer name (quote if it contains spaces).                                                                      | `-n "Officejet 6500 E710n-z"` (no default)                        |
+| `-o`, `--paperless-token`             | Paperless-ngx API token.                                                                                         | `-o xxxxxxxxxxxx` (no default)                                    |
+| `-p`, `--pattern`                     | Filename pattern (no extension). Use quotes for static text, supports date/time masks (see [dateformat docs](https://www.npmjs.com/package/dateformat#mask-options)). Defaults to `scan<increasing number>_page<page number>`. | `-p scan1_page1`                                                  |
+| `-r`, `--resolution`                  | Scan resolution in DPI. Defaults to 200.                                                                         | `-r 200`                                                          |
+| `--mode <mode> `                      | Selects the scan mode (default: Color) (choices: "Gray", "Color").                                               | `--mode Gray`                                                     |
 | `-s`, `--paperless-post-document-url` | Paperless-ngx API URL for uploading documents.                                                             | `-s https://domain.tld/api/documents/post_document/` (no default) |
-| `-t`, `--temp-directory`        | Temporary directory for processing. Defaults to `/tmp/scan-to-pc<random value>` if not set.                      | `-t /tmp/scan-to-pc5678`                             |
-| `-w`, `--width`                 | Scan width in pixels. Defaults to 2481.                                                                          | `-w 2481`                                            |
-| `--device-up-polling-interval`  | Polling interval (in milliseconds) to check if the printer is online.                                            | `--device-up-polling-interval 5000` (no default)     |
-| `--nextcloud-password`          | Nextcloud app password. Required unless `--nextcloud-password-file` is used. Overrides if both are provided.     | `--nextcloud-password mypassword` (no default)      |
-| `--nextcloud-password-file`     | File containing the Nextcloud app password. Required unless `--nextcloud-password` is used. Takes precedence if both are provided. | `--nextcloud-password-file /path/to/file` (no default) |
-| `--nextcloud-upload-folder`     | Nextcloud folder for uploads. Defaults to `scan`.                                                                | `--nextcloud-upload-folder scan`                    |
-| `--nextcloud-url`               | Nextcloud instance URL.                                                                                          | `--nextcloud-url https://domain.tld` (no default)   |
-| `--nextcloud-username`          | Nextcloud username with write access to the upload folder.                                                       | `--nextcloud-username user` (no default)            |
+| `-t`, `--temp-directory`              | Temporary directory for processing. Defaults to `/tmp/scan-to-pc<random value>` if not set.                      | `-t /tmp/scan-to-pc5678`                                          |
+| `-w`, `--width`                       | Scan width in pixels. Defaults to 2481.                                                                          | `-w 2481`                                                         |
+| `--device-up-polling-interval`        | Polling interval (in milliseconds) to check if the printer is online.                                            | `--device-up-polling-interval 5000` (no default)                  |
+| `--nextcloud-password`                | Nextcloud app password. Required unless `--nextcloud-password-file` is used. Overrides if both are provided.     | `--nextcloud-password mypassword` (no default)                    |
+| `--nextcloud-password-file`           | File containing the Nextcloud app password. Required unless `--nextcloud-password` is used. Takes precedence if both are provided. | `--nextcloud-password-file /path/to/file` (no default)            |
+| `--nextcloud-upload-folder`           | Nextcloud folder for uploads. Defaults to `scan`.                                                                | `--nextcloud-upload-folder scan`                                  |
+| `--nextcloud-url`                     | Nextcloud instance URL.                                                                                          | `--nextcloud-url https://domain.tld` (no default)                 |
+| `--nextcloud-username`                | Nextcloud username with write access to the upload folder.                                                       | `--nextcloud-username user` (no default)                          |
 
 **Notes:**
 
@@ -157,18 +182,120 @@ By default, this app runs the `listen` command as the default mode. It will list
 
 Run `npx node-hp-scan-to listen --help` to get the full list of command options.
 
+<!-- BEGIN HELP command: listen -->
+```text
+Usage:  listen [options]
+
+Listen the device for new scan job to save to this target
+
+Output Options:
+  -d, --directory <dir>                                            Directory where scans are saved (default: /tmp/scan-to-pcRANDOM)
+  -p, --pattern <pattern>                                          Pattern for filename (i.e. "scan"_dd.mm.yyyy_hh:MM:ss, default would be scanPageNUMBER), make sure that the pattern is enclosed in extra quotes
+  -k, --keep-files                                                 Keep the scan files on the file system when sent to external systems for local backup and easy access (default: false)
+
+Scan Options:
+  -r, --resolution <dpi>                                           Resolution in DPI of the scans (default: 200)
+  --mode <mode>                                                    Selects the scan mode (default: Color) (choices: "Gray", "Color")
+  -w, --width <width>                                              Width in pixels of the scans (default: max)
+  -h, --height <height>                                            Height in pixels of the scans (default: max)
+  -t, --temp-directory <dir>                                       Temp directory used for processing (default: /tmp/scan-to-pcRANDOM)
+  --prefer-eSCL                                                    Prefer eSCL protocol if available
+
+Options:
+  --device-up-polling-interval <deviceUpPollingInterval>           Device up polling interval in milliseconds
+  --help                                                           display help for command
+
+Paperless Options:
+  -s, --paperless-post-document-url <paperless_post_document_url>  The paperless post document url (example: https://domain.tld/api/documents/post_document/)
+  -o, --paperless-token <paperless_token>                          The paperless token
+  --paperless-group-multi-page-scan-into-a-pdf                     Combine multiple scanned images into a single PDF document
+  --paperless-always-send-as-pdf-file                              Always convert scan job to pdf before sending to paperless
+
+Nextcloud Options:
+  --nextcloud-url <nextcloud_url>                                  The nextcloud url (example: https://domain.tld)
+  --nextcloud-username <nextcloud_username>                        The nextcloud username
+  --nextcloud-password <nextcloud_app_password>                    The nextcloud app password for username. Either this or nextcloud-password-file is required
+  --nextcloud-password-file <nextcloud_app_password_file>          File name that contains the nextcloud app password for username. Either this or nextcloud-password is required
+  --nextcloud-upload-folder <nextcloud_upload_folder>              The upload folder where documents or images are uploaded (default: scan)
+
+Device Control Screen Options:
+  -l, --label <label>                                              The label to display on the device (the default is the hostname)
+  --add-emulated-duplex [mode]                                     Enable emulated duplex scanning, with optional assembly mode (default: document-wise) (choices: "page-wise", "document-wise", "reverse-front", "reverse-both")
+  --emulated-duplex-label <label>                                  The emulated duplex label to display on the device (the default is to suffix the main label with duplex)
+
+Global Options:
+  -a, --address <ip>                                               IP address of the device, when specified, the ip will be used instead of the name
+  -n, --name <name>                                                Name of the device to lookup for on the network
+  -D, --debug                                                      Enable debug
+  --health-check                                                   Start an http health check endpoint
+  --health-check-port <health-check-port>                          Define the port for the HTTP health check endpoint
+```
+<!-- END HELP command: listen -->
+
 ##### `adf-autoscan`
 
 Running `npx node-hp-scan-to adf-autoscan` will automatically trigger a scan job as soon as the ADF (automatic document feeder) on the printer's scanner is loaded with paper.
 
-Run `npx node-hp-scan-to adf-autoscan --help` to get command line usage help.
-
 You can also set the environment variable `MAIN_COMMAND="adf-autoscan"` with Docker. Example:
 
 ```sh
-docker run -e MAIN_COMMAND="adf-autoscan" CMDLINE=--debug docker.io/manuc66/node-hp-scan-to:latest
+docker run -e MAIN_COMMAND="adf-autoscan" -e CMDLINE=--debug docker.io/manuc66/node-hp-scan-to:latest
 ```
 
+Run `npx node-hp-scan-to adf-autoscan --help` to get command line usage help.
+
+<!-- BEGIN HELP command: adf-autoscan -->
+```text
+Usage:  adf-autoscan [options]
+
+Automatically trigger a new scan job to this target once paper is detected in
+the automatic document feeder (adf)
+
+Output Options:
+  -d, --directory <dir>                                            Directory where scans are saved (default: /tmp/scan-to-pcRANDOM)
+  -p, --pattern <pattern>                                          Pattern for filename (i.e. "scan"_dd.mm.yyyy_hh:MM:ss, default would be scanPageNUMBER), make sure that the pattern is enclosed in extra quotes
+  -k, --keep-files                                                 Keep the scan files on the file system when sent to external systems for local backup and easy access (default: false)
+  --pdf                                                            If specified, the scan result will always be a pdf document, the default depends on the device choice
+
+Scan Options:
+  -r, --resolution <dpi>                                           Resolution in DPI of the scans (default: 200)
+  --mode <mode>                                                    Selects the scan mode (default: Color) (choices: "Gray", "Color")
+  -w, --width <width>                                              Width in pixels of the scans (default: max)
+  -h, --height <height>                                            Height in pixels of the scans (default: max)
+  -t, --temp-directory <dir>                                       Temp directory used for processing (default: /tmp/scan-to-pcRANDOM)
+  --prefer-eSCL                                                    Prefer eSCL protocol if available
+  --duplex                                                         If specified, all the scans will be in duplex if the device support it
+
+Options:
+  --device-up-polling-interval <deviceUpPollingInterval>           Device up polling interval in milliseconds
+  --help                                                           display help for command
+
+Paperless Options:
+  -s, --paperless-post-document-url <paperless_post_document_url>  The paperless post document url (example: https://domain.tld/api/documents/post_document/)
+  -o, --paperless-token <paperless_token>                          The paperless token
+  --paperless-group-multi-page-scan-into-a-pdf                     Combine multiple scanned images into a single PDF document
+  --paperless-always-send-as-pdf-file                              Always convert scan job to pdf before sending to paperless
+
+Nextcloud Options:
+  --nextcloud-url <nextcloud_url>                                  The nextcloud url (example: https://domain.tld)
+  --nextcloud-username <nextcloud_username>                        The nextcloud username
+  --nextcloud-password <nextcloud_app_password>                    The nextcloud app password for username. Either this or nextcloud-password-file is required
+  --nextcloud-password-file <nextcloud_app_password_file>          File name that contains the nextcloud app password for username. Either this or nextcloud-password is required
+  --nextcloud-upload-folder <nextcloud_upload_folder>              The upload folder where documents or images are uploaded (default: scan)
+
+Auto-scan Options:
+  --pollingInterval <pollingInterval>                              Time interval in millisecond between each lookup for content in the automatic document feeder
+  --start-scan-delay <startScanDelay>                              Once document are detected to be in the adf, this specify the wait delay in millisecond before triggering the scan
+
+Global Options:
+  -a, --address <ip>                                               IP address of the device, when specified, the ip will be used instead of the name
+  -n, --name <name>                                                Name of the device to lookup for on the network
+  -D, --debug                                                      Enable debug
+  --health-check                                                   Start an http health check endpoint
+  --health-check-port <health-check-port>                          Define the port for the HTTP health check endpoint
+```
+<!-- END HELP command: adf-autoscan -->
+
 ##### `clear-registrations`
 
 Running `npx node-hp-scan-to clear-registratons` will clear all registered targets on the device (useful for trial and error and debugging).
@@ -181,11 +308,97 @@ You can also set the environment variable `MAIN_COMMAND="clear-registrations"` w
 docker run -e MAIN_COMMAND="clear-registrations" docker.io/manuc66/node-hp-scan-to:latest
 ```
 
+<!-- BEGIN HELP command: clear-registrations -->
+```text
+Usage:  clear-registrations [options]
+
+Clear the list or registered target on the device
+
+Options:
+  -h, --help                               display help for command
+
+Global Options:
+  -a, --address <ip>                       IP address of the device, when specified, the ip will be used instead of the name
+  -n, --name <name>                        Name of the device to lookup for on the network
+  -D, --debug                              Enable debug
+  --health-check                           Start an http health check endpoint
+  --health-check-port <health-check-port>  Define the port for the HTTP health check endpoint
+```
+<!-- END HELP command: clear-registrations -->
+
+##### `single-scan`
+
+Running `npx node-hp-scan-to single-scan` will directly issue a single scan job
+
+Run `npx node-hp-scan-to single-scan --help` to get command line usage help.
+
+You can also set the environment variable `MAIN_COMMAND="single-scan"` with Docker. Example:
+
+```sh
+docker run -e MAIN_COMMAND="single-scan" docker.io/manuc66/node-hp-scan-to:latest
+```
+
+<!-- BEGIN HELP command: single-scan -->
+```text
+Usage:  single-scan [options]
+
+Trigger a new scan job
+
+Output Options:
+  -d, --directory <dir>                                            Directory where scans are saved (default: /tmp/scan-to-pcRANDOM)
+  -p, --pattern <pattern>                                          Pattern for filename (i.e. "scan"_dd.mm.yyyy_hh:MM:ss, default would be scanPageNUMBER), make sure that the pattern is enclosed in extra quotes
+  -k, --keep-files                                                 Keep the scan files on the file system when sent to external systems for local backup and easy access (default: false)
+  --pdf                                                            If specified, the scan result will always be a pdf document, the default depends on the device choice
+
+Scan Options:
+  -r, --resolution <dpi>                                           Resolution in DPI of the scans (default: 200)
+  --mode <mode>                                                    Selects the scan mode (default: Color) (choices: "Gray", "Color")
+  -w, --width <width>                                              Width in pixels of the scans (default: max)
+  -h, --height <height>                                            Height in pixels of the scans (default: max)
+  -t, --temp-directory <dir>                                       Temp directory used for processing (default: /tmp/scan-to-pcRANDOM)
+  --prefer-eSCL                                                    Prefer eSCL protocol if available
+  --duplex                                                         If specified, all the scans will be in duplex if the device support it
+
+Options:
+  --device-up-polling-interval <deviceUpPollingInterval>           Device up polling interval in milliseconds
+  --help                                                           display help for command
+
+Paperless Options:
+  -s, --paperless-post-document-url <paperless_post_document_url>  The paperless post document url (example: https://domain.tld/api/documents/post_document/)
+  -o, --paperless-token <paperless_token>                          The paperless token
+  --paperless-group-multi-page-scan-into-a-pdf                     Combine multiple scanned images into a single PDF document
+  --paperless-always-send-as-pdf-file                              Always convert scan job to pdf before sending to paperless
+
+Nextcloud Options:
+  --nextcloud-url <nextcloud_url>                                  The nextcloud url (example: https://domain.tld)
+  --nextcloud-username <nextcloud_username>                        The nextcloud username
+  --nextcloud-password <nextcloud_app_password>                    The nextcloud app password for username. Either this or nextcloud-password-file is required
+  --nextcloud-password-file <nextcloud_app_password_file>          File name that contains the nextcloud app password for username. Either this or nextcloud-password is required
+  --nextcloud-upload-folder <nextcloud_upload_folder>              The upload folder where documents or images are uploaded (default: scan)
+
+Global Options:
+  -a, --address <ip>                                               IP address of the device, when specified, the ip will be used instead of the name
+  -n, --name <name>                                                Name of the device to lookup for on the network
+  -D, --debug                                                      Enable debug
+  --health-check                                                   Start an http health check endpoint
+  --health-check-port <health-check-port>                          Define the port for the HTTP health check endpoint
+```
+<!-- END HELP command: single-scan -->
+
 ### Run with Docker
 
 #### Public Pre-Built Docker image
 
-- <https://hub.docker.com/repository/docker/manuc66/node-hp-scan-to>
+<https://hub.docker.com/repository/docker/manuc66/node-hp-scan-to>
+
+The Docker images follow semantic versioning:
+- `latest`: Latest stable release (includes all patch updates)
+- `x.y.z`: Specific version (e.g., `1.2.3`)
+- `x.y`: Latest patch version of a specific minor version (e.g., `1.2`)
+- `x`: Latest minor.patch version of a specific major version (e.g., `1`)
+- `master`: Latest build from the master branch (development version)
+
+Note: For most users, the `latest` tag is recommended as it includes all patch updates and bug fixes.
 
 Be aware that with Docker you have to specify the IP address of the printer via the `IP` environment variable, because the Bonjour service discovery protocol uses multicast network traffic, which by default doesn't work in Docker.
 
@@ -197,26 +410,28 @@ All scanned files are written to the volume `/scan`, the filename can be changed
 
 List of supported environment variables and their meaning, or correspondence with [command-line flags](#cli-options):
 
-| Environment Variable            | Description                                                                                              | Corresponding CLI Flag or Notes                                                                                   |
-|---------------------------------|----------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|
-| `CMDLINE`                       | Additional command-line flags added at the end of the command                                            | Set to `-D` to enable debug logs                                                                                |
-| `DIR`                           | Directory to use                                                                                         | `-d` / `--directory`                                                                                            |
-| `IP`                            | IP address for the program                                                                               | `-a` / `--address`                                                                                              |
-| `KEEP_FILES`                    | If set, scanned files are not deleted after uploading to Paperless-ngx or Nextcloud                      |                                                                                                                  |
-| `LABEL`                         | Label to apply                                                                                           | `-l` / `--label`                                                                                                |
-| `NAME`                          | Name to set                                                                                              | `-n` / `--name`                                                                                                 |
-| `NEXTCLOUD_PASSWORD`            | Password of Nextcloud user (either this or `NEXTCLOUD_PASSWORD_FILE` is required; file takes precedence) |                                                                                                                  |
-| `NEXTCLOUD_PASSWORD_FILE`       | File containing Nextcloud user password (either this or `NEXTCLOUD_PASSWORD` is required; takes precedence) | Example: `./nextcloud_password.secret` (preferred for Docker Compose secrets)                                   |
-| `NEXTCLOUD_UPLOAD_FOLDER`       | Upload folder for documents or images (user must have write permission; defaults to `scan` if not set)   |                                                                                                                  |
-| `NEXTCLOUD_URL`                 | Nextcloud URL                                                                                            | Example: `https://nextcloud.example.tld`                                                                        |
-| `NEXTCLOUD_USERNAME`            | Nextcloud username                                                                                       |                                                                                                                  |
-| `PAPERLESS_POST_DOCUMENT_URL`   | Paperless-ngx post document URL (if provided with token, a PDF is uploaded)                              | Example: `http://<paperless-host>:<port>/api/documents/post_document/`                                          |
-| `PAPERLESS_TOKEN`               | Paperless-ngx API token                                                                                  | Example: `xxxxxxxxxxxx...`                                                                                      |
-| `PATTERN`                       | Pattern to use                                                                                           | `-p` / `--pattern`                                                                                              |
-| `PGID`                          | ID of the group that will run the program                                                                |                                                                                                                  |
-| `PUID`                          | ID of the user that will run the program                                                                 |                                                                                                                  |
-| `RESOLUTION`                    | Resolution setting                                                                                       | `-r` / `--resolution`                                                                                           |
-| `TEMP_DIR`                      | Temporary directory                                                                                      | `-t` / `--temp-directory`                                                                                       |
+| Environment Variable          | Description                                                                                                 | Corresponding CLI Flag or Notes                                               |
+|-------------------------------|-------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|
+| `CMDLINE`                     | Additional command-line flags added at the end of the command                                               | Set to `-D` to enable debug logs                                              |
+| `DIR`                         | Directory to use                                                                                            | `-d` / `--directory`                                                          |
+| `IP`                          | IP address for the program                                                                                  | `-a` / `--address`                                                            |
+| `KEEP_FILES`                  | If set, scanned files are not deleted after uploading to Paperless-ngx or Nextcloud                         |                                                                               |
+| `LABEL`                       | Label to set on the device's display as a scan target                                                       | `-l` / `--label`                                                              |
+| `NAME`                        | Name of the device to lookup for on the network                                                             | `-n` / `--name`                                                               |
+| `ADD_EMULATED_DUPLEX`         | Enable emulated duplex scanning, with optional assembly mode (default: document-wise)                       | `--add-emulated-duplex [mode]`                                                |
+| `NEXTCLOUD_PASSWORD`          | Password of Nextcloud user (either this or `NEXTCLOUD_PASSWORD_FILE` is required; file takes precedence)    |                                                                               |
+| `NEXTCLOUD_PASSWORD_FILE`     | File containing Nextcloud user password (either this or `NEXTCLOUD_PASSWORD` is required; takes precedence) | Example: `./nextcloud_password.secret` (preferred for Docker Compose secrets) |
+| `NEXTCLOUD_UPLOAD_FOLDER`     | Upload folder for documents or images (user must have write permission; defaults to `scan` if not set)      |                                                                               |
+| `NEXTCLOUD_URL`               | Nextcloud URL                                                                                               | Example: `https://nextcloud.example.tld`                                      |
+| `NEXTCLOUD_USERNAME`          | Nextcloud username                                                                                          |                                                                               |
+| `PAPERLESS_POST_DOCUMENT_URL` | Paperless-ngx post document URL (if provided with token, a PDF is uploaded)                                 | Example: `http://<paperless-host>:<port>/api/documents/post_document/`        |
+| `PAPERLESS_TOKEN`             | Paperless-ngx API token                                                                                     | Example: `xxxxxxxxxxxx...`                                                    |
+| `PATTERN`                     | Pattern to use                                                                                              | `-p` / `--pattern`                                                            |
+| `PGID`                        | ID of the group that will run the program                                                                   |                                                                               |
+| `PUID`                        | ID of the user that will run the program                                                                    |                                                                               |
+| `RESOLUTION`                  | Resolution setting                                                                                          | `-r` / `--resolution`                                                         |
+| `MODE`                        | Scan mode setting                                                                                           | `--mode`                                                                      |
+| `TEMP_DIR`                    | Temporary directory                                                                                         | `-t` / `--temp-directory`                                                     |
 
 **Additional Notes:**
 
@@ -262,8 +477,8 @@ services:
       # If you need to pass additional configuration flag use the CMDLINE env, thy will be appened to the
       # - CMDLINE=--debug --pdf
       # If using Paperless-ngx, you can use its API to upload files:
-      # - PAPERLESS_POST_DOCUMENT_URL="http://<paperless-host>:<port>/api/documents/post_document/"
-      # - PAPERLESS_TOKEN= "xxxxxxxxxxxx..."
+      # - PAPERLESS_POST_DOCUMENT_URL=http://<paperless-host>:<port>/api/documents/post_document/
+      # - PAPERLESS_TOKEN= xxxxxxxxxxxx...
     volumes:
       - ./scan:/scan
 ```
@@ -322,6 +537,12 @@ spec:
             claimName: incoming-scans
 ```
 
+### Configure
+
+Configuration can be done in a config file instead of using command line switches or environment variables in docker. The schema of the configuration file can be found in [FileConfig](src/type/FileConfig.ts)
+
+The configuration file is handled by https://www.npmjs.com/package/config
+
 ## Build Source Code
 
 How to build and run the project's source code:

package/dist/HPApi.d.ts

@@ -6,7 +6,6 @@ import WalkupScanDestination from "./hpModels/WalkupScanDestination";
 import WalkupScanToCompDestination from "./hpModels/WalkupScanToCompDestination";
 import WalkupScanDestinations from "./hpModels/WalkupScanDestinations";
 import WalkupScanToCompDestinations from "./hpModels/WalkupScanToCompDestinations";
-import ScanJobSettings from "./hpModels/ScanJobSettings";
 import Destination from "./hpModels/Destination";
 import WalkupScanToCompEvent from "./hpModels/WalkupScanToCompEvent";
 import DiscoveryTree from "./type/DiscoveryTree";
@@ -15,6 +14,11 @@ import WalkupScanToCompCaps from "./hpModels/WalkupScanToCompCaps";
 import WalkupScanManifest from "./hpModels/WalkupScanManifest";
 import ScanJobManifest from "./hpModels/ScanJobManifest";
 import ScanCaps from "./hpModels/ScanCaps";
+import EsclScanJobManifest from "./hpModels/EsclManifest";
+import EsclScanCaps from "./hpModels/EsclScanCaps";
+import EsclScanStatus from "./hpModels/EsclScanStatus";
+import { IScanJobSettings } from "./hpModels/IScanJobSettings";
+import EsclScanImageInfo from "./hpModels/EsclScanImageInfo";
 export default class HPApi {
     static setDeviceIP(ip: string): void;
     static setDebug(dbg: boolean): void;
@@ -29,7 +33,9 @@ export default class HPApi {
     static getWalkupScanManifest(uri: string): Promise<WalkupScanManifest>;
     static getWalkupScanToCompManifest(uri: string): Promise<WalkupScanToCompManifest>;
     static getScanJobManifest(uri: string): Promise<ScanJobManifest>;
+    static getEsclScanJobManifest(uri: string): Promise<EsclScanJobManifest>;
     static getScanCaps(uri: string): Promise<ScanCaps>;
+    static getEsclScanCaps(uri: string): Promise<EsclScanCaps>;
     static getWalkupScanToCompCaps(uri: string): Promise<WalkupScanToCompCaps>;
     static getWalkupScanToCompEvent(compEventURI: string): Promise<WalkupScanToCompEvent>;
     static removeDestination(walkupScanDestination: WalkupScanDestination | WalkupScanToCompDestination): Promise<boolean>;
@@ -40,12 +46,16 @@ export default class HPApi {
     static appendTimeout(url: string, timeout?: number | null): string;
     static getDestination(destinationURL: string): Promise<WalkupScanDestination | WalkupScanToCompDestination>;
     static getScanStatus(): Promise<ScanStatus>;
+    static getEsclScanStatus(): Promise<EsclScanStatus>;
     static delay(t: number): Promise<void>;
-    static postJob(job: ScanJobSettings): Promise<string>;
+    static postJob(job: IScanJobSettings): Promise<string>;
+    static postEsclJob(job: IScanJobSettings): Promise<string>;
     /**
      * @param jobURL
      * @return {Promise<Job|*>}
      */
     static getJob(jobURL: string): Promise<Job>;
-    static downloadPage(binaryURL: string, destination: string): Promise<string>;
+    static downloadPage(binaryURL: string, destination: string, timeout?: number): Promise<string>;
+    static downloadEsclPage(jobUri: string, destination: string): Promise<string>;
+    static getEsclScanImageInfo(jobUri: string): Promise<EsclScanImageInfo>;
 }