tsplink ¶

The tsplink commands module.

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

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

Please report an issue if one is found.

Attributes and Functions

- tsplink.group
- tsplink.master
- tsplink.node
- tsplink.readbit()
- tsplink.readport()
- tsplink.reset()
- tsplink.state
- tsplink.trigger[N].assert()
- tsplink.trigger[N].clear()
- tsplink.trigger[N].mode
- tsplink.trigger[N].overrun
- tsplink.trigger[N].pulsewidth
- tsplink.trigger[N].release()
- tsplink.trigger[N].reset()
- tsplink.trigger[N].stimulus
- tsplink.trigger[N].wait()
- tsplink.writebit()
- tsplink.writeport()
- tsplink.writeprotect

Tsplink ¶

Bases: BaseTSPCmd

The tsplink command tree.

Constants

.TRIG_BYPASS: Allows direct control of the line as a digital I/O line.
.TRIG_EITHER: Detects rising-edge or falling-edge triggers as input. Asserts a TTL-low pulse for output.
.TRIG_FALLING: Detects falling-edge triggers as input. Asserts a TTL-low pulse for output.
.TRIG_RISING: If the programmed state of the line is high, the tsplink.TRIG_RISING mode behaves similarly to tsplink.TRIG_RISINGA. If the programmed state of the line is low, the tsplink.TRIG_RISING mode behaves similarly to tsplink.TRIG_RISINGM. Use tsplink.TRIG_RISINGA if the line is in the high output state. Use tsplink.TRIG_RISINGM if the line is in the low output state.
.TRIG_RISINGA: Detects rising-edge triggers as input. Asserts a TTL-low pulse for output.
.TRIG_RISINGM: Edge detection as an input is not available. Generates a TTL-high pulse as an output trigger.
.TRIG_SYNCHRONOUS: Detects the falling-edge input triggers and automatically latches and drives the trigger line low. Asserts a TTL-low pulse as an output trigger.
.TRIG_SYNCHRONOUSA: Detects the falling-edge input triggers and automatically latches and drives the trigger line low.
.TRIG_SYNCHRONOUSM: Detects rising-edge triggers as an input. Asserts a TTL-low pulse for output.

Properties and methods

.group: The tsplink.group attribute.
.master: The tsplink.master attribute.
.node: The tsplink.node attribute.
.readbit(): The tsplink.readbit() function.
.readport(): The tsplink.readport() function.
.reset(): The tsplink.reset() function.
.state: The tsplink.state attribute.
.trigger: The tsplink.trigger[N] command tree.
.writebit(): The tsplink.writebit() function.
.writeport(): The tsplink.writeport() function.
.writeprotect: The tsplink.writeprotect attribute.

TRIG_BYPASS `class-attribute` `instance-attribute` ¶

TRIG_BYPASS = 'tsplink.TRIG_BYPASS'

TRIG_EITHER `class-attribute` `instance-attribute` ¶

TRIG_EITHER = 'tsplink.TRIG_EITHER'

TRIG_FALLING `class-attribute` `instance-attribute` ¶

TRIG_FALLING = 'tsplink.TRIG_FALLING'

TRIG_RISING `class-attribute` `instance-attribute` ¶

TRIG_RISING = 'tsplink.TRIG_RISING'

If the programmed state of the line is low, the tsplink.TRIG_RISING mode behaves similarly to tsplink.TRIG_RISINGM. Use tsplink.TRIG_RISINGA if the line is in the high output state. Use tsplink.TRIG_RISINGM if the line is in the low output state.

TRIG_RISINGA `class-attribute` `instance-attribute` ¶

TRIG_RISINGA = 'tsplink.TRIG_RISINGA'

TRIG_RISINGM `class-attribute` `instance-attribute` ¶

TRIG_RISINGM = 'tsplink.TRIG_RISINGM'

TRIG_SYNCHRONOUS `class-attribute` `instance-attribute` ¶

TRIG_SYNCHRONOUS = 'tsplink.TRIG_SYNCHRONOUS'

TRIG_SYNCHRONOUSA `class-attribute` `instance-attribute` ¶

TRIG_SYNCHRONOUSA = 'tsplink.TRIG_SYNCHRONOUSA'

TRIG_SYNCHRONOUSM `class-attribute` `instance-attribute` ¶

TRIG_SYNCHRONOUSM = 'tsplink.TRIG_SYNCHRONOUSM'

group `property` `writable` ¶

group: str

Access the tsplink.group attribute.

Description

This attribute contains the group number of a TSP-Link node. This command is not available on the 2604B, 2614B, or 2634B.

Usage

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

TSP Syntax

- tsplink.group = value
- print(tsplink.group)

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

master `property` ¶

master: str

Access the tsplink.master attribute.

Description

This attribute reads the node number assigned to the master node. This command is not available on the 2604B, 2614B, or 2634B.

Usage

Accessing this property will send the print(tsplink.master) query.

TSP Syntax

- print(tsplink.master)

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

node `property` `writable` ¶

node: str

Access the tsplink.node attribute.

Description

This attribute defines the node number. This command is not available on the 2604B, 2614B, or 2634B.

Usage

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

TSP Syntax

- tsplink.node = value
- print(tsplink.node)

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

state `property` ¶

state: str

Access the tsplink.state attribute.

Description

This attribute describes the TSP-Link online state. This command is not available on the 2604B, 2614B, or 2634B.

Usage

Accessing this property will send the print(tsplink.state) query.

TSP Syntax

- print(tsplink.state)

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

trigger `property` ¶

trigger: dict[int, TsplinkTriggerItem]

Return the tsplink.trigger[N] command tree.

Info

N, the trigger line (1 to 3).

Constants

.EVENT_ID: The number that is used for the trigger events.

Sub-properties and sub-methods

.assert(): The tsplink.trigger[N].assert() function.
.clear(): The tsplink.trigger[N].clear() function.
.mode: The tsplink.trigger[N].mode attribute.
.overrun: The tsplink.trigger[N].overrun attribute.
.pulsewidth: The tsplink.trigger[N].pulsewidth attribute.
.release(): The tsplink.trigger[N].release() function.
.reset(): The tsplink.trigger[N].reset() function.
.stimulus: The tsplink.trigger[N].stimulus attribute.
.wait(): The tsplink.trigger[N].wait() function.

writeprotect `property` `writable` ¶

writeprotect: str

Access the tsplink.writeprotect attribute.

Description

This attribute contains the write-protect mask that protects bits from changes by the tsplink.writebit() and tsplink.writeport() functions. This command is not available on the 2604B, 2614B, or 2634B.

Usage

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

TSP Syntax

- tsplink.writeprotect = value
- print(tsplink.writeprotect)

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

readbit ¶

readbit(n: int) -> str

Run the tsplink.readbit() function.

Description

This function reads the state of a TSP-Link synchronization line. This command is not available on the 2604B, 2614B, or 2634B.

TSP Syntax

- tsplink.readbit()

Parameters:	`n` (`int`) – The trigger line (1 to 3).

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

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

readport ¶

readport() -> str

Run the tsplink.readport() function.

Description

This function reads the TSP-Link trigger lines as a digital I/O port. This command is not available on the 2604B, 2614B, or 2634B.

TSP Syntax

- tsplink.readport()

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

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

reset ¶

reset(expected_nodes: int | None = None) -> str

Run the tsplink.reset() function.

Description

This function initializes (resets) all nodes (instruments) in the TSP-Link system. This command is not available on the 2604B, 2614B, or 2634B.

TSP Syntax

- tsplink.reset()

Parameters:	`expected_nodes` (`optional`, default: `None` ) – The number of nodes expected on the system (1 to 64).

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

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

writebit ¶

writebit(n: int, data: int) -> None

Run the tsplink.writebit() function.

Description

This function sets a TSP-Link trigger line high or low. This command is not available on the 2604B, 2614B, or 2634B.

TSP Syntax

- tsplink.writebit()

Parameters:	`n` (`int`) – The trigger line (1 to 3). `data` (`int`) – The value to write to the bit.

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

writeport ¶

writeport(data: int) -> None

Run the tsplink.writeport() function.

Description

This function writes to all TSP-Link synchronization lines. This command is not available on the 2604B, 2614B, or 2634B.

TSP Syntax

- tsplink.writeport()

Parameters:	`data` (`int`) – Value to write to the port (0 to 7).

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

TsplinkTriggerItem ¶

Bases: ValidatedDynamicNumberCmd, BaseTSPCmd

The tsplink.trigger[N] command tree.

Info

N, the trigger line (1 to 3).

Constants

.EVENT_ID: The number that is used for the trigger events.

Properties and methods

.assert(): The tsplink.trigger[N].assert() function.
.clear(): The tsplink.trigger[N].clear() function.
.mode: The tsplink.trigger[N].mode attribute.
.overrun: The tsplink.trigger[N].overrun attribute.
.pulsewidth: The tsplink.trigger[N].pulsewidth attribute.
.release(): The tsplink.trigger[N].release() function.
.reset(): The tsplink.trigger[N].reset() function.
.stimulus: The tsplink.trigger[N].stimulus attribute.
.wait(): The tsplink.trigger[N].wait() function.

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

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

mode `property` `writable` ¶

mode: str

Access the tsplink.trigger[N].mode attribute.

Description

This attribute defines the trigger operation and detection mode. This command is not available on the 2604B, 2614B, or 2634B.

Usage

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

TSP Syntax

- tsplink.trigger[N].mode = value
- print(tsplink.trigger[N].mode)

Info

N, the trigger line (1 to 3).

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

overrun `property` ¶

overrun: str

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

Description

This attribute indicates if the event detector ignored an event while in the detected state. This command is not available on the 2604B, 2614B, or 2634B.

Usage

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

TSP Syntax

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

Info

N, the trigger line (1 to 3).

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

pulsewidth `property` `writable` ¶

pulsewidth: str

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

Description

This attribute sets the length of time that the trigger line is asserted for output triggers. This command is not available on the 2604B, 2614B, or 2634B.

Usage

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

TSP Syntax

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

Info

width, the pulse width (in seconds).
N, the trigger line (1 to 3).

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

stimulus `property` `writable` ¶

stimulus: str

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

Description

This attribute specifies the event that causes the synchronization line to assert a trigger. This command is not available on the 2604B, 2614B, or 2634B.

Usage

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

TSP Syntax

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

Info

N, the trigger line (1 to 3).

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

assert_ ¶

assert_() -> None

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

Description

This function simulates the occurrence of the trigger and generates the corresponding event ID. This command is not available on the 2604B, 2614B, or 2634B.

TSP Syntax

- tsplink.trigger[N].assert()

Info

N, the trigger line (1 to 3).

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

clear ¶

clear() -> None

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

Description

This function clears the event detector for a LAN trigger. This command is not available on the 2604B, 2614B, or 2634B.

TSP Syntax

- tsplink.trigger[N].clear()

Info

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

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

release ¶

release() -> None

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

Description

This function releases a latched trigger on the given TSP-Link trigger line. This command is not available on the 2604B, 2614B, or 2634B.

TSP Syntax

- tsplink.trigger[N].release()

Info

N, the trigger line (1 to 3).

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

reset ¶

reset() -> None

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

Description

This function resets some of the TSP-Link trigger attributes to their factory defaults. This command is not available on the 2604B, 2614B, or 2634B.

TSP Syntax

- tsplink.trigger[N].reset()

Info

N, the trigger line (1 to 3).

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

wait ¶

wait(timeout: float) -> str

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

Description

This function waits for a trigger. This command is not available on the 2604B, 2614B, or 2634B.

TSP Syntax

- tsplink.trigger[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.

tsplink ¶

Tsplink ¶

TRIG_BYPASS class-attribute instance-attribute ¶

TRIG_EITHER class-attribute instance-attribute ¶

TRIG_FALLING class-attribute instance-attribute ¶

TRIG_RISING class-attribute instance-attribute ¶

TRIG_RISINGA class-attribute instance-attribute ¶

TRIG_RISINGM class-attribute instance-attribute ¶

TRIG_SYNCHRONOUS class-attribute instance-attribute ¶

TRIG_SYNCHRONOUSA class-attribute instance-attribute ¶

TRIG_SYNCHRONOUSM class-attribute instance-attribute ¶

group property writable ¶

master property ¶

node property writable ¶

state property ¶

trigger property ¶

writeprotect property writable ¶

readbit ¶

readport ¶

reset ¶

writebit ¶

writeport ¶

TsplinkTriggerItem ¶

EVENT_ID class-attribute instance-attribute ¶

mode property writable ¶

overrun property ¶

pulsewidth property writable ¶

stimulus property writable ¶

assert_ ¶

clear ¶

release ¶

reset ¶

wait ¶

TRIG_BYPASS `class-attribute` `instance-attribute` ¶

TRIG_EITHER `class-attribute` `instance-attribute` ¶

TRIG_FALLING `class-attribute` `instance-attribute` ¶

TRIG_RISING `class-attribute` `instance-attribute` ¶

TRIG_RISINGA `class-attribute` `instance-attribute` ¶

TRIG_RISINGM `class-attribute` `instance-attribute` ¶

TRIG_SYNCHRONOUS `class-attribute` `instance-attribute` ¶

TRIG_SYNCHRONOUSA `class-attribute` `instance-attribute` ¶

TRIG_SYNCHRONOUSM `class-attribute` `instance-attribute` ¶

group `property` `writable` ¶

master `property` ¶

node `property` `writable` ¶

state `property` ¶

trigger `property` ¶

writeprotect `property` `writable` ¶

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

mode `property` `writable` ¶

overrun `property` ¶

pulsewidth `property` `writable` ¶

stimulus `property` `writable` ¶