| /** |
| * |
| * Copyright (c) 2021 Project CHIP Authors |
| * |
| * 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 <app-common/zap-generated/attributes/Accessors.h> |
| #include <app-common/zap-generated/cluster-objects.h> |
| #include <app-common/zap-generated/ids/Attributes.h> |
| #include <app-common/zap-generated/ids/Clusters.h> |
| #include <app/AttributeAccessInterface.h> |
| #include <app/CommandHandler.h> |
| #include <app/ConcreteCommandPath.h> |
| #include <app/EventLogging.h> |
| #include <app/util/af.h> |
| #include <app/util/attribute-storage.h> |
| #include <lib/core/Optional.h> |
| #include <platform/DiagnosticDataProvider.h> |
| |
| using namespace chip; |
| using namespace chip::app; |
| using namespace chip::app::Clusters; |
| using namespace chip::app::Clusters::WiFiNetworkDiagnostics; |
| using namespace chip::app::Clusters::WiFiNetworkDiagnostics::Attributes; |
| using chip::DeviceLayer::DiagnosticDataProvider; |
| using chip::DeviceLayer::GetDiagnosticDataProvider; |
| |
| namespace { |
| |
| class WiFiDiagosticsAttrAccess : public AttributeAccessInterface |
| { |
| public: |
| // Register for the WiFiNetworkDiagnostics cluster on all endpoints. |
| WiFiDiagosticsAttrAccess() : AttributeAccessInterface(Optional<EndpointId>::Missing(), WiFiNetworkDiagnostics::Id) {} |
| |
| CHIP_ERROR Read(const ConcreteReadAttributePath & aPath, AttributeValueEncoder & aEncoder) override; |
| |
| private: |
| template <typename T, typename Type> |
| CHIP_ERROR ReadIfSupported(CHIP_ERROR (DiagnosticDataProvider::*getter)(T &), Type & data, AttributeValueEncoder & aEncoder); |
| |
| CHIP_ERROR ReadWiFiBssId(AttributeValueEncoder & aEncoder); |
| CHIP_ERROR ReadSecurityType(AttributeValueEncoder & aEncoder); |
| CHIP_ERROR ReadWiFiVersion(AttributeValueEncoder & aEncoder); |
| CHIP_ERROR ReadChannelNumber(AttributeValueEncoder & aEncoder); |
| CHIP_ERROR ReadWiFiRssi(AttributeValueEncoder & aEncoder); |
| }; |
| |
| template <typename T, typename Type> |
| CHIP_ERROR WiFiDiagosticsAttrAccess::ReadIfSupported(CHIP_ERROR (DiagnosticDataProvider::*getter)(T &), Type & data, |
| AttributeValueEncoder & aEncoder) |
| { |
| T value; |
| CHIP_ERROR err = (DeviceLayer::GetDiagnosticDataProvider().*getter)(value); |
| |
| if (err == CHIP_NO_ERROR) |
| { |
| data.SetNonNull(value); |
| } |
| else |
| { |
| ChipLogProgress(Zcl, "The WiFi interface is not currently configured or operational."); |
| } |
| |
| return aEncoder.Encode(data); |
| } |
| |
| CHIP_ERROR WiFiDiagosticsAttrAccess::ReadWiFiBssId(AttributeValueEncoder & aEncoder) |
| { |
| Attributes::Bssid::TypeInfo::Type bssid; |
| ByteSpan value; |
| |
| if (DeviceLayer::GetDiagnosticDataProvider().GetWiFiBssId(value) == CHIP_NO_ERROR) |
| { |
| if (!value.empty()) |
| { |
| bssid.SetNonNull(value); |
| ChipLogProgress(Zcl, "Node is currently connected to Wi-Fi network with BSSID:"); |
| ChipLogByteSpan(Zcl, value); |
| } |
| } |
| else |
| { |
| ChipLogProgress(Zcl, "The WiFi interface is not currently connected."); |
| } |
| |
| return aEncoder.Encode(bssid); |
| } |
| |
| CHIP_ERROR WiFiDiagosticsAttrAccess::ReadSecurityType(AttributeValueEncoder & aEncoder) |
| { |
| Attributes::SecurityType::TypeInfo::Type securityType; |
| uint8_t value = 0; |
| |
| if (DeviceLayer::GetDiagnosticDataProvider().GetWiFiSecurityType(value) == CHIP_NO_ERROR) |
| { |
| securityType.SetNonNull(static_cast<WiFiNetworkDiagnostics::SecurityType>(value)); |
| ChipLogProgress(Zcl, "The current type of Wi-Fi security used: %d", value); |
| } |
| else |
| { |
| ChipLogProgress(Zcl, "The WiFi interface is not currently configured or operational."); |
| } |
| |
| return aEncoder.Encode(securityType); |
| } |
| |
| CHIP_ERROR WiFiDiagosticsAttrAccess::ReadWiFiVersion(AttributeValueEncoder & aEncoder) |
| { |
| Attributes::WiFiVersion::TypeInfo::Type version; |
| uint8_t value = 0; |
| |
| if (DeviceLayer::GetDiagnosticDataProvider().GetWiFiVersion(value) == CHIP_NO_ERROR) |
| { |
| version.SetNonNull(static_cast<WiFiNetworkDiagnostics::WiFiVersionType>(value)); |
| ChipLogProgress(Zcl, "The current 802.11 standard version in use by the Node: %d", value); |
| } |
| else |
| { |
| ChipLogProgress(Zcl, "The current 802.11 standard version in use by the Node is not available"); |
| } |
| |
| return aEncoder.Encode(version); |
| } |
| |
| CHIP_ERROR WiFiDiagosticsAttrAccess::ReadChannelNumber(AttributeValueEncoder & aEncoder) |
| { |
| Attributes::ChannelNumber::TypeInfo::Type channelNumber; |
| uint16_t value = 0; |
| |
| if (DeviceLayer::GetDiagnosticDataProvider().GetWiFiChannelNumber(value) == CHIP_NO_ERROR) |
| { |
| channelNumber.SetNonNull(value); |
| ChipLogProgress(Zcl, "The channel that Wi-Fi communication is currently operating on is: %d", value); |
| } |
| else |
| { |
| ChipLogProgress(Zcl, "The WiFi interface is not currently configured or operational."); |
| } |
| |
| return aEncoder.Encode(channelNumber); |
| } |
| |
| CHIP_ERROR WiFiDiagosticsAttrAccess::ReadWiFiRssi(AttributeValueEncoder & aEncoder) |
| { |
| Attributes::Rssi::TypeInfo::Type rssi; |
| int8_t value = 0; |
| |
| if (DeviceLayer::GetDiagnosticDataProvider().GetWiFiRssi(value) == CHIP_NO_ERROR) |
| { |
| rssi.SetNonNull(value); |
| ChipLogProgress(Zcl, "The current RSSI of the Node’s Wi-Fi radio in dB: %d", value); |
| } |
| else |
| { |
| ChipLogProgress(Zcl, "The WiFi interface is not currently configured or operational."); |
| } |
| |
| return aEncoder.Encode(rssi); |
| } |
| |
| WiFiDiagosticsAttrAccess gAttrAccess; |
| |
| CHIP_ERROR WiFiDiagosticsAttrAccess::Read(const ConcreteReadAttributePath & aPath, AttributeValueEncoder & aEncoder) |
| { |
| if (aPath.mClusterId != WiFiNetworkDiagnostics::Id) |
| { |
| // We shouldn't have been called at all. |
| return CHIP_ERROR_INVALID_ARGUMENT; |
| } |
| |
| switch (aPath.mAttributeId) |
| { |
| case Bssid::Id: { |
| return ReadWiFiBssId(aEncoder); |
| } |
| case Attributes::SecurityType::Id: { |
| return ReadSecurityType(aEncoder); |
| } |
| case WiFiVersion::Id: { |
| return ReadWiFiVersion(aEncoder); |
| } |
| case ChannelNumber::Id: { |
| return ReadChannelNumber(aEncoder); |
| } |
| case Rssi::Id: { |
| return ReadWiFiRssi(aEncoder); |
| } |
| case BeaconLostCount::Id: { |
| Attributes::BeaconLostCount::TypeInfo::Type count; |
| return ReadIfSupported(&DiagnosticDataProvider::GetWiFiBeaconLostCount, count, aEncoder); |
| } |
| case BeaconRxCount::Id: { |
| Attributes::BeaconRxCount::TypeInfo::Type count; |
| return ReadIfSupported(&DiagnosticDataProvider::GetWiFiBeaconRxCount, count, aEncoder); |
| } |
| case PacketMulticastRxCount::Id: { |
| Attributes::PacketMulticastRxCount::TypeInfo::Type count; |
| return ReadIfSupported(&DiagnosticDataProvider::GetWiFiPacketMulticastRxCount, count, aEncoder); |
| } |
| case PacketMulticastTxCount::Id: { |
| Attributes::PacketMulticastTxCount::TypeInfo::Type count; |
| return ReadIfSupported(&DiagnosticDataProvider::GetWiFiPacketMulticastTxCount, count, aEncoder); |
| } |
| case PacketUnicastRxCount::Id: { |
| Attributes::PacketUnicastRxCount::TypeInfo::Type count; |
| return ReadIfSupported(&DiagnosticDataProvider::GetWiFiPacketUnicastRxCount, count, aEncoder); |
| } |
| case PacketUnicastTxCount::Id: { |
| Attributes::PacketUnicastTxCount::TypeInfo::Type count; |
| return ReadIfSupported(&DiagnosticDataProvider::GetWiFiPacketUnicastTxCount, count, aEncoder); |
| } |
| case CurrentMaxRate::Id: { |
| Attributes::CurrentMaxRate::TypeInfo::Type rate; |
| return ReadIfSupported(&DiagnosticDataProvider::GetWiFiCurrentMaxRate, rate, aEncoder); |
| } |
| case OverrunCount::Id: { |
| Attributes::OverrunCount::TypeInfo::Type count; |
| return ReadIfSupported(&DiagnosticDataProvider::GetWiFiOverrunCount, count, aEncoder); |
| } |
| default: { |
| break; |
| } |
| } |
| return CHIP_NO_ERROR; |
| } |
| |
| class WiFiDiagnosticsDelegate : public DeviceLayer::WiFiDiagnosticsDelegate |
| { |
| // Gets called when the Node detects Node’s Wi-Fi connection has been disconnected. |
| void OnDisconnectionDetected(uint16_t reasonCode) override |
| { |
| ChipLogProgress(Zcl, "WiFiDiagnosticsDelegate: OnDisconnectionDetected"); |
| |
| for (auto endpoint : EnabledEndpointsWithServerCluster(WiFiNetworkDiagnostics::Id)) |
| { |
| // If WiFi Network Diagnostics cluster is implemented on this endpoint |
| Events::Disconnection::Type event{ reasonCode }; |
| EventNumber eventNumber; |
| |
| if (CHIP_NO_ERROR != LogEvent(event, endpoint, eventNumber)) |
| { |
| ChipLogError(Zcl, "WiFiDiagnosticsDelegate: Failed to record Disconnection event"); |
| } |
| } |
| } |
| |
| // Gets called when the Node fails to associate or authenticate an access point. |
| void OnAssociationFailureDetected(uint8_t associationFailureCause, uint16_t status) override |
| { |
| ChipLogProgress(Zcl, "WiFiDiagnosticsDelegate: OnAssociationFailureDetected"); |
| |
| Events::AssociationFailure::Type event{ static_cast<AssociationFailureCause>(associationFailureCause), status }; |
| |
| for (auto endpoint : EnabledEndpointsWithServerCluster(WiFiNetworkDiagnostics::Id)) |
| { |
| // If WiFi Network Diagnostics cluster is implemented on this endpoint |
| EventNumber eventNumber; |
| |
| if (CHIP_NO_ERROR != LogEvent(event, endpoint, eventNumber)) |
| { |
| ChipLogError(Zcl, "WiFiDiagnosticsDelegate: Failed to record AssociationFailure event"); |
| } |
| } |
| } |
| |
| // Gets when the Node’s connection status to a Wi-Fi network has changed. |
| void OnConnectionStatusChanged(uint8_t connectionStatus) override |
| { |
| ChipLogProgress(Zcl, "WiFiDiagnosticsDelegate: OnConnectionStatusChanged"); |
| |
| Events::ConnectionStatus::Type event{ static_cast<WiFiConnectionStatus>(connectionStatus) }; |
| for (auto endpoint : EnabledEndpointsWithServerCluster(WiFiNetworkDiagnostics::Id)) |
| { |
| // If WiFi Network Diagnostics cluster is implemented on this endpoint |
| EventNumber eventNumber; |
| |
| if (CHIP_NO_ERROR != LogEvent(event, endpoint, eventNumber)) |
| { |
| ChipLogError(Zcl, "WiFiDiagnosticsDelegate: Failed to record ConnectionStatus event"); |
| } |
| } |
| } |
| }; |
| |
| WiFiDiagnosticsDelegate gDiagnosticDelegate; |
| |
| } // anonymous namespace |
| |
| bool emberAfWiFiNetworkDiagnosticsClusterResetCountsCallback(app::CommandHandler * commandObj, |
| const app::ConcreteCommandPath & commandPath, |
| const Commands::ResetCounts::DecodableType & commandData) |
| { |
| DeviceLayer::GetDiagnosticDataProvider().ResetWiFiNetworkDiagnosticsCounts(); |
| commandObj->AddStatus(commandPath, Protocols::InteractionModel::Status::Success); |
| |
| return true; |
| } |
| |
| void MatterWiFiNetworkDiagnosticsPluginServerInitCallback() |
| { |
| registerAttributeAccessOverride(&gAttrAccess); |
| GetDiagnosticDataProvider().SetWiFiDiagnosticsDelegate(&gDiagnosticDelegate); |
| } |
