Online documentation, manuals and tutorials
< All Topics
Print

GetInstrumentProperties

Updated

Description

Using this Action, we can retrieve the instrument properties that are defined within the IEXT instrument extension.

For example, in the Rigol Waveform Data example, we want to retrieve how many channels the instrument has and what color is used for each channel. First, we can look at all the properties of the Rigol DS1000Z instrument:

Alt text

Now it is necessary to define the Flow variable type in which we want to store the properties we are interested in. In this case, we define the type struct:InstrumentProperties defined as follows:

Alt text

The InstrumentProperties structure has one member called channels, which is of type array:InstrumentPropertiesChannel, and which is defined as follows:

Alt text

And now using this Action in one step we can retrieve information about all channels:

Alt text

After we have retrieved the properties, we can find out the number of channels with Array.length(properties.channels), and the color, for example, of the 1st channel with: properties.channels[0].color.

Properties

Specific

Instrument

EXPRESSION (object:Instrument)

The instrument whose properties will be retrieved.

Inputs

seqin

SEQ | MANDATORY

A standard sequence input.

Outputs

seqout

SEQ | OPTIONAL

A standard sequence output.

properties

DATA(any) | MANDATORY

Retrieved properties are sent to this output.

Examples

  • Rigol Waveform Data
Page content