hp-webscan-client v1.1.3

About

Some HP printers include the webscan protocol. This client can be used to interact with this protocol and request scans from a printer on your local network.

Only tested with HP Envy 6432e.

Setup your printer

In my case, the webscan function of my printer had to be enabled in the webinterface.

For the HP Envy 6432e the setting is located at Settings > Security > Administrator Settings. Check the box next to "Webscan from EWS" and save the changes.

Installation

npm install hp-webscan-client

Usage

import { WebScan } from "hp-webscan-client";

// Create a new WebScan instance
const client = new WebScan({
    ip: "PRINTER_IP",
});

// Start scanning process and save file to output.pdf
client.scanToFile({
    color: true,
    output: {
        format: "application/pdf",
        path: "output.pdf",
    },
});

// Start scanning process and return document as buffer
const buffer = client.scanToBuffer({
    color: true,
    format: "application/pdf",
});

Properties

IScanDocumentOptions

IScanDocumentBufferOptions

IScanOutput

WebScan Class

Functions

• scanToFile

scanToFile(options: IScanDocumentOptions): Promise<void>

This function will initiate a scan and save the scanned document to a local file.

• scanToBuffer

scanToBuffer(options: IScanDocumentBufferOptions): Promise<Buffer>

This function will initiate a scan and return the scanned document as a buffer.