mirror of
https://github.com/espressif/esp-matter.git
synced 2026-04-27 19:13:13 +00:00
Rohit Jadhav
447e0b1c78
Added momentary_switch, action_switch and momentary_switch_multi_press features and respective features. Removed fixed and user labels from example because these are removed from spec. Removed mfg_binary as it's not needed anymore.
90 lines
3.3 KiB
Markdown
90 lines
3.3 KiB
Markdown
# Generic Switch
|
|
|
|
This example creates a Generic Switch device using the ESP
|
|
Matter data model.
|
|
This example demonstrates the use of few optional data model elements like :
|
|
- Taglist Feature of Descriptor Cluster : used to disambiguate sibling endpoints where two or more sibling
|
|
endpoints have an overlap in the supported device types with each such endpoint having a unique TagList.
|
|
|
|
|
|
See the [docs](https://docs.espressif.com/projects/esp-matter/en/latest/esp32/developing.html) for more information about building and flashing the firmware.
|
|
|
|
## 1. Additional Environment Setup
|
|
|
|
### 1.1 Building the firmware
|
|
|
|
There are two types of switches in the example which can be configured
|
|
through menuconfig:
|
|
|
|
- idf.py menuconfig -> Demo -> Generic Switch Type
|
|
- To use latching switch, enable `GENERIC_SWITCH_TYPE_LATCHING`.
|
|
- To use a momentary switch, enable `GENERIC_SWITCH_TYPE_MOMENTARY`.
|
|
- By default momentary switch i.e `GENERIC_SWITCH_TYPE_MOMENTARY` is enabled.
|
|
|
|
### 1.2 Enabling insights (Optional)
|
|
|
|
Follow the steps mentioned [here](https://docs.espressif.com/projects/esp-matter/en/latest/esp32/insights.html)
|
|
|
|
## 2.Commissioning and Control
|
|
- Commission the device with ``discriminator: 3840``and `` passcode: 20202021``
|
|
|
|
```
|
|
chip-tool pairing ble-wifi 0x7283 [ssid] [password] 20202021 3840
|
|
```
|
|
### 2.1 Using the TagList Feature
|
|
|
|
To read the taglist of the Descriptor cluster execute the command given below.
|
|
|
|
```
|
|
chip-tool descriptor read tag-list 0x7283 1
|
|
```
|
|
|
|
## 3. Post Commissioning Setup
|
|
|
|
This should be followed by: Commission the generic switch device
|
|
- Turn on chip-tool interactive mode. ``./chip-tool interactive start``
|
|
- By default momentary switch is enabled so subscribe to long-press event via chip-tool.
|
|
``switch subscribe-event long-press <min-interval> <max-interval> <destination-id> <endpoint-id>``
|
|
- `Double press the boot button` on device so that client will receive event after max-interval.
|
|
|
|
### 3.1 Latching switch
|
|
|
|
Following are latching switch events mapped with boot button on device.
|
|
|
|
- `Double Press` -----------> `switch-latched`
|
|
|
|
### 3.2 Momentary switch
|
|
|
|
Following are momentary switch events mapped with boot button on device.
|
|
|
|
- `Button Press Down` -----------> `initial-pressed`
|
|
- `Button Press Up ( Release )` -----------> `short-release`
|
|
- `Button Long Press ( 5 sec )` -----------> `long-pressed`
|
|
- `Button Press Up ( Long Release )` -----------> `long-release`
|
|
- `Button Press Repeat` -----------> `multipress-ongoing`
|
|
- `Button Press Repeat Done` -----------> `multipress-completed`
|
|
|
|
## 3. Device Performance
|
|
|
|
### 3.1 Memory usage
|
|
|
|
The following is the Memory and Flash Usage.
|
|
|
|
- `Bootup` == Device just finished booting up. Device is not
|
|
commissionined or connected to wifi yet.
|
|
- `After Commissioning` == Device is conneted to wifi and is also
|
|
commissioned and is rebooted.
|
|
- device used: esp32c3_devkit_m
|
|
- tested on:
|
|
[4881109](https://github.com/espressif/esp-matter/commit/4881109ce26c92e547ca11d6f022d2c9f908834e)
|
|
(2022-12-15)
|
|
|
|
| | Bootup | After Commissioning |
|
|
|:- |:-: |:-: |
|
|
|**Free Internal Memory** |94KB |110KB |
|
|
|
|
**Flash Usage**: Firmware binary size: 1.24MB
|
|
|
|
This should give you a good idea about the amount of free memory that is
|
|
available for you to run your application's code.
|