[EnergyGatewayApp] Add build examples for host and ESP32 (project-chip#38502)

* Basic energy-gateway-app framework for Linux and ESP32 - linking issue due to device type problems bringing in expected clusters.

* Initial attempt to add new clusters based of PR 10815 - ZAP is raising error 'Unable to find cluster extension by component'

* Added missing xml files to zcl.json. Added regen of global-structs.xml and global-enums.xml (NOTE: ApparentPowerThresholds SHOULD be power_mva! but Zap does not recognise this yet.

* Temporary change of "money" to int64s whilst waiting for a ZAP change.

* Added Meter Identification cluster XML

* Updated tests.yaml and rules.matterlint to include new clusters

* .matter file updates caused by new enums

* Updated files after zap_regen_all

* New files after zap_regen_all

* Add support for money and new electrical data types

* Added new attributes for structs to attributeAccessInterfaceAttributes. Removed legacy measurement-and-sensing.xml in favour of new global-structs/global-enums.xml

* Updated .matter files after subsequent regen_all

* code autogen after moving to global structs/enums and updating structs in attributes- regen_all

* Backed out change to support SetVidVerificationStatement etc

* Enabled Commodity Price in data_model/contoller-clusters.zap. Added stub basic-type Currency. Disabled Ember in config-data.yaml. Linux now builds but aborts at start-up.

* Update chip-types.xml with new energy types and money

* Changed to use correct global struct CurrencyStruct

* Revert changes to generated attribute-type.h file

* regen_all after merging in Hasty's new types PR: project-chip#37980

* Further zap_regen_all updates after picking up fix from Hasty#s project-chip#37980

* Revert reversion of generated attribute-type.h

* Fix build issue due to moving MeasurementAccuracyStruct to global-structs.

* Restyled by whitespace

* Restyled by clang-format

* Restyled by gn

* Update attribute-type.h

* Fix EEM/EPM clusters which use new global MeasurementAccuracyRangeStruct and MeasurementTypeEnum

* Restyled by clang-format

* Generated XML files from Alchemy for new clusters and refreshed older EM clusters with latest Alchemy.

* Added missing zap_cluster_list.json

* Added missing CurrencyStruct

* zap_regen_all

* Fix-up EEM/EPM and apps that use them because the Structs and Enums have moved to Globals:: namespace

* Fix CI issue - Re-did bootstrap to pick up new ZAP, and regen_all. Updated ChipStructs.java which was different in CI

* Reverted back to using existing measurement-and-sensing-.xml to avoid API backwards compatibility change.

* Regen_all to revert all .matter files back to remove global MeasurementType enum

* Another regen_all

* Manually added missing description to the clusters to hopefully fix the IDL parsing errors.

* Regen_all to include description tag from XML.

* Updated ChipStructs.java after previous regen_all

* Revert bad merge

* Reverted removal of measurement and sensing xml

* regen_all

* Moved MatterCommodityPricePluginServerInitCallback() to util.cpp to resolve linker error

* Reverted ElectricalPowermeasurementDelegate use of global struct

* Added basic test steps for TC_SEPR_2.1/2/3.py

* Bump zap to 2025.3.25

* Partial regen-all to update .matter files (zap-regen-all still crashes!)

* Support non-nightly versions

* Another update for logic

* Fix bad update

* Update one more extra extension

* Reverted some of the xml files that were updated by alchemy and not really needed in this pr

* Reverted EEM/EPM xml files

* Zap regen all finally fixed with increased timeout

* Merge of .github/workflows/tests.yaml had screwed up

* Fixed Linux crash on startup by adding an empty cmd handler function for now and calling ChipLinuxAppInit()

* Revert "Merge remote-tracking branch 'andrei/zap_update' into energy-gateway-app"

This reverts commit 0cc1dea, reversing
changes made to 2fd6786.

* Syncd back to Master after reverting Andrei's zap changes

* Initial stab at CommodityPriceDelegate.cpp/.h

* moved files

* Basic delegate added with ability and setting of Descriptor tags for this endpoint

* Added CommodityPriceTestEventTriggerHandler.h

* Added hooks to enable/disable chip_enable_commodity_price_trigger to Linux build

* Used TestEvent Trigger to set a Price into CurrentPrice. Needs more work but is basically working.

* Per review comment - changed copyright to only 2025

* Updated more copyright to 2025

* Update copyright commodity-price-server.cpp

* Merged Hasty's PR 38226 into TC_SEPR_2_1.py

* Currently returns a valid empty list for PriceForecast.

* Updated test case to not complain if list is empty and to check that the description and components must not be included.

* New proposed ElectricalGridConditions (EGC)

* Fixed issue in spec which caused 2nd event not to generate correctly

* Manually added new cluster to tests.yaml, rules.matterlint, zcl.json since Alchemy didn't work for some reason

* Ran zap_regen_all

* Updated XML based on Rene's PR review comments.

* Initial attempt to add a Forecast with list and sub-list and memory management

* Updated CommodityPrice XML based on Spec PR to add PriceLevel and make Events have nullable fields to match attributes.

* ZAP Regen all

* Restyled by whitespace

* Restyled by clang-format

* Restyled by gn

* Restyled by isort

* Fix build issue caused by new spec update to make price optional

* Updated test script to allow for optional price or price level in both CommodityPrice and CommodityPriceComponent structs

* Updated test steps after spec update and test plan update.

* Moved common code into TC_SEPRTestBase. Some additional checks added to 2.2 test

* Update test scripts so that they use TestBase

* ruff fixes in python tests

* Restyled by autopep8

* Restyled by isort

* regen_all update

* Refactor - made cluster server handle 'set' operations so that it sends out a Matter Reporting callback for each attribute if it is changed.
Started making commands work but needs more work

* Refactoring to allow cluster server to retrieve a copy of the Forecast based on bitmap

* Slightly buggy version but sort of works if there is enough memory

* An update to get per entry component values. Currently had to reduce the forecast to 4 entries to get it to fit

* Clean up and fix some issues in the data and SetCurrentPrice. Removed unnecessary files now that delegate isn't really holding the data.

* More clean-up

* More clean up

* Updated zcl.json with AttributeInterface handling.

* Zap regen all once zcl.json was updated

* Had accidentally turned off FeatureMap in CommodityPrice. Now back on.

* Update commodity-price-cluster.xml based on spec PR 11569

* zap regen all

* Marked TC_SEPRTestBase as shared code (not a script)

* Update EntryToText.cpp - restore newline at EOF

* Update EntryToText.h - restore newline at EOF

* Update EntryToText.cpp - restore newline at EOF

* Update EntryToText.h - restore newline at EOF

* Align structures to corrected Price as Money type.

* Fixed IncorrectState when running commands caused by AddStatus after AddResponse

* Made the ReadAttribute and GetDetailedForecastCommand dynamically size the response to avoid packet overflow.

* Deleted unused java files so CI passes

* Completed and fixed test case TC_SEPR_2_2.

* Fixed bug introduced in last commit. TC_SEPR_2_1 now passes again

* Updated SDK to send PriceForecast events. Note that events have an overhead so not as many entries can be sent.

* Implemented TC_SEPR_2_3 and fixed other issues with test scripts.

* Restyled by isort

* Fix Lint error

* Made local copy of EnergyTimeUtils.h

* Updated linux to use local copy of EnergyTimeUtils.cpp

* Removed Python Tests so that they don't trigger build check failure.

* Revert test_metadata.yaml since we're backing out Python scripts from this PR.

* Added changes to build targets to enable top level build_example for enabling testing.

* Restyled by clang-format

* Restyled by clang-format

* Changed GetDetailedForecastRequest to take a ScopedMemoryBuffer

* Improved Memory management for GetDetailedPriceRequest()

* Restyled by whitespace

* Restyled by clang-format

* Restyled by gn

* Update all_targets_linux_x64.txt

* Apply suggestions from code review

Co-authored-by: Boris Zbarsky <[email protected]>

* Remove Forecast Changed Event

* Addressing most of code review comments

* More review comment changes

* removing chip:: and moving to CharSpan::fromCharString()

* Refactored SetCurrentPrice to save a local copy into the cluster server.

* Fixed issue with wrong variable in SetCurrentPrice - removed unused variable now - seen when sending multiple triggers.

* Apply suggestions from code review

Co-authored-by: Boris Zbarsky <[email protected]>

* Further review comments fixed in SetCurrentPrice()

* Further refinement on SetCurrentPrice deep copy

* Fixed issues with wrong buffer and a bug in the .component.Value() called without checking .HasValue() first

* Removed byte counting nonsense now we have Large Message support

* Renamed function

* Avoid error when it is ok not to have allocated sub-elements

* Missing .matter file after regen_all after merge causing CI issues.

* Update src/app/clusters/commodity-price-server/commodity-price-server.h

Co-authored-by: Boris Zbarsky <[email protected]>

* Merge from Master

* Revert "Merge from Master"

This reverts commit bf42fda.

* Tidy up AppMain.cpp after merge

* Fixed another merge error

* Removed VerifyOrDie when checking that memory should already be free'd. Free it if allocated.

* Fixed GetEpochTS (again) - merge issue?

* Added Electrical Grid Conditions & test event flags to ESP32

* Missed Kconfig.projbuild

---------

Co-authored-by: Hasty Granbery <[email protected]>
Co-authored-by: Hasty Granbery <[email protected]>
Co-authored-by: Restyled.io <[email protected]>
Co-authored-by: Andrei Litvin <[email protected]>
Co-authored-by: Boris Zbarsky <[email protected]>

Author: 5 people

.github/workflows/examples-esp32.yaml

@@ -168,6 +168,9 @@ jobs:
             - name: Build example Lighting App (external platform)
               run: scripts/examples/esp_example.sh lighting-app sdkconfig.ext_plat.defaults
 
+            - name: Build example Energy Gateway App
+              run: scripts/examples/esp_example.sh energy-gateway-app sdkconfig.defaults
+
             - name: Build example Energy Management App
               run: scripts/examples/esp_example.sh energy-management-app sdkconfig.defaults
 

.github/workflows/tests.yaml

@@ -524,6 +524,7 @@ jobs:
                   echo "CHIP_LOCK_APP: out/linux-x64-lock-ipv6only-no-ble-no-wifi-tsan-clang-test/chip-lock-app" >> /tmp/test_env.yaml
                   echo "CAMERA_APP: out/linux-x64-camera/chip-camera-app" >> /tmp/test_env.yaml
                   echo "ENERGY_MANAGEMENT_APP: out/linux-x64-energy-management-ipv6only-no-ble-no-wifi-tsan-clang-test/chip-energy-management-app" >> /tmp/test_env.yaml
+                  echo "ENERGY_GATEWAY_APP: out/linux-x64-energy-gateway-ipv6only-no-ble-no-wifi-tsan-clang-test/chip-energy-gateway-app" >> /tmp/test_env.yaml
                   echo "LIT_ICD_APP: out/linux-x64-lit-icd-ipv6only-no-ble-no-wifi-tsan-clang-test/lit-icd-app" >> /tmp/test_env.yaml
                   echo "AIR_PURIFIER_APP: out/linux-x64-air-purifier-ipv6only-no-ble-no-wifi-tsan-clang-test/chip-air-purifier-app" >> /tmp/test_env.yaml
                   echo "CHIP_MICROWAVE_OVEN_APP: out/linux-x64-microwave-oven-ipv6only-no-ble-no-wifi-tsan-clang-test/chip-microwave-oven-app" >> /tmp/test_env.yaml

examples/energy-gateway-app/esp32/main/CMakeLists.txt

@@ -17,12 +17,14 @@
 # (Uses default behaviour of compiling all source files in directory, adding 'include' to include path.)
 
 get_filename_component(CHIP_ROOT ${CMAKE_SOURCE_DIR}/third_party/connectedhomeip REALPATH)
-get_filename_component(ENERGY_GATEWAY_COMMON_DIR ${CHIP_ROOT}/examples/energy-gateway-app/energy-gateway-common/ REALPATH)
+get_filename_component(ENERGY_GATEWAY_DIR ${CHIP_ROOT}/examples/energy-gateway-app/ REALPATH)
 get_filename_component(APP_COMMON_GEN_DIR ${CHIP_ROOT}/zzz_generated/app-common/app-common/zap-generated REALPATH)
 
 set(PRIV_INCLUDE_DIRS_LIST
   "${CHIP_ROOT}/examples/providers"
-  "${ENERGY_GATEWAY_COMMON_DIR}/common/include"
+  "${ENERGY_GATEWAY_DIR}/commodity-price/include"
+  "${ENERGY_GATEWAY_DIR}/common/include"
+  "${ENERGY_GATEWAY_DIR}/electrical-grid-conditions/include"
   "${CMAKE_CURRENT_LIST_DIR}/include"
   "${CHIP_ROOT}/examples/platform/esp32"
 )
@@ -31,7 +33,9 @@ set(SRC_DIRS_LIST
   "${APP_COMMON_GEN_DIR}/attributes"
   "${APP_COMMON_GEN_DIR}"
   "${CHIP_ROOT}/examples/providers"
-  "${ENERGY_GATEWAY_COMMON_DIR}/common/src"
+  "${ENERGY_GATEWAY_DIR}/commodity-price/src"
+  "${ENERGY_GATEWAY_DIR}/common/src"
+  "${ENERGY_GATEWAY_DIR}/electrical-grid-conditions/src"
   "${CHIP_ROOT}/examples/platform/esp32/ota"
   "${CHIP_ROOT}/examples/platform/esp32/common"
   "${CHIP_ROOT}/examples/platform/esp32/time"
@@ -66,7 +70,7 @@ idf_component_register(PRIV_INCLUDE_DIRS ${PRIV_INCLUDE_DIRS_LIST}
 
 include(${CHIP_ROOT}/src/app/chip_data_model.cmake)
 chip_configure_data_model(${COMPONENT_LIB}
-    ZAP_FILE ${ENERGY_GATEWAY_COMMON_DIR}/energy-gateway-app.zap
+    ZAP_FILE ${ENERGY_GATEWAY_DIR}/energy-gateway-common/energy-gateway-app.zap
 )
 
 if(CONFIG_ENABLE_ESP_INSIGHTS_TRACE)

examples/energy-gateway-app/esp32/main/DeviceCallbacks.cpp

@@ -25,7 +25,7 @@
 #include <app/ConcreteAttributePath.h>
 #include <lib/support/logging/CHIPLogging.h>
 
-static const char * TAG = "energy-management-app-callbacks";
+static const char * TAG = "energy-gateway-app-callbacks";
 
 using namespace chip;
 using namespace chip::Inet;

examples/energy-gateway-app/esp32/main/Kconfig.projbuild

@@ -185,3 +185,19 @@ depends on ENABLE_PW_RPC
             about available pin numbers for UART.
 
 endmenu
+
+menu "Energy Gateway Example App Configuration"
+
+    config CHIP_DEVICE_CONFIG_ENABLE_COMMODITY_PRICE_TRIGGER
+        bool "Enable SEPR (CommodityPrice) triggers"
+        default "n"
+        help
+            Enable test triggers used by the Commodity Price tests
+
+    config CHIP_DEVICE_CONFIG_ENABLE_ELECTRICAL_GRID_CONDITIONS_TRIGGER
+        bool "Enable EGC (ElectricalGridConditions) triggers"
+        default "n"
+        help
+            Enable test triggers used by the Electrical Grid Conditions tests
+        
+endmenu

examples/energy-gateway-app/esp32/main/main.cpp

@@ -118,14 +118,14 @@ void ApplicationInit()
 {
     ESP_LOGD(TAG, "Energy Gateway App: ApplicationInit()");
 
-    ElectricalPriceApplicationInit();
+    ElectricalEnergyTariffInit();
 }
 
 void ApplicationShutdown()
 {
     ESP_LOGD(TAG, "Energy Gateway App: ApplicationShutdown()");
 
-    ElectricalPriceApplicationShutdown();
+    ElectricalEnergyTariffShutdown();
 }
 
 static void InitServer(intptr_t context)

examples/energy-gateway-app/esp32/sdkconfig.defaults

@@ -63,3 +63,9 @@ CONFIG_ENABLE_SNTP_TIME_SYNC=y
 
 # Enable OTA Requestor
 CONFIG_ENABLE_OTA_REQUESTOR=y
+
+# Enable test triggers used by the CommidityPrice tests
+CONFIG_CHIP_DEVICE_CONFIG_ENABLE_COMMODITY_PRICE_TRIGGER=y
+
+# Enable test triggers used by the ElectricalGridConditions tests
+CONFIG_CHIP_DEVICE_CONFIG_ENABLE_ELECTRICAL_GRID_CONDITIONS_TRIGGER=y

examples/platform/esp32/common/Esp32AppServer.cpp

@@ -41,6 +41,12 @@
 #if CONFIG_CHIP_DEVICE_CONFIG_ENABLE_DEVICE_ENERGY_MANAGEMENT_TRIGGER
 #include <app/clusters/device-energy-management-server/DeviceEnergyManagementTestEventTriggerHandler.h>
 #endif
+#if CONFIG_CHIP_DEVICE_CONFIG_ENABLE_COMMODITY_PRICE_TRIGGER
+#include <app/clusters/commodity-price-server/CommodityPriceTestEventTriggerHandler.h>
+#endif
+#if CONFIG_CHIP_DEVICE_CONFIG_ENABLE_ELECTRICAL_GRID_CONDITIONS_TRIGGER
+#include <app/clusters/electrical-grid-conditions-server/ElectricalGridConditionsTestEventTriggerHandler.h>
+#endif
 
 #ifdef CONFIG_ENABLE_CHIP_SHELL
 #include <lib/shell/commands/WiFi.h>
@@ -145,6 +151,14 @@ void Esp32AppServer::Init(AppDelegate * sAppDelegate)
     static DeviceEnergyManagementTestEventTriggerHandler sDeviceEnergyManagementTestEventTriggerHandler;
     sTestEventTriggerDelegate.AddHandler(&sDeviceEnergyManagementTestEventTriggerHandler);
 #endif
+#if CONFIG_CHIP_DEVICE_CONFIG_ENABLE_COMMODITY_PRICE_TRIGGER
+    static CommodityPriceTestEventTriggerHandler sCommodityPriceTestEventTriggerHandler;
+    sTestEventTriggerDelegate.AddHandler(&sCommodityPriceTestEventTriggerHandler);
+#endif
+#if CONFIG_CHIP_DEVICE_CONFIG_ENABLE_ELECTRICAL_GRID_CONDITIONS_TRIGGER
+    static ElectricalGridConditionsTestEventTriggerHandler sElectricalGridConditionsTestEventTriggerHandler;
+    sTestEventTriggerDelegate.AddHandler(&sElectricalGridConditionsTestEventTriggerHandler);
+#endif
 
 #if CONFIG_ENABLE_OTA_REQUESTOR
     static OTATestEventTriggerHandler sOtaTestEventTriggerHandler{};

examples/platform/linux/BUILD.gn

@@ -63,6 +63,10 @@ source_set("boolean-state-configuration-test-event-trigger") {
   sources = [ "${chip_root}/src/app/clusters/boolean-state-configuration-server/BooleanStateConfigurationTestEventTriggerHandler.h" ]
 }
 
+source_set("commodity-price-test-event-trigger") {
+  sources = [ "${chip_root}/src/app/clusters/commodity-price-server/CommodityPriceTestEventTriggerHandler.h" ]
+}
+
 source_set("energy-evse-test-event-trigger") {
   sources = [ "${chip_root}/src/app/clusters/energy-evse-server/EnergyEvseTestEventTriggerHandler.h" ]
 }
@@ -105,6 +109,7 @@ source_set("app-main") {
   public_deps = [
     ":boolean-state-configuration-test-event-trigger",
     ":commissioner-main",
+    ":commodity-price-test-event-trigger",
     ":device-energy-management-test-event-trigger",
     ":energy-evse-test-event-trigger",
     ":energy-reporting-test-event-trigger",

integrations/docker/images/chip-cert-bins/Dockerfile

@@ -161,6 +161,7 @@ RUN case ${TARGETPLATFORM} in \
     --target linux-x64-lock-ipv6only \
     --target linux-x64-simulated-app1-ipv6only \
     --target linux-x64-lit-icd-ipv6only \
+    --target linux-x64-energy-gateway-ipv6only \
     --target linux-x64-energy-management-ipv6only \
     --target linux-x64-microwave-oven-ipv6only \
     --target linux-x64-rvc-ipv6only \
@@ -186,6 +187,7 @@ RUN case ${TARGETPLATFORM} in \
     && mv out/linux-x64-lock-ipv6only/chip-lock-app out/chip-lock-app \
     && mv out/linux-x64-simulated-app1-ipv6only/chip-app1 out/chip-app1 \
     && mv out/linux-x64-lit-icd-ipv6only/lit-icd-app out/lit-icd-app \
+    && mv out/linux-x64-energy-gateway-ipv6only/chip-energy-gateway-app out/chip-energy-gateway-app \
     && mv out/linux-x64-energy-management-ipv6only/chip-energy-management-app out/chip-energy-management-app \
     && mv out/linux-x64-microwave-oven-ipv6only/chip-microwave-oven-app out/chip-microwave-oven-app \
     && mv out/linux-x64-rvc-ipv6only/chip-rvc-app out/chip-rvc-app \
@@ -215,6 +217,7 @@ RUN case ${TARGETPLATFORM} in \
     --target linux-arm64-lock-ipv6only \
     --target linux-arm64-simulated-app1-ipv6only \
     --target linux-arm64-lit-icd-ipv6only \
+    --target linux-arm64-energy-gateway-ipv6only \
     --target linux-arm64-energy-management-ipv6only \
     --target linux-arm64-microwave-oven-ipv6only \
     --target linux-arm64-rvc-ipv6only \
@@ -240,6 +243,7 @@ RUN case ${TARGETPLATFORM} in \
     && mv out/linux-arm64-lock-ipv6only/chip-lock-app out/chip-lock-app \
     && mv out/linux-arm64-simulated-app1-ipv6only/chip-app1 out/chip-app1 \
     && mv out/linux-arm64-lit-icd-ipv6only/lit-icd-app out/lit-icd-app \
+    && mv out/linux-arm64-energy-gateway-ipv6only/chip-energy-gateway-app out/chip-energy-gateway-app \
     && mv out/linux-arm64-energy-management-ipv6only/chip-energy-management-app out/chip-energy-management-app \
     && mv out/linux-arm64-microwave-oven-ipv6only/chip-microwave-oven-app out/chip-microwave-oven-app \
     && mv out/linux-arm64-rvc-ipv6only/chip-rvc-app out/chip-rvc-app \
@@ -279,6 +283,7 @@ COPY --from=chip-build-cert-bins /root/connectedhomeip/out/chip-ota-requestor-ap
 COPY --from=chip-build-cert-bins /root/connectedhomeip/out/chip-lock-app apps/chip-lock-app
 COPY --from=chip-build-cert-bins /root/connectedhomeip/out/chip-app1 apps/chip-app1
 COPY --from=chip-build-cert-bins /root/connectedhomeip/out/lit-icd-app apps/lit-icd-app
+COPY --from=chip-build-cert-bins /root/connectedhomeip/out/chip-energy-gateway-app apps/chip-energy-gateway-app
 COPY --from=chip-build-cert-bins /root/connectedhomeip/out/chip-energy-management-app apps/chip-energy-management-app
 COPY --from=chip-build-cert-bins /root/connectedhomeip/out/chip-microwave-oven-app apps/chip-microwave-oven-app
 COPY --from=chip-build-cert-bins /root/connectedhomeip/out/chip-rvc-app apps/chip-rvc-app