Skip to content

Commit

Permalink
[clusters] Implemented ThreadDiagnosticDelegate
Browse files Browse the repository at this point in the history
Added ThreadDiagnosticDelegate to enable generation of optional
events from ThreadNetworkDiagnostics cluster.

Additionally implemented generation of ConnectionStatus
and NetworkFaultChanged events when Thread link state
is changed.
  • Loading branch information
kkasperczyk-no committed Apr 17, 2024
1 parent 3c7c9b1 commit 02f19c7
Show file tree
Hide file tree
Showing 4 changed files with 105 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,17 @@
#include <app/AttributeAccessInterface.h>
#include <app/CommandHandler.h>
#include <app/ConcreteCommandPath.h>
#include <app/EventLogging.h>
#include <app/clusters/thread-network-diagnostics-server/thread-network-diagnostics-provider.h>
#include <app/util/attribute-storage.h>
#include <lib/core/CHIPEncoding.h>
#include <lib/core/Optional.h>
#include <lib/core/TLVTypes.h>
#include <lib/support/CHIPPlatformMemory.h>
#include <platform/CHIPDeviceLayer.h>
#include <platform/DiagnosticDataProvider.h>
#include <tracing/macros.h>
#include <tracing/metric_event.h>

using namespace chip;
using namespace chip::app;
Expand Down Expand Up @@ -132,6 +136,60 @@ CHIP_ERROR ThreadDiagosticsAttrAccess::Read(const ConcreteReadAttributePath & aP
return CHIP_NO_ERROR;
}

class ThreadDiagnosticsDelegate : public DeviceLayer::ThreadDiagnosticsDelegate
{
// Notified when the Node’s connection status to a Thread network has changed.
void OnConnectionStatusChanged(ConnectionStatusEnum newConnectionStatus) override
{
ChipLogProgress(Zcl, "ThreadDiagnosticsDelegate: OnConnectionStatusChanged");

Events::ConnectionStatus::Type event{ newConnectionStatus };

// ThreadNetworkDiagnostics cluster should exist only for endpoint 0.
if (emberAfContainsServer(0, ThreadNetworkDiagnostics::Id))
{
// If Thread Network Diagnostics cluster is implemented on this endpoint
EventNumber eventNumber;

if (CHIP_NO_ERROR != LogEvent(event, 0, eventNumber))
{
ChipLogError(Zcl, "ThreadDiagnosticsDelegate: Failed to record ConnectionStatus event");
}
}
}

// Notified when the Node’s faults related to a Thread network have changed.
void OnNetworkFaultChanged(const GeneralFaults<kMaxNetworkFaults> & previous,
const GeneralFaults<kMaxNetworkFaults> & current) override
{
ChipLogProgress(Zcl, "ThreadDiagnosticsDelegate: OnNetworkFaultChanged");

/* Verify that the data size matches the expected one. */
static_assert(sizeof(*current.data()) == sizeof(NetworkFaultEnum));

DataModel::List<const NetworkFaultEnum> currentList(reinterpret_cast<const NetworkFaultEnum *>(current.data()),
current.size());
DataModel::List<const NetworkFaultEnum> previousList(reinterpret_cast<const NetworkFaultEnum *>(previous.data()),
previous.size());

Events::NetworkFaultChange::Type event{ currentList, previousList };

// ThreadNetworkDiagnostics cluster should exist only for endpoint 0.
if (emberAfContainsServer(0, ThreadNetworkDiagnostics::Id))
{
// If Thread Network Diagnostics cluster is implemented on this endpoint
EventNumber eventNumber;

if (CHIP_NO_ERROR != LogEvent(event, 0, eventNumber))
{
ChipLogError(Zcl, "ThreadDiagnosticsDelegate: Failed to record NetworkFaultChange event");
}
}
}
};

ThreadDiagnosticsDelegate gDiagnosticDelegate;

} // anonymous namespace

bool emberAfThreadNetworkDiagnosticsClusterResetCountsCallback(app::CommandHandler * commandObj,
Expand All @@ -146,4 +204,5 @@ bool emberAfThreadNetworkDiagnosticsClusterResetCountsCallback(app::CommandHandl
void MatterThreadNetworkDiagnosticsPluginServerInitCallback()
{
registerAttributeAccessOverride(&gAttrAccess);
GetDiagnosticDataProvider().SetThreadDiagnosticsDelegate(&gDiagnosticDelegate);
}
28 changes: 27 additions & 1 deletion src/include/platform/DiagnosticDataProvider.h
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,29 @@ class WiFiDiagnosticsDelegate
virtual void OnConnectionStatusChanged(uint8_t connectionStatus) {}
};

/**
* Defines the Thread Diagnostics Delegate class to notify Thread network events.
*/
class ThreadDiagnosticsDelegate
{
public:
virtual ~ThreadDiagnosticsDelegate() {}

/**
* @brief
* Called when the Node’s connection status to a Thread network has changed.
*/
virtual void OnConnectionStatusChanged(app::Clusters::ThreadNetworkDiagnostics::ConnectionStatusEnum newConnectionStatus) {}

/**
* @brief
* Called when the Node detects change in the set of current Thread network faults.
*/
virtual void OnNetworkFaultChanged(const GeneralFaults<kMaxNetworkFaults> & previous,
const GeneralFaults<kMaxNetworkFaults> & current)
{}
};

/**
* Provides access to runtime and build-time configuration information for a chip device.
*/
Expand All @@ -99,6 +122,8 @@ class DiagnosticDataProvider
public:
void SetWiFiDiagnosticsDelegate(WiFiDiagnosticsDelegate * delegate) { mWiFiDiagnosticsDelegate = delegate; }
WiFiDiagnosticsDelegate * GetWiFiDiagnosticsDelegate() const { return mWiFiDiagnosticsDelegate; }
void SetThreadDiagnosticsDelegate(ThreadDiagnosticsDelegate * delegate) { mThreadDiagnosticsDelegate = delegate; }
ThreadDiagnosticsDelegate * GetThreadDiagnosticsDelegate() const { return mThreadDiagnosticsDelegate; }

/**
* General Diagnostics methods.
Expand Down Expand Up @@ -238,7 +263,8 @@ class DiagnosticDataProvider
virtual ~DiagnosticDataProvider() = default;

private:
WiFiDiagnosticsDelegate * mWiFiDiagnosticsDelegate = nullptr;
WiFiDiagnosticsDelegate * mWiFiDiagnosticsDelegate = nullptr;
ThreadDiagnosticsDelegate * mThreadDiagnosticsDelegate = nullptr;

// No copy, move or assignment.
DiagnosticDataProvider(const DiagnosticDataProvider &) = delete;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
#include <app/icd/server/ICDServerConfig.h>
#include <lib/dnssd/Advertiser.h>
#include <lib/dnssd/platform/Dnssd.h>
#include <platform/GeneralFaults.h>
#include <platform/NetworkCommissioning.h>

namespace chip {
Expand Down Expand Up @@ -229,6 +230,7 @@ class GenericThreadStackManagerImpl_OpenThread

DnsBrowseCallback mDnsBrowseCallback;
DnsResolveCallback mDnsResolveCallback;
GeneralFaults<kMaxNetworkFaults> mNetworkFaults;

struct DnsServiceTxtEntries
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
#include <lib/support/FixedBufferAllocator.h>
#include <lib/support/ThreadOperationalDataset.h>
#include <lib/support/logging/CHIPLogging.h>
#include <platform/DiagnosticDataProvider.h>
#include <platform/OpenThread/GenericNetworkCommissioningThreadDriver.h>
#include <platform/OpenThread/GenericThreadStackManagerImpl_OpenThread.h>
#include <platform/OpenThread/OpenThreadUtils.h>
Expand Down Expand Up @@ -223,6 +224,22 @@ void GenericThreadStackManagerImpl_OpenThread<ImplClass>::_OnPlatformEvent(const
{
ChipLogError(DeviceLayer, "Failed to post Thread connectivity change: %" CHIP_ERROR_FORMAT, status.Format());
}

ThreadDiagnosticsDelegate * delegate = GetDiagnosticDataProvider().GetThreadDiagnosticsDelegate();

if (mIsAttached)
{
delegate->OnConnectionStatusChanged(app::Clusters::ThreadNetworkDiagnostics::ConnectionStatusEnum::kConnected);
}
else
{
delegate->OnConnectionStatusChanged(app::Clusters::ThreadNetworkDiagnostics::ConnectionStatusEnum::kNotConnected);

GeneralFaults<kMaxNetworkFaults> current;
current.add(to_underlying(chip::app::Clusters::ThreadNetworkDiagnostics::NetworkFaultEnum::kLinkDown));
delegate->OnNetworkFaultChanged(mNetworkFaults, current);
mNetworkFaults = current;
}
}

#if CHIP_DETAIL_LOGGING
Expand Down

0 comments on commit 02f19c7

Please sign in to comment.