Difference between revisions of "NetworkUtils Object"

From Hubitat Documentation
Jump to: navigation, search
(ping)
 
Line 1: Line 1:
==Description==
+
<big>'''We're moving!''' Please visit http://docs2.hubitat.com for the latest documentation.</big>
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> ==
+
<big>
Performs an ICMP ping and returns the results.
+
This document is available at: http://docs2.hubitat.com/en/developer/networkutils-object
 
+
</big>
'''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
 

Latest revision as of 19:49, 25 September 2022

We're moving! Please visit http://docs2.hubitat.com for the latest documentation.

This document is available at: http://docs2.hubitat.com/en/developer/networkutils-object