When connected to a Console Server Mode port e.g. using SSH, you are connected via portmanager's pmshell environment.
Inside pmshell and when connected to a port, there are several pmshell commands available to assist with console management. These commands are run by typing a special sequence of characters known as an escape sequence.
Notes concerning the escape character:
- By default, the escape character is: ~
- If you are connected using the OpenSSH command line client, e.g. from Mac or Linux system, you must type a second ~ to trigger the escape, i.e.: ~~
- An alternate escape character may be set under Serial & Network -> Serial Port -> Edit/Edit Multiple Ports -> Escape Character
- The escape character must be the first character on a new line
To demonstrate, here is an escape sequence to display the pmshell command help text.
Shell Commands: ~b - Generate BREAK ~h - View history ~p - Power menu
~c - Port Configuration menu
~m - Connect to port menu ~. - Exit pmshell ~? - Show this message
If the above help text does not display, check you are using the appropriate escape sequence. Otherwise, the available commands are:
- Generate break: Send a serial break signal to the device on this port
- View history: Display recent TX and RX event logs for this port
- Power menu: If enabled and configured, open the power menu for power control of the device on this port
- Port Configuration menu: Display configuration menu for currently connected port
- Port menu: Drop back to the pmshell chooser menu to connect to another port
- Exit pmshell: Terminate this portmanager session