Skip to content

Commit

Permalink
[ChipTool] Add a command to enumerate the paired devices and show ip/…
Browse files Browse the repository at this point in the history
…port/interface informations for them
  • Loading branch information
vivien-apple committed Oct 27, 2021
1 parent 1d10ef8 commit d42a40f
Show file tree
Hide file tree
Showing 4 changed files with 137 additions and 0 deletions.
2 changes: 2 additions & 0 deletions examples/chip-tool/BUILD.gn
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ executable("chip-tool") {
"commands/discover/DiscoverCommand.cpp",
"commands/discover/DiscoverCommissionablesCommand.cpp",
"commands/discover/DiscoverCommissionersCommand.cpp",
"commands/pairing/CommissionedListCommand.cpp",
"commands/pairing/CommissionedListCommand.h",
"commands/pairing/PairingCommand.cpp",
"commands/payload/AdditionalDataParseCommand.cpp",
"commands/payload/SetupPayloadParseCommand.cpp",
Expand Down
2 changes: 2 additions & 0 deletions examples/chip-tool/commands/pairing/Commands.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@

#pragma once

#include "CommissionedListCommand.h"
#include "PairingCommand.h"

class Unpair : public PairingCommand
Expand Down Expand Up @@ -169,6 +170,7 @@ void registerCommandsPairing(Commands & commands)
make_unique<PairOnNetworkDeviceType>(),
make_unique<PairOnNetworkInstanceName>(),
make_unique<OpenCommissioningWindow>(),
make_unique<CommissionedListCommand>(),
};

commands.Register(clusterName, clusterCommands);
Expand Down
98 changes: 98 additions & 0 deletions examples/chip-tool/commands/pairing/CommissionedListCommand.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
/*
* Copyright (c) 2021 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 "CommissionedListCommand.h"

#include <lib/core/CHIPEncoding.h>
#include <lib/support/PersistentStorageMacros.h>
#include <lib/support/SafeInt.h>
#include <lib/support/Span.h>

CHIP_ERROR CommissionedListCommand::Run()
{
ReturnLogErrorOnFailure(mStorage.Init());
return PrintInformation();
}

CHIP_ERROR CommissionedListCommand::PrintInformation()
{
uint64_t pairedNodesIds[chip::Controller::kNumMaxPairedDevices];
uint16_t pairedNodesIdsSize = sizeof(pairedNodesIds);
memset(pairedNodesIds, 0, pairedNodesIdsSize);

PERSISTENT_KEY_OP(static_cast<uint64_t>(0), chip::kPairedDeviceListKeyPrefix, key,
ReturnLogErrorOnFailure(mStorage.SyncGetKeyValue(key, pairedNodesIds, pairedNodesIdsSize)));

chip::SerializableU64Set<chip::Controller::kNumMaxPairedDevices> devices;
devices.Deserialize(chip::ByteSpan((uint8_t *) pairedNodesIds, pairedNodesIdsSize));

uint16_t pairedDevicesCount = 0;
while (pairedNodesIds[pairedDevicesCount] != 0x0 && pairedDevicesCount < chip::Controller::kNumMaxPairedDevices)
{
pairedDevicesCount++;
}

if (pairedDevicesCount == 0)
{
ChipLogProgress(chipTool, "No paired devices.");
}
else
{
fprintf(stdout, "NOTES: Only the devices locally commissioned with chip-tool are displayed.\n");
fprintf(stdout, "+---------------------------------------------------------------------------------------------+\n");
fprintf(stdout, "| NodeId | Address | Port | Interface |\n");
fprintf(stdout, "+---------------------------------------------------------------------------------------------+\n");
for (uint16_t i = 0; i < pairedDevicesCount; i++)
{
ReturnLogErrorOnFailure(PrintDeviceInformation(pairedNodesIds[i]));
}
fprintf(stdout, "+---------------------------------------------------------------------------------------------+\n");
}

return CHIP_NO_ERROR;
}

CHIP_ERROR CommissionedListCommand::PrintDeviceInformation(chip::NodeId deviceId)
{
chip::Controller::SerializedDevice deviceInfo;
uint16_t size = sizeof(deviceInfo.inner);

PERSISTENT_KEY_OP(deviceId, chip::kPairedDeviceKeyPrefix, key,
ReturnLogErrorOnFailure(mStorage.SyncGetKeyValue(key, deviceInfo.inner, size)));
VerifyOrReturnError(size <= sizeof(deviceInfo.inner), CHIP_ERROR_INVALID_DEVICE_DESCRIPTOR);

chip::Controller::SerializableDevice serializable;
constexpr size_t maxlen = BASE64_ENCODED_LEN(sizeof(serializable));
const size_t len = strnlen(chip::Uint8::to_const_char(&deviceInfo.inner[0]), maxlen);

VerifyOrReturnError(len < sizeof(chip::Controller::SerializedDevice), CHIP_ERROR_INVALID_ARGUMENT);
VerifyOrReturnError(chip::CanCastTo<uint16_t>(len), CHIP_ERROR_INVALID_ARGUMENT);

CHIP_ZERO_AT(serializable);
const uint16_t deserializedLen = chip::Base64Decode(chip::Uint8::to_const_char(deviceInfo.inner), static_cast<uint16_t>(len),
chip::Uint8::to_uchar(reinterpret_cast<uint8_t *>(&serializable)));

VerifyOrReturnError(deserializedLen > 0, CHIP_ERROR_INVALID_ARGUMENT);
VerifyOrReturnError(deserializedLen <= sizeof(serializable), CHIP_ERROR_INVALID_ARGUMENT);

const uint16_t port = chip::Encoding::LittleEndian::HostSwap16(serializable.mDevicePort);
fprintf(stderr, "| 0x%-16" PRIx64 " | %-45s | %-5u| %-15s |\n", deviceId, serializable.mDeviceAddr, port,
serializable.mInterfaceName);

return CHIP_NO_ERROR;
}
35 changes: 35 additions & 0 deletions examples/chip-tool/commands/pairing/CommissionedListCommand.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
/*
* Copyright (c) 2021 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 "../../config/PersistentStorage.h"
#include "../common/Command.h"

class CommissionedListCommand : public Command
{
public:
CommissionedListCommand() : Command("list") {}
CHIP_ERROR Run() override;

private:
CHIP_ERROR PrintInformation();
CHIP_ERROR PrintDeviceInformation(chip::NodeId deviceId);

PersistentStorage mStorage;
};

0 comments on commit d42a40f

Please sign in to comment.