trigger ¶

The trigger commands module.

These commands are used in the following models: DMM7510

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

Please report an issue if one is found.

Attributes and Functions

- trigger.blender[N].clear()
- trigger.blender[N].orenable
- trigger.blender[N].overrun
- trigger.blender[N].reset()
- trigger.blender[N].stimulus[M]
- trigger.blender[N].wait()
- trigger.clear()
- trigger.continuous
- trigger.digin[N].clear()
- trigger.digin[N].edge
- trigger.digin[N].overrun
- trigger.digin[N].wait()
- trigger.digout[N].assert()
- trigger.digout[N].logic
- trigger.digout[N].pulsewidth
- trigger.digout[N].release()
- trigger.digout[N].stimulus
- trigger.ext.reset()
- trigger.extin.clear()
- trigger.extin.edge
- trigger.extin.overrun
- trigger.extin.wait()
- trigger.extout.assert()
- trigger.extout.logic
- trigger.extout.stimulus
- trigger.lanin[N].clear()
- trigger.lanin[N].edge
- trigger.lanin[N].overrun
- trigger.lanin[N].wait()
- trigger.lanout[N].assert()
- trigger.lanout[N].connect()
- trigger.lanout[N].connected
- trigger.lanout[N].disconnect()
- trigger.lanout[N].ipaddress
- trigger.lanout[N].logic
- trigger.lanout[N].protocol
- trigger.lanout[N].stimulus
- trigger.model.abort()
- trigger.model.getblocklist()
- trigger.model.getbranchcount()
- trigger.model.initiate()
- trigger.model.load() - DurationLoop
- trigger.model.load() - Empty
- trigger.model.load() - Keithley2001
- trigger.model.load() - LogicTrigger
- trigger.model.load() - LoopUntilEvent
- trigger.model.load() - SimpleLoop
- trigger.model.pause()
- trigger.model.resume()
- trigger.model.setblock() - trigger.BLOCK_BRANCH_ALWAYS
- trigger.model.setblock() - trigger.BLOCK_BRANCH_COUNTER
- trigger.model.setblock() - trigger.BLOCK_BRANCH_DELTA
- trigger.model.setblock() - trigger.BLOCK_BRANCH_LIMIT_CONSTANT
- trigger.model.setblock() - trigger.BLOCK_BRANCH_LIMIT_DYNAMIC
- trigger.model.setblock() - trigger.BLOCK_BRANCH_ONCE
- trigger.model.setblock() - trigger.BLOCK_BRANCH_ONCE_EXCLUDED
- trigger.model.setblock() - trigger.BLOCK_BRANCH_ON_EVENT
- trigger.model.setblock() - trigger.BLOCK_BUFFER_CLEAR
- trigger.model.setblock() - trigger.BLOCK_DELAY_CONSTANT
- trigger.model.setblock() - trigger.BLOCK_DELAY_DYNAMIC
- trigger.model.setblock() - trigger.BLOCK_DIGITAL_IO
- trigger.model.setblock() - trigger.BLOCK_LOG_EVENT
- trigger.model.setblock() - trigger.BLOCK_MEASURE_DIGITIZE
- trigger.model.setblock() - trigger.BLOCK_NOP
- trigger.model.setblock() - trigger.BLOCK_NOTIFY
- trigger.model.setblock() - trigger.BLOCK_RESET_BRANCH_COUNT
- trigger.model.setblock() - trigger.BLOCK_WAIT
- trigger.timer[N].clear()
- trigger.timer[N].count
- trigger.timer[N].delay
- trigger.timer[N].delaylist
- trigger.timer[N].enable
- trigger.timer[N].reset()
- trigger.timer[N].start.fractionalseconds
- trigger.timer[N].start.generate
- trigger.timer[N].start.overrun
- trigger.timer[N].start.seconds
- trigger.timer[N].start.stimulus
- trigger.timer[N].wait()
- trigger.tsplinkin[N].clear()
- trigger.tsplinkin[N].edge
- trigger.tsplinkin[N].overrun
- trigger.tsplinkin[N].wait()
- trigger.tsplinkout[N].assert()
- trigger.tsplinkout[N].logic
- trigger.tsplinkout[N].pulsewidth
- trigger.tsplinkout[N].release()
- trigger.tsplinkout[N].stimulus
- trigger.wait()

Trigger ¶

Bases: BaseTSPCmd

The trigger command tree.

Constants

.BLOCK_BRANCH_ALWAYS: Defines a trigger model block that always goes to a specific block.
.BLOCK_BRANCH_COUNTER: Defines a trigger model block that branches to a specified block a specified number of times.
.BLOCK_BRANCH_DELTA: Defines a trigger model block that goes to a specified block if the difference of two measurements meets preset criteria.
.BLOCK_BRANCH_LIMIT_CONSTANT: Defines a trigger model block that goes to a specified block if a measurement meets preset criteria.
.BLOCK_BRANCH_LIMIT_DYNAMIC: Defines a trigger model block that goes to a specified block in the trigger model if a measurement meets user-defined criteria.
.BLOCK_BRANCH_ONCE: Causes the trigger model to branch to a specified building block the first time it is encountered in the trigger model.
.BLOCK_BRANCH_ONCE_EXCLUDED: Causes the trigger model to go to a specified building block every time the trigger model encounters it, except for the first time.
.BLOCK_BRANCH_ON_EVENT: Branches to a specified block when a specified trigger event occurs.
.BLOCK_BUFFER_CLEAR: Defines a trigger model block that clears the reading buffer.
.BLOCK_CONFIG_NEXT: Recalls the settings at the next index of a configuration list.
.BLOCK_CONFIG_PREV: Recalls the settings stored at the previous index of a configuration list.
.BLOCK_DELAY_CONSTANT: Adds a constant delay to the execution of a trigger model.
.BLOCK_DELAY_DYNAMIC: Adds a user delay to the execution of the trigger model.
.BLOCK_DIGITAL_IO: Defines a trigger model block that sets the lines on the digital I/O port high or low.
.BLOCK_LOG_EVENT: Allows you to log an event in the event log when the trigger model is running.
.BLOCK_MEASURE: Deprecated; use trigger.BLOCK_MEASURE_DIGITIZE instead.
.BLOCK_MEASURE_DIGITIZE: defines a trigger block that makes or digitizes a measurement.
.BLOCK_NOP: Creates a placeholder that performs no action in the trigger model.
.BLOCK_NOTIFY: Defines a trigger-model block that generates a trigger event and immediately continues to the next block.
.BLOCK_RESET_BRANCH_COUNT: Creates a block in the trigger model that resets a branch counter to 0.
.BLOCK_WAIT: Defines a trigger model block that waits for an event before allowing the trigger model to continue.
.CLEAR_ENTER: Clear previously detected trigger events when entering the wait block.
.CLEAR_NEVER: Immediately act on any previously detected triggers and not clear them (default).
.CONT_AUTO: Start continuous measurements after boot.
.CONT_OFF: Do not start continuous measurements after boot.
.CONT_RESTART: Place the instrument into local control and start continuous measurements after boot.
.COUNT_AUTO: Use most recent count value.
.COUNT_INFINITE: Infinite (run continuously until stopped).
.COUNT_STOP: Stop infinite to stop the block.
.EDGE_EITHER: Sets the selected trigger line to detect either rising-edge or falling-edge triggers as input when the line is configured as an input or open drain.
.EDGE_FALLING: Sets the selected trigger line to detect falling-edge triggers as input when the line is configured as an input or open drain.
.EDGE_RISING: Sets the selected trigger line to detect rising-edge triggers as input when the line is configured as an input or open drain.
.EVENT_BLENDERN: Trigger event blender N (1 to 2), which combines trigger events.
.EVENT_COMMAND: A command interface trigger.
.EVENT_DIGION: Line edge (either rising, falling, or either based on the configuration of the line) detected on digital input line N (1 to 6).
.EVENT_DISPLAY: Front-panel TRIGGER key press.
.EVENT_LANN: Appropriate LXI trigger packet is received on LAN trigger object N (1 to 8).
.EVENT_NONE: No trigger event.
.EVENT_NOTIFYN: Notify trigger block N (1 to 3) generates a trigger event when the trigger model executes it.
.EVENT_TIMER1: Trigger timer 1 expired.
.EVENT_TIMER2: Trigger timer 2 expired.
.EVENT_TIMER3: Trigger timer 3 expired.
.EVENT_TIMER4: Trigger timer 4 expired.
.EVENT_TSPLINKN: Line edge detected on TSP-Link synchronization line N (1 to 3).
.LIMIT_ABOVE: The measurement is above the value set by limit B; limit A must be set, but is ignored when this type is selected.
.LIMIT_BELOW: The measurement is below the value set by limit A; limit B must be set, but is ignored when this type is selected.
.LIMIT_INSIDE: The measurement is inside the values set by limits A and B; limit A must be the low value and Limit B must be the high value.
.LIMIT_OUTSIDE: The measurement is outside the values set by limits A and B; limit A must be the low value and Limit B must be the high value.
.LOGIC_NEGATIVE: Asserts a TTL-low pulse for the output logic of the trigger event generator for the specified line.
.LOGIC_POSITIVE: Asserts a TTL-high pulse for the output logic of the trigger event generator for the specified line.
.LOG_ERROR1: Log error event 1 in the event log when trigger model execution reaches this block.
.LOG_ERROR2: Log error event 2 in the event log when trigger model execution reaches this block.
.LOG_ERROR3: Log error event 3 in the event log when trigger model execution reaches this block.
.LOG_ERROR4: Log error event 4 in the event log when trigger model execution reaches this block.
.LOG_INFO1: Log information event 1 in the event log when trigger model execution reaches this block.
.LOG_INFO2: Log information event 2 in the event log when trigger model execution reaches this block.
.LOG_INFO3: Log information event 3 in the event log when trigger model execution reaches this block.
.LOG_INFO4: Log information event 4 in the event log when trigger model execution reaches this block.
.LOG_WARN1: Log warning event 1 in the event log when trigger model execution reaches this block.
.LOG_WARN2: Log warning event 2 in the event log when trigger model execution reaches this block.
.LOG_WARN3: Log warning event 3 in the event log when trigger model execution reaches this block.
.LOG_WARN4: Log warning event 4 in the event log when trigger model execution reaches this block.
.LOG_WARN_ABORT: Abort the trigger model immediately and post a warning event log message.
.OFF: Disable the trigger timer.
.ON: Enable the trigger timer.
.STATE_ABORTED: The trigger model is stopped.
.STATE_ABORTING: The trigger model is stopping.
.STATE_BUILDING: Blocks have been added.
.STATE_EMPTY: The trigger model is selected, but no blocks are defined.
.STATE_FAILED: The trigger model is stopped because of an error.
.STATE_IDLE: The trigger model is stopped.
.STATE_RUNNING: The trigger model is running.
.STATE_WAITING: The trigger model has been in the same wait block for more than 100 ms.
.WAIT_AND: Each event must occur before the trigger model continues.
.WAIT_OR: At least one of the events must occur before the trigger model continues.

Properties and methods

.blender: The trigger.blender[N] command tree.
.clear(): The trigger.clear() function.
.continuous: The trigger.continuous attribute.
.digin: The trigger.digin[N] command tree.
.digout: The trigger.digout[N] command tree.
.ext: The trigger.ext command tree.
.extin: The trigger.extin command tree.
.extout: The trigger.extout command tree.
.lanin: The trigger.lanin[N] command tree.
.lanout: The trigger.lanout[N] command tree.
.model: The trigger.model command tree.
.timer: The trigger.timer[N] command tree.
.tsplinkin: The trigger.tsplinkin[N] command tree.
.tsplinkout: The trigger.tsplinkout[N] command tree.
.wait(): The trigger.wait() function.

BLOCK_BRANCH_ALWAYS `class-attribute` `instance-attribute` ¶

BLOCK_BRANCH_ALWAYS = 'trigger.BLOCK_BRANCH_ALWAYS'

BLOCK_BRANCH_COUNTER `class-attribute` `instance-attribute` ¶

BLOCK_BRANCH_COUNTER = 'trigger.BLOCK_BRANCH_COUNTER'

BLOCK_BRANCH_DELTA `class-attribute` `instance-attribute` ¶

BLOCK_BRANCH_DELTA = 'trigger.BLOCK_BRANCH_DELTA'

BLOCK_BRANCH_LIMIT_CONSTANT `class-attribute` `instance-attribute` ¶

BLOCK_BRANCH_LIMIT_CONSTANT = 'trigger.BLOCK_BRANCH_LIMIT_CONSTANT'

BLOCK_BRANCH_LIMIT_DYNAMIC `class-attribute` `instance-attribute` ¶

BLOCK_BRANCH_LIMIT_DYNAMIC = 'trigger.BLOCK_BRANCH_LIMIT_DYNAMIC'

BLOCK_BRANCH_ONCE `class-attribute` `instance-attribute` ¶

BLOCK_BRANCH_ONCE = 'trigger.BLOCK_BRANCH_ONCE'

BLOCK_BRANCH_ONCE_EXCLUDED `class-attribute` `instance-attribute` ¶

BLOCK_BRANCH_ONCE_EXCLUDED = 'trigger.BLOCK_BRANCH_ONCE_EXCLUDED'

BLOCK_BRANCH_ON_EVENT `class-attribute` `instance-attribute` ¶

BLOCK_BRANCH_ON_EVENT = 'trigger.BLOCK_BRANCH_ON_EVENT'

BLOCK_BUFFER_CLEAR `class-attribute` `instance-attribute` ¶

BLOCK_BUFFER_CLEAR = 'trigger.BLOCK_BUFFER_CLEAR'

BLOCK_CONFIG_NEXT `class-attribute` `instance-attribute` ¶

BLOCK_CONFIG_NEXT = 'trigger.BLOCK_CONFIG_NEXT'

BLOCK_CONFIG_PREV `class-attribute` `instance-attribute` ¶

BLOCK_CONFIG_PREV = 'trigger.BLOCK_CONFIG_PREV'

BLOCK_DELAY_CONSTANT `class-attribute` `instance-attribute` ¶

BLOCK_DELAY_CONSTANT = 'trigger.BLOCK_DELAY_CONSTANT'

BLOCK_DELAY_DYNAMIC `class-attribute` `instance-attribute` ¶

BLOCK_DELAY_DYNAMIC = 'trigger.BLOCK_DELAY_DYNAMIC'

BLOCK_DIGITAL_IO `class-attribute` `instance-attribute` ¶

BLOCK_DIGITAL_IO = 'trigger.BLOCK_DIGITAL_IO'

BLOCK_LOG_EVENT `class-attribute` `instance-attribute` ¶

BLOCK_LOG_EVENT = 'trigger.BLOCK_LOG_EVENT'

BLOCK_MEASURE `class-attribute` `instance-attribute` ¶

BLOCK_MEASURE = 'trigger.BLOCK_MEASURE'

BLOCK_MEASURE_DIGITIZE `class-attribute` `instance-attribute` ¶

BLOCK_MEASURE_DIGITIZE = 'trigger.BLOCK_MEASURE_DIGITIZE'

BLOCK_NOP `class-attribute` `instance-attribute` ¶

BLOCK_NOP = 'trigger.BLOCK_NOP'

BLOCK_NOTIFY `class-attribute` `instance-attribute` ¶

BLOCK_NOTIFY = 'trigger.BLOCK_NOTIFY'

BLOCK_RESET_BRANCH_COUNT `class-attribute` `instance-attribute` ¶

BLOCK_RESET_BRANCH_COUNT = 'trigger.BLOCK_RESET_BRANCH_COUNT'

BLOCK_WAIT `class-attribute` `instance-attribute` ¶

BLOCK_WAIT = 'trigger.BLOCK_WAIT'

CLEAR_ENTER `class-attribute` `instance-attribute` ¶

CLEAR_ENTER = 'trigger.CLEAR_ENTER'

CLEAR_NEVER `class-attribute` `instance-attribute` ¶

CLEAR_NEVER = 'trigger.CLEAR_NEVER'

CONT_AUTO `class-attribute` `instance-attribute` ¶

CONT_AUTO = 'trigger.CONT_AUTO'

CONT_OFF `class-attribute` `instance-attribute` ¶

CONT_OFF = 'trigger.CONT_OFF'

CONT_RESTART `class-attribute` `instance-attribute` ¶

CONT_RESTART = 'trigger.CONT_RESTART'

COUNT_AUTO `class-attribute` `instance-attribute` ¶

COUNT_AUTO = 'trigger.COUNT_AUTO'

COUNT_INFINITE `class-attribute` `instance-attribute` ¶

COUNT_INFINITE = 'trigger.COUNT_INFINITE'

COUNT_STOP `class-attribute` `instance-attribute` ¶

COUNT_STOP = 'trigger.COUNT_STOP'

EDGE_EITHER `class-attribute` `instance-attribute` ¶

EDGE_EITHER = 'trigger.EDGE_EITHER'

EDGE_FALLING `class-attribute` `instance-attribute` ¶

EDGE_FALLING = 'trigger.EDGE_FALLING'

EDGE_RISING `class-attribute` `instance-attribute` ¶

EDGE_RISING = 'trigger.EDGE_RISING'

EVENT_BLENDERN `class-attribute` `instance-attribute` ¶

EVENT_BLENDERN = 'trigger.EVENT_BLENDERN'

EVENT_COMMAND `class-attribute` `instance-attribute` ¶

EVENT_COMMAND = 'trigger.EVENT_COMMAND'

EVENT_DIGION `class-attribute` `instance-attribute` ¶

EVENT_DIGION = 'trigger.EVENT_DIGION'

EVENT_DISPLAY `class-attribute` `instance-attribute` ¶

EVENT_DISPLAY = 'trigger.EVENT_DISPLAY'

EVENT_LANN `class-attribute` `instance-attribute` ¶

EVENT_LANN = 'trigger.EVENT_LANN'

EVENT_NONE `class-attribute` `instance-attribute` ¶

EVENT_NONE = 'trigger.EVENT_NONE'

EVENT_NOTIFYN `class-attribute` `instance-attribute` ¶

EVENT_NOTIFYN = 'trigger.EVENT_NOTIFYN'

EVENT_TIMER1 `class-attribute` `instance-attribute` ¶

EVENT_TIMER1 = 'trigger.EVENT_TIMER1'

EVENT_TIMER2 `class-attribute` `instance-attribute` ¶

EVENT_TIMER2 = 'trigger.EVENT_TIMER2'

EVENT_TIMER3 `class-attribute` `instance-attribute` ¶

EVENT_TIMER3 = 'trigger.EVENT_TIMER3'

EVENT_TIMER4 `class-attribute` `instance-attribute` ¶

EVENT_TIMER4 = 'trigger.EVENT_TIMER4'

EVENT_TSPLINKN `class-attribute` `instance-attribute` ¶

EVENT_TSPLINKN = 'trigger.EVENT_TSPLINKN'

LIMIT_ABOVE `class-attribute` `instance-attribute` ¶

LIMIT_ABOVE = 'trigger.LIMIT_ABOVE'

LIMIT_BELOW `class-attribute` `instance-attribute` ¶

LIMIT_BELOW = 'trigger.LIMIT_BELOW'

LIMIT_INSIDE `class-attribute` `instance-attribute` ¶

LIMIT_INSIDE = 'trigger.LIMIT_INSIDE'

LIMIT_OUTSIDE `class-attribute` `instance-attribute` ¶

LIMIT_OUTSIDE = 'trigger.LIMIT_OUTSIDE'

LOGIC_NEGATIVE `class-attribute` `instance-attribute` ¶

LOGIC_NEGATIVE = 'trigger.LOGIC_NEGATIVE'

LOGIC_POSITIVE `class-attribute` `instance-attribute` ¶

LOGIC_POSITIVE = 'trigger.LOGIC_POSITIVE'

LOG_ERROR1 `class-attribute` `instance-attribute` ¶

LOG_ERROR1 = 'trigger.LOG_ERROR1'

LOG_ERROR2 `class-attribute` `instance-attribute` ¶

LOG_ERROR2 = 'trigger.LOG_ERROR2'

LOG_ERROR3 `class-attribute` `instance-attribute` ¶

LOG_ERROR3 = 'trigger.LOG_ERROR3'

LOG_ERROR4 `class-attribute` `instance-attribute` ¶

LOG_ERROR4 = 'trigger.LOG_ERROR4'

LOG_INFO1 `class-attribute` `instance-attribute` ¶

LOG_INFO1 = 'trigger.LOG_INFO1'

LOG_INFO2 `class-attribute` `instance-attribute` ¶

LOG_INFO2 = 'trigger.LOG_INFO2'

LOG_INFO3 `class-attribute` `instance-attribute` ¶

LOG_INFO3 = 'trigger.LOG_INFO3'

LOG_INFO4 `class-attribute` `instance-attribute` ¶

LOG_INFO4 = 'trigger.LOG_INFO4'

LOG_WARN1 `class-attribute` `instance-attribute` ¶

LOG_WARN1 = 'trigger.LOG_WARN1'

LOG_WARN2 `class-attribute` `instance-attribute` ¶

LOG_WARN2 = 'trigger.LOG_WARN2'

LOG_WARN3 `class-attribute` `instance-attribute` ¶

LOG_WARN3 = 'trigger.LOG_WARN3'

LOG_WARN4 `class-attribute` `instance-attribute` ¶

LOG_WARN4 = 'trigger.LOG_WARN4'

LOG_WARN_ABORT `class-attribute` `instance-attribute` ¶

LOG_WARN_ABORT = 'trigger.LOG_WARN_ABORT'

OFF `class-attribute` `instance-attribute` ¶

OFF = 'trigger.OFF'

ON `class-attribute` `instance-attribute` ¶

ON = 'trigger.ON'

STATE_ABORTED `class-attribute` `instance-attribute` ¶

STATE_ABORTED = 'trigger.STATE_ABORTED'

STATE_ABORTING `class-attribute` `instance-attribute` ¶

STATE_ABORTING = 'trigger.STATE_ABORTING'

STATE_BUILDING `class-attribute` `instance-attribute` ¶

STATE_BUILDING = 'trigger.STATE_BUILDING'

STATE_EMPTY `class-attribute` `instance-attribute` ¶

STATE_EMPTY = 'trigger.STATE_EMPTY'

STATE_FAILED `class-attribute` `instance-attribute` ¶

STATE_FAILED = 'trigger.STATE_FAILED'

STATE_IDLE `class-attribute` `instance-attribute` ¶

STATE_IDLE = 'trigger.STATE_IDLE'

STATE_RUNNING `class-attribute` `instance-attribute` ¶

STATE_RUNNING = 'trigger.STATE_RUNNING'

STATE_WAITING `class-attribute` `instance-attribute` ¶

STATE_WAITING = 'trigger.STATE_WAITING'

WAIT_AND `class-attribute` `instance-attribute` ¶

WAIT_AND = 'trigger.WAIT_AND'

WAIT_OR `class-attribute` `instance-attribute` ¶

WAIT_OR = 'trigger.WAIT_OR'

blender `property` ¶

blender: dict[int, TriggerBlenderItem]

Return the trigger.blender[N] command tree.

Info

N, the blender number .

Sub-properties and sub-methods

.clear(): The trigger.blender[N].clear() function.
.orenable: The trigger.blender[N].orenable attribute.
.overrun: The trigger.blender[N].overrun attribute.
.reset(): The trigger.blender[N].reset() function.
.stimulus: The trigger.blender[N].stimulus[M] attribute.
.wait(): The trigger.blender[N].wait() function.

continuous `property` `writable` ¶

continuous: str

Access the trigger.continuous attribute.

Description

This attribute determines the trigger mode setting after bootup.

Usage

Accessing this property will send the print(trigger.continuous) query.
Setting this property to a value will send the trigger.continuous = value command.

TSP Syntax

- trigger.continuous = value
- print(trigger.continuous)

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

digin `property` ¶

digin: dict[int, TriggerDiginItem]

Return the trigger.digin[N] command tree.

Info

N, the digital I/O trigger line (1 to 6).

Sub-properties and sub-methods

.clear(): The trigger.digin[N].clear() function.
.edge: The trigger.digin[N].edge attribute.
.overrun: The trigger.digin[N].overrun attribute.
.wait(): The trigger.digin[N].wait() function.

digout `property` ¶

digout: dict[int, TriggerDigoutItem]

Return the trigger.digout[N] command tree.

Info

N, the digital I/O trigger line (1 to 6).

Sub-properties and sub-methods

.assert(): The trigger.digout[N].assert() function.
.logic: The trigger.digout[N].logic attribute.
.pulsewidth: The trigger.digout[N].pulsewidth attribute.
.release(): The trigger.digout[N].release() function.
.stimulus: The trigger.digout[N].stimulus attribute.

ext `property` ¶

ext: TriggerExt

Return the trigger.ext command tree.

Sub-properties and sub-methods

.reset(): The trigger.ext.reset() function.

extin `property` ¶

extin: TriggerExtin

Return the trigger.extin command tree.

Sub-properties and sub-methods

.clear(): The trigger.extin.clear() function.
.edge: The trigger.extin.edge attribute.
.overrun: The trigger.extin.overrun attribute.
.wait(): The trigger.extin.wait() function.

extout `property` ¶

extout: TriggerExtout

Return the trigger.extout command tree.

Sub-properties and sub-methods

.assert(): The trigger.extout.assert() function.
.logic: The trigger.extout.logic attribute.
.stimulus: The trigger.extout.stimulus attribute.

lanin `property` ¶

lanin: dict[int, TriggerLaninItem]

Return the trigger.lanin[N] command tree.

Info

N, the LAN event number (1 to 8) to clear.

Sub-properties and sub-methods

.clear(): The trigger.lanin[N].clear() function.
.edge: The trigger.lanin[N].edge attribute.
.overrun: The trigger.lanin[N].overrun attribute.
.wait(): The trigger.lanin[N].wait() function.

lanout `property` ¶

lanout: dict[int, TriggerLanoutItem]

Return the trigger.lanout[N] command tree.

Info

N, the LAN event number (1 to 8).

Sub-properties and sub-methods

.assert(): The trigger.lanout[N].assert() function.
.connect(): The trigger.lanout[N].connect() function.
.connected: The trigger.lanout[N].connected attribute.
.disconnect(): The trigger.lanout[N].disconnect() function.
.ipaddress: The trigger.lanout[N].ipaddress attribute.
.logic: The trigger.lanout[N].logic attribute.
.protocol: The trigger.lanout[N].protocol attribute.
.stimulus: The trigger.lanout[N].stimulus attribute.

model `property` ¶

model: TriggerModel

Return the trigger.model command tree.

Sub-properties and sub-methods

.abort(): The trigger.model.abort() function.
.getblocklist(): The trigger.model.getblocklist() function.
.getbranchcount(): The trigger.model.getbranchcount() function.
.initiate(): The trigger.model.initiate() function.
.load_duration_loop(): The trigger.model.load() - DurationLoop function.
.load_empty(): The trigger.model.load() - Empty function.
.load_keithley2001(): The trigger.model.load() - Keithley2001 function.
.load_logic_trigger(): The trigger.model.load() - LogicTrigger function.
.load_loop_until_event(): The trigger.model.load() - LoopUntilEvent function.
.load_simple_loop(): The trigger.model.load() - SimpleLoop function.
.pause(): The trigger.model.pause() function.
.resume(): The trigger.model.resume() function.
.setblock_trigger_block_branch_always(): The trigger.model.setblock() - trigger.BLOCK_BRANCH_ALWAYS function.
.setblock_trigger_block_branch_counter(): The trigger.model.setblock() - trigger.BLOCK_BRANCH_COUNTER function.
.setblock_trigger_block_branch_delta(): The trigger.model.setblock() - trigger.BLOCK_BRANCH_DELTA function.
.setblock_trigger_block_branch_limit_constant(): The trigger.model.setblock() - trigger.BLOCK_BRANCH_LIMIT_CONSTANT function.
.setblock_trigger_block_branch_limit_dynamic(): The trigger.model.setblock() - trigger.BLOCK_BRANCH_LIMIT_DYNAMIC function.
.setblock_trigger_block_branch_once(): The trigger.model.setblock() - trigger.BLOCK_BRANCH_ONCE function.
.setblock_trigger_block_branch_once_excluded(): The trigger.model.setblock() - trigger.BLOCK_BRANCH_ONCE_EXCLUDED function.
.setblock_trigger_block_branch_on_event(): The trigger.model.setblock() - trigger.BLOCK_BRANCH_ON_EVENT function.
.setblock_trigger_block_buffer_clear(): The trigger.model.setblock() - trigger.BLOCK_BUFFER_CLEAR function.
.setblock_trigger_block_delay_constant(): The trigger.model.setblock() - trigger.BLOCK_DELAY_CONSTANT function.
.setblock_trigger_block_delay_dynamic(): The trigger.model.setblock() - trigger.BLOCK_DELAY_DYNAMIC function.
.setblock_trigger_block_digital_io(): The trigger.model.setblock() - trigger.BLOCK_DIGITAL_IO function.
.setblock_trigger_block_log_event(): The trigger.model.setblock() - trigger.BLOCK_LOG_EVENT function.
.setblock_trigger_block_measure_digitize(): The trigger.model.setblock() - trigger.BLOCK_MEASURE_DIGITIZE function.
.setblock_trigger_block_nop(): The trigger.model.setblock() - trigger.BLOCK_NOP function.
.setblock_trigger_block_notify(): The trigger.model.setblock() - trigger.BLOCK_NOTIFY function.
.setblock_trigger_block_reset_branch_count(): The trigger.model.setblock() - trigger.BLOCK_RESET_BRANCH_COUNT function.
.setblock_trigger_block_wait(): The trigger.model.setblock() - trigger.BLOCK_WAIT function.

timer `property` ¶

timer: dict[int, TriggerTimerItem]

Return the trigger.timer[N] command tree.

Info

N, the trigger timer number (1 to 4).

Sub-properties and sub-methods

.clear(): The trigger.timer[N].clear() function.
.count: The trigger.timer[N].count attribute.
.delay: The trigger.timer[N].delay attribute.
.delaylist: The trigger.timer[N].delaylist attribute.
.enable: The trigger.timer[N].enable attribute.
.reset(): The trigger.timer[N].reset() function.
.start: The trigger.timer[N].start command tree.
.wait(): The trigger.timer[N].wait() function.

tsplinkin `property` ¶

tsplinkin: dict[int, TriggerTsplinkinItem]

Return the trigger.tsplinkin[N] command tree.

Info

N, the trigger line (1 to 3) to clear.

Sub-properties and sub-methods

.clear(): The trigger.tsplinkin[N].clear() function.
.edge: The trigger.tsplinkin[N].edge attribute.
.overrun: The trigger.tsplinkin[N].overrun attribute.
.wait(): The trigger.tsplinkin[N].wait() function.

tsplinkout `property` ¶

tsplinkout: dict[int, TriggerTsplinkoutItem]

Return the trigger.tsplinkout[N] command tree.

Info

N, the trigger line (1 to 3).

Sub-properties and sub-methods

.assert(): The trigger.tsplinkout[N].assert() function.
.logic: The trigger.tsplinkout[N].logic attribute.
.pulsewidth: The trigger.tsplinkout[N].pulsewidth attribute.
.release(): The trigger.tsplinkout[N].release() function.
.stimulus: The trigger.tsplinkout[N].stimulus attribute.

clear ¶

clear() -> None

Run the trigger.clear() function.

Description

This function clears any pending command triggers.

TSP Syntax

- trigger.clear()

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

wait ¶

wait(timeout: float) -> str

Run the trigger.wait() function.

Description

This function waits for a trigger event.

TSP Syntax

- trigger.wait()

Parameters:	`timeout` (`float`) – Maximum amount of time in seconds to wait for the trigger.

Returns:	`str` – The result of the function call.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

TriggerBlenderItem ¶

Bases: ValidatedDynamicNumberCmd, BaseTSPCmd

The trigger.blender[N] command tree.

Info

N, the blender number .

Properties and methods

.clear(): The trigger.blender[N].clear() function.
.orenable: The trigger.blender[N].orenable attribute.
.overrun: The trigger.blender[N].overrun attribute.
.reset(): The trigger.blender[N].reset() function.
.stimulus: The trigger.blender[N].stimulus[M] attribute.
.wait(): The trigger.blender[N].wait() function.

orenable `property` `writable` ¶

orenable: str

Access the trigger.blender[N].orenable attribute.

Description

This attribute selects whether the blender performs OR operations or AND operations.

Usage

Accessing this property will send the print(trigger.blender[N].orenable) query.
Setting this property to a value will send the trigger.blender[N].orenable = value command.

TSP Syntax

- trigger.blender[N].orenable = value
- print(trigger.blender[N].orenable)

Info

N, the blender number .

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

overrun `property` ¶

overrun: str

Access the trigger.blender[N].overrun attribute.

Description

This attribute indicates whether or not an event was ignored because of the event detector state.

Usage

Accessing this property will send the print(trigger.blender[N].overrun) query.

TSP Syntax

- print(trigger.blender[N].overrun)

Info

N, the blender number .

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

stimulus `property` ¶

stimulus: dict[int, str | float]

Access the trigger.blender[N].stimulus[M] attribute.

Description

This attribute specifies the events that trigger the blender.

Usage

Accessing an item from this property will send the print(trigger.blender[N].stimulus[M]) query.
Setting an item from this property to a value will send the trigger.blender[N].stimulus[M] = value command.

TSP Syntax

- trigger.blender[N].stimulus[M] = value
- print(trigger.blender[N].stimulus[M])

Info

N, the an integer that represents the trigger event blender .
M, the an integer representing the stimulus index (1 to 4).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

clear ¶

clear() -> None

Run the trigger.blender[N].clear() function.

Description

This function clears the blender event detector and resets the overrun indicator of blender N.

TSP Syntax

- trigger.blender[N].clear()

Info

N, the blender number .

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

reset ¶

reset() -> None

Run the trigger.blender[N].reset() function.

Description

This function resets some of the trigger blender settings to their factory defaults.

TSP Syntax

- trigger.blender[N].reset()

Info

N, the trigger event blender .

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

wait ¶

wait(timeout: float) -> str

Run the trigger.blender[N].wait() function.

Description

This function waits for a blender trigger event to occur.

TSP Syntax

- trigger.blender[N].wait()

Parameters:	`timeout` (`float`) – Maximum amount of time in seconds to wait for the trigger blender event.

Returns:	`str` – The result of the function call.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

TriggerDiginItem ¶

Bases: ValidatedDynamicNumberCmd, BaseTSPCmd

The trigger.digin[N] command tree.

Info

N, the digital I/O trigger line (1 to 6).

Properties and methods

.clear(): The trigger.digin[N].clear() function.
.edge: The trigger.digin[N].edge attribute.
.overrun: The trigger.digin[N].overrun attribute.
.wait(): The trigger.digin[N].wait() function.

edge `property` `writable` ¶

edge: str

Access the trigger.digin[N].edge attribute.

Description

This attribute sets the edge used by the trigger event detector on the given trigger line.

Usage

Accessing this property will send the print(trigger.digin[N].edge) query.
Setting this property to a value will send the trigger.digin[N].edge = value command.

TSP Syntax

- trigger.digin[N].edge = value
- print(trigger.digin[N].edge)

Info

N, the digital I/O trigger line (1 to 6).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

overrun `property` ¶

overrun: str

Access the trigger.digin[N].overrun attribute.

Description

This attribute returns the event detector overrun status.

Usage

Accessing this property will send the print(trigger.digin[N].overrun) query.

TSP Syntax

- print(trigger.digin[N].overrun)

Info

N, the digital I/O trigger line (1 to 6).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

clear ¶

clear() -> None

Run the trigger.digin[N].clear() function.

Description

<img id=’f14261’ src=’notesmall_lr.png’ class=’linkedepsandpngtemplate’ alt=’VARIABLE
NOTE’ height=‘17’ width=‘41’ vspace=‘0’ hspace=‘0’ align=’bottom’ border=‘0’>This command requires a communications accessory card to be installed in the instrument. Accessory cards include the KTTI-GPIB, KTTI-TSP, and KTTI-RS232.This function clears the trigger event on a digital input line.

TSP Syntax

- trigger.digin[N].clear()

Info

N, the digital I/O trigger line (1 to 6).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

wait ¶

wait(timeout: float) -> str

Run the trigger.digin[N].wait() function.

Description

This function waits for a trigger.

TSP Syntax

- trigger.digin[N].wait()

Parameters:	`timeout` (`float`) – Timeout in seconds.

Returns:	`str` – The result of the function call.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

TriggerDigoutItem ¶

Bases: ValidatedDynamicNumberCmd, BaseTSPCmd

The trigger.digout[N] command tree.

Info

N, the digital I/O trigger line (1 to 6).

Properties and methods

.assert(): The trigger.digout[N].assert() function.
.logic: The trigger.digout[N].logic attribute.
.pulsewidth: The trigger.digout[N].pulsewidth attribute.
.release(): The trigger.digout[N].release() function.
.stimulus: The trigger.digout[N].stimulus attribute.

logic `property` `writable` ¶

logic: str

Access the trigger.digout[N].logic attribute.

Description

This attribute sets the output logic of the trigger event generator to positive or negative for the specified line.

Usage

Accessing this property will send the print(trigger.digout[N].logic) query.
Setting this property to a value will send the trigger.digout[N].logic = value command.

TSP Syntax

- trigger.digout[N].logic = value
- print(trigger.digout[N].logic)

Info

N, the digital I/O trigger line (1 to 6).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

pulsewidth `property` `writable` ¶

pulsewidth: str

Access the trigger.digout[N].pulsewidth attribute.

Description

<img id=’f14261’ src=’notesmall_lr.png’ class=’linkedepsandpngtemplate’ alt=’VARIABLE
NOTE’ height=‘17’ width=‘41’ vspace=‘0’ hspace=‘0’ align=’bottom’ border=‘0’>This command requires a communications accessory card to be installed in the instrument. Accessory cards include the KTTI-GPIB, KTTI-TSP, and KTTI-RS232.This attribute describes the length of time that the trigger line is asserted for output triggers.

Usage

Accessing this property will send the print(trigger.digout[N].pulsewidth) query.
Setting this property to a value will send the trigger.digout[N].pulsewidth = value command.

TSP Syntax

- trigger.digout[N].pulsewidth = value
- print(trigger.digout[N].pulsewidth)

Info

width, the pulse width (0 to 100 ks).
N, the digital I/O trigger line (1 to 6).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

stimulus `property` `writable` ¶

stimulus: str

Access the trigger.digout[N].stimulus attribute.

Description

This attribute selects the event that causes a trigger to be asserted on the digital output line.

Usage

Accessing this property will send the print(trigger.digout[N].stimulus) query.
Setting this property to a value will send the trigger.digout[N].stimulus = value command.

TSP Syntax

- trigger.digout[N].stimulus = value
- print(trigger.digout[N].stimulus)

Info

N, the digital I/O trigger line (1 to 6).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

assert_ ¶

assert_() -> None

Run the trigger.digout[N].assert() function.

Description

This function asserts a trigger pulse on one of the digital I/O lines.

TSP Syntax

- trigger.digout[N].assert()

Info

N, the digital I/O trigger line (1 to 6).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

release ¶

release() -> None

Run the trigger.digout[N].release() function.

Description

This function releases an indefinite length or latched trigger.

TSP Syntax

- trigger.digout[N].release()

Info

N, the digital I/O trigger line (1 to 6).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

TriggerExt ¶

Bases: BaseTSPCmd

The trigger.ext command tree.

Properties and methods

.reset(): The trigger.ext.reset() function.

reset ¶

reset() -> None

Run the trigger.ext.reset() function.

Description

This function resets the edge, logic, and stimulus values for the external in/out lineEXTERNAL TRIGGER IN and EXTERNAL TRIGGER OUT lines to their default values.

TSP Syntax

- trigger.ext.reset()

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

TriggerExtin ¶

Bases: BaseTSPCmd

The trigger.extin command tree.

Properties and methods

.clear(): The trigger.extin.clear() function.
.edge: The trigger.extin.edge attribute.
.overrun: The trigger.extin.overrun attribute.
.wait(): The trigger.extin.wait() function.

edge `property` `writable` ¶

edge: str

Access the trigger.extin.edge attribute.

Description

This attribute sets the type of edge that is detected as an input on the external trigger in lineEXTERNAL TRIGGER IN trigger line.

Usage

Accessing this property will send the print(trigger.extin.edge) query.
Setting this property to a value will send the trigger.extin.edge = value command.

TSP Syntax

- trigger.extin.edge = value
- print(trigger.extin.edge)

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

overrun `property` ¶

overrun: str

Access the trigger.extin.overrun attribute.

Description

This attribute returns the event detector overrun status.

Usage

Accessing this property will send the print(trigger.extin.overrun) query.

TSP Syntax

- print(trigger.extin.overrun)

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

clear ¶

clear() -> None

Run the trigger.extin.clear() function.

Description

This function clears the trigger event on the external in lineEXTERNAL TRIGGER IN line.

TSP Syntax

- trigger.extin.clear()

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

wait ¶

wait(timeout: float) -> str

Run the trigger.extin.wait() function.

Description

This function waits for a trigger.

TSP Syntax

- trigger.extin.wait()

Parameters:	`timeout` (`float`) – Timeout in seconds.

Returns:	`str` – The result of the function call.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

TriggerExtout ¶

Bases: BaseTSPCmd

The trigger.extout command tree.

Properties and methods

.assert(): The trigger.extout.assert() function.
.logic: The trigger.extout.logic attribute.
.stimulus: The trigger.extout.stimulus attribute.

logic `property` `writable` ¶

logic: str

Access the trigger.extout.logic attribute.

Description

This attribute sets the output logic of the trigger event generator to positive or negative for the external I/O out lineEXTERNAL TRIGGER OUT line.

Usage

Accessing this property will send the print(trigger.extout.logic) query.
Setting this property to a value will send the trigger.extout.logic = value command.

TSP Syntax

- trigger.extout.logic = value
- print(trigger.extout.logic)

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

stimulus `property` `writable` ¶

stimulus: str

Access the trigger.extout.stimulus attribute.

Description

This attribute selects the event that causes a trigger to be asserted on the external output lineEXTERNAL TRIGGER OUT line.

Usage

Accessing this property will send the print(trigger.extout.stimulus) query.
Setting this property to a value will send the trigger.extout.stimulus = value command.

TSP Syntax

- trigger.extout.stimulus = value
- print(trigger.extout.stimulus)

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

assert_ ¶

assert_() -> None

Run the trigger.extout.assert() function.

Description

This function asserts a trigger on the external output lineEXTERNAL TRIGGER OUT line.

TSP Syntax

- trigger.extout.assert()

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

TriggerLaninItem ¶

Bases: ValidatedDynamicNumberCmd, BaseTSPCmd

The trigger.lanin[N] command tree.

Info

N, the LAN event number (1 to 8) to clear.

Properties and methods

.clear(): The trigger.lanin[N].clear() function.
.edge: The trigger.lanin[N].edge attribute.
.overrun: The trigger.lanin[N].overrun attribute.
.wait(): The trigger.lanin[N].wait() function.

edge `property` `writable` ¶

edge: str

Access the trigger.lanin[N].edge attribute.

Description

This attribute sets the trigger operation and detection mode of the specified LAN event.

Usage

Accessing this property will send the print(trigger.lanin[N].edge) query.
Setting this property to a value will send the trigger.lanin[N].edge = value command.

TSP Syntax

- trigger.lanin[N].edge = value
- print(trigger.lanin[N].edge)

Info

N, the LAN event number (1 to 8).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

overrun `property` ¶

overrun: str

Access the trigger.lanin[N].overrun attribute.

Description

This attribute contains the overrun status of the LAN event detector.

Usage

Accessing this property will send the print(trigger.lanin[N].overrun) query.

TSP Syntax

- print(trigger.lanin[N].overrun)

Info

N, the LAN event number (1 to 8).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

clear ¶

clear() -> None

Run the trigger.lanin[N].clear() function.

Description

This function clears the event detector for a LAN trigger.

TSP Syntax

- trigger.lanin[N].clear()

Info

N, the LAN event number (1 to 8) to clear.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

wait ¶

wait(timeout: float) -> str

Run the trigger.lanin[N].wait() function.

Description

This function waits for an input trigger.

TSP Syntax

- trigger.lanin[N].wait()

Parameters:	`timeout` (`float`) – Maximum amount of time in seconds to wait for the trigger event.

Returns:	`str` – The result of the function call.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

TriggerLanoutItem ¶

Bases: ValidatedDynamicNumberCmd, BaseTSPCmd

The trigger.lanout[N] command tree.

Info

N, the LAN event number (1 to 8).

Properties and methods

.assert(): The trigger.lanout[N].assert() function.
.connect(): The trigger.lanout[N].connect() function.
.connected: The trigger.lanout[N].connected attribute.
.disconnect(): The trigger.lanout[N].disconnect() function.
.ipaddress: The trigger.lanout[N].ipaddress attribute.
.logic: The trigger.lanout[N].logic attribute.
.protocol: The trigger.lanout[N].protocol attribute.
.stimulus: The trigger.lanout[N].stimulus attribute.

connected `property` ¶

connected: str

Access the trigger.lanout[N].connected attribute.

Description

This attribute contains the LAN event connection state.

Usage

Accessing this property will send the print(trigger.lanout[N].connected) query.

TSP Syntax

- print(trigger.lanout[N].connected)

Info

N, the LAN event number (1 to 8).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

ipaddress `property` `writable` ¶

ipaddress: str

Access the trigger.lanout[N].ipaddress attribute.

Description

This attribute specifies the address (in dotted-decimal format) of UDP or TCP listeners.

Usage

Accessing this property will send the print(trigger.lanout[N].ipaddress) query.
Setting this property to a value will send the trigger.lanout[N].ipaddress = value command.

TSP Syntax

- trigger.lanout[N].ipaddress = value
- print(trigger.lanout[N].ipaddress)

Info

N, the LAN event number (1 to 8).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

logic `property` `writable` ¶

logic: str

Access the trigger.lanout[N].logic attribute.

Description

This attribute sets the logic on which the trigger event detector and the output trigger generator operate on the given trigger line.

Usage

Accessing this property will send the print(trigger.lanout[N].logic) query.
Setting this property to a value will send the trigger.lanout[N].logic = value command.

TSP Syntax

- trigger.lanout[N].logic = value
- print(trigger.lanout[N].logic)

Info

N, the LAN event number (1 to 8).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

protocol `property` `writable` ¶

protocol: str

Access the trigger.lanout[N].protocol attribute.

Description

This attribute sets the LAN protocol to use for sending trigger messages.

Usage

Accessing this property will send the print(trigger.lanout[N].protocol) query.
Setting this property to a value will send the trigger.lanout[N].protocol = value command.

TSP Syntax

- trigger.lanout[N].protocol = value
- print(trigger.lanout[N].protocol)

Info

N, the LAN event number (1 to 8).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

stimulus `property` `writable` ¶

stimulus: str

Access the trigger.lanout[N].stimulus attribute.

Description

This attribute specifies events that cause this trigger to assert.

Usage

Accessing this property will send the print(trigger.lanout[N].stimulus) query.
Setting this property to a value will send the trigger.lanout[N].stimulus = value command.

TSP Syntax

- trigger.lanout[N].stimulus = value
- print(trigger.lanout[N].stimulus)

Info

N, a number specifying the trigger packet over the LAN for which to set or query the trigger source (1 to 8).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

assert_ ¶

assert_() -> None

Run the trigger.lanout[N].assert() function.

Description

This function simulates the occurrence of the trigger and generates the corresponding event.

TSP Syntax

- trigger.lanout[N].assert()

Info

N, the LAN event number (1 to 8).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

connect ¶

connect() -> None

Run the trigger.lanout[N].connect() function.

Description

This function prepares the event generator for outgoing trigger events.

TSP Syntax

- trigger.lanout[N].connect()

Info

N, the LAN event number (1 to 8).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

disconnect ¶

disconnect() -> None

Run the trigger.lanout[N].disconnect() function.

Description

This function disconnects the LAN trigger event generator.

TSP Syntax

- trigger.lanout[N].disconnect()

Info

N, the LAN event number (1 to 8).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

TriggerModel ¶

Bases: BaseTSPCmd

The trigger.model command tree.

Properties and methods

.abort(): The trigger.model.abort() function.
.getblocklist(): The trigger.model.getblocklist() function.
.getbranchcount(): The trigger.model.getbranchcount() function.
.initiate(): The trigger.model.initiate() function.
.load_duration_loop(): The trigger.model.load() - DurationLoop function.
.load_empty(): The trigger.model.load() - Empty function.
.load_keithley2001(): The trigger.model.load() - Keithley2001 function.
.load_logic_trigger(): The trigger.model.load() - LogicTrigger function.
.load_loop_until_event(): The trigger.model.load() - LoopUntilEvent function.
.load_simple_loop(): The trigger.model.load() - SimpleLoop function.
.pause(): The trigger.model.pause() function.
.resume(): The trigger.model.resume() function.
.setblock_trigger_block_branch_always(): The trigger.model.setblock() - trigger.BLOCK_BRANCH_ALWAYS function.
.setblock_trigger_block_branch_counter(): The trigger.model.setblock() - trigger.BLOCK_BRANCH_COUNTER function.
.setblock_trigger_block_branch_delta(): The trigger.model.setblock() - trigger.BLOCK_BRANCH_DELTA function.
.setblock_trigger_block_branch_limit_constant(): The trigger.model.setblock() - trigger.BLOCK_BRANCH_LIMIT_CONSTANT function.
.setblock_trigger_block_branch_limit_dynamic(): The trigger.model.setblock() - trigger.BLOCK_BRANCH_LIMIT_DYNAMIC function.
.setblock_trigger_block_branch_once(): The trigger.model.setblock() - trigger.BLOCK_BRANCH_ONCE function.
.setblock_trigger_block_branch_once_excluded(): The trigger.model.setblock() - trigger.BLOCK_BRANCH_ONCE_EXCLUDED function.
.setblock_trigger_block_branch_on_event(): The trigger.model.setblock() - trigger.BLOCK_BRANCH_ON_EVENT function.
.setblock_trigger_block_buffer_clear(): The trigger.model.setblock() - trigger.BLOCK_BUFFER_CLEAR function.
.setblock_trigger_block_delay_constant(): The trigger.model.setblock() - trigger.BLOCK_DELAY_CONSTANT function.
.setblock_trigger_block_delay_dynamic(): The trigger.model.setblock() - trigger.BLOCK_DELAY_DYNAMIC function.
.setblock_trigger_block_digital_io(): The trigger.model.setblock() - trigger.BLOCK_DIGITAL_IO function.
.setblock_trigger_block_log_event(): The trigger.model.setblock() - trigger.BLOCK_LOG_EVENT function.
.setblock_trigger_block_measure_digitize(): The trigger.model.setblock() - trigger.BLOCK_MEASURE_DIGITIZE function.
.setblock_trigger_block_nop(): The trigger.model.setblock() - trigger.BLOCK_NOP function.
.setblock_trigger_block_notify(): The trigger.model.setblock() - trigger.BLOCK_NOTIFY function.
.setblock_trigger_block_reset_branch_count(): The trigger.model.setblock() - trigger.BLOCK_RESET_BRANCH_COUNT function.
.setblock_trigger_block_wait(): The trigger.model.setblock() - trigger.BLOCK_WAIT function.

abort ¶

abort() -> None

Run the trigger.model.abort() function.

Description

This function stops all trigger model commands and scans on the instrument.

TSP Syntax

- trigger.model.abort()

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

getblocklist ¶

getblocklist() -> str

Run the trigger.model.getblocklist() function.

Description

This function returns the settings for all trigger model blocks.

TSP Syntax

- trigger.model.getblocklist()

Returns:	`str` – The result of the function call.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

getbranchcount ¶

getbranchcount(block_number: int) -> str

Run the trigger.model.getbranchcount() function.

Description

This function returns the count value of the trigger model counter block.

TSP Syntax

- trigger.model.getbranchcount()

Parameters:	`block_number` (`int`) – The sequence of the block in the trigger model.

Returns:	`str` – The result of the function call.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

initiate ¶

initiate() -> None

Run the trigger.model.initiate() function.

Description

This function starts the trigger model or scan.

TSP Syntax

- trigger.model.initiate()

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

load_duration_loop ¶

load_duration_loop(
    duration: float, delay: float | None = None, buffer_name: str | None = None
) -> None

Run the trigger.model.load() - DurationLoop function.

Description

This function loads a trigger-model template configuration that makes continuous measurements for a specified amount of time.

TSP Syntax

- trigger.model.load()

Parameters:

duration (float) –

The amount of time for which to make measurements (500 167 ns to 100 ks).
delay (optional, default: None ) –

The delay time before each measurement (167 ns to 10 ks); default is 0 for no delay.
buffer_name (optional, default: None ) –

The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

load_empty ¶

load_empty() -> None

Run the trigger.model.load() - Empty function.

Description

This function clears the trigger model.

TSP Syntax

- trigger.model.load()

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

load_keithley2001 ¶

load_keithley2001(
    arm1_bypass: str,
    arm1_source: str,
    arm1_count: int,
    arm2_bypass: str,
    arm2_source: str,
    arm2_count: int,
    arm2_delay: float,
    trig_bypass: str,
    trig_source: str,
    trig_count: int,
    trig_delay: float,
) -> None

Run the trigger.model.load() - Keithley2001 function.

Description

This function loads a trigger-model template configuration that emulates a Keithley Instruments 2001 trigger model.

TSP Syntax

- trigger.model.load()

Parameters:

arm1_bypass (str) –

Bypass Arm 1.
arm1_source (str) –

The event that triggers Arm 1; see Details.
arm1_count (int) –

The number of times to repeat the Arm 1 layer.
arm2_bypass (str) –

Bypass Arm 2.
arm2_source (str) –

The event that triggers Arm 2; see Details.
arm2_count (int) –

The number of times to repeat the Arm 2 layer.
arm2_delay (float) –

The delay time before each measurement (167 ns to 10 ks); default is 0 for no delay.
trig_bypass (str) –

Bypass the trigger layer.
trig_source (str) –

The event that triggers the trigger layer; see Details.
trig_count (int) –

The number of times to repeat the trigger layer.
trig_delay (float) –

The delay time before each measurement (167 ns to 10 ks); default is 0 for no delay.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

load_logic_trigger ¶

load_logic_trigger(
    dig_in_line: int,
    dig_out_line: int,
    count: int,
    clear: str,
    delay: float | None = None,
    buffer_name: str | None = None,
) -> None

Run the trigger.model.load() - LogicTrigger function.

Description

This function loads a trigger-model template configuration that sets up a logic trigger through the digital or external I/O.

TSP Syntax

- trigger.model.load()

Parameters:

dig_in_line (int) –

The digital input line (1 to 6) or external input line (7); also, the event that the trigger model will wait on in block 1.
dig_out_line (int) –

The digital output line (1 to 6) or external input line (7).
count (int) –

The number of measurements the instrument will make.
clear (str) –

To clear previously detected trigger events when entering the wait block.
delay (optional, default: None ) –

The delay time before each measurement (167 ns to 10 ks); default is 0 for no delay.
buffer_name (optional, default: None ) –

The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

load_loop_until_event ¶

load_loop_until_event(
    trigger_event: str,
    position: int,
    clear: str,
    delay: float | None = None,
    buffer_name: str | None = None,
) -> None

Run the trigger.model.load() - LoopUntilEvent function.

Description

This function loads a trigger-model template configuration that makes continuous measurements until the specified event occurs.

TSP Syntax

- trigger.model.load()

Parameters:

trigger_event (str) –

The event that ends infinite triggering or readings set to occur before the trigger; see Details.
position (int) –

The number of readings to make in relation to the size of the reading buffer; enter as a percentage (0% to 100%).
clear (str) –

To clear previously detected trigger events when entering the wait block (default).
delay (optional, default: None ) –

The delay time before each measurement (167 ns to 10 ks); default is 0 for no delay.
buffer_name (optional, default: None ) –

The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

load_simple_loop ¶

load_simple_loop(count: int, delay: float | None = None, buffer_name: str | None = None) -> None

Run the trigger.model.load() - SimpleLoop function.

Description

This function loads a trigger-model template configuration that makes a specific number of measurements.

TSP Syntax

- trigger.model.load()

Parameters:

count (int) –

The number of measurements the instrument will make.
delay (optional, default: None ) –

The delay time before each measurement (167 ns to 10 ks); default is 0 for no delay.
buffer_name (optional, default: None ) –

Indicates the reading buffer to use; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, defbuffer1 is used.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

pause ¶

pause() -> None

Run the trigger.model.pause() function.

Description

This function pauses a running scan or trigger model.

TSP Syntax

- trigger.model.pause()

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

resume ¶

resume() -> None

Run the trigger.model.resume() function.

Description

This function continues a paused scan or trigger model.

TSP Syntax

- trigger.model.resume()

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

setblock_trigger_block_branch_always ¶

setblock_trigger_block_branch_always(block_number: int, branch_to_block: str) -> None

Run the trigger.model.setblock() - trigger.BLOCK_BRANCH_ALWAYS function.

Description

This function defines a trigger model block that always goes to a specific block.

TSP Syntax

- trigger.model.setblock()

Parameters:	`block_number` (`int`) – The sequence of the block in the trigger model. `branch_to_block` (`str`) – The block number to execute when the trigger model reaches the Branch Always block.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

setblock_trigger_block_branch_counter ¶

setblock_trigger_block_branch_counter(
    block_number: int, target_count: int, branch_to_block: str
) -> None

Run the trigger.model.setblock() - trigger.BLOCK_BRANCH_COUNTER function.

Description

This function defines a trigger model block that branches to a specified block a specified number of times.

TSP Syntax

- trigger.model.setblock()

Parameters:	`block_number` (`int`) – The sequence of the block in the trigger model. `target_count` (`int`) – The number of times to repeat. `branch_to_block` (`str`) – The block number of the trigger model block to execute when the counter is less than the targetCount value.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

setblock_trigger_block_branch_delta ¶

setblock_trigger_block_branch_delta(
    block_number: int,
    target_difference: str,
    branch_to_block: str,
    measure_block: float | None = None,
) -> None

Run the trigger.model.setblock() - trigger.BLOCK_BRANCH_DELTA function.

Description

This function defines a trigger model block that goes to a specified block if the difference of two measurements meets preset criteria.

TSP Syntax

- trigger.model.setblock()

Parameters:

block_number (int) –

The sequence of the block in the trigger model.
target_difference (str) –

The value against which the block compares the difference between the measurements.
branch_to_block (str) –

The block number of the trigger model block to execute when the difference between the measurements is less than or equal to the targetDifference.
measure_block (optional, default: None ) –

The block number of the measure/digitize block that makes the measurements to be compared; if this is 0 or undefined, the trigger model uses the previous measure/digitize block.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

setblock_trigger_block_branch_limit_constant ¶

setblock_trigger_block_branch_limit_constant(
    block_number: int,
    limit_type: float,
    limit_a: float,
    limit_b: float,
    branch_to_block: str,
    measure_block: float | None = None,
) -> None

Run the trigger.model.setblock() - trigger.BLOCK_BRANCH_LIMIT_CONSTANT function.

Description

This function defines a trigger model block that goes to a specified block if a measurement meets preset criteria.

TSP Syntax

- trigger.model.setblock()

Parameters:

block_number (int) –

The sequence of the block in the trigger model.
limit_type (float) –

The type of limit, which can be one of the following types.
limit_a (float) –

The lower limit that the measurement is tested against; if limitType is set to.
limit_b (float) –

The upper limit that the measurement is tested against; if limitType is set to.
branch_to_block (str) –

The block number of the trigger model block to execute when the measurement meets the defined criteria.
measure_block (optional, default: None ) –

The block number of the measure/digitize block that makes the measurements to be compared; if this is 0 or undefined, the trigger model uses the previous measure/digitize block.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

setblock_trigger_block_branch_limit_dynamic ¶

setblock_trigger_block_branch_limit_dynamic(
    block_number: int,
    limit_type: float,
    limit_number: float,
    branch_to_block: str,
    measure_block: float | None = None,
) -> None

Run the trigger.model.setblock() - trigger.BLOCK_BRANCH_LIMIT_DYNAMIC function.

Description

This function defines a trigger model block that goes to a specified block in the trigger model if a measurement meets user-defined criteria.

TSP Syntax

- trigger.model.setblock()

Parameters:

block_number (int) –

The sequence of the block in the trigger model.
limit_type (float) –

The type of limit, which can be one of the following types.
limit_number (float) –

The limit number (1 or 2).
branch_to_block (str) –

The block number of the trigger model block to execute when the measurement meets the criteria set in the configuration list.
measure_block (optional, default: None ) –

The block number of the measure/digitize block that makes the measurements to be compared; if this is 0 or undefined, the trigger model uses the previous measure/digitize block.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

setblock_trigger_block_branch_on_event ¶

setblock_trigger_block_branch_on_event(block_number: int, event: str, branch_to_block: str) -> None

Run the trigger.model.setblock() - trigger.BLOCK_BRANCH_ON_EVENT function.

Description

This function branches to a specified block when a specified trigger event occurs.

TSP Syntax

- trigger.model.setblock()

Parameters:	`block_number` (`int`) – The sequence of the block in the trigger model. `event` (`str`) – The event that must occur before the trigger model branches the specified block. `branch_to_block` (`str`) – The block number of the trigger model block to execute when the specified event occurs.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

setblock_trigger_block_branch_once ¶

setblock_trigger_block_branch_once(block_number: int, branch_to_block: str) -> None

Run the trigger.model.setblock() - trigger.BLOCK_BRANCH_ONCE function.

Description

This function causes the trigger model to branch to a specified building block the first time it is encountered in the trigger model.

TSP Syntax

- trigger.model.setblock()

Parameters:	`block_number` (`int`) – The sequence of the block in the trigger model. `branch_to_block` (`str`) – The block number of the trigger model block to execute when the trigger model first encounters this block.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

setblock_trigger_block_branch_once_excluded ¶

setblock_trigger_block_branch_once_excluded(block_number: int, branch_to_block: str) -> None

Run the trigger.model.setblock() - trigger.BLOCK_BRANCH_ONCE_EXCLUDED function.

Description

This function defines a trigger model block that causes the trigger model to go to a specified building block every time the trigger model encounters it, except for the first time.

TSP Syntax

- trigger.model.setblock()

Parameters:	`block_number` (`int`) – The sequence of the block in the trigger model. `branch_to_block` (`str`) – The block number of the trigger model block to execute when the trigger model encounters this block after the first encounter.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

setblock_trigger_block_buffer_clear ¶

setblock_trigger_block_buffer_clear(block_number: int, buffer_name: str | None = None) -> None

Run the trigger.model.setblock() - trigger.BLOCK_BUFFER_CLEAR function.

Description

This function defines a trigger model block that clears the reading buffer.

TSP Syntax

- trigger.model.setblock()

Parameters:	`block_number` (`int`) – The sequence of the block in the trigger model. `buffer_name` (`optional`, default: `None` ) – The name of the buffer, which must be an existing buffer; if no buffer is defined, defbuffer1 is used.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

setblock_trigger_block_delay_constant ¶

setblock_trigger_block_delay_constant(block_number: int, time: str) -> None

Run the trigger.model.setblock() - trigger.BLOCK_DELAY_CONSTANT function.

Description

This function adds a constant delay to the execution of a trigger model.

TSP Syntax

- trigger.model.setblock()

Parameters:	`block_number` (`int`) – The sequence of the block in the trigger model. `time` (`str`) – The amount of time to delay in seconds (167 ns to 10 ks, or 0 for no delay).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

setblock_trigger_block_delay_dynamic ¶

setblock_trigger_block_delay_dynamic(block_number: int, n: int) -> None

Run the trigger.model.setblock() - trigger.BLOCK_DELAY_DYNAMIC function.

Description

This function adds a user delay to the execution of the trigger model.

TSP Syntax

- trigger.model.setblock()

Parameters:	`block_number` (`int`) – The sequence of the block in the trigger model. `n` (`int`) – The number of the user delay, 1 to 5, set by .userdelay[N] or dmm.digitize.userdelay[N].

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

setblock_trigger_block_digital_io ¶

setblock_trigger_block_digital_io(block_number: int, bit_pattern: int, bit_mask: int) -> None

Run the trigger.model.setblock() - trigger.BLOCK_DIGITAL_IO function.

Description

<img id=’f14261’ src=’notesmall_lr.png’ class=’linkedepsandpngtemplate’ alt=’VARIABLE
NOTE’ height=‘17’ width=‘41’ vspace=‘0’ hspace=‘0’ align=’bottom’ border=‘0’>This command requires a communications accessory card to be installed in the instrument. Accessory cards include the KTTI-GPIB, KTTI-TSP, and KTTI-RS232.This function defines a trigger model block that sets the lines on the digital I/O port high or low.

TSP Syntax

- trigger.model.setblock()

Parameters:	`block_number` (`int`) – The sequence of the block in the trigger model. `bit_pattern` (`int`) – Sets the value that specifies the output line bit pattern (0 to 63). `bit_mask` (`int`) – Specifies the bit mask; if omitted, all lines are driven (0 to 63).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

setblock_trigger_block_log_event ¶

setblock_trigger_block_log_event(block_number: int, event_number: int, message: str) -> None

Run the trigger.model.setblock() - trigger.BLOCK_LOG_EVENT function.

Description

This function allows you to log an event in the event log when the trigger model is running.

TSP Syntax

- trigger.model.setblock()

Parameters:	`block_number` (`int`) – The sequence of the block in the trigger model. `event_number` (`int`) – The event number. `message` (`str`) – A string up to 31 characters.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

setblock_trigger_block_measure_digitize ¶

setblock_trigger_block_measure_digitize(
    block_number: int, buffer_name: str | None = None, count: int | None = None
) -> None

Run the trigger.model.setblock() - trigger.BLOCK_MEASURE_DIGITIZE function.

Description

This function defines a trigger block that makes or digitizes a measurement.

TSP Syntax

- trigger.model.setblock()

Parameters:	`block_number` (`int`) – The sequence of the block in the trigger model. `buffer_name` (`optional`, default: `None` ) – The name of the buffer, which must be an existing buffer; if no buffer is defined, defbuffer1 is used. `count` (`optional`, default: `None` ) – The number of measure or digitize readings to make before moving to the next block in the trigger model; set to.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

setblock_trigger_block_nop ¶

setblock_trigger_block_nop(block_number: int) -> None

Run the trigger.model.setblock() - trigger.BLOCK_NOP function.

Description

This function creates a placeholder that performs no action in the trigger model; available only using remote commands.

TSP Syntax

- trigger.model.setblock()

Parameters:	`block_number` (`int`) – The sequence of the block in the trigger model.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

setblock_trigger_block_notify ¶

setblock_trigger_block_notify(block_number: int, n: str) -> None

Run the trigger.model.setblock() - trigger.BLOCK_NOTIFY function.

Description

This function defines a trigger model block that generates a trigger event and immediately continues to the next block.

TSP Syntax

- trigger.model.setblock()

Parameters:	`block_number` (`int`) – The sequence of the block in the trigger model. `n` (`str`) – The identification number of the notification; 1 to 8.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

setblock_trigger_block_reset_branch_count ¶

setblock_trigger_block_reset_branch_count(block_number: int, counter: str) -> None

Run the trigger.model.setblock() - trigger.BLOCK_RESET_BRANCH_COUNT function.

Description

This function creates a block in the trigger model that resets a branch counter to 0.

TSP Syntax

- trigger.model.setblock()

Parameters:	`block_number` (`int`) – The sequence of the block in the trigger model. `counter` (`str`) – The block number of the counter that is to be reset.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

setblock_trigger_block_wait ¶

setblock_trigger_block_wait(
    block_number: int,
    event: str,
    clear: str | None = None,
    logic: str | None = None,
    event_2: str | None = None,
    event_3: str | None = None,
) -> None

Run the trigger.model.setblock() - trigger.BLOCK_WAIT function.

Description

This function defines a trigger model block that waits for an event before allowing the trigger model to continue.

TSP Syntax

- trigger.model.setblock()

Parameters:

block_number (int) –

The sequence of the block in the trigger model.
event (str) –

The event that must occur before the trigger block allows trigger execution to continue (see Details).
clear (optional, default: None ) –

To clear previously detected trigger events when entering the wait block.
logic (optional, default: None ) –

If each event must occur before the trigger model continues.
event_2 (optional, default: None ) –

The event that must occur before the trigger block allows trigger execution to continue (see Details).
event_3 (optional, default: None ) –

The event that must occur before the trigger block allows trigger execution to continue (see Details).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

TriggerTimerItem ¶

Bases: ValidatedDynamicNumberCmd, BaseTSPCmd

The trigger.timer[N] command tree.

Info

N, the trigger timer number (1 to 4).

Properties and methods

.clear(): The trigger.timer[N].clear() function.
.count: The trigger.timer[N].count attribute.
.delay: The trigger.timer[N].delay attribute.
.delaylist: The trigger.timer[N].delaylist attribute.
.enable: The trigger.timer[N].enable attribute.
.reset(): The trigger.timer[N].reset() function.
.start: The trigger.timer[N].start command tree.
.wait(): The trigger.timer[N].wait() function.

count `property` `writable` ¶

count: str

Access the trigger.timer[N].count attribute.

Description

This attribute sets the number of events to generate each time the timer generates a trigger event or is enabled as a timer or alarm or is enabled as a timer or alarm.

Usage

Accessing this property will send the print(trigger.timer[N].count) query.
Setting this property to a value will send the trigger.timer[N].count = value command.

TSP Syntax

- trigger.timer[N].count = value
- print(trigger.timer[N].count)

Info

N, the trigger timer number (1 to 4).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

delay `property` `writable` ¶

delay: str

Access the trigger.timer[N].delay attribute.

Description

This attribute sets and reads the timer delay.

Usage

Accessing this property will send the print(trigger.timer[N].delay) query.
Setting this property to a value will send the trigger.timer[N].delay = value command.

TSP Syntax

- trigger.timer[N].delay = value
- print(trigger.timer[N].delay)

Info

N, the trigger timer number (1 to 4).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

delaylist `property` `writable` ¶

delaylist: str

Access the trigger.timer[N].delaylist attribute.

Description

This attribute sets an array of timer intervals.

Usage

Accessing this property will send the print(trigger.timer[N].delaylist) query.
Setting this property to a value will send the trigger.timer[N].delaylist = value command.

TSP Syntax

- trigger.timer[N].delaylist = value
- print(trigger.timer[N].delaylist)

Info

N, the trigger timer number (1 to 4).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

enable `property` `writable` ¶

enable: str

Access the trigger.timer[N].enable attribute.

Description

This attribute enables the trigger timer.

Usage

Accessing this property will send the print(trigger.timer[N].enable) query.
Setting this property to a value will send the trigger.timer[N].enable = value command.

TSP Syntax

- trigger.timer[N].enable = value
- print(trigger.timer[N].enable)

Info

N, the trigger timer number (1 to 4).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

start `property` ¶

start: TriggerTimerItemStart

Return the trigger.timer[N].start command tree.

Info

N, the trigger timer number (1 to 4).

Sub-properties and sub-methods

.fractionalseconds: The trigger.timer[N].start.fractionalseconds attribute.
.generate: The trigger.timer[N].start.generate attribute.
.overrun: The trigger.timer[N].start.overrun attribute.
.seconds: The trigger.timer[N].start.seconds attribute.
.stimulus: The trigger.timer[N].start.stimulus attribute.

clear ¶

clear() -> None

Run the trigger.timer[N].clear() function.

Description

This function clears the timer event detector and overrun indicator for the specified trigger timer number.

TSP Syntax

- trigger.timer[N].clear()

Info

N, the trigger timer number (1 to 4).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

reset ¶

reset() -> None

Run the trigger.timer[N].reset() function.

Description

This function resets trigger timer settings to their default values.

TSP Syntax

- trigger.timer[N].reset()

Info

N, the trigger timer number (1 to 4).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

wait ¶

wait(timeout: float) -> str

Run the trigger.timer[N].wait() function.

Description

This function waits for a trigger.

TSP Syntax

- trigger.timer[N].wait()

Parameters:	`timeout` (`float`) – Maximum amount of time in seconds to wait for the trigger.

Returns:	`str` – The result of the function call.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

TriggerTimerItemStart ¶

Bases: BaseTSPCmd

The trigger.timer[N].start command tree.

Info

N, the trigger timer number (1 to 4).

Properties and methods

.fractionalseconds: The trigger.timer[N].start.fractionalseconds attribute.
.generate: The trigger.timer[N].start.generate attribute.
.overrun: The trigger.timer[N].start.overrun attribute.
.seconds: The trigger.timer[N].start.seconds attribute.
.stimulus: The trigger.timer[N].start.stimulus attribute.

fractionalseconds `property` `writable` ¶

fractionalseconds: str

Access the trigger.timer[N].start.fractionalseconds attribute.

Description

This attribute configures the fractional seconds of an alarm or a time in the future when the timer will start.

Usage

Accessing this property will send the print(trigger.timer[N].start.fractionalseconds) query.
Setting this property to a value will send the trigger.timer[N].start.fractionalseconds = value command.

TSP Syntax

- trigger.timer[N].start.fractionalseconds = value
- print(trigger.timer[N].start.fractionalseconds)

Info

N, the trigger timer number (1 to 4).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

generate `property` `writable` ¶

generate: str

Access the trigger.timer[N].start.generate attribute.

Description

This attribute specifies when timer events are generated.

Usage

Accessing this property will send the print(trigger.timer[N].start.generate) query.
Setting this property to a value will send the trigger.timer[N].start.generate = value command.

TSP Syntax

- trigger.timer[N].start.generate = value
- print(trigger.timer[N].start.generate)

Info

N, the trigger timer number (1 to 4).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

overrun `property` ¶

overrun: str

Access the trigger.timer[N].start.overrun attribute.

Description

This attribute indicates if an event was ignored because of the event detector state.

Usage

Accessing this property will send the print(trigger.timer[N].start.overrun) query.

TSP Syntax

- print(trigger.timer[N].start.overrun)

Info

N, the trigger timer number (1 to 4).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

seconds `property` `writable` ¶

seconds: str

Access the trigger.timer[N].start.seconds attribute.

Description

This attribute configures the seconds of an alarm or a time in the future when the timer will start.

Usage

Accessing this property will send the print(trigger.timer[N].start.seconds) query.
Setting this property to a value will send the trigger.timer[N].start.seconds = value command.

TSP Syntax

- trigger.timer[N].start.seconds = value
- print(trigger.timer[N].start.seconds)

Info

N, the trigger timer number (1 to 4).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

stimulus `property` `writable` ¶

stimulus: str

Access the trigger.timer[N].start.stimulus attribute.

Description

This attribute describes the event that starts the trigger timer.

Usage

Accessing this property will send the print(trigger.timer[N].start.stimulus) query.
Setting this property to a value will send the trigger.timer[N].start.stimulus = value command.

TSP Syntax

- trigger.timer[N].start.stimulus = value
- print(trigger.timer[N].start.stimulus)

Info

N, the trigger timer number (1 to 4).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

TriggerTsplinkinItem ¶

Bases: ValidatedDynamicNumberCmd, BaseTSPCmd

The trigger.tsplinkin[N] command tree.

Info

N, the trigger line (1 to 3) to clear.

Properties and methods

.clear(): The trigger.tsplinkin[N].clear() function.
.edge: The trigger.tsplinkin[N].edge attribute.
.overrun: The trigger.tsplinkin[N].overrun attribute.
.wait(): The trigger.tsplinkin[N].wait() function.

edge `property` `writable` ¶

edge: str

Access the trigger.tsplinkin[N].edge attribute.

Description

This attribute indicates which trigger edge controls the trigger event detector for a trigger line.

Usage

Accessing this property will send the print(trigger.tsplinkin[N].edge) query.
Setting this property to a value will send the trigger.tsplinkin[N].edge = value command.

TSP Syntax

- trigger.tsplinkin[N].edge = value
- print(trigger.tsplinkin[N].edge)

Info

N, the trigger line (1 to 3).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

overrun `property` ¶

overrun: str

Access the trigger.tsplinkin[N].overrun attribute.

Description

This attribute indicates if the event detector ignored an event while in the detected state.

Usage

Accessing this property will send the print(trigger.tsplinkin[N].overrun) query.

TSP Syntax

- print(trigger.tsplinkin[N].overrun)

Info

N, the trigger line (1 to 3).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

clear ¶

clear() -> None

Run the trigger.tsplinkin[N].clear() function.

Description

This function clears the event detector for a LAN trigger.

TSP Syntax

- trigger.tsplinkin[N].clear()

Info

N, the trigger line (1 to 3) to clear.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

wait ¶

wait(timeout: float) -> str

Run the trigger.tsplinkin[N].wait() function.

Description

This function waits for a trigger.

TSP Syntax

- trigger.tsplinkin[N].wait()

Parameters:	`timeout` (`float`) – The timeout value in seconds.

Returns:	`str` – The result of the function call.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

TriggerTsplinkoutItem ¶

Bases: ValidatedDynamicNumberCmd, BaseTSPCmd

The trigger.tsplinkout[N] command tree.

Info

N, the trigger line (1 to 3).

Properties and methods

.assert(): The trigger.tsplinkout[N].assert() function.
.logic: The trigger.tsplinkout[N].logic attribute.
.pulsewidth: The trigger.tsplinkout[N].pulsewidth attribute.
.release(): The trigger.tsplinkout[N].release() function.
.stimulus: The trigger.tsplinkout[N].stimulus attribute.

logic `property` `writable` ¶

logic: str

Access the trigger.tsplinkout[N].logic attribute.

Description

This attribute defines the trigger output with output logic for a trigger line.

Usage

Accessing this property will send the print(trigger.tsplinkout[N].logic) query.
Setting this property to a value will send the trigger.tsplinkout[N].logic = value command.

TSP Syntax

- trigger.tsplinkout[N].logic = value
- print(trigger.tsplinkout[N].logic)

Info

N, the trigger line (1 to 3).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

pulsewidth `property` `writable` ¶

pulsewidth: str

Access the trigger.tsplinkout[N].pulsewidth attribute.

Description

This attribute sets the length of time that the trigger line is asserted for output triggers.

Usage

Accessing this property will send the print(trigger.tsplinkout[N].pulsewidth) query.
Setting this property to a value will send the trigger.tsplinkout[N].pulsewidth = value command.

TSP Syntax

- trigger.tsplinkout[N].pulsewidth = value
- print(trigger.tsplinkout[N].pulsewidth)

Info

width, the pulse width (0.0 to 100 ks).
N, the trigger line (1 to 3).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

stimulus `property` `writable` ¶

stimulus: str

Access the trigger.tsplinkout[N].stimulus attribute.

Description

This attribute specifies the event that causes the synchronization line to assert a trigger.

Usage

Accessing this property will send the print(trigger.tsplinkout[N].stimulus) query.
Setting this property to a value will send the trigger.tsplinkout[N].stimulus = value command.

TSP Syntax

- trigger.tsplinkout[N].stimulus = value
- print(trigger.tsplinkout[N].stimulus)

Info

N, the trigger line (1 to 3).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

assert_ ¶

assert_() -> None

Run the trigger.tsplinkout[N].assert() function.

Description

This function simulates the occurrence of the trigger and generates the corresponding trigger event.

TSP Syntax

- trigger.tsplinkout[N].assert()

Info

N, the trigger line (1 to 3).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

release ¶

release() -> None

Run the trigger.tsplinkout[N].release() function.

Description

This function releases a latched trigger on the given TSP-Link trigger line.

TSP Syntax

- trigger.tsplinkout[N].release()

Info

N, the trigger line (1 to 3).

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

trigger ¶

Trigger ¶

BLOCK_BRANCH_ALWAYS class-attribute instance-attribute ¶

BLOCK_BRANCH_COUNTER class-attribute instance-attribute ¶

BLOCK_BRANCH_DELTA class-attribute instance-attribute ¶

BLOCK_BRANCH_LIMIT_CONSTANT class-attribute instance-attribute ¶

BLOCK_BRANCH_LIMIT_DYNAMIC class-attribute instance-attribute ¶

BLOCK_BRANCH_ONCE class-attribute instance-attribute ¶

BLOCK_BRANCH_ONCE_EXCLUDED class-attribute instance-attribute ¶

BLOCK_BRANCH_ON_EVENT class-attribute instance-attribute ¶

BLOCK_BUFFER_CLEAR class-attribute instance-attribute ¶

BLOCK_CONFIG_NEXT class-attribute instance-attribute ¶

BLOCK_CONFIG_PREV class-attribute instance-attribute ¶

BLOCK_DELAY_CONSTANT class-attribute instance-attribute ¶

BLOCK_DELAY_DYNAMIC class-attribute instance-attribute ¶

BLOCK_DIGITAL_IO class-attribute instance-attribute ¶

BLOCK_LOG_EVENT class-attribute instance-attribute ¶

BLOCK_MEASURE class-attribute instance-attribute ¶

BLOCK_MEASURE_DIGITIZE class-attribute instance-attribute ¶

BLOCK_NOP class-attribute instance-attribute ¶

BLOCK_NOTIFY class-attribute instance-attribute ¶

BLOCK_RESET_BRANCH_COUNT class-attribute instance-attribute ¶

BLOCK_WAIT class-attribute instance-attribute ¶

CLEAR_ENTER class-attribute instance-attribute ¶

CLEAR_NEVER class-attribute instance-attribute ¶

CONT_AUTO class-attribute instance-attribute ¶

CONT_OFF class-attribute instance-attribute ¶

CONT_RESTART class-attribute instance-attribute ¶

COUNT_AUTO class-attribute instance-attribute ¶

COUNT_INFINITE class-attribute instance-attribute ¶

COUNT_STOP class-attribute instance-attribute ¶

EDGE_EITHER class-attribute instance-attribute ¶

EDGE_FALLING class-attribute instance-attribute ¶

EDGE_RISING class-attribute instance-attribute ¶

EVENT_BLENDERN class-attribute instance-attribute ¶

EVENT_COMMAND class-attribute instance-attribute ¶

EVENT_DIGION class-attribute instance-attribute ¶

EVENT_DISPLAY class-attribute instance-attribute ¶

EVENT_LANN class-attribute instance-attribute ¶

EVENT_NONE class-attribute instance-attribute ¶

EVENT_NOTIFYN class-attribute instance-attribute ¶

EVENT_TIMER1 class-attribute instance-attribute ¶

EVENT_TIMER2 class-attribute instance-attribute ¶

EVENT_TIMER3 class-attribute instance-attribute ¶

EVENT_TIMER4 class-attribute instance-attribute ¶

EVENT_TSPLINKN class-attribute instance-attribute ¶

LIMIT_ABOVE class-attribute instance-attribute ¶

LIMIT_BELOW class-attribute instance-attribute ¶

LIMIT_INSIDE class-attribute instance-attribute ¶

LIMIT_OUTSIDE class-attribute instance-attribute ¶

LOGIC_NEGATIVE class-attribute instance-attribute ¶

LOGIC_POSITIVE class-attribute instance-attribute ¶

LOG_ERROR1 class-attribute instance-attribute ¶

LOG_ERROR2 class-attribute instance-attribute ¶

LOG_ERROR3 class-attribute instance-attribute ¶

LOG_ERROR4 class-attribute instance-attribute ¶

LOG_INFO1 class-attribute instance-attribute ¶

LOG_INFO2 class-attribute instance-attribute ¶

LOG_INFO3 class-attribute instance-attribute ¶

LOG_INFO4 class-attribute instance-attribute ¶

LOG_WARN1 class-attribute instance-attribute ¶

LOG_WARN2 class-attribute instance-attribute ¶

LOG_WARN3 class-attribute instance-attribute ¶

LOG_WARN4 class-attribute instance-attribute ¶

LOG_WARN_ABORT class-attribute instance-attribute ¶

OFF class-attribute instance-attribute ¶

ON class-attribute instance-attribute ¶

STATE_ABORTED class-attribute instance-attribute ¶

STATE_ABORTING class-attribute instance-attribute ¶

STATE_BUILDING class-attribute instance-attribute ¶

STATE_EMPTY class-attribute instance-attribute ¶

STATE_FAILED class-attribute instance-attribute ¶

STATE_IDLE class-attribute instance-attribute ¶

STATE_RUNNING class-attribute instance-attribute ¶

STATE_WAITING class-attribute instance-attribute ¶

WAIT_AND class-attribute instance-attribute ¶

WAIT_OR class-attribute instance-attribute ¶

blender property ¶

continuous property writable ¶

digin property ¶

BLOCK_BRANCH_ALWAYS `class-attribute` `instance-attribute` ¶

BLOCK_BRANCH_COUNTER `class-attribute` `instance-attribute` ¶

BLOCK_BRANCH_DELTA `class-attribute` `instance-attribute` ¶

BLOCK_BRANCH_LIMIT_CONSTANT `class-attribute` `instance-attribute` ¶

BLOCK_BRANCH_LIMIT_DYNAMIC `class-attribute` `instance-attribute` ¶

BLOCK_BRANCH_ONCE `class-attribute` `instance-attribute` ¶

BLOCK_BRANCH_ONCE_EXCLUDED `class-attribute` `instance-attribute` ¶

BLOCK_BRANCH_ON_EVENT `class-attribute` `instance-attribute` ¶

BLOCK_BUFFER_CLEAR `class-attribute` `instance-attribute` ¶

BLOCK_CONFIG_NEXT `class-attribute` `instance-attribute` ¶

BLOCK_CONFIG_PREV `class-attribute` `instance-attribute` ¶

BLOCK_DELAY_CONSTANT `class-attribute` `instance-attribute` ¶

BLOCK_DELAY_DYNAMIC `class-attribute` `instance-attribute` ¶

BLOCK_DIGITAL_IO `class-attribute` `instance-attribute` ¶

BLOCK_LOG_EVENT `class-attribute` `instance-attribute` ¶

BLOCK_MEASURE `class-attribute` `instance-attribute` ¶

BLOCK_MEASURE_DIGITIZE `class-attribute` `instance-attribute` ¶

BLOCK_NOP `class-attribute` `instance-attribute` ¶

BLOCK_NOTIFY `class-attribute` `instance-attribute` ¶

BLOCK_RESET_BRANCH_COUNT `class-attribute` `instance-attribute` ¶

BLOCK_WAIT `class-attribute` `instance-attribute` ¶

CLEAR_ENTER `class-attribute` `instance-attribute` ¶

CLEAR_NEVER `class-attribute` `instance-attribute` ¶

CONT_AUTO `class-attribute` `instance-attribute` ¶

CONT_OFF `class-attribute` `instance-attribute` ¶

CONT_RESTART `class-attribute` `instance-attribute` ¶

COUNT_AUTO `class-attribute` `instance-attribute` ¶

COUNT_INFINITE `class-attribute` `instance-attribute` ¶

COUNT_STOP `class-attribute` `instance-attribute` ¶

EDGE_EITHER `class-attribute` `instance-attribute` ¶

EDGE_FALLING `class-attribute` `instance-attribute` ¶

EDGE_RISING `class-attribute` `instance-attribute` ¶

EVENT_BLENDERN `class-attribute` `instance-attribute` ¶

EVENT_COMMAND `class-attribute` `instance-attribute` ¶

EVENT_DIGION `class-attribute` `instance-attribute` ¶

EVENT_DISPLAY `class-attribute` `instance-attribute` ¶

EVENT_LANN `class-attribute` `instance-attribute` ¶

EVENT_NONE `class-attribute` `instance-attribute` ¶

EVENT_NOTIFYN `class-attribute` `instance-attribute` ¶

EVENT_TIMER1 `class-attribute` `instance-attribute` ¶

EVENT_TIMER2 `class-attribute` `instance-attribute` ¶

EVENT_TIMER3 `class-attribute` `instance-attribute` ¶

EVENT_TIMER4 `class-attribute` `instance-attribute` ¶

EVENT_TSPLINKN `class-attribute` `instance-attribute` ¶

LIMIT_ABOVE `class-attribute` `instance-attribute` ¶

LIMIT_BELOW `class-attribute` `instance-attribute` ¶

LIMIT_INSIDE `class-attribute` `instance-attribute` ¶

LIMIT_OUTSIDE `class-attribute` `instance-attribute` ¶

LOGIC_NEGATIVE `class-attribute` `instance-attribute` ¶

LOGIC_POSITIVE `class-attribute` `instance-attribute` ¶

LOG_ERROR1 `class-attribute` `instance-attribute` ¶

LOG_ERROR2 `class-attribute` `instance-attribute` ¶

LOG_ERROR3 `class-attribute` `instance-attribute` ¶

LOG_ERROR4 `class-attribute` `instance-attribute` ¶

LOG_INFO1 `class-attribute` `instance-attribute` ¶

LOG_INFO2 `class-attribute` `instance-attribute` ¶

LOG_INFO3 `class-attribute` `instance-attribute` ¶

LOG_INFO4 `class-attribute` `instance-attribute` ¶

LOG_WARN1 `class-attribute` `instance-attribute` ¶

LOG_WARN2 `class-attribute` `instance-attribute` ¶

LOG_WARN3 `class-attribute` `instance-attribute` ¶

LOG_WARN4 `class-attribute` `instance-attribute` ¶

LOG_WARN_ABORT `class-attribute` `instance-attribute` ¶

OFF `class-attribute` `instance-attribute` ¶

ON `class-attribute` `instance-attribute` ¶

STATE_ABORTED `class-attribute` `instance-attribute` ¶

STATE_ABORTING `class-attribute` `instance-attribute` ¶

STATE_BUILDING `class-attribute` `instance-attribute` ¶

STATE_EMPTY `class-attribute` `instance-attribute` ¶

STATE_FAILED `class-attribute` `instance-attribute` ¶

STATE_IDLE `class-attribute` `instance-attribute` ¶

STATE_RUNNING `class-attribute` `instance-attribute` ¶

STATE_WAITING `class-attribute` `instance-attribute` ¶

WAIT_AND `class-attribute` `instance-attribute` ¶

WAIT_OR `class-attribute` `instance-attribute` ¶

blender `property` ¶

continuous `property` `writable` ¶

digin `property` ¶

digout `property` ¶

ext `property` ¶