socketserver
¶
The socketserver commands module.
These commands are used in the following models: DPO4K, DPO4KB, MDO3, MDO3K, MDO4K, MDO4KB, MDO4KC, MSO4K, MSO4KB
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|<NR1>}
- 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 theSOCKETServer?
query. - Using the
.verify(value)
method will send theSOCKETServer?
query and raise an AssertionError if the returned value does not matchvalue
.
Properties
.enable
: TheSOCKETServer:ENAble
command..port
: TheSOCKETServer:PORT
command..protocol
: TheSOCKETServer: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 TCP/IP socket connection to send commands and queries to the instrument. The default state is enabled.
Usage
- Using the
.query()
method will send theSOCKETServer:ENAble?
query. - Using the
.verify(value)
method will send theSOCKETServer:ENAble?
query and raise an AssertionError if the returned value does not matchvalue
. - Using the
.write(value)
method will send theSOCKETServer:ENAble value
command.
SCPI Syntax
- SOCKETServer:ENAble {ON|OFF|<NR1>}
- SOCKETServer:ENAble?
Info
ON
enables the socket server.OFF
disables the socket server.<NR1> = 0
disables the socket server; any other value turns it on.
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 theSOCKETServer:PORT?
query. - Using the
.verify(value)
method will send theSOCKETServer:PORT?
query and raise an AssertionError if the returned value does not matchvalue
. - Using the
.write(value)
method will send theSOCKETServer: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 theSOCKETServer:PROTOCol?
query. - Using the
.verify(value)
method will send theSOCKETServer:PROTOCol?
query and raise an AssertionError if the returned value does not matchvalue
. - Using the
.write(value)
method will send theSOCKETServer: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 TCP/IP socket connection to send commands and queries to the instrument. The default state is enabled.
Usage
- Using the
.query()
method will send theSOCKETServer:ENAble?
query. - Using the
.verify(value)
method will send theSOCKETServer:ENAble?
query and raise an AssertionError if the returned value does not matchvalue
. - Using the
.write(value)
method will send theSOCKETServer:ENAble value
command.
SCPI Syntax
- SOCKETServer:ENAble {ON|OFF|<NR1>}
- SOCKETServer:ENAble?
Info
ON
enables the socket server.OFF
disables the socket server.<NR1> = 0
disables the socket server; any other value turns it on.
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 theSOCKETServer:PORT?
query. - Using the
.verify(value)
method will send theSOCKETServer:PORT?
query and raise an AssertionError if the returned value does not matchvalue
. - Using the
.write(value)
method will send theSOCKETServer: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 theSOCKETServer:PROTOCol?
query. - Using the
.verify(value)
method will send theSOCKETServer:PROTOCol?
query and raise an AssertionError if the returned value does not matchvalue
. - Using the
.write(value)
method will send theSOCKETServer: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.