ListPy

SCPI Command :

SYSTem:BASE:OPTion:LIST
class ListPyCls[source]

ListPy commands group definition. 1 total commands, 0 Subgroups, 1 group commands

get(product_type: ProductType = None, validity: ValidityScope = None, scope: ValidityScopeB = None, instrument_no: float = None) → str[source]
# SCPI: SYSTem:BASE:OPTion:LIST
value: str = driver.system.option.listPy.get(product_type = enums.ProductType.ALL, validity = enums.ValidityScope.ALL, scope = enums.ValidityScopeB.INSTrument, instrument_no = 1.0)

Returns a list of installed software options (licenses) , hardware options, software packages and firmware applications. The list can be filtered using the described parameters. If filtering results in an empty list, a ‘0’ is returned.

INTRO_CMD_HELP: The meaning of the filter <Validity> depends on the <OptionType> as follows:

  • A software option is valid if there is an active license key for it. The value ‘FUNCtional’ is not relevant.

  • A hardware option is functional if the corresponding hardware and all its components can be used (no defect detected) . The value ‘VALid’ is not relevant.

  • A firmware application is functional if the required hardware, software and license keys are available and functional. The value ‘VALid’ is not relevant.

  • For software packages, the filter has no effect.

param product_type:

No help available

param validity:

FUNCtional | VALid | ALL List only functional entries or only valid entries. By default or if ALL is selected, the list is not filtered according to the validity.

param scope:

No help available

param instrument_no:

No help available

return:

option_list: No help available