Online documentation, manuals and tutorials
< All Topics
Print

AddToInstrumentHistory

Updated

Description

It is used to add a new item to the History view of the instrument. Currently, only adding chart items is supported.

For example in the Rigol Waveform Data example we have this Action:

Alt text

It is used to add a chart which, after successful addition, will be displayed as follows (example of test signal acquisition):

Alt text

Properties

Specific

Instrument

EXPRESSION (object:Instrument)

An instrument in whose History an item will be added.

Item type

Enum

Item type to be added, currently it can only be "Chart".

Chart description

EXPRESSION (string)

Description of the chart displayed in the instrument History:

Alt text

Chart data

EXPRESSION (blob)

A string or blob containing the samples that will be displayed in the chart.

Chart sampling rate

EXPRESSION (float)

Sampling rate or number of samples per second (SPS).

Chart offset

EXPRESSION (double)

Offset value used in formula offset + sample_value * scale which transforms sample value to sample position on y axis in the chart.

Chart scale

EXPRESSION (double)

When displaying samples, the formula offset + sample_value * scale is used.

Chart format

EXPRESSION (string)

Format from Chart data. Possible values:

  • "float" – “Chart data” must be a blob containing 32-bit, little-endian float numbers.
  • "double"– “Chart data” must be a blob containing 64-bit, little-endian float numbers.
  • "rigol-byte" – “Chart data” must be a blob containing 8-bit unsigned integer numbers.
  • "rigol-word" – “Chart data” must be a blob containing 16-bit unsigned integer numbers.
  • "csv" – “Chart data” must be a CSV string, the first column is taken.

Chart unit

EXPRESSION (integer)

The unit displayed on the Y-axis. The X-axis is always time.

Chart color

EXPRESSION (string)

The color of the line in the chart if a dark background is selected.

Chart color inverse

EXPRESSION (string)

The color of the line in the chart if the light background is selected.

Chart label

EXPRESSION (string)

Chart label:

Alt text

Chart major subdivision horizontal

EXPRESSION (integer)

Alt text

Chart major subdivision vertical

EXPRESSION (integer)

Alt text

Chart minor subdivision horizontal

EXPRESSION (integer)

Alt text

Chart minor subdivision vertical

EXPRESSION (integer)

Alt text

Chart horizontal scale

EXPRESSION (double)

The number that defines the X-axis zoom factor in the default chart view.

Chart vertical scale

EXPRESSION (double)

The number that defines the Y-axis zoom factor in the default chart view.

Inputs

seqin

SEQ | MANDATORY

A standard sequence input.

Outputs

seqout

SEQ | OPTIONAL

A standard sequence output.

id

DATA(string) | OPTIONAL

ID of the added history item. We can, for example, use this data in the Chart Widget to display the chart history item inside the dashboard.

Examples

  • Rigol Waveform Data
Page content