Iperf

SCPI Commands

CONFigure:DATA:MEASurement<MeasInstance>:IPERf:TYPE
CONFigure:DATA:MEASurement<MeasInstance>:IPERf:TDURation
CONFigure:DATA:MEASurement<MeasInstance>:IPERf:PSIZe
CONFigure:DATA:MEASurement<MeasInstance>:IPERf:STYPe
CONFigure:DATA:MEASurement<MeasInstance>:IPERf:WSIZe
CONFigure:DATA:MEASurement<MeasInstance>:IPERf:PORT
CONFigure:DATA:MEASurement<MeasInstance>:IPERf:LPORt
CONFigure:DATA:MEASurement<MeasInstance>:IPERf:PROTocol
CONFigure:DATA:MEASurement<MeasInstance>:IPERf:IPADdress
CONFigure:DATA:MEASurement<MeasInstance>:IPERf:BITRate
CONFigure:DATA:MEASurement<MeasInstance>:IPERf:PCONnection
class Iperf[source]

Iperf commands group definition. 31 total commands, 3 Sub-groups, 11 group commands

get_bitrate() → int[source]
# SCPI: CONFigure:DATA:MEASurement<Instance>:IPERf:BITRate
value: int = driver.configure.data.measurement.iperf.get_bitrate()

No command help available

return

bitrate: No help available

get_ip_address() → str[source]
# SCPI: CONFigure:DATA:MEASurement<Instance>:IPERf:IPADdress
value: str = driver.configure.data.measurement.iperf.get_ip_address()

No command help available

return

ip_address: No help available

get_lport() → int[source]
# SCPI: CONFigure:DATA:MEASurement<Instance>:IPERf:LPORt
value: int = driver.configure.data.measurement.iperf.get_lport()

No command help available

return

listen_port: No help available

get_pconnection() → int[source]
# SCPI: CONFigure:DATA:MEASurement<Instance>:IPERf:PCONnection
value: int = driver.configure.data.measurement.iperf.get_pconnection()

No command help available

return

par_conn: No help available

get_port() → int[source]
# SCPI: CONFigure:DATA:MEASurement<Instance>:IPERf:PORT
value: int = driver.configure.data.measurement.iperf.get_port()

No command help available

return

port: No help available

get_protocol() → RsCmwDau.enums.Protocol[source]
# SCPI: CONFigure:DATA:MEASurement<Instance>:IPERf:PROTocol
value: enums.Protocol = driver.configure.data.measurement.iperf.get_protocol()

No command help available

return

protocol: No help available

get_psize() → int[source]
# SCPI: CONFigure:DATA:MEASurement<Instance>:IPERf:PSIZe
value: int = driver.configure.data.measurement.iperf.get_psize()

Defines the packet size for iperf tests.

return

packet_size: Range: 40 bytes to 65507 bytes, Unit: bytes

get_stype() → RsCmwDau.enums.ServiceTypeB[source]
# SCPI: CONFigure:DATA:MEASurement<Instance>:IPERf:STYPe
value: enums.ServiceTypeB = driver.configure.data.measurement.iperf.get_stype()

No command help available

return

service_type: No help available

get_tduration() → int[source]
# SCPI: CONFigure:DATA:MEASurement<Instance>:IPERf:TDURation
value: int = driver.configure.data.measurement.iperf.get_tduration()

Defines the duration of the test.

return

test_duration: Range: 1 s to 1E+6 s, Unit: s

get_type_py() → float[source]
# SCPI: CONFigure:DATA:MEASurement<Instance>:IPERf:TYPE
value: float = driver.configure.data.measurement.iperf.get_type_py()

Selects the type of iperf to be used.

return

iperf_type: IPERf | IP3 | IPNat Iperf or iperf3 or iperf(NAT)

get_wsize() → float[source]
# SCPI: CONFigure:DATA:MEASurement<Instance>:IPERf:WSIZe
value: float = driver.configure.data.measurement.iperf.get_wsize()

No command help available

return

window_size: No help available

set_bitrate(bitrate: int) → None[source]
# SCPI: CONFigure:DATA:MEASurement<Instance>:IPERf:BITRate
driver.configure.data.measurement.iperf.set_bitrate(bitrate = 1)

No command help available

param bitrate

No help available

set_ip_address(ip_address: str) → None[source]
# SCPI: CONFigure:DATA:MEASurement<Instance>:IPERf:IPADdress
driver.configure.data.measurement.iperf.set_ip_address(ip_address = '1')

No command help available

param ip_address

No help available

set_lport(listen_port: int) → None[source]
# SCPI: CONFigure:DATA:MEASurement<Instance>:IPERf:LPORt
driver.configure.data.measurement.iperf.set_lport(listen_port = 1)

No command help available

param listen_port

No help available

set_pconnection(par_conn: int) → None[source]
# SCPI: CONFigure:DATA:MEASurement<Instance>:IPERf:PCONnection
driver.configure.data.measurement.iperf.set_pconnection(par_conn = 1)

No command help available

param par_conn

No help available

set_port(port: int) → None[source]
# SCPI: CONFigure:DATA:MEASurement<Instance>:IPERf:PORT
driver.configure.data.measurement.iperf.set_port(port = 1)

No command help available

param port

No help available

set_protocol(protocol: RsCmwDau.enums.Protocol) → None[source]
# SCPI: CONFigure:DATA:MEASurement<Instance>:IPERf:PROTocol
driver.configure.data.measurement.iperf.set_protocol(protocol = enums.Protocol.TCP)

No command help available

param protocol

No help available

set_psize(packet_size: int) → None[source]
# SCPI: CONFigure:DATA:MEASurement<Instance>:IPERf:PSIZe
driver.configure.data.measurement.iperf.set_psize(packet_size = 1)

Defines the packet size for iperf tests.

param packet_size

Range: 40 bytes to 65507 bytes, Unit: bytes

set_stype(service_type: RsCmwDau.enums.ServiceTypeB) → None[source]
# SCPI: CONFigure:DATA:MEASurement<Instance>:IPERf:STYPe
driver.configure.data.measurement.iperf.set_stype(service_type = enums.ServiceTypeB.BIDirectional)

No command help available

param service_type

No help available

set_tduration(test_duration: int) → None[source]
# SCPI: CONFigure:DATA:MEASurement<Instance>:IPERf:TDURation
driver.configure.data.measurement.iperf.set_tduration(test_duration = 1)

Defines the duration of the test.

param test_duration

Range: 1 s to 1E+6 s, Unit: s

set_type_py(iperf_type: float) → None[source]
# SCPI: CONFigure:DATA:MEASurement<Instance>:IPERf:TYPE
driver.configure.data.measurement.iperf.set_type_py(iperf_type = 1.0)

Selects the type of iperf to be used.

param iperf_type

IPERf | IP3 | IPNat Iperf or iperf3 or iperf(NAT)

set_wsize(window_size: float) → None[source]
# SCPI: CONFigure:DATA:MEASurement<Instance>:IPERf:WSIZe
driver.configure.data.measurement.iperf.set_wsize(window_size = 1.0)

No command help available

param window_size

No help available

Cloning the Group

# Create a clone of the original group, that exists independently
group2 = driver.configure.data.measurement.iperf.clone()

Subgroups