blob: 12a10d5ccf9bfe48ef6087a4f0bf721ffe63ae45 [file] [log] [blame] [view] [edit]
# Matter ESP32 Energy Gateway Example
This example demonstrates the Matter `Commodity Price` and
`Electrical Grid Conditions` clusters on ESP platforms.
Please
[setup ESP-IDF and CHIP Environment](../../../docs/platforms/esp32/setup_idf_chip.md)
and refer
[building and commissioning](../../../docs/platforms/esp32/build_app_and_commission.md)
guides to get started.
### Enabling ESP-Insights:
- Before building the app, enable the option: `ESP_INSIGHTS_ENABLED` through
menuconfig.
- Create a file named `insights_auth_key.txt` in the main directory of the
example.
- Follow the steps present
[here](https://github.com/espressif/esp-insights/blob/main/examples/README.md#set-up-esp-insights-account)
to set up an insights_account and the auth key created while setting it up
will be used in the example.
- Download the auth key and copy Auth Key to the example
```
cp /path/to/auth/key.txt path/to/connectedhomeip/examples/energy-gateway-app/esp32/main/insights_auth_key.txt
```
---
- [Cluster Control](#cluster-control)
- [Matter OTA guide](../../../docs/platforms/esp32/ota.md)
---
### Build time configuration
- Test Event Trigger support: By default the `CommodityPrice` and
`ElectricalGridConditions` test event triggers are enabled in the build. To
turn these off run `idf.py menuconfig` and search for the following config
entries:
ENABLE_COMMODITY_PRICE_TRIGGER
ENABLE_ELECTRICAL_GRID_CONDITIONS_TRIGGER
### Cluster Control
- More examples using matter-repl are demonstrated in
[Energy Gateway Linux](../linux/README.md)