Phase

SCPI Commands

ROUTe:PHASe

class Phase

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

get(channel_list: str) → List[int]

# SCPI: ROUTe:PHASe
value: List[int] = driver.route.phase.get(channel_list = r1)

Sets or queries the phase angle, if a phase shifter is available in the module. Also, you can control phase shifters by the standard command method RsOsp.Route.Close.set, allowing joint control of phase shifters and relays, and saving their target states in joint path definitions. Similar to method RsOsp.Route.Close.set, the parameter <channel list> uses the following syntax:

INTRO_CMD_HELP: (@FxxMyy(sssee) )

• xx = 01, 02, 03,…,99 (frame ID in, e.g., switch unit name F01)

• yy = 01, 02, 03,…,20 (module ID in, e.g., slot position M02)

• sss = 000 … n (state of the phase shifter to be controlled in a module)

• ee = 01 … m (element number of the phase shifter to be controlled)

Note that in the string ‘sss’, you can omit leading zeros.

param channel_list

Channel list string as described above, selecting a module and phase shifter and specifying the phase angle to be set. The query also requires the element number ‘ee’, but it ignores the state information ‘sss’. You can submit the value of ‘sss’ as 000 (or any arbitrary 3-digit value) , or you can omit it, entering only ee. The range and interpretation of the state value sss depends on the specific phase shifter used in the module. For details, refer to the module description.

return

phase_list: No help available

get_multiple_channels(channels: List[str]) → List[int]

ROUTe:PHASe

Same as get_single_channel(), but for multiple channels.

param channels

Example value (without quotes): [‘F01M03(0002)’, ‘F01M04(0003)’]

get_single_channel(channel: str) → List[int]

ROUTe:PHASe

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

param channel

example value (without quotes): ‘F01M03(0001,0002,0003,0004)’

set(channel_list: str) → None

# SCPI: ROUTe:PHASe
driver.route.phase.set(channel_list = r1)

Sets or queries the phase angle, if a phase shifter is available in the module. Also, you can control phase shifters by the standard command method RsOsp.Route.Close.set, allowing joint control of phase shifters and relays, and saving their target states in joint path definitions. Similar to method RsOsp.Route.Close.set, the parameter <channel list> uses the following syntax:

INTRO_CMD_HELP: (@FxxMyy(sssee) )

• xx = 01, 02, 03,…,99 (frame ID in, e.g., switch unit name F01)

• yy = 01, 02, 03,…,20 (module ID in, e.g., slot position M02)

• sss = 000 … n (state of the phase shifter to be controlled in a module)

• ee = 01 … m (element number of the phase shifter to be controlled)

Note that in the string ‘sss’, you can omit leading zeros.

param channel_list

Channel list string as described above, selecting a module and phase shifter and specifying the phase angle to be set. The query also requires the element number ‘ee’, but it ignores the state information ‘sss’. You can submit the value of ‘sss’ as 000 (or any arbitrary 3-digit value) , or you can omit it, entering only ee. The range and interpretation of the state value sss depends on the specific phase shifter used in the module. For details, refer to the module description.