Difference between revisions of "NetworkUtils Object"

From Hubitat Documentation
Jump to: navigation, search
(Created page with "==Description== The package name of this class is hubitat.helper. So to use in an App or Driver you would reference it with hubitat.helper.NetworkUtils. == <code>ping</code>...")
 
(ping)
Line 17: Line 17:
  
 
  PingData - An object containing the following properties:
 
  PingData - An object containing the following properties:
Double rttAvg - Average Round Trip Time
+
  Double rttAvg - Average Round Trip Time
Double rttMin - Minimum Round Trip Time
+
  Double rttMin - Minimum Round Trip Time
Double rttMax - Maximum Round Trip Time
+
  Double rttMax - Maximum Round Trip Time
Integer packetsTransmitted - Ping requests sent
+
  Integer packetsTransmitted - Ping requests sent
Integer packetsReceived - Responses received
+
  Integer packetsReceived - Responses received
Integer packetLoss - Responses lost
+
  Integer packetLoss - Responses lost

Revision as of 15:35, 5 October 2021

Description

The package name of this class is hubitat.helper. So to use in an App or Driver you would reference it with hubitat.helper.NetworkUtils.

ping

Performs an ICMP ping and returns the results.

Signature

PingData ping(String IPAddress)
PingData ping(String IPAddress, Integer count)

Parameters

IPAddress - The IP Address to ping
count - The number of ping requests to send (defaults to 3, maximum is 5).

Returns

PingData - An object containing the following properties:
 Double rttAvg - Average Round Trip Time
 Double rttMin - Minimum Round Trip Time
 Double rttMax - Maximum Round Trip Time
 Integer packetsTransmitted - Ping requests sent
 Integer packetsReceived - Responses received
 Integer packetLoss - Responses lost