Documentation

Command line

The application is a GUI executable that also answers a console, which is why half of these switches exist.

1. Getting the output

The application is built as a Windows GUI executable, so it has no console of its own. Launched from cmd or PowerShell it attaches to the parent console and prints normally; launched from Explorer the text would be discarded, so the same output is mirrored to a file.

  • Mirror path: the data folder, in cli\<command>.txt
  • Falling back to the folder next to the executable, then to %TEMP%
  • The mirror is UTF-8 with a byte-order mark, so it opens correctly in Notepad

2. Switches

--version
Print the product identity and version.
--help
Print the full switch list.
--install-driver
Install or start the bundled kernel driver (asks for elevation).
--fingerprint [--json] [--trace]
Print this machine's fingerprint and binding string, for licence issuing and support.
--license-status
Read the licence file from the data folder and print the edition and details.
--license-verify <file>
Verify a licence file offline. Exit code 0 valid, 1 rejected, 2 wrong usage.
--license-import <file>
Verify a licence and write it to the data folder.
--license-request <key|->
Write an offline activation request file.
--license-activate <key> [--url <url>]
Activate online against the configured endpoint.
--integrity [dir]
Re-check the files listed in integrity.txt. The exit code is the number of failures.
--anti-debug
Run the tamper probes and report what they found.
--config-get <section> <key>
Read one setting, using the same lookup order the application uses.
--register-assoc / --assoc-status
Associate .cms files with this application, or report the current state.
--throughput [sec] [fps] [bytes]
Synthetic throughput probe: deliver frames as fast as the pipeline allows and report the profile.
--capture-probe <port> [payload] [sec]
End-to-end probe against a real port: driver, decoding and frame pool.
--open-session-probe <file.cms>
Open a session through the same code path a double click uses.

The remaining switches are diagnostic probes used by the build and test tooling - the settings, dialogs, theme, setup and UI probes, and the conformance runner. --help lists them all with their arguments.

3. Common uses

REM What build is this?
CommMonitor.exe --version

REM Is the package intact?
CommMonitor.exe --integrity

REM Which machine do I send you for a licence?
CommMonitor.exe --fingerprint --json

REM Capture 100 Modbus frames on COM3 for 6 seconds
CommMonitor.exe --capture-probe COM3 01030000000AC5CD 6

4. Exit codes

  • --license-verify: 0 valid, 1 rejected, 2 wrong usage.
  • --integrity: the number of files that failed the check.
  • --register-assoc: the number of failures, so 0 means the association is in place.
  • --throughput: 0 when the run met the baseline, 1 when it did not, 2 for wrong arguments.

A non-zero exit code is written for scripts, not for the user: the same information appears in the Problems panel and in the log.

Applies to version 14.0.0.26002 · All documentation

Next: troubleshooting

What to check when the driver, a port or an activation does not cooperate.