mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2025-03-05 21:00:08 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #857 from pdxlocations/esp-cli

Browse source 
Update ESP32 CLI flashing instructions
This commit is contained in:
Ben Lipsey 2023-10-25 16:44:04 -07:00 committed by GitHub
parent 52a9d39a32 344e6006f0
commit fe52016305
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
docs/getting-started/flashing-firmware/esp32/cli-script.mdx
View file

@ -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 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.
:::
<Tabs
@ -214,12 +214,14 @@ values={[
</TabItem>
<TabItem value="macos">
<!-- trunk-ignore(markdownlint/MD024) -->
#### Install
```shell title="Command"
./device-install.sh -f firmware-BOARD-VERSION.bin
```
<!-- trunk-ignore(markdownlint/MD024) -->
#### Update
```shell title="Command"
@ -229,12 +231,14 @@ values={[
</TabItem>
<TabItem value="windows">
<!-- trunk-ignore(markdownlint/MD024) -->
#### Install
```shell title="Command"
device-install.bat -f firmware-BOARD-VERSION.bin
```
<!-- trunk-ignore(markdownlint/MD024) -->
#### Update
```shell title="Command"
@ -244,17 +248,6 @@ device-update.bat -f firmware-BOARD-VERSION.bin
</TabItem>
</Tabs>
### 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