Replace compile-time configuration of watchdog (compiled in/out) with parameter in 'begin' function.

The watchdog is now always compiled in, but can be disabled when setting the parameter 'enable_watchdog' too false. The parameter is set to true by default.

Author: aentinger

src/AIoTC_Config.h

@@ -87,12 +87,6 @@
  * AUTOMATICALLY CONFIGURED DEFINES
  ******************************************************************************/
 
-#ifdef ARDUINO_ARCH_SAMD
-#  define WATCHDOG_ENABLED  (1)
-#else
-#  define WATCHDOG_ENABLED  (0)
-#endif
-
 #if defined(ARDUINO_SAMD_MKRWIFI1010) || defined(ARDUINO_SAMD_NANO_33_IOT) || \
   defined(ARDUINO_AVR_UNO_WIFI_REV2)
   #define OTA_STORAGE_SNU         (1)

src/ArduinoIoTCloudTCP.cpp

@@ -104,16 +104,16 @@ ArduinoIoTCloudTCP::ArduinoIoTCloudTCP()
  * PUBLIC MEMBER FUNCTIONS
  ******************************************************************************/
 
-int ArduinoIoTCloudTCP::begin(ConnectionHandler & connection, String brokerAddress, uint16_t brokerPort)
+int ArduinoIoTCloudTCP::begin(ConnectionHandler & connection, bool const enable_watchdog, String brokerAddress, uint16_t brokerPort)
 {
   _connection = &connection;
   _brokerAddress = brokerAddress;
   _brokerPort = brokerPort;
   _time_service.begin(&connection);
-  return begin(_brokerAddress, _brokerPort);
+  return begin(enable_watchdog, _brokerAddress, _brokerPort);
 }
 
-int ArduinoIoTCloudTCP::begin(String brokerAddress, uint16_t brokerPort)
+int ArduinoIoTCloudTCP::begin(bool const enable_watchdog, String brokerAddress, uint16_t brokerPort)
 {
   _brokerAddress = brokerAddress;
   _brokerPort = brokerPort;
@@ -275,7 +275,9 @@ int ArduinoIoTCloudTCP::begin(String brokerAddress, uint16_t brokerPort)
    * call to ArduinoIoTCloudTCP::update() it is wise to
    * set a rather large timeout at first.
    */
-  Watchdog.enable(SAMD_WATCHDOG_MAX_TIME_ms);
+  if (enable_watchdog) {
+    samd_watchdog_enable();
+  }
 #endif /* ARDUINO_ARCH_SAMD */
 
   return 1;
@@ -287,7 +289,7 @@ void ArduinoIoTCloudTCP::update()
   /* Feed the watchdog. If any of the functions called below
    * get stuck than we can at least reset and recover.
    */
-  Watchdog.reset();
+  samd_watchdog_reset();
 #endif /* ARDUINO_ARCH_SAMD */
 
   /* Run through the state machine. */
@@ -546,7 +548,7 @@ int ArduinoIoTCloudTCP::write(String const topic, byte const data[], int const l
 void ArduinoIoTCloudTCP::onOTARequest()
 {
 #ifdef ARDUINO_ARCH_SAMD
-  Watchdog.reset();
+  samd_watchdog_reset();
 #endif /* ARDUINO_ARCH_SAMD */
 
   DEBUG_VERBOSE("ArduinoIoTCloudTCP::%s _ota_url = %s", __FUNCTION__, _ota_url.c_str());
@@ -557,7 +559,7 @@ void ArduinoIoTCloudTCP::onOTARequest()
   WiFiStorage.remove("/fs/UPDATE.BIN.LZSS.TMP");
 
 #ifdef ARDUINO_ARCH_SAMD
-  Watchdog.reset();
+  samd_watchdog_reset();
 #endif /* ARDUINO_ARCH_SAMD */
 
   /* Trigger direct download to nina module. */

src/ArduinoIoTCloudTCP.h

@@ -66,11 +66,11 @@ class ArduinoIoTCloudTCP: public ArduinoIoTCloudClass
     virtual void printDebugInfo() override;
 
     #if defined(BOARD_HAS_ECCX08) || defined(BOARD_HAS_OFFLOADED_ECCX08)
-    int begin(ConnectionHandler & connection, String brokerAddress = DEFAULT_BROKER_ADDRESS_SECURE_AUTH, uint16_t brokerPort = DEFAULT_BROKER_PORT_SECURE_AUTH);
+    int begin(ConnectionHandler & connection, bool const enable_watchdog = true, String brokerAddress = DEFAULT_BROKER_ADDRESS_SECURE_AUTH, uint16_t brokerPort = DEFAULT_BROKER_PORT_SECURE_AUTH);
     #else
-    int begin(ConnectionHandler & connection, String brokerAddress = DEFAULT_BROKER_ADDRESS_USER_PASS_AUTH, uint16_t brokerPort = DEFAULT_BROKER_PORT_USER_PASS_AUTH);
+    int begin(ConnectionHandler & connection, bool const enable_watchdog = true, String brokerAddress = DEFAULT_BROKER_ADDRESS_USER_PASS_AUTH, uint16_t brokerPort = DEFAULT_BROKER_PORT_USER_PASS_AUTH);
     #endif
-    int begin(String brokerAddress = DEFAULT_BROKER_ADDRESS_SECURE_AUTH, uint16_t brokerPort = DEFAULT_BROKER_PORT_SECURE_AUTH);
+    int begin(bool const enable_watchdog = true, String brokerAddress = DEFAULT_BROKER_ADDRESS_SECURE_AUTH, uint16_t brokerPort = DEFAULT_BROKER_PORT_SECURE_AUTH);
 
     #ifdef BOARD_ESP
     inline void setBoardId        (String const device_id) { setDeviceId(device_id); }

src/utility/watchdog/Watchdog.cpp

@@ -21,12 +21,30 @@
 
 #include "Watchdog.h"
 
+/******************************************************************************
+ * GLOBAL VARIABLES
+ ******************************************************************************/
+
+static bool is_watchdog_enabled = false;
+
 /******************************************************************************
  * FUNCTION DEFINITION
  ******************************************************************************/
 
-#if WATCHDOG_ENABLED
-#  ifdef ARDUINO_ARCH_SAMD
+#ifdef ARDUINO_ARCH_SAMD
+void samd_watchdog_enable()
+{
+  is_watchdog_enabled = true;
+  Watchdog.enable(SAMD_WATCHDOG_MAX_TIME_ms);
+}
+
+void samd_watchdog_reset()
+{
+  if (is_watchdog_enabled) {
+    Watchdog.reset();
+  }
+}
+
 /* This function is called within the WiFiNINA library when invoking
  * the method 'connectBearSSL' in order to prevent a premature bite
  * of the watchdog (max timeout on SAMD is 16 s). wifi_nina_feed...
@@ -35,7 +53,6 @@
  */
 void wifi_nina_feed_watchdog()
 {
-    Watchdog.reset();
+  samd_watchdog_reset();
 }
-#  endif /* ARDUINO_ARCH_SAMD */
-#endif /* WATCHDOG_ENABLED */
+#endif /* ARDUINO_ARCH_SAMD */

src/utility/watchdog/Watchdog.h

@@ -24,11 +24,22 @@
 
 #include <AIoTC_Config.h>
 
-#if WATCHDOG_ENABLED
-#  ifdef ARDUINO_ARCH_SAMD
-#    include <Adafruit_SleepyDog.h>
-#    define SAMD_WATCHDOG_MAX_TIME_ms (16 * 1000)
-#  endif /* ARDUINO_ARCH_SAMD */
-#endif /* WATCHDOG_ENABLED */
+/******************************************************************************
+ * PREPROCESSOR SECTION
+ ******************************************************************************/
+
+#ifdef ARDUINO_ARCH_SAMD
+#  include <Adafruit_SleepyDog.h>
+#  define SAMD_WATCHDOG_MAX_TIME_ms (16 * 1000)
+#endif /* ARDUINO_ARCH_SAMD */
+
+/******************************************************************************
+ * FUNCTION DECLARATION
+ ******************************************************************************/
+
+#ifdef ARDUINO_ARCH_SAMD
+void samd_watchdog_enable();
+void samd_watchdog_reset();
+#endif /* ARDUINO_ARCH_SAMD */
 
 #endif /* ARDUINO_AIOTC_UTILITY_WATCHDOG_H_ */