Command-line utility rspcli.exe may be used as a simple API to create and manage alias, shared, remote, pipe, tcp and script serial ports and local bridges. Command-line utility returns 0 if the requested operation is completed successfully, or non-zero error code (HRESULT). It also prints error description to STDOUT unless the --silent parameter is specified.
The utility supports the following command-line parameters:
| Parameter | Value | Description | ||||||
|---|---|---|---|---|---|---|---|---|
-?, --help | Displays the list of supported parameters with short description. | |||||||
--silent | Do not display any error or success messages. | |||||||
-create | (alias | bridge | shared | remote | pipe | tcp | script) | Create new virtual serial device. | ||||||
-delete | N | Delete an existing port. | ||||||
-list | (alias | bridge | shared | remote | pipe | tcp | script) | List all remote serial ports on the current computer. | ||||||
-list-remote | hostname | List all shared serial ports on the specified host. | ||||||
| Port Creation Parameters | ||||||||
--local-port | N | Optional local port number. If omitted, the next available port is used. | ||||||
--device-name | name | Optional name to use for created virtual serial port device. | ||||||
| Alias Port Parameters | ||||||||
--alias-port | N | Original serial port number. | ||||||
| Bridge Parameters | ||||||||
--bridge-ports | N1,N2 | Optional bridges port numbers. | ||||||
| Shared Port Parameters | ||||||||
--share-port | N | Original serial port number. | ||||||
| Pipe Port Parameters | ||||||||
--create-pipe | \\.\pipe\PIPENAME | Name of the pipe to create. | ||||||
--connect-pipe | \\SERVERNAME\pipe\PIPENAME | Name of the pipe to connect to. | ||||||
--num-instances | N | Number of port instances, 255 to unlimited | ||||||
--input-buffer-size | N | Size of the input buffer. | ||||||
--output-buffer-size | N | Size of the output buffer. | ||||||
--pipe-timeout | N | Pipe timeout. | ||||||
--pipe-security-descriptor | string | Pipe security descriptor in SDDL format. | ||||||
| Common Port Parameters | ||||||||
--baud-rate | N | Specify port baud rate to override. | ||||||
--data-bits | N | Specify port data bits to override. | ||||||
--parity | (no | odd | even | mark | space) | Specify port parity to override. | ||||||
--stop-bits | (1 | 1.5 | 2) | Specify port stop bits to override. | ||||||
--flow-control | (none | software | hardware) | Specify port flow control to override. | ||||||
--timeouts | "N1,N2,N3,N4,N5" | Specify port timeouts to override. Timeout values must be separated with commas (no spaces allowed) and must in the following order: readIntervalTimeout, readTotalMultiplier, readTotalConstant, writeTotalMultiplier, writeTotalConstant. -1 can be used to specify MAXDWORD. Enclose the whole parameter in double quotation marks if using negative numbers. | ||||||
| Remote Port Parameters | ||||||||
--remote-host | hostname | Name or address of remote host that shares COM port. | ||||||
--remote-port | N | Name of the remote COM port for RSP server or remote TCP port for TCP/IP server. | ||||||
--login | username | Name of the user to use for authentication on a remote host. May include domain in the form DOMAIN\USERNAME. | ||||||
--password | password | Password of the user for authentication on remote computer. If omitted, the user is asked to enter password in terminal. | ||||||
--connection-timeout | N | An optional connection timeout (in milliseconds). | ||||||
--connection-attempts | N | An optional number of connection attempts to try before giving up. | ||||||
| TCP Port Parameters | ||||||||
--tcp-protocol | (rfc2217 | raw) | TCP/IP emulation protocol. Defaults to “rfc2217”.
| ||||||
--local-address | (ip-address | *) | Local address to listen on. | ||||||
--local-tcp-port | N | Local TCP port number to listen on. | ||||||
--remote-host | hostname | Name or address of remote host that shares COM port. | ||||||
--remote-port | N | Remote TCP port number. | ||||||
--tcp-buffer-size | N | TCP buffer size, in bytes. Default is 512KB. Allowed range: 4KB..10MB. | ||||||
| Script Port Parameters | ||||||||
--script-file | <path> | Full or relative path to a script file. | ||||||
--script-log-folder | <path> | Full path to a folder where script execution log files will be created. | ||||||
--script-init-value | string | Any custom string to use for script initialization. | ||||||
| Compatibility Flags | ||||||||
--get-compat | N | Gets the current compatibility flags. Can be a combination of the following values:
| ||||||
--set-compat | N | Sets the current compatibility flags. Can be a combination of the following values:
| ||||||