[python source code]

tsplink

The tsplink commands module.

These commands are used in the following models: SMU2450, SMU2460, SMU2461, SMU2470

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.initialize()
- tsplink.line[N].mode
- tsplink.line[N].reset()
- tsplink.line[N].state
- tsplink.master
- tsplink.node
- tsplink.readport()
- tsplink.state
- tsplink.writeport()

Bases: BaseTSPCmd

The tsplink command tree.

Constants
  • .MODE_DIGITAL_OPEN_DRAIN: TSP-Link digital open drain line.
  • .MODE_SYNCHRONOUS_ACCEPTOR: TSP-Link trigger synchronous acceptor.
  • .MODE_SYNCHRONOUS_MASTER: TSP-Link trigger synchronous master.
  • .MODE_TRIGGER_OPEN_DRAIN: TSP-Link trigger open drain line.
  • .STATE_HIGH: High state of the synchronization line.
  • .STATE_LOW: Low state of the synchronization line.
Properties and methods
  • .group: The tsplink.group attribute.
  • .initialize(): The tsplink.initialize() function.
  • .line: The tsplink.line[N] command tree.
  • .master: The tsplink.master attribute.
  • .node: The tsplink.node attribute.
  • .readport(): The tsplink.readport() function.
  • .state: The tsplink.state attribute.
  • .writeport(): The tsplink.writeport() function.

MODE_DIGITAL_OPEN_DRAIN class-attribute instance-attribute 

MODE_DIGITAL_OPEN_DRAIN = 'tsplink.MODE_DIGITAL_OPEN_DRAIN'

MODE_SYNCHRONOUS_ACCEPTOR class-attribute instance-attribute 

MODE_SYNCHRONOUS_ACCEPTOR = 'tsplink.MODE_SYNCHRONOUS_ACCEPTOR'

MODE_SYNCHRONOUS_MASTER class-attribute instance-attribute 

MODE_SYNCHRONOUS_MASTER = 'tsplink.MODE_SYNCHRONOUS_MASTER'

MODE_TRIGGER_OPEN_DRAIN class-attribute instance-attribute 

MODE_TRIGGER_OPEN_DRAIN = 'tsplink.MODE_TRIGGER_OPEN_DRAIN'

STATE_HIGH class-attribute instance-attribute 

STATE_HIGH = 'tsplink.STATE_HIGH'

STATE_LOW class-attribute instance-attribute 

STATE_LOW = 'tsplink.STATE_LOW'

group property writable 

group: str

Access the tsplink.group attribute.

Description
  • This attribute contains the group number of a TSP-Link node.
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:

line property 

line: dict[int, TsplinkLineItem]

Return the tsplink.line[N] command tree.

Info
  • N, the trigger line (1 to 3).
Sub-properties and sub-methods
  • .mode: The tsplink.line[N].mode attribute.
  • .reset(): The tsplink.line[N].reset() function.
  • .state: The tsplink.line[N].state attribute.

master property 

master: str

Access the tsplink.master attribute.

Description
  • This attribute reads the node number assigned to the master node.
Usage
  • Accessing this property will send the print(tsplink.master) query.
TSP Syntax 
- print(tsplink.master)
Raises:

node property writable 

node: str

Access the tsplink.node attribute.

Description
  • This attribute defines the node number.
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:

state property 

state: str

Access the tsplink.state attribute.

Description
  • This attribute describes the TSP-Link online state.
Usage
  • Accessing this property will send the print(tsplink.state) query.
TSP Syntax 
- print(tsplink.state)
Raises:

initialize 

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

Run the tsplink.initialize() function.

Description
  • This function initializes all instruments and enclosures in the TSP-Link system.
TSP Syntax 
- tsplink.initialize()
Parameters:
  • expected_nodes (optional, default: None ) –

    The number of nodes expected on the system (1 to 32).
Returns:
  • str –

    The result of the function call.
Raises:

readport 

readport() -> str

Run the tsplink.readport() function.

Description
  • This function reads the TSP-Link trigger lines as a digital I/O port.
TSP Syntax 
- tsplink.readport()
Returns:
  • str –

    The result of the function call.
Raises:

writeport 

writeport(data: int) -> None

Run the tsplink.writeport() function.

Description
  • This function writes to all TSP-Link synchronization lines as a digital I/O port.
TSP Syntax 
- tsplink.writeport()
Parameters:
  • data (int) –

    Value to write to the port (0 to 7).
Raises:

TsplinkLineItem

Bases: ValidatedDynamicNumberCmd, BaseTSPCmd

The tsplink.line[N] command tree.

Info
  • N, the trigger line (1 to 3).
Properties and methods
  • .mode: The tsplink.line[N].mode attribute.
  • .reset(): The tsplink.line[N].reset() function.
  • .state: The tsplink.line[N].state attribute.

mode property writable 

mode: str

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

Description
  • This attribute defines the trigger operation of a TSP-Link line.
Usage
  • Accessing this property will send the print(tsplink.line[N].mode) query.
  • Setting this property to a value will send the tsplink.line[N].mode = value command.
TSP Syntax 
- tsplink.line[N].mode = value
- print(tsplink.line[N].mode)
Info
  • N, the trigger line (1 to 3).
Raises:

state property writable 

state: str

Access the tsplink.line[N].state attribute.

Description
  • This attribute reads or writes the digital state of a TSP-Link synchronization line.
Usage
  • Accessing this property will send the print(tsplink.line[N].state) query.
  • Setting this property to a value will send the tsplink.line[N].state = value command.
TSP Syntax 
- tsplink.line[N].state = value
- print(tsplink.line[N].state)
Info
  • N, the trigger line (1 to 3).
Raises:

reset 

reset() -> None

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

Description
  • This function resets some of the TSP-Link trigger attributes to their factory defaults.
TSP Syntax 
- tsplink.line[N].reset()
Info
  • N, the trigger line (1 to 3).
Raises: