System Console and Toolkit Tcl Command Reference Manual

ID 683101
Date 9/26/2022
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

2.2.12. _hw.tcl Toolkit Properties

Name Description
AUTHOR The author of the toolkit.
AUTOSWEEP_CASE_VALIDITY_CALLBACK A callback procedure that is called at the start of each autosweep scan iteration and takes in a set of parameters to be set to determine whether a given configuration case is valid by returning a 'true' or 'false' value.
AUTOSWEEP_FINALIZATION_CALLBACK A callback procedure that is called at the end of an autosweep scan (not per autosweep scan case iteration). This callback is used to configure the device at the end of a scan, e.g., restore the device to a previous state.
AUTOSWEEP_INITIALIZATION_CALLBACK A callback procedure that is called at the start of an autosweep scan (not per autosweep scan case iteration). This callback is used to configure the device in preparation for an autosweep scan.
AUTOSWEEP_QUALITY_METRIC_CALLBACK A callback procedure that is called in each autosweep scan iteration to update specified quality metric values. The argument of this callback procedure is a list of quality metric parameters that are expected to be updated after every scan. Note: quality metric parameters must have an associated quality comparison callback defined.
CHANNEL_CALLBACK A callback procedure that is called to declare toolkit channels. This can be used to add channels with the "add_channel" command and can be used to set the properties of that channel using the "set_channel_property".
CHART_CALLBACK The update procedure for chartable parameters. The argument of the callback procedure is a list of chartable parameters that are expected to be updated. This callback is called at a fixed time interval as specified by the user's update frequency. These callbacks execute sequentially and, when added, are scheduled to execute at the next available time slot.
DATASHEET_URL The URL for the corresponding datasheet.
DESCRIPTION Description of the toolkit.
DISPLAY_NAME Name of the toolkit.
ELABORATION_CALLBACK The name of the elaboration callback. When defined, the toolkit's elaboration callback is called to respond to parameter value changes, i.e., this callback may be used to push updated parameter values to hardware.
EYE_VIEWER_CALLBACK A callback procedure that is called to configure the Eye Viewer tool to display an eye based on a given set of eye data. The argument of this callback is the channel that is going to be scanned. Use "set_eye_data" command to set the data used to create the eye diagram.
FINALIZATION_CALLBACK When defined, this callback is executed once when a toolkit is either closed by System Console or is no longer referenced in a System Console toolkit view, whichever occurs last.
GROUP The group that this toolkit belongs to.
INITIALIZATION_CALLBACK When defined, this callback is executed once when the toolkit is either first launched or referenced in a System Console toolkit view, whichever occurs first.
INTERNAL When set to true, this property causes the toolkit to only be displayed when using the "--debug" flag.
NAME A unique identifier for the toolkit.
VERSION Toolkit version, e.g., 1.0