Define

SCPI Commands

ROUTe:PATH:DEFine
class Define[source]

Define commands group definition. 1 total commands, 0 Sub-groups, 1 group commands

List

alias of List

get(path_name: str) str[source]
# SCPI: ROUTe:PATH[:DEFine]
value: str = driver.route.path.define.get(path_name = '1')

method RsOsp.Route.Path.Define.set or method RsOsp.Route.Path.Define.set defines a path name and the channel-list string that can be replaced by this path name. A short path name can thus represent a long list of specific states of relays and I/O channels. Use method RsOsp.Route.Close.set to switch a path. The query returns the channel list that encodes the defined states for all relays and I/O channels in this path. Note that in ‘Compatibility Mode’, the query returns a string with syntax that differs from the channel list (see query example below) .

param path_name

String parameter to specify the name of the path to be defined or queried. Limited to a maximum of 35 characters. Write the path name in quotation marks. The firmware observes capitalization of the path name. For example, ‘path a’ in lower case is not the same as ‘Path A’ in upper and lower case. A newly defined path name only exists in the instruments internal volatile memory (RAM) . At shutdown, all path definitions are saved permanently in the instrument’s flash memory At startup, all saved path definitions are restored automatically. All new path definitions, which you made since the last startup, are lost, if you switch off the device by the rear on/off switch. The same holds true, if you switch off the device by pushing the front PWR key for more than 10 seconds, or if the firmware crashes. You can trigger immediate storing of all defined path names in the instrument’s flash memory by using the command method RsOsp.Route.Path.export.

return

channel_list: List of relays and I/O channels and their states to be set, as described in method RsOsp.Route.Close.set.

set(path_name: str, channel_list: str) None[source]
# SCPI: ROUTe:PATH[:DEFine]
driver.route.path.define.set(path_name = '1', channel_list = r1)

method RsOsp.Route.Path.Define.set or method RsOsp.Route.Path.Define.set defines a path name and the channel-list string that can be replaced by this path name. A short path name can thus represent a long list of specific states of relays and I/O channels. Use method RsOsp.Route.Close.set to switch a path. The query returns the channel list that encodes the defined states for all relays and I/O channels in this path. Note that in ‘Compatibility Mode’, the query returns a string with syntax that differs from the channel list (see query example below) .

param path_name

String parameter to specify the name of the path to be defined or queried. Limited to a maximum of 35 characters. Write the path name in quotation marks. The firmware observes capitalization of the path name. For example, ‘path a’ in lower case is not the same as ‘Path A’ in upper and lower case. A newly defined path name only exists in the instruments internal volatile memory (RAM) . At shutdown, all path definitions are saved permanently in the instrument’s flash memory At startup, all saved path definitions are restored automatically. All new path definitions, which you made since the last startup, are lost, if you switch off the device by the rear on/off switch. The same holds true, if you switch off the device by pushing the front PWR key for more than 10 seconds, or if the firmware crashes. You can trigger immediate storing of all defined path names in the instrument’s flash memory by using the command method RsOsp.Route.Path.export.

param channel_list

List of relays and I/O channels and their states to be set, as described in method RsOsp.Route.Close.set.

set_multiple_channels(path_name: str, channels: List[str]) None[source]

ROUTe:PATH[:DEFine]

Same as set_single_channel(), but for multiple channels

Parameters
  • path_name – String parameter to specify the name of the path to be defined

  • channels – example value (without quotes): [‘F01M01(0301)’, ‘F02M03(0101)’]

set_single_channel(path_name: str, channel: str) None[source]

ROUTe:PATH[:DEFine]

Same as set(), but you do not need to enter round brackets or the ‘@’ character.

Parameters
  • path_name – String parameter to specify the name of the path to be defined

  • channel – example value (without quotes): ‘F02M03(0101)’