[ChipTool] Add Payload Parse Command

examples/chip-tool/BUILD.gn

@@ -26,6 +26,7 @@ executable("chip-tool") {
     "commands/common/Logging.cpp",
     "commands/common/ModelCommand.cpp",
     "commands/common/NetworkCommand.cpp",
+    "commands/payload/ParseCommand.cpp",
     "main.cpp",
   ]
 

examples/chip-tool/README.md

@@ -91,3 +91,23 @@ To get the list of parameters for a specific command, run the built executable
 with the target cluster name and the target command name
 
     $ chip-tool onoff on
+
+## Using the Client for Setup Payload
+
+### How to parse a setup code
+
+To parse a setup code, run the built executable with the `payload` cluster name and the `parse` command
+
+    $ chip-tool payload parse code
+
+#### QR Code
+
+    $ chip-tool payload parse "CH:#####"
+
+#### QR Code with optional Vendor Info
+
+    $ chip-tool chip-tool payload parse "CH:#####"
+
+#### Manual Setup Code
+
+    $ chip-tool payload parse :#####"

examples/chip-tool/commands/payload/Commands.h

@@ -0,0 +1,31 @@
+/*
+ *   Copyright (c) 2020 Project CHIP Authors
+ *   All rights reserved.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ *
+ */
+
+#pragma once
+
+#include "ParseCommand.h"
+
+void registerCommandsPayload(Commands & commands)
+{
+    const char * clusterName = "Payload";
+    commands_list clusterCommands = {
+        make_unique<ParseCommand>(),
+    };
+
+    commands.Register(clusterName, clusterCommands);
+}

examples/chip-tool/commands/payload/ParseCommand.cpp

@@ -0,0 +1,101 @@
+/*
+ *   Copyright (c) 2020 Project CHIP Authors
+ *   All rights reserved.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ *
+ */
+
+#include "ParseCommand.h"
+#include <setup_payload/QRCodeSetupPayloadParser.h>
+#include <setup_payload/ManualSetupPayloadParser.h>
+#include <setup_payload/SetupPayload.h>
+
+using namespace ::chip;
+using namespace ::chip::DeviceController;
+
+CHIP_ERROR ParseCommand::Run(ChipDeviceController * dc, NodeId remoteId)
+{    
+    std::string codeString(mCode);
+    SetupPayload payload;
+
+    CHIP_ERROR err = CHIP_NO_ERROR;
+    err = Parse(codeString, payload);
+    SuccessOrExit(err);
+
+    err = Print(payload);
+    SuccessOrExit(err);
+exit:
+    return err;
+}
+
+CHIP_ERROR ParseCommand::Print(chip::SetupPayload payload){
+    std::string serialNumber;
+    std::vector<OptionalQRCodeInfo> optionalVendorData;
+    CHIP_ERROR err = CHIP_NO_ERROR;
+
+    ChipLogProgress(SetupPayload, "RequiresCustomFlow: %u", payload.requiresCustomFlow);
+    ChipLogProgress(SetupPayload, "VendorID: %u", payload.vendorID);
+    ChipLogProgress(SetupPayload, "Version: %u", payload.version);
+    ChipLogProgress(SetupPayload, "ProductID: %u", payload.productID);
+    ChipLogProgress(SetupPayload, "Discriminator: %u", payload.discriminator);
+    ChipLogProgress(SetupPayload, "SetUpPINCode: %u", payload.setUpPINCode);
+    ChipLogProgress(SetupPayload, "RendezvousInformation: %u", payload.rendezvousInformation);
+
+    if (payload.getSerialNumber(serialNumber) == CHIP_NO_ERROR){
+        ChipLogProgress(SetupPayload, "SerialNumber: %s", serialNumber.c_str());
+    }
+
+    optionalVendorData = payload.getAllOptionalVendorData();
+    for (const OptionalQRCodeInfo & info : optionalVendorData)
+    {        
+        if (info.type == optionalQRCodeInfoTypeString)
+        {
+            ChipLogProgress(SetupPayload, "OptionalQRCodeInfo: tag=%u,string value=%s",info.tag, info.data.c_str());
+        }
+        else if (info.type == optionalQRCodeInfoTypeInt32)
+        {
+            ChipLogProgress(SetupPayload, "OptionalQRCodeInfo: tag=%u,int value=%u",info.tag, info.int32);
+        }
+        else
+        {
+            err = CHIP_ERROR_INVALID_ARGUMENT;
+        }
+    }
+
+    SuccessOrExit(err);
+
+exit:
+    return err;
+}
+
+CHIP_ERROR ParseCommand::Parse(std::string codeString, chip::SetupPayload &payload){
+
+    CHIP_ERROR err = CHIP_NO_ERROR;
+    if(IsQRCode(codeString)) 
+    {
+        ChipLogDetail(SetupPayload, "Parsing base41Representation: %s", codeString.c_str());
+        err = QRCodeSetupPayloadParser(codeString).populatePayload(payload);
+    }
+    else
+    {
+        ChipLogDetail(SetupPayload, "Parsing decimalRepresentation: %s", codeString.c_str());
+        err = ManualSetupPayloadParser(codeString).populatePayload(payload);
+    }
+
+    return err;
+}
+
+bool ParseCommand::IsQRCode(std::string codeString){
+    return codeString.rfind(QRCODE_PREFIX)==0;
+}

examples/chip-tool/commands/payload/ParseCommand.h

@@ -0,0 +1,40 @@
+/*
+ *   Copyright (c) 2020 Project CHIP Authors
+ *   All rights reserved.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ *
+ */
+
+#pragma once
+
+#include "../common/Command.h"
+#include <setup_payload/SetupPayload.h>
+
+class ParseCommand : public Command
+{
+public:
+    ParseCommand() : Command("parse")
+    {
+        AddArgument("code", &mCode);
+    }
+
+    CHIP_ERROR Run(ChipDeviceController * dc, NodeId remoteId) override;
+
+private:
+    char* mCode;
+    CHIP_ERROR Parse(std::string codeString, chip::SetupPayload &payload);
+    CHIP_ERROR Print(chip::SetupPayload payload);
+    bool IsQRCode(std::string codeString);
+    const std::string QRCODE_PREFIX = "CH:";
+};

examples/chip-tool/main.cpp

@@ -20,6 +20,7 @@
 
 #include "commands/clusters/Commands.h"
 #include "commands/echo/Commands.h"
+#include "commands/payload/Commands.h"
 
 // NOTE: Remote device ID is in sync with the echo server device id
 //       At some point, we may want to add an option to connect to a device without
@@ -33,9 +34,10 @@ constexpr chip::NodeId kRemoteDeviceId = 12344321;
 int main(int argc, char * argv[])
 {
     Commands commands;
-
     registerCommandsEcho(commands);
-    registerClusters(commands);
+    registerCommandsPayload(commands);
 
+    registerClusters(commands);
+
     return commands.Run(kLocalDeviceId, kRemoteDeviceId, argc, argv);
 }