Skip to content

Commit

Permalink
Fix TV commissioning and control (project-chip#30904)
Browse files Browse the repository at this point in the history 
* tv2 fixes

* debug CI failure

* address comments, add code to debug CI

* add code to debug CI

* add code to debug CI

* Restyled by clang-format (project-chip#30960)

Co-authored-by: Restyled.io <[email protected]>

* revert CI debug

---------

Co-authored-by: restyled-io[bot] <32688539+restyled-io[bot]@users.noreply.github.com>
Co-authored-by: Restyled.io <[email protected]>
  • Loading branch information
@chrisdecenzo @restyled-io @restyled-commits
3 people authored Dec 14, 2023
1 parent 8e3d98c commit 4fe0f8d
Show file tree
Hide file tree
Showing 6 changed files with 155 additions and 60 deletions.
3 changes: 2 additions & 1 deletion examples/platform/linux/CommissionerMain.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,8 @@ CHIP_ERROR InitCommissioner(uint16_t commissionerPort, uint16_t udcListenPort, F
params.controllerICAC = icacSpan;
params.controllerNOC = nocSpan;

params.defaultCommissioner = &gAutoCommissioner;
params.defaultCommissioner = &gAutoCommissioner;
params.enableServerInteractions = true;

// assign prefered feature settings
CommissioningParameters commissioningParams = gAutoCommissioner.GetCommissioningParameters();
Expand Down
35 changes: 24 additions & 11 deletions src/protocols/user_directed_commissioning/UDCClientState.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,15 @@ enum class UDCClientProcessingState : uint8_t

using PeerAddress = ::chip::Transport::PeerAddress;

/**
* Represents information in the TargetAppList of the Identification Declaration message
*/
struct TargetAppInfo
{
uint16_t vendorId = 0;
uint16_t productId = 0;
};

/**
* Defines the handling state of a UDC Client.
*
Expand Down Expand Up @@ -99,25 +108,29 @@ class UDCClientState
uint16_t GetPairingHint() const { return mPairingHint; }
void SetPairingHint(uint16_t pairingHint) { mPairingHint = pairingHint; }

bool GetAppVendorId(size_t index, uint16_t & vid) const
bool GetTargetAppInfo(uint8_t index, TargetAppInfo & info) const
{
if (index < mNumAppVendorIds)
if (index < mNumTargetAppInfos)
{
vid = mAppVendorIds[index];
info.vendorId = mTargetAppInfos[index].vendorId;
info.productId = mTargetAppInfos[index].productId;
return true;
}
return false;
}
size_t GetNumAppVendorIds() const { return mNumAppVendorIds; }
size_t GetNumTargetAppInfos() const { return mNumTargetAppInfos; }

void AddAppVendorId(uint16_t vid)
bool AddTargetAppInfo(TargetAppInfo vid)
{
if (mNumAppVendorIds >= sizeof(mAppVendorIds))
if (mNumTargetAppInfos >= sizeof(mTargetAppInfos))
{
// already at max
return;
return false;
}
mAppVendorIds[mNumAppVendorIds++] = vid;
mTargetAppInfos[mNumTargetAppInfos].vendorId = vid.vendorId;
mTargetAppInfos[mNumTargetAppInfos].productId = vid.productId;
mNumTargetAppInfos++;
return true;
}

UDCClientProcessingState GetUDCClientProcessingState() const { return mUDCClientProcessingState; }
Expand Down Expand Up @@ -183,9 +196,9 @@ class UDCClientState
char mPairingInst[chip::Dnssd::kMaxPairingInstructionLen + 1] = {};
uint16_t mPairingHint = 0;

constexpr static size_t kMaxAppVendorIds = 10;
size_t mNumAppVendorIds = 0; // number of vendor Ids
uint16_t mAppVendorIds[kMaxAppVendorIds];
constexpr static size_t kMaxTargetAppInfos = 10;
uint8_t mNumTargetAppInfos = 0; // number of vendor Ids
TargetAppInfo mTargetAppInfos[kMaxTargetAppInfos];

bool mNoPasscode = false;
bool mCdUponPasscodeDialog = false;
Expand Down
52 changes: 30 additions & 22 deletions src/protocols/user_directed_commissioning/UserDirectedCommissioning.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ class DLL_EXPORT IdentificationDeclaration
bool HasDiscoveryInfo()
{
return mVendorId != 0 || mProductId != 0 || mCdPort != 0 || strlen(mDeviceName) > 0 || GetRotatingIdLength() > 0 ||
mNumAppVendorIds > 0 || mNoPasscode || mCdUponPasscodeDialog || mCommissionerPasscode || mCommissionerPasscodeReady;
mNumTargetAppInfos > 0 || mNoPasscode || mCdUponPasscodeDialog || mCommissionerPasscode || mCommissionerPasscodeReady;
}

const char * GetDeviceName() const { return mDeviceName; }
Expand All @@ -105,25 +105,29 @@ class DLL_EXPORT IdentificationDeclaration
memcpy(mRotatingId, rotatingId, mRotatingIdLen);
}

bool GetAppVendorId(uint8_t index, uint16_t & vid) const
bool GetTargetAppInfo(uint8_t index, TargetAppInfo & info) const
{
if (index < mNumAppVendorIds)
if (index < mNumTargetAppInfos)
{
vid = mAppVendorIds[index];
info.vendorId = mTargetAppInfos[index].vendorId;
info.productId = mTargetAppInfos[index].productId;
return true;
}
return false;
}
size_t GetNumAppVendorIds() const { return mNumAppVendorIds; }
size_t GetNumTargetAppInfos() const { return mNumTargetAppInfos; }

void AddAppVendorId(uint16_t vid)
bool AddTargetAppInfo(TargetAppInfo vid)
{
if (mNumAppVendorIds >= sizeof(mAppVendorIds))
if (mNumTargetAppInfos >= sizeof(mTargetAppInfos))
{
// already at max
return;
return false;
}
mAppVendorIds[mNumAppVendorIds++] = vid;
mTargetAppInfos[mNumTargetAppInfos].vendorId = vid.vendorId;
mTargetAppInfos[mNumTargetAppInfos].productId = vid.productId;
mNumTargetAppInfos++;
return true;
}

const char * GetPairingInst() const { return mPairingInst; }
Expand Down Expand Up @@ -170,12 +174,12 @@ class DLL_EXPORT IdentificationDeclaration
client->SetRotatingId(GetRotatingId(), GetRotatingIdLength());
client->SetPairingInst(GetPairingInst());
client->SetPairingHint(GetPairingHint());
for (uint8_t i = 0; i < GetNumAppVendorIds(); i++)
for (uint8_t i = 0; i < GetNumTargetAppInfos(); i++)
{
uint16_t vid;
if (GetAppVendorId(i, vid))
TargetAppInfo info;
if (GetTargetAppInfo(i, info))
{
client->AddAppVendorId(vid);
client->AddTargetAppInfo(info);
}
}

Expand Down Expand Up @@ -214,9 +218,10 @@ class DLL_EXPORT IdentificationDeclaration
Encoding::BytesToUppercaseHexString(mRotatingId, mRotatingIdLen, rotatingIdString, sizeof(rotatingIdString));
ChipLogDetail(AppServer, "\trotating id: %s", rotatingIdString);
}
for (uint8_t i = 0; i < mNumAppVendorIds; i++)
for (uint8_t i = 0; i < mNumTargetAppInfos; i++)
{
ChipLogDetail(AppServer, "\tapp vendor id [%d]: %u", i, mAppVendorIds[i]);
ChipLogDetail(AppServer, "\tapp vendor id / product id [%d]: %u/%u", i, mTargetAppInfos[i].vendorId,
mTargetAppInfos[i].productId);
}
if (strlen(mPairingInst) != 0)
{
Expand Down Expand Up @@ -256,13 +261,16 @@ class DLL_EXPORT IdentificationDeclaration
{
kVendorIdTag = 1,
kProductIdTag,
kNameTag,
kRotatingIdTag,
kCdPortTag,
kDeviceNameTag,
kDeviceTypeTag,
kPairingInstTag,
kPairingHintTag,
kAppVendorIdListTag,
kRotatingIdTag,
kCdPortTag,
kTargetAppListTag,
kTargetAppTag,
kAppVendorIdTag,
kAppProductIdTag,
kNoPasscodeTag,
kCdUponPasscodeDialogTag,
kCommissionerPasscodeTag,
Expand All @@ -281,9 +289,9 @@ class DLL_EXPORT IdentificationDeclaration
uint8_t mRotatingId[chip::Dnssd::kMaxRotatingIdLen];
size_t mRotatingIdLen = 0;

constexpr static size_t kMaxAppVendorIds = 10;
uint8_t mNumAppVendorIds = 0; // number of vendor Ids
uint16_t mAppVendorIds[kMaxAppVendorIds];
constexpr static size_t kMaxTargetAppInfos = 10;
uint8_t mNumTargetAppInfos = 0; // number of vendor Ids
TargetAppInfo mTargetAppInfos[kMaxTargetAppInfos];

char mPairingInst[chip::Dnssd::kMaxPairingInstructionLen + 1] = {};
uint16_t mPairingHint = 0;
Expand Down
26 changes: 21 additions & 5 deletions src/protocols/user_directed_commissioning/UserDirectedCommissioningClient.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,8 @@ uint32_t IdentificationDeclaration::WritePayload(uint8_t * payloadBuffer, size_t

VerifyOrExit(CHIP_NO_ERROR == (err = writer.Put(chip::TLV::ContextTag(kVendorIdTag), GetVendorId())), LogErrorOnFailure(err));
VerifyOrExit(CHIP_NO_ERROR == (err = writer.Put(chip::TLV::ContextTag(kProductIdTag), GetProductId())), LogErrorOnFailure(err));
VerifyOrExit(CHIP_NO_ERROR == (err = writer.PutString(chip::TLV::ContextTag(kNameTag), mDeviceName)), LogErrorOnFailure(err));
VerifyOrExit(CHIP_NO_ERROR == (err = writer.PutString(chip::TLV::ContextTag(kDeviceNameTag), mDeviceName)),
LogErrorOnFailure(err));
VerifyOrExit(CHIP_NO_ERROR == (err = writer.PutString(chip::TLV::ContextTag(kPairingInstTag), mPairingInst)),
LogErrorOnFailure(err));
VerifyOrExit(CHIP_NO_ERROR == (err = writer.Put(chip::TLV::ContextTag(kPairingHintTag), mPairingHint)), LogErrorOnFailure(err));
Expand All @@ -134,12 +135,22 @@ uint32_t IdentificationDeclaration::WritePayload(uint8_t * payloadBuffer, size_t
// AppVendorIdList
VerifyOrExit(
CHIP_NO_ERROR ==
(err = writer.StartContainer(chip::TLV::ContextTag(kAppVendorIdListTag), chip::TLV::kTLVType_List, listContainerType)),
(err = writer.StartContainer(chip::TLV::ContextTag(kTargetAppListTag), chip::TLV::kTLVType_List, listContainerType)),
LogErrorOnFailure(err));
for (size_t i = 0; i < mNumAppVendorIds; i++)
for (size_t i = 0; i < mNumTargetAppInfos; i++)
{
VerifyOrExit(CHIP_NO_ERROR == (err = writer.Put(chip::TLV::ContextTag(kAppVendorIdTag), mAppVendorIds[i])),
// start the TargetApp structure
VerifyOrExit(CHIP_NO_ERROR ==
(err = writer.StartContainer(chip::TLV::ContextTag(kTargetAppTag), chip::TLV::kTLVType_Structure,
outerContainerType)),
LogErrorOnFailure(err));
// add the vendor Id
VerifyOrExit(CHIP_NO_ERROR == (err = writer.Put(chip::TLV::ContextTag(kAppVendorIdTag), mTargetAppInfos[i].vendorId)),
LogErrorOnFailure(err));
VerifyOrExit(CHIP_NO_ERROR == (err = writer.Put(chip::TLV::ContextTag(kAppProductIdTag), mTargetAppInfos[i].productId)),
LogErrorOnFailure(err));
// end the TargetApp structure
VerifyOrExit(CHIP_NO_ERROR == (err = writer.EndContainer(outerContainerType)), LogErrorOnFailure(err));
}
VerifyOrExit(CHIP_NO_ERROR == (err = writer.EndContainer(listContainerType)), LogErrorOnFailure(err));

Expand Down Expand Up @@ -180,7 +191,12 @@ CHIP_ERROR CommissionerDeclaration::ReadPayload(uint8_t * udcPayload, size_t pay
while ((err = reader.Next()) == CHIP_NO_ERROR)
{
chip::TLV::Tag containerTag = reader.GetTag();
uint8_t tagNum = static_cast<uint8_t>(chip::TLV::TagNumFromTag(containerTag));
if (!TLV::IsContextTag(containerTag))
{
ChipLogError(AppServer, "Unexpected non-context TLV tag.");
return CHIP_ERROR_INVALID_TLV_TAG;
}
uint8_t tagNum = static_cast<uint8_t>(chip::TLV::TagNumFromTag(containerTag));

switch (tagNum)
{
Expand Down
64 changes: 55 additions & 9 deletions src/protocols/user_directed_commissioning/UserDirectedCommissioningServer.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,12 @@ CHIP_ERROR IdentificationDeclaration::ReadPayload(uint8_t * udcPayload, size_t p
while ((err = reader.Next()) == CHIP_NO_ERROR)
{
chip::TLV::Tag containerTag = reader.GetTag();
uint8_t tagNum = static_cast<uint8_t>(chip::TLV::TagNumFromTag(containerTag));
if (!TLV::IsContextTag(containerTag))
{
ChipLogError(AppServer, "Unexpected non-context TLV tag.");
return CHIP_ERROR_INVALID_TLV_TAG;
}
uint8_t tagNum = static_cast<uint8_t>(chip::TLV::TagNumFromTag(containerTag));

switch (tagNum)
{
Expand All @@ -225,7 +230,7 @@ CHIP_ERROR IdentificationDeclaration::ReadPayload(uint8_t * udcPayload, size_t p
// port
err = reader.Get(mCdPort);
break;
case kNameTag:
case kDeviceNameTag:
// deviceName
err = reader.GetString(mDeviceName, sizeof(mDeviceName));
break;
Expand All @@ -242,25 +247,66 @@ CHIP_ERROR IdentificationDeclaration::ReadPayload(uint8_t * udcPayload, size_t p
mRotatingIdLen = reader.GetLength();
err = reader.GetBytes(mRotatingId, sizeof(mRotatingId));
break;
case kAppVendorIdListTag:
case kTargetAppListTag:
// app vendor list
{
ChipLogProgress(AppServer, "TLV found an applist");
chip::TLV::TLVType listContainerType = chip::TLV::kTLVType_List;
ReturnErrorOnFailure(reader.EnterContainer(listContainerType));

while ((err = reader.Next()) == CHIP_NO_ERROR && mNumAppVendorIds < sizeof(mAppVendorIds))
while ((err = reader.Next()) == CHIP_NO_ERROR && mNumTargetAppInfos < sizeof(mTargetAppInfos))
{
containerTag = reader.GetTag();
tagNum = static_cast<uint8_t>(chip::TLV::TagNumFromTag(containerTag));
if (tagNum == kAppVendorIdTag)
if (!TLV::IsContextTag(containerTag))
{
ChipLogError(AppServer, "Unexpected non-context TLV tag.");
return CHIP_ERROR_INVALID_TLV_TAG;
}
tagNum = static_cast<uint8_t>(chip::TLV::TagNumFromTag(containerTag));
if (tagNum == kTargetAppTag)
{
ReturnErrorOnFailure(reader.EnterContainer(outerContainerType));
uint16_t appVendorId = 0;
uint16_t appProductId = 0;

while ((err = reader.Next()) == CHIP_NO_ERROR)
{
containerTag = reader.GetTag();
if (!TLV::IsContextTag(containerTag))
{
ChipLogError(AppServer, "Unexpected non-context TLV tag.");
return CHIP_ERROR_INVALID_TLV_TAG;
}
tagNum = static_cast<uint8_t>(chip::TLV::TagNumFromTag(containerTag));
if (tagNum == kAppVendorIdTag)
{
err = reader.Get(appVendorId);
}
else if (tagNum == kAppProductIdTag)
{
err = reader.Get(appProductId);
}
}
if (err == CHIP_END_OF_TLV)
{
ChipLogProgress(AppServer, "TLV end of struct TLV");
ReturnErrorOnFailure(reader.ExitContainer(outerContainerType));
}
if (appVendorId != 0)
{
mTargetAppInfos[mNumTargetAppInfos].vendorId = appVendorId;
mTargetAppInfos[mNumTargetAppInfos].productId = appProductId;
mNumTargetAppInfos++;
}
}
else
{
err = reader.Get(mAppVendorIds[mNumAppVendorIds]);
mNumAppVendorIds++;
ChipLogError(AppServer, "unrecognized tag %d", tagNum);
}
}
if (err == CHIP_END_OF_TLV)
{
ChipLogError(AppServer, "TLV end of array TLV");
ChipLogProgress(AppServer, "TLV end of array");
ReturnErrorOnFailure(reader.ExitContainer(listContainerType));
}
}
Expand Down
Loading

0 comments on commit 4fe0f8d

Please sign in to comment.