trigger
¶
The trigger 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
- 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() - ConfigList
- trigger.model.load() - DurationLoop
- trigger.model.load() - Empty
- 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_CONFIG_NEXT
- trigger.model.setblock() - trigger.BLOCK_CONFIG_PREV
- trigger.model.setblock() - trigger.BLOCK_CONFIG_RECALL
- 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.model.state()
- 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_ANALOGTRIGGER: Analog trigger..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_EXTERNAL: External in trigger..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_SCAN_ALARM_LIMIT: Limit value for scan reached (returns trigger.EVENT_NOTIFY3)..EVENT_SCAN_CHANNEL_READY: Channel closed (returns trigger.EVENT_NOTIFY6)..EVENT_SCAN_COMPLETE: Scan completed (returns trigger.EVENT_NOTIFY8)..EVENT_SCAN_MEASURE_COMPLETE: Measure completed (returns trigger.EVENT_NOTIFY7)..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_TIMERN: Trigger timer N (1 to 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..SCAN_ALARM_LIMIT: Scan alarm limit exceeded..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: Thetrigger.blender[N]command tree..clear(): Thetrigger.clear()function..continuous: Thetrigger.continuousattribute..digin: Thetrigger.digin[N]command tree..digout: Thetrigger.digout[N]command tree..ext: Thetrigger.extcommand tree..extin: Thetrigger.extincommand tree..extout: Thetrigger.extoutcommand tree..lanin: Thetrigger.lanin[N]command tree..lanout: Thetrigger.lanout[N]command tree..model: Thetrigger.modelcommand tree..timer: Thetrigger.timer[N]command tree..tsplinkin: Thetrigger.tsplinkin[N]command tree..tsplinkout: Thetrigger.tsplinkout[N]command tree..wait(): Thetrigger.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_MEASURE_DIGITIZE
class-attribute
instance-attribute
¶
BLOCK_MEASURE_DIGITIZE = 'trigger.BLOCK_MEASURE_DIGITIZE'
BLOCK_RESET_BRANCH_COUNT
class-attribute
instance-attribute
¶
BLOCK_RESET_BRANCH_COUNT = 'trigger.BLOCK_RESET_BRANCH_COUNT'
EVENT_ANALOGTRIGGER
class-attribute
instance-attribute
¶
EVENT_ANALOGTRIGGER = 'trigger.EVENT_ANALOGTRIGGER'
EVENT_SCAN_ALARM_LIMIT
class-attribute
instance-attribute
¶
EVENT_SCAN_ALARM_LIMIT = 'trigger.EVENT_SCAN_ALARM_LIMIT'
EVENT_SCAN_CHANNEL_READY
class-attribute
instance-attribute
¶
EVENT_SCAN_CHANNEL_READY = 'trigger.EVENT_SCAN_CHANNEL_READY'
EVENT_SCAN_COMPLETE
class-attribute
instance-attribute
¶
EVENT_SCAN_COMPLETE = 'trigger.EVENT_SCAN_COMPLETE'
EVENT_SCAN_MEASURE_COMPLETE
class-attribute
instance-attribute
¶
EVENT_SCAN_MEASURE_COMPLETE = 'trigger.EVENT_SCAN_MEASURE_COMPLETE'
blender
property
¶
blender: dict[int, TriggerBlenderItem]
Return the trigger.blender[N] command tree.
Info
N, the blender number (up to two).
Sub-properties and sub-methods
.clear(): Thetrigger.blender[N].clear()function..orenable: Thetrigger.blender[N].orenableattribute..overrun: Thetrigger.blender[N].overrunattribute..reset(): Thetrigger.blender[N].reset()function..stimulus: Thetrigger.blender[N].stimulus[M]attribute..wait(): Thetrigger.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 = valuecommand.
TSP Syntax
- trigger.continuous = value
- print(trigger.continuous)
| Raises: |
|
|---|
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(): Thetrigger.digin[N].clear()function..edge: Thetrigger.digin[N].edgeattribute..overrun: Thetrigger.digin[N].overrunattribute..wait(): Thetrigger.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(): Thetrigger.digout[N].assert()function..logic: Thetrigger.digout[N].logicattribute..pulsewidth: Thetrigger.digout[N].pulsewidthattribute..release(): Thetrigger.digout[N].release()function..stimulus: Thetrigger.digout[N].stimulusattribute.
ext
property
¶
ext: TriggerExt
Return the trigger.ext command tree.
Sub-properties and sub-methods
.reset(): Thetrigger.ext.reset()function.
extin
property
¶
extin: TriggerExtin
Return the trigger.extin command tree.
Sub-properties and sub-methods
.clear(): Thetrigger.extin.clear()function..edge: Thetrigger.extin.edgeattribute..overrun: Thetrigger.extin.overrunattribute..wait(): Thetrigger.extin.wait()function.
extout
property
¶
extout: TriggerExtout
Return the trigger.extout command tree.
Sub-properties and sub-methods
.assert(): Thetrigger.extout.assert()function..logic: Thetrigger.extout.logicattribute..stimulus: Thetrigger.extout.stimulusattribute.
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(): Thetrigger.lanin[N].clear()function..edge: Thetrigger.lanin[N].edgeattribute..overrun: Thetrigger.lanin[N].overrunattribute..wait(): Thetrigger.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(): Thetrigger.lanout[N].assert()function..connect(): Thetrigger.lanout[N].connect()function..connected: Thetrigger.lanout[N].connectedattribute..disconnect(): Thetrigger.lanout[N].disconnect()function..ipaddress: Thetrigger.lanout[N].ipaddressattribute..logic: Thetrigger.lanout[N].logicattribute..protocol: Thetrigger.lanout[N].protocolattribute..stimulus: Thetrigger.lanout[N].stimulusattribute.
model
property
¶
model: TriggerModel
Return the trigger.model command tree.
Sub-properties and sub-methods
.abort(): Thetrigger.model.abort()function..getblocklist(): Thetrigger.model.getblocklist()function..getbranchcount(): Thetrigger.model.getbranchcount()function..initiate(): Thetrigger.model.initiate()function..load_config_list(): Thetrigger.model.load() - ConfigListfunction..load_duration_loop(): Thetrigger.model.load() - DurationLoopfunction..load_empty(): Thetrigger.model.load() - Emptyfunction..load_logic_trigger(): Thetrigger.model.load() - LogicTriggerfunction..load_loop_until_event(): Thetrigger.model.load() - LoopUntilEventfunction..load_simple_loop(): Thetrigger.model.load() - SimpleLoopfunction..pause(): Thetrigger.model.pause()function..resume(): Thetrigger.model.resume()function..setblock_trigger_block_branch_always(): Thetrigger.model.setblock() - trigger.BLOCK_BRANCH_ALWAYSfunction..setblock_trigger_block_branch_counter(): Thetrigger.model.setblock() - trigger.BLOCK_BRANCH_COUNTERfunction..setblock_trigger_block_branch_delta(): Thetrigger.model.setblock() - trigger.BLOCK_BRANCH_DELTAfunction..setblock_trigger_block_branch_limit_constant(): Thetrigger.model.setblock() - trigger.BLOCK_BRANCH_LIMIT_CONSTANTfunction..setblock_trigger_block_branch_limit_dynamic(): Thetrigger.model.setblock() - trigger.BLOCK_BRANCH_LIMIT_DYNAMICfunction..setblock_trigger_block_branch_once(): Thetrigger.model.setblock() - trigger.BLOCK_BRANCH_ONCEfunction..setblock_trigger_block_branch_once_excluded(): Thetrigger.model.setblock() - trigger.BLOCK_BRANCH_ONCE_EXCLUDEDfunction..setblock_trigger_block_branch_on_event(): Thetrigger.model.setblock() - trigger.BLOCK_BRANCH_ON_EVENTfunction..setblock_trigger_block_buffer_clear(): Thetrigger.model.setblock() - trigger.BLOCK_BUFFER_CLEARfunction..setblock_trigger_block_config_next(): Thetrigger.model.setblock() - trigger.BLOCK_CONFIG_NEXTfunction..setblock_trigger_block_config_prev(): Thetrigger.model.setblock() - trigger.BLOCK_CONFIG_PREVfunction..setblock_trigger_block_config_recall(): Thetrigger.model.setblock() - trigger.BLOCK_CONFIG_RECALLfunction..setblock_trigger_block_delay_constant(): Thetrigger.model.setblock() - trigger.BLOCK_DELAY_CONSTANTfunction..setblock_trigger_block_delay_dynamic(): Thetrigger.model.setblock() - trigger.BLOCK_DELAY_DYNAMICfunction..setblock_trigger_block_digital_io(): Thetrigger.model.setblock() - trigger.BLOCK_DIGITAL_IOfunction..setblock_trigger_block_log_event(): Thetrigger.model.setblock() - trigger.BLOCK_LOG_EVENTfunction..setblock_trigger_block_measure_digitize(): Thetrigger.model.setblock() - trigger.BLOCK_MEASURE_DIGITIZEfunction..setblock_trigger_block_nop(): Thetrigger.model.setblock() - trigger.BLOCK_NOPfunction..setblock_trigger_block_notify(): Thetrigger.model.setblock() - trigger.BLOCK_NOTIFYfunction..setblock_trigger_block_reset_branch_count(): Thetrigger.model.setblock() - trigger.BLOCK_RESET_BRANCH_COUNTfunction..setblock_trigger_block_wait(): Thetrigger.model.setblock() - trigger.BLOCK_WAITfunction..state(): Thetrigger.model.state()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(): Thetrigger.timer[N].clear()function..count: Thetrigger.timer[N].countattribute..delay: Thetrigger.timer[N].delayattribute..delaylist: Thetrigger.timer[N].delaylistattribute..enable: Thetrigger.timer[N].enableattribute..reset(): Thetrigger.timer[N].reset()function..start: Thetrigger.timer[N].startcommand tree..wait(): Thetrigger.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(): Thetrigger.tsplinkin[N].clear()function..edge: Thetrigger.tsplinkin[N].edgeattribute..overrun: Thetrigger.tsplinkin[N].overrunattribute..wait(): Thetrigger.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(): Thetrigger.tsplinkout[N].assert()function..logic: Thetrigger.tsplinkout[N].logicattribute..pulsewidth: Thetrigger.tsplinkout[N].pulsewidthattribute..release(): Thetrigger.tsplinkout[N].release()function..stimulus: Thetrigger.tsplinkout[N].stimulusattribute.
clear
¶
clear() -> None
Run the trigger.clear() function.
Description
- This function clears any pending command triggers.
TSP Syntax
- trigger.clear()
| Raises: |
|
|---|
wait
¶
Run the trigger.wait() function.
Description
- This function waits for a trigger event.
TSP Syntax
- trigger.wait()
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
TriggerBlenderItem
¶
Bases: ValidatedDynamicNumberCmd, BaseTSPCmd
The trigger.blender[N] command tree.
Info
N, the blender number (up to two).
Properties and methods
.clear(): Thetrigger.blender[N].clear()function..orenable: Thetrigger.blender[N].orenableattribute..overrun: Thetrigger.blender[N].overrunattribute..reset(): Thetrigger.blender[N].reset()function..stimulus: Thetrigger.blender[N].stimulus[M]attribute..wait(): Thetrigger.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 = valuecommand.
TSP Syntax
- trigger.blender[N].orenable = value
- print(trigger.blender[N].orenable)
Info
N, the blender number (up to two).
| Raises: |
|
|---|
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 (up to two).
| Raises: |
|
|---|
stimulus
property
¶
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] = valuecommand.
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 (up to two).M, the an integer representing the stimulus index (1 to 4).
| Raises: |
|
|---|
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 (up to two).
| Raises: |
|
|---|
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 (up to two).
| Raises: |
|
|---|
wait
¶
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: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
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(): Thetrigger.digin[N].clear()function..edge: Thetrigger.digin[N].edgeattribute..overrun: Thetrigger.digin[N].overrunattribute..wait(): Thetrigger.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 = valuecommand.
TSP Syntax
- trigger.digin[N].edge = value
- print(trigger.digin[N].edge)
Info
N, the digital I/O trigger line (1 to 6).
| Raises: |
|
|---|
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: |
|
|---|
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: |
|
|---|
wait
¶
Run the trigger.digin[N].wait() function.
Description
- This function waits for a trigger.
TSP Syntax
- trigger.digin[N].wait()
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
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(): Thetrigger.digout[N].assert()function..logic: Thetrigger.digout[N].logicattribute..pulsewidth: Thetrigger.digout[N].pulsewidthattribute..release(): Thetrigger.digout[N].release()function..stimulus: Thetrigger.digout[N].stimulusattribute.
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 = valuecommand.
TSP Syntax
- trigger.digout[N].logic = value
- print(trigger.digout[N].logic)
Info
N, the digital I/O trigger line (1 to 6).
| Raises: |
|
|---|
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 = valuecommand.
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: |
|
|---|
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 = valuecommand.
TSP Syntax
- trigger.digout[N].stimulus = value
- print(trigger.digout[N].stimulus)
Info
N, the digital I/O trigger line (1 to 6).
| Raises: |
|
|---|
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: |
|
|---|
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: |
|
|---|
TriggerExt
¶
Bases: BaseTSPCmd
The trigger.ext command tree.
Properties and methods
.reset(): Thetrigger.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 TRIGGER IN and EXTERNAL TRIGGER OUT lines to their default values.
TSP Syntax
- trigger.ext.reset()
| Raises: |
|
|---|
TriggerExtin
¶
Bases: BaseTSPCmd
The trigger.extin command tree.
Properties and methods
.clear(): Thetrigger.extin.clear()function..edge: Thetrigger.extin.edgeattribute..overrun: Thetrigger.extin.overrunattribute..wait(): Thetrigger.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 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 = valuecommand.
TSP Syntax
- trigger.extin.edge = value
- print(trigger.extin.edge)
| Raises: |
|
|---|
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: |
|
|---|
clear
¶
clear() -> None
Run the trigger.extin.clear() function.
Description
- This function clears the trigger event on the EXTERNAL TRIGGER IN line.
TSP Syntax
- trigger.extin.clear()
| Raises: |
|
|---|
wait
¶
Run the trigger.extin.wait() function.
Description
- This function waits for a trigger.
TSP Syntax
- trigger.extin.wait()
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
TriggerExtout
¶
Bases: BaseTSPCmd
The trigger.extout command tree.
Properties and methods
.assert(): Thetrigger.extout.assert()function..logic: Thetrigger.extout.logicattribute..stimulus: Thetrigger.extout.stimulusattribute.
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 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 = valuecommand.
TSP Syntax
- trigger.extout.logic = value
- print(trigger.extout.logic)
| Raises: |
|
|---|
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 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 = valuecommand.
TSP Syntax
- trigger.extout.stimulus = value
- print(trigger.extout.stimulus)
| Raises: |
|
|---|
assert_
¶
assert_() -> None
Run the trigger.extout.assert() function.
Description
- This function asserts a trigger on the EXTERNAL TRIGGER OUT line.
TSP Syntax
- trigger.extout.assert()
| Raises: |
|
|---|
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(): Thetrigger.lanin[N].clear()function..edge: Thetrigger.lanin[N].edgeattribute..overrun: Thetrigger.lanin[N].overrunattribute..wait(): Thetrigger.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 = valuecommand.
TSP Syntax
- trigger.lanin[N].edge = value
- print(trigger.lanin[N].edge)
Info
N, the LAN event number (1 to 8).
| Raises: |
|
|---|
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: |
|
|---|
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: |
|
|---|
wait
¶
Run the trigger.lanin[N].wait() function.
Description
- This function waits for an input trigger.
TSP Syntax
- trigger.lanin[N].wait()
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
TriggerLanoutItem
¶
Bases: ValidatedDynamicNumberCmd, BaseTSPCmd
The trigger.lanout[N] command tree.
Info
N, the LAN event number (1 to 8).
Properties and methods
.assert(): Thetrigger.lanout[N].assert()function..connect(): Thetrigger.lanout[N].connect()function..connected: Thetrigger.lanout[N].connectedattribute..disconnect(): Thetrigger.lanout[N].disconnect()function..ipaddress: Thetrigger.lanout[N].ipaddressattribute..logic: Thetrigger.lanout[N].logicattribute..protocol: Thetrigger.lanout[N].protocolattribute..stimulus: Thetrigger.lanout[N].stimulusattribute.
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: |
|
|---|
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 = valuecommand.
TSP Syntax
- trigger.lanout[N].ipaddress = value
- print(trigger.lanout[N].ipaddress)
Info
N, the LAN event number (1 to 8).
| Raises: |
|
|---|
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 = valuecommand.
TSP Syntax
- trigger.lanout[N].logic = value
- print(trigger.lanout[N].logic)
Info
N, the LAN event number (1 to 8).
| Raises: |
|
|---|
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 = valuecommand.
TSP Syntax
- trigger.lanout[N].protocol = value
- print(trigger.lanout[N].protocol)
Info
N, the LAN event number (1 to 8).
| Raises: |
|
|---|
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 = valuecommand.
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: |
|
|---|
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: |
|
|---|
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: |
|
|---|
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: |
|
|---|
TriggerModel
¶
Bases: BaseTSPCmd
The trigger.model command tree.
Properties and methods
.abort(): Thetrigger.model.abort()function..getblocklist(): Thetrigger.model.getblocklist()function..getbranchcount(): Thetrigger.model.getbranchcount()function..initiate(): Thetrigger.model.initiate()function..load_config_list(): Thetrigger.model.load() - ConfigListfunction..load_duration_loop(): Thetrigger.model.load() - DurationLoopfunction..load_empty(): Thetrigger.model.load() - Emptyfunction..load_logic_trigger(): Thetrigger.model.load() - LogicTriggerfunction..load_loop_until_event(): Thetrigger.model.load() - LoopUntilEventfunction..load_simple_loop(): Thetrigger.model.load() - SimpleLoopfunction..pause(): Thetrigger.model.pause()function..resume(): Thetrigger.model.resume()function..setblock_trigger_block_branch_always(): Thetrigger.model.setblock() - trigger.BLOCK_BRANCH_ALWAYSfunction..setblock_trigger_block_branch_counter(): Thetrigger.model.setblock() - trigger.BLOCK_BRANCH_COUNTERfunction..setblock_trigger_block_branch_delta(): Thetrigger.model.setblock() - trigger.BLOCK_BRANCH_DELTAfunction..setblock_trigger_block_branch_limit_constant(): Thetrigger.model.setblock() - trigger.BLOCK_BRANCH_LIMIT_CONSTANTfunction..setblock_trigger_block_branch_limit_dynamic(): Thetrigger.model.setblock() - trigger.BLOCK_BRANCH_LIMIT_DYNAMICfunction..setblock_trigger_block_branch_once(): Thetrigger.model.setblock() - trigger.BLOCK_BRANCH_ONCEfunction..setblock_trigger_block_branch_once_excluded(): Thetrigger.model.setblock() - trigger.BLOCK_BRANCH_ONCE_EXCLUDEDfunction..setblock_trigger_block_branch_on_event(): Thetrigger.model.setblock() - trigger.BLOCK_BRANCH_ON_EVENTfunction..setblock_trigger_block_buffer_clear(): Thetrigger.model.setblock() - trigger.BLOCK_BUFFER_CLEARfunction..setblock_trigger_block_config_next(): Thetrigger.model.setblock() - trigger.BLOCK_CONFIG_NEXTfunction..setblock_trigger_block_config_prev(): Thetrigger.model.setblock() - trigger.BLOCK_CONFIG_PREVfunction..setblock_trigger_block_config_recall(): Thetrigger.model.setblock() - trigger.BLOCK_CONFIG_RECALLfunction..setblock_trigger_block_delay_constant(): Thetrigger.model.setblock() - trigger.BLOCK_DELAY_CONSTANTfunction..setblock_trigger_block_delay_dynamic(): Thetrigger.model.setblock() - trigger.BLOCK_DELAY_DYNAMICfunction..setblock_trigger_block_digital_io(): Thetrigger.model.setblock() - trigger.BLOCK_DIGITAL_IOfunction..setblock_trigger_block_log_event(): Thetrigger.model.setblock() - trigger.BLOCK_LOG_EVENTfunction..setblock_trigger_block_measure_digitize(): Thetrigger.model.setblock() - trigger.BLOCK_MEASURE_DIGITIZEfunction..setblock_trigger_block_nop(): Thetrigger.model.setblock() - trigger.BLOCK_NOPfunction..setblock_trigger_block_notify(): Thetrigger.model.setblock() - trigger.BLOCK_NOTIFYfunction..setblock_trigger_block_reset_branch_count(): Thetrigger.model.setblock() - trigger.BLOCK_RESET_BRANCH_COUNTfunction..setblock_trigger_block_wait(): Thetrigger.model.setblock() - trigger.BLOCK_WAITfunction..state(): Thetrigger.model.state()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: |
|
|---|
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: |
|
|---|
| Raises: |
|
|---|
getbranchcount
¶
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: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
initiate
¶
initiate() -> None
Run the trigger.model.initiate() function.
Description
- This function starts the trigger model or scan.
TSP Syntax
- trigger.model.initiate()
| Raises: |
|
|---|
load_config_list
¶
load_config_list(
measure_config_list: str, delay: float | None = None, buffer_name: str | None = None
) -> None
Run the trigger.model.load() - ConfigList function.
Description
- This function loads a trigger-model template configuration that uses a measure configuration list.
TSP Syntax
- trigger.model.load()
| Parameters: |
|
|---|
| Raises: |
|
|---|
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: |
|
|---|
| Raises: |
|
|---|
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: |
|
|---|
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: |
|
|---|
| Raises: |
|
|---|
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: |
|
|---|
| Raises: |
|
|---|
load_simple_loop
¶
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: |
|
|---|
| Raises: |
|
|---|
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: |
|
|---|
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: |
|
|---|
setblock_trigger_block_branch_always
¶
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: |
|---|
| Raises: |
|
|---|
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: |
|---|
| Raises: |
|
|---|
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: |
|
|---|
| Raises: |
|
|---|
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: |
|
|---|
| Raises: |
|
|---|
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: |
|
|---|
| Raises: |
|
|---|
setblock_trigger_block_branch_on_event
¶
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: |
|---|
| Raises: |
|
|---|
setblock_trigger_block_branch_once
¶
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: |
|---|
| Raises: |
|
|---|
setblock_trigger_block_branch_once_excluded
¶
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: |
|---|
| Raises: |
|
|---|
setblock_trigger_block_buffer_clear
¶
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: |
|
|---|
| Raises: |
|
|---|
setblock_trigger_block_config_next
¶
Run the trigger.model.setblock() - trigger.BLOCK_CONFIG_NEXT function.
Description
- This function recalls the settings at the next index of a configuration list.
TSP Syntax
- trigger.model.setblock()
| Parameters: |
|---|
| Raises: |
|
|---|
setblock_trigger_block_config_prev
¶
Run the trigger.model.setblock() - trigger.BLOCK_CONFIG_PREV function.
Description
- This function defines a trigger model block that recalls the settings stored at the previous index in a configuration list.
TSP Syntax
- trigger.model.setblock()
| Parameters: |
|---|
| Raises: |
|
|---|
setblock_trigger_block_config_recall
¶
setblock_trigger_block_config_recall(
block_number: int, configuration_list: str, index: int | None = None
) -> None
Run the trigger.model.setblock() - trigger.BLOCK_CONFIG_RECALL function.
Description
- This function recalls the system settings that are stored in a configuration list.
TSP Syntax
- trigger.model.setblock()
| Parameters: |
|---|
| Raises: |
|
|---|
setblock_trigger_block_delay_constant
¶
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: |
|---|
| Raises: |
|
|---|
setblock_trigger_block_delay_dynamic
¶
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: |
|---|
| Raises: |
|
|---|
setblock_trigger_block_digital_io
¶
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: |
|---|
| Raises: |
|
|---|
setblock_trigger_block_log_event
¶
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: |
|---|
| Raises: |
|
|---|
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: |
|
|---|
| Raises: |
|
|---|
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: |
|
|---|
| Raises: |
|
|---|
setblock_trigger_block_notify
¶
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: |
|---|
| Raises: |
|
|---|
setblock_trigger_block_reset_branch_count
¶
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: |
|---|
| Raises: |
|
|---|
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: |
|
|---|
| Raises: |
|
|---|
state
¶
state() -> str
Run the trigger.model.state() function.
Description
- This function returns the present state of the trigger model.
TSP Syntax
- trigger.model.state()
| Returns: |
|
|---|
| Raises: |
|
|---|
TriggerTimerItem
¶
Bases: ValidatedDynamicNumberCmd, BaseTSPCmd
The trigger.timer[N] command tree.
Info
N, the trigger timer number (1 to 4).
Properties and methods
.clear(): Thetrigger.timer[N].clear()function..count: Thetrigger.timer[N].countattribute..delay: Thetrigger.timer[N].delayattribute..delaylist: Thetrigger.timer[N].delaylistattribute..enable: Thetrigger.timer[N].enableattribute..reset(): Thetrigger.timer[N].reset()function..start: Thetrigger.timer[N].startcommand tree..wait(): Thetrigger.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.
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 = valuecommand.
TSP Syntax
- trigger.timer[N].count = value
- print(trigger.timer[N].count)
Info
N, the trigger timer number (1 to 4).
| Raises: |
|
|---|
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 = valuecommand.
TSP Syntax
- trigger.timer[N].delay = value
- print(trigger.timer[N].delay)
Info
N, the trigger timer number (1 to 4).
| Raises: |
|
|---|
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 = valuecommand.
TSP Syntax
- trigger.timer[N].delaylist = value
- print(trigger.timer[N].delaylist)
Info
N, the trigger timer number (1 to 4).
| Raises: |
|
|---|
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 = valuecommand.
TSP Syntax
- trigger.timer[N].enable = value
- print(trigger.timer[N].enable)
Info
N, the trigger timer number (1 to 4).
| Raises: |
|
|---|
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: Thetrigger.timer[N].start.fractionalsecondsattribute..generate: Thetrigger.timer[N].start.generateattribute..overrun: Thetrigger.timer[N].start.overrunattribute..seconds: Thetrigger.timer[N].start.secondsattribute..stimulus: Thetrigger.timer[N].start.stimulusattribute.
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: |
|
|---|
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: |
|
|---|
wait
¶
Run the trigger.timer[N].wait() function.
Description
- This function waits for a trigger.
TSP Syntax
- trigger.timer[N].wait()
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
TriggerTimerItemStart
¶
Bases: BaseTSPCmd
The trigger.timer[N].start command tree.
Info
N, the trigger timer number (1 to 4).
Properties and methods
.fractionalseconds: Thetrigger.timer[N].start.fractionalsecondsattribute..generate: Thetrigger.timer[N].start.generateattribute..overrun: Thetrigger.timer[N].start.overrunattribute..seconds: Thetrigger.timer[N].start.secondsattribute..stimulus: Thetrigger.timer[N].start.stimulusattribute.
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 = valuecommand.
TSP Syntax
- trigger.timer[N].start.fractionalseconds = value
- print(trigger.timer[N].start.fractionalseconds)
Info
N, the trigger timer number (1 to 4).
| Raises: |
|
|---|
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 = valuecommand.
TSP Syntax
- trigger.timer[N].start.generate = value
- print(trigger.timer[N].start.generate)
Info
N, the trigger timer number (1 to 4).
| Raises: |
|
|---|
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: |
|
|---|
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 = valuecommand.
TSP Syntax
- trigger.timer[N].start.seconds = value
- print(trigger.timer[N].start.seconds)
Info
N, the trigger timer number (1 to 4).
| Raises: |
|
|---|
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 = valuecommand.
TSP Syntax
- trigger.timer[N].start.stimulus = value
- print(trigger.timer[N].start.stimulus)
Info
N, the trigger timer number (1 to 4).
| Raises: |
|
|---|
TriggerTsplinkinItem
¶
Bases: ValidatedDynamicNumberCmd, BaseTSPCmd
The trigger.tsplinkin[N] command tree.
Info
N, the trigger line (1 to 3) to clear.
Properties and methods
.clear(): Thetrigger.tsplinkin[N].clear()function..edge: Thetrigger.tsplinkin[N].edgeattribute..overrun: Thetrigger.tsplinkin[N].overrunattribute..wait(): Thetrigger.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 = valuecommand.
TSP Syntax
- trigger.tsplinkin[N].edge = value
- print(trigger.tsplinkin[N].edge)
Info
N, the trigger line (1 to 3).
| Raises: |
|
|---|
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: |
|
|---|
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: |
|
|---|
wait
¶
Run the trigger.tsplinkin[N].wait() function.
Description
- This function waits for a trigger.
TSP Syntax
- trigger.tsplinkin[N].wait()
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
TriggerTsplinkoutItem
¶
Bases: ValidatedDynamicNumberCmd, BaseTSPCmd
The trigger.tsplinkout[N] command tree.
Info
N, the trigger line (1 to 3).
Properties and methods
.assert(): Thetrigger.tsplinkout[N].assert()function..logic: Thetrigger.tsplinkout[N].logicattribute..pulsewidth: Thetrigger.tsplinkout[N].pulsewidthattribute..release(): Thetrigger.tsplinkout[N].release()function..stimulus: Thetrigger.tsplinkout[N].stimulusattribute.
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 = valuecommand.
TSP Syntax
- trigger.tsplinkout[N].logic = value
- print(trigger.tsplinkout[N].logic)
Info
N, the trigger line (1 to 3).
| Raises: |
|
|---|
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 = valuecommand.
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: |
|
|---|
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 = valuecommand.
TSP Syntax
- trigger.tsplinkout[N].stimulus = value
- print(trigger.tsplinkout[N].stimulus)
Info
N, the trigger line (1 to 3).
| Raises: |
|
|---|
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: |
|
|---|
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: |
|
|---|