SmartRip - Sample CLI programs | Helix Documentation

Overview

These are sample applications written in C# to drive SmartRIP Industrial, a OPC UA-enabled PDF RIP. Use a simple command line to instruct a live SmartRIP installation to RIP a given job, delivering thumbnails and full-resolution Tiff files to a folder of your choosing.

Browse Sandbox / Andrea - Hybrid Software Group Bitbucket

In the repo, there are Three examples, SmartRIP_CLI, SmartRIP_PageShooter and SmartRIP_NewPageShooter.

A technical deep dive is available here:SmartRip_Technical_White_Paper.md

SmartRIP_CLI

To get the usage, enter SmartRip_CLI.exe with no arguments.

SmartRip_CLI version 1.0.0.0

Usage:
    SmartRip_CLI.dll <PrimaryCommand>

Required Parameters:
    <PrimaryCommand>
        install - Install media from .smd file
        media - List installed media
        print - Start print workflow
        uninstall - Uninstall media by name
        version - Display version info

For .dll read .exe - this is just a .NET thing.

Print command

To get the print command usage, enter SmartRip_CLI.exe print with no other arguments.

SmartRip_CLI version 1.0.0.0

Usage:
    SmartRip_CLI.dll print <PdfPath> <OutFolder> [-CopyCount <Int>] [-EnableScreening] [-MediaName <Str>] [-OutputType
        <Str>] [-PageRange <Str>]

    Start print workflow

Required Parameters:
    <PdfPath> : <Str> - Path to the input PDF file.
    <OutFolder> : <Str> - Output folder path, which will be created if it does not exist.

Optional Parameters:
    -CopyCount <Int> - Copy Count [Default: 1, Alias: -c]
    -EnableScreening - Enable screening [Alias: -s]
    -MediaName <Str> - Media to use, from available installed media. Use the media command to list them. [Default:
        Default KCMY Press Profile (Incomplete), Alias: -m]
    -OutputType <Str> - Output type [Default: Tiff, Alias: -o]
    -PageRange <Str> - [Default: 1-, Alias: -p]

Notes:

-EnableScreening Enable/disable screening with true or false.

-OutputType The output plugin to use. Tiff is the only available choice unless another output plugin has been installed with SmartRIP.

-PageRange This uses a page range syntax, as follows:

Empty string, "all", or "1-" - prints all pages
Single page: "3" - prints page 3 only
Page range: "1-5" - prints pages 1 through 5
Open-ended range: "3-" - prints page 3 to end of document
Multiple ranges: "1-3,5,7-9" - prints pages 1-3, 5, and 7-9
Special keywords:
"odd" - prints only odd-numbered pages
"even" - prints only even-numbered page

Install command

Installs an SMD file into SmartRIP. The media will remain installed and available until uninstalled with the uninstall command. A media's availability can be verified with the media command. For example:

PowerShell

.\SmartRip_CLI.exe install .\KCMY-CompleteMediaTest.smd
[OPC] Connecting.
[OPC] Connected.
[CLI] Installed: CompleteMediaTest

The final message confirms the media name, which in this case is CompleteMediaTest.

Uninstall command

Uninstalls a media from SmartRIP. Supply the media name (which may differ from the filename), as follows:

PowerShell

.\SmartRip_CLI.exe uninstall CompleteMediaTest
[OPC] Connecting.
[OPC] Connected.
[CLI] Uninstalled: CompleteMediaTest

Media command

Lists the available media, including the defaults installed by SmartRIP itself. For example:

PowerShell

.\SmartRip_CLI.exe media
[OPC] Connecting.
[OPC] Connected.
Installed media:
 - CompleteMediaTest
 - Default KCMY Press Profile (Incomplete)
 - Default KCMYOV Press Profile (Incomplete)

Version command

Returns the SmartRIP version number, for example:

PowerShell

.\SmartRip_CLI.exe version
[OPC] Connecting.
[OPC] Connected.
SmartRip Version: Smart RIP v1.0.0.0

SmartRIP Page Shooter

Same functionality as SmartRIP_CLI, but after the printRun start, the user choose what page to print. This is a typycal industrial use where marking is printed on demand accordingly to different items delivered on a conveyor.

SmartRIP New Page Shooter

A variant of Page Shooter where the page print is triggered by a QR detected by a camera. For simplicity we are using a standard webcam. QR with page numbers samples are included in the project

Usage

PowerShell

\SmartRip_PageShooter.exe
======================================
  SmartRip Interactive Print Console
======================================

Usage:
  SmartRipInteractive <pdf> <media> <outputDir> <outputType> <copyCount> <enableScreening>