Ping¶

SCPI Commands

CONFigure:DATA:MEASurement<MeasInstance>:PING:TIMeout
CONFigure:DATA:MEASurement<MeasInstance>:PING:DIPaddress
CONFigure:DATA:MEASurement<MeasInstance>:PING:PSIZe
CONFigure:DATA:MEASurement<MeasInstance>:PING:PCOunt
CONFigure:DATA:MEASurement<MeasInstance>:PING:INTerval

class Ping[source]

Ping commands group definition. 5 total commands, 0 Sub-groups, 5 group commands

get_dip_address() → str[source]

# SCPI: CONFigure:DATA:MEASurement<Instance>:PING:DIPaddress
value: str = driver.configure.data.measurement.ping.get_dip_address()

Specifies the destination IP address for the ping command.

return

ip_address: IPv4 or IPv6 address as string

get_interval() → float[source]

# SCPI: CONFigure:DATA:MEASurement<Instance>:PING:INTerval
value: float = driver.configure.data.measurement.ping.get_interval()

Specifies the interval between two ping requests.

return

interval: Range: 0.2 s to 10 s, Unit: s

get_pcount() → int[source]

# SCPI: CONFigure:DATA:MEASurement<Instance>:PING:PCOunt
value: int = driver.configure.data.measurement.ping.get_pcount()

Specifies the number of echo request packets to be sent.

return

ping_count: Range: 1 to 1000

get_psize() → int[source]

# SCPI: CONFigure:DATA:MEASurement<Instance>:PING:PSIZe
value: int = driver.configure.data.measurement.ping.get_psize()

Specifies the payload size of echo request packets.

return

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

get_timeout() → float[source]

# SCPI: CONFigure:DATA:MEASurement<Instance>:PING:TIMeout
value: float = driver.configure.data.measurement.ping.get_timeout()

Specifies a timeout for ping requests.

return

timeout: Range: 1 s to 9 s, Unit: s

set_dip_address(ip_address: str) → None[source]

# SCPI: CONFigure:DATA:MEASurement<Instance>:PING:DIPaddress
driver.configure.data.measurement.ping.set_dip_address(ip_address = '1')

Specifies the destination IP address for the ping command.

param ip_address

IPv4 or IPv6 address as string

set_interval(interval: float) → None[source]

# SCPI: CONFigure:DATA:MEASurement<Instance>:PING:INTerval
driver.configure.data.measurement.ping.set_interval(interval = 1.0)

Specifies the interval between two ping requests.

param interval

Range: 0.2 s to 10 s, Unit: s

set_pcount(ping_count: int) → None[source]

# SCPI: CONFigure:DATA:MEASurement<Instance>:PING:PCOunt
driver.configure.data.measurement.ping.set_pcount(ping_count = 1)

Specifies the number of echo request packets to be sent.

param ping_count

Range: 1 to 1000

set_psize(packet_size: int) → None[source]

# SCPI: CONFigure:DATA:MEASurement<Instance>:PING:PSIZe
driver.configure.data.measurement.ping.set_psize(packet_size = 1)

Specifies the payload size of echo request packets.

param packet_size

Range: 0 bytes to 65507 bytes , Unit: bytes

set_timeout(timeout: float) → None[source]

# SCPI: CONFigure:DATA:MEASurement<Instance>:PING:TIMeout
driver.configure.data.measurement.ping.set_timeout(timeout = 1.0)

Specifies a timeout for ping requests.

param timeout

Range: 1 s to 9 s, Unit: s