21.13.1.43 read_active_probe

Description

This Tcl command reads active probe values from the device. The target probe points are selected by the select_active_probe command.

Note:

When the user tries to read at least one signal from the bus/group, the complete bus or group is read. The user is presented with the latest value for all the signals in the bus/group.

read_active_probe [-deviceName device_name ] \
                  [-name probe_name ] \
                  [-group_name bus_name | group_name ] \
                  [-value_type b|h] \
                  [-file file_path ]

Arguments


Parameter	Type	Description
deviceName	string	Parameter is optional if only one device is available in the current configuration.
name	string	Instead of all probes, read only the probes specified. The probe name should be prefixed with bus or group name if the probe is in the bus or group.
group_name	string	Instead of all probes, reads only the specified buses or groups specified here.
value_type	string	Optional parameter, used when the read value is stored into a variable as a string. b = binary h = hex
file	string	Optional. If specified, redirects output with probe point values read from the device to the specified file.


Return Type	Description
None	None

Error Codes


Error Code	Description
None	Parameter 'file' has illegal value.
None	Parameter 'value_type' has illegal value.
None	Parameter 'name' has illegal value.
None	Parameter 'group_name' has illegal value.

Supported Families


PolarFire
PolarFire SoC
SmartFusion 2
IGLOO 2
RTG4

Example

This example reads active probes of {group1}.

read_active_probe -group_name {group1}