[chip-tool] Add a command to generate/update a qrcode and a command t…

…o generate/update a manual code
project-chip · Mar 28, 2022 · 508d49b · 508d49b
1 parent 89e097c
commit 508d49b
Show file tree

Hide file tree

Showing 4 changed files with 218 additions and 4 deletions.
diff --git a/examples/chip-tool/BUILD.gn b/examples/chip-tool/BUILD.gn
@@ -61,6 +61,7 @@ static_library("chip-tool-utils") {
     "commands/pairing/OpenCommissioningWindowCommand.h",
     "commands/pairing/PairingCommand.cpp",
     "commands/payload/AdditionalDataParseCommand.cpp",
+    "commands/payload/SetupPayloadGenerateCommand.cpp",
     "commands/payload/SetupPayloadParseCommand.cpp",
     "commands/payload/SetupPayloadVerhoeff.cpp",
     "commands/tests/TestCommand.cpp",

diff --git a/examples/chip-tool/commands/payload/Commands.h b/examples/chip-tool/commands/payload/Commands.h
@@ -19,17 +19,20 @@
 #pragma once
 
 #include "AdditionalDataParseCommand.h"
+#include "SetupPayloadGenerateCommand.h"
 #include "SetupPayloadParseCommand.h"
 #include "SetupPayloadVerhoeff.h"
 
 void registerCommandsPayload(Commands & commands)
 {
     const char * clusterName      = "Payload";
     commands_list clusterCommands = {
-        make_unique<SetupPayloadParseCommand>(),
-        make_unique<AdditionalDataParseCommand>(),
-        make_unique<SetupPayloadVerhoeffVerify>(),
-        make_unique<SetupPayloadVerhoeffGenerate>(),
+        make_unique<SetupPayloadGenerateQRCodeCommand>(),     //
+        make_unique<SetupPayloadGenerateManualCodeCommand>(), //
+        make_unique<SetupPayloadParseCommand>(),              //
+        make_unique<AdditionalDataParseCommand>(),            //
+        make_unique<SetupPayloadVerhoeffVerify>(),            //
+        make_unique<SetupPayloadVerhoeffGenerate>(),          //
     };
 
     commands.Register(clusterName, clusterCommands);

diff --git a/examples/chip-tool/commands/payload/SetupPayloadGenerateCommand.cpp b/examples/chip-tool/commands/payload/SetupPayloadGenerateCommand.cpp
@@ -0,0 +1,130 @@
+/*
+ *   Copyright (c) 2022 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 "SetupPayloadGenerateCommand.h"
+#include <setup_payload/ManualSetupPayloadGenerator.h>
+#include <setup_payload/ManualSetupPayloadParser.h>
+#include <setup_payload/QRCodeSetupPayloadGenerator.h>
+#include <setup_payload/QRCodeSetupPayloadParser.h>
+#include <setup_payload/SetupPayload.h>
+
+using namespace ::chip;
+
+CHIP_ERROR SetupPayloadGenerateQRCodeCommand::Run()
+{
+    SetupPayload payload;
+
+    if (mPayload.HasValue())
+    {
+        QRCodeSetupPayloadParser(mPayload.Value()).populatePayload(payload);
+    }
+
+    if (mDiscriminator.HasValue())
+    {
+        payload.discriminator = mDiscriminator.Value();
+    }
+
+    if (mSetUpPINCode.HasValue())
+    {
+        payload.setUpPINCode = mSetUpPINCode.Value();
+    }
+
+    if (mVersion.HasValue())
+    {
+        payload.version = mVersion.Value();
+    }
+
+    if (mVendorId.HasValue())
+    {
+        payload.vendorID = mVendorId.Value();
+    }
+
+    if (mProductId.HasValue())
+    {
+        payload.productID = mProductId.Value();
+    }
+
+    if (mCommissioningMode.HasValue())
+    {
+        payload.commissioningFlow = static_cast<CommissioningFlow>(mCommissioningMode.Value());
+    }
+
+    if (mRendezvous.HasValue())
+    {
+        payload.rendezvousInformation.SetRaw(mRendezvous.Value());
+    }
+
+    QRCodeSetupPayloadGenerator generator(payload);
+    generator.SetAllowInvalidPayload(mAllowInvalidPayload.ValueOr(false));
+
+    std::string code;
+    ReturnErrorOnFailure(generator.payloadBase38Representation(code));
+    ChipLogProgress(chipTool, "QR Code: %s", code.c_str());
+
+    return CHIP_NO_ERROR;
+}
+
+CHIP_ERROR SetupPayloadGenerateManualCodeCommand::Run()
+{
+    SetupPayload payload;
+
+    if (mPayload.HasValue())
+    {
+        ManualSetupPayloadParser(mPayload.Value()).populatePayload(payload);
+    }
+
+    if (mDiscriminator.HasValue())
+    {
+        payload.discriminator = mDiscriminator.Value();
+    }
+
+    if (mSetUpPINCode.HasValue())
+    {
+        payload.setUpPINCode = mSetUpPINCode.Value();
+    }
+
+    if (mVersion.HasValue())
+    {
+        payload.version = mVersion.Value();
+    }
+
+    if (mVendorId.HasValue())
+    {
+        payload.vendorID = mVendorId.Value();
+    }
+
+    if (mProductId.HasValue())
+    {
+        payload.productID = mProductId.Value();
+    }
+
+    if (mCommissioningMode.HasValue())
+    {
+        payload.commissioningFlow = static_cast<CommissioningFlow>(mCommissioningMode.Value());
+    }
+
+    ManualSetupPayloadGenerator generator(payload);
+    generator.SetAllowInvalidPayload(mAllowInvalidPayload.ValueOr(false));
+    generator.SetForceShortCode(mForceShortCode.ValueOr(false));
+
+    std::string code;
+    ReturnErrorOnFailure(generator.payloadDecimalStringRepresentation(code));
+    ChipLogProgress(chipTool, "Manual Code: %s", code.c_str());
+
+    return CHIP_NO_ERROR;
+}
diff --git a/examples/chip-tool/commands/payload/SetupPayloadGenerateCommand.h b/examples/chip-tool/commands/payload/SetupPayloadGenerateCommand.h
@@ -0,0 +1,80 @@
+/*
+ *   Copyright (c) 2022 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 SetupPayloadGenerateQRCodeCommand : public Command
+{
+public:
+    SetupPayloadGenerateQRCodeCommand() : Command("generate-qrcode")
+    {
+        AddArgument("discriminator", 0, UINT16_MAX, &mDiscriminator);
+        AddArgument("setup-pin-code", 0, UINT32_MAX, &mSetUpPINCode);
+        AddArgument("version", 0, UINT8_MAX, &mVersion);
+        AddArgument("vendor-id", 0, UINT16_MAX, &mVendorId);
+        AddArgument("product-id", 0, UINT16_MAX, &mProductId);
+        AddArgument("rendezvous", 0, UINT8_MAX, &mRendezvous);
+        AddArgument("commissioning-mode", 0, UINT8_MAX, &mCommissioningMode);
+        AddArgument("payload", &mPayload);
+        AddArgument("allow-invalid-payload", 0, 1, &mAllowInvalidPayload);
+    }
+    CHIP_ERROR Run() override;
+
+private:
+    chip::Optional<uint16_t> mDiscriminator;
+    chip::Optional<uint32_t> mSetUpPINCode;
+    chip::Optional<uint8_t> mVersion;
+    chip::Optional<uint16_t> mVendorId;
+    chip::Optional<uint16_t> mProductId;
+    chip::Optional<uint8_t> mRendezvous;
+    chip::Optional<char *> mPayload;
+    chip::Optional<uint8_t> mCommissioningMode;
+    chip::Optional<bool> mAllowInvalidPayload;
+};
+
+class SetupPayloadGenerateManualCodeCommand : public Command
+{
+public:
+    SetupPayloadGenerateManualCodeCommand() : Command("generate-manualcode")
+    {
+        AddArgument("discriminator", 0, UINT16_MAX, &mDiscriminator);
+        AddArgument("setup-pin-code", 0, UINT32_MAX, &mSetUpPINCode);
+        AddArgument("version", 0, UINT8_MAX, &mVersion);
+        AddArgument("vendor-id", 0, UINT16_MAX, &mVendorId);
+        AddArgument("product-id", 0, UINT16_MAX, &mProductId);
+        AddArgument("commissioning-mode", 0, UINT8_MAX, &mCommissioningMode);
+        AddArgument("payload", &mPayload);
+        AddArgument("allow-invalid-payload", 0, 1, &mAllowInvalidPayload);
+        AddArgument("force-short-code", 0, 1, &mForceShortCode);
+    }
+    CHIP_ERROR Run() override;
+
+private:
+    chip::Optional<uint16_t> mDiscriminator;
+    chip::Optional<uint32_t> mSetUpPINCode;
+    chip::Optional<uint8_t> mVersion;
+    chip::Optional<uint16_t> mVendorId;
+    chip::Optional<uint16_t> mProductId;
+    chip::Optional<uint8_t> mCommissioningMode;
+    chip::Optional<char *> mPayload;
+    chip::Optional<bool> mAllowInvalidPayload;
+    chip::Optional<bool> mForceShortCode;
+};