New GetBLEMacAddress response message (arduino-libraries#27)

Author: fabik111

extras/test/src/test_command_encode.cpp

@@ -499,4 +499,32 @@ SCENARIO("Test the encoding of command messages") {
     }
   }
 
+  WHEN("Encode a message with provisioning ble mac Address ")
+  {
+    ProvisioningJWTMessage command;
+    command.c.id = CommandId::ProvisioningBLEMacAddress;
+    memset(command.params.jwt, 0xAF, 6);
+    uint8_t buffer[512];
+    size_t bytes_encoded = sizeof(buffer);
+
+    CBORMessageEncoder encoder;
+    Encoder::Status err = encoder.encode((Message*)&command, buffer, bytes_encoded);
+
+    uint8_t expected_result[] = {
+      0xda, 0x00, 0x01, 0x20, 0x13, 0x81, 0x46, 
+      0xAF, 0xAF, 0xAF, 0xAF, 0xAF, 0xAF
+    };
+
+    // Test the encoding is
+    //DA 00012013       # tag(73747)
+    //81                # array(1)
+    //  46              # bytes(6)
+    //     AFAFAFAFAFA
+    THEN("The encoding is successful") {
+      REQUIRE(err == Encoder::Status::Complete);
+      REQUIRE(bytes_encoded == sizeof(expected_result));
+      REQUIRE(memcmp(buffer, expected_result, sizeof(expected_result)) == 0);
+    }
+  }
+
 }

src/cbor/CBOR.cpp

@@ -50,6 +50,8 @@ CommandId toCommandId(CBORCommandTag tag) {
     return CommandId::ProvisioningUniqueHardwareId;
   case CBORCommandTag::CBORProvisioningJWT:
     return CommandId::ProvisioningJWT;
+  case CBORCommandTag::CBORProvisioningBLEMacAddress:
+    return CommandId::ProvisioningBLEMacAddress;
   case CBORCommandTag::CBORProvisioningTimestamp:
     return CommandId::ProvisioningTimestamp;
   case CBORCommandTag::CBORProvisioningCommands:
@@ -105,6 +107,8 @@ CBORCommandTag toCBORCommandTag(CommandId id) {
     return CBORCommandTag::CBORProvisioningUniqueHardwareId;
   case CommandId::ProvisioningJWT:
     return CBORCommandTag::CBORProvisioningJWT;
+  case CommandId::ProvisioningBLEMacAddress:
+    return CBORCommandTag::CBORProvisioningBLEMacAddress;
   case CommandId::ProvisioningTimestamp:
     return CBORCommandTag::CBORProvisioningTimestamp;
   case CommandId::ProvisioningCommands:

src/cbor/CBOR.h

@@ -40,6 +40,7 @@ enum CBORCommandTag: uint64_t {
   CBORProvisioningListWifiNetworks   = 0x012001,
   CBORProvisioningUniqueHardwareId   = 0x012010,
   CBORProvisioningJWT                = 0x012011,
+  CBORProvisioningBLEMacAddress      = 0x012013,
   CBORProvisioningTimestamp          = 0x012002,
   CBORProvisioningCommands           = 0x012003,
   CBORProvisioningWifiConfig         = 0x012004,

src/cbor/MessageEncoder.cpp

@@ -109,6 +109,9 @@ CBORMessageEncoder::EncoderState CBORMessageEncoder::handle_EncodeArray(CborEnco
   case CommandId::ProvisioningJWT:
     array_size = 1;
     break;
+  case CommandId::ProvisioningBLEMacAddress:
+    array_size = 1;
+    break;
   default:
     return EncoderState::MessageNotSupported;
   }
@@ -154,6 +157,9 @@ CBORMessageEncoder::EncoderState CBORMessageEncoder::handle_EncodeParam(CborEnco
   case CommandId::ProvisioningJWT:
     error = CBORMessageEncoder::encodeProvisioningJWT(array_encoder, message);
     break;
+  case CommandId::ProvisioningBLEMacAddress:
+    error = CBORMessageEncoder::encodeProvisioningBLEMacAddress(array_encoder, message);
+    break;
   default:
     return EncoderState::MessageNotSupported;
   }
@@ -230,4 +236,17 @@ CborError CBORMessageEncoder::encodeProvisioningJWT(CborEncoder * array_encoder,
   ProvisioningJWTMessage * provisioningJWT = (ProvisioningJWTMessage *) message;
   CHECK_CBOR(cbor_encode_byte_string(array_encoder, (uint8_t *) provisioningJWT->params.jwt, PROVISIONING_JWT_SIZE));
   return CborNoError;
-}
+}
+
+CborError CBORMessageEncoder::encodeProvisioningBLEMacAddress(CborEncoder *array_encoder, Message *message)
+{
+  ProvisioningBLEMacAddressMessage *provisioningBLEMacAddress = (ProvisioningBLEMacAddressMessage *)message;
+  uint8_t size = 0;
+  uint8_t emptyMac[] = {0, 0, 0, 0, 0, 0};
+  if(memcmp(provisioningBLEMacAddress->params.macAddress, emptyMac, BLE_MAC_ADDRESS_SIZE) != 0)
+  {
+    size = BLE_MAC_ADDRESS_SIZE;
+  }
+  CHECK_CBOR(cbor_encode_byte_string(array_encoder, provisioningBLEMacAddress->params.macAddress, size));
+  return CborNoError;
+}

src/cbor/MessageEncoder.h

@@ -66,6 +66,7 @@ class CBORMessageEncoder: public Encoder
   CborError encodeProvisioningListWifiNetworks(CborEncoder * array_encoder, Message * message);
   CborError encodeProvisioningUniqueHardwareId(CborEncoder * array_encoder, Message * message);
   CborError encodeProvisioningJWT(CborEncoder * array_encoder, Message * message);
+  CborError encodeProvisioningBLEMacAddress(CborEncoder * array_encoder, Message * message);
 };
 
 #endif /* ARDUINO_CBOR_MESSAGE_ENCODER_H_ */

src/message/Commands.h

@@ -28,6 +28,7 @@
 #define MAX_LIB_VERSION_SIZE        10
 #define UHWID_SIZE                  32
 #define PROVISIONING_JWT_SIZE      268 // Max length of jwt is 268
+#define BLE_MAC_ADDRESS_SIZE         6
 #define WIFI_SSID_SIZE              33 // Max length of ssid is 32 + \0
 #define WIFI_PWD_SIZE               64 // Max length of password is 63 + \0
 #define LORA_APPEUI_SIZE            17 // appeui is 8 octets * 2 (hex format) + \0
@@ -81,6 +82,7 @@ enum CommandId: uint32_t {
   ProvisioningStatus,
   ProvisioningListWifiNetworks,
   ProvisioningUniqueHardwareId,
+  ProvisioningBLEMacAddress,
   ProvisioningJWT,
   ProvisioningTimestamp,
   ProvisioningCommands,
@@ -212,6 +214,13 @@ struct ProvisioningJWTMessage {
   } params;
 };
 
+struct ProvisioningBLEMacAddressMessage {
+  Command c;
+  struct {
+    uint8_t macAddress[BLE_MAC_ADDRESS_SIZE];
+  } params;
+};
+
 struct ProvisioningTimestampMessage {
   Command c;
   struct {