[python source code]

channel

The channel commands module.

These commands are used in the following models: DMM6500

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

Please report an issue if one is found.

Attributes and Functions 
- channel.close()
- channel.getclose()
- channel.getcount()
- channel.getdelay()
- channel.getdmm()
- channel.getlabel()
- channel.getstate()
- channel.gettype()
- channel.multiple.close()
- channel.multiple.open()
- channel.open()
- channel.setdelay()
- channel.setdmm()
- channel.setlabel()

Channel

Bases: BaseTSPCmd

The channel command tree.

Properties and methods
  • .close(): The channel.close() function.
  • .getclose(): The channel.getclose() function.
  • .getcount(): The channel.getcount() function.
  • .getdelay(): The channel.getdelay() function.
  • .getdmm(): The channel.getdmm() function.
  • .getlabel(): The channel.getlabel() function.
  • .getstate(): The channel.getstate() function.
  • .gettype(): The channel.gettype() function.
  • .multiple: The channel.multiple command tree.
  • .open(): The channel.open() function.
  • .setdelay(): The channel.setdelay() function.
  • .setdmm(): The channel.setdmm() function.
  • .setlabel(): The channel.setlabel() function.

multiple property 

multiple: ChannelMultiple

Return the channel.multiple command tree.

Sub-properties and sub-methods
  • .close(): The channel.multiple.close() function.
  • .open(): The channel.multiple.open() function.

close 

close(channel_list: str) -> None

Run the channel.close() function.

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

    A string that lists the channels and channel pairs to close.
Raises:

getclose 

getclose(channel_list: str | None = None) -> 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 (optional, default: None ) –

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

    The result of the function call.
Raises:

getcount 

getcount(channel_list: str | None = None) -> 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 (optional, default: None ) –

    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; slot1, slot2, or allslots allowed.
Returns:
  • str –

    The result of the function call.
Raises:

getdmm 

getdmm(channel_list: str, setting: str) -> str

Run the channel.getdmm() function.

Description
  • This function returns the setting for a channel DMM attribute.
TSP Syntax 
- channel.getdmm()
Parameters:
  • channel_list (str) –

    List of channels to get from the DMM.

  • setting (str) –

    The DMM function or the parameter values to return for the selected channels.
Returns:
  • str –

    The result of the function call.
Raises:

getlabel 

getlabel(channel_number: str) -> str

Run the channel.getlabel() function.

Description
  • This function returns the label associated with the specified channel.
TSP Syntax 
- channel.getlabel()
Parameters:
  • channel_number (str) –

    A string that lists the channel to query for the associated label.
Returns:
  • str –

    The result of the function call.
Raises:

getstate 

getstate(channel_list: 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 (optional, default: None ) –

    String specifying the channels to query; use normal channel list syntax; if no channels are defined, all slots are returnedall channels are returned.
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 command opens the specified channels and channel pairs.
TSP Syntax 
- channel.open()
Parameters:
  • channel_list (str) –

    String listing the channels to open; allslots, slot1, and slot2 available, which open all channels on all slots, all channels on slot 1, or all channels on slot 2allslots and slot1 are available; both open all channels.
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:

setdmm 

setdmm(channel_list: str, setting: str, value: str) -> None

Run the channel.setdmm() function.

Description
  • This function configures the DMM for a channel or group of channels.
TSP Syntax 
- channel.setdmm()
Parameters:
  • channel_list (str) –

    List of channels for which to set the DMM.

  • setting (str) –

    The DMM function or the parameter for the function to be applied to the channelList; refer to Details and the tables following the examples.

  • value (str) –

    The function or attribute value.
Raises:

setlabel 

setlabel(channel_number: 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_number (str) –

    A string that lists the channel for which to set the label.

  • labelname (str) –

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

ChannelMultiple

Bases: BaseTSPCmd

The channel.multiple command tree.

Properties and methods
  • .close(): The channel.multiple.close() function.
  • .open(): The channel.multiple.open() function.

close 

close(channel_list: str) -> None

Run the channel.multiple.close() function.

Description
  • This function closes the listed channels without affecting any other channels.
TSP Syntax 
- channel.multiple.close()
Parameters:
  • channel_list (str) –

    The list of channels to close.
Raises:

open 

open(channel_list: str) -> None

Run the channel.multiple.open() function.

Description
  • This function opens the channels in the channel list without affecting any others.
TSP Syntax 
- channel.multiple.open()
Parameters:
  • channel_list (str) –

    A list of the channels to open.
Raises: