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_value =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. |
| Key | Description |
|---|---|
| setconnector <COM port> <host name> <TCP port> <Remote COM port> | Add virtual serial port connector |
| sharevirtual <COM port> | Add virtual shared ports |
| sharephysical <COM port> | Share physical port |
| fixedbaudrate <COM port> <on|off> [BaudRate] | Set fixed baudrate for physical port |
| fixedlinecontrol <COM port> <on|off> [<DataBits> <Parity> <StopBits>] | Set fixed line control for physical port Where: DataBits: from 5 to 8 Parity: None|Odd|Even|Mark|Two StopBits: One|One5|Two |
| fixedflowcontrol <COM port> <on|off> [FlowControl] | Set fixed flow control for physical port Where: FlowControl: None|Hardware|XonXoff |
| cachedata <COM port> <on|off> | Cache data read from COM port |
| limitspeed <COM port> <on|off> | Limit transmission speed for connected virtual COM port |
| connectiontimeout <COM port> <on|off> [Timeout] | Set custom connection timeout for virtual port Where: Timeout: from 1 to 99 seconds |
| autoreconnect <COM port> <on|off> [Interval] | Set auto-reconnect interval when connection is broken Where: Interval: from 1 to 99999 seconds |
| networklatency <COM port> <Value> | Set network latency compensation for virtual port Where: Value: from 1 to 10 |
| settcp <TCP port> | Set TCP port |
| remove <COM port> | Remove virtual serial port |
| removeall | Remove all virtual ports |
| list [physical|shared|connectors] | List serial ports |
| enable | Enable all virtual ports |
| disable | Disable all virtual ports |
| help | Show this help |
Command Line Usage Examples:
| Key | Description |
|---|---|
| NSPKCmd.exe sharephysical 1 | Share physical port COM1 |
| NSPKCmd.exe setconnector 5 192.168.10.1 33600 1 | Create virtual COM5 connected to remote shared COM1 (IP: 192.168.10.1, TCP port: 33600) |
| NSPKCmd.exe removeall | Remove all virtual ports |