Add detach command support

Author: robgee86

extras/test/src/test_command_decode.cpp

@@ -50,6 +50,35 @@ SCENARIO("Test the decoding of command messages") {
   }
 
   /****************************************************************************/
+  WHEN("Decode the ThingDetachCmdDown message")
+  {
+    CommandDown command;
+    /*
+      DA 00011000                             # tag(69632)
+        81                                    # array(1)
+            78 24                             # text(36)
+              65343439346435352D383732612D346664322D393634362D393266383739343933393463 # "e4494d55-872a-4fd2-9646-92f87949394c"
+    */
+    uint8_t const payload[] = {0xDA, 0x00, 0x01, 0x10, 0x00, 0x81, 0x78, 0x24,
+                               0x65, 0x34, 0x34, 0x39, 0x34, 0x64, 0x35, 0x35,
+                               0x2D, 0x38, 0x37, 0x32, 0x61, 0x2D, 0x34, 0x66,
+                               0x64, 0x32, 0x2D, 0x39, 0x36, 0x34, 0x36, 0x2D,
+                               0x39, 0x32, 0x66, 0x38, 0x37, 0x39, 0x34, 0x39,
+                               0x33, 0x39, 0x34, 0x63};
+
+    size_t payload_length = sizeof(payload) / sizeof(uint8_t);
+    CBORMessageDecoder decoder;
+      Decoder::Status err =  decoder.decode((Message*)&command, payload, payload_length);
+    const char *thingIdToMatch = "e4494d55-872a-4fd2-9646-92f87949394c";
+
+    THEN("The decode is successful") {
+      REQUIRE(err == Decoder::Status::Complete);
+      REQUIRE(strcmp(command.thingDetachCmd.params.thing_id, thingIdToMatch) == 0);
+      REQUIRE(command.c.id == ThingDetachCmdId);
+    }
+  }
+
+   /************************************************************************************/
 
   WHEN("Decode the ThingUpdateCmdId message containing a number instead of a string")
   {

extras/test/src/test_command_encode.cpp

@@ -304,6 +304,24 @@ SCENARIO("Test the encoding of command messages") {
 
   /****************************************************************************/
 
+  WHEN("Encode the ThingDetachCmdDown message")
+  {
+    ThingDetachCmdDown command;
+    command.c.id = CommandId::ThingDetachCmdDown;
+
+    uint8_t buffer[512];
+    size_t bytes_encoded = sizeof(buffer);
+
+    CBORMessageEncoder encoder;
+    Encoder::Status err = encoder.encode((Message*)&command, buffer, bytes_encoded);
+
+    THEN("The encoding is unsuccessful - ThingDetachCmdDown is not supported") {
+      REQUIRE(err == Encoder::Status::Error);
+    }
+  }
+
+  /****************************************************************************/
+
   WHEN("Encode a message with unknown command Id")
   {
     OtaUpdateCmdDown command;

src/ArduinoIoTCloudTCP.cpp

@@ -410,6 +410,17 @@ void ArduinoIoTCloudTCP::handleMessage(int length)
         }
         break;
 
+        case CommandId::ThingDetachCmdId:
+        {
+          if (!_device.isAttached() || _thing_id != String(command.thingDetachCmd.params.thing_id)) {
+            DEBUG_VERBOSE("ArduinoIoTCloudTCP::%s [%d] thing detach rejected", __FUNCTION__, millis());
+          }
+
+          DEBUG_VERBOSE("ArduinoIoTCloudTCP::%s [%d] thing detach received", __FUNCTION__, millis());
+          detachThing();
+        }
+        break;
+
         case CommandId::LastValuesUpdateCmdId:
         {
           DEBUG_VERBOSE("ArduinoIoTCloudTCP::%s [%d] last values received", __FUNCTION__, millis());

src/cbor/CBOR.cpp

@@ -36,6 +36,8 @@ CommandId toCommandId(CBORCommandTag tag) {
     return CommandId::OtaUpdateCmdDownId;
   case CBORCommandTag::CBORThingUpdateCmd:
     return CommandId::ThingUpdateCmdId;
+  case CBORCommandTag::CBORThingDetachCmd:
+    return CommandId::ThingDetachCmdId;
   case CBORCommandTag::CBORLastValuesUpdate:
     return CommandId::LastValuesUpdateCmdId;
   case CBORCommandTag::CBORTimezoneCommandDown:
@@ -63,6 +65,8 @@ CBORCommandTag toCBORCommandTag(CommandId id) {
     return CBORCommandTag::CBOROtaUpdateCmdDown;
   case CommandId::ThingUpdateCmdId:
     return CBORCommandTag::CBORThingUpdateCmd;
+  case CommandId::ThingDetachCmdId:
+    return CBORCommandTag::CBORThingDetachCmd;
   case CommandId::LastValuesUpdateCmdId:
     return CBORCommandTag::CBORLastValuesUpdate;
   case CommandId::TimezoneCommandDownId:

src/cbor/CBOR.h

@@ -31,6 +31,7 @@ enum CBORCommandTag: uint64_t {
   // Commands DOWN
   CBOROtaUpdateCmdDown    = 0x010100,
   CBORThingUpdateCmd      = 0x010400,
+  CBORThingDetachCmd      = 0x011000,
   CBORLastValuesUpdate    = 0x010600,
   CBORTimezoneCommandDown = 0x010900,
 

src/cbor/MessageDecoder.cpp

@@ -130,6 +130,17 @@ CBORMessageDecoder::ArrayParserState CBORMessageDecoder::decodeThingUpdateCmd(Cb
   return ArrayParserState::LeaveArray;
 }
 
+CBORMessageDecoder::ArrayParserState CBORMessageDecoder::decodeThingDetachCmd(CborValue * param, Message * message) {
+  ThingDetachCmd * thingCommand = (ThingDetachCmd *) message;
+
+  // Message is composed of a single parameter, a string (thing_id)
+  if (!copyCBORStringToArray(param, thingCommand->params.thing_id, sizeof(thingCommand->params.thing_id))) {
+    return ArrayParserState::Error;
+  }
+
+  return ArrayParserState::LeaveArray;
+}
+
 CBORMessageDecoder::ArrayParserState CBORMessageDecoder::decodeTimezoneCommandDown(CborValue * param, Message * message) {
   TimezoneCommandDown * setTz = (TimezoneCommandDown *) message;
 
@@ -213,6 +224,9 @@ CBORMessageDecoder::ArrayParserState CBORMessageDecoder::handle_Param(CborValue
   case CommandId::ThingUpdateCmdId:
     return CBORMessageDecoder::decodeThingUpdateCmd(param, message);
 
+  case CommandId::ThingDetachCmdId:
+    return CBORMessageDecoder::decodeThingDetachCmd(param, message);
+
   case CommandId::TimezoneCommandDownId:
     return CBORMessageDecoder::decodeTimezoneCommandDown(param, message);
 

src/cbor/MessageDecoder.h

@@ -65,6 +65,7 @@ class CBORMessageDecoder: public Decoder
 
   // Message specific decoders
   ArrayParserState decodeThingUpdateCmd(CborValue * param, Message * message);
+  ArrayParserState decodeThingDetachCmd(CborValue * param, Message * message);
   ArrayParserState decodeTimezoneCommandDown(CborValue * param, Message * message);
   ArrayParserState decodeLastValuesUpdateCmd(CborValue * param, Message * message);
   ArrayParserState decodeOtaUpdateCmdDown(CborValue * param, Message * message);

src/message/Commands.h

@@ -37,6 +37,7 @@ enum CommandId: uint32_t {
   DeviceBeginCmdId,
   ThingBeginCmdId,
   ThingUpdateCmdId,
+  ThingDetachCmdId,
   DeviceRegisteredCmdId,
   DeviceAttachedCmdId,
   DeviceDetachedCmdId,
@@ -89,6 +90,13 @@ struct ThingUpdateCmd {
   } params;
 };
 
+struct ThingDetachCmd {
+  Command c;
+  struct {
+    char thing_id[THING_ID_SIZE];
+  } params;
+};
+
 struct LastValuesBeginCmd {
   Command c;
 };
@@ -144,6 +152,7 @@ union CommandDown {
   struct Command                  c;
   struct OtaUpdateCmdDown         otaUpdateCmdDown;
   struct ThingUpdateCmd           thingUpdateCmd;
+  struct ThingDetachCmd           thingDetachCmd;
   struct LastValuesUpdateCmd      lastValuesUpdateCmd;
   struct TimezoneCommandDown      timezoneCommandDown;
 };