ArduinoIoTCloudTCP: switch to messages

Author: pennam

src/ArduinoIoTCloudTCP.cpp

@@ -33,6 +33,7 @@
 #include "cbor/CBOREncoder.h"
 #include "cbor/CBORDecoder.h"
 #include "utility/watchdog/Watchdog.h"
+#include <typeinfo>
 
 /******************************************************************************
    LOCAL MODULE FUNCTIONS
@@ -51,7 +52,6 @@ ArduinoIoTCloudTCP::ArduinoIoTCloudTCP()
 : _state{State::ConnectPhy}
 , _device_id{""}
 , _thing_id{""}
-, _thing_id_property{nullptr}
 , _connection_attempt(0,0)
 , _mqtt_data_buf{0}
 , _mqtt_data_len{0}
@@ -60,23 +60,15 @@ ArduinoIoTCloudTCP::ArduinoIoTCloudTCP()
 , _password("")
 #endif
 , _mqttClient{nullptr}
-, _deviceTopicOut("")
-, _deviceTopicIn("")
-, _shadowTopicOut("")
-, _shadowTopicIn("")
+, _messageTopicOut("")
+, _messageTopicIn("")
 , _dataTopicOut("")
 , _dataTopicIn("")
 , _message_stream(std::bind(&ArduinoIoTCloudTCP::sendMessage, this, std::placeholders::_1))
 , _thing(&_message_stream)
 , _device(&_message_stream)
 #if OTA_ENABLED
 , _ota(&_message_stream)
-, _ota_cap{false}
-, _ota_error{static_cast<int>(ota::OTAError::None)}
-, _ota_img_sha256{"Inv."}
-, _ota_url{""}
-, _ota_progress{"Resume"}
-, _ota_req{false}
 , _ask_user_before_executing_ota{false}
 , _get_ota_confirmation{nullptr}
 #endif /* OTA_ENABLED */
@@ -166,43 +158,19 @@ int ArduinoIoTCloudTCP::begin(bool const enable_watchdog, String brokerAddress,
     _mqttClient.setUsernamePassword(getDeviceId(), _password);
   }
 #endif
+
   _mqttClient.onMessage(ArduinoIoTCloudTCP::onMessage);
   _mqttClient.setKeepAliveInterval(30 * 1000);
   _mqttClient.setConnectionTimeout(1500);
   _mqttClient.setId(getDeviceId().c_str());
 
-  _deviceTopicOut = getTopic_deviceout();
-  _deviceTopicIn  = getTopic_devicein();
-
-  Property* p;
-  p = new CloudWrapperString(_lib_version);
-  addPropertyToContainer(_device.getPropertyContainer(), *p, "LIB_VERSION", Permission::Read, -1);
-  p = new CloudWrapperString(_thing_id);
-  _thing_id_property = &addPropertyToContainer(_device.getPropertyContainer(), *p, "thing_id", Permission::ReadWrite, -1);
+  _messageTopicOut = getTopic_messageout();
+  _messageTopicIn  = getTopic_messagein();
 
   _thing.begin();
   _device.begin();
 
 #if  OTA_ENABLED
-  p = new CloudWrapperBool(_ota_cap);
-  addPropertyToContainer(_device.getPropertyContainer(), *p, "OTA_CAP", Permission::Read, -1).publishOnChange(0.0f, 0);
-  p = new CloudWrapperInt(_ota_error);
-  addPropertyToContainer(_device.getPropertyContainer(), *p, "OTA_ERROR", Permission::Read, -1).publishOnChange(0.0f, 0);
-  p = new CloudWrapperString(_ota_progress);
-  addPropertyToContainer(_device.getPropertyContainer(), *p, "OTA_PROGRESS", Permission::Read, -1).publishOnChange(0.0f, 0);
-  p = new CloudWrapperString(_ota_img_sha256);
-  addPropertyToContainer(_device.getPropertyContainer(), *p, "OTA_SHA256", Permission::Read, -1).publishOnChange(0.0f, 0);
-  p = new CloudWrapperString(_ota_url);
-  _ota_url_property = &addPropertyToContainer(_device.getPropertyContainer(), *p, "OTA_URL", Permission::ReadWrite, -1).publishOnChange(0.0f, 0).writeOnDemand();
-  p = new CloudWrapperBool(_ota_req);
-  addPropertyToContainer(_device.getPropertyContainer(), *p, "OTA_REQ", Permission::ReadWrite, -1).publishOnChange(0.0f, 0);
-
-  _ota_cap =_ota.isOtaCapable();
-
-  // Sha256 is calculated when the ota fsm reaches its second state
-  _ota.update();
-  _ota.update();
-
   _ota.setClient(&_otaClient);
 #endif // OTA_ENABLED
 
@@ -313,6 +281,7 @@ ArduinoIoTCloudTCP::State ArduinoIoTCloudTCP::handle_ConnectMqttBroker()
 {
   if (_mqttClient.connect(_brokerAddress.c_str(), _brokerPort))
   {
+    _mqttClient.subscribe(getTopic_messagein());
     DEBUG_VERBOSE("ArduinoIoTCloudTCP::%s connected to %s:%d", __FUNCTION__, _brokerAddress.c_str(), _brokerPort);
     /* Reconfigure timers for next state */
     _connection_attempt.begin(AIOT_CONFIG_DEVICE_TOPIC_SUBSCRIBE_RETRY_DELAY_ms, AIOT_CONFIG_MAX_DEVICE_TOPIC_SUBSCRIBE_RETRY_DELAY_ms);
@@ -336,8 +305,8 @@ ArduinoIoTCloudTCP::State ArduinoIoTCloudTCP::handle_Connected()
   }
 
   _device.update();
+
 #if  OTA_ENABLED
-   handle_OTARequest();
   _ota.update();
 #endif // OTA_ENABLED
 
@@ -356,53 +325,11 @@ ArduinoIoTCloudTCP::State ArduinoIoTCloudTCP::handle_Connected()
   return State::Connected;
 }
 
-#if OTA_ENABLED
-void ArduinoIoTCloudTCP::handle_OTARequest() {
-  /* Request a OTA download if the hidden property
-  * OTA request has been set.
-  */
-
-  if (_ota_req)
-  {
-    bool const ota_execution_allowed_by_user = (_get_ota_confirmation != nullptr && _get_ota_confirmation());
-    bool const perform_ota_now = ota_execution_allowed_by_user || !_ask_user_before_executing_ota;
-    if (perform_ota_now) {
-      /* Clear the error flag. */
-      _ota_error = static_cast<int>(ota::OTAError::None);
-      /* Clear the request flag. */
-      _ota_req = false;
-      /* Transmit the cleared request flags to the cloud. */
-      sendDevicePropertyToCloud("OTA_REQ");
-      /* Call member function to handle OTA request. */
-      //_ota_error = OTA::onRequest(_ota_url, _connection->getInterface());
-      /* If something fails send the OTA error to the cloud */
-      sendDevicePropertyToCloud("OTA_ERROR");
-
-      struct OtaUpdateCmdDown cmd = {
-        OtaUpdateCmdDownId,
-        "123456",
-      };
-
-      strncpy(cmd.params.url, _ota_url.c_str(), URL_SIZE);
-
-      _ota.handleMessage((Message*) &cmd);
-    }
-  }
-
-  /* Check if we have received the OTA_URL property and provide
-  * echo to the cloud.
-  */
-  sendDevicePropertyToCloud("OTA_URL");
-}
-#endif /* OTA_ENABLED */
-
-
 ArduinoIoTCloudTCP::State ArduinoIoTCloudTCP::handle_Disconnect()
 {
   if (!_mqttClient.connected()) {
     DEBUG_ERROR("ArduinoIoTCloudTCP::%s MQTT client connection lost", __FUNCTION__);
   } else {
-    _mqttClient.unsubscribe(_shadowTopicIn);
     _mqttClient.unsubscribe(_dataTopicIn);
     /* TODO add device topic */
     _mqttClient.stop();
@@ -435,82 +362,88 @@ void ArduinoIoTCloudTCP::handleMessage(int length)
     bytes[i] = _mqttClient.read();
   }
 
-  /* Topic for OTA properties and device configuration */
-  if (_deviceTopicIn == topic) {
-    CBORDecoder::decode(_device.getPropertyContainer(), (uint8_t*)bytes, length);
-    /* Unlock device state machine waiting thing_id*/
-    DEBUG_VERBOSE("ArduinoIoTCloudTCP::%s [%d] device configuration received", __FUNCTION__, millis());
-    ThingGetIdCmdDown message;
-    message.c.id = AttachThing;
-    strcpy(message.params.thing_id, _thing_id.c_str());
-    Serial.println(_thing_id.c_str());
-    _device.handleMessage((Message*)&message);
-  }
-
   /* Topic for user input data */
   if (_dataTopicIn == topic) {
-    CBORDecoder::decode(_thing.getPropertyContainer(), (uint8_t*)bytes, length);
+    CBORDecoder::decode(getThing().getPropertyContainer(), (uint8_t*)bytes, length);
   }
 
-  /* Topic for sync Thing last values on connect */
-  if (_shadowTopicIn == topic) {
-    DEBUG_VERBOSE("ArduinoIoTCloudTCP::%s [%d] last values received", __FUNCTION__, millis());
-    CBORDecoder::decode(_thing.getPropertyContainer(), (uint8_t*)bytes, length, true);
-    execCloudEventCallback(ArduinoIoTCloudEvent::SYNC);
-    /* Unlock thing state machine waiting last values */
-    Message message;
-    message.id = LastValues;
-    _thing.handleMessage(&message);
+  /* Topic for device commands */
+  if (_messageTopicIn == topic) {
+    CommandDown command;
+    DEBUG_VERBOSE("ArduinoIoTCloudTCP::%s [%d] received %d bytes", __FUNCTION__, millis(), length);
+    CBORMessageDecoder decoder;
+
+    size_t buffer_length = length;
+    if (decoder.decode((Message*)&command, bytes, buffer_length) != Decoder::Status::Error) {
+      DEBUG_VERBOSE("ArduinoIoTCloudTCP::%s [%d] received command id %d", __FUNCTION__, millis(), command.c.id);
+      switch (command.c.id)
+      {
+        case CommandID::ThingGetIdCmdDownId:
+        {
+          ThingGetIdCmdDown * msg = (ThingGetIdCmdDown *)&command;
+          _thing_id = String(msg->params.thing_id);
+          DEBUG_VERBOSE("ArduinoIoTCloudTCP::%s [%d] device configuration received", __FUNCTION__, millis());
+          _device.handleMessage((Message*)&command);
+        }
+        break;
+
+        case CommandID::ThingGetLastValueCmdDownId:
+        {
+          DEBUG_VERBOSE("ArduinoIoTCloudTCP::%s [%d] last values received", __FUNCTION__, millis());
+          ThingGetLastValueCmdDown * msg = (ThingGetLastValueCmdDown*)&command;
+          CBORDecoder::decode(getThing().getPropertyContainer(), (uint8_t*)msg->params.last_values, msg->params.length, true);
+          _thing.handleMessage((Message*)&command);
+          execCloudEventCallback(ArduinoIoTCloudEvent::SYNC);
+
+          /*
+           * NOTE: in this current version properties are not properly integrated with the new paradigm of
+           * modeling the messages with C structs. The current CBOR library allocates an array in the heap
+           * thus we need to delete it after decoding it with the old CBORDecoder
+           */
+          free(msg->params.last_values);
+        }
+        break;
+
+#if OTA_ENABLED
+        case CommandID::OtaUpdateCmdDownId:
+        {
+          DEBUG_VERBOSE("ArduinoIoTCloudTCP::%s [%d] ota update received", __FUNCTION__, millis());
+          _ota.handleMessage((Message*)&command);
+        }
+#endif
+
+        default:
+        break;
+      }
+    }
   }
 }
 
 void ArduinoIoTCloudTCP::sendMessage(Message * msg)
 {
   switch (msg->id)
   {
-    case SendCapabilities:
-    sendDevicePropertiesToCloud();
-    break;
     case SendProperties:
-    sendThingPropertiesToCloud();
-    break;
-    case GetLastValues:
-    requestLastValue();
-    break;
-    case GetThingId:
-    requestThingId();
+    return sendThingPropertiesToCloud();
     break;
+
     case AttachThing:
-    attachThing();
-    break;
-#if OTA_ENABLED
-    case OtaBeginUpId:
-    {
-    OtaBeginUp *ota_begin_cmd = (OtaBeginUp*)msg;
-    String sha256_str;
-    std::for_each(ota_begin_cmd->params.sha,
-      ota_begin_cmd->params.sha + SHA256::HASH_SIZE,
-      [&sha256_str](uint8_t const elem) {
-        char buf[4];
-        snprintf(buf, 4, "%02X", elem);
-        sha256_str += buf;
-      });
-      _ota_img_sha256 = sha256_str;
-    }
+    return attachThing();
     break;
-    case OtaProgressCmdUpId:
-    {
-    OtaProgressCmdUp *ota_progress_cmd = (OtaProgressCmdUp*)msg;
-    _ota_progress = OTACloudProcessInterface::STATE_NAMES[ota_progress_cmd->params.state < 0? OTACloudProcessInterface::Fail - ota_progress_cmd->params.state : ota_progress_cmd->params.state];
-    Serial.println("This is not a bug from Andrea code");
-    /* If something fails send the OTA error to the cloud */
-    sendDevicePropertyToCloud("OTA_PROGRESS");
-    }
-    break;
-#endif
     default:
     break;
   }
+
+  uint8_t data[MQTT_TRANSMIT_BUFFER_SIZE];
+  size_t bytes_encoded = sizeof(data);
+  CBORMessageEncoder encoder;
+
+  if (encoder.encode(msg, data, bytes_encoded) == Encoder::Status::Complete &&
+      bytes_encoded > 0) {
+    write(_messageTopicOut, data, bytes_encoded);
+  } else {
+    DEBUG_ERROR("error encoding %d", msg->id);
+  }
 }
 
 void ArduinoIoTCloudTCP::sendPropertyContainerToCloud(String const topic, PropertyContainer & container, unsigned int & current_property_index)
@@ -538,60 +471,6 @@ void ArduinoIoTCloudTCP::sendThingPropertiesToCloud()
   sendPropertyContainerToCloud(_dataTopicOut, _thing.getPropertyContainer(), _thing.getPropertyContainerIndex());
 }
 
-void ArduinoIoTCloudTCP::sendDevicePropertiesToCloud()
-{
-  PropertyContainer ro_device_container;
-  unsigned int last_device_property_index = 0;
-
-  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_container ] (String const & name)
-                {
-                  Property* p = getProperty(this->_device.getPropertyContainer(), name);
-                  if(p != nullptr)
-                    addPropertyToContainer(ro_device_container, *p, p->name(), p->isWriteableByCloud() ? Permission::ReadWrite : Permission::Read);
-                }
-                );
-  DEBUG_VERBOSE("ArduinoIoTCloudTCP::%s announce device to the Cloud %d", __FUNCTION__, _time_service.getTime());
-  sendPropertyContainerToCloud(_deviceTopicOut, ro_device_container, last_device_property_index);
-}
-
-#if OTA_ENABLED
-void ArduinoIoTCloudTCP::sendDevicePropertyToCloud(String const name)
-{
-  PropertyContainer temp_device_container;
-  unsigned int last_device_property_index = 0;
-
-  Property* p = getProperty(this->_device.getPropertyContainer(), name);
-  if(p != nullptr)
-  {
-    addPropertyToContainer(temp_device_container, *p, p->name(), p->isWriteableByCloud() ? Permission::ReadWrite : Permission::Read);
-    sendPropertyContainerToCloud(_deviceTopicOut, temp_device_container, last_device_property_index);
-  }
-}
-#endif
-
-void ArduinoIoTCloudTCP::requestLastValue()
-{
-  // Send the getLastValues CBOR message to the cloud
-  // [{0: "r:m", 3: "getLastValues"}] = 81 A2 00 63 72 3A 6D 03 6D 67 65 74 4C 61 73 74 56 61 6C 75 65 73
-  // Use http://cbor.me to easily generate CBOR encoding
-  DEBUG_VERBOSE("ArduinoIoTCloudTCP::%s at time [%d]", __FUNCTION__, getTime());
-  const uint8_t CBOR_REQUEST_LAST_VALUE_MSG[] = { 0x81, 0xA2, 0x00, 0x63, 0x72, 0x3A, 0x6D, 0x03, 0x6D, 0x67, 0x65, 0x74, 0x4C, 0x61, 0x73, 0x74, 0x56, 0x61, 0x6C, 0x75, 0x65, 0x73 };
-  write(_shadowTopicOut, CBOR_REQUEST_LAST_VALUE_MSG, sizeof(CBOR_REQUEST_LAST_VALUE_MSG));
-}
-
-void ArduinoIoTCloudTCP::requestThingId()
-{
-  if (!_mqttClient.subscribe(_deviceTopicIn))
-  {
-    /* If device_id is wrong the board can't connect to the broker so this condition
-    * should never happen.
-    */
-    DEBUG_ERROR("ArduinoIoTCloudTCP::%s could not subscribe to %s", __FUNCTION__, _deviceTopicIn.c_str());
-  }
-}
 
 void ArduinoIoTCloudTCP::attachThing()
 {
@@ -604,15 +483,6 @@ void ArduinoIoTCloudTCP::attachThing()
     return;
   }
 
-  _shadowTopicIn  = getTopic_shadowin();
-  _shadowTopicOut = getTopic_shadowout();
-  if (!_mqttClient.subscribe(_shadowTopicIn))
-  {
-    DEBUG_ERROR("ArduinoIoTCloudTCP::%s could not subscribe to %s", __FUNCTION__, _shadowTopicIn.c_str());
-    DEBUG_ERROR("Check your thing configuration, and press the reset button on your board.");
-    return;
-  }
-
   DEBUG_INFO("Connected to Arduino IoT Cloud");
   DEBUG_INFO("Thing ID: %s", getThingId().c_str());
   execCloudEventCallback(ArduinoIoTCloudEvent::CONNECT);