VCOM Commands#

Simplicity Commander supports configuring the adapter board's Virtual COM (VCOM) configuration (baud rate and handshake) using the vcom config command.

Additionally, Simplicity Commander can connect to the adapter board's VCOM port to communicate with the target device using the vcom connect command. Communications will be active until terminated by pressing CTRL+C.

Configure Adapter VCOM Settings#

The adapter's VCOM baudrate is set with the --baudrate option. The handshake type is set with the --handshake option, and the available handshake configurations are 'none' (disabled), 'rtscts' (hardware flow control, RTS+CTS), and 'aux' (auxiliary UART).

By default, the VCOM settings that are configured using this command are not stored permanently on the adapter board (i.e. rebooting the adapter will revert the adapter to the previously stored configuration). Provide the --store option if you want the applied configuration to be persistent across adapter reboots.

Note: Handshake type 'aux' is not supported on all adapter boards.

Note: Not all adapter boards support setting a baud rate other than 115200 baud while handshake type 'aux' is enabled.

Command Line Syntax

$ commander vcom config [--baudrate <baud rate> --handshake <'none'|'rtscts'|'aux'> --store]

Command Line Input Example

$ commander vcom config --baudrate 921600 --handshake none

This command line sets the adapter board's VCOM baud rate to 921600 baud and disables hardware flow control.

Command Line Output Example

Adapter board VCOM handshake type successfully set to 'none'.
Adapter board baud rate successfully set to 921600 baud.
Adapter board VCOM configuration not stored; the current configuration may be overwritten if the adapter board is reset.
DONE

VCOM Communications#

Using the vcom connect command, you can communicate with the target device on your adapter board via a serial connection. If you are connecting to an adapter board over USB (i.e. by providing --serialno), Simplicity Commander will communicate via the serial port of the adapter. If you are instead connecting over the network (i.e. by providing --ip), Simplicity Commander will open a TCP socket and connect to the adapter's IP address via port 4901.

The line ending to use can be specified with the --lineending option. Carriage return (CR) and line feed (LF) is the default line ending.

Providing the --hex option will handle all input and output as hexadecimal strings. No line ending is added in this case, i.e. any provided line endings are ignored.

For certain adapter boards, you can restart the target in ISP mode upon connecting by providing the --restartinisp option. This is only supported for SiWx917 devices.

Command Line Syntax

$ commander vcom connect [--hex --restartinisp --lineending <'cr'|'lf'|'crlf'|'none'>]

Command Line Input Example

$ commander vcom connect

This command line starts VCOM communications with the target device using the default line ending.

Command Line Output Example

Opening serial port 'COM3'...
Connection established!
<data written by the target application>
^C
Serial port was disconnected.
Connection terminated by user.
DONE