From 334026ab1e3dde1164f757d54531d15af5c3229d Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Thu, 15 Apr 2021 13:57:34 -0600 Subject: [PATCH] Created Linux firmware flashing page. TODO add GUI section for ubuntu esphome-flasher release --- .../flashing_firmware/linux.md | 69 +++++++++++++++++++ website/sidebars.js | 1 + 2 files changed, 70 insertions(+) create mode 100644 website/docs/getting_started/flashing_firmware/linux.md diff --git a/website/docs/getting_started/flashing_firmware/linux.md b/website/docs/getting_started/flashing_firmware/linux.md new file mode 100644 index 00000000..ba6ac642 --- /dev/null +++ b/website/docs/getting_started/flashing_firmware/linux.md @@ -0,0 +1,69 @@ +--- +id: linux +title: Flashing Firmware – Linux +sidebar_label: Linux +--- +:::note +To check if you have a data cable that will work, plug in your device and **then** navigate to `Apple Menu  > About This Mac > System Report... > Hardware > USB` +you should see something like `CP210X USB to UART Bridge Controller`. +::: + +## Download Firmware + + +Download the [latest](https://github.com/meshtastic/meshtastic-device/releases/latest) firmware release. Unzip the file and locate the correct device and region within the list of prebuilt binaries. + +## Command Line Instructions + +Requires `Python` and `pip` + +1. Install `esptool` +```bash +pip install --upgrade esptool +``` +2. Connect your radio to your USB port +3. Confirm that your device is talking to your Mac by running the following command in Terminal +```bash title="Command" +esptool.py chip_id +``` +```bash title="Expected Output" +# You should see a result similar to this: +mydir$ esptool.py chip_id +esptool.py v2.6 +Found 2 serial ports +Serial port /dev/ttyUSB0 +Connecting.... +Detecting chip type... ESP32 +Chip is ESP32D0WDQ6 (revision 1) +Features: WiFi, BT, Dual Core, 240MHz, VRef calibration in efuse, Coding Scheme None +MAC: 24:6f:28:b5:36:71 +Uploading stub... +Running stub... +Stub running... +Warning: ESP32 has no Chip ID. Reading MAC instead. +MAC: 24:6f:28:b5:36:71 +Hard resetting via RTS pin... +``` +4. `cd` into the directory where you unzipped the latest release. For example: +```bash title="Example" +cd /Downloads/firmware/ +``` +5. Install the correct firmware for your board with +:::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. +::: +```bash title="Command" +device-install.sh -f firmware-BOARD-VERSION.bin +``` +```bash title="Example" +./device-install.sh -f firmware-heltec-EU865-1.2.0.bin +``` +6. To update a the firmware on an existing Meshtastic device, run +```bash title="Command" +device-update.sh -f firmware-BOARD-VERSION.bin +``` +```bash title="Example" +./device-update.sh -f firmware-heltec-EU865-1.2.0.bin +``` + +## Graphical User Interface Instructions diff --git a/website/sidebars.js b/website/sidebars.js index 9fbaa034..e94255a0 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -9,6 +9,7 @@ module.exports = { "getting_started/flashing_firmware/flashing_firmware_cli", "getting_started/flashing_firmware/flashing_firmware_gui", "getting_started/flashing_firmware/flashing_firmware_ota", + "getting_started/flashing_firmware/linux", "getting_started/flashing_firmware/macos", "getting_started/flashing_firmware/windows", ],