Skip to content

Commit

Permalink
[doc] Updates docs for cleanly upgrading to release/v4.4 ESP-IDF SDK. (
Browse files Browse the repository at this point in the history
…#14912)

* [doc] Updates docs for cleanly upgrading to release/v4.4 ESP-IDF SDK.

* [doc] Adjust esp32 usbserial connection name on Mac to match typical.

* restyle

* [doc] Comment resolution.

* [doc] Add details on setting proper VID / PID to ESP docs.

* Added spellcheck words and ran things through `sort -f | uniq -i`

* Restyle

Co-authored-by: Andrei Litvin <andy314@gmail.com>
  • Loading branch information
2 people authored and pull[bot] committed Feb 4, 2024
1 parent 8a94ec4 commit 3192969
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 5 deletions.
7 changes: 6 additions & 1 deletion .github/.wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,7 @@ CCMP
CCS
CCSTUDIO
CCXML
CDEEDC
CDVersionNumber
ced
cfg
Expand Down Expand Up @@ -342,6 +343,7 @@ detokenizer
dev
devcontainer
devCtrl
DevelopmentCerts
DeviceAttestationCredsExample
DeviceCaCerts
DeviceCert
Expand Down Expand Up @@ -477,6 +479,7 @@ FC
FDDE
fddead
fde
fdx
FECA
FecalColiformAndEColiConcentrationMeasurement
feff
Expand Down Expand Up @@ -650,6 +653,7 @@ kAdminister
kBusy
kCase
Kconfig
kDacPublicKey
KeypadInput
keyset
kGroup
Expand Down Expand Up @@ -1252,7 +1256,7 @@ TXD
txt
uargument
UART
udc
UDC
udcport
udhcpc
UDP
Expand All @@ -1279,6 +1283,7 @@ ureverse
URI
urlrequest
usbmodem
usbserial
USBtoUART
uscif
UserConsentNeeded
Expand Down
27 changes: 23 additions & 4 deletions examples/all-clusters-app/esp32/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,18 @@ step. To install these components manually, follow these steps:
$ git checkout v4.4
$ git submodule update --init
$ ./install.sh
$ . ./export.sh

To update an existing esp-idf toolchain to v4.4:

$ cd ~/tools/esp-idf
$ git fetch origin
$ git checkout v4.4
$ git reset --hard origin/v4.4
$ git submodule update --init
$ git clean -fdx
$ ./install.sh
$ . ./export.sh

- Install ninja-build

Expand Down Expand Up @@ -112,10 +124,11 @@ that are currently supported include `ESP32-DevKitC` (default),
- After building the application, to flash it outside of VSCode, connect your
device via USB. Then run the following command to flash the demo application
onto the device and then monitor its output. If necessary, replace
`/dev/tty.SLAB_USBtoUART`(MacOS) with the correct USB device name for your
system(like `/dev/ttyUSB0` on Linux). Note that sometimes you might have to
press and hold the `boot` button on the device while it's trying to connect
before flashing. For ESP32-DevKitC devices this is labeled in the
`/dev/tty.SLAB_USBtoUART` with the correct USB device name for your system
(like `/dev/ttyUSB0` on Linux or `/dev/tty.usbserial-01CDEEDC` on Mac). Note
that sometimes you might have to press and hold the `boot` button on the
device while it's trying to connect before flashing. For ESP32-DevKitC
devices this is labeled in the
[functional description diagram](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/hw-reference/esp32/get-started-devkitc.html#functional-description).

$ idf.py -p /dev/tty.SLAB_USBtoUART flash monitor
Expand Down Expand Up @@ -148,6 +161,12 @@ menuconfig).

`idf.py menuconfig -> Component config -> CHIP Device Layer -> WiFi Station Options`

NOTE: to avoid build error
`undefined reference to 'chip::DevelopmentCerts::kDacPublicKey'`, set VID to
0xFFF1 and PID in range 0x8000..0x8005.

`idf.py menuconfig -> Component config -> CHIP Device Layer -> Device Identification Options`

2. Now flash the device with the same command as before. (Use the right `/dev`
device)

Expand Down

0 comments on commit 3192969

Please sign in to comment.