create_dashboard_gadget - 2024.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
UG835
Release Date
2024-05-30
Version
2024.1 English

Create the Gadget for Project summary dashboard

Syntax

create_dashboard_gadget ‑name <arg> ‑type <arg> [‑quiet] [‑verbose]

Usage

Name Description
-name Name of the gadget
-type Type of the gadget
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution

Categories

Project

Description

Important: This command is primarily intended to be used in the Vivado™ IDE, with the Project Summary, and the Add Gadget command.

Create a new "gadget" for a dashboard, such as the Project Summary dashboard that lets you view different aspects of the synthesized or implemented design run. Aspects of the design include timing information, resource utilization, DRC and methodology violations, and power analysis.

A dashboard gadget has a series of properties that define the information displayed, and the way it is displayed. These properties can be set using the set_property command. To determine the properties on a gadget, you can use the following command:

report_property -all [get_dashboard_gadget <gadget_name>]

Properties of a dashboard gadget can be set using the set_property command. Some of the properties of a gadget that can be set include:

  • TYPE: Indicates the type of information presented by the gadget as defined by the -type option.
  • ROW: Indicates the row placement in the dashboard.
  • COL: Indicates the column placement of the gadget in the dashboard.
  • REPORTS: specifies the reports associated with the gadget.
  • RUN.STEP and TYPE: specifies the synthesis or implementation run step that the gadget applies to.
  • VIEW.TYPE and ORIENTATION: Specifies the presentation of information as a graph or table, and indicates the orientation of the data.

Arguments

-name <arg> - (Required) Specify the name of the gadget to create.

-type <arg> - (Required) Specify the type of dashboard gadget to create. The type is specified as one of an enumerated set which includes the following types: DRC, Methodology, Power, Timing, and Utilization.

-quiet - (Optional) Execute the command quietly, returning no messages from the command. The command also returns TCL_OK regardless of any errors encountered during execution.
Note: Any errors encountered on the command-line, while launching the command, will be returned. Only errors occurring inside the command will be trapped.
-verbose - (Optional) Temporarily override any message limits and return all messages from this command.
Note: Message limits can be defined with the set_msg_config command.

Example

The following example creates a power type gadget, and defines the reports and run stages the gadget applies to:

create_dashboard_gadget -name gadget_power -type power
set_property reports {impl_1#impl_1_route_report_power_0} [get_dashboard_gadgets [list {gadget_power}]]
set_property active_reports {impl_1#impl_1_route_report_power_0} [get_dashboard_gadgets [list {gadget_power}]]
set_property run.step all_stages [get_dashboard_gadgets [list {gadget_power}]]