Merge pull request #8119 from s-hadinger/ping

Add command ``Ping`` (#7176)

tasmota/CHANGELOG.md

@@ -23,6 +23,7 @@
 - Add more accuracy to GPS NTP server (#8088)
 - Add support for an iAQ sensor (#8107)
 - Add support for Seven Segment display using HT16K33 (#8116)
+- Add command ``Ping`` (#7176)
 
 ### 8.2.0.2 20200328
 

tasmota/i18n.h

@@ -563,6 +563,10 @@
 #define D_CMND_BRI_PRESET "BriPreset"
 #endif
 
+// Commands xdrv_38_ping.ino
+#define D_CMND_PING "Ping"
+#define D_JSON_PING "Ping"
+
 // Commands xsns_02_analog.ino
 #define D_CMND_ADCPARAM "AdcParam"
 

tasmota/my_user_config.h

@@ -389,6 +389,9 @@
   #define USE_SUNRISE                            // Add support for Sunrise and sunset tools (+16k)
     #define SUNRISE_DAWN_ANGLE DAWN_NORMAL       // Select desired Dawn Angle from (DAWN_NORMAL, DAWN_CIVIL, DAWN_NAUTIC, DAWN_ASTRONOMIC)
 
+// -- Ping ----------------------------------------
+//  #define USE_PING                                 // Enable Ping command (+3k code)
+
 // -- Rules or Script  ----------------------------
 // Select none or only one of the below defines
 #define USE_RULES                                // Add support for rules (+8k code)

tasmota/xdrv_38_ping.ino

@@ -0,0 +1,169 @@
+/*
+  xdrv_38_ping.ino - support for ICMP Ping
+
+  Copyright (C) 2020  Theo Arends and Stephan Hadinger
+
+  This program is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#ifdef USE_PING
+
+#define XDRV_38                    38
+
+#include <ping.h>
+#include <vector>
+
+const char kPingCommands[] PROGMEM =  "|"    // no prefix
+  D_CMND_PING
+  ;
+
+void (* const PingCommand[])(void) PROGMEM = {
+  &CmndPing,
+  };
+
+// inspired by https://github.com/dancol90/ESP8266Ping
+
+typedef struct Ping_t {
+  ping_option opt;                // extend the ping_option structure with internal values
+  uint16_t    total_count;        // total count if packets sent
+  uint16_t    timeout_count;      // time-outs (no responses)
+  uint32_t    min_time;           // minimum time in ms for a successful response
+  uint32_t    max_time;           // maximum time in ms for a successful response
+  uint32_t    sum_time;           // cumulated time in ms for all successful responses (used to compute the average)
+  bool        done;               // indicates the ping campaign is finished
+} Ping_t;
+
+std::vector<Ping_t*>    pings = {};
+
+extern "C" {
+  // callbacks for ping
+
+  // called after a ping response is received or time-out
+  void ICACHE_RAM_ATTR ping_recv_cb(Ping_t *ping, struct ping_resp *p_resp) {
+    // If successful
+    if (p_resp->ping_err >= 0) {
+      uint32_t resp_time = p_resp->resp_time;
+      ping->sum_time += resp_time;
+      if (resp_time < ping->min_time) { ping->min_time = resp_time; }
+      if (resp_time > ping->max_time) { ping->max_time = resp_time; }
+    }
+  }
+
+  // called after the ping campaign is finished
+  void ICACHE_RAM_ATTR ping_sent_cb(Ping_t *ping, struct ping_resp *p_resp) {
+    // copy counters to build the MQTT response
+    ping->total_count = p_resp->total_count;
+    ping->timeout_count = p_resp->timeout_count;
+    ping->done = true;
+  }
+}
+
+// Check if any ping requests is completed, and publish the results
+void PingResponsePoll(void) {
+  for (auto it = pings.begin(); it != pings.end(); it++) {
+    Ping_t *ping = *it;
+    if (ping->done) {
+      uint32_t success = ping->total_count - ping->timeout_count;
+      uint32_t ip = ping->opt.ip;
+
+      // Serial.printf(
+      //         "DEBUG ping_sent_cb: ping reply\n"
+      //         "\tsuccess_count = %d \n"
+      //         "\ttimeout_count = %d \n"
+      //         "\tmin_time = %d \n"
+      //         "\tmax_time = %d \n"
+      //         "\tavg_time = %d \n",
+      //         success, ping->timeout_count,
+      //         ping->min_time, ping->max_time,
+      //         success ? ping->sum_time / success : 0
+      // );
+
+      Response_P(PSTR("{\"" D_JSON_PING "\":{\"%d.%d.%d.%d\":{"
+                      "\"Reachable\":%s"
+                      ",\"Success\":%d"
+                      ",\"Timeout\":%d"
+                      ",\"MinTime\":%d"
+                      ",\"MaxTime\":%d"
+                      ",\"AvgTime\":%d"
+                      "}}}"),
+                      ip & 0xFF, (ip >> 8) & 0xFF, (ip >> 16) & 0xFF, ip >> 24,
+                      success ? "true" : "false",
+                      success, ping->timeout_count,
+                      ping->min_time, ping->max_time,
+                      success ? ping->sum_time / success : 0
+                      );
+      MqttPublishPrefixTopic_P(RESULT_OR_TELE, PSTR(D_JSON_PING));
+      XdrvRulesProcess();
+      
+      pings.erase(it--);    // remove from list
+      delete ping;          // free memory allocated
+    }
+  }
+}
+
+void CmndPing(void) {
+  uint32_t count = XdrvMailbox.index;
+  IPAddress ip;
+
+  RemoveSpace(XdrvMailbox.data);
+  if (count > 60) { count = 60; }
+
+  if (WiFi.hostByName(XdrvMailbox.data, ip)) {
+    Ping_t *ping = new Ping_t();
+    memset(ping, 0, sizeof(Ping_t ));
+    ping->min_time = UINT32_MAX;
+
+    ping_option &opt = ping->opt;
+    opt.count = count;
+    opt.coarse_time = 1;    // wait 1 second between messages
+    opt.ip = ip;
+
+    // callbacks
+    opt.recv_function = (ping_recv_function) ping_recv_cb;    // at each response or time-out
+    opt.sent_function = (ping_sent_function) ping_sent_cb;    // when all packets have been sent and reveived
+
+    if (ping_start(&opt)) {
+      pings.push_back(ping);
+      ResponseCmndDone();
+    } else {
+      ResponseCmndChar_P(PSTR("Unable to send Ping"));
+      delete ping;
+    }
+  } else {
+    ResponseCmndChar_P(PSTR("Unable to resolve IP address"));
+  }
+
+}
+
+
+/*********************************************************************************************\
+ * Interface
+\*********************************************************************************************/
+
+bool Xdrv38(uint8_t function)
+{
+  bool result = false;
+
+  switch (function) {
+    case FUNC_EVERY_250_MSECOND:
+    PingResponsePoll();
+    break;
+    case FUNC_COMMAND:
+    result = DecodeCommand(kPingCommands, PingCommand);
+    break;
+  }
+  return result;
+}
+
+#endif // USE_PING