[Code Driven Cluster] Decouple Fan Cluster part 2

examples/air-purifier-app/air-purifier-common/air-purifier-app.matter

@@ -3155,7 +3155,7 @@ endpoint 1 {
     callback attribute acceptedCommandList;
     callback attribute attributeList;
     ram      attribute featureMap default = 63;
-    ram      attribute clusterRevision default = 0x0006;
+    callback attribute clusterRevision;
 
     handle command Step;
   }

examples/air-purifier-app/air-purifier-common/include/air-purifier-manager.h

@@ -91,6 +91,11 @@ class AirPurifierManager : public FanControl::Delegate, public DeviceManager::De
      */
     Protocols::InteractionModel::Status HandleStep(FanControl::StepDirectionEnum aDirection, bool aWrap, bool aLowestOff) override;
 
+    /**
+     * @brief Sync the OnOff cluster when the fan turns on or off via FanControl.
+     */
+    void OnFanStateChanged(bool isOn) override;
+
     /**
      * @brief Callback that thermostat manager calls when the heating state changes
      */

examples/air-purifier-app/air-purifier-common/src/air-purifier-manager.cpp

@@ -17,6 +17,9 @@
  */
 
 #include <air-purifier-manager.h>
+#include <app/clusters/fan-control-server/CodegenIntegration.h>
+#include <app/clusters/fan-control-server/FanControlCluster.h>
+#include <lib/support/CodeUtils.h>
 
 using namespace chip;
 using namespace chip::app;
@@ -90,10 +93,12 @@ Status AirPurifierManager::HandleStep(FanControl::StepDirectionEnum aDirection,
 
     VerifyOrReturnError(aDirection != FanControl::StepDirectionEnum::kUnknownEnumValue, Status::InvalidCommand);
 
-    uint8_t speedMax;
-    FanControl::Attributes::SpeedMax::Get(mEndpointId, &speedMax);
+    FanControlCluster * fc = FanControl::FindClusterOnEndpoint(mEndpointId);
+    VerifyOrReturnError(fc != nullptr, Status::UnsupportedEndpoint);
+    VerifyOrReturnError(fc->GetFeatureMap().Has(FanControl::Feature::kMultiSpeed), Status::Failure);
 
-    DataModel::Nullable<uint8_t> speedSetting = GetSpeedSetting();
+    uint8_t speedMax                          = fc->GetSpeedMax();
+    DataModel::Nullable<uint8_t> speedSetting = fc->GetSpeedSetting();
 
     uint8_t newSpeedSetting = speedSetting.IsNull() ? 0 : speedSetting.Value();
 
@@ -149,7 +154,14 @@ Status AirPurifierManager::HandleStep(FanControl::StepDirectionEnum aDirection,
         }
     }
 
-    return FanControl::Attributes::SpeedSetting::Set(mEndpointId, newSpeedSetting);
+    return fc->SetSpeedSetting(DataModel::Nullable<uint8_t>(newSpeedSetting)).GetStatusCode().GetStatus();
+}
+
+void AirPurifierManager::OnFanStateChanged(bool isOn)
+{
+    ChipLogProgress(NotSpecified, "AirPurifierManager::OnFanStateChanged: %d", isOn);
+    OnOff::Attributes::OnOff::Set(mEndpointId, isOn);
+    mOnOffClusterOn = isOn;
 }
 
 void AirPurifierManager::HandleFanControlAttributeChange(AttributeId attributeId, uint8_t type, uint16_t size, uint8_t * value)
@@ -201,61 +213,13 @@ void AirPurifierManager::HandleOnOff(AttributeId attributeId, uint8_t type, uint
         return;
     }
     bool on = static_cast<bool>(*value);
-    uint8_t new_speed;
-    uint8_t new_percent;
-    if (on)
-    {
-        // If either of these come back as NULL, that should mean the fan is operating in auto mode.
-        // I have no idea what that means for this case, so I'll just set them to high because this
-        // is just an example.
-        // In theory these should always be NULL together or not at all, so hopefully
-        // the checks for only percent.IsNull() or only speed.IsNull() are more theoretical
-        // than practical.
-        DataModel::Nullable<Percent> percent = GetPercentSetting();
-        DataModel::Nullable<uint8_t> speed   = GetSpeedSetting();
-        uint8_t speedMax                     = GetSpeedMax();
-        if (speedMax == 0)
-        {
-            ChipLogError(NotSpecified, "Out of bounds value for SpeedMax, setting to default (1)");
-            speedMax = 1;
-        }
-        if (percent.IsNull() && speed.IsNull())
-        {
-            // Operating in auto mode, set to 100
-            new_percent = 100;
-            new_speed   = speedMax;
-        }
-        else if (percent.IsNull())
-        {
-            // This should never happen, but nonetheless, let's check and warn.
-            ChipLogError(NotSpecified,
-                         "AirPurifierManager::HandleOnOff: PercentSetting is null when SpeedSetting is not. Setting PercentCurrent "
-                         "from Speed");
-            new_speed   = speed.Value();
-            new_percent = static_cast<uint8_t>(new_speed * 100u / speedMax);
-        }
-        else if (speed.IsNull())
-        {
-            // This should never happen, but nonetheless, let's check and warn.
-            ChipLogError(NotSpecified,
-                         "AirPurifierManager::HandleOnOff: SpeedSetting is null when PercentSetting is not. Setting SpeedCurrent "
-                         "from Percent");
-            new_percent = percent.Value();
-            new_speed   = static_cast<uint8_t>(new_percent * speedMax / 100u);
-        }
-        else
-        {
-            new_percent = percent.Value();
-            new_speed   = speed.Value();
-        }
-    }
-    else
+
+    FanControlCluster * fanCluster = FanControl::FindClusterOnEndpoint(mEndpointId);
+    if (fanCluster != nullptr)
     {
-        new_percent = 0;
-        new_speed   = 0;
+        fanCluster->SetOnOffState(on);
     }
-    FanControl::Attributes::SpeedCurrent::Set(mEndpointId, new_speed);
-    FanControl::Attributes::PercentCurrent::Set(mEndpointId, new_percent);
+
     mOnOffClusterOn = on;
 }
 
@@ -264,7 +228,10 @@ void AirPurifierManager::PercentSettingWriteCallback(uint8_t aNewPercentSetting)
     ChipLogDetail(NotSpecified, "AirPurifierManager::PercentSettingWriteCallback: %d", static_cast<int>(aNewPercentSetting));
     if (mOnOffClusterOn)
     {
-        Status status = FanControl::Attributes::PercentCurrent::Set(mEndpointId, aNewPercentSetting);
+        FanControlCluster * c = FanControl::FindClusterOnEndpoint(mEndpointId);
+        Status status         = c == nullptr
+                    ? Status::UnsupportedEndpoint
+                    : c->SetPercentSetting(DataModel::Nullable<Percent>(aNewPercentSetting)).GetStatusCode().GetStatus();
         if (status != Status::Success)
         {
             ChipLogError(NotSpecified,
@@ -279,7 +246,10 @@ void AirPurifierManager::SpeedSettingWriteCallback(uint8_t aNewSpeedSetting)
     ChipLogDetail(NotSpecified, "AirPurifierManager::SpeedSettingWriteCallback: %d", static_cast<int>(aNewSpeedSetting));
     if (mOnOffClusterOn)
     {
-        Status status = FanControl::Attributes::SpeedCurrent::Set(mEndpointId, aNewSpeedSetting);
+        FanControlCluster * c = FanControl::FindClusterOnEndpoint(mEndpointId);
+        Status status         = c == nullptr
+                    ? Status::UnsupportedEndpoint
+                    : c->SetSpeedSetting(DataModel::Nullable<uint8_t>(aNewSpeedSetting)).GetStatusCode().GetStatus();
         if (status != Status::Success)
         {
             ChipLogError(NotSpecified, "AirPurifierManager::SpeedSettingWriteCallback: failed to set SpeedCurrent attribute: %d",
@@ -288,21 +258,30 @@ void AirPurifierManager::SpeedSettingWriteCallback(uint8_t aNewSpeedSetting)
     }
 
     // Determine if the speed change should also change the fan mode
+    FanControl::FanModeEnum fanMode;
     if (aNewSpeedSetting == 0)
     {
-        FanControl::Attributes::FanMode::Set(mEndpointId, FanControl::FanModeEnum::kOff);
+        fanMode = FanControl::FanModeEnum::kOff;
     }
     else if (aNewSpeedSetting <= FAN_MODE_LOW_UPPER_BOUND)
     {
-        FanControl::Attributes::FanMode::Set(mEndpointId, FanControl::FanModeEnum::kLow);
+        fanMode = FanControl::FanModeEnum::kLow;
     }
     else if (aNewSpeedSetting <= FAN_MODE_MEDIUM_UPPER_BOUND)
     {
-        FanControl::Attributes::FanMode::Set(mEndpointId, FanControl::FanModeEnum::kMedium);
+        fanMode = FanControl::FanModeEnum::kMedium;
     }
     else if (aNewSpeedSetting <= FAN_MODE_HIGH_UPPER_BOUND)
     {
-        FanControl::Attributes::FanMode::Set(mEndpointId, FanControl::FanModeEnum::kHigh);
+        fanMode = FanControl::FanModeEnum::kHigh;
+    }
+    else
+    {
+        return;
+    }
+    if (FanControlCluster * c = FanControl::FindClusterOnEndpoint(mEndpointId); c != nullptr)
+    {
+        LogErrorOnFailure(c->SetFanMode(fanMode).GetUnderlyingError());
     }
 }
 
@@ -366,7 +345,8 @@ void AirPurifierManager::SetSpeedSetting(DataModel::Nullable<uint8_t> aNewSpeedS
         return;
     }
 
-    Status status = FanControl::Attributes::SpeedSetting::Set(mEndpointId, aNewSpeedSetting);
+    FanControlCluster * c = FanControl::FindClusterOnEndpoint(mEndpointId);
+    Status status = c == nullptr ? Status::UnsupportedEndpoint : c->SetSpeedSetting(aNewSpeedSetting).GetStatusCode().GetStatus();
     if (status != Status::Success)
     {
         ChipLogError(NotSpecified, "AirPurifierManager::SetSpeedSetting: failed to set SpeedSetting attribute: %d",
@@ -377,39 +357,31 @@ void AirPurifierManager::SetSpeedSetting(DataModel::Nullable<uint8_t> aNewSpeedS
 DataModel::Nullable<uint8_t> AirPurifierManager::GetSpeedSetting()
 {
     DataModel::Nullable<uint8_t> speedSetting;
-    Status status = FanControl::Attributes::SpeedSetting::Get(mEndpointId, speedSetting);
-
-    if (status != Status::Success)
+    FanControlCluster * c = FanControl::FindClusterOnEndpoint(mEndpointId);
+    if (c != nullptr && c->GetFeatureMap().Has(FanControl::Feature::kMultiSpeed))
     {
-        ChipLogError(NotSpecified, "AirPurifierManager::GetSpeedSetting: failed to get SpeedSetting attribute: %d",
-                     to_underlying(status));
+        speedSetting = c->GetSpeedSetting();
     }
-
     return speedSetting;
 }
 
 DataModel::Nullable<Percent> AirPurifierManager::GetPercentSetting()
 {
     DataModel::Nullable<Percent> percentSetting;
-    Status status = FanControl::Attributes::PercentSetting::Get(mEndpointId, percentSetting);
-
-    if (status != Status::Success)
+    if (FanControlCluster * c = FanControl::FindClusterOnEndpoint(mEndpointId); c != nullptr)
     {
-        ChipLogError(NotSpecified, "AirPurifierManager::GetPercentSetting: failed to get PercentSetting attribute: %d",
-                     to_underlying(status));
+        percentSetting = c->GetPercentSetting();
     }
-
     return percentSetting;
 }
 
 uint8_t AirPurifierManager::GetSpeedMax()
 {
     uint8_t speedMax = 1;
-    Status status    = FanControl::Attributes::SpeedMax::Get(mEndpointId, &speedMax);
-    if (status != Status::Success)
+    if (FanControlCluster * c = FanControl::FindClusterOnEndpoint(mEndpointId);
+        c != nullptr && c->GetFeatureMap().Has(FanControl::Feature::kMultiSpeed))
     {
-        ChipLogError(NotSpecified, "AirPurifierManager::GetPercentSetting: failed to get SpeedMax attribute: %d",
-                     to_underlying(status));
+        speedMax = c->GetSpeedMax();
     }
     return speedMax;
 }

examples/all-clusters-app/all-clusters-common/all-clusters-app.matter

@@ -8275,7 +8275,7 @@ endpoint 1 {
     ram      attribute windSetting default = 0x00;
     ram      attribute airflowDirection default = 0;
     ram      attribute featureMap default = 0x3F;
-    ram      attribute clusterRevision default = 0x0006;
+    callback attribute clusterRevision;
 
     handle command Step;
   }

examples/all-clusters-app/all-clusters-common/src/fan-stub.cpp

@@ -21,8 +21,11 @@
 #include <app-common/zap-generated/ids/Clusters.h>
 #include <app/AttributeAccessInterface.h>
 #include <app/AttributeAccessInterfaceRegistry.h>
+#include <app/clusters/fan-control-server/CodegenIntegration.h>
+#include <app/clusters/fan-control-server/FanControlCluster.h>
 #include <app/clusters/fan-control-server/fan-control-server.h>
 #include <app/util/attribute-storage.h>
+#include <app/util/attribute-table.h>
 #include <lib/support/CodeUtils.h>
 #include <lib/support/logging/CHIPLogging.h>
 
@@ -44,6 +47,7 @@ class FanControlManager : public AttributeAccessInterface, public Delegate
 
     CHIP_ERROR Read(const ConcreteReadAttributePath & aPath, AttributeValueEncoder & aEncoder) override;
     Status HandleStep(StepDirectionEnum aDirection, bool aWrap, bool aLowestOff) override;
+    void OnFanStateChanged(bool isOn) override;
 
 private:
     CHIP_ERROR ReadPercentCurrent(AttributeValueEncoder & aEncoder);
@@ -56,7 +60,10 @@ CHIP_ERROR FanControlManager::ReadPercentCurrent(AttributeValueEncoder & aEncode
 {
     // Return PercentSetting attribute value for now
     DataModel::Nullable<Percent> percentSetting;
-    PercentSetting::Get(mEndpoint, percentSetting);
+    if (FanControlCluster * c = FanControl::FindClusterOnEndpoint(mEndpoint); c != nullptr)
+    {
+        percentSetting = c->GetPercentSetting();
+    }
     Percent ret = 0;
     if (!percentSetting.IsNull())
     {
@@ -70,7 +77,11 @@ CHIP_ERROR FanControlManager::ReadSpeedCurrent(AttributeValueEncoder & aEncoder)
 {
     // Return SpeedCurrent attribute value for now
     DataModel::Nullable<uint8_t> speedSetting;
-    SpeedSetting::Get(mEndpoint, speedSetting);
+    if (FanControlCluster * c = FanControl::FindClusterOnEndpoint(mEndpoint);
+        c != nullptr && c->GetFeatureMap().Has(FanControl::Feature::kMultiSpeed))
+    {
+        speedSetting = c->GetSpeedSetting();
+    }
     uint8_t ret = 0;
     if (!speedSetting.IsNull())
     {
@@ -80,20 +91,29 @@ CHIP_ERROR FanControlManager::ReadSpeedCurrent(AttributeValueEncoder & aEncoder)
     return aEncoder.Encode(ret);
 }
 
+void FanControlManager::OnFanStateChanged(bool isOn)
+{
+    ChipLogProgress(NotSpecified, "FanControlManager::OnFanStateChanged: %d", isOn);
+    OnOff::Attributes::OnOff::Set(mEndpoint, isOn);
+}
+
 Status FanControlManager::HandleStep(StepDirectionEnum aDirection, bool aWrap, bool aLowestOff)
 {
     ChipLogProgress(NotSpecified, "FanControlManager::HandleStep aDirection %d, aWrap %d, aLowestOff %d", to_underlying(aDirection),
                     aWrap, aLowestOff);
 
     VerifyOrReturnError(aDirection != StepDirectionEnum::kUnknownEnumValue, Status::InvalidCommand);
 
-    uint8_t speedMax;
-    SpeedMax::Get(mEndpoint, &speedMax);
-
+    FanControlCluster * cluster = FanControl::FindClusterOnEndpoint(mEndpoint);
+    uint8_t speedMax            = 0;
     DataModel::Nullable<uint8_t> speedSetting;
-    SpeedSetting::Get(mEndpoint, speedSetting);
+    if (cluster != nullptr && cluster->GetFeatureMap().Has(FanControl::Feature::kMultiSpeed))
+    {
+        speedMax     = cluster->GetSpeedMax();
+        speedSetting = cluster->GetSpeedSetting();
+    }
 
-    uint8_t newSpeedSetting = speedSetting.IsNull() ? 0 : speedSetting.Value();
+    uint8_t newSpeedSetting = speedSetting.ValueOr(0);
 
     if (aDirection == StepDirectionEnum::kIncrease)
     {
@@ -147,7 +167,11 @@ Status FanControlManager::HandleStep(StepDirectionEnum aDirection, bool aWrap, b
         }
     }
 
-    return SpeedSetting::Set(mEndpoint, newSpeedSetting);
+    if (cluster == nullptr)
+    {
+        return Status::UnsupportedEndpoint;
+    }
+    return cluster->SetSpeedSetting(DataModel::MakeNullable(newSpeedSetting)).GetStatusCode().GetStatus();
 }
 
 CHIP_ERROR FanControlManager::Read(const ConcreteReadAttributePath & aPath, AttributeValueEncoder & aEncoder)

examples/all-clusters-app/realtek/data_model/all-clusters-app.matter

@@ -9141,7 +9141,7 @@ endpoint 1 {
     ram      attribute windSetting default = 0x00;
     ram      attribute airflowDirection default = 0;
     ram      attribute featureMap default = 0x3F;
-    ram      attribute clusterRevision default = 0x0006;
+    callback attribute clusterRevision;
 
     handle command Step;
   }

examples/all-clusters-minimal-app/all-clusters-common/all-clusters-minimal-app.matter

@@ -7049,7 +7049,7 @@ endpoint 1 {
     ram      attribute percentSetting default = 0x00;
     ram      attribute percentCurrent default = 0x00;
     ram      attribute featureMap default = 0;
-    ram      attribute clusterRevision default = 0x0006;
+    callback attribute clusterRevision;
   }
 
   server cluster ThermostatUserInterfaceConfiguration {

examples/all-devices-app/all-devices-common/devices/device-factory/BUILD.gn

@@ -22,6 +22,7 @@ source_set("device-factory") {
     "${chip_root}/examples/all-devices-app/all-devices-common/devices/boolean-state-sensor",
     "${chip_root}/examples/all-devices-app/all-devices-common/devices/chime",
     "${chip_root}/examples/all-devices-app/all-devices-common/devices/dimmable-light/impl:logging",
+    "${chip_root}/examples/all-devices-app/all-devices-common/devices/fan/impl:logging",
     "${chip_root}/examples/all-devices-app/all-devices-common/devices/occupancy-sensor/impl:toggling",
     "${chip_root}/examples/all-devices-app/all-devices-common/devices/on-off-light",
     "${chip_root}/examples/all-devices-app/all-devices-common/devices/soil-sensor/impl:increasing",

examples/all-devices-app/all-devices-common/devices/device-factory/DeviceFactory.h

@@ -21,6 +21,7 @@
 #include <devices/boolean-state-sensor/BooleanStateSensorDevice.h>
 #include <devices/chime/ChimeDevice.h>
 #include <devices/dimmable-light/impl/LoggingDimmableLightDevice.h>
+#include <devices/fan/impl/LoggingFanDevice.h>
 #include <devices/occupancy-sensor/impl/TogglingOccupancySensorDevice.h>
 #include <devices/on-off-light/LoggingOnOffLightDevice.h>
 #include <devices/soil-sensor/impl/IncreasingMoistureSoilSensorDevice.h>
@@ -140,6 +141,14 @@ class DeviceFactory
                 LoggingSpeakerDevice::Context{ .timerDelegate = mContext->timerDelegate });
         };
         mRegistry["soil-sensor"] = []() { return std::make_unique<IncreasingMoistureSoilSensorDevice>(); };
+        mRegistry["fan"]         = [this]() {
+            VerifyOrDie(mContext.has_value());
+            return std::make_unique<LoggingFanDevice>(LoggingFanDevice::Context{
+                        .groupDataProvider = mContext->groupDataProvider,
+                        .fabricTable       = mContext->fabricTable,
+                        .timerDelegate     = mContext->timerDelegate,
+            });
+        };
     }
 };