[python source code]

license

The license commands module.

These commands are used in the following models: DPO7AX, LPD6, MSO4, MSO4B, MSO5, MSO5B, MSO5LP, MSO6, MSO6B

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

Please report an issue if one is found.

Commands and Queries 
- LICense:APPID? {<QString>}
- LICense:COUNt?
- LICense:ERRor?
- LICense:GMT?
- LICense:HID?
- LICense:INSTall <Block>
- LICense:ITEM? <NR1>
- LICense:LIST?
- LICense:UNINSTALL? <QString>
- LICense:VALidate? <QString>
- LICense?

License

Bases: SCPICmdRead

The LICense command.

Description
  • This query-only command returns all license parameters.
Usage
  • Using the .query() method will send the LICense? query.
  • Using the .verify(value) method will send the LICense? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- LICense?
Properties
  • .appid: The LICense:APPID command.
  • .count: The LICense:COUNt command.
  • .error: The LICense:ERRor command.
  • .gmt: The LICense:GMT command.
  • .hid: The LICense:HID command.
  • .install: The LICense:INSTall command.
  • .item: The LICense:ITEM command.
  • .list: The LICense:LIST command.
  • .uninstall: The LICense:UNINSTALL command.
  • .validate: The LICense:VALidate command.

appid property 

appid: LicenseAppid

Return the LICense:APPID command.

Description
  • This query returns a comma-separated list of the active application IDs. If a string argument is provided, a ‘0’ or ‘1’ is returned, according to whether the string matches an active application ID.
Usage
  • Using the .query(argument) method will send the LICense:APPID? argument query.
  • Using the .verify(argument, value) method will send the LICense:APPID? argument query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- LICense:APPID? {<QString>}

count property 

count: LicenseCount

Return the LICense:COUNt command.

Description
  • This query returns a count of the number of active licenses installed.
Usage
  • Using the .query() method will send the LICense:COUNt? query.
  • Using the .verify(value) method will send the LICense:COUNt? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- LICense:COUNt?

error property 

error: LicenseError

Return the LICense:ERRor command.

Description
  • This query-only command prompts the instrument to return all events and their messages (delimited by commas), and removes the returned events from the Event Queue. This command is an alias for ALLEV?.
Usage
  • Using the .query() method will send the LICense:ERRor? query.
  • Using the .verify(value) method will send the LICense:ERRor? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- LICense:ERRor?

gmt property 

gmt: LicenseGmt

Return the LICense:GMT command.

Description
  • This query returns the GMT time in ISO 8601 format, the local date, 24 hour time and time-zone offset.
Usage
  • Using the .query() method will send the LICense:GMT? query.
  • Using the .verify(value) method will send the LICense:GMT? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- LICense:GMT?

hid property 

hid: LicenseHid

Return the LICense:HID command.

Description
  • This query returns the instrument HostID unique identifier.
Usage
  • Using the .query() method will send the LICense:HID? query.
  • Using the .verify(value) method will send the LICense:HID? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- LICense:HID?

install property 

install: LicenseInstall

Return the LICense:INSTall command.

Description
  • This command accepts a block data license and installs it on the instrument. Restarting the instrument may be necessary to fully activate the additional capabilities. The format of the block data in the argument must have the following: #
Usage
  • Using the .write(value) method will send the LICense:INSTall value command.
SCPI Syntax 
- LICense:INSTall <Block>
Info
  • <Block> is the license in block data format.

item property 

item: LicenseItem

Return the LICense:ITEM command.

Description
  • This query returns the details pertaining to a specific license. The NR1 argument is zero-indexed. If no argument is provided, zero is assumed.
Usage
  • Using the .query(argument) method will send the LICense:ITEM? argument query.
  • Using the .verify(argument, value) method will send the LICense:ITEM? argument query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- LICense:ITEM? <NR1>
Info
  • <NR1> is the zero-indexed argument specifying a specific license.

list property 

list: LicenseList

Return the LICense:LIST command.

Description
  • This query returns the active license nomenclatures as a comma-separated list of strings. Duplicate nomenclatures, that is, the same license but with different expiration dates, are included.
Usage
  • Using the .query() method will send the LICense:LIST? query.
  • Using the .verify(value) method will send the LICense:LIST? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- LICense:LIST?

uninstall property 

uninstall: LicenseUninstall

Return the LICense:UNINSTALL command.

Description
  • Returns the exit license indicated for the user to return to their TekAMS account. Active licenses can be specified by their nomenclature. TransactionIDs can be used to specify an active license or a previously uninstalled license. In either case, the exit-license is returned as block data.
Usage
  • Using the .query(argument) method will send the LICense:UNINSTALL? argument query.
  • Using the .verify(argument, value) method will send the LICense:UNINSTALL? argument query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- LICense:UNINSTALL? <QString>
Info
  • <QString> is the nomenclature of an active license or a TransactionIDs to specify an active license or a previously uninstalled license.

validate property 

validate: LicenseValidate

Return the LICense:VALidate command.

Description
  • This query accepts a license nomenclature as an argument and returns True (1) if that nomenclature is active and any required hardware is installed, or False (0) if either the nomenclature is not active or required hardware is not installed.
Usage
  • Using the .query(argument) method will send the LICense:VALidate? argument query.
  • Using the .verify(argument, value) method will send the LICense:VALidate? argument query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- LICense:VALidate? <QString>
Info
  • <QString> is the license nomenclature.

LicenseAppid

Bases: SCPICmdReadWithArguments

The LICense:APPID command.

Description
  • This query returns a comma-separated list of the active application IDs. If a string argument is provided, a ‘0’ or ‘1’ is returned, according to whether the string matches an active application ID.
Usage
  • Using the .query(argument) method will send the LICense:APPID? argument query.
  • Using the .verify(argument, value) method will send the LICense:APPID? argument query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- LICense:APPID? {<QString>}

LicenseCount

Bases: SCPICmdRead

The LICense:COUNt command.

Description
  • This query returns a count of the number of active licenses installed.
Usage
  • Using the .query() method will send the LICense:COUNt? query.
  • Using the .verify(value) method will send the LICense:COUNt? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- LICense:COUNt?

LicenseError

Bases: SCPICmdRead

The LICense:ERRor command.

Description
  • This query-only command prompts the instrument to return all events and their messages (delimited by commas), and removes the returned events from the Event Queue. This command is an alias for ALLEV?.
Usage
  • Using the .query() method will send the LICense:ERRor? query.
  • Using the .verify(value) method will send the LICense:ERRor? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- LICense:ERRor?

LicenseGmt

Bases: SCPICmdRead

The LICense:GMT command.

Description
  • This query returns the GMT time in ISO 8601 format, the local date, 24 hour time and time-zone offset.
Usage
  • Using the .query() method will send the LICense:GMT? query.
  • Using the .verify(value) method will send the LICense:GMT? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- LICense:GMT?

LicenseHid

Bases: SCPICmdRead

The LICense:HID command.

Description
  • This query returns the instrument HostID unique identifier.
Usage
  • Using the .query() method will send the LICense:HID? query.
  • Using the .verify(value) method will send the LICense:HID? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- LICense:HID?

LicenseInstall

Bases: SCPICmdWrite

The LICense:INSTall command.

Description
  • This command accepts a block data license and installs it on the instrument. Restarting the instrument may be necessary to fully activate the additional capabilities. The format of the block data in the argument must have the following: #
Usage
  • Using the .write(value) method will send the LICense:INSTall value command.
SCPI Syntax 
- LICense:INSTall <Block>
Info
  • <Block> is the license in block data format.

LicenseItem

Bases: SCPICmdReadWithArguments

The LICense:ITEM command.

Description
  • This query returns the details pertaining to a specific license. The NR1 argument is zero-indexed. If no argument is provided, zero is assumed.
Usage
  • Using the .query(argument) method will send the LICense:ITEM? argument query.
  • Using the .verify(argument, value) method will send the LICense:ITEM? argument query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- LICense:ITEM? <NR1>
Info
  • <NR1> is the zero-indexed argument specifying a specific license.

LicenseList

Bases: SCPICmdRead

The LICense:LIST command.

Description
  • This query returns the active license nomenclatures as a comma-separated list of strings. Duplicate nomenclatures, that is, the same license but with different expiration dates, are included.
Usage
  • Using the .query() method will send the LICense:LIST? query.
  • Using the .verify(value) method will send the LICense:LIST? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- LICense:LIST?

LicenseUninstall

Bases: SCPICmdReadWithArguments

The LICense:UNINSTALL command.

Description
  • Returns the exit license indicated for the user to return to their TekAMS account. Active licenses can be specified by their nomenclature. TransactionIDs can be used to specify an active license or a previously uninstalled license. In either case, the exit-license is returned as block data.
Usage
  • Using the .query(argument) method will send the LICense:UNINSTALL? argument query.
  • Using the .verify(argument, value) method will send the LICense:UNINSTALL? argument query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- LICense:UNINSTALL? <QString>
Info
  • <QString> is the nomenclature of an active license or a TransactionIDs to specify an active license or a previously uninstalled license.

LicenseValidate

Bases: SCPICmdReadWithArguments

The LICense:VALidate command.

Description
  • This query accepts a license nomenclature as an argument and returns True (1) if that nomenclature is active and any required hardware is installed, or False (0) if either the nomenclature is not active or required hardware is not installed.
Usage
  • Using the .query(argument) method will send the LICense:VALidate? argument query.
  • Using the .verify(argument, value) method will send the LICense:VALidate? argument query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- LICense:VALidate? <QString>
Info
  • <QString> is the license nomenclature.