[python source code]

ethernet

The ethernet commands module.

These commands are used in the following models: MSO2

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

Please report an issue if one is found.

Commands and Queries 
- ETHERnet:DHCPbootp {ON|OFF}
- ETHERnet:DHCPbootp?
- ETHERnet:DNS:IPADDress <QString>
- ETHERnet:DNS:IPADDress?
- ETHERnet:DOMAINname <QString>
- ETHERnet:DOMAINname?
- ETHERnet:ENET:ADDress?
- ETHERnet:GATEWay:IPADDress <QString>
- ETHERnet:GATEWay:IPADDress?
- ETHERnet:IPADDress <QString>
- ETHERnet:IPADDress?
- ETHERnet:LXI:LAN:RESET
- ETHERnet:LXI:LAN:SERVICENAMe <QString>
- ETHERnet:LXI:LAN:SERVICENAMe?
- ETHERnet:LXI:LAN:STATus?
- ETHERnet:NAME <QString>
- ETHERnet:NAME?
- ETHERnet:NETWORKCONFig {AUTOmatic|MANual}
- ETHERnet:NETWORKCONFig?
- ETHERnet:PING EXECute
- ETHERnet:PING:STATus?
- ETHERnet:SUBNETMask <QString>
- ETHERnet:SUBNETMask?

Ethernet

Bases: SCPICmdRead

The ETHERnet command tree.

Usage
  • Using the .query() method will send the ETHERnet? query.
  • Using the .verify(value) method will send the ETHERnet? query and raise an AssertionError if the returned value does not match value.
Properties
  • .dhcpbootp: The ETHERnet:DHCPbootp command.
  • .dns: The ETHERnet:DNS command tree.
  • .domainname: The ETHERnet:DOMAINname command.
  • .enet: The ETHERnet:ENET command tree.
  • .gateway: The ETHERnet:GATEWay command tree.
  • .ipaddress: The ETHERnet:IPADDress command.
  • .lxi: The ETHERnet:LXI command tree.
  • .name: The ETHERnet:NAME command.
  • .networkconfig: The ETHERnet:NETWORKCONFig command.
  • .ping: The ETHERnet:PING command.
  • .subnetmask: The ETHERnet:SUBNETMask command.

dhcpbootp property 

dhcpbootp: EthernetDhcpbootp

Return the ETHERnet:DHCPbootp command.

Description
  • This command sets the network configuration method to DHCP (that is ON) or static IP address (that is OFF).
Usage
  • Using the .query() method will send the ETHERnet:DHCPbootp? query.
  • Using the .verify(value) method will send the ETHERnet:DHCPbootp? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ETHERnet:DHCPbootp value command.
SCPI Syntax 
- ETHERnet:DHCPbootp {ON|OFF}
- ETHERnet:DHCPbootp?
Info
  • ON enables the instrument to search the network for a DHCP server in order to automatically assign a dynamic IP address to the instrument.
  • OFF disables the instrument to search the network for a DHCP server.

dns property 

dns: EthernetDns

Return the ETHERnet:DNS command tree.

Usage
  • Using the .query() method will send the ETHERnet:DNS? query.
  • Using the .verify(value) method will send the ETHERnet:DNS? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .ipaddress: The ETHERnet:DNS:IPADDress command.

domainname property 

domainname: EthernetDomainname

Return the ETHERnet:DOMAINname command.

Description
  • This command specifies the network domain name.
Usage
  • Using the .query() method will send the ETHERnet:DOMAINname? query.
  • Using the .verify(value) method will send the ETHERnet:DOMAINname? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ETHERnet:DOMAINname value command.
SCPI Syntax 
- ETHERnet:DOMAINname <QString>
- ETHERnet:DOMAINname?
Info
  • <QString> is the network domain name, enclosed in quotes.

enet property 

enet: EthernetEnet

Return the ETHERnet:ENET command tree.

Usage
  • Using the .query() method will send the ETHERnet:ENET? query.
  • Using the .verify(value) method will send the ETHERnet:ENET? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .address: The ETHERnet:ENET:ADDress command.

gateway property 

gateway: EthernetGateway

Return the ETHERnet:GATEWay command tree.

Usage
  • Using the .query() method will send the ETHERnet:GATEWay? query.
  • Using the .verify(value) method will send the ETHERnet:GATEWay? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .ipaddress: The ETHERnet:GATEWay:IPADDress command.

ipaddress property 

ipaddress: EthernetIpaddress

Return the ETHERnet:IPADDress command.

Description
  • This command sets the IP address assigned to the instrument.
Usage
  • Using the .query() method will send the ETHERnet:IPADDress? query.
  • Using the .verify(value) method will send the ETHERnet:IPADDress? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ETHERnet:IPADDress value command.
SCPI Syntax 
- ETHERnet:IPADDress <QString>
- ETHERnet:IPADDress?
Info
  • <QString> is a standard IP address value, enclosed in quotes.

lxi property 

lxi: EthernetLxi

Return the ETHERnet:LXI command tree.

Usage
  • Using the .query() method will send the ETHERnet:LXI? query.
  • Using the .verify(value) method will send the ETHERnet:LXI? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .lan: The ETHERnet:LXI:LAN command tree.

name property 

name: EthernetName

Return the ETHERnet:NAME command.

Description
  • This command sets or queries the instrument Ethernet hostname assigned to the instrument.
Usage
  • Using the .query() method will send the ETHERnet:NAME? query.
  • Using the .verify(value) method will send the ETHERnet:NAME? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ETHERnet:NAME value command.
SCPI Syntax 
- ETHERnet:NAME <QString>
- ETHERnet:NAME?
Info
  • <QString> is the network name assigned to the instrument, enclosed in quotes.

networkconfig property 

networkconfig: EthernetNetworkconfig

Return the ETHERnet:NETWORKCONFig command.

Description
  • This command specifies the Ethernet network configuration setting.
Usage
  • Using the .query() method will send the ETHERnet:NETWORKCONFig? query.
  • Using the .verify(value) method will send the ETHERnet:NETWORKCONFig? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ETHERnet:NETWORKCONFig value command.
SCPI Syntax 
- ETHERnet:NETWORKCONFig {AUTOmatic|MANual}
- ETHERnet:NETWORKCONFig?
Info
  • AUTOmatic specifies that the instrument’s IP address, subnet mask and gateway settings will be received from a DHCP server on the local network.
  • MANual specifies that the Ethernet settings will be configured manually, using ETHERNET:IPADDRESS, ETHERNET:SUBNETMASK, and ETHERNET:GATEWAY:IPADDRESS.

ping property 

ping: EthernetPing

Return the ETHERnet:PING command.

Description
  • Sends a ping packet to the instrument gateway and sets the status accordingly.
Usage
  • Using the .write(value) method will send the ETHERnet:PING value command.
SCPI Syntax 
- ETHERnet:PING EXECute
Sub-properties
  • .status: The ETHERnet:PING:STATus command.

subnetmask property 

subnetmask: EthernetSubnetmask

Return the ETHERnet:SUBNETMask command.

Description
  • This command sets or queries the instrument subnet mask value.
Usage
  • Using the .query() method will send the ETHERnet:SUBNETMask? query.
  • Using the .verify(value) method will send the ETHERnet:SUBNETMask? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ETHERnet:SUBNETMask value command.
SCPI Syntax 
- ETHERnet:SUBNETMask <QString>
- ETHERnet:SUBNETMask?
Info
  • <QString> is the subnet mask value, enclosed in quotes.

EthernetDhcpbootp

Bases: SCPICmdWrite, SCPICmdRead

The ETHERnet:DHCPbootp command.

Description
  • This command sets the network configuration method to DHCP (that is ON) or static IP address (that is OFF).
Usage
  • Using the .query() method will send the ETHERnet:DHCPbootp? query.
  • Using the .verify(value) method will send the ETHERnet:DHCPbootp? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ETHERnet:DHCPbootp value command.
SCPI Syntax 
- ETHERnet:DHCPbootp {ON|OFF}
- ETHERnet:DHCPbootp?
Info
  • ON enables the instrument to search the network for a DHCP server in order to automatically assign a dynamic IP address to the instrument.
  • OFF disables the instrument to search the network for a DHCP server.

EthernetDns

Bases: SCPICmdRead

The ETHERnet:DNS command tree.

Usage
  • Using the .query() method will send the ETHERnet:DNS? query.
  • Using the .verify(value) method will send the ETHERnet:DNS? query and raise an AssertionError if the returned value does not match value.
Properties
  • .ipaddress: The ETHERnet:DNS:IPADDress command.

ipaddress property 

ipaddress: EthernetDnsIpaddress

Return the ETHERnet:DNS:IPADDress command.

Description
  • This command specifies the network Domain Name Server (DNS) IP address.
Usage
  • Using the .query() method will send the ETHERnet:DNS:IPADDress? query.
  • Using the .verify(value) method will send the ETHERnet:DNS:IPADDress? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ETHERnet:DNS:IPADDress value command.
SCPI Syntax 
- ETHERnet:DNS:IPADDress <QString>
- ETHERnet:DNS:IPADDress?
Info
  • <QString> is a standard IP address value, enclosed in quotes.

EthernetDnsIpaddress

Bases: SCPICmdWrite, SCPICmdRead

The ETHERnet:DNS:IPADDress command.

Description
  • This command specifies the network Domain Name Server (DNS) IP address.
Usage
  • Using the .query() method will send the ETHERnet:DNS:IPADDress? query.
  • Using the .verify(value) method will send the ETHERnet:DNS:IPADDress? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ETHERnet:DNS:IPADDress value command.
SCPI Syntax 
- ETHERnet:DNS:IPADDress <QString>
- ETHERnet:DNS:IPADDress?
Info
  • <QString> is a standard IP address value, enclosed in quotes.

EthernetDomainname

Bases: SCPICmdWrite, SCPICmdRead

The ETHERnet:DOMAINname command.

Description
  • This command specifies the network domain name.
Usage
  • Using the .query() method will send the ETHERnet:DOMAINname? query.
  • Using the .verify(value) method will send the ETHERnet:DOMAINname? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ETHERnet:DOMAINname value command.
SCPI Syntax 
- ETHERnet:DOMAINname <QString>
- ETHERnet:DOMAINname?
Info
  • <QString> is the network domain name, enclosed in quotes.

EthernetEnet

Bases: SCPICmdRead

The ETHERnet:ENET command tree.

Usage
  • Using the .query() method will send the ETHERnet:ENET? query.
  • Using the .verify(value) method will send the ETHERnet:ENET? query and raise an AssertionError if the returned value does not match value.
Properties
  • .address: The ETHERnet:ENET:ADDress command.

address property 

address: EthernetEnetAddress

Return the ETHERnet:ENET:ADDress command.

Description
  • Returns the Ethernet address (MAC address) value assigned to the instrument. This is assigned at the factory and can not be changed.
Usage
  • Using the .query() method will send the ETHERnet:ENET:ADDress? query.
  • Using the .verify(value) method will send the ETHERnet:ENET:ADDress? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- ETHERnet:ENET:ADDress?

EthernetEnetAddress

Bases: SCPICmdRead

The ETHERnet:ENET:ADDress command.

Description
  • Returns the Ethernet address (MAC address) value assigned to the instrument. This is assigned at the factory and can not be changed.
Usage
  • Using the .query() method will send the ETHERnet:ENET:ADDress? query.
  • Using the .verify(value) method will send the ETHERnet:ENET:ADDress? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- ETHERnet:ENET:ADDress?

EthernetGateway

Bases: SCPICmdRead

The ETHERnet:GATEWay command tree.

Usage
  • Using the .query() method will send the ETHERnet:GATEWay? query.
  • Using the .verify(value) method will send the ETHERnet:GATEWay? query and raise an AssertionError if the returned value does not match value.
Properties
  • .ipaddress: The ETHERnet:GATEWay:IPADDress command.

ipaddress property 

ipaddress: EthernetGatewayIpaddress

Return the ETHERnet:GATEWay:IPADDress command.

Description
  • This command specifies the network gateway IP address.
Usage
  • Using the .query() method will send the ETHERnet:GATEWay:IPADDress? query.
  • Using the .verify(value) method will send the ETHERnet:GATEWay:IPADDress? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ETHERnet:GATEWay:IPADDress value command.
SCPI Syntax 
- ETHERnet:GATEWay:IPADDress <QString>
- ETHERnet:GATEWay:IPADDress?
Info
  • <QString> is a standard IP address value, enclosed in quotes.

EthernetGatewayIpaddress

Bases: SCPICmdWrite, SCPICmdRead

The ETHERnet:GATEWay:IPADDress command.

Description
  • This command specifies the network gateway IP address.
Usage
  • Using the .query() method will send the ETHERnet:GATEWay:IPADDress? query.
  • Using the .verify(value) method will send the ETHERnet:GATEWay:IPADDress? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ETHERnet:GATEWay:IPADDress value command.
SCPI Syntax 
- ETHERnet:GATEWay:IPADDress <QString>
- ETHERnet:GATEWay:IPADDress?
Info
  • <QString> is a standard IP address value, enclosed in quotes.

EthernetIpaddress

Bases: SCPICmdWrite, SCPICmdRead

The ETHERnet:IPADDress command.

Description
  • This command sets the IP address assigned to the instrument.
Usage
  • Using the .query() method will send the ETHERnet:IPADDress? query.
  • Using the .verify(value) method will send the ETHERnet:IPADDress? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ETHERnet:IPADDress value command.
SCPI Syntax 
- ETHERnet:IPADDress <QString>
- ETHERnet:IPADDress?
Info
  • <QString> is a standard IP address value, enclosed in quotes.

EthernetLxi

Bases: SCPICmdRead

The ETHERnet:LXI command tree.

Usage
  • Using the .query() method will send the ETHERnet:LXI? query.
  • Using the .verify(value) method will send the ETHERnet:LXI? query and raise an AssertionError if the returned value does not match value.
Properties
  • .lan: The ETHERnet:LXI:LAN command tree.

lan property 

lan: EthernetLxiLan

Return the ETHERnet:LXI:LAN command tree.

Usage
  • Using the .query() method will send the ETHERnet:LXI:LAN? query.
  • Using the .verify(value) method will send the ETHERnet:LXI:LAN? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .reset: The ETHERnet:LXI:LAN:RESET command.
  • .servicename: The ETHERnet:LXI:LAN:SERVICENAMe command.
  • .status: The ETHERnet:LXI:LAN:STATus command.

EthernetLxiLan

Bases: SCPICmdRead

The ETHERnet:LXI:LAN command tree.

Usage
  • Using the .query() method will send the ETHERnet:LXI:LAN? query.
  • Using the .verify(value) method will send the ETHERnet:LXI:LAN? query and raise an AssertionError if the returned value does not match value.
Properties
  • .reset: The ETHERnet:LXI:LAN:RESET command.
  • .servicename: The ETHERnet:LXI:LAN:SERVICENAMe command.
  • .status: The ETHERnet:LXI:LAN:STATus command.

reset property 

reset: EthernetLxiLanReset

Return the ETHERnet:LXI:LAN:RESET command.

Description
  • This command resets the LXI local area network.
Usage
  • Using the .write() method will send the ETHERnet:LXI:LAN:RESET command.
SCPI Syntax 
- ETHERnet:LXI:LAN:RESET

servicename property 

servicename: EthernetLxiLanServicename

Return the ETHERnet:LXI:LAN:SERVICENAMe command.

Description
  • This command sets or queries the service name used for the LXI interface.
Usage
  • Using the .query() method will send the ETHERnet:LXI:LAN:SERVICENAMe? query.
  • Using the .verify(value) method will send the ETHERnet:LXI:LAN:SERVICENAMe? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ETHERnet:LXI:LAN:SERVICENAMe value command.
SCPI Syntax 
- ETHERnet:LXI:LAN:SERVICENAMe <QString>
- ETHERnet:LXI:LAN:SERVICENAMe?
Info
  • <QString> is a quoted string of up to 64 characters that specifies the mDNS service name used for the LXI interface.

status property 

status: EthernetLxiLanStatus

Return the ETHERnet:LXI:LAN:STATus command.

Description
  • This query returns the LXI network status: one of OK, FAULT, or IDENTIFY. IDENTIFY indicates that the device identify mode is enabled.
Usage
  • Using the .query() method will send the ETHERnet:LXI:LAN:STATus? query.
  • Using the .verify(value) method will send the ETHERnet:LXI:LAN:STATus? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- ETHERnet:LXI:LAN:STATus?

EthernetLxiLanReset

Bases: SCPICmdWriteNoArguments

The ETHERnet:LXI:LAN:RESET command.

Description
  • This command resets the LXI local area network.
Usage
  • Using the .write() method will send the ETHERnet:LXI:LAN:RESET command.
SCPI Syntax 
- ETHERnet:LXI:LAN:RESET

EthernetLxiLanServicename

Bases: SCPICmdWrite, SCPICmdRead

The ETHERnet:LXI:LAN:SERVICENAMe command.

Description
  • This command sets or queries the service name used for the LXI interface.
Usage
  • Using the .query() method will send the ETHERnet:LXI:LAN:SERVICENAMe? query.
  • Using the .verify(value) method will send the ETHERnet:LXI:LAN:SERVICENAMe? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ETHERnet:LXI:LAN:SERVICENAMe value command.
SCPI Syntax 
- ETHERnet:LXI:LAN:SERVICENAMe <QString>
- ETHERnet:LXI:LAN:SERVICENAMe?
Info
  • <QString> is a quoted string of up to 64 characters that specifies the mDNS service name used for the LXI interface.

EthernetLxiLanStatus

Bases: SCPICmdRead

The ETHERnet:LXI:LAN:STATus command.

Description
  • This query returns the LXI network status: one of OK, FAULT, or IDENTIFY. IDENTIFY indicates that the device identify mode is enabled.
Usage
  • Using the .query() method will send the ETHERnet:LXI:LAN:STATus? query.
  • Using the .verify(value) method will send the ETHERnet:LXI:LAN:STATus? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- ETHERnet:LXI:LAN:STATus?

EthernetName

Bases: SCPICmdWrite, SCPICmdRead

The ETHERnet:NAME command.

Description
  • This command sets or queries the instrument Ethernet hostname assigned to the instrument.
Usage
  • Using the .query() method will send the ETHERnet:NAME? query.
  • Using the .verify(value) method will send the ETHERnet:NAME? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ETHERnet:NAME value command.
SCPI Syntax 
- ETHERnet:NAME <QString>
- ETHERnet:NAME?
Info
  • <QString> is the network name assigned to the instrument, enclosed in quotes.

EthernetNetworkconfig

Bases: SCPICmdWrite, SCPICmdRead

The ETHERnet:NETWORKCONFig command.

Description
  • This command specifies the Ethernet network configuration setting.
Usage
  • Using the .query() method will send the ETHERnet:NETWORKCONFig? query.
  • Using the .verify(value) method will send the ETHERnet:NETWORKCONFig? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ETHERnet:NETWORKCONFig value command.
SCPI Syntax 
- ETHERnet:NETWORKCONFig {AUTOmatic|MANual}
- ETHERnet:NETWORKCONFig?
Info
  • AUTOmatic specifies that the instrument’s IP address, subnet mask and gateway settings will be received from a DHCP server on the local network.
  • MANual specifies that the Ethernet settings will be configured manually, using ETHERNET:IPADDRESS, ETHERNET:SUBNETMASK, and ETHERNET:GATEWAY:IPADDRESS.

EthernetPing

Bases: SCPICmdWrite, SCPICmdRead

The ETHERnet:PING command.

Description
  • Sends a ping packet to the instrument gateway and sets the status accordingly.
Usage
  • Using the .write(value) method will send the ETHERnet:PING value command.
SCPI Syntax 
- ETHERnet:PING EXECute
Properties
  • .status: The ETHERnet:PING:STATus command.

status property 

status: EthernetPingStatus

Return the ETHERnet:PING:STATus command.

Description
  • Returns the results of sending the ETHERNET:PING command to ping the gateway IP address.
Usage
  • Using the .query() method will send the ETHERnet:PING:STATus? query.
  • Using the .verify(value) method will send the ETHERnet:PING:STATus? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- ETHERnet:PING:STATus?

EthernetPingStatus

Bases: SCPICmdRead

The ETHERnet:PING:STATus command.

Description
  • Returns the results of sending the ETHERNET:PING command to ping the gateway IP address.
Usage
  • Using the .query() method will send the ETHERnet:PING:STATus? query.
  • Using the .verify(value) method will send the ETHERnet:PING:STATus? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- ETHERnet:PING:STATus?

EthernetSubnetmask

Bases: SCPICmdWrite, SCPICmdRead

The ETHERnet:SUBNETMask command.

Description
  • This command sets or queries the instrument subnet mask value.
Usage
  • Using the .query() method will send the ETHERnet:SUBNETMask? query.
  • Using the .verify(value) method will send the ETHERnet:SUBNETMask? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ETHERnet:SUBNETMask value command.
SCPI Syntax 
- ETHERnet:SUBNETMask <QString>
- ETHERnet:SUBNETMask?
Info
  • <QString> is the subnet mask value, enclosed in quotes.