Handle the RvcOperationalState GoHome command

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

@@ -3420,6 +3420,8 @@ cluster RvcOperationalState = 97 {
   command Start(): OperationalCommandResponse = 2;
   /** Upon receipt, the device SHALL resume its operation from the point it was at when it received the Pause command, or from the point when it was paused by means outside of this cluster (for example by manual button press). */
   command Resume(): OperationalCommandResponse = 3;
+  /** On receipt of this command, the device SHALL start seeking the charging dock, if possible in the current state of the device. */
+  command GoHome(): OperationalCommandResponse = 128;
 }
 
 /** Attributes and commands for scene configuration and manipulation. */
@@ -7786,6 +7788,7 @@ endpoint 1 {
     handle command Pause;
     handle command Resume;
     handle command OperationalCommandResponse;
+    handle command GoHome;
   }
 
   server cluster ScenesManagement {

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

@@ -11262,6 +11262,14 @@
               "source": "server",
               "isIncoming": 0,
               "isEnabled": 1
+            },
+            {
+              "name": "GoHome",
+              "code": 128,
+              "mfgCode": null,
+              "source": "client",
+              "isIncoming": 1,
+              "isEnabled": 1
             }
           ],
           "attributes": [

examples/all-clusters-app/all-clusters-common/include/operational-state-delegate-impl.h

@@ -111,38 +111,11 @@ class OperationalStateDelegate : public GenericOperationalStateDelegateImpl
     }
 };
 
-void Shutdown();
-
-} // namespace OperationalState
-
-namespace RvcOperationalState {
-
-// This is an application level delegate to handle operational state commands according to the specific business logic.
-class RvcOperationalStateDelegate : public OperationalState::GenericOperationalStateDelegateImpl
-{
-private:
-    const OperationalState::GenericOperationalState rvcOpStateList[7] = {
-        OperationalState::GenericOperationalState(to_underlying(OperationalState::OperationalStateEnum::kStopped)),
-        OperationalState::GenericOperationalState(to_underlying(OperationalState::OperationalStateEnum::kRunning)),
-        OperationalState::GenericOperationalState(to_underlying(OperationalState::OperationalStateEnum::kPaused)),
-        OperationalState::GenericOperationalState(to_underlying(OperationalState::OperationalStateEnum::kError)),
-        OperationalState::GenericOperationalState(
-            to_underlying(Clusters::RvcOperationalState::OperationalStateEnum::kSeekingCharger)),
-        OperationalState::GenericOperationalState(to_underlying(Clusters::RvcOperationalState::OperationalStateEnum::kCharging)),
-        OperationalState::GenericOperationalState(to_underlying(Clusters::RvcOperationalState::OperationalStateEnum::kDocked)),
-    };
-
-public:
-    RvcOperationalStateDelegate()
-    {
-        GenericOperationalStateDelegateImpl::mOperationalStateList =
-            Span<const OperationalState::GenericOperationalState>(rvcOpStateList);
-    }
-};
+Instance * GetOperationalStateInstance();
 
 void Shutdown();
 
-} // namespace RvcOperationalState
+} // namespace OperationalState
 } // namespace Clusters
 } // namespace app
 } // namespace chip

examples/all-clusters-app/ameba/main/include/OperationalStateManager.h → examples/all-clusters-app/all-clusters-common/include/rvc-operational-state-delegate-impl.h

@@ -23,20 +23,34 @@
 #include <app/util/af-enums.h>
 #include <protocols/interaction_model/StatusCode.h>
 
-void getOperationalStateSet(u8 state);
-
 namespace chip {
 namespace app {
 namespace Clusters {
 
-namespace OperationalState {
-
-Instance * GetOperationalStateInstance();
+namespace RvcOperationalState {
 
 // This is an application level delegate to handle operational state commands according to the specific business logic.
-class GenericOperationalStateDelegateImpl : public Delegate
+class RvcOperationalStateDelegate : public Delegate
 {
+private:
+    const Clusters::OperationalState::GenericOperationalState rvcOpStateList[7] = {
+        OperationalState::GenericOperationalState(to_underlying(OperationalState::OperationalStateEnum::kStopped)),
+        OperationalState::GenericOperationalState(to_underlying(OperationalState::OperationalStateEnum::kRunning)),
+        OperationalState::GenericOperationalState(to_underlying(OperationalState::OperationalStateEnum::kPaused)),
+        OperationalState::GenericOperationalState(to_underlying(OperationalState::OperationalStateEnum::kError)),
+        OperationalState::GenericOperationalState(
+            to_underlying(Clusters::RvcOperationalState::OperationalStateEnum::kSeekingCharger)),
+        OperationalState::GenericOperationalState(to_underlying(Clusters::RvcOperationalState::OperationalStateEnum::kCharging)),
+        OperationalState::GenericOperationalState(to_underlying(Clusters::RvcOperationalState::OperationalStateEnum::kDocked)),
+    };
+
+    Span<const OperationalState::GenericOperationalState> mOperationalStateList =
+        Span<const OperationalState::GenericOperationalState>(rvcOpStateList);
+    Span<const CharSpan> mOperationalPhaseList;
+
 public:
+    RvcOperationalStateDelegate() {}
+
     /**
      * Get the countdown time. This attribute is not used in this application.
      * @return The current countdown time.
@@ -51,19 +65,15 @@ class GenericOperationalStateDelegateImpl : public Delegate
      * @param index The index of the state, with 0 representing the first state.
      * @param operationalState  The GenericOperationalState is filled.
      */
-    CHIP_ERROR GetOperationalStateAtIndex(size_t index, GenericOperationalState & operationalState) override;
+    CHIP_ERROR GetOperationalStateAtIndex(size_t index, OperationalState::GenericOperationalState & operationalState) override;
 
     /**
-     * Fills in the provided MutableCharSpan with the phase at index `index` if there is one,
+     * Fills in the provided GenericOperationalPhase with the phase at index `index` if there is one,
      * or returns CHIP_ERROR_NOT_FOUND if the index is out of range for the list of phases.
-     *
-     * If CHIP_ERROR_NOT_FOUND is returned for index 0, that indicates that the PhaseList attribute is null
-     * (there are no phases defined at all).
-     *
      * Note: This is used by the SDK to populate the phase list attribute. If the contents of this list changes, the
      * device SHALL call the Instance's ReportPhaseListChange method to report that this attribute has changed.
      * @param index The index of the phase, with 0 representing the first phase.
-     * @param operationalPhase  The MutableCharSpan is filled.
+     * @param operationalPhase  The GenericOperationalPhase is filled.
      */
     CHIP_ERROR GetOperationalPhaseAtIndex(size_t index, MutableCharSpan & operationalPhase) override;
 
@@ -72,82 +82,37 @@ class GenericOperationalStateDelegateImpl : public Delegate
      * Handle Command Callback in application: Pause
      * @param[out] get operational error after callback.
      */
-    void HandlePauseStateCallback(GenericOperationalError & err) override;
+    void HandlePauseStateCallback(OperationalState::GenericOperationalError & err) override;
 
     /**
      * Handle Command Callback in application: Resume
      * @param[out] get operational error after callback.
      */
-    void HandleResumeStateCallback(GenericOperationalError & err) override;
+    void HandleResumeStateCallback(OperationalState::GenericOperationalError & err) override;
 
     /**
      * Handle Command Callback in application: Start
      * @param[out] get operational error after callback.
      */
-    void HandleStartStateCallback(GenericOperationalError & err) override;
+    void HandleStartStateCallback(OperationalState::GenericOperationalError & err) override;
 
     /**
      * Handle Command Callback in application: Stop
      * @param[out] get operational error after callback.
      */
-    void HandleStopStateCallback(GenericOperationalError & err) override;
-
-protected:
-    Span<const GenericOperationalState> mOperationalStateList;
-    Span<const CharSpan> mOperationalPhaseList;
-};
-
-// This is an application level delegate to handle operational state commands according to the specific business logic.
-class OperationalStateDelegate : public GenericOperationalStateDelegateImpl
-{
-private:
-    const GenericOperationalState opStateList[4] = {
-        GenericOperationalState(to_underlying(OperationalStateEnum::kStopped)),
-        GenericOperationalState(to_underlying(OperationalStateEnum::kRunning)),
-        GenericOperationalState(to_underlying(OperationalStateEnum::kPaused)),
-        GenericOperationalState(to_underlying(OperationalStateEnum::kError)),
-    };
+    void HandleStopStateCallback(OperationalState::GenericOperationalError & err) override;
 
-public:
-    OperationalStateDelegate()
-    {
-        GenericOperationalStateDelegateImpl::mOperationalStateList = Span<const GenericOperationalState>(opStateList);
-    }
+    /**
+     * Handle the GoHome command.
+     * @param err
+     */
+    void HandleGoHomeCommandCallback(OperationalState::GenericOperationalError & err) override;
 };
 
 void Shutdown();
 
-} // namespace OperationalState
-
-namespace RvcOperationalState {
-
 Instance * GetRvcOperationalStateInstance();
 
-// This is an application level delegate to handle operational state commands according to the specific business logic.
-class RvcOperationalStateDelegate : public OperationalState::GenericOperationalStateDelegateImpl
-{
-private:
-    const OperationalState::GenericOperationalState rvcOpStateList[7] = {
-        OperationalState::GenericOperationalState(to_underlying(OperationalState::OperationalStateEnum::kStopped)),
-        OperationalState::GenericOperationalState(to_underlying(OperationalState::OperationalStateEnum::kRunning)),
-        OperationalState::GenericOperationalState(to_underlying(OperationalState::OperationalStateEnum::kPaused)),
-        OperationalState::GenericOperationalState(to_underlying(OperationalState::OperationalStateEnum::kError)),
-        OperationalState::GenericOperationalState(
-            to_underlying(Clusters::RvcOperationalState::OperationalStateEnum::kSeekingCharger)),
-        OperationalState::GenericOperationalState(to_underlying(Clusters::RvcOperationalState::OperationalStateEnum::kCharging)),
-        OperationalState::GenericOperationalState(to_underlying(Clusters::RvcOperationalState::OperationalStateEnum::kDocked)),
-    };
-
-public:
-    RvcOperationalStateDelegate()
-    {
-        GenericOperationalStateDelegateImpl::mOperationalStateList =
-            Span<const OperationalState::GenericOperationalState>(rvcOpStateList);
-    }
-};
-
-void Shutdown();
-
 } // namespace RvcOperationalState
 } // namespace Clusters
 } // namespace app

examples/all-clusters-app/all-clusters-common/src/air-quality-instance.cpp

@@ -1,3 +1,20 @@
+/*
+ *
+ *    Copyright (c) 2023 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 <air-quality-instance.h>
 
 using namespace chip::app::Clusters;

examples/all-clusters-app/all-clusters-common/src/operational-state-delegate-impl.cpp

@@ -103,6 +103,11 @@ void GenericOperationalStateDelegateImpl::HandleStopStateCallback(GenericOperati
 static OperationalState::Instance * gOperationalStateInstance = nullptr;
 static OperationalStateDelegate * gOperationalStateDelegate   = nullptr;
 
+OperationalState::Instance * OperationalState::GetOperationalStateInstance()
+{
+    return gOperationalStateInstance;
+}
+
 void OperationalState::Shutdown()
 {
     if (gOperationalStateInstance != nullptr)
@@ -130,36 +135,3 @@ void emberAfOperationalStateClusterInitCallback(chip::EndpointId endpointId)
 
     gOperationalStateInstance->Init();
 }
-
-// Init RVC Operational State cluster
-
-static OperationalState::Instance * gRvcOperationalStateInstance  = nullptr;
-static RvcOperationalStateDelegate * gRvcOperationalStateDelegate = nullptr;
-
-void RvcOperationalState::Shutdown()
-{
-    if (gRvcOperationalStateInstance != nullptr)
-    {
-        delete gRvcOperationalStateInstance;
-        gRvcOperationalStateInstance = nullptr;
-    }
-    if (gRvcOperationalStateDelegate != nullptr)
-    {
-        delete gRvcOperationalStateDelegate;
-        gRvcOperationalStateDelegate = nullptr;
-    }
-}
-
-void emberAfRvcOperationalStateClusterInitCallback(chip::EndpointId endpointId)
-{
-    VerifyOrDie(endpointId == 1); // this cluster is only enabled for endpoint 1.
-    VerifyOrDie(gRvcOperationalStateInstance == nullptr && gRvcOperationalStateDelegate == nullptr);
-
-    gRvcOperationalStateDelegate        = new RvcOperationalStateDelegate;
-    EndpointId operationalStateEndpoint = 0x01;
-    gRvcOperationalStateInstance        = new RvcOperationalState::Instance(gRvcOperationalStateDelegate, operationalStateEndpoint);
-
-    gRvcOperationalStateInstance->SetOperationalState(to_underlying(OperationalState::OperationalStateEnum::kStopped));
-
-    gRvcOperationalStateInstance->Init();
-}