digio ¶

The digio commands module.

These commands are used in the following models: SS3706A

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

Please report an issue if one is found.

Attributes and Functions

- digio.readbit()
- digio.readport()
- digio.trigger[N].assert()
- digio.trigger[N].clear()
- digio.trigger[N].mode
- digio.trigger[N].overrun
- digio.trigger[N].pulsewidth
- digio.trigger[N].release()
- digio.trigger[N].reset()
- digio.trigger[N].stimulus
- digio.trigger[N].wait()
- digio.writebit()
- digio.writeport()
- digio.writeprotect

Digio ¶

Bases: BaseTSPCmd

The digio command tree.

Properties and methods

.readbit(): The digio.readbit() function.
.readport(): The digio.readport() function.
.trigger: The digio.trigger[N] command tree.
.writebit(): The digio.writebit() function.
.writeport(): The digio.writeport() function.
.writeprotect: The digio.writeprotect attribute.

trigger `property` ¶

trigger: dict[int, DigioTriggerItem]

Return the digio.trigger[N] command tree.

Info

N, the digital I/O trigger line (1 to 14).

Constants

.EVENT_ID: The trigger event generated by the digital I/O line N.

Sub-properties and sub-methods

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

writeprotect `property` `writable` ¶

writeprotect: str

Access the digio.writeprotect attribute.

Description

This attribute contains the write-protect mask that protects bits from changes from the digio.writebit() and digio.writeport() functions.

Usage

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

TSP Syntax

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

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

readbit ¶

readbit(n: int) -> str

Run the digio.readbit() function.

Description

This function reads one digital I/O line.

TSP Syntax

- digio.readbit()

Parameters:	`n` (`int`) – Digital I/O line number to be read (1 to 14).

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

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

readport ¶

readport() -> str

Run the digio.readport() function.

Description

This function reads the digital I/O port.

TSP Syntax

- digio.readport()

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 digio.writebit() function.

Description

This function sets a digital I/O line high or low.

TSP Syntax

- digio.writebit()

Parameters:	`n` (`int`) – Digital I/O trigger line (1 to 14). `data` (`int`) – The value to write to the bit.

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

writeport ¶

writeport(data: int) -> None

Run the digio.writeport() function.

Description

This function writes to all digital I/O lines.

TSP Syntax

- digio.writeport()

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

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

DigioTriggerItem ¶

Bases: ValidatedDynamicNumberCmd, BaseTSPCmd

The digio.trigger[N] command tree.

Info

N, the digital I/O trigger line (1 to 14).

Constants

.EVENT_ID: The trigger event generated by the digital I/O line N.

Properties and methods

.assert(): The digio.trigger[N].assert() function.
.clear(): The digio.trigger[N].clear() function.
.mode: The digio.trigger[N].mode attribute.
.overrun: The digio.trigger[N].overrun attribute.
.pulsewidth: The digio.trigger[N].pulsewidth attribute.
.release(): The digio.trigger[N].release() function.
.reset(): The digio.trigger[N].reset() function.
.stimulus: The digio.trigger[N].stimulus attribute.
.wait(): The digio.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 digio.trigger[N].mode attribute.

Description

This attribute sets the mode in which the trigger event detector and the output trigger generator operate on the given trigger line.

Usage

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

TSP Syntax

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

Info

N, the digital I/O trigger line (1 to 14).

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

overrun `property` ¶

overrun: str

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

Description

This attribute returns the event detector overrun status.

Usage

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

TSP Syntax

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

Info

N, the digital I/O trigger line (1 to 14).

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

pulsewidth `property` `writable` ¶

pulsewidth: str

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

Description

This attribute describes the length of time that the trigger line is asserted for output triggers.

Usage

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

TSP Syntax

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

Info

width, the pulse width (seconds).
N, the digital I/O trigger line (1 to 14).

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

stimulus `property` `writable` ¶

stimulus: str

Access the digio.trigger[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(digio.trigger[N].stimulus) query.
Setting this property to a value will send the digio.trigger[N].stimulus = value command.

TSP Syntax

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

Info

N, the digital I/O trigger line (1 to 14).

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

assert_ ¶

assert_() -> None

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

Description

This function asserts a trigger pulse on one of the digital I/O lines.

TSP Syntax

- digio.trigger[N].assert()

Info

N, the digital I/O trigger line (1 to 14).

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

clear ¶

clear() -> None

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

Description

This function clears the trigger event on a digital I/O line.

TSP Syntax

- digio.trigger[N].clear()

Info

N, the digital I/O trigger line (1 to 14).

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

release ¶

release() -> None

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

Description

This function releases an indefinite length or latched trigger.

TSP Syntax

- digio.trigger[N].release()

Info

N, the digital I/O trigger line (1 to 14).

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

reset ¶

reset() -> None

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

Description

This function resets trigger values to their factory defaults.

TSP Syntax

- digio.trigger[N].reset()

Info

N, the digital I/O trigger line (1 to 14).

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

wait ¶

wait(timeout: float) -> str

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

Description

This function waits for a trigger.

TSP Syntax

- digio.trigger[N].wait()

Parameters:	`timeout` (`float`) – Timeout in seconds.

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

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

digio ¶

Digio ¶

trigger property ¶

writeprotect property writable ¶

readbit ¶

readport ¶

writebit ¶

writeport ¶

DigioTriggerItem ¶

EVENT_ID class-attribute instance-attribute ¶

mode property writable ¶

overrun property ¶

pulsewidth property writable ¶

stimulus property writable ¶

assert_ ¶

clear ¶

release ¶

reset ¶

wait ¶

trigger `property` ¶

writeprotect `property` `writable` ¶

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

mode `property` `writable` ¶

overrun `property` ¶

pulsewidth `property` `writable` ¶

stimulus `property` `writable` ¶