Fix OTA flow

Author: pennam

src/AIoTC_Config.h

@@ -151,4 +151,6 @@
 #define AIOT_CONFIG_RP2040_OTA_HTTP_HEADER_RECEIVE_TIMEOUT_ms (10*1000UL)
 #define AIOT_CONFIG_RP2040_OTA_HTTP_DATA_RECEIVE_TIMEOUT_ms   (4*60*1000UL)
 
+#define AIOT_CONFIG_LIB_VERSION "1.5.0"
+
 #endif /* ARDUINO_AIOTC_CONFIG_H_ */

src/ArduinoIoTCloud.cpp

@@ -32,6 +32,7 @@ ArduinoIoTCloudClass::ArduinoIoTCloudClass()
 , _tz_dst_until{0}
 , _thing_id{""}
 , _device_id{""}
+, _lib_version{AIOT_CONFIG_LIB_VERSION}
 , _cloud_event_callback{nullptr}
 , _thing_id_outdated{false}
 {

src/ArduinoIoTCloud.h

@@ -173,7 +173,7 @@ class ArduinoIoTCloudClass
     int _tz_offset;
     unsigned int _tz_dst_until;
     String _thing_id;
-
+    String _lib_version;
     void execCloudEventCallback(ArduinoIoTCloudEvent const event);
 
   private:

src/ArduinoIoTCloudTCP.cpp

@@ -250,6 +250,7 @@ int ArduinoIoTCloudTCP::begin(bool const enable_watchdog, String brokerAddress,
   _deviceTopicOut = getTopic_deviceout();
   _deviceTopicIn  = getTopic_devicein();
 
+  addPropertyReal(_lib_version, _device_property_container, "LIB_VERSION", Permission::Read);
 #if OTA_ENABLED
   addPropertyReal(_ota_cap, _device_property_container, "OTA_CAP", Permission::Read);
   addPropertyReal(_ota_error, _device_property_container, "OTA_ERROR", Permission::Read);
@@ -260,7 +261,6 @@ int ArduinoIoTCloudTCP::begin(bool const enable_watchdog, String brokerAddress,
 
   addPropertyReal(_tz_offset, _thing_property_container, "tz_offset", Permission::ReadWrite).onSync(CLOUD_WINS).onUpdate(updateTimezoneInfo);
   addPropertyReal(_tz_dst_until, _thing_property_container, "tz_dst_until", Permission::ReadWrite).onSync(CLOUD_WINS).onUpdate(updateTimezoneInfo);
-
   addPropertyReal(_thing_id, _device_property_container, "thing_id", Permission::ReadWrite).onUpdate(setThingIdOutdated);
 
 #if OTA_STORAGE_PORTENTA_QSPI
@@ -428,9 +428,7 @@ ArduinoIoTCloudTCP::State ArduinoIoTCloudTCP::handle_SendDeviceProperties()
 
   DEBUG_VERBOSE("ArduinoIoTCloudTCP::%s", __FUNCTION__);
 
-#if OTA_ENABLED
-  sendOTAPropertiesToCloud();
-#endif
+  sendDevicePropertiesToCloud();
   return State::SubscribeDeviceTopic;
 }
 
@@ -653,18 +651,20 @@ ArduinoIoTCloudTCP::State ArduinoIoTCloudTCP::handle_Connected()
         _ota_error = static_cast<int>(OTAError::None);
         /* Clear the request flag. */
         _ota_req = false;
-        /* Transmit the cleared error and request flags to the cloud. */
-        sendOTAPropertiesToCloud();
+        /* Transmit the cleared request flags to the cloud. */
+        sendClearedOTARequestToCloud();
         /* Call member function to handle OTA request. */
         onOTARequest();
+        /* If something fails send the OTA error to the cloud */
+        sendOTAErrorToCloud();
       }
     }
 #endif /* OTA_ENABLED */
 
     /* Check if any properties need encoding and send them to
     * the cloud if necessary.
     */
-    sendPropertiesToCloud();
+    sendThingPropertiesToCloud();
 
     unsigned long const internal_posix_time = _time_service.getTime();
     if(internal_posix_time < _tz_dst_until) {
@@ -700,7 +700,7 @@ void ArduinoIoTCloudTCP::handleMessage(int length)
 
   /* Topic for OTA properties and device configuration */
   if (_deviceTopicIn == topic) {
-    CBORDecoder::decode(_device_property_container, (uint8_t*)bytes, length);
+    CBORDecoder::decode(_device_property_container, (uint8_t*)bytes, length, true);
     DEBUG_VERBOSE("ArduinoIoTCloudTCP::%s [%d] device configuration or OTA message received", __FUNCTION__, millis());
     _last_device_subscribe_cnt = 0;
     _next_device_subscribe_attempt_tick = 0;
@@ -716,7 +716,6 @@ void ArduinoIoTCloudTCP::handleMessage(int length)
   {
     DEBUG_VERBOSE("ArduinoIoTCloudTCP::%s [%d] last values received", __FUNCTION__, millis());
     CBORDecoder::decode(_thing_property_container, (uint8_t*)bytes, length, true);
-    sendPropertiesToCloud();
     _time_service.setTimeZoneData(_tz_offset, _tz_dst_until);
     execCloudEventCallback(ArduinoIoTCloudEvent::SYNC);
     _last_sync_request_cnt = 0;
@@ -744,19 +743,53 @@ void ArduinoIoTCloudTCP::sendPropertyContainerToCloud(String const topic, Proper
     }
 }
 
-void ArduinoIoTCloudTCP::sendPropertiesToCloud()
+void ArduinoIoTCloudTCP::sendThingPropertiesToCloud()
 {
   sendPropertyContainerToCloud(_dataTopicOut, _thing_property_container);
 }
 
+void ArduinoIoTCloudTCP::sendDevicePropertiesToCloud()
+{
+  PropertyContainer ro_device_property_container;
+
+  std::list<String> ro_device_property_list {"LIB_VERSION", "OTA_CAP", "OTA_ERROR", "OTA_SHA256"};
+  std::for_each(ro_device_property_list.begin(),
+                ro_device_property_list.end(),
+                [this, &ro_device_property_container ] (String const & name)
+                {
+                  Property* p = getProperty(this->_device_property_container, name);
+                  if(p != nullptr)
+                    addPropertyToContainer(ro_device_property_container, *p, p->name(), p->isWriteableByCloud() ? Permission::ReadWrite : Permission::Read);
+                }
+                );
+
+  sendPropertyContainerToCloud(_deviceTopicOut, ro_device_property_container);
+}
+
 #if OTA_ENABLED
-void ArduinoIoTCloudTCP::sendOTAPropertiesToCloud(bool include_ota_req)
+void ArduinoIoTCloudTCP::sendClearedOTARequestToCloud()
+{
+  PropertyContainer ota_property_container;
+
+  std::list<String> ota_property_list {"OTA_REQ"};
+  std::for_each(ota_property_list.begin(),
+                ota_property_list.end(),
+                [this, &ota_property_container ] (String const & name)
+                {
+                  Property* p = getProperty(this->_device_property_container, name);
+                  if(p != nullptr)
+                    addPropertyToContainer(ota_property_container, *p, p->name(), p->isWriteableByCloud() ? Permission::ReadWrite : Permission::Read);
+                }
+                );
+
+  sendPropertyContainerToCloud(_deviceTopicOut, ota_property_container);
+}
+
+void ArduinoIoTCloudTCP::sendOTAErrorToCloud()
 {
   PropertyContainer ota_property_container;
 
-  std::list<String> ota_property_list {"OTA_CAP", "OTA_ERROR", "OTA_SHA256"};
-  if (include_ota_req)
-    ota_property_list.push_back("OTA_REQ");
+  std::list<String> ota_property_list {"OTA_ERROR"};
   std::for_each(ota_property_list.begin(),
                 ota_property_list.end(),
                 [this, &ota_property_container ] (String const & name)

src/ArduinoIoTCloudTCP.h

@@ -186,13 +186,15 @@ class ArduinoIoTCloudTCP: public ArduinoIoTCloudClass
     static void onMessage(int length);
     void handleMessage(int length);
     void sendPropertyContainerToCloud(String const topic, PropertyContainer & property_container);
-    void sendPropertiesToCloud();
+    void sendThingPropertiesToCloud();
+    void sendDevicePropertiesToCloud();
     void requestLastValue();
     int write(String const topic, byte const data[], int const length);
 
 #if OTA_ENABLED
     void onOTARequest();
-    void sendOTAPropertiesToCloud(bool include_ota_req = false);
+    void sendClearedOTARequestToCloud();
+    void sendOTAErrorToCloud();
 #endif
 
     void updateThingTopics();