trigger ¶

The trigger commands module.

These commands are used in the following models: SMU2601B, SMU2602B, SMU2604B, SMU2606B, SMU2611B, SMU2612B, SMU2614B, SMU2634B, SMU2635B, SMU2636B

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.generator[N].assert()
- trigger.timer[N].clear()
- trigger.timer[N].count
- trigger.timer[N].delay
- trigger.timer[N].delaylist
- trigger.timer[N].overrun
- trigger.timer[N].passthrough
- trigger.timer[N].reset()
- trigger.timer[N].stimulus
- trigger.timer[N].wait()
- trigger.wait()

Trigger ¶

Bases: BaseTSPCmd

The trigger command tree.

Constants

.EVENT_ID: The command interface trigger event number.

Properties and methods

.blender: The trigger.blender[N] command tree.
.clear(): The trigger.clear() function.
.generator: The trigger.generator[N] command tree.
.timer: The trigger.timer[N] command tree.
.wait(): The trigger.wait() function.

EVENT_ID `class-attribute` `instance-attribute` ¶

EVENT_ID = 'trigger.EVENT_ID'

blender `property` ¶

blender: dict[int, TriggerBlenderItem]

Return the trigger.blender[N] command tree.

Info

N, the blender number (up to six).

Constants

.EVENT_ID: The trigger blender event 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.

generator `property` ¶

generator: dict[int, TriggerGeneratorItem]

Return the trigger.generator[N] command tree.

Info

N, the generator number (1 or 2).

Constants

.EVENT_ID: The trigger event generated by the trigger event generator.

Sub-properties and sub-methods

.assert(): The trigger.generator[N].assert() function.

timer `property` ¶

timer: dict[int, TriggerTimerItem]

Return the trigger.timer[N] command tree.

Info

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

Constants

.EVENT_ID: The trigger timer event number.

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.
.overrun: The trigger.timer[N].overrun attribute.
.passthrough: The trigger.timer[N].passthrough attribute.
.reset(): The trigger.timer[N].reset() function.
.stimulus: The trigger.timer[N].stimulus attribute.
.wait(): The trigger.timer[N].wait() function.

clear ¶

clear() -> None

Run the trigger.clear() function.

Description

This function clears the command interface trigger event detector.

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 command interface 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 (up to six).

Constants

.EVENT_ID: The trigger blender event 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.

EVENT_ID `class-attribute` `instance-attribute` ¶

EVENT_ID = replace('[N]', f'[{split(']', maxsplit=1)[0]}]')

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 (up to six).

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 (up to six).

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 representing the trigger event blender (up to six).
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 (up to six).

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 (up to six).

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.

TriggerGeneratorItem ¶

Bases: ValidatedDynamicNumberCmd, BaseTSPCmd

The trigger.generator[N] command tree.

Info

N, the generator number (1 or 2).

Constants

.EVENT_ID: The trigger event generated by the trigger event generator.

Properties and methods

.assert(): The trigger.generator[N].assert() function.

EVENT_ID `class-attribute` `instance-attribute` ¶

EVENT_ID = replace('[N]', f'[{split(']', maxsplit=1)[0]}]')

assert_ ¶

assert_() -> None

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

Description

This function generates a trigger event.

TSP Syntax

- trigger.generator[N].assert()

Info

N, the generator number (1 or 2).

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 8).

Constants

.EVENT_ID: The trigger timer event number.

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.
.overrun: The trigger.timer[N].overrun attribute.
.passthrough: The trigger.timer[N].passthrough attribute.
.reset(): The trigger.timer[N].reset() function.
.stimulus: The trigger.timer[N].stimulus attribute.
.wait(): The trigger.timer[N].wait() function.

EVENT_ID `class-attribute` `instance-attribute` ¶

EVENT_ID = replace('[N]', f'[{split(']', maxsplit=1)[0]}]')

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.

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 8).

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 8).

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 8).

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

overrun `property` ¶

overrun: str

Access the trigger.timer[N].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].overrun) query.

TSP Syntax

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

Info

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

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

passthrough `property` `writable` ¶

passthrough: str

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

Description

This attribute enables or disables the timer trigger pass-through mode.

Usage

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

TSP Syntax

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

Info

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

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

stimulus `property` `writable` ¶

stimulus: str

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

Description

This attribute specifies which event starts the timer.

Usage

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

TSP Syntax

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

Info

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

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

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 8).

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

reset ¶

reset() -> None

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

Description

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

TSP Syntax

- trigger.timer[N].reset()

Info

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

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.

trigger ¶

Trigger ¶

EVENT_ID class-attribute instance-attribute ¶

blender property ¶

generator property ¶

timer property ¶

clear ¶

wait ¶

TriggerBlenderItem ¶

EVENT_ID class-attribute instance-attribute ¶

orenable property writable ¶

overrun property ¶

stimulus property ¶

clear ¶

reset ¶

wait ¶

TriggerGeneratorItem ¶

EVENT_ID class-attribute instance-attribute ¶

assert_ ¶

TriggerTimerItem ¶

EVENT_ID class-attribute instance-attribute ¶

count property writable ¶

delay property writable ¶

delaylist property writable ¶

overrun property ¶

passthrough property writable ¶

stimulus property writable ¶

clear ¶

reset ¶

wait ¶

EVENT_ID `class-attribute` `instance-attribute` ¶

blender `property` ¶

generator `property` ¶

timer `property` ¶

EVENT_ID `class-attribute` `instance-attribute` ¶

orenable `property` `writable` ¶

overrun `property` ¶

stimulus `property` ¶

EVENT_ID `class-attribute` `instance-attribute` ¶

EVENT_ID `class-attribute` `instance-attribute` ¶

count `property` `writable` ¶

delay `property` `writable` ¶

delaylist `property` `writable` ¶

overrun `property` ¶

passthrough `property` `writable` ¶

stimulus `property` `writable` ¶