Adding various verbose debug output which can be disabled by disabling the DBG_VERBOSE macro within AIoTC_Config.h

Author: aentinger

src/utility/ota/OTALogic.cpp

@@ -30,6 +30,7 @@
 
 #ifndef HOST
   #include <Arduino.h>
+  #include <Arduino_DebugUtils.h>
 #else
   #include <algorithm> /* for std::min, otherwise Arduino defines min() */
   using namespace std;
@@ -123,6 +124,7 @@ void OTALogic::onOTADataReceived(uint8_t const * const data, size_t const length
 
 OTAState OTALogic::handle_Init()
 {
+  DBG_VERBOSE(__func__);
   if (_ota_storage->init()) {
     return OTAState::Idle;
   } else {
@@ -141,6 +143,7 @@ OTAState OTALogic::handle_Idle()
 
 OTAState OTALogic::handle_StartDownload()
 {
+  DBG_VERBOSE(__func__);
   if(_ota_storage->open("UPDATE.BIN.TMP")) {
     return OTAState::WaitForHeader;
   } else {
@@ -151,6 +154,7 @@ OTAState OTALogic::handle_StartDownload()
 
 OTAState OTALogic::handle_WaitForHeader()
 {
+  DBG_VERBOSE(__func__);
   if(_mqtt_ota_buf.num_bytes >= OTA_BINARY_HEADER_SIZE) {
     return OTAState::HeaderReceived;
   }
@@ -159,6 +163,7 @@ OTAState OTALogic::handle_WaitForHeader()
 
 OTAState OTALogic::handle_HeaderReceived()
 {
+  DBG_VERBOSE(__func__);
   /* The OTA header has been received, let's extract it
    * from the MQTT OTA receive buffer.
    */
@@ -179,6 +184,9 @@ OTAState OTALogic::handle_HeaderReceived()
   _ota_bin_data.hdr_len   = ota_header.header.len;
   _ota_bin_data.hdr_crc32 = ota_header.header.crc32;
 
+  DBG_VERBOSE("%s: OTA binary len = %d", __func__, _ota_bin_data.hdr_len);
+  DBG_VERBOSE("%s: OTA binary crc32 = %X", __func__, _ota_bin_data.hdr_crc32);
+
   /* Reset the counter which is responsible for keeping tabs on how many bytes have been received */
   _ota_bin_data.bytes_received = 0;
 
@@ -218,6 +226,8 @@ OTAState OTALogic::handle_BinaryReceived()
   _ota_bin_data.bytes_received += _mqtt_ota_buf.num_bytes;
   _mqtt_ota_buf.num_bytes = 0;
 
+  DBG_VERBOSE("%s: %d bytes received", __func__, _ota_bin_data.bytes_received);
+
   if(_ota_bin_data.bytes_received >= _ota_bin_data.hdr_len) {
     _ota_storage->close();
     _ota_bin_data.crc32 = crc_finalize(_ota_bin_data.crc32);
@@ -229,6 +239,7 @@ OTAState OTALogic::handle_BinaryReceived()
 
 OTAState OTALogic::handle_Verify()
 {
+  DBG_VERBOSE(__func__);
   if(_ota_bin_data.crc32 == _ota_bin_data.hdr_crc32) {
     return OTAState::Rename;
   } else {
@@ -240,6 +251,7 @@ OTAState OTALogic::handle_Verify()
 
 OTAState OTALogic::handle_Rename()
 {
+  DBG_VERBOSE(__func__);
   if(_ota_storage->rename("UPDATE.BIN.TMP", "UPDATE.BIN")) {
     _ota_storage->deinit();
     return OTAState::Reset;
@@ -252,6 +264,7 @@ OTAState OTALogic::handle_Rename()
 
 OTAState OTALogic::handle_Reset()
 {
+  DBG_VERBOSE(__func__);
 #if !defined(HOST) && !defined(ESP8266)
   /* After completion of the reset a second stage bootloader
    * such as the SFU is examining the OTA storage medium for