[python source code]

scan

The scan commands module.

These commands are used in the following models: DAQ6510

THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED.

Please report an issue if one is found.

Attributes and Functions 
- scan.add()
- scan.addsinglestep()
- scan.addwrite()
- scan.buffer
- scan.bypass
- scan.channel.stimulus
- scan.create()
- scan.export()
- scan.learnlimits()
- scan.list()
- scan.measure.interval
- scan.measure.stimulus
- scan.mode
- scan.monitor.channel
- scan.monitor.limit.high.value
- scan.monitor.limit.low.value
- scan.monitor.mode
- scan.restart
- scan.scancount
- scan.scaninterval
- scan.start.stimulus
- scan.state()
- scan.stepcount

Scan

Bases: BaseTSPCmd

The scan command tree.

Constants
  • .ABORTED: The scan was canceled.
  • .BUILDING: The instrument is building the scan.
  • .COUNT_INFINITE: Set the number of times the scan is repeated to repeated until aborted.
  • .EMPTY: Scan is not set up.
  • .FAILED: The scan failed.
  • .MODE_FIXED_ABR: Sets the relay action when the scan starts to automatic backplane relay.
  • .MODE_HIGH: Start the scan when the measurement exceeds the value set by scan.monitor.limit.high.value.
  • .MODE_LOW: Start the scan when the measurement is below the value set by scan.monitor.limit.low.value.
  • .MODE_OFF: Start the scan without waiting for a specific value.
  • .MODE_OPEN_ALL: Sets the relay action when the scan starts to open all.
  • .MODE_OPEN_USED: Sets the relay action when the scan starts to use an intelligent open.
  • .MODE_OUTSIDE: Start the scan when the measurement is less than the lower limit or more than the upper limit.
  • .MODE_WINDOW: Start the scan when the measurement is between the lower limit and the upper limit.
  • .OFF: Do not restart scan.
  • .ON: Restart scan.
  • .PAUSED: The scan was paused.
  • .RUNNING: The scan is running the trigger model portion of the scan.
  • .STEPPING: The scan is running the channel action portion of the scan.
  • .SUCCESS: The scan completed successfully.
  • .WRITE_AFTER_SCAN: Write scan data to a file on a USB flash drive at completion of each scan.
  • .WRITE_AFTER_STEP: Write scan data to a file on a USB flash drive at completion of each scan step.
  • .WRITE_AT_END: Write scan data to a file on a USB flash drive at completion of all scans.
  • .WRITE_NEVER: Do not write data to a file.
Properties and methods
  • .add(): The scan.add() function.
  • .addsinglestep(): The scan.addsinglestep() function.
  • .addwrite(): The scan.addwrite() function.
  • .buffer: The scan.buffer attribute.
  • .bypass: The scan.bypass attribute.
  • .channel: The scan.channel command tree.
  • .create(): The scan.create() function.
  • .export(): The scan.export() function.
  • .learnlimits(): The scan.learnlimits() function.
  • .list(): The scan.list() function.
  • .measure: The scan.measure command tree.
  • .mode: The scan.mode attribute.
  • .monitor: The scan.monitor command tree.
  • .restart: The scan.restart attribute.
  • .scancount: The scan.scancount attribute.
  • .scaninterval: The scan.scaninterval attribute.
  • .start: The scan.start command tree.
  • .state(): The scan.state() function.
  • .stepcount: The scan.stepcount attribute.

ABORTED class-attribute instance-attribute 

ABORTED = 'scan.ABORTED'

BUILDING class-attribute instance-attribute 

BUILDING = 'scan.BUILDING'

COUNT_INFINITE class-attribute instance-attribute 

COUNT_INFINITE = 'scan.COUNT_INFINITE'

EMPTY class-attribute instance-attribute 

EMPTY = 'scan.EMPTY'

FAILED class-attribute instance-attribute 

FAILED = 'scan.FAILED'

MODE_FIXED_ABR class-attribute instance-attribute 

MODE_FIXED_ABR = 'scan.MODE_FIXED_ABR'

MODE_HIGH class-attribute instance-attribute 

MODE_HIGH = 'scan.MODE_HIGH'

MODE_LOW class-attribute instance-attribute 

MODE_LOW = 'scan.MODE_LOW'

MODE_OFF class-attribute instance-attribute 

MODE_OFF = 'scan.MODE_OFF'

MODE_OPEN_ALL class-attribute instance-attribute 

MODE_OPEN_ALL = 'scan.MODE_OPEN_ALL'

MODE_OPEN_USED class-attribute instance-attribute 

MODE_OPEN_USED = 'scan.MODE_OPEN_USED'

MODE_OUTSIDE class-attribute instance-attribute 

MODE_OUTSIDE = 'scan.MODE_OUTSIDE'

MODE_WINDOW class-attribute instance-attribute 

MODE_WINDOW = 'scan.MODE_WINDOW'

OFF class-attribute instance-attribute 

OFF = 'scan.OFF'

ON class-attribute instance-attribute 

ON = 'scan.ON'

PAUSED class-attribute instance-attribute 

PAUSED = 'scan.PAUSED'

RUNNING class-attribute instance-attribute 

RUNNING = 'scan.RUNNING'

STEPPING class-attribute instance-attribute 

STEPPING = 'scan.STEPPING'

SUCCESS class-attribute instance-attribute 

SUCCESS = 'scan.SUCCESS'

WRITE_AFTER_SCAN class-attribute instance-attribute 

WRITE_AFTER_SCAN = 'scan.WRITE_AFTER_SCAN'

WRITE_AFTER_STEP class-attribute instance-attribute 

WRITE_AFTER_STEP = 'scan.WRITE_AFTER_STEP'

WRITE_AT_END class-attribute instance-attribute 

WRITE_AT_END = 'scan.WRITE_AT_END'

WRITE_NEVER class-attribute instance-attribute 

WRITE_NEVER = 'scan.WRITE_NEVER'

buffer property writable 

buffer: str

Access the scan.buffer attribute.

Description
  • This attribute defines which buffer is used with the scan.
Usage
  • Accessing this property will send the print(scan.buffer) query.
  • Setting this property to a value will send the scan.buffer = value command.
TSP Syntax 
- scan.buffer = value
- print(scan.buffer)
Raises:

bypass property writable 

bypass: str

Access the scan.bypass attribute.

Description
  • This attribute indicates whether the first channel of the scan waits for the channel stimulus event to be satisfied before closing.
Usage
  • Accessing this property will send the print(scan.bypass) query.
  • Setting this property to a value will send the scan.bypass = value command.
TSP Syntax 
- scan.bypass = value
- print(scan.bypass)
Raises:

channel property 

channel: ScanChannel

Return the scan.channel command tree.

Sub-properties and sub-methods
  • .stimulus: The scan.channel.stimulus attribute.

measure property 

measure: ScanMeasure

Return the scan.measure command tree.

Sub-properties and sub-methods
  • .interval: The scan.measure.interval attribute.
  • .stimulus: The scan.measure.stimulus attribute.

mode property writable 

mode: str

Access the scan.mode attribute.

Description
  • This attribute sets the relay action when the scan starts.
Usage
  • Accessing this property will send the print(scan.mode) query.
  • Setting this property to a value will send the scan.mode = value command.
TSP Syntax 
- scan.mode = value
- print(scan.mode)
Raises:

monitor property 

monitor: ScanMonitor

Return the scan.monitor command tree.

Sub-properties and sub-methods
  • .channel: The scan.monitor.channel attribute.
  • .limit: The scan.monitor.limit command tree.
  • .mode: The scan.monitor.mode attribute.

restart property writable 

restart: str

Access the scan.restart attribute.

Description
  • This function causes a scan to automatically restart if it was interrupted by a power failure.
Usage
  • Accessing this property will send the print(scan.restart) query.
  • Setting this property to a value will send the scan.restart = value command.
TSP Syntax 
- scan.restart = value
- print(scan.restart)
Raises:

scancount property writable 

scancount: str

Access the scan.scancount attribute.

Description
  • This attribute sets the number of times the scan is repeated.
Usage
  • Accessing this property will send the print(scan.scancount) query.
  • Setting this property to a value will send the scan.scancount = value command.
TSP Syntax 
- scan.scancount = value
- print(scan.scancount)
Raises:

scaninterval property writable 

scaninterval: str

Access the scan.scaninterval attribute.

Description
  • This attribute specifies the interval time between scan starts when the scan count is more than one.
Usage
  • Accessing this property will send the print(scan.scaninterval) query.
  • Setting this property to a value will send the scan.scaninterval = value command.
TSP Syntax 
- scan.scaninterval = value
- print(scan.scaninterval)
Raises:

start property 

start: ScanStart

Return the scan.start command tree.

Sub-properties and sub-methods
  • .stimulus: The scan.start.stimulus attribute.

stepcount property 

stepcount: str

Access the scan.stepcount attribute.

Description
  • This attribute returns the number of steps in the present scan.
Usage
  • Accessing this property will send the print(scan.stepcount) query.
TSP Syntax 
- print(scan.stepcount)
Raises:

add 

add(channel_list: str, config_list: str | None = None, index: int | None = None) -> None

Run the scan.add() function.

Description
  • This function adds channels to the scan list.
TSP Syntax 
- scan.add()
Parameters:
  • channel_list (str) –

    List of channels to add, in the order in which they should occur in the scan.

  • config_list (optional, default: None ) –

    A string that defines the configuration list to recall.

  • index (optional, default: None ) –

    The index in the configuration list to recall; default is 1.
Raises:

addsinglestep 

addsinglestep(channel_list: str, config_list: str | None = None, index: int | None = None) -> None

Run the scan.addsinglestep() function.

Description
  • This function allows you to include multiple channels in a single scan step.
TSP Syntax 
- scan.addsinglestep()
Parameters:
  • channel_list (str) –

    List of channels to add, in the order in which they should occur in the scan.

  • config_list (optional, default: None ) –

    A string that defines the configuration list to recall.

  • index (optional, default: None ) –

    The index in the configuration list to recall; default is 1.
Raises:

addwrite 

addwrite(channel_list: str, write_value: str) -> None

Run the scan.addwrite() function.

Description
  • This function writes a specified value to a channel at the added step in the scan.
TSP Syntax 
- scan.addwrite()
Parameters:
  • channel_list (str) –

    String specifying channels to add using normal channel list syntax.

  • write_value (str) –

    The value to write to the channel for this scan step.
Raises:

create 

create(
    channel_list: str | None = None, config_list: str | None = None, index: int | None = None
) -> None

Run the scan.create() function.

Description
  • This function deletes the existing scan list and creates a new list of channels to scan.
TSP Syntax 
- scan.create()
Parameters:
  • channel_list (optional, default: None ) –

    String specifying channels to add to the new scan list.

  • config_list (optional, default: None ) –

    A string that defines the configuration list to recall.

  • index (optional, default: None ) –

    The index in the configuration list to recall; default is 1.
Raises:

export 

export(filename: str, when: str, what: str | None = None) -> None

Run the scan.export() function.

Description
  • This command stores data from a scan to a file on a USB flash drive.
TSP Syntax 
- scan.export()
Parameters:
  • filename (str) –

    The name of the file to be created on the USB flash drive.

  • when (str) –

    When to write the data to the file.

  • what (optional, default: None ) –

    Which data to include; see Details for options.
Raises:

learnlimits 

learnlimits(window: str, iterations: str | None = None) -> None

Run the scan.learnlimits() function.

Description
  • This function calculates alarm limits based on the present configuration of the system.
TSP Syntax 
- scan.learnlimits()
Parameters:
  • window (str) –

    Percentage of deviation from the measurement that is within limits.

  • iterations (optional, default: None ) –

    Number of times to run the scan to set limits.
Raises:

list 

list() -> str

Run the scan.list() function.

Description
  • This function returns a list that includes the initial open or close state of any cards installed in the instrument and the settings at each step of the scan.
TSP Syntax 
- scan.list()
Returns:
  • str –

    The result of the function call.
Raises:

state 

state() -> str

Run the scan.state() function.

Description
  • This function provides the present state of a running background scan.
TSP Syntax 
- scan.state()
Returns:
  • str –

    The result of the function call.
Raises:

ScanChannel

Bases: BaseTSPCmd

The scan.channel command tree.

Properties and methods
  • .stimulus: The scan.channel.stimulus attribute.

stimulus property writable 

stimulus: str

Access the scan.channel.stimulus attribute.

Description
  • This attribute determines which trigger event causes the channel action to occur.
Usage
  • Accessing this property will send the print(scan.channel.stimulus) query.
  • Setting this property to a value will send the scan.channel.stimulus = value command.
TSP Syntax 
- scan.channel.stimulus = value
- print(scan.channel.stimulus)
Raises:

ScanMeasure

Bases: BaseTSPCmd

The scan.measure command tree.

Properties and methods
  • .interval: The scan.measure.interval attribute.
  • .stimulus: The scan.measure.stimulus attribute.

interval property writable 

interval: str

Access the scan.measure.interval attribute.

Description
  • This attribute specifies the interval time between measurement requests.
Usage
  • Accessing this property will send the print(scan.measure.interval) query.
  • Setting this property to a value will send the scan.measure.interval = value command.
TSP Syntax 
- scan.measure.interval = value
- print(scan.measure.interval)
Raises:

stimulus property writable 

stimulus: str

Access the scan.measure.stimulus attribute.

Description
  • This attribute selects the trigger for the measurement.
Usage
  • Accessing this property will send the print(scan.measure.stimulus) query.
  • Setting this property to a value will send the scan.measure.stimulus = value command.
TSP Syntax 
- scan.measure.stimulus = value
- print(scan.measure.stimulus)
Raises:

ScanMonitor

Bases: BaseTSPCmd

The scan.monitor command tree.

Properties and methods
  • .channel: The scan.monitor.channel attribute.
  • .limit: The scan.monitor.limit command tree.
  • .mode: The scan.monitor.mode attribute.

channel property writable 

channel: str

Access the scan.monitor.channel attribute.

Description
  • This attribute defines which channel to monitor for a limit to be reached before starting the scan.
Usage
  • Accessing this property will send the print(scan.monitor.channel) query.
  • Setting this property to a value will send the scan.monitor.channel = value command.
TSP Syntax 
- scan.monitor.channel = value
- print(scan.monitor.channel)
Raises:

limit property 

limit: ScanMonitorLimit

Return the scan.monitor.limit command tree.

Sub-properties and sub-methods
  • .high: The scan.monitor.limit.high command tree.
  • .low: The scan.monitor.limit.low command tree.

mode property writable 

mode: str

Access the scan.monitor.mode attribute.

Description
  • This attribute determines if a scan starts immediately when triggered or after measurements reach a set value.
Usage
  • Accessing this property will send the print(scan.monitor.mode) query.
  • Setting this property to a value will send the scan.monitor.mode = value command.
TSP Syntax 
- scan.monitor.mode = value
- print(scan.monitor.mode)
Raises:

ScanMonitorLimit

Bases: BaseTSPCmd

The scan.monitor.limit command tree.

Properties and methods
  • .high: The scan.monitor.limit.high command tree.
  • .low: The scan.monitor.limit.low command tree.

high property 

high: ScanMonitorLimitHigh

Return the scan.monitor.limit.high command tree.

Sub-properties and sub-methods
  • .value: The scan.monitor.limit.high.value attribute.

low property 

low: ScanMonitorLimitLow

Return the scan.monitor.limit.low command tree.

Sub-properties and sub-methods
  • .value: The scan.monitor.limit.low.value attribute.

ScanMonitorLimitHigh

Bases: BaseTSPCmd

The scan.monitor.limit.high command tree.

Properties and methods
  • .value: The scan.monitor.limit.high.value attribute.

value property writable 

value: str

Access the scan.monitor.limit.high.value attribute.

Description
  • This attribute specifies the high limit to be used by the scan monitor.
Usage
  • Accessing this property will send the print(scan.monitor.limit.high.value) query.
  • Setting this property to a value will send the scan.monitor.limit.high.value = value command.
TSP Syntax 
- scan.monitor.limit.high.value = value
- print(scan.monitor.limit.high.value)
Raises:

ScanMonitorLimitLow

Bases: BaseTSPCmd

The scan.monitor.limit.low command tree.

Properties and methods
  • .value: The scan.monitor.limit.low.value attribute.

value property writable 

value: str

Access the scan.monitor.limit.low.value attribute.

Description
  • This attribute defines the low limit to be used by the scan monitor.
Usage
  • Accessing this property will send the print(scan.monitor.limit.low.value) query.
  • Setting this property to a value will send the scan.monitor.limit.low.value = value command.
TSP Syntax 
- scan.monitor.limit.low.value = value
- print(scan.monitor.limit.low.value)
Raises:

ScanStart

Bases: BaseTSPCmd

The scan.start command tree.

Properties and methods
  • .stimulus: The scan.start.stimulus attribute.

stimulus property writable 

stimulus: str

Access the scan.start.stimulus attribute.

Description
  • This attribute determines which event starts the scan.
Usage
  • Accessing this property will send the print(scan.start.stimulus) query.
  • Setting this property to a value will send the scan.start.stimulus = value command.
TSP Syntax 
- scan.start.stimulus = value
- print(scan.start.stimulus)
Raises: