ArduinoIoTCloudTCP: switch to messages

Author: pennam

src/ArduinoIoTCloudTCP.cpp

@@ -43,6 +43,7 @@
 #include <algorithm>
 #include "cbor/CBOREncoder.h"
 #include "utility/watchdog/Watchdog.h"
+#include <typeinfo>
 
 /******************************************************************************
    LOCAL MODULE FUNCTIONS
@@ -74,12 +75,6 @@ ArduinoIoTCloudTCP::ArduinoIoTCloudTCP()
 , _password("")
 #endif
 , _mqttClient{nullptr}
-, _deviceTopicOut("")
-, _deviceTopicIn("")
-, _shadowTopicOut("")
-, _shadowTopicIn("")
-, _dataTopicOut("")
-, _dataTopicIn("")
 #if OTA_ENABLED
 , _ota_cap{false}
 , _ota_error{static_cast<int>(OTAError::None)}
@@ -181,24 +176,21 @@ 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();
+  getTopic_devicein()  = 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).writeOnDemand();
+  _messageTopicIn  = getTopic_messagein();
 
   _thing.begin();
   _device.begin();
 
 #if  OTA_ENABLED
+  Property* p;
   p = new CloudWrapperBool(_ota_cap);
   addPropertyToContainer(_device.getPropertyContainer(), *p, "OTA_CAP", Permission::Read, -1);
   p = new CloudWrapperInt(_ota_error);
@@ -322,6 +314,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);
@@ -437,7 +430,7 @@ void ArduinoIoTCloudTCP::handleMessage(int length)
   }
 
   /* Topic for OTA properties and device configuration */
-  if (_deviceTopicIn == topic) {
+  if (getTopic_devicein() == topic) {
     CBORDecoder::decode(_device.getPropertyContainer(), (uint8_t*)bytes, length);
 
     /* Temporary check to avoid flooding device state machine with usless messages */
@@ -468,16 +461,47 @@ void ArduinoIoTCloudTCP::handleMessage(int length)
     CBORDecoder::decode(_thing.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());
-    /* Decode last values property array */
-    CBORDecoder::decode(_thing.getPropertyContainer(), (uint8_t*)bytes, length, true);
-    /* Unlock thing state machine waiting last values */
-    Message message = { LastValuesUpdateCmdId };
-    _thing.handleMessage(&message);
-    /* Call ArduinoIoTCloud sync user callback*/
-    execCloudEventCallback(ArduinoIoTCloudEvent::SYNC);
+  /* Topic for device commands */
+  if (getTopic_messagein() == 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::ThingUpdateCmdId:
+        {
+          _thing_id = String(command.thingBeginCmd.params.thing_id);
+          DEBUG_VERBOSE("ArduinoIoTCloudTCP::%s [%d] device configuration received", __FUNCTION__, millis());
+          _device.handleMessage((Message*)&command);
+        }
+        break;
+
+        case CommandId::LastValuesUpdateCmdId:
+        {
+          DEBUG_VERBOSE("ArduinoIoTCloudTCP::%s [%d] last values received", __FUNCTION__, millis());
+          CBORDecoder::decode(_thing.getPropertyContainer(),
+            (uint8_t*)command.lastValuesUpdateCmd.params.last_values,
+            command.lastValuesUpdateCmd.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(command.lastValuesUpdateCmd.params.last_values);
+        }
+        break;
+
+        default:
+        break;
+      }
+    }
   }
 }
 
@@ -504,6 +528,17 @@ void ArduinoIoTCloudTCP::sendMessage(Message * msg)
   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(getTopic_messageout(), data, bytes_encoded);
+  } else {
+    DEBUG_ERROR("error encoding %d", msg->id);
+  }
 }
 
 void ArduinoIoTCloudTCP::sendPropertyContainerToCloud(String const topic, PropertyContainer & property_container, unsigned int & current_property_index)
@@ -546,7 +581,7 @@ void ArduinoIoTCloudTCP::sendDevicePropertiesToCloud()
                     addPropertyToContainer(ro_device_property_container, *p, p->name(), p->isWriteableByCloud() ? Permission::ReadWrite : Permission::Read);
                 }
                 );
-  sendPropertyContainerToCloud(_deviceTopicOut, ro_device_property_container, last_device_property_index);
+  sendPropertyContainerToCloud(getTopic_deviceout(), ro_device_property_container, last_device_property_index);
 }
 
 #if OTA_ENABLED
@@ -559,7 +594,7 @@ void ArduinoIoTCloudTCP::sendDevicePropertyToCloud(String const name)
   if(p != nullptr)
   {
     addPropertyToContainer(temp_device_property_container, *p, p->name(), p->isWriteableByCloud() ? Permission::ReadWrite : Permission::Read);
-    sendPropertyContainerToCloud(_deviceTopicOut, temp_device_property_container, last_device_property_index);
+    sendPropertyContainerToCloud(getTopic_deviceout(), temp_device_property_container, last_device_property_index);
   }
 }
 #endif
@@ -575,12 +610,12 @@ void ArduinoIoTCloudTCP::requestLastValue()
 
 void ArduinoIoTCloudTCP::requestThingId()
 {
-  if (!_mqttClient.subscribe(_deviceTopicIn))
+  if (!_mqttClient.subscribe(getTopic_devicein()))
   {
     /* 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());
+    DEBUG_ERROR("ArduinoIoTCloudTCP::%s could not subscribe to %s", __FUNCTION__, getTopic_devicein().c_str());
   }
 }
 

src/ArduinoIoTCloudTCP.h

@@ -56,6 +56,9 @@
 #include <utility/ota/OTA.h>
 #endif
 
+#include "cbor/MessageDecoder.h"
+#include "cbor/MessageEncoder.h"
+
 /******************************************************************************
    CONSTANTS
  ******************************************************************************/
@@ -163,10 +166,8 @@ class ArduinoIoTCloudTCP: public ArduinoIoTCloudClass
 
     MqttClient _mqttClient;
 
-    String _deviceTopicOut;
-    String _deviceTopicIn;
-    String _shadowTopicOut;
-    String _shadowTopicIn;
+    String _messageTopicOut;
+    String _messageTopicIn;
     String _dataTopicOut;
     String _dataTopicIn;
 
@@ -182,8 +183,10 @@ class ArduinoIoTCloudTCP: public ArduinoIoTCloudClass
 
     inline String getTopic_deviceout() { return String("/a/d/" + getDeviceId() + "/e/o");}
     inline String getTopic_devicein () { return String("/a/d/" + getDeviceId() + "/e/i");}
-    inline String getTopic_shadowout() { return ( getThingId().length() == 0) ? String("") : String("/a/t/" + getThingId() + "/shadow/o"); }
-    inline String getTopic_shadowin () { return ( getThingId().length() == 0) ? String("") : String("/a/t/" + getThingId() + "/shadow/i"); }
+
+    inline String getTopic_messageout() { return String("/a/d/" + getDeviceId() + "/c/up");}
+    inline String getTopic_messagein () { return String("/a/d/" + getDeviceId() + "/c/dw");}
+
     inline String getTopic_dataout  () { return ( getThingId().length() == 0) ? String("") : String("/a/t/" + getThingId() + "/e/o"); }
     inline String getTopic_datain   () { return ( getThingId().length() == 0) ? String("") : String("/a/t/" + getThingId() + "/e/i"); }
 
@@ -198,17 +201,11 @@ class ArduinoIoTCloudTCP: public ArduinoIoTCloudClass
     void sendMessage(Message * msg);
     void sendPropertyContainerToCloud(String const topic, PropertyContainer & property_container, unsigned int & current_property_index);
     void sendThingPropertiesToCloud();
-    void sendDevicePropertiesToCloud();
-    void requestLastValue();
-    void requestThingId();
+
     void attachThing();
     void detachThing();
     int write(String const topic, byte const data[], int const length);
 
-#if OTA_ENABLED
-    void sendDevicePropertyToCloud(String const name);
-#endif
-
 };
 
 /******************************************************************************