StIcon

SCPI Commands :

SYSTem:BASE:STICon:ENABle
SYSTem:BASE:STICon:OPEN
SYSTem:BASE:STICon:CLOSe

class StIconCls

StIcon commands group definition. 3 total commands, 0 Subgroups, 3 group commands

close() → None

# SCPI: SYSTem:BASE:STICon:CLOSe
driver.system.stIcon.close()

Hides all windows and taskbar entries of the CMW application. Prerequisite: A CMW software icon has been added to the system tray (ENABle command) .

close_with_opc(opc_timeout_ms: int = -1) → None

# SCPI: SYSTem:BASE:STICon:CLOSe
driver.system.stIcon.close_with_opc()

Hides all windows and taskbar entries of the CMW application. Prerequisite: A CMW software icon has been added to the system tray (ENABle command) .

Same as close, but waits for the operation to complete before continuing further. Use the RsCmwBase.utilities.opc_timeout_set() to set the timeout value.

param opc_timeout_ms:

Maximum time to wait in milliseconds, valid only for this call.

get_enable() → bool

# SCPI: SYSTem:BASE:STICon:ENABle
value: bool = driver.system.stIcon.get_enable()

Selects whether an icon for the CMW software is added to the system tray of the operating system.

return:

on_off: ON | OFF | 1 | 0 ON | 1: icon in system tray OFF | 0: no icon in system tray

open() → None

# SCPI: SYSTem:BASE:STICon:OPEN
driver.system.stIcon.open()

Restores the windows and taskbar entries of the CMW application after they have been hidden by the CLOSe command. Prerequisite: A CMW software icon has been added to the system tray (ENABle command) .

open_with_opc(opc_timeout_ms: int = -1) → None

# SCPI: SYSTem:BASE:STICon:OPEN
driver.system.stIcon.open_with_opc()

Restores the windows and taskbar entries of the CMW application after they have been hidden by the CLOSe command. Prerequisite: A CMW software icon has been added to the system tray (ENABle command) .

Same as open, but waits for the operation to complete before continuing further. Use the RsCmwBase.utilities.opc_timeout_set() to set the timeout value.

param opc_timeout_ms:

Maximum time to wait in milliseconds, valid only for this call.

set_enable(on_off: bool) → None

# SCPI: SYSTem:BASE:STICon:ENABle
driver.system.stIcon.set_enable(on_off = False)

Selects whether an icon for the CMW software is added to the system tray of the operating system.

param on_off:

ON | OFF | 1 | 0 ON | 1: icon in system tray OFF | 0: no icon in system tray