[python source code]

socketserver

The socketserver commands module.

These commands are used in the following models: MSO2, TekScopePC

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

Please report an issue if one is found.

Commands and Queries 
- SOCKETServer:ENAble {ON|OFF|1|0}
- SOCKETServer:ENAble?
- SOCKETServer:PORT <NR1>
- SOCKETServer:PORT?
- SOCKETServer:PROTOCol {TERMinal|NONe}
- SOCKETServer:PROTOCol?

Socketserver

Bases: SCPICmdRead

The SOCKETServer command tree.

Usage
  • Using the .query() method will send the SOCKETServer? query.
  • Using the .verify(value) method will send the SOCKETServer? query and raise an AssertionError if the returned value does not match value.
Properties
  • .enable: The SOCKETServer:ENAble command.
  • .port: The SOCKETServer:PORT command.
  • .protocol: The SOCKETServer:PROTOCol command.

enable property 

enable: SocketserverEnable

Return the SOCKETServer:ENAble command.

Description
  • This command enables or disables the socket server which supports a telnet or other TCPIP socket connection to send commands and queries to the instrument. The default state is enabled.
Usage
  • Using the .query() method will send the SOCKETServer:ENAble? query.
  • Using the .verify(value) method will send the SOCKETServer:ENAble? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the SOCKETServer:ENAble value command.
SCPI Syntax 
- SOCKETServer:ENAble {ON|OFF|1|0}
- SOCKETServer:ENAble?
Info
  • 1 enables the socket server. If the state is 0 (disabled) and this command is sent to enable the socket server when the port is in use by another service, then the error event code 221 (Settings conflict) is posted to the event queue and the socket server remains disabled. In this case, select a different port number and attempt to enable the socket server again.
  • 0 disables the socket server.
  • ON enables the socket server.
  • OFF disables the socket server.

port property 

port: SocketserverPort

Return the SOCKETServer:PORT command.

Description
  • This command sets the TCPIP port for the socket server connection.
Usage
  • Using the .query() method will send the SOCKETServer:PORT? query.
  • Using the .verify(value) method will send the SOCKETServer:PORT? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the SOCKETServer:PORT value command.
SCPI Syntax 
- SOCKETServer:PORT <NR1>
- SOCKETServer:PORT?
Info
  • <NR1> is the TCPIP port for the socket server connection.

protocol property 

protocol: SocketserverProtocol

Return the SOCKETServer:PROTOCol command.

Description
  • This command sets or queries the protocol for the socket server.
Usage
  • Using the .query() method will send the SOCKETServer:PROTOCol? query.
  • Using the .verify(value) method will send the SOCKETServer:PROTOCol? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the SOCKETServer:PROTOCol value command.
SCPI Syntax 
- SOCKETServer:PROTOCol {TERMinal|NONe}
- SOCKETServer:PROTOCol?
Info
  • TERMinal specifies terminal protocol for the socket server. When set to TERMinal, a session startup message is sent to the socket and a command prompt is provided.
  • NONe disables the terminal features, allowing the server to be used for raw socket transactions, such as with a VISA socket server. The default setting is NONe.

SocketserverEnable

Bases: SCPICmdWrite, SCPICmdRead

The SOCKETServer:ENAble command.

Description
  • This command enables or disables the socket server which supports a telnet or other TCPIP socket connection to send commands and queries to the instrument. The default state is enabled.
Usage
  • Using the .query() method will send the SOCKETServer:ENAble? query.
  • Using the .verify(value) method will send the SOCKETServer:ENAble? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the SOCKETServer:ENAble value command.
SCPI Syntax 
- SOCKETServer:ENAble {ON|OFF|1|0}
- SOCKETServer:ENAble?
Info
  • 1 enables the socket server. If the state is 0 (disabled) and this command is sent to enable the socket server when the port is in use by another service, then the error event code 221 (Settings conflict) is posted to the event queue and the socket server remains disabled. In this case, select a different port number and attempt to enable the socket server again.
  • 0 disables the socket server.
  • ON enables the socket server.
  • OFF disables the socket server.

SocketserverPort

Bases: SCPICmdWrite, SCPICmdRead

The SOCKETServer:PORT command.

Description
  • This command sets the TCPIP port for the socket server connection.
Usage
  • Using the .query() method will send the SOCKETServer:PORT? query.
  • Using the .verify(value) method will send the SOCKETServer:PORT? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the SOCKETServer:PORT value command.
SCPI Syntax 
- SOCKETServer:PORT <NR1>
- SOCKETServer:PORT?
Info
  • <NR1> is the TCPIP port for the socket server connection.

SocketserverProtocol

Bases: SCPICmdWrite, SCPICmdRead

The SOCKETServer:PROTOCol command.

Description
  • This command sets or queries the protocol for the socket server.
Usage
  • Using the .query() method will send the SOCKETServer:PROTOCol? query.
  • Using the .verify(value) method will send the SOCKETServer:PROTOCol? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the SOCKETServer:PROTOCol value command.
SCPI Syntax 
- SOCKETServer:PROTOCol {TERMinal|NONe}
- SOCKETServer:PROTOCol?
Info
  • TERMinal specifies terminal protocol for the socket server. When set to TERMinal, a session startup message is sent to the socket and a command prompt is provided.
  • NONe disables the terminal features, allowing the server to be used for raw socket transactions, such as with a VISA socket server. The default setting is NONe.