blob: f7f020ed10f70246114daf2be7ccf05a0d68145b [file] [log] [blame] [view]
# Matter ESP32 Lock Example
This example demonstrates the mapping of OnOff cluster to lock/unlock logic.
Please
[setup ESP-IDF and CHIP Environment](../../../docs/guides/esp32/setup_idf_chip.md)
and refer
[building and commissioning](../../../docs/guides/esp32/build_app_and_commission.md)
guides to get started.
---
- [Cluster control](#cluster-control)
- [Example Demo](#example-demo)
- [RPC console and Device Tracing](../../../docs/guides/esp32/rpc_console.md)
---
### Cluster control
#### onoff
To use the Client to send Matter commands, run the built executable and pass it
the target cluster name, the target command name as well as an endpoint id.
$ ./out/debug/chip-tool onoff on <NODE ID> 1
The client will send a single command packet and then exit.
### Example Demo
This demo app illustrates controlling OnOff cluster (Server) attributes of an
endpoint and lock/unlock status of door using LED's. For `ESP32-DevKitC`, a GPIO
(configurable through `LOCK_STATE_LED` in `main/include/AppConfig.h`) is updated
through the on/off/toggle commands from the `python-controller`. If you wish to
see the actual effect of the commands on `ESP32-DevKitC`, you will have to
connect an external LED to GPIO.