Skip to content

Invoke BALTECH Uploader from a custom application

With BALTECH Uploader, you can deploy configurations or firmware updates. To automate deployment, you can invoke Uploader from your own application or script.

This feature requires Uploader v4.26.02 or above.

Uploader EXE

Uploader is available for download as part of BALTECH ToolSuite. Once you've installed ToolSuite, you can find the Uploader EXE file here:

C:\Program Files (x86)\Baltech\Tool Suite\bf2uploader.exe

Command line arguments

You can invoke Uploader without any arguments; then Uploader will simply start and wait for user interaction. With the following arguments, you can further automate the deployment process.

Argument Supported values Description Note
Path to firmware or config file
  • File path, e.g.C:\{path}\1100_2.10.05.bf2
    		•

    The firmware or config file will be preselected when Uploader starts.

    		This must be the first argument.
    Mode

    optionally with reader serial number
    • wired
    • wireless
    • configCard
    		 Uploader selects the connected reader and starts the specified upload mode, i.e. Wired Upload, Wireless Upload (using the connected reader as a transfer reader), or ConfigCard creation.

    Specify the reader serial number if several readers are connected. To do so, use {mode}={serialnumber}, e.g. wired=12345678.

    In Uploader versions below v5.00.03, the serial number must always be specified.

    No user interaction

    optional

    		 noInteractions This argument lets you perform Wired Upload without any user interaction: Uploader will start automatically, start Wired Upload, and respond with an exit code instead of a dialog (see table below). As this argument only works with Wired Upload, the argument wired must be passed as well (see argument Mode above).
    Show error messages

    optional

    		 onlyErrorMessages This argument can be used as an alternative to noInteractions. Uploader will behave as with noInteractions; however, if an error occurs (exit code 1, 4, 5, or 6, see table below), it will display the specific error message, so you can more easily respond to the error.

    Requires Uploader v5.00.07 or above.

    As this argument only works with Wired Upload, the argument wired must be passed as well (see argument Mode above).

    Agree to factory reset factoryReset If an error with exit code 4, 5, or 6 occurs (see table below), Uploader will not throw the exit code or display the error message, but automatically perform the factory reset, upload the configuration, and complete with exit code 0. Requires Uploader v5.00.09 or above.

    Success and error response

    Upon successful completion or errors, Uploader will respond as follows:

    Status With argument noInteractions With argument onlyErrorMessages With neither noInteractions nor onlyErrorMessages
    Upload successful Exit code 0 Exit code 0 Success message for Wireless Upload in BALTECH Uploader
    An error occurred during the upload Exit code 1

    We recommend you repeat the upload manually to see the error message.

    		 Specific error message
    The argument {mode} or {mode}={serialnumber} has been passed, but Uploader doesn't detect a reader. Exit code 2 Exit code 2 Dialog Select a Reader in BALTECH Uploader

    The argument {mode} has been passed, but Uploader has detected more than 1 reader.

    or

    The argument {mode}={serialnumber} has been passed, but the specified serial number doesn't match any of the connected readers.

    		Exit code 3 Exit code 3 Dialog Select a Reader in BALTECH Uploader
    Outdated version rejected (learn more) Exit code 4 Error 'Outdated version rejected' in BALTECH Uploader
    Configuration rejected (learn more) Exit code 5 Error 'Configuration rejected' in BALTECH Uploader
    Factory reset required (learn more) Exit code 6 Error 'Factory reset required' in BALTECH Uploader

    Example

    Deploy the firmware file C:\Users\john.doe\Documents\1100_2.10.05.bf2 via Wired Upload to the connected reader and terminate upon completion, except for exit code 1. In case of exit code 4, 5, or 6, perform a factoryReset automatically and upload the firmware file.

    "C:\Program Files (x86)\Baltech\Tool Suite\bf2uploader.exe" C:\Users\john.doe\Documents\1100_1.10.05.bf2 wired onlyErrorMessages factoryReset
    Title