From b2a950a787ef9c522316564f7d88160258077f3a Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Wed, 25 Oct 2023 11:56:53 -0700 Subject: [PATCH 1/2] update cli instructions --- .../flashing-firmware/esp32/cli-script.mdx | 19 ++++++------------- 1 file changed, 6 insertions(+), 13 deletions(-) diff --git a/docs/getting-started/flashing-firmware/esp32/cli-script.mdx b/docs/getting-started/flashing-firmware/esp32/cli-script.mdx index 51bbade3..d072ede8 100644 --- a/docs/getting-started/flashing-firmware/esp32/cli-script.mdx +++ b/docs/getting-started/flashing-firmware/esp32/cli-script.mdx @@ -18,7 +18,7 @@ Before you flash your device start by verifying connectivity with the device bei :::note The [T-Beam 0.7](/docs/hardware/devices/tbeam#t-beam---v07) board is an earlier version of the T-Beam board, and due to changes in the design in subsequent iterations this board uses a specific firmware file different from the other T-Beam boards. -`firmware-tbeam0.7-1.x.x.bin` is the correct firmware. `firmware-tbeam-1.x.x.bin` is incompatible. For all other [T-Beam](/docs/hardware/devices/tbeam) boards `firmware-tbeam-1.x.x.bin` is the correct selection. +`firmware-tbeam0.7-X.X.X.xxxxxxx.bin` is the correct firmware. `firmware-tbeam-X.X.X.xxxxxxx.bin` is incompatible. For all other [T-Beam](/docs/hardware/devices/tbeam) boards `firmware-tbeam-X.X.X.xxxxxxx.bin` is the correct selection. ::: ## Command Line Interface Instructions @@ -186,7 +186,7 @@ cd ~/Downloads/firmware/ Install or Update the device that you have by using the following commands according to your operating system: :::caution -Be very careful to install the correct load for your board. In particular the popular 'T-BEAM' radio from TTGO is not called 'TTGO-Lora' (that is a different board). So don't install the 'TTGO-Lora' build on a TBEAM, it won't work correctly. +Be very careful to install the correct load for your board. In particular the popular 'T-BEAM' radio from TTGO is not called 'TTGO-Lora' (that is a different board). So don't install the 'TTGO-Lora' build on a TBEAM, it won't work correctly. If you flash the incorrect firmware: It may appear to flash correctly, but if your device has a screen it might stay blank. On-board radio peripherals might be damaged because of GPIO pin direction, but you should just try to flash with the correct version. ::: + #### Install ```shell title="Command" ./device-install.sh -f firmware-BOARD-VERSION.bin ``` + #### Update ```shell title="Command" @@ -229,12 +231,14 @@ values={[ + #### Install ```shell title="Command" device-install.bat -f firmware-BOARD-VERSION.bin ``` + #### Update ```shell title="Command" @@ -244,17 +248,6 @@ device-update.bat -f firmware-BOARD-VERSION.bin -### Select Firmware - -Browse to the previously downloaded firmware and select the correct firmware based on the board type and frequency. - -:::caution -Be very careful to install the correct load for your board. In particular the popular 'T-BEAM' radio from TTGO is not called 'TTGO-Lora' (that is a different board). So don't install the 'TTGO-Lora' build on a TBEAM, it won't work correctly. If you flash the incorrect firmware: It may appear to flash correctly, but if your device has a screen it might stay blank. On-board radio peripherals might be damaged because of GPIO pin direction, but you should just try to flash with the correct version. -::: - -### Flash Firmware - -Select `Flash ESP`. It may take a minute or two. Once complete, "Done! Flashing is complete!" will be shown. ## Connect and Configure Device From 6f73de8f6bdb59acff00e3da7f6f69745d5fca6d Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Wed, 25 Oct 2023 14:48:17 -0700 Subject: [PATCH 2/2] reword based on review --- docs/getting-started/flashing-firmware/esp32/cli-script.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/flashing-firmware/esp32/cli-script.mdx b/docs/getting-started/flashing-firmware/esp32/cli-script.mdx index d072ede8..6db52e02 100644 --- a/docs/getting-started/flashing-firmware/esp32/cli-script.mdx +++ b/docs/getting-started/flashing-firmware/esp32/cli-script.mdx @@ -186,7 +186,7 @@ cd ~/Downloads/firmware/ Install or Update the device that you have by using the following commands according to your operating system: :::caution -Be very careful to install the correct load for your board. In particular the popular 'T-BEAM' radio from TTGO is not called 'TTGO-Lora' (that is a different board). So don't install the 'TTGO-Lora' build on a TBEAM, it won't work correctly. If you flash the incorrect firmware: It may appear to flash correctly, but if your device has a screen it might stay blank. On-board radio peripherals might be damaged because of GPIO pin direction, but you should just try to flash with the correct version. +Be very careful to install the correct firmware file for your board. In particular, the popular 'T-BEAM' radio from TTGO is not called 'TTGO-Lora' (that is a different board). So don't install the 'TTGO-Lora' build on a TBEAM, it won't work correctly. If you flash the incorrect device firmware, it may appear to successfully complete, yet the device will usually become unresponsive, displaying a blank screen (if equipped). Attempt to flash the correct version. Please note, while these devices are quite resilient and damage is not always likely, there is a possibility of onboard radio and peripheral damage due to incorrect GPIO pin direction. :::