trigger ¶

The trigger commands module.

These commands are used in the following models: MP5103

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

Please report an issue if one is found.

Attributes and Functions

- trigger.clear()
- trigger.detector[N].clear()
- trigger.detector[N].overrun
- trigger.detector[N].stimulus
- trigger.detector[N].wait
- trigger.generator[N].assert()
- trigger.timer[N].clear()
- trigger.timer[N].count
- trigger.timer[N].delay
- 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.
.EVENT_NONE: This trigger event ID is never generated. It is used to disconnect stimulus inputs.

Properties and methods

.clear(): The trigger.clear() function.
.detector: The trigger.detector[N] command tree.
.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'

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

EVENT_NONE = 'trigger.EVENT_NONE'

detector `property` ¶

detector: dict[int, TriggerDetectorItem]

Return the trigger.detector[N] command tree.

Info

N, the detector number: 1 to 8.

Sub-properties and sub-methods

.clear(): The trigger.detector[N].clear() function.
.overrun: The trigger.detector[N].overrun attribute.
.stimulus: The trigger.detector[N].stimulus attribute.
.wait: The trigger.detector[N].wait function.

generator `property` ¶

generator: dict[int, TriggerGeneratorItem]

Return the trigger.generator[N] command tree.

Info

N, the generator number: 1 to 8.

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 trimer 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.
.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.

TriggerDetectorItem ¶

Bases: ValidatedDynamicNumberCmd, BaseTSPCmd

The trigger.detector[N] command tree.

Info

N, the detector number: 1 to 8.

Properties and methods

.clear(): The trigger.detector[N].clear() function.
.overrun: The trigger.detector[N].overrun attribute.
.stimulus: The trigger.detector[N].stimulus attribute.
.wait: The trigger.detector[N].wait function.

overrun `property` ¶

overrun: str

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

TSP Syntax

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

Info

N, the detector number: 1 to 8.

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

stimulus `property` `writable` ¶

stimulus: str

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

Description

This attribute specifies which event triggers the detector.

Usage

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

TSP Syntax

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

Info

N, the detector number: 1 to 8.

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

clear ¶

clear() -> None

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

Description

This command clears the trigger event detector and the overrun indicator.

TSP Syntax

- trigger.detector[N].clear()

Info

N, the detector number: 1 to 8.

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

wait ¶

wait(timeout: float) -> str

Run the trigger.detector[N].wait function.

Description

This command waits for an event to be detected by the detector.

TSP Syntax

- trigger.detector[N].wait

Parameters:	`timeout` (`float`) – The 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.

TriggerGeneratorItem ¶

Bases: ValidatedDynamicNumberCmd, BaseTSPCmd

The trigger.generator[N] command tree.

Info

N, the generator number: 1 to 8.

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

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

TriggerTimerItem ¶

Bases: ValidatedDynamicNumberCmd, BaseTSPCmd

The trigger.timer[N] command tree.

Info

N, the trigger trimer 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.
.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.

overrun `property` `writable` ¶

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.
Setting this property to a value will send the trigger.timer[N].overrun = value command.

TSP Syntax

- trigger.timer[N].overrun = value
- 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 ¶

EVENT_NONE class-attribute instance-attribute ¶

detector property ¶

generator property ¶

timer property ¶

clear ¶

wait ¶

TriggerDetectorItem ¶

overrun property ¶

stimulus property writable ¶

clear ¶

wait ¶

TriggerGeneratorItem ¶

EVENT_ID class-attribute instance-attribute ¶

assert_ ¶

TriggerTimerItem ¶

EVENT_ID class-attribute instance-attribute ¶

count property writable ¶

delay property writable ¶

overrun property writable ¶

passthrough property writable ¶

stimulus property writable ¶

clear ¶

reset ¶

wait ¶

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

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

detector `property` ¶

generator `property` ¶

timer `property` ¶

overrun `property` ¶

stimulus `property` `writable` ¶

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

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

count `property` `writable` ¶

delay `property` `writable` ¶

overrun `property` `writable` ¶

passthrough `property` `writable` ¶

stimulus `property` `writable` ¶