Skip to content

Node Documentation

This section describes all the nodes in the AWG Module node tree organized by branch.

awg

/awg/enable

Properties: Read, Write
Type: Integer (64 bit)
Unit: None

Start the AWG sequencers. In MDS mode, this will enable all devices in the correct order.

compiler

/compiler/sourcefile

Properties: Read, Write
Type: String
Unit: None

The filename of an AWG sequencer program file to compile and load. The file must be located in the "awg/src" sub-directory of the LabOne user directory. This directory path is provided by the value of the read-only directory parameter.

/compiler/sourcestring

Properties: Read, Write
Type: String
Unit: None

A string containing an AWG sequencer program may directly loaded to this parameter using the module command setString. This allows compilation and upload of a sequencer program without saving it to a file first. Compilation starts automatically after compiler/sourcestring has been set.

/compiler/start

Properties: Read, Write
Type: Integer (64 bit)
Unit: None

Set to 1 to start compiling the AWG sequencer program specified by compiler/ sourcefile. The module sets compiler/ start to 0 once compilation has successfully completed (or failed). If compiler/upload is enabled then the sequencer program will additionally be uploaded to the AWG upon after successful compilation.

/compiler/status

Properties: Read
Type: Integer (enumerated)
Unit: None

Compilation status

Value Description
-1 Idle.
0 Compilation successful.
1 Compilation failed.
2 Compilation completed with warnings.
/compiler/statusstring

Properties: Read
Type: String
Unit: None

Status message of the compiler.

/compiler/upload

Properties: Read, Write
Type: Integer (64 bit)
Unit: None

Specify whether the sequencer program should be automatically uploaded to the AWG following successful compilation.

/compiler/waveforms

Properties: Read, Write
Type: String
Unit: None

A comma-separated list of waveform CSV files to be used by the AWG sequencer program.

device

/device

Properties: Read, Write
Type: String
Unit: None

The target device for AWG sequencer programs upload, e.g. 'dev1000'.

directory

/directory

Properties: Read, Write
Type: String
Unit: None

The path of the LabOne user directory. The AWG Module uses the following subdirectories in the LabOne web server directory: "awg/src": Contains AWG sequencer program source files (user created); "awg/elf": Contains compiled AWG binary (ELF) files (created by the module); "awg/waves": Contains CSV waveform files (user created).

elf

/elf/checksum

Properties: Read
Type: Integer (64 bit)
Unit: None

The checksum of the generated ELF file.

/elf/file

Properties: Read, Write
Type: String
Unit: None

The filename of the compiled binary ELF file. If not set, the name is automatically set based on the source filename. The ELF file will be saved by the AWG Module in the "awg/elf" sub-directory of the LabOne user directory. This directory path is provided by the value of the read-only directory parameter.

/elf/status

Properties: Read
Type: Integer (enumerated)
Unit: None

Status of the ELF file upload.

Value Description
-1 Idle.
0 Upload successful.
1 Upload failed.
2 Upload in progress.
/elf/upload

Properties: Read, Write
Type: Integer (64 bit)
Unit: None

Set to 1 to start uploading the AWG sequencer program to the device. The module sets elf/upload to 0 once the upload has finished.

index

/index

Properties: Read, Write
Type: Integer (64 bit)
Unit: None

The index of the current AWG Module to use when running with multiple AWG groups. See section on channel grouping in the manual for further explanation.

mds

/mds/group

Properties: Read, Write
Type: Integer (64 bit)
Unit: None

The MDS group (multiDeviceSyncModule/group) to use for synchronized AWG playback.

progress

/progress

Properties: Read
Type: Double
Unit: None

Reports the progress of the upload as a value between 0 and 1.

sequencertype

/sequencertype

Properties: Read, Write
Type: Integer (enumerated)
Unit: None

Type of sequencer to compile for. For all devices but the SHFQC, the sequencer type is deduced from the device type, and this node is ignored. For the SHFQC, the sequencer type must be defined ("qa" or "sg").

Value Description
0 "auto-detect": The sequencer type is deduced from the device type (for all devices but the SHFQC).
1 "qa": QA sequencer
2 "sg": SG sequencer