Merge pull request #65 from andreagilardoni/ping

Add ping feature

Author: pennam

UNOR4USBBridge/cmds_esp_generic.h

@@ -2,6 +2,7 @@
 #define CMDS_ESP_GENERIC_H
 
 #include "at_handler.h"
+#include "ping.h"
 
 extern "C" {
    #include "esp32-hal-tinyusb.h"
@@ -360,7 +361,7 @@ void CAtHandler::add_cmds_esp_generic() {
             return chAT::CommandStatus::ERROR;
       }
    };
-   
+
    /* ....................................................................... */
    command_table[_GETTIME] = [this](auto & srv, auto & parser) {
    /* ....................................................................... */
@@ -386,6 +387,52 @@ void CAtHandler::add_cmds_esp_generic() {
             return chAT::CommandStatus::ERROR;
       }
    };
+
+/* ....................................................................... */
+   command_table[_PING] = [this](auto & srv, auto & parser) {
+/* ....................................................................... */
+      switch (parser.cmd_mode) {
+      case chAT::CommandMode::Write: {
+         if (parser.args.size() != 4) {
+            return chAT::CommandStatus::ERROR;
+         }
+
+         // get IP
+         auto &target = parser.args[1];
+         if (target.empty()) {
+            return chAT::CommandStatus::ERROR;
+         }
+
+         // get ttl
+         auto &ttl = parser.args[2];
+         if (ttl.empty()) {
+            return chAT::CommandStatus::ERROR;
+         }
+
+         // get count
+         auto &cnt = parser.args[3];
+         if (cnt.empty()) {
+            return chAT::CommandStatus::ERROR;
+         }
+
+         auto ping_res = execute_ping(target.c_str(), atoi(ttl.c_str()), atoi(cnt.c_str()));
+         char rsl[8];
+         if (ping_res.status == ping_status::SUCCESS) {
+           sprintf(rsl,"%.0f", ping_res.averagertt);
+         } else {
+           sprintf(rsl,"%d", ping_res.status);
+         }
+
+         srv.write_response_prompt();
+         srv.write_str((const char *) rsl);
+         srv.write_line_end();
+         return chAT::CommandStatus::OK;
+
+      }
+      default:
+         return chAT::CommandStatus::ERROR;
+      }
+   };
 }
 
 #endif

UNOR4USBBridge/commands.h

@@ -105,6 +105,8 @@ enum file_op {
 #define _UDPREMOTEPORT           "+UDPREMOTEPORT"
 #define _UDPSTOP                 "+UDPSTOP"
 
+#define _PING                    "+PING"
+
 #define _FWVERSION               "+FWVERSION"
 #define _FWVERSION_U32           "+FWVERSION_U32"
 

UNOR4USBBridge/ping.cpp

@@ -0,0 +1,92 @@
+#include "ping.h"
+#include <string.h>
+#include <Arduino.h>
+#include <lwip/inet.h>
+#include <lwip/ip_addr.h>
+#include <lwip/netdb.h>
+#include "ping/ping_sock.h"
+
+// we are assuming that ping is a blocking call that returns the results of a ping session
+// async operations are not taken into account as of now
+// one ping session can be performed
+
+static ping_statistics _stats;
+static esp_ping_handle_t esp_ping_handle = nullptr;
+
+static void ping_success(esp_ping_handle_t hdl, void *args) {
+    uint32_t elapsed_time;
+    esp_ping_get_profile(hdl, ESP_PING_PROF_TIMEGAP, &elapsed_time, sizeof(elapsed_time));
+    // streaming average on rtt
+    _stats.averagertt = _stats.averagertt + ((elapsed_time-_stats.averagertt)/++_stats.success_count);
+}
+
+static void ping_timeout(esp_ping_handle_t hdl, void *args) {
+    _stats.timedout_count++;
+}
+
+static void ping_end(esp_ping_handle_t hdl, void *args) {
+    esp_ping_stop(hdl);
+    esp_ping_delete_session(hdl);
+    if(_stats.success_count == 0) {
+        // all ping request have timed out
+        _stats.status = ping_status::TIMEOUT;
+    } else {
+        // at least one ping as succeded and we can return rtt value
+        _stats.status = ping_status::SUCCESS;
+    }
+}
+
+ping_statistics execute_ping(const char* address, uint8_t ttl, uint8_t count) {
+
+    ip_addr_t target_addr;
+    struct addrinfo hint;
+    struct addrinfo *res = NULL;
+    memset(&hint, 0, sizeof(hint));
+    memset(&target_addr, 0, sizeof(target_addr));
+    memset(&_stats, 0, sizeof(_stats));
+
+    if(getaddrinfo(address, NULL, &hint, &res) != 0) {
+        _stats.status = ping_status::DNS_RESOLUTION_ERROR;
+        return _stats;
+    }
+
+    struct in_addr addr4 = ((struct sockaddr_in *) (res->ai_addr))->sin_addr;
+    inet_addr_to_ip4addr(ip_2_ip4(&target_addr), &addr4);
+    freeaddrinfo(res);
+
+    esp_ping_config_t ping_config = ESP_PING_DEFAULT_CONFIG();
+    ping_config.target_addr = target_addr;          // target IP address
+    ping_config.ttl = ttl;
+
+    // for simplification we are not pinging indefinetly
+    ping_config.count = count > 0 ? count : 1;
+
+    /* set callback functions */
+    esp_ping_callbacks_t cbs;
+    cbs.on_ping_success = ping_success;
+    cbs.on_ping_timeout = ping_timeout;
+    cbs.on_ping_end     = ping_end;
+    cbs.cb_args         = NULL;
+
+    if(esp_ping_new_session(&ping_config, &cbs, &esp_ping_handle) != ESP_OK) {
+        _stats.status = ping_status::ERROR;
+        return _stats;
+    }
+
+    if(esp_ping_start(esp_ping_handle) != ESP_OK) {
+        _stats.status = ping_status::ERROR;
+        esp_ping_delete_session(esp_ping_handle);
+        return _stats;
+    }
+
+    _stats.status = ping_status::RUNNING;
+
+    // wait for the end of ping session
+    while(_stats.status == ping_status::RUNNING) {
+        delay(10);
+    }
+
+    // session is deleted inside ping_end() callback
+
+    return _stats;
+}

UNOR4USBBridge/ping.h

@@ -0,0 +1,20 @@
+#pragma once
+
+#include <stdint.h>
+
+enum class ping_status: int {
+    ERROR = -4,
+    DNS_RESOLUTION_ERROR = -3,
+    TIMEOUT = -2,
+    RUNNING = 0,
+    SUCCESS = 1
+};
+
+struct ping_statistics {
+    uint8_t success_count;
+    uint8_t timedout_count;
+    float averagertt;         // measured in ms
+    volatile ping_status status;
+};
+
+ping_statistics execute_ping(const char* address, uint8_t ttl, uint8_t count);