task

List of supported commands:

class nardascripting.base.scpi.task.ScpiTask(com: nardascripting.base.comm.CommBase)

SignalShark TASK SCPI subsystem class.

add(ttype: nardascripting.base.scpi.enums.TaskTypes)

Adds a new measurement task to the instrument

Parameters

ttype (TaskTypes) – Task type e.g. ‘SPECTRUM’, ‘RT_SPECTRUM’, ‘AUTO_DF’

Returns

Name of the new task

Return type

str

delete(name: str)

Deletes a measurement task

Parameters

name (str) – Task name to delete

delete_all()

Deletes all a measurement tasks

get_list()

Queries a list of measurement tasks and task names

Returns

Two dimensional list (Type, Name) of current measurement tasks.

Return type

list [TaskTypes, string]

get_names()

Queries a list of measurement task names

Returns

List of current measurement task names.

Return type

list[string]

get_selected()

Queries the selected measurement task

Returns

Task type; Task name

Return type

TaskTypes, str

get_state()

Queries the task state of the selected task

Returns

Task state (RUN, HOLD, STOP)

Return type

TaskStates

move(name: str, name_ne_wpos: str)

Moves a measurement task to another position

Parameters
  • name (str) – Task to move

  • name_ne_wpos (str) – Destination task to move in front of, or empty string to move to the end

new(ttype: nardascripting.base.scpi.enums.TaskTypes)

Adds a new measurement task and deletes existing tasks. This command has a timeout of 10s

Parameters

ttype (TaskTypes) – Task type e.g. ‘SPECTRUM’, ‘RT_SPECTRUM’, ‘AUTO_DF’

Returns

Name of the new task

Return type

str

rename(name: str, new_name: str)

Renames a measurement task

Parameters
  • name (str) – Task to rename

  • new_name (str) – New task name

replace(name: str, ttype: nardascripting.base.scpi.enums.TaskTypes)

Replaces an existing measurement task

Parameters
  • name (str) – Name of task to replace

  • ttype (TaskTypes) – Task type of new task e.g. ‘RT_SPECTRUM’, ‘AUTO_DF’

Returns

Name of the new task

Return type

str

set_select(name: str)

Selects a measurement task

Parameters

name (str) – Task name to select