electron-rare/esp-box
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Ali Hassan Shah
2023-09-18 19:14:10 +08:00
parent 533d8e20a8
commit e8e1d73cae
2 changed files with 141 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files
examples/chatgpt_demo/README.md
+2 -2
View File
@@ -22,13 +22,13 @@ git checkout 53ff7d43dbff642d831a937b066ea0735a6aca24 && git pull && git submodu
```
### Hardware Required
### **Hardware Required**
* A ESP32-S3-BOX，ESP32-S3-BOX-Lite or ESP32-S3-BOX-3
* An USB-C cable for power supply and programming
## **Text to speech**
## Text to speech
Due to the lack of native text-to-speech support in the [OpenAI](https://platform.openai.com/docs/api-reference) API, an external API is used to meet this requirement. This example utilizes the text-to-speech functionality offered by [TalkingGenie](https://www.talkinggenie.com/tts). Additional information can be found in this [blog post](https://czyt.tech/post/a-free-tts-api/?from_wecom=1).
### **Build and Flash**
examples/matter_switch/README.md
+139 -62
View File
@@ -6,25 +6,39 @@
| ESP32-S3-BOX-Lite | YES |
| ESP32-S3-BOX-3 | YES |
This example creates a 3 channel matter On/Off Switch device on esp32s3 box platform.
It creates the On/Off client and other on-off devices can be bound to the switch and then controlled from the switch.
## 1. Esp-idf And Esp-matter Commit ID
In this example, we are setting up ESP-BOX to operate as a Matter device, specifically a switch, with the capability to turn other Matter devices on and off. Currently, the ESP-BOX Matter switch can control up to three Matter devices(Light, Fan and Switch).
esp-idf: master branch 67552c31dac8cd94fb0d63192a538f4f984c5b6e
esp-matter: main branch de3fc77b03c2bd0e59bca623290399ae5302a0f6
## 2. Simplified Environment Setup
### 2.1 Setup esp-matter environment
## How to use example
* ESP-IDF [master](https://github.com/espressif/esp-idf)
* ESP-MATTER [master](https://github.com/espressif/esp-matter)
See the [docs](https://docs.espressif.com/projects/esp-matter/en/latest/esp32/developing.html#developing-with-the-sdk) for more information about esp-matter building and flashing the firmware.
### 2.2 Matter-switch example build and setup
After setup the esp-matter environment, get into the matter-switch project folder, then
If you encounter any errors during the upgrade process, please make sure to use the ESP-IDF version [master](https://github.com/espressif/esp-idf) at commit ID `67552c31dac8cd94fb0d63192a538f4f984c5b6e` and ESP-MATTER [master](https://github.com/espressif/esp-matter) at commit ID `de3fc77b03c2bd0e59bca623290399ae5302a0f6`.This specific commits represent a stable state of the ESP-IDF and ESP-MATTER repository for this example and can help ensure a smoother transition or troubleshooting process.
### Hardware Required
* An ESP32-S3-BOX，ESP32-S3-BOX-Lite or ESP32-S3-BOX-3
* An ESP32C3 devkit for testing (Not necessary if you have another Matter device for testing)
* An USB-C or Micro USB cable for power supply and programming
* A Bluetooth connection to the PC to facilitate the hardware connection and transmit the Wi-Fi password and SSID using Chip-tool
## Build and Flash
**1. Export IDF and Matter**
The first step is to export both ESP-IDF and ESP-MATTER into the terminal
``` bash
. ./export.sh
```
**2. Build & Flash ESP_BOX**
After setup the esp-matter environment, get into the [matter-switch project folder](https://github.com/espressif/esp-box/tree/master/examples/matter_switch), then
execute below commands:
```
```bash
idf.py set-target esp32s3 build
cd build && esptool.py --chip esp32s3 merge_bin `cat flash_args` -o demo_box_s3_box_switch.bin
@@ -34,98 +48,134 @@ esptool.py -p /dev/ttyACM0 write_flash 0 demo_box_s3_box_switch.bin
cd ..
idf.py -p /dev/ttyACM0 monitor
```
After flash the firmware, then use the chip-tool to pairing the matter network, you can use the default command:
```
**3. Commissioning ESP-BOX**
After flash the firmware, then use the chip-tool to pairing the Matter network, The command is as follows:
```bash
./chip-tool pairing ble-wifi 0x4 wifi-name wifi-password 20202021 3840
```
- 0x4 is the node id for ESP-BOX Matter Switch.
After pairing successfully, the s3 box will start displaying splash screen.
After pairing successfully, the ESP-BOX will start displaying splash screen.
<img src="../../docs/_static/_get_started_static/boot_animation.png" width="200px" />
**4. Build & Flash Matter Devices**
## 2.3 Open commissioning window and pairing using Homekit
To test the functionality of the ESP-BOX Matter Switch with a Matter Devices, You can utilize an examples from the [ESP-Matter](https://github.com/espressif/esp-matter/tree/main/examples) SDK.
After pairing using chip-tool, you can send below command to open commissioning window:
- For Light:
We can use the example named [Light Switch Example](https://github.com/espressif/esp-matter/tree/main/examples/light_switch) from ESP-Matter.
```bash
idf.py set-target esp32c3 build flash monitor
```
./chip-tool pairing open-commissioning-window 0x4 1 180 1000 3840
This command will set the target for the ESP32-C3, build the project, flash it onto the device, and then start monitoring the output.
- For Fan:
**At the moment, this example is not accessible to the general public**
- For Switch:
**At the moment, this example is not accessible to the general public**
>Note: "As Matter-Fan and Matter-Switch are presently unavailable for public use, developers can make use of the Matter-Light example. Flash it onto the devkits and then follow the subsequent steps to assess the functionality of Fan and Switch."
**5. Commissioning ESP-Matter Devices**
After flashing the firmware, use the chip-tool to pair the Matter network. The default command is as follows:
- For Light:
```bash
./chip-tool pairing ble-wifi 0x1 wifi-name wifi-password 20202021 3840
```
0x1 is the node id for Matter Light.
- For Fan:
```bash
./chip-tool pairing ble-wifi 0x2 wifi-name wifi-password 20202021 3840
```
[1689931442.902596][2216299:2216301] CHIP:CTL: Successfully opened pairing window on the device
[1689931442.902603][2216299:2216301] CHIP:CTL: Manual pairing code: [36478701899]
[1689931442.902607][2216299:2216301] CHIP:CTL: SetupQRCode: [MT:MH5B4BFN00KCTW7I200]
[1689931442.902623][2216299:2216301] CHIP:DMG: ICR moving to [AwaitingDe]
0x2 is the node id for Matter Fan.
- For Switch:
```bash
./chip-tool pairing ble-wifi 0x3 wifi-name wifi-password 20202021 3840
```
Then we can use the ***SetupQRCode: [MT:MH5B4BFN00KCTW7I200]*** or ***Manual pairing code: [36478701899]*** to paring to Homekit, as below show:
0x3 is the node id for Matter switch.
<img src="../../docs/_static/matter/apple1.png" width="200px" />
<img src="../../docs/_static/matter/apple2.png" width="200px" />
<img src="../../docs/_static/matter/apple3.png" width="200px" />
<img src="../../docs/_static/matter/apple4.png" width="200px" />
<img src="../../docs/_static/matter/apple5.png" width="200px" />
<img src="../../docs/_static/matter/apple6.png" width="200px" />
## 3. Post Commissioning Setup
**6. Post Commissioning Setup**
After Commissioning, we can bind three matter on-off devices to the box switch and control them via touch screen and speech recognition.
### 3.1 Bind on-off devices to switch
After commissioning, the next step is to bind Matter devices (Light, Fan, and Switch) with the ESP-BOX Matter switch and control them via the touchscreen and speech recognition.
Using the chip-tool, commission 4 devices, the box matter-switch and 3 on-off devices, such as onoff light, fan, onoff plug.
If you are having trouble, try commissioning them one at a time (by powering off the other device) as
the default discriminator and passcode are same for all of them.
Then use the below commands to bind the onoff devices to the switch.
**6.1 Bind devices to ESP-BOX Matter switch**
For the commands below:
Utilizing chip-tool to write access control to the Matter devices in order to control through ESP-BOX Matter Switch.
- Node Id of switch used during commissioning is 4
- Node Id of onoff light used during commissioning is 1
- Node Id of onoff fan used during commissioning is 2
- Node Id of onoff plug used during commissioning is 3
- Cluster Id for OnOff cluster is 6
- Binding cluster is currently present on endpoint 1, 2 and 3 on the switch
- For Light:
Update the 3 onoff devices' acl attribute to add the entry of remote device
(switch) in the access control list:
```
```bash
./chip-tool accesscontrol write acl '[{"fabricIndex": 1, "privilege": 5, "authMode": 2, "subjects": [ 112233, 4 ], "targets": null}]' 1 0x0
```
- For Fan:
```bash
./chip-tool accesscontrol write acl '[{"fabricIndex": 1, "privilege": 5, "authMode": 2, "subjects": [ 112233, 4 ], "targets": null}]' 2 0x0
```
- For Switch:
```bash
./chip-tool accesscontrol write acl '[{"fabricIndex": 1, "privilege": 5, "authMode": 2, "subjects": [ 112233, 4 ], "targets": null}]' 3 0x0
```
Update the switch's binding attribute to add the entry of remote device
(light) in the binding table:
```
> Note: If you are having trouble, try commissioning them one at a time (by powering off the other device)
**6.2 Update device binding attribute to ESP-BOX Matter Switch**
To update the ESP-BOX Matter Switch binding attribute and add an entry for a remote device (Matter Light, Fan, and Switch) to the binding table, use the following command:
- For Light:
```bash
./chip-tool binding write binding '[{"fabricIndex": 1, "node":1, "endpoint":1, "cluster":6}]' 4 0x1
```
(fan) in the binding table:
```
- For Fan:
```bash
./chip-tool binding write binding '[{"fabricIndex": 1, "node":2, "endpoint":1, "cluster":6}]' 4 0x2
```
(plug) in the binding table:
```
- For Switch:
```bash
./chip-tool binding write binding '[{"fabricIndex": 1, "node":3, "endpoint":1, "cluster":6}]' 4 0x3
```
### 3.2 Control 3 onoff devices
## Control devices
After binding successfully, we can control the three onoff devices via touch screen and speech recognition.
#### Touch screen control
After binding successfully, To control the onoff devices via touch screen and speech recognition.
Enter the device control interface, click the *Light*, *Fan*, *Switch* buttons respectively to control the onoff light, fan and onoff plug.
**1. Touch screen control**
Enter the device control interface, click the *Light*, *Fan*, *Switch* buttons respectively to control the onoff light, fan and onoff switch.
<img src="../../docs/_static/_get_started_static/4.png" width="200px" />
<img src="../../docs/_static/_get_started_static/4.1.png" width="200px" />
#### Speech recognition control
**2. Speech recognition control**
Current matter-switch example only support English mode, you can say "Hi ESP" to wake up the switch, then say
Current matter-switch example only support English mode, Saying "Hi ESP" to wake up the switch, then say
```
Turn on the light
@@ -141,13 +191,40 @@ to control the three onoff devices.
<img src="../../docs/_static/_get_started_static/17.png" width="200px" />
<img src="../../docs/_static/_get_started_static/21.png" width="200px" />
## 4 Factory Reset Matter Switch
## Commissioning window and pairing using Homekit
Long press *Boot* button for more than 5 seconds, then release, the matter switch will trigger factoryreset, all the matter related information will be factoryreset.
## A1 Appendix FAQs
To initiate the commissioning window and establish a connection between the ESP-BOX Matter Switch and an Apple HomePod, send the following command using chip-tool:
### A1.1 Binding Failed
```bash
./chip-tool pairing open-commissioning-window 0x4 1 180 1000 3840
```
The output generated by the chip-tool resembles the following:
```bash
[1689931442.902596][2216299:2216301] CHIP:CTL: Successfully opened pairing window on the device
[1689931442.902603][2216299:2216301] CHIP:CTL: Manual pairing code: [36478701899]
[1689931442.902607][2216299:2216301] CHIP:CTL: SetupQRCode: [MT:MH5B4BFN00KCTW7I200]
[1689931442.902623][2216299:2216301] CHIP:DMG: ICR moving to [AwaitingDe]
```
Then we can use the ***SetupQRCode: [MT:MH5B4BFN00KCTW7I200]*** or ***Manual pairing code: [36478701899]*** to paring to Homekit, as below show:
<img src="../../docs/_static/matter/apple1.png" width="200px" />
<img src="../../docs/_static/matter/apple2.png" width="200px" />
<img src="../../docs/_static/matter/apple3.png" width="200px" />
<img src="../../docs/_static/matter/apple4.png" width="200px" />
<img src="../../docs/_static/matter/apple5.png" width="200px" />
<img src="../../docs/_static/matter/apple6.png" width="200px" />
## Factory Reset Matter Switch
Long press *Boot* button for more than 5 seconds, then release, the matter switch will trigger factory reset, all the matter related information will be factory reset.
## Build & Flash Using LaunchPad
The LaunchPad can be utilized to directly build and flash both the [ESP-Box Matter Switch](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://raw.githubusercontent.com/espressif/esp-box/master/launch.toml) and [ESP-Matter Light](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-matter/launchpad.toml). However, even with the LaunchPad, still require to employ the chip-tool for commissioning and subsequent post-commissioning procedures.
> On the LaunchPad, you can find the ESP-Matter Light example available under the name "Light Switch."
## FAQs
My light is not getting bound to my switch:
- Make sure the light's acl is updated. You can read it again to make