[python source code]

channel

The channel 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 
- channel.calibration.adjustcount()
- channel.calibration.adjustdate()
- channel.calibration.lock()
- channel.calibration.password()
- channel.calibration.save()
- channel.calibration.step()
- channel.calibration.unlock()
- channel.calibration.verifydate()
- channel.clearforbidden()
- channel.close()
- channel.connectrule
- channel.connectsequential
- channel.exclusiveclose()
- channel.exclusiveslotclose()
- channel.getbackplane()
- channel.getclose()
- channel.getcount()
- channel.getdelay()
- channel.getforbidden()
- channel.getimage()
- channel.getlabel()
- channel.getmatch()
- channel.getmatchtype()
- channel.getmode()
- channel.getoutputenable()
- channel.getpole()
- channel.getpowerstate()
- channel.getstate()
- channel.getstatelatch()
- channel.gettype()
- channel.open()
- channel.pattern.delete()
- channel.pattern.getimage()
- channel.pattern.setimage()
- channel.pattern.snapshot()
- channel.read()
- channel.reset()
- channel.resetstatelatch()
- channel.setbackplane()
- channel.setdelay()
- channel.setforbidden()
- channel.setlabel()
- channel.setmatch()
- channel.setmatchtype()
- channel.setmode()
- channel.setoutputenable()
- channel.setpole()
- channel.setstatelatch()
- channel.trigger[N].clear()
- channel.trigger[N].get()
- channel.trigger[N].set()
- channel.trigger[N].wait()
- channel.write()

Channel

Bases: BaseTSPCmd

The channel command tree.

Properties and methods
  • .calibration: The channel.calibration command tree.
  • .clearforbidden(): The channel.clearforbidden() function.
  • .close(): The channel.close() function.
  • .connectrule: The channel.connectrule attribute.
  • .connectsequential: The channel.connectsequential attribute.
  • .exclusiveclose(): The channel.exclusiveclose() function.
  • .exclusiveslotclose(): The channel.exclusiveslotclose() function.
  • .getbackplane(): The channel.getbackplane() function.
  • .getclose(): The channel.getclose() function.
  • .getcount(): The channel.getcount() function.
  • .getdelay(): The channel.getdelay() function.
  • .getforbidden(): The channel.getforbidden() function.
  • .getimage(): The channel.getimage() function.
  • .getlabel(): The channel.getlabel() function.
  • .getmatch(): The channel.getmatch() function.
  • .getmatchtype(): The channel.getmatchtype() function.
  • .getmode(): The channel.getmode() function.
  • .getoutputenable(): The channel.getoutputenable() function.
  • .getpole(): The channel.getpole() function.
  • .getpowerstate(): The channel.getpowerstate() function.
  • .getstate(): The channel.getstate() function.
  • .getstatelatch(): The channel.getstatelatch() function.
  • .gettype(): The channel.gettype() function.
  • .open(): The channel.open() function.
  • .pattern: The channel.pattern command tree.
  • .read(): The channel.read() function.
  • .reset(): The channel.reset() function.
  • .resetstatelatch(): The channel.resetstatelatch() function.
  • .setbackplane(): The channel.setbackplane() function.
  • .setdelay(): The channel.setdelay() function.
  • .setforbidden(): The channel.setforbidden() function.
  • .setlabel(): The channel.setlabel() function.
  • .setmatch(): The channel.setmatch() function.
  • .setmatchtype(): The channel.setmatchtype() function.
  • .setmode(): The channel.setmode() function.
  • .setoutputenable(): The channel.setoutputenable() function.
  • .setpole(): The channel.setpole() function.
  • .setstatelatch(): The channel.setstatelatch() function.
  • .trigger: The channel.trigger[N] command tree.
  • .write(): The channel.write() function.

calibration property 

calibration: ChannelCalibration

Return the channel.calibration command tree.

Sub-properties and sub-methods
  • .adjustcount(): The channel.calibration.adjustcount() function.
  • .adjustdate(): The channel.calibration.adjustdate() function.
  • .lock(): The channel.calibration.lock() function.
  • .password(): The channel.calibration.password() function.
  • .save(): The channel.calibration.save() function.
  • .step(): The channel.calibration.step() function.
  • .unlock(): The channel.calibration.unlock() function.
  • .verifydate(): The channel.calibration.verifydate() function.

connectrule property writable 

connectrule: str

Access the channel.connectrule attribute.

Description
  • This attribute controls the connection rule for closing and opening channels in the instrument.
Usage
  • Accessing this property will send the print(channel.connectrule) query.
  • Setting this property to a value will send the channel.connectrule = value command.
TSP Syntax 
- channel.connectrule = value
- print(channel.connectrule)
Raises:

connectsequential property writable 

connectsequential: str

Access the channel.connectsequential attribute.

Description
  • This attribute controls whether or not channels are closed sequentially.
Usage
  • Accessing this property will send the print(channel.connectsequential) query.
  • Setting this property to a value will send the channel.connectsequential = value command.
TSP Syntax 
- channel.connectsequential = value
- print(channel.connectsequential)
Raises:

pattern property 

pattern: ChannelPattern

Return the channel.pattern command tree.

Sub-properties and sub-methods
  • .delete(): The channel.pattern.delete() function.
  • .getimage(): The channel.pattern.getimage() function.
  • .setimage(): The channel.pattern.setimage() function.
  • .snapshot(): The channel.pattern.snapshot() function.

trigger property 

trigger: dict[int, ChannelTriggerItem]

Return the channel.trigger[N] command tree.

Info
  • N, the number indicating the channel trigger event ID (1 to 8).
Constants
  • .EVENT_ID: This constant indicates the trigger event generated by the channel trigger N.
Sub-properties and sub-methods
  • .clear(): The channel.trigger[N].clear() function.
  • .get(): The channel.trigger[N].get() function.
  • .set(): The channel.trigger[N].set() function.
  • .wait(): The channel.trigger[N].wait() function.

clearforbidden 

clearforbidden(channel_list: str) -> None

Run the channel.clearforbidden() function.

Description
  • This function clears the list of channels specified from being forbidden to close.
TSP Syntax 
- channel.clearforbidden()
Parameters:
  • channel_list (str) –

    The channels to set, using standard channel naming.
Raises:

close 

close(channel_list: str) -> None

Run the channel.close() function.

Description
  • This function closes the channels, analog backplane relays, and channel patterns that are specified by the channel list parameter.
TSP Syntax 
- channel.close()
Parameters:
  • channel_list (str) –

    The channels, analog backplane relays, and channel patterns to close, using standard channel naming.
Raises:

exclusiveclose 

exclusiveclose(channel_list: str) -> None

Run the channel.exclusiveclose() function.

Description
  • This function closes the specified channels so that they are the only channels that are closed on the instrument.
TSP Syntax 
- channel.exclusiveclose()
Parameters:
  • channel_list (str) –

    A string listing the channels (including analog backplane relays) and channel patterns to exclusively close.
Raises:

exclusiveslotclose 

exclusiveslotclose(channel_list: str) -> None

Run the channel.exclusiveslotclose() function.

Description
  • This function closes the specified channels and channel patterns on the associated slots and opens any channels that are not specified.
TSP Syntax 
- channel.exclusiveslotclose()
Parameters:
  • channel_list (str) –

    A string that lists the channels and channel patterns to exclusively close on the cards in associated slots (you can specify analog backplane relays).
Raises:

getbackplane 

getbackplane(channel_list: str) -> str

Run the channel.getbackplane() function.

Description
  • This function returns a string that lists the analog backplane relays that are controlled when the specified channels are used with switching operations.
TSP Syntax 
- channel.getbackplane()
Parameters:
  • channel_list (str) –

    A string listing the channels being queried.
Returns:
  • str –

    The result of the function call.
Raises:

getclose 

getclose(channel_list: str) -> str

Run the channel.getclose() function.

Description
  • This function queries for the closed channels indicated by the channel list parameter.
TSP Syntax 
- channel.getclose()
Parameters:
  • channel_list (str) –

    A string representing the channels, channel patterns, and backplane relays that will be queried.
Returns:
  • str –

    The result of the function call.
Raises:

getcount 

getcount(channel_list: str) -> str

Run the channel.getcount() function.

Description
  • This function returns the number of times the relays have been closed for the specified channels.
TSP Syntax 
- channel.getcount()
Parameters:
  • channel_list (str) –

    A string listing the items to query, which can include.
Returns:
  • str –

    The result of the function call.
Raises:

getdelay 

getdelay(channel_list: str) -> str

Run the channel.getdelay() function.

Description
  • This function queries for the additional delay time for the specified channels.
TSP Syntax 
- channel.getdelay()
Parameters:
  • channel_list (str) –

    A string listing the channels to query for their delay times.
Returns:
  • str –

    The result of the function call.
Raises:

getforbidden 

getforbidden(channel_list: str) -> str

Run the channel.getforbidden() function.

Description
  • This function returns a string listing the channels and analog backplane relays in the channel list that are forbidden to close.
TSP Syntax 
- channel.getforbidden()
Parameters:
  • channel_list (str) –

    A string listing the channels, backplane relays, and channel patterns that are to be checked to see if they are forbidden to close.
Returns:
  • str –

    The result of the function call.
Raises:

getimage 

getimage(channel_list: str) -> str

Run the channel.getimage() function.

Description
  • This function queries a channel for items associated with that channel when used in a switching operation.
TSP Syntax 
- channel.getimage()
Parameters:
  • channel_list (str) –

    A string representing the channels and analog backplane relays to query.
Returns:
  • str –

    The result of the function call.
Raises:

getlabel 

getlabel(channel_list: str) -> str

Run the channel.getlabel() function.

Description
  • This function retrieves the label associated with one or more channels.
TSP Syntax 
- channel.getlabel()
Parameters:
  • channel_list (str) –

    A string listing the channels to query for the label associated with them.
Returns:
  • str –

    The result of the function call.
Raises:

getmatch 

getmatch(channel_list: str) -> str

Run the channel.getmatch() function.

Description
  • This function gets the match value on a channel.
TSP Syntax 
- channel.getmatch()
Parameters:
  • channel_list (str) –

    String specifying digital I/O or totalizer channels to query, using normal channel list syntax.
Returns:
  • str –

    The result of the function call.
Raises:

getmatchtype 

getmatchtype(channel_list: str) -> str

Run the channel.getmatchtype() function.

Description
  • This function returns the match type for digital I/O and totalizer channels.
TSP Syntax 
- channel.getmatchtype()
Parameters:
  • channel_list (str) –

    String specifying the digital I/O or totalizer channels to query, using normal channel list syntax.
Returns:
  • str –

    The result of the function call.
Raises:

getmode 

getmode(channel_list: str) -> str

Run the channel.getmode() function.

Description
  • This function returns the present mode of digital and totalizer channels.
TSP Syntax 
- channel.getmode()
Parameters:
  • channel_list (str) –

    String that specifies the channels to query, using normal channel list syntax.
Returns:
  • str –

    The result of the function call.
Raises:

getoutputenable 

getoutputenable(channel_list: str) -> str

Run the channel.getoutputenable() function.

Description
  • This function gets the present output enable attribute for a channel.
TSP Syntax 
- channel.getoutputenable()
Parameters:
  • channel_list (str) –

    String specifying the DAC channels to query, using normal channel list syntax.
Returns:
  • str –

    The result of the function call.
Raises:

getpole 

getpole(channel_list: str) -> str

Run the channel.getpole() function.

Description
  • This function queries the pole settings for the specified channels.
TSP Syntax 
- channel.getpole()
Parameters:
  • channel_list (str) –

    A string listing the channels to query for their pole settings.
Returns:
  • str –

    The result of the function call.
Raises:

getpowerstate 

getpowerstate(channel_list: str) -> str

Run the channel.getpowerstate() function.

Description
  • This function gets the current power state attribute for a totalizer or DAC channel.
TSP Syntax 
- channel.getpowerstate()
Parameters:
  • channel_list (str) –

    String specifying the channels to query, using normal channel list syntax.
Returns:
  • str –

    The result of the function call.
Raises:

getstate 

getstate(channel_list: str, indicator_mask: str | None = None) -> str

Run the channel.getstate() function.

Description
  • This function returns the state indicators of the channels in the instrument.
TSP Syntax 
- channel.getstate()
Parameters:
  • channel_list (str) –

    String specifying the channels to query, using normal channel list syntax.

  • indicator_mask (optional, default: None ) –

    Value to specify only certain indicators; if omitted, all indicators are returned.
Returns:
  • str –

    The result of the function call.
Raises:

getstatelatch 

getstatelatch(channel_list: str) -> str

Run the channel.getstatelatch() function.

Description
  • This function gets the mask representing the states that would be latched if they occurred.
TSP Syntax 
- channel.getstatelatch()
Parameters:
  • channel_list (str) –

    String specifying the channels to query, using normal channel list syntax.
Returns:
  • str –

    The result of the function call.
Raises:

gettype 

gettype(channel_list: str) -> str

Run the channel.gettype() function.

Description
  • This function returns the type associated with a channel.
TSP Syntax 
- channel.gettype()
Parameters:
  • channel_list (str) –

    String specifying the channels to query, using normal channelList syntax.
Returns:
  • str –

    The result of the function call.
Raises:

open 

open(channel_list: str) -> None

Run the channel.open() function.

Description
  • This function opens the specified channels, analog backplane relays, and channel patterns.
TSP Syntax 
- channel.open()
Parameters:
  • channel_list (str) –

    String listing the channels, analog backplane relays, and channel patterns to open.
Raises:

read 

read(channel_list: str, width: str | None = None, reading_buffer: str | None = None) -> str

Run the channel.read() function.

Description
  • This function reads a value from a totalizer, DAC, or digital I/O channel.
TSP Syntax 
- channel.read()
Parameters:
  • channel_list (str) –

    The channels to set, using standard channel naming.

  • width (optional, default: None ) –

    Specifies reading over multiple consecutive channels (default 1).

  • reading_buffer (optional, default: None ) –

    Reading buffer to store read values.
Returns:
  • str –

    The result of the function call.
Raises:

reset 

reset(channel_list: str) -> None

Run the channel.reset() function.

Description
  • This function resets the specified channel list items to factory default settings.
TSP Syntax 
- channel.reset()
Parameters:
  • channel_list (str) –

    A string that lists the items to reset; the string can include.
Raises:

resetstatelatch 

resetstatelatch(channel_list: str, state: str) -> None

Run the channel.resetstatelatch() function.

Description
  • This function resets the channel state.
TSP Syntax 
- channel.resetstatelatch()
Parameters:
  • channel_list (str) –

    String that specifies the channels that need to have their states reset, using normal channel list syntax.

  • state (str) –

    The comma-delimited states for channels in channelList that are to have their states reset.
Raises:

setbackplane 

setbackplane(channel_list: str, abuslist: str) -> None

Run the channel.setbackplane() function.

Description
  • This function specifies the list of analog backplane relays to use with the specified channels when they are used in switching applications.
TSP Syntax 
- channel.setbackplane()
Parameters:
  • channel_list (str) –

    A string that lists the channels to change.

  • abuslist (str) –

    A string that lists the analog backplane relays to set for the channels specified in channelList.
Raises:

setdelay 

setdelay(channel_list: str, delay: float) -> None

Run the channel.setdelay() function.

Description
  • This function sets additional delay time for specified channels.
TSP Syntax 
- channel.setdelay()
Parameters:
  • channel_list (str) –

    A string listing the channels for which to add delay time.

  • delay (float) –

    Delay time for the selected channels; minimum is 0 seconds.
Raises:

setforbidden 

setforbidden(channel_list: str) -> None

Run the channel.setforbidden() function.

Description
  • This function prevents the closing of specified channels and analog backplane relays.
TSP Syntax 
- channel.setforbidden()
Parameters:
  • channel_list (str) –

    A string that lists the channels and analog backplane relays to make forbidden to close.
Raises:

setlabel 

setlabel(channel_list: str, labelname: str) -> None

Run the channel.setlabel() function.

Description
  • This function sets the label associated with a channel.
TSP Syntax 
- channel.setlabel()
Parameters:
  • channel_list (str) –

    A string that lists the channel to which to set the label; the string cannot contain spaces.

  • labelname (str) –

    A string that contains the label for the channel in channelList, up to 19 characters.
Raises:

setmatch 

setmatch(
    channel_list: str, match_value: str, mask: str | None = None, width: str | None = None
) -> None

Run the channel.setmatch() function.

Description
  • This function sets the match value on a digital input or totalizer channel.
TSP Syntax 
- channel.setmatch()
Parameters:
  • channel_list (str) –

    String that specifies the channels to query, using normal channel list syntax.

  • match_value (str) –

    Channel value to compare on the specified channel.

  • mask (optional, default: None ) –

    Value to specify the bits used to mask matchValue.

  • width (optional, default: None ) –

    Value that specifies matches over multiple consecutive channels (default 1).
Raises:

setmatchtype 

setmatchtype(channel_list: str, type_: str) -> None

Run the channel.setmatchtype() function.

Description
  • This function sets the match type on a channel.
TSP Syntax 
- channel.setmatchtype()
Parameters:
  • channel_list (str) –

    String specifying the channels to set, using normal channel list syntax.

  • type_ (str) –

    A value for setting the match operation used on this specific channel.
Raises:

setmode 

setmode(channel_list: str, mode: str) -> None

Run the channel.setmode() function.

Description
  • This function sets the mode of operation of a channel.
TSP Syntax 
- channel.setmode()
Parameters:
  • channel_list (str) –

    String specifying the channels to set, using normal channel list syntax.

  • mode (str) –

    The value that sets the mode of operation for a channel; see Details.
Raises:

setoutputenable 

setoutputenable(channel_list: str, state: str) -> None

Run the channel.setoutputenable() function.

Description
  • This function sets the output enable attribute on a channel.
TSP Syntax 
- channel.setoutputenable()
Parameters:
  • channel_list (str) –

    String specifying the channels to set, using normal channel list syntax.

  • state (str) –

    A value representing the state of the output of the channel.
Raises:

setpole 

setpole(channel_list: str, value: str) -> None

Run the channel.setpole() function.

Description
  • This function specifies the pole setting for a list of channels.
TSP Syntax 
- channel.setpole()
Parameters:
  • channel_list (str) –

    String specifying the channels to set, using normal channel list syntax.

  • value (str) –

    Pole setting for the channels in channelList. Use the following.
Raises:

setstatelatch 

setstatelatch(channel_list: str, state_latch_mask: str) -> None

Run the channel.setstatelatch() function.

Description
  • This function sets the state indicators to either latching or nonlatching.
TSP Syntax 
- channel.setstatelatch()
Parameters:
  • channel_list (str) –

    The channels to set, using standard channel naming.

  • state_latch_mask (str) –

    A value specifying the indicators to latch.
Raises:

write 

write(channel_list: str, value: str, width: str | None = None) -> None

Run the channel.write() function.

Description
  • This function writes a value to a channel.
TSP Syntax 
- channel.write()
Parameters:
  • channel_list (str) –

    The channels to set, using standard channel naming.

  • value (str) –

    The value to be written to the channel (must be decimal value).

  • width (optional, default: None ) –

    Value that specifies the channel width of the write.
Raises:

ChannelCalibration

Bases: BaseTSPCmd

The channel.calibration command tree.

Properties and methods
  • .adjustcount(): The channel.calibration.adjustcount() function.
  • .adjustdate(): The channel.calibration.adjustdate() function.
  • .lock(): The channel.calibration.lock() function.
  • .password(): The channel.calibration.password() function.
  • .save(): The channel.calibration.save() function.
  • .step(): The channel.calibration.step() function.
  • .unlock(): The channel.calibration.unlock() function.
  • .verifydate(): The channel.calibration.verifydate() function.

adjustcount 

adjustcount(x: str) -> str

Run the channel.calibration.adjustcount() function.

Description
  • This function gets the number of times that a card has been adjusted.
TSP Syntax 
- channel.calibration.adjustcount()
Parameters:
  • x (str) –

    The slot number ( 1 to 6).
Returns:
  • str –

    The result of the function call.
Raises:

adjustdate 

adjustdate(x: str, date: str | None = None) -> str

Run the channel.calibration.adjustdate() function.

Description
  • This function sets or gets the adjustment date in UTC format (number of seconds since January 1, 1970) on the unlocked channel.
TSP Syntax 
- channel.calibration.adjustdate()
Parameters:
  • x (str) –

    The slot number ( 1 to 6).

  • date (optional, default: None ) –

    The date of the adjustment (UTC formatted).
Returns:
  • str –

    The result of the function call.
Raises:

lock 

lock() -> None

Run the channel.calibration.lock() function.

Description
  • This function prevents further calibration on the currently unlocked card.
TSP Syntax 
- channel.calibration.lock()
Raises:

password 

password(password: str) -> None

Run the channel.calibration.password() function.

Description
  • This function sets the password needed to unlock the calibration functionality of a card.
TSP Syntax 
- channel.calibration.password()
Parameters:
  • password (str) –

    A string of characters that contain the password.
Raises:

save 

save() -> None

Run the channel.calibration.save() function.

Description
  • This function saves the calibration data to the card.
TSP Syntax 
- channel.calibration.save()
Raises:

step 

step(channel: str, step: str, value: str | None = None) -> None

Run the channel.calibration.step() function.

Description
  • This function sends a calibration command.
TSP Syntax 
- channel.calibration.step()
Parameters:
  • channel (str) –

    The channel to be calibrated.

  • step (str) –

    The number corresponding to the specified step.

  • value (optional, default: None ) –

    The measured value for the specified step when the step value is even.
Raises:

unlock 

unlock(x: str, password: str) -> None

Run the channel.calibration.unlock() function.

Description
  • This function unlocks calibration functionality for a card so that calibration operations can be performed.
TSP Syntax 
- channel.calibration.unlock()
Parameters:
  • x (str) –

    The slot number ( 1 to 6).

  • password (str) –

    The password that unlocks calibration.
Raises:

verifydate 

verifydate(x: str, date: str | None = None) -> str

Run the channel.calibration.verifydate() function.

Description
  • This function gets or sets the date the calibration was verified in UTC format (number of seconds since January 1, 1970).
TSP Syntax 
- channel.calibration.verifydate()
Parameters:
  • x (str) –

    The slot number ( 1 to 6).

  • date (optional, default: None ) –

    UTC formatted date to which to set the calibration verification date.
Returns:
  • str –

    The result of the function call.
Raises:

ChannelPattern

Bases: BaseTSPCmd

The channel.pattern command tree.

Properties and methods
  • .delete(): The channel.pattern.delete() function.
  • .getimage(): The channel.pattern.getimage() function.
  • .setimage(): The channel.pattern.setimage() function.
  • .snapshot(): The channel.pattern.snapshot() function.

delete 

delete(name: str) -> None

Run the channel.pattern.delete() function.

Description
  • This function deletes a channel pattern.
TSP Syntax 
- channel.pattern.delete()
Parameters:
  • name (str) –

    A string representing the name of the channel pattern to delete.
Raises:

getimage 

getimage(name: str) -> str

Run the channel.pattern.getimage() function.

Description
  • This function queries a channel pattern for associated channels and analog backplane relays.
TSP Syntax 
- channel.pattern.getimage()
Parameters:
  • name (str) –

    A string representing the name of the channel pattern to query.
Returns:
  • str –

    The result of the function call.
Raises:

setimage 

setimage(channel_list: str, name: str) -> None

Run the channel.pattern.setimage() function.

Description
  • This function creates a channel pattern and associates it with the specified name.
TSP Syntax 
- channel.pattern.setimage()
Parameters:
  • channel_list (str) –

    A string listing the channels, channel patterns, or analog backplane relays to use when creating the new channel pattern.

  • name (str) –

    A string representing the name to associate with the new channel pattern.
Raises:

snapshot 

snapshot(name: str) -> None

Run the channel.pattern.snapshot() function.

Description
  • This function creates a channel pattern.
TSP Syntax 
- channel.pattern.snapshot()
Parameters:
  • name (str) –

    A string representing the name to associate with the present state of channels and analog backplane relays.
Raises:

ChannelTriggerItem

Bases: ValidatedDynamicNumberCmd, BaseTSPCmd

The channel.trigger[N] command tree.

Info
  • N, the number indicating the channel trigger event ID (1 to 8).
Constants
  • .EVENT_ID: This constant indicates the trigger event generated by the channel trigger N.
Properties and methods
  • .clear(): The channel.trigger[N].clear() function.
  • .get(): The channel.trigger[N].get() function.
  • .set(): The channel.trigger[N].set() function.
  • .wait(): The channel.trigger[N].wait() function.

EVENT_ID class-attribute instance-attribute 

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

clear 

clear() -> None

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

Description
  • This function clears any pending events.
TSP Syntax 
- channel.trigger[N].clear()
Info
  • N, the number indicating the trigger line to clear (1 to 8).
Raises:

get 

get() -> str

Run the channel.trigger[N].get() function.

Description
  • This function gets the channel status trigger information that is used to watch the state of a specific channel.
TSP Syntax 
- channel.trigger[N].get()
Info
  • N, the number indicating the channel trigger to get (1 to 8).
Returns:
  • str –

    The result of the function call.
Raises:

set_ 

set_(channel_list: str, state_match: str) -> None

Run the channel.trigger[N].set() function.

Description
  • This function sets the channel status trigger model to watch the state of a specific channel.
TSP Syntax 
- channel.trigger[N].set()
Parameters:
  • channel_list (str) –

    The channels to set, using standard channel naming.

  • state_match (str) –

    Value specifying the status to match when triggering an event.
Raises:

wait 

wait(timeout: float) -> str

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

Description
  • This function waits for the specified trigger or timeout period, whichever comes first.
TSP Syntax 
- channel.trigger[N].wait()
Parameters:
  • timeout (float) –

    The number of seconds to wait.
Returns:
  • str –

    The result of the function call.
Raises: