uCon HomePage

Menu Items


File-

File->Open
This allows a user to open up a previously saved uCon configuration file (*.ct). This allows the majority of the configuration to be reloaded on the fly. Things like function key settings, com port configuration, etc... are all re-configured. The only portion of uCon that is not touched is the state of the servers. For example, if the current configuration has the telnet server running, and the configuration to be opened has the server disabled, it is not turned off. This is true for all of the active servers.

File->New
This allows the user to simply start up a new uCon session from within uCon.

File->Save
As the counterpart to File->Open, this allows the user to save the current configuration to the currently opened configuration file (overwrite).

File->SaveAs
This allows the user to save the current configuration to a newly named uCon configuration file (*.ct).

File->Validate
This opens up the MD5/CRC32 dialog to allow you to do a general MD5SUM and/or CRC32  check on a file, or use it in conjunction with the uCon download page to verify that your download is valid.

File->Edit Config
This opens up the currently active config file (an ASCII-readable file) for editing.  Don't touch this unless you know what you're doing..

File->Exit
Terminate the uCon application.

Edit-

These items are available from the Edit menu item as well as from the floating menu that is activated by the right mouse button when the cursor is over the main window.

Edit->CopyScreenBuffer
This will copy the content of the screen buffer to the clipboard. The screen buffer is all of the text that is scrollable within the uCon window. Note, uCon does not yet support copying selected portions of the screen to the clipboard. To copy a portion of the screen buffer to the clipboard follow these steps:

1. Click Edit->CopyScreenBuffer to put the whole buffer into the clipboard.

2. Click Edit->Notepad to open Windows Notepad.

3. Paste the content of the clipboard into the notepad session.

4. Use notepad to re-copy only the desired portion to the clipboard.

Edit->CopyScreenOnly
Similar to CopyScreenBuffer, but in this case, only the text visible on the screen is copied.

Edit-Paste
This will transfer the first full line of the clipboard to the target connected to uCon's backend.

Edit->Editor
This will open up a edit (default=Notepad) session (an easy way to edit the content of the clipboard).

Edit->ClearScreen
Clear all text on the main console window.

Edit->ClearTrace
Clear all text on the system trace window.

View-

View->ToolBar
Toggle the visibility of the toolbar. If checked, then toolbar is visible.

View->Buttons
Toggle the visibility of the function key labels. If checked, then the labels are visible.

View->Funckeys
Toggle the visibility of the function key labels. If checked, then the labels are visible.

View->StatusBar
Toggle the visibility of the status bar. If checked, then the statusbar is visible.

View->SysTrace
Toggle the visibility of the system trace window. If checked, then the system trace window is visible.

View->ComPortControl
Toggle the visibility of the comport control toolbar buttons. If checked, the buttons are visible.

Config-

Config->Backend
uCon supports multiple "backends". This means that the console can be a window into one of several different interfaces. This menu item has one sub-menu item for each of the backends it supports...

COM Port:
Re-configure the settings of the backend COM port. This includes all of the normal stuff: baudrate, parity, bits-per-character, flow control etc...

Telnet:
Re-configure the settings of the telnet client used as the backend.

Plink:
Re-configure the settings of the putty client used as the backend.

Moncmd:
Re-configure the settings of the monitor command client used as the backend.

Config->Environment
uCon supports the notion of shell variables, sometimes referred to as "the environment". The shell variables are primarily used within scripts, but do pop up in other portions of uCon as appropriate. This menu item simply allows the user to display and or set/remove shell variables.

Set:
Establish a new shell variable, or remove a currently existing shell variable (by leaving the "value" field blank).

Display:
Display the current list of shell variables and their values.

Config->Timestamp
Timestamping in uCon simply means that some formatted time/date string is appended to every linefeed received from the target. This menu item presents a dialog box that allows the user to enable timestamping and to specify the format of the timestamp. Since uCon allows remote users to be connected to the session, the timestamping can be put in "local-only" mode also so that the time stamp is not transmitted back to each remote client connection.

Config->Buttons
The clickable buttons are similar to the function keys. Each button has a label and some string of text that will be pushed to the backend when clicked. The buttons are *only* clickable, they do not have a correpsonding keyboard stroke. Also, the buttons do not support scripts as the function keys do.

Config->Function Keys
The user can establish quick typing macros through the function keys. Note that "\n" is converted to the equivalent of the "ENTER" key. Also, each function key replacement string can alternatively be configured as a scriptname. This tells uCon that the text is a filename to be run as a script, not a simple one-line command.

Config->Miscellaneous
Various configuration parameters are placed here. Screen display stuff primarily. Also included here is the editor of choice to be used for various other paths in uCon.

Config->Console Font
Use this menu item to change the console font.

Config->System Trace
To support a trace feature for the uCon program and its servers, the system trace window can be enabled. This simply allocates a portion of the client window to trace output that is generated by uCon. The primary use of this window is to monitor server activity. The sub-items allow the user to toggle the state of the server window (visible/invisible), clear the trace window or just insert a blank line into the trace.

Config->RtBtnIsPaste
If this config item is checked, then a right click on the mouse is assumed to be a "paste-from-clipboard".  If unchecked, then the right button shows the default floating menu.

Config->ReadOnly
With this enabled, the console is in "local-lock-out" mode.  This simply means that characters typed into the console window are discarded.  All other interactive capabilities are normal.

Logging-

Logging->Standard
Standard, short term interaction through uCon is copied to a specified file.

Logging->LongTerm
For cases where the logging will continue for days and potentially build up very large amounts of logging data, this longterm logging method should be used. It supports the ability to cap the amount of data that is stored to disk so that over time the disk is not filled.

Logging->Insert Tag
Opens a dialog box to allow the user to insert a line of text into the current log file.

Logging->OmitHeader
If checked, then when logging is turned on, uCon will NOT insert an initial tag..

Scripts-

Scripts->Run
Execute the specified script. Any script can be run in debug mode which allows the user to single step through the script.  Note: if the scriptname ends with ".lua", then this tells uCon to run the script using the Lua interpreter.

Scripts->Halt
This item is only available when the script is active. It is typically used to terminate an out-of-control script.

Scripts->Resume
This item is only available when the script is active but paused. It simply transitions the script from a paused state to a running state.

Scripts->Pause
This item is only available when the script is active and running. It informs the script runner to pause prior to starting the next command in the script.

Scripts->Step
This item is only available when the script is active and paused. It tells the script runner to execute the next command in the script, then return to the paused state.

Scripts->Catch
Set up a "catch" script. For more information on this, go to the Scripting page.

Scripts->Fkey2Script
Create a script that will re-install the current set of button and function key settings.

Scripts->Edit
This simply brings up an editor to modify an assumed-to-exist script file.

Scripts->New
This opens up a new file and starts it off with documentation of scripting. It is useful for getting to know how to write scripts.

Servers-

Servers->FTP
This item allows the user to startup an FTP server. The home directory can be specified and the user can designate whether or not to allow full-path file access or only allow access to at or below the startup directory.

Servers->TFTP
This item allows the user to startup a TFTP server. The home directory can be specified and the user can designate whether or not to allow full-path file access or only allow access to at or below the startup directory. This server is a single threaded server meant only for use by one target at a time.

Servers->DHCP
This item allows the user to startup an DHCP server. Refer to Help->DHCP Server and the output generated when creating a new server config file for more details.

Servers->Syslog
This item allows the user to startup a basic syslog server. 

Servers->Telnet
This item is only available if the telnet server was initially turned on when uCon was started up. It allows the user to specify a welcome message that will be displayed when a client attaches. Also, if necessary, uCon can be configured to require a password and the clients can be put in read-only mode.

Servers->Moncmd
This item allows the user to startup a server similar to the moncmd facility in MicroMonitor.  In the nutshell, it allows uCon to receive commands from other programs/processes/systems via udp. 

Transfer-

Transfer->Xmodem
Transfer a file to/from the PC through uCon's XMODEM facility. Xmodem is a protocol that must be started up on both sides of the transaction. This means that even if the sender starts a transaction, data will not be transferred until the receiver starts up the other side (the fact that the sender has started does not automatically cause the receiver to receive). The "Cmd" item in this dialog box is what supports this. The uCon side of the protocol is started as a result of clicking on the Send or Receive button. The target side of the protocol is assumed to be started as a result of uCon sending the content of the "Cmd" item to the target just prior to starting up the uCon side of the protocol.

Xmodem typically transfers in blocks of 128 or 1024. This means that a Recv transaction will result in a file whose size is modulo 128; hence, it is likely that there will be some number of bytes of garbage data appended to the end of the received file. To eliminate this, the user can specify the size (if known) of the file to be received and uCon will automatically store the file as the size specified.

If the DBC checkbox is checked, then a "delay-between-characters" is inserted to slow the per-character rate down.

Transfer->TFTP

Transfer a file to/from the PC through uCon's TFTP client. Using the FOF mode, the source file is assumed to be a file that contains a list of transactions (SEND and/or RECV) of the format:

#
# File-of-files for uCon TFTP client
#
SEND srcfile destfile
RECV srcfile destfile

For each line in the "file-of-files" file, a transaction is carried out. Currently, the only two available are SEND & RECV. The client will ignore any lines starting with a pound sign (#), so the creator of the file can use this delimiter to inject comments in the file.

Transfer->File
Transfer a file to the target by simply copying the file directly (no protocol) to the com port. The DBC check box supports the ability to inject a delay between each character if necessary. Note that this file transfer mechanism uses the XMODEM trace flag.

Transfer->Binary
Transfer a small block of ASCII-Coded-Hex to the target.

uMon-

The items in this pull-down assume that uCon is connected to a target running MicroMonitor.

uMon->Backup TFS
This menu item supports the ability to transfer all files on the target up to the host (backup) and visa versa (restore). For backup, the "ListFile" item in the dialog box serves two purposes:

  1. It is a destination file that will contain a list of all files (and their storage attributes) currently in TFS.
  2. The path of that file will be used as the destination directory for all files transferred from the target.

The restore facility can then use that file (and directory path) as a source list for all files that are to be restored. If the "query" box is checked, then the restore will query the user to restore or skip over each file; otherwise all files in the ListFile will be restored.

Note:
This menu item assumes that the version of the MicroMonitor installed on the target supports the TFTP server's ability to treat a source file whose name is simply "." (dot) as a request for a list of all files on the target. In general, if the monitor's version is post July 1, 2002, then this feature is part of the monitor.

uMon->Moncmd
Use the moncmd client to issue a command to some network-connected target running uMon.

uMon->Edit TFS File
Use the uCon-configured editor to edit ASCII TFS files on a uMon-based target.

Help-

Help->Overview
Provides an overall description of uCon.

Help->Menu Items
Provides this text.

Help->Scripts
Provides detailed information on uCon's scripting language.

Help->Servers
Provides details on the various servers in uCon.

Help->Ascii
Provides tables for easy hex-to-ascii and octal-to-ascii conversion.

Help->Get Latest Version
Download the latest uCon installer from (http://www.umonfw.com/releases/ucon_install.exe)

Help->Latest Online Docs
Connect to latest online documentation from (http://www.umonfw.com/ucon).  The web pages you typically read through uCon's Help menu are local files (to eliminate the need to be web-connected just to get some help); so there maybe something new to read about.

Help->About
Provides information about the version of uCon.