ROUTe:CHANnel:LABel[:DEFine]

34980A

previous page next page

ROUTe:CHANnel:LABel[:DEFine]

Syntax | Description | Parameters | Remarks | Return Format | Examples

Syntax

ROUTe:CHANnel:LABel[:DEFine] "<label>" , (@<ch_list>)

ROUTe:CHANnel:LABel[:DEFine]? [<type>, ] (@<ch_list>)

Description

This command assigns a user-defined label to the specified channels for use with the 34980A front panel and Web Interface. You can assign a user-defined label to any channel, including Analog Bus channels on the multiplexer and matrix modules.

User-defined channel labels are available for identification purposes only and cannot be used in place of a channel number within a command string.

Used With:

  • All 34980A Modules

Parameters

Name

Type

Range of Values

Default Value

<label>

Quoted ASCII String

 

A string of up to 18 characters enclosed in quotes. You can use letters (A-Z), numbers (0-9), and special characters like "@", "%", "*", etc. Use the "#" character to display a degree symbol ( ° ) on the front panel (displayed as "#" from the Web Interface).

This is a required parameter

 

<ch_list>

Numeric

One or more channels in the form (@sccc). You can assign labels to any channel, including Analog Bus channels.

This is a required parameter

 

<type>

Discrete

{USER|FACTory}

USER (read the user-defined label on the specified channels).

Remarks

  • When shipped from the factory, each channel is assigned a unique factory-default label (cannot be overwritten). From the front panel, the factory-default labels are shown on the upper line of the display (e.g., "MUX CH BANK 1", "MATRIX1 ROW3 COL4", "DIO BYTE 1", etc.). From the Web Interface, the factory-default labels are displayed as the channel number (e.g., "1001", "3020", etc.).

  • If desired, you can assign the same user-defined label to multiple channels within the same module or on different modules (i.e., channel labels are not required to be unique).

  • If you specify a label with more than the allowed 18 characters, it will be truncated (no error is generated).

  • From the Web Interface, a limited number of characters can be displayed due to space constraints in the browser window. If the user-defined label it too long to be displayed properly, it will be truncated (no error is generated).

  • To clear user-defined labels on an individual channel or range of channels (and reassign the factory-default labels), specify a null string for the <label> parameter (see Examples below). Note that since the Analog Bus relays are ignored if they are included in a range of channels, you must list these channels individually as shown below:

        ROUT:CHAN:LAB "",(@1001:1020,1911,1912,1913,1914)

  • Use the ROUTe:CHANnel:LABel:CLEar:MODule command to clear all user-defined labels on all channels in a specified slot, or on all modules installed in the 34980A, and restores the factory-default labels to the front panel and Web Interface.

  • The instrument keeps a record of what module types are installed in each slot. If a different module type is detected in a specific slot at power on, all user-defined channel labels for that slot are discarded. If an empty slot is detected at power-on, any previously-defined labels for that slot are preserved and will be restored if the same module type is installed later; however, if a module of a different type is installed in that slot, the previously-defined labels will be discarded.

  • All user-defined channel labels are stored in non-volatile memory, and do not change when power has been off, after a Factory Reset (*RST command), after an Instrument Preset (SYSTem:PRESet command), or after a stored state is recalled (*RCL command).

Return Format

The query command reads the user-defined or factory-default label assigned to the specified channels and returns a comma-separated list of strings enclosed in double quotes. If you have not assigned a user-defined label to a channel, a null string ( " " ) is returned for that channel.

  • If you specify the optional USER parameter (default), this command returns the user-defined labels assigned to the specified channels.

  • If you specify the optional FACTory parameter, this command returns the factory-defined channel labels assigned to the specified channels (e.g., "MUX CH BANK 1", "MATRIX1 ROW3 COL4", "DIO BYTE 1", etc.).

Examples

The following command assigns a label ("TEST_PT_1") to channels 3 and 5 in slot 1.

ROUT:CHAN:LAB "TEST_PT_1",(@1003,1005)   or   ROUT:CHAN:LAB 'TEST_PT_1',(@1003,1005)

The following command clears the user-defined label previously assigned to channel 19 in slot 4. The channel will now be identified by its factory default label (e.g., "MUX CH BANK 1", "MATRIX1 ROW3 COL4", "DIO BYTE 1", etc.).

ROUT:CHAN:LAB "",(@4019)

The following query returns the user-defined labels assigned to channels 3 through 7 in slot 1. Note that channels 4 and 6 have no user-defined label assigned to them (a null string is returned).

ROUT:CHAN:LAB? (@1003:1007)

Typical Response:  "TEST_PT_1","",DUT_ACV,"",CLOSE_FIXTURE

The following query returns the factory-default labels for channels 10 and 32 in slot 6.  

ROUT:CHAN:LAB? FACT,(@6010,6032)

Typical Response:  "MUX CH IN BANK 1","MUX CH IN BANK 2"

See Also

ROUTe:CHANnel:LABel:CLEar:MODule

previous page start next page