diff --git a/website/docs/getting-started/flashing-firmware.md b/website/docs/getting-started/flashing-esp32.md similarity index 99% rename from website/docs/getting-started/flashing-firmware.md rename to website/docs/getting-started/flashing-esp32.md index 9a176009..43842309 100644 --- a/website/docs/getting-started/flashing-firmware.md +++ b/website/docs/getting-started/flashing-esp32.md @@ -1,7 +1,7 @@ --- -id: flashing-firmware -title: Flashing Firmware -sidebar_label: Flashing Firmware +id: flashing-esp32 +title: Flashing ESP32 devices firmware +sidebar_label: ESP32 devices --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/website/docs/getting-started/flashing-nrf52.md b/website/docs/getting-started/flashing-nrf52.md new file mode 100644 index 00000000..3c4c25c7 --- /dev/null +++ b/website/docs/getting-started/flashing-nrf52.md @@ -0,0 +1,38 @@ +--- +id: flashing-nrf52 +title: Flashing nRF52 devices firmware +sidebar_label: nRF52 devices +--- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +## Pre-requisits + +Please ensure that you use a data USB cable, as some cables provide power only and not the data lines. + +### T-Echo + +You may need to install the [USB device drivers](http://www.wch-ic.com/search?q=ch340&t=downloads) if your device does not show up when connected. + +### WisBlock RAK4631 + +Please ensure that you have updated the bootloader to the latest version using the information on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK4631/Quickstart/#how-to-check-if-you-have-the-updated-rak4631-bootloader) website. +## Download Latest Firmware + +Prebuilt binaries for the supported radios are available in our releases. Your initial installation has to happen over USB from your Mac, Windows or Linux PC. Once our software is installed, all future software updates happen over bluetooth from your phone. + + +| [Current Firmware](https://github.com/meshtastic/meshtastic-device/releases/latest) | [List of Firmware Versions](https://github.com/meshtastic/meshtastic-device/releases/) | +| :--------------: | :-----------------------: | + +## Install/Update Firmware +:::caution +Be careful to install the correct load for your board. While it is unlikely that you will cause damage to your device, the wrong firmware will cause it to not work. +::: + + +* Connect your device to your computer with a USB cable. If you computer complains about needing to format a new drive, cancel the format command. +* Double click the reset button on your device, this will put it into boot loader mode. +* A new drive will then be mounted on your computer. Open this drive and you should see three files: `CURRENT.UF2`, `INDEX.HTM`, and `INFO_UF2.TXT` +* Copy the appropriate `firmware-xxxxx-1.2.x.uf2` file from the firmware zip file onto the new drive. +* Once the file has finished copying over, the device will reboot, loading the new firmware as it does. diff --git a/website/docs/getting-started/getting_started.md b/website/docs/getting-started/getting_started.md index cc692ab4..9228804c 100644 --- a/website/docs/getting-started/getting_started.md +++ b/website/docs/getting-started/getting_started.md @@ -32,6 +32,8 @@ If your device already has Meshtastic flashed to it, You can update it over the - Install using the command line interface (CLI) - Install using a graphical user interface (GUI) +The firmware installation method will also depend on whether you have an ESP32 based device or a nRF52 based device. See our [hardware section](/docs/hardware) to determine which microcontroller your device is based on. + ## Connect to your Device There are many ways to connect to your new radio! diff --git a/website/docs/hardware/rak4631.md b/website/docs/hardware/rak4631.md index 20eacbd2..00977828 100644 --- a/website/docs/hardware/rak4631.md +++ b/website/docs/hardware/rak4631.md @@ -27,5 +27,6 @@ There is currently fledgling support for the WisBlock RAK4631 module. The WisBlo * [Purchase Link](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK4631/Overview) * [Installation instructions](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK4631/Quickstart/#rak4631-lora-mesh-via-meshtastic) * Dont forget to [update the bootloader](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK4631/Quickstart/#updating-the-bootloader) first! +* RAK's [GitHub Page](https://github.com/RAKWireless/WisBlock) for the WisBlock RAK4631 Core Module \ No newline at end of file diff --git a/website/docs/hardware/techo.md b/website/docs/hardware/techo.md index 10dbd55e..500df89f 100644 --- a/website/docs/hardware/techo.md +++ b/website/docs/hardware/techo.md @@ -18,5 +18,6 @@ The T-Echo has been in development by LILYGO® over the past few months and has * firmware file: `firmware-t-echo-1.x.x.uf2` * [Purchase link](https://www.aliexpress.com/item/1005002842456390.html) +* TTGO's [GitHub page](https://github.com/Xinyuan-LilyGO/LilyGO-T-Echo) for the T-Echo LILYGO T-Echo diff --git a/website/docs/software/android/usage.md b/website/docs/software/android/usage.md index b6c01c14..a14bfb11 100644 --- a/website/docs/software/android/usage.md +++ b/website/docs/software/android/usage.md @@ -14,7 +14,7 @@ Open the App and you should see a screen like this. You can move through the tab ## Connecting -You will need a device with Meshtastic installed to go any further. See the [flashing firmware](/docs/getting-started/flashing-firmware) section for information on how to do this. +You will need a device with Meshtastic installed to go any further. See the [getting started](/docs/getting-started) section for information on how to do this. Open the Settings tab (last tab), and it should look similar to the screen below. It shows any Meshtastic devices that are found over Bluetooth. diff --git a/website/sidebars.js b/website/sidebars.js index 245fdbc8..9c0684b3 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -2,9 +2,11 @@ module.exports = { Sidebar: { "Getting Started": [ "getting-started/overview", - "getting-started/flashing-firmware", { - "Howto's": [], + "Flashing firmware": [ + "getting-started/flashing-esp32", + "getting-started/flashing-nrf52", + ], }, "getting-started/concepts", ],