ZoneMgmtCluster Migration PR#3 move structs

src/app/clusters/zone-management-server/CodegenIntegration.h

@@ -0,0 +1,172 @@
+/*
+ *
+ *    Copyright (c) 2026 Project CHIP Authors
+ *    All rights reserved.
+ *
+ *    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.
+ */
+
+#pragma once
+
+#include <app/AttributeAccessInterface.h>
+#include <app/CommandHandlerInterface.h>
+#include <app/SafeAttributePersistenceProvider.h>
+#include <app/StatusResponse.h>
+#include <app/clusters/zone-management-server/Delegate.h>
+#include <app/clusters/zone-management-server/TwoDCartesianZoneStorage.h>
+#include <app/clusters/zone-management-server/ZoneInformationStorage.h>
+#include <lib/core/CHIPPersistentStorageDelegate.h>
+#include <optional>
+#include <protocols/interaction_model/StatusCode.h>
+#include <vector>
+
+namespace chip {
+namespace app {
+namespace Clusters {
+namespace ZoneManagement {
+
+class ZoneMgmtServer : public CommandHandlerInterface, public AttributeAccessInterface
+{
+public:
+    /**
+     * @brief Creates a Zone Management cluster instance. The Init() function needs to be called for this instance
+     * to be registered and called by the interaction model at the appropriate times.
+     *
+     * @param aDelegate                         A reference to the delegate to be used by this server.
+     *                                          Note: the caller must ensure that the delegate lives throughout the instance's
+     *                                          lifetime.
+     *
+     * @param aEndpointId                       The endpoint on which this cluster exists. This must match the zap configuration.
+     * @param aFeatures                         The bitflags value that identifies which features are supported by this instance.
+     * @param aMaxUserDefinedZones              The maximum number of user-defined zones supported by the device.
+     *                                          This value is specified by the device manufacturer.
+     * @param aMaxZones                         The maximum number of zones that are allowed to exist on the device. This is the
+     *                                          sum of the predefined built-in zones and the user-defined zones.
+     * @param aSensitivityMax                   The hardware-specific value for the number of supported sensitivity levels.
+     *                                          This value is specified by the device manufacturer.
+     * @param aTwoDCartesianMax                 The maximum X and Y points that are allowed for TwoD Cartesian Zones.
+     *
+     */
+    ZoneMgmtServer(Delegate & aDelegate, EndpointId aEndpointId, const BitFlags<Feature> aFeatures, uint8_t aMaxUserDefinedZones,
+                   uint8_t aMaxZones, uint8_t aSensitivityMax, const TwoDCartesianVertexStruct & aTwoDCartesianMax);
+
+    ~ZoneMgmtServer() override;
+
+    /**
+     * @brief Initialise the Zone Management server instance.
+     * This function must be called after defining a ZoneMgmtServer class object.
+     * @return Returns an error if some of the constraint/feature validation checks fail or
+     * the CommandHandler or AttributeHandler registration fails, else returns CHIP_NO_ERROR.
+     */
+    CHIP_ERROR Init();
+
+    bool HasFeature(Feature feature) const;
+
+    // Attribute Setters
+    CHIP_ERROR SetSensitivity(uint8_t aSensitivity);
+
+    // Attribute Getters
+    const std::vector<ZoneInformationStorage> & GetZones() const { return mZones; }
+
+    const std::vector<ZoneTriggerControlStruct> & GetTriggers() const { return mTriggers; }
+
+    const Optional<ZoneTriggerControlStruct> GetTriggerForZone(uint16_t zoneID);
+
+    uint8_t GetMaxUserDefinedZones() const { return mMaxUserDefinedZones; }
+    uint8_t GetMaxZones() const { return mMaxZones; }
+    uint8_t GetSensitivityMax() const { return mSensitivityMax; }
+    uint8_t GetSensitivity() const { return mSensitivity; }
+    const TwoDCartesianVertexStruct & GetTwoDCartesianMax() const { return mTwoDCartesianMax; }
+
+    CHIP_ERROR AddZone(const ZoneInformationStorage & zone);
+    CHIP_ERROR UpdateZone(uint16_t zoneId, const ZoneInformationStorage & zone);
+    CHIP_ERROR RemoveZone(uint16_t zoneId);
+
+    Protocols::InteractionModel::Status AddOrUpdateTrigger(const ZoneTriggerControlStruct & trigger);
+    Protocols::InteractionModel::Status RemoveTrigger(uint16_t zoneId);
+
+    // Generate Zone events
+    Protocols::InteractionModel::Status GenerateZoneTriggeredEvent(uint16_t zoneID, ZoneEventTriggeredReasonEnum triggerReason);
+    Protocols::InteractionModel::Status GenerateZoneStoppedEvent(uint16_t zoneID, ZoneEventStoppedReasonEnum stopReason);
+
+private:
+    Delegate & mDelegate;
+    EndpointId mEndpointId;
+    const BitFlags<Feature> mFeatures;
+
+    // Attributes
+    const uint8_t mMaxUserDefinedZones;
+    const uint8_t mMaxZones;
+    const uint8_t mSensitivityMax;
+    const TwoDCartesianVertexStruct mTwoDCartesianMax;
+    uint8_t mUserDefinedZonesCount = 0;
+
+    std::vector<ZoneInformationStorage> mZones;
+    std::vector<ZoneTriggerControlStruct> mTriggers;
+    uint8_t mSensitivity = 0;
+
+    /**
+     * IM-level implementation of read
+     * @return appropriately mapped CHIP_ERROR if applicable
+     */
+    CHIP_ERROR Read(const ConcreteReadAttributePath & aPath, AttributeValueEncoder & aEncoder) override;
+
+    /**
+     * IM-level implementation of write
+     * @return appropriately mapped CHIP_ERROR if applicable
+     */
+    CHIP_ERROR Write(const ConcreteDataAttributePath & aPath, AttributeValueDecoder & aDecoder) override;
+
+    /**
+     * Helper function that loads all the persistent attributes from the KVS.
+     */
+    void LoadPersistentAttributes();
+
+    CHIP_ERROR ReadAndEncodeZones(const AttributeValueEncoder::ListEncodeHelper & encoder);
+
+    CHIP_ERROR ReadAndEncodeTriggers(const AttributeValueEncoder::ListEncodeHelper & encoder);
+
+    Protocols::InteractionModel::Status ValidateTwoDCartesianZone(const TwoDCartesianZoneDecodableStruct & zone);
+
+    Protocols::InteractionModel::Status ValidateTrigger(const ZoneTriggerControlStruct & trigger);
+
+    // Utility that matches a given zone's ZoneUse and verices with the given
+    // parameters to check if they match. Used by ZoneAlreadyExists().
+    bool DoZoneUseAndVerticesMatch(ZoneUseEnum use, const std::vector<TwoDCartesianVertexStruct> & vertices,
+                                   const TwoDCartesianZoneStorage & zone);
+
+    // Utility function to check if a given ZoneUse and a TwoDVertex already
+    // exists in mZones.
+    bool ZoneAlreadyExists(ZoneUseEnum zoneUse, const std::vector<TwoDCartesianVertexStruct> & vertices,
+                           const DataModel::Nullable<uint16_t> & excludeZoneId);
+
+    /**
+     * @brief Inherited from CommandHandlerInterface
+     */
+    void InvokeCommand(HandlerContext & ctx) override;
+
+    void HandleCreateTwoDCartesianZone(HandlerContext & ctx, const Commands::CreateTwoDCartesianZone::DecodableType & req);
+
+    void HandleUpdateTwoDCartesianZone(HandlerContext & ctx, const Commands::UpdateTwoDCartesianZone::DecodableType & req);
+
+    void HandleRemoveZone(HandlerContext & ctx, const Commands::RemoveZone::DecodableType & req);
+
+    void HandleCreateOrUpdateTrigger(HandlerContext & ctx, const Commands::CreateOrUpdateTrigger::DecodableType & req);
+
+    void HandleRemoveTrigger(HandlerContext & ctx, const Commands::RemoveTrigger::DecodableType & req);
+};
+
+} // namespace ZoneManagement
+} // namespace Clusters
+} // namespace app
+} // namespace chip

src/app/clusters/zone-management-server/Delegate.h

@@ -0,0 +1,154 @@
+/*
+ *
+ *    Copyright (c) 2025 Project CHIP Authors
+ *    All rights reserved.
+ *
+ *    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.
+ */
+
+#pragma once
+
+#include <app/clusters/zone-management-server/TwoDCartesianZoneStorage.h>
+#include <app/clusters/zone-management-server/ZoneInformationStorage.h>
+#include <protocols/interaction_model/StatusCode.h>
+#include <vector>
+
+namespace chip {
+namespace app {
+namespace Clusters {
+namespace ZoneManagement {
+
+class ZoneMgmtServer;
+
+/** @brief
+ *  Defines interfaces for implementing application-specific logic for various aspects of the ZoneManagement Cluster.
+ *  Specifically, it defines interfaces for the command handling and loading of the allocated streams.
+ */
+class Delegate
+{
+public:
+    Delegate() = default;
+
+    virtual ~Delegate() = default;
+
+    /**
+     *    @brief Command Delegate for creation of TwoDCartesianZone with the provided parameters.
+     *
+     *   @param[in]  zone       Structure with parameters for defining a TwoDCartesian zone.
+     *
+     *   @param[out] outZoneID  Indicates the ID of the created zone.
+     *
+     *   @return Success if the creation is successful and a zoneID was
+     *   produced; otherwise, the command SHALL be rejected with an appropriate
+     *   error.
+     */
+    virtual Protocols::InteractionModel::Status CreateTwoDCartesianZone(const TwoDCartesianZoneStorage & zone,
+                                                                        uint16_t & outZoneID) = 0;
+
+    /**
+     *    @brief Command Delegate for updating of a TwoDCartesianZone with the provided parameters.
+     *
+     *   @param[in] zoneID  Indicates the ID of the zone to update.
+     *   @param[in]  zone    Structure with parameters for a TwoDCartesian zone.
+     *
+     *
+     *   @return Success if the update is successful; otherwise, the command SHALL be
+     *   rejected with an appropriate error.
+     */
+    virtual Protocols::InteractionModel::Status UpdateTwoDCartesianZone(uint16_t zoneID, const TwoDCartesianZoneStorage & zone) = 0;
+
+    /**
+     *    @brief Command Delegate for the removal of a TwoDCartesianZone for a given zoneID.
+     *
+     *   @param[in] zoneID  Indicates the ID of the zone to remove.
+     *
+     *   @return Success if the removal is successful; otherwise, the command SHALL be
+     *   rejected with an appropriate error.
+     */
+    virtual Protocols::InteractionModel::Status RemoveZone(uint16_t zoneID) = 0;
+
+    /**
+     *    @brief Command Delegate for creation of a ZoneTrigger.
+     *
+     *   @param[in]  zoneTrigger    Structure with parameters for defining a ZoneTriggerControl.
+     *
+     *   @return Success if the creation is successful; otherwise, the command SHALL be
+     *   rejected with an appropriate error.
+     */
+    virtual Protocols::InteractionModel::Status CreateTrigger(const ZoneTriggerControlStruct & zoneTrigger) = 0;
+
+    /**
+     *    @brief Command Delegate for update of a ZoneTrigger.
+     *
+     *   @param[in]  zoneTrigger    Structure with parameters for defining a ZoneTriggerControl.
+     *
+     *   @return Success if the update is successful; otherwise, the command SHALL be
+     *   rejected with an appropriate error.
+     */
+    virtual Protocols::InteractionModel::Status UpdateTrigger(const ZoneTriggerControlStruct & zoneTrigger) = 0;
+
+    /**
+     *    @brief Command Delegate for the removal of a ZoneTrigger for a given zoneID.
+     *
+     *   @param[in] zoneID  Indicates the ID of the zone to remove the ZoneTrigger for.
+     *
+     *   @return Success if the removal is successful; otherwise, the command SHALL be
+     *   rejected with an appropriate error.
+     */
+    virtual Protocols::InteractionModel::Status RemoveTrigger(uint16_t zoneID) = 0;
+
+    /**
+     *   @brief Delegate callback for notifying change in an attribute.
+     *
+     */
+    virtual void OnAttributeChanged(AttributeId attributeId) = 0;
+
+    /**
+     *  @brief Callback into the delegate once persistent attributes managed by
+     *  the Cluster have been loaded from Storage.
+     */
+    virtual CHIP_ERROR PersistentAttributesLoadedCallback() = 0;
+
+    /**
+     * Delegate function to load the created zones and triggers.
+     * The application is responsible for persisting them. The Load APIs
+     * would be used to load the persisted zones and triggers into the cluster
+     * server list members at initialization.
+     * Once loaded, the cluster server can serve Reads on these
+     * attributes.
+     */
+    virtual CHIP_ERROR LoadZones(std::vector<ZoneInformationStorage> & aZones) = 0;
+
+    virtual CHIP_ERROR LoadTriggers(std::vector<ZoneTriggerControlStruct> & aTriggers) = 0;
+
+    ZoneMgmtServer * GetZoneMgmtServer() const { return mZoneMgmtServer; }
+
+private:
+    friend class ZoneMgmtServer;
+
+    ZoneMgmtServer * mZoneMgmtServer = nullptr;
+
+    /**
+     * This method is used by the SDK to ensure the delegate points to the server instance it's associated with.
+     * When a server instance is created or destroyed, this method will be called to set and clear, respectively,
+     * the pointer to the server instance.
+     *
+     * @param aZoneMgmtServer  A pointer to the ZoneMgmtServer object related to this delegate object.
+     */
+    void SetZoneMgmtServer(ZoneMgmtServer * aZoneMgmtServer) { mZoneMgmtServer = aZoneMgmtServer; }
+};
+
+} // namespace ZoneManagement
+} // namespace Clusters
+} // namespace app
+} // namespace chip