[python source code]

hsinterface

The hsinterface 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 
- HSInterface:PORT <NR1>
- HSInterface:PORT?
- HSInterface:STATe {0|1}
- HSInterface:STATe?
- HSInterface:TIMeout <NR1>
- HSInterface:TIMeout?

Hsinterface

Bases: SCPICmdRead

The HSInterface command tree.

Usage
  • Using the .query() method will send the HSInterface? query.
  • Using the .verify(value) method will send the HSInterface? query and raise an AssertionError if the returned value does not match value.
Properties
  • .port: The HSInterface:PORT command.
  • .state: The HSInterface:STATe command.
  • .timeout: The HSInterface:TIMeout command.

port property 

port: HsinterfacePort

Return the HSInterface:PORT command.

Description
  • This command sets or queries the port that the high speed interface listens on.
Usage
  • Using the .query() method will send the HSInterface:PORT? query.
  • Using the .verify(value) method will send the HSInterface:PORT? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the HSInterface:PORT value command.
SCPI Syntax 
- HSInterface:PORT <NR1>
- HSInterface:PORT?
Info
  • <NR1> is the port number that the high speed interface listens. The default value is 5000.

state property 

state: HsinterfaceState

Return the HSInterface:STATe command.

Description
  • This command enables or disables the high speed interface.
Usage
  • Using the .query() method will send the HSInterface:STATe? query.
  • Using the .verify(value) method will send the HSInterface:STATe? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the HSInterface:STATe value command.
SCPI Syntax 
- HSInterface:STATe {0|1}
- HSInterface:STATe?
Info
  • 0 disables high speed interface. This is the default value.
  • 1 enables high speed interface.

timeout property 

timeout: HsinterfaceTimeout

Return the HSInterface:TIMeout command.

Description
  • This command sets or queries the timeout for the high speed interface. If a client is waiting for data and no new data is acquired within the specified timeout, the high speed interface will disconnect the client.
Usage
  • Using the .query() method will send the HSInterface:TIMeout? query.
  • Using the .verify(value) method will send the HSInterface:TIMeout? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the HSInterface:TIMeout value command.
SCPI Syntax 
- HSInterface:TIMeout <NR1>
- HSInterface:TIMeout?
Info
  • <NR1> is the amount of time in seconds. The default value is 20 seconds.

HsinterfacePort

Bases: SCPICmdWrite, SCPICmdRead

The HSInterface:PORT command.

Description
  • This command sets or queries the port that the high speed interface listens on.
Usage
  • Using the .query() method will send the HSInterface:PORT? query.
  • Using the .verify(value) method will send the HSInterface:PORT? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the HSInterface:PORT value command.
SCPI Syntax 
- HSInterface:PORT <NR1>
- HSInterface:PORT?
Info
  • <NR1> is the port number that the high speed interface listens. The default value is 5000.

HsinterfaceState

Bases: SCPICmdWrite, SCPICmdRead

The HSInterface:STATe command.

Description
  • This command enables or disables the high speed interface.
Usage
  • Using the .query() method will send the HSInterface:STATe? query.
  • Using the .verify(value) method will send the HSInterface:STATe? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the HSInterface:STATe value command.
SCPI Syntax 
- HSInterface:STATe {0|1}
- HSInterface:STATe?
Info
  • 0 disables high speed interface. This is the default value.
  • 1 enables high speed interface.

HsinterfaceTimeout

Bases: SCPICmdWrite, SCPICmdRead

The HSInterface:TIMeout command.

Description
  • This command sets or queries the timeout for the high speed interface. If a client is waiting for data and no new data is acquired within the specified timeout, the high speed interface will disconnect the client.
Usage
  • Using the .query() method will send the HSInterface:TIMeout? query.
  • Using the .verify(value) method will send the HSInterface:TIMeout? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the HSInterface:TIMeout value command.
SCPI Syntax 
- HSInterface:TIMeout <NR1>
- HSInterface:TIMeout?
Info
  • <NR1> is the amount of time in seconds. The default value is 20 seconds.