Command Line Interface
Use NSPKCmd.exe console program to configure the program via command line interface.
Note: Command line NSPKCmd.exe file is created during the program install. You can find it within Network Serial Port Kit program folder.
Command-line syntax cheat sheet
| Notation | Example | Description |
|---|---|---|
| Text without brackets | command | Items which must be typed as shown. |
| Text in square brackets | [optional] | Optional parameter. |
| Text in angle brackets | <value> | Placeholder for user-provided values. |
| Text in curly braces | { required =0|=1 } | Group of required choices. At least one option must be included. |
| Pipe | option_1|option_2 | Divider between alternative options. Only one option can be selected. |
C:\Program Files\FabulaTech\Network Serial Port Kit\NSPKCmd.exe
Network Serial Port Kit console utility
Copyright (с) 2000-2024 FabulaTech
Usage: NSPKCmd.exe command [option]
Syntax:
list [physical|shared|connectors]
List all serial ports or display
physical or shared serial ports or connectors.
sharephysical <COM port> Share physical serial port.
sharevirtual <COM port> Share virtual serial port.
setconnector <COM port> <remote host> <TCP port> <remote COM port>
Add a connection between the local COM port and
a remote one shared on a remote host's TCP port.
fixedbaudrate <COM port> on <value>
Set fixed baudrate for physical serial port.
fixedbaudrate <COM port> off
Disable fixed baudrate.
fixedlinecontrol <COM port> on [<databits> <parity> <stopbits>]
Set fixed line control for physical serial port:
databits: from 5 to 8;
parity: None|Odd|Even|Mark|Two;
stopbits: One|One5|Two.
fixedlinecontrol <COM port> off
Disable fixed line control.
fixedflowcontrol <COM port> on <value>
Set fixed flow control for physical serial port:
value: None|Hardware|XonXoff.
fixedflowcontrol <COM port> off
Disable fixed flow control.
limitspeed <COM port> on|off
Enable or disable transmission speed limiting
for the connection between physical COM port
and a virtual one.
cachedata <COM port> on|off
Enable or disable caching of the data read from
the physical COM port.
connectiontimeout <COM port> on <value>
Set custom connection timeout for virtual serial
port from 1 to 99 seconds.
connectiontimeout <COM port> off
Set default connection timeout for COM port.
autoreconnect <COM port> on <value>
Enable auto reconnect after 1...99999 seconds
if virtual serial port's connection is broken.
autoreconnect <COM port> off
Disable automatic reconnect.
networklatency <COM port> <value>
Set network latency compensation level for
virtual serial port, from 1 to 10.
remove <COM port> Remove virtual serial port or unshare physical.
removeall Remove all virtual ports and connections and
unshare all physical serial ports.
settcp <TCP port> Set TCP port for sharing local serial ports.
enable Enable all virtual serial ports.
disable Disable all virtual serial ports.
help|/? Show this help.
Command line usage examples:
Share physical port COM1
NSPKCmd.exe sharephysical 1
Create virtual COM5 connected to remote shared COM1 (IP: 192.168.10.1, TCP port: 33600)
NSPKCmd.exe setconnector 5 192.168.10.1 33600 1
Remove all virtual ports
NSPKCmd.exe removeall