ping: make api compatible to WiFiNINA and WiFi101

Author: pennam

libraries/WiFiS3/examples/WiFiPing/WiFiPing.ino

@@ -71,11 +71,11 @@ void loop() {
   Serial.print("Trying to ping github.com on IP: ");
   Serial.println(remote_ip);
 
-  // using default ping count of 5
-  float res = WiFi.ping(remote_ip);
+  // using default ping count of 1
+  int res = WiFi.ping(remote_ip);
 
-  if (res != 0) {
-    Serial.print("Pin average response time: ");
+  if (res > 0) {
+    Serial.print("Ping response time: ");
     Serial.print(res);
     Serial.println(" ms");
   }
@@ -88,11 +88,11 @@ void loop() {
   Serial.print("Trying to ping host: ");
   Serial.println(remote_host);
 
-  // setting ping count to 10 instead of default 5
-  float res1 = WiFi.ping(remote_host,10);
+  // setting ttl to 128 and ping count to 10
+  int res1 = WiFi.ping(remote_host, 128, 10);
 
-  if (res1 != 0) {
-    Serial.print("Pin average response time: ");
+  if (res1 > 0) {
+    Serial.print("Ping average response time: ");
     Serial.print(res1);
     Serial.println(" ms");
   }

libraries/WiFiS3/src/WiFi.cpp

@@ -559,21 +559,21 @@ void CWifi::setTimeout(unsigned long timeout) {
 }
 
 /* -------------------------------------------------------------------------- */
-float CWifi::ping(IPAddress ip, unsigned int count) {
+int CWifi::ping(IPAddress ip, uint8_t ttl, uint8_t count) {
 /* -------------------------------------------------------------------------- */
-   return ping(ip.toString().c_str(), count);
+   return ping(ip.toString().c_str(), ttl, count);
 }
 
 /* -------------------------------------------------------------------------- */
-float CWifi::ping(const char* host, unsigned int count) {
+int CWifi::ping(const char* host, uint8_t ttl, uint8_t count) {
 /* -------------------------------------------------------------------------- */
+   int ret = WL_PING_ERROR;
    modem.begin();
    string res = "";
-   if (modem.write(string(PROMPT(_PING)), res, "%s,%s,%d\r\n", CMD_WRITE(_PING), host, count)) {
-      String rsl = res.c_str();
-      return rsl.toFloat();
+   if (modem.write(string(PROMPT(_PING)), res, "%s,%s,%d,%d\r\n", CMD_WRITE(_PING), host, ttl, count)) {
+      ret = atoi(res.c_str());
    }
-   return 0;
+   return ret;
 }
 
 CWifi WiFi;

libraries/WiFiS3/src/WiFi.h

@@ -61,8 +61,8 @@ class CWifi {
     /*
      * PING
      */
-    float ping(IPAddress ip, unsigned int count = 5);
-    float ping(const char* host, unsigned int count = 5);
+    int ping(IPAddress ip, uint8_t ttl = 128, uint8_t count = 1);
+    int ping(const char* host, uint8_t ttl = 128, uint8_t count = 1);
 
     /* 
      * Start WiFi connection for OPEN networks 

libraries/WiFiS3/src/WiFiTypes.h

@@ -31,4 +31,11 @@ enum wl_enc_type {
     ENC_TYPE_UNKNOWN = 255
 };
 
+typedef enum {
+  WL_PING_DEST_UNREACHABLE = -1,
+  WL_PING_TIMEOUT = -2,
+  WL_PING_UNKNOWN_HOST = -3,
+  WL_PING_ERROR = -4
+} wl_ping_result_t;
+
 #endif