PostalPortal/PostalPoint_Plugins
PostalPortal/PostalPoint_Plugins
2
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

Fix api formatting docs
All checks were successful
Build and Deploy MkDocs / build-next (push) Successful in 47s
Details

Browse Source
This commit is contained in:
Skylar Ittner 2026-04-08 19:19:35 -06:00
parent f117a3d70c
commit 1671f19bc2
1 changed files with 27 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
docs/Plugin API/documentscanner.md
View File

@ -17,19 +17,21 @@ Get a list of document scanners found on the network. Supports eSCL/AirPrint.
**Kind**: static method of [<code>documentscanner</code>](#documentscanner) **Kind**: static method of [<code>documentscanner</code>](#documentscanner)
**Example** **Example**
```js ```js
await global.apis.documentscanner.discoverScanners();
// Returns:
[{ [{
protocol: "http", protocol: "http",
host: "ip or hostname", host: "ip or hostname",
port: 80, port: 80,
rs: "eSCL", rs: "eSCL",
uuid: "1234etc", uuid: "1234etc",
icon: "http://hostname/icon.png", // Icon supplied by the scanner to represent itself visually to the user. icon: "http://hostname/icon.png", // Icon supplied by the scanner to represent itself visually to the user.
name: "ScanTron 9000", name: "ScanTron 9000",
note: "", // Whatever is set as the scanner's human-readable location in its settings note: "", // Whatever is set as the scanner's human-readable location in its settings
hasAdf: true, // Has an automatic document/page feeder hasAdf: true, // Has an automatic document/page feeder
hasPlaten: true, // Has a flatbed hasPlaten: true, // Has a flatbed
hasDuplex: false // Can do automatic duplex scanning hasDuplex: false // Can do automatic duplex scanning
}] }]
``` ```
<a name="documentscanner.scanToPDF"></a> <a name="documentscanner.scanToPDF"></a>
@ -42,5 +44,17 @@ Scan a document to PDF. Supports eSCL/AirPrint.
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| scannerObj | <code>Object</code> | A scanner object from discoverScanners() | | scannerObj | <code>Object</code> | A scanner object from discoverScanners() |
| opts | <code>Object</code> | Scanning options: dpi?: number, // default 300 colorMode?: string, // "RGB24" | "Grayscale8" | "BlackAndWhite1", default "RGB24" source?: string, // Where the document is physically located: "Platen" or "Feeder". Default is "Feeder" (if scanner has one and it isn't empty) or unset (so scanner can autodetect media). intent?: string, // default is unset. "Document" | "TextAndGraphic" | "Photo" | "Preview" duplex?: boolean, // default true if the scanner supports it. scanHeight?: number, // Height in inches. Default 11. scanWidth?: number // Width in inches. Default 8.5. | | opts | <code>Object</code> | Scanning options |
**Example**
```js
var pdfBlob = await global.apis.documentscanner.scanToPDF(await discoverScanners()[0], {
dpi?: number, // default 300
colorMode?: string, // "RGB24" | "Grayscale8" | "BlackAndWhite1", default "RGB24"
source?: string, // Where the document is physically located: "Platen" or "Feeder". Default is "Feeder" (if scanner has one and it isn't empty) or unset (so scanner can autodetect media).
intent?: string, // default is unset. "Document" | "TextAndGraphic" | "Photo" | "Preview"
duplex?: boolean, // default true if the scanner supports it.
scanHeight?: number, // Height in inches. Default 11.
scanWidth?: number // Width in inches. Default 8.5.
});
```