Skip to content

[DNM] [nrf toup] Network Commissioning: Add hysteresis to status reporting #620

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[DNM] [nrf toup] Network Commissioning: Add hysteresis to status reporting #620

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 61 additions & 4 deletions src/app/clusters/network-commissioning/network-commissioning.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -680,17 +680,70 @@ void Instance::OnNetworkingStatusChange(Status aCommissioningError, Optional<Byt
}
}

SetLastNetworkingStatusValue(MakeNullable(aCommissioningError));
if (aConnectStatus.HasValue())
#if CHIP_CONFIG_NETWORK_COMMISSIONING_IMMEDIATE_STATUS_REPORTING
SetLastNetworkingStatusValue(aCommissioningError);
SetLastConnectErrorValue(aConnectStatus.HasValue() ? MakeNullable(aConnectStatus.Value()) : NullNullable);
#else
if (aCommissioningError == Status::kSuccess)
{
CancelPendingError();
mLastSuccessTimestamp = System::SystemClock().GetMonotonicTimestamp();
SetLastNetworkingStatusValue(aCommissioningError);
SetLastConnectErrorValue(NullNullable);
}
else if (mLastSuccessTimestamp == System::Clock::kZero)
{
SetLastConnectErrorValue(MakeNullable(aConnectStatus.Value()));
SetLastNetworkingStatusValue(aCommissioningError);
SetLastConnectErrorValue(aConnectStatus.HasValue() ? MakeNullable(aConnectStatus.Value()) : NullNullable);
}
else
{
SetLastConnectErrorValue(NullNullable);
mDeferredLastStatus = aCommissioningError;
mDeferredConnectError = aConnectStatus;

if (!mDeferredErrorPending)
{
mDeferredErrorPending = true;

uint32_t timeoutSec = mpWirelessDriver ? mpWirelessDriver->GetConnectNetworkTimeoutSeconds() : 20;
DeviceLayer::SystemLayer().StartTimer(System::Clock::Seconds32(timeoutSec), DeferredErrorTimerFiredStatic, this);
}
}
#endif
}

#if !CHIP_CONFIG_NETWORK_COMMISSIONING_IMMEDIATE_STATUS_REPORTING

void Instance::ResetSuccessTimestamp()
{
mLastSuccessTimestamp = System::Clock::kZero;
}

void Instance::DeferredErrorTimerFiredStatic(System::Layer *, void * context)
{
static_cast<Instance *>(context)->DeferredErrorTimerFired();
}

void Instance::DeferredErrorTimerFired()
{
if (mDeferredErrorPending)
{
mDeferredErrorPending = false;
SetLastNetworkingStatusValue(mDeferredLastStatus);
SetLastConnectErrorValue(mDeferredConnectError.HasValue() ? MakeNullable(mDeferredConnectError.Value()) : NullNullable);
}
}

void Instance::CancelPendingError()
{
if (mDeferredErrorPending)
{
DeviceLayer::SystemLayer().CancelTimer(DeferredErrorTimerFiredStatic, this);
mDeferredErrorPending = false;
}
}
#endif

void Instance::HandleScanNetworks(HandlerContext & ctx, const Commands::ScanNetworks::DecodableType & req)
{
MATTER_TRACE_SCOPE("HandleScanNetwork", "NetworkCommissioning");
Expand Down Expand Up @@ -1046,6 +1099,10 @@ void Instance::HandleConnectNetwork(HandlerContext & ctx, const Commands::Connec
mAsyncCommandHandle = CommandHandler::Handle(&ctx.mCommandHandler);
mCurrentOperationBreadcrumb = req.breadcrumb;

#if !CHIP_CONFIG_NETWORK_COMMISSIONING_IMMEDIATE_STATUS_REPORTING
ResetSuccessTimestamp();
#endif

#if CHIP_DEVICE_CONFIG_SUPPORTS_CONCURRENT_CONNECTION
// Per spec, lingering connections on any other interfaces need to be disconnected at this point.
for (auto & node : sInstances)
Expand Down
14 changes: 14 additions & 0 deletions src/app/clusters/network-commissioning/network-commissioning.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,11 +126,25 @@ class Instance : public CommandHandlerInterface,
Optional<uint64_t> mCurrentOperationBreadcrumb;
bool mScanningWasDirected = false;

#if !CHIP_CONFIG_NETWORK_COMMISSIONING_IMMEDIATE_STATUS_REPORTING
System::Clock::Timestamp mLastSuccessTimestamp{};
bool mDeferredErrorPending = false;
DeviceLayer::NetworkCommissioning::Status mDeferredLastStatus;
Optional<int32_t> mDeferredConnectError;
#endif

void SetLastNetworkingStatusValue(Attributes::LastNetworkingStatus::TypeInfo::Type networkingStatusValue);
void SetLastConnectErrorValue(Attributes::LastConnectErrorValue::TypeInfo::Type connectErrorValue);
void SetLastNetworkId(ByteSpan lastNetworkId);
void ReportNetworksListChanged() const;

#if !CHIP_CONFIG_NETWORK_COMMISSIONING_IMMEDIATE_STATUS_REPORTING
void ResetSuccessTimestamp();
static void DeferredErrorTimerFiredStatic(System::Layer *, void * context);
void DeferredErrorTimerFired();
void CancelPendingError();
#endif

#if CHIP_DEVICE_CONFIG_SUPPORTS_CONCURRENT_CONNECTION
// Disconnect if the current connection is not in the Networks list
void DisconnectLingeringConnection();
Expand Down
18 changes: 18 additions & 0 deletions src/lib/core/CHIPConfig.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1467,6 +1467,24 @@ extern const char CHIP_NON_PRODUCTION_MARKER[];
#define CHIP_CONFIG_NETWORK_COMMISSIONING_DEBUG_TEXT_BUFFER_SIZE 64
#endif // CHIP_CONFIG_NETWORK_COMMISSIONING_DEBUG_TEXT_BUFFER_SIZE

/*
* @def CHIP_CONFIG_NETWORK_COMMISSIONING_IMMEDIATE_STATUS_REPORTING
*
* @brief If enabled, networking status and connection error values (LastNetworkingStatus / LastConnectErrorValue)
* are updated immediately upon receiving the result from the driver.
*
* If disabled, errors will be reported only after the driver-defined connect timeout (e.g. 30s),
* to avoid reflecting transient failures too early.
*
* This allows delaying status reporting to reduce the impact of temporary network instabilities.
*
* Default: 1 (enabled)
*/
#ifndef CHIP_CONFIG_NETWORK_COMMISSIONING_IMMEDIATE_STATUS_REPORTING
#define CHIP_CONFIG_NETWORK_COMMISSIONING_IMMEDIATE_STATUS_REPORTING 0
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: Disabled for CI testing of a new behavior.

#endif // CHIP_CONFIG_NETWORK_COMMISSIONING_IMMEDIATE_STATUS_REPORTING


/**
* @def CHIP_CONFIG_IM_STATUS_CODE_VERBOSE_FORMAT
*
Expand Down
Loading