mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-11-12 16:44:20 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Clean up and simplify the getting started section

Browse source
This commit is contained in:
tekstrand 2024-11-01 12:47:32 -05:00
parent 7b74c4d317
commit b0d52d0178
36 changed files with 253 additions and 355 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/about/faq.mdx
View file

@ -23,7 +23,7 @@ export const Faq = {
"firmware": [
{
title: "Can I update my node's firmware over the mesh?",
content: `No, Meshtastic does not support OTA updates over LoRa. Please visit [Flash Firmware](/docs/getting-started/flashing-firmware/) for update options.`,
content: `No, Meshtastic does not support OTA updates over LoRa. Please visit [Flash Firmware](/docs/support-troubleshooting/flashing-firmware/) for update options.`,
},
{
title: "Which version of firmware should I use?",

2
docs/community/_category_.yml
View file

@ -1,4 +1,4 @@
position: 7
position: 8
label: Community
collapsible: true # make the category collapsible
link:

7
docs/configuration/_category_.yml
View file

@ -1,7 +0,0 @@
label: Configuration
collapsible: true
position: 4
link:
type: generated-index
title: Configuration
slug: /configuration

75
docs/configuration/index.mdx Normal file
View file

@ -0,0 +1,75 @@
---
sidebar_label: Configuration
collapsible: true
sidebar_position: 4
id: configuration
title: Configuration
slug: /configuration
description: How to configure your Meshtastic device to get started
---
import LoRaRegions from "../blocks/_lora-regions.mdx";
import TabItem from "@theme/TabItem";
import Tabs from "@theme/Tabs";
## Select Region
To start communicating over the mesh, the only setting your must configure is your region. This controls the frequency range your device uses and should be set according to your regional location.
<Tabs
groupId="settings"
defaultValue="android"
values={[
{label: 'Android', value: 'android'},
{label: 'Apple', value: 'apple'},
{label: 'CLI', value: 'cli'},
{label: 'Web', value: 'web'},
]}>
<TabItem value="android">
#### Android
1. [Install the Android app](/docs/software/android/installation)
2. Connect to the device using Bluetooth or USB Serial.
3. Tap "UNSET" next to the device name.
4. Select the region
</TabItem>
<TabItem value="apple">
#### Apple
1. [Install the Apple app](/docs/software/apple/installation/)
2. Connect to the device using Bluetooth
3. If unset, tap "Set Region" or go to Settings > LoRa
</TabItem>
<TabItem value="cli">
#### CLI
1. [Install the Python CLI](/docs/software/python/cli/installation)
2. Run the following command, replacing `<REGION-CODE>` with the region code listed above according to your regional location.
```sh
meshtastic --set lora.region <REGION-CODE>
```
</TabItem>
<TabItem value="web">
#### Web
1. Open the Meshtastic Web interface: [client.meshtastic.org](https://client.meshtastic.org).
2. Connect to your device.
3. Navigate to **Config** > **LoRa** menu.
3. Set **Region** according to your regional location.
4. Click the **Save** icon.
</TabItem>
</Tabs>
### Region Codes
<LoRaRegions />
Refer to [LoRa Region by Country](/docs/configuration/region-by-country) for a more comprehensive list.

2
docs/configuration/radio/device.mdx
View file

@ -28,7 +28,7 @@ The device config options are: Role, Serial Output, and Debug Log. Device config
| ROUTER | Infrastructure node for extending network coverage by relaying messages. Visible in Nodes list. | Best positioned in strategic locations to maximize the network's overall coverage. Device is shown in topology. |
:::tip
Still not sure which role to use? Check out the [role configuration tips](/docs/configuration/tips/#roles)
Still not sure which role to use? Check out the [role configuration tips](/docs/getting-started/tips/#roles)
:::
Looking for ROUTER_CLIENT? This role was deprecated in firmware 2.3.15. Learn more in the [2.3.15 release notes](https://github.com/meshtastic/firmware/releases/tag/v2.3.15.deb7c27)

2
docs/development/firmware/building.mdx
View file

@ -77,5 +77,5 @@ Gitpod offers an alternative method for compiling the firmware without installin
3. Build the firmware by running: `pio run -e <variant_name>`
4. Once complete, download `<variant_name>.bin` or `<variant_name>.uf2` from `/workspace/firmware/.pio/build/<variant_name>.`
5. As flashing directly to the device isn't possible using Gitpod, upload using either:
- [Drag & Drop](/docs/getting-started/flashing-firmware/nrf52/#drag--drop) for NRF52/RP2040 devices.
- [Drag & Drop](/docs/support-troubleshooting/flashing-firmware/nrf52/#drag--drop) for NRF52/RP2040 devices.
- [Web flasher](https://flasher.meshtastic.org/) for ESP32 devices.

7
docs/getting-started/_category_.yml Normal file
View file

@ -0,0 +1,7 @@
label: Getting Started
collapsible: true
position: 1
link:
type: generated-index
title: Getting Started
slug: /getting-started

26
docs/getting-started/flashing-firmware/nrf52/index.mdx
View file

@ -1,26 +0,0 @@
---
id: flashing-nrf52-devices
title: Flash nRF52 & RP2040 Devices
sidebar_label: nRF52/RP2040 Device
sidebar_position: 2
description: Instructions to flash Meshtastic firmware to nRF52 or RP2040 chipset devices.
---
## Flashing Methods for nRF52 and RP2040 Devices
nRF52 and RP2040 based devices have the easiest firmware upgrade process. No driver or software install is required on any platform.
### Drag & Drop
nRF52 and RP2040 devices use the [Drag & Drop](/docs/getting-started/flashing-firmware/nrf52/drag-n-drop) installation method to install firmware releases.
### Over-The-Air (OTA)
nRF52 devices are able to accept [OTA firmware updates](/docs/getting-started/flashing-firmware/nrf52/ota) from a mobile device over bluetooth.
### nRF Factory Erase
You may wish to perform a [Factory Erase](/docs/getting-started/flashing-firmware/nrf52/nrf52-erase) prior to installing firmware to clear data that may change format and location between releases.
### Convert RAK4631-R to RAK4631
If your device did not come with the Arduino bootloader you will need to [perform the conversion](/docs/getting-started/flashing-firmware/nrf52/convert-rak4631r).
### Use Raspberry Pi as a SWDIO Flash Tool
If your device can't be flashed through USB or Bluetooth, another option might be a [direct SWDIO connection](/docs/getting-started/flashing-firmware/nrf52/swdio).

136
docs/getting-started/index.mdx
View file

@ -1,136 +0,0 @@
---
id: getting-started
title: Getting Started
sidebar_label: Getting Started
slug: /getting-started
sidebar_position: 2
description: The official Meshtastic guide to get you started. Covers all devices and configurations.
---
import Link from "@docusaurus/Link";
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
## Identify Hardware
:::note
This guide assumes that you have already purchased the devices you will be using with Meshtastic. If you haven't, you can check out our list of [supported hardware](/docs/hardware/devices/index.mdx)
to see your options.
:::
Before you begin, it's important to determine which kind of hardware you're using. Meshtastic works with devices that have these types of Micro-Controller Units (MCU):
### ESP32
The ESP32 chip is older and consumes more power than the nRF52 chip, but is equipped with both WiFi and Bluetooth. Supported ESP32 devices include:
- LILYGO® TTGO T-Beam (>V1.1 recommended)
- LILYGO® TTGO Lora (>V2.1 recommended)
- Nano G1
- Station G1
- Heltec V3 and Wireless Stick Lite V3
- RAK11200 Core module for RAK WisBlock modular boards
### nRF52
The nRF52 chip is much more power efficient than the ESP32 chip and easier to update, but is only equipped with Bluetooth. Supported nRF52 devices include:
- RAK4631 Core module for RAK WisBlock modular boards
- LILYGO® TTGO T-Echo
### RP2040
The RP2040 is a dual-core ARM chip developed by Raspberry Pi. Supported RP2040 devices include:
- Raspberry Pi Pico + Waveshare LoRa Module (Note: **Bluetooth on the Pico W is not yet supported by Meshtastic**)
- RAK11310 Core module for RAK WisBlock modular boards
:::info
If your device is not listed above, please review our [supported devices](/docs/hardware/devices/index.mdx) to determine which MCU your device has or contact us in [Discord](https://discord.gg/ktMAKGBnBs) with any questions.
:::
:::danger STOP! Put The Power Cable Down!
Never power on the radio without attaching an antenna! _It_ could damage the radio chip.
:::
Prior to connecting your Meshtastic device to the computer, you should perform the following basic checks.
### Verify Data Cable
Some cables only provide _charging_, verify that your cable is also capable of _transferring data_ before proceeding. To check if your cable can also transfer data, try connecting it to another device (like a phone) and see if you can copy a file to or from it. If the file transfer works, then your cable is also able to transfer data and you can continue.
### Install Serial Drivers
:::caution
nRF52/RP2040 devices typically do not require serial drivers. They use the UF2 bootloader which makes the devices appear as flash drives. Do _NOT_ download the USB device drivers unless required to install UF2 support.
:::
If you require serial drivers installed on your computer, please choose one of the options below and install it before continuing.
<div className="indexCtasBody">
<div className="split-container">
<div className="split-item">
<Link
className={'button button--outline button--lg cta--button'}
to={'/docs/getting-started/serial-drivers/esp32'}
>
Install ESP32 Drivers
</Link>
</div>
<div className="split-item">
<Link
className={'button button--outline button--lg cta--button'}
to={'/docs/getting-started/serial-drivers/nrf52'}
>
Install nRF52/RP2040 Drivers
</Link>
</div>
</div>
</div>
### Flash Firmware
After completing the previous steps, you can now flash the Meshtastic firmware onto your device. To proceed, select the appropriate device type for your device.
<div className="indexCtasBody">
<div className="split-container">
<div className="split-item">
<Link
className={"button button--outline button--lg cta--button"}
to={"/docs/getting-started/flashing-firmware/esp32/"}
>
Flash ESP32 Firmware
</Link>
</div>
<div className="split-item">
<Link
className={"button button--outline button--lg cta--button"}
to={"/docs/getting-started/flashing-firmware/nrf52/"}
>
Flash nRF52/RP2040 Firmware
</Link>
</div>
</div>
</div>
### Connect and Configure Device
After flashing the Meshtastic firmware onto your device, you can now move on to initial configuration.
<div className="indexCtasBody">
<Link
className={"button button--outline button--lg cta--button"}
to={"/docs/getting-started/initial-config"}
>
Connect and Configure Device
</Link>
</div>

136
docs/getting-started/initial-config.mdx
View file

@ -1,136 +0,0 @@
---
id: initial-config
title: Initial Configuration
sidebar_label: Initial Configuration
slug: /getting-started/initial-config
sidebar_position: 4
description: Getting started with the initial configuration of your Meshtastic device including serial, bluetooth, LoRa, and more.
---
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import LoRaRegions from "../blocks/_lora-regions.mdx";
import Link from "@docusaurus/Link";
## Supported Clients per Connection Type
Depending on your connection, some configuration options are not fully supported. Find out which client is best for your type of connection.
<Tabs
groupId="settings"
defaultValue="ble"
values={[
{label: 'Serial', value: 'serial'},
{label: 'Bluetooth', value: 'ble'},
{label: 'Network', value: 'network'},
]}>
<TabItem value="serial">
#### Serial
- [Python CLI](/docs/software/python/cli/)
- [Web Client](https://client.meshtastic.org)
- [Android App](/docs/category/android-app)
</TabItem>
<TabItem value="ble">
#### Bluetooth
- [Android App](/docs/category/android-app)
- [Web Client](https://client.meshtastic.org)
</TabItem>
<TabItem value="network">
#### Network
:::info
Connecting over network is only supported on ESP32 devices.
:::
- [Web Client](https://client.meshtastic.org)
- [Android App](/docs/category/android-app)
- [iOS App](/docs/category/apple-apps)
- [Python CLI](/docs/software/python/cli/)
</TabItem>
</Tabs>
## Set Regional Settings
In order to start communicating over the mesh, you must set your region. This setting controls which frequency range your device uses and should be set according to your regional location.
<Tabs
groupId="settings"
defaultValue="apple"
values={[
{label: 'Android', value: 'android'},
{label: 'Apple', value: 'apple'},
{label: 'CLI', value: 'cli'},
{label: 'Web', value: 'web'},
]}>
<TabItem value="android">
#### Android
1. Follow the [installation](/docs/software/android/installation) and [usage](/docs/software/python/cli/usage) instructions for [Meshtastic Android](/docs/category/android-app).
2. Open the app, connect to the device from your phone over USB Serial or Bluetooth.
3. Once paired, Click "UNSET" next to the device name.
4. Select the region from the list according to your regional location.
</TabItem>
<TabItem value="apple">
#### Apple
:::info
Configuration of Region, Modem Preset and Hop Limit is available on iOS, iPadOS and macOS at Settings > Radio Configuration > LoRa.
:::
</TabItem>
<TabItem value="cli">
#### CLI
1. Install [Meshtastic PythonCLI](/docs/software/python/cli/installation)
```sh
pip3 install --upgrade pytap2
pip3 install --upgrade meshtastic
```
2. Run the following command, replacing `<REGION-CODE>` with the region code listed above according to your regional location.
```sh
meshtastic --set lora.region <REGION-CODE>
```
</TabItem>
<TabItem value="web">
#### Web
1. Open the Meshtastic Web interface: [client.meshtastic.org](https://client.meshtastic.org)
2. Navigate to the **LoRa** menu.
3. Under **Regional Settings**, set your **Region** according to your regional location.
4. Click **Save**.
</TabItem>
</Tabs>
### Region Codes
<LoRaRegions />
Refer to [LoRa Region by Country](/docs/configuration/region-by-country) for a more comprehensive list.
## Continue Configuration
Now that you have set the LoRa region on your device, you can continue with configuring any additional configs to suit your needs.
<div className="indexCtasBody">
<Link
className={"button button--outline button--lg cta--button"}
to={"/docs/configuration/"}
>
Device Configuration
</Link>
</div>

61
docs/getting-started/quick-start.mdx Normal file
View file

@ -0,0 +1,61 @@
---
id: quick-start
title: Quick Start Guide
sidebar_label: Quick Start Guide
sidebar_position: 1
description: The official Meshtastic guide to get you started fast.
---
import Link from "@docusaurus/Link";
## 1. Select hardware
If you haven't already purchased hardware, [find supported hardware](/docs/hardware/devices/index.mdx)
## 2. Connect Device
:::danger STOP! Put The Power Cable Down!
Never power on the radio without attaching an antenna as doing so may damage the radio chip!
:::
### Verify Data Cable
Some cables only support _charging_. Verify that your cable is also capable of _transferring data_ before proceeding. To verify, try connecting it to another device (like a phone) to see if you can copy a file to or from it.
## 3. Flash Firmware
Now that your device is connected, you can flash the latest firmware to your device.
<div className="indexCtasBody">
<div className="split-container">
<div className="split-item">
<Link
className={"button button--outline button--lg cta--button"}
to={"/docs/support-troubleshooting/flashing-firmware/esp32/"}
>
Flash ESP32 Firmware
</Link>
</div>
<div className="split-item">
<Link
className={"button button--outline button--lg cta--button"}
to={"/docs/support-troubleshooting/flashing-firmware/nrf52/"}
>
Flash nRF52/RP2040 Firmware
</Link>
</div>
</div>
</div>
## 4. Configure your region
To start communicating over the mesh, you must [configure your region](/docs/configuration/).
## 5. Start meshing!
Check out our [tips and best practices](/docs/getting-started/tips/) for the best experience.
With the antenna attached, the latest firmware, and your region configured, you can now start sending messages over the mesh!
For advanced configuration, check out the full [configuration documentation](/docs/configuration/).

4
docs/configuration/tips.mdx → docs/getting-started/tips.mdx
View file

@ -2,8 +2,8 @@
id: tips
title: Configuration Tips
description: Tips and Solutions to help you get the most out of your Meshtastic device and network.
sidebar_label: Tips
sidebar_position: 4
sidebar_label: Tips & Best Practices
sidebar_position: 2
---
## Roles

7
docs/hardware/_category_.yml
View file

@ -1,7 +0,0 @@
label: Hardware
collapsible: true
position: 5
link:
type: generated-index
title: Supported Hardware
slug: hardware

2
docs/hardware/devices/lilygo/lora/index.mdx
View file

@ -265,7 +265,7 @@ With the device now in the Espressif Firmware Download mode, you can proceed wit
:::note
If after successfully flashing the device and the screen remains black, you may need to use the [CLI Script](https://meshtastic.org/docs/getting-started/flashing-firmware/esp32/cli-script) to flash Meshtastic.
If after successfully flashing the device and the screen remains black, you may need to use the [CLI Script](https://meshtastic.org/docs/support-troubleshooting/flashing-firmware/esp32/cli-script) to flash Meshtastic.
:::

2
docs/hardware/devices/rak-wireless/wisblock/core-modules.mdx
View file

@ -23,7 +23,7 @@ values={[
## RAK4631 - nRF52
:::info
Please be aware of the difference between the RAK4631 (Arduino bootloader) and the RAK4631-R (RUI3 bootloader). Meshtastic requires the Arduino bootloader. If you have a RAK4631-R, please see the [instructions for converting the bootloader](/docs/getting-started/flashing-firmware/nrf52/convert-rak4631r).
Please be aware of the difference between the RAK4631 (Arduino bootloader) and the RAK4631-R (RUI3 bootloader). Meshtastic requires the Arduino bootloader. If you have a RAK4631-R, please see the [instructions for converting the bootloader](/docs/support-troubleshooting/flashing-firmware/nrf52/convert-rak4631r).
:::
- RAK4631

36
docs/hardware/index.mdx Normal file
View file

@ -0,0 +1,36 @@
---
id: hardware
sidebar_label: Hardware
sidebar_position: 5
slug: /hardware
title: Supported Hardware
---
### ESP32
The ESP32 chip is older and consumes more power than the nRF52 chip, but is equipped with both WiFi and Bluetooth. Supported ESP32 devices include:
- LILYGO® TTGO T-Beam (>V1.1 recommended)
- LILYGO® TTGO Lora (>V2.1 recommended)
- Nano G1
- Station G1
- Heltec V3 and Wireless Stick Lite V3
- RAK11200 Core module for RAK WisBlock modular boards
### nRF52
The nRF52 chip is much more power efficient than the ESP32 chip and easier to update, but is only equipped with Bluetooth. Supported nRF52 devices include:
- RAK4631 Core module for RAK WisBlock modular boards
- LILYGO® TTGO T-Echo
### RP2040
The RP2040 is a dual-core ARM chip developed by Raspberry Pi. Supported RP2040 devices include:
- Raspberry Pi Pico + Waveshare LoRa Module (Note: **Bluetooth on the Pico W is not yet supported by Meshtastic**)
- RAK11310 Core module for RAK WisBlock modular boards
:::info
If your device is not listed above, please review our [supported devices](/docs/hardware/devices/index.mdx) to determine which MCU your device has or contact us in [Discord](https://discord.gg/ktMAKGBnBs) with any questions.
:::

2
docs/software/android/usage.mdx
View file

@ -81,7 +81,7 @@ of range.
### Set your region
In order to start communicating with your mesh, you must select a region. This setting controls which frequency range your device uses and should be set according to your location. See [Region Settings](https://meshtastic.org/docs/getting-started/initial-config#set-regional-settings) for a list of region codes and their meanings.
In order to start communicating with your mesh, you must select a region. This setting controls which frequency range your device uses and should be set according to your location. See [Region Settings](https://meshtastic.org/docs/getting-started/quick-start/#set-regional-settings) for a list of region codes and their meanings.
- Tap on the "Region" dropdown in the top-right corner and make the appropriate selection.

6
docs/software/python-cli/installation.mdx
View file

@ -54,7 +54,7 @@ values={[
- You should see something like:
- `ID 10c4:ea60 Silicon Labs CP210x UART Bridge` for CP210X
- `ID 1a86:55d4 QinHeng Electronics USB Single Serial` for CH9102
- If there is no seral device shown that matches the device you are using, please review our [Install Serial Drivers](/docs/getting-started/serial-drivers/) page before proceeding.
- If there is no seral device shown that matches the device you are using, please review our [Install Serial Drivers](/docs/support-troubleshooting/serial-drivers/) page before proceeding.
- Check that your computer has Python 3 installed.
@ -116,7 +116,7 @@ values={[
- Connect your Meshtastic device to your USB port
- Navigate to `Apple Menu  > About This Mac > System Report... > Hardware > USB`
- You should see something like `CP210X USB to UART Bridge Controller`
- If there is no serial device shown that matches the device you are using, please review our [Install Serial Drivers](/docs/getting-started/serial-drivers/) page before proceeding.
- If there is no serial device shown that matches the device you are using, please review our [Install Serial Drivers](/docs/support-troubleshooting/serial-drivers/) page before proceeding.
- Check that your computer has Python 3 installed.
- Use the command
```shell
@ -159,7 +159,7 @@ values={[
- Connect your Meshtastic device to your USB port
- Open Device Manager
- Under `Ports (COM & LPT)` you should see something like `Silicon Labs CP210X USB to UART Bridge (COM5)`
- If there is no serial device shown that matches the device you are using, please review our [Install Serial Drivers](/docs/getting-started/serial-drivers/) page before proceeding.
- If there is no serial device shown that matches the device you are using, please review our [Install Serial Drivers](/docs/support-troubleshooting/serial-drivers/) page before proceeding.
- Check that your computer has Python 3 installed.
- Use the command
```powershell

7
docs/support-troubleshooting/_category_.yml Normal file
View file

@ -0,0 +1,7 @@
label: Support & Troubleshooting
collapsible: true
position: 7
link:
type: generated-index
title: Support & Troubleshooting
slug: /support-troubleshooting

3
docs/getting-started/flashing-firmware/_category_.yml → docs/support-troubleshooting/flashing-firmware/_category_.yml
View file

@ -1,7 +1,6 @@
label: Flash Firmware
collapsible: true # make the category collapsible
position: 2
link:
type: generated-index
title: Flashing Firmware
slug: /getting-started/flashing-firmware
slug: /support-troubleshooting/flashing-firmware

2
docs/getting-started/flashing-firmware/esp32/cli-script.mdx → docs/support-troubleshooting/flashing-firmware/esp32/cli-script.mdx
View file

@ -286,7 +286,7 @@ After flashing the Meshtastic firmware to the device, you can proceed with the i
<div className="indexCtasBody">
<Link
className={"button button--outline button--lg cta--button"}
to={"/docs/getting-started/initial-config"}
to={"/docs/getting-started/quick-start/"}
>
Connect and Configure Device
</Link>

6
docs/getting-started/flashing-firmware/esp32/external-serial-adapter.mdx → docs/support-troubleshooting/flashing-firmware/esp32/external-serial-adapter.mdx
View file

@ -11,7 +11,7 @@ import TabItem from "@theme/TabItem";
import Link from "@docusaurus/Link";
:::info
This information will likely only be helpful if you've already attempted to go through the prerequisites and processes outlined in [manually flashing](/docs/getting-started/flashing-firmware/esp32/cli-script)
This information will likely only be helpful if you've already attempted to go through the prerequisites and processes outlined in [manually flashing](/docs/support-troubleshooting/flashing-firmware/esp32/cli-script)
:::
:::caution
@ -56,7 +56,7 @@ Disconnect your USB to Serial Adapter from the computer before starting this pro
### Flashing
After following the steps above, your device should be in flash mode. You can flash your device using the [manual method](/docs/getting-started/flashing-firmware/esp32/cli-script)
After following the steps above, your device should be in flash mode. You can flash your device using the [manual method](/docs/support-troubleshooting/flashing-firmware/esp32/cli-script)
After flashing the device is complete, reset your device (via the RST button if available).
If you have the Meshtastic Python CLI installed, you can run `meshtastic --noproto` to connect the device again over the adapter and view the serial output to confirm Meshtastic installed correctly.
@ -75,7 +75,7 @@ After flashing the Meshtastic firmware to the device, you can proceed with the i
<div className="indexCtasBody">
<Link
className={"button button--outline button--lg cta--button"}
to={"/docs/getting-started/initial-config"}
to={"/docs/getting-started/quick-start/"}
>
Connect and Configure Device
</Link>

6
docs/getting-started/flashing-firmware/esp32/index.mdx → docs/support-troubleshooting/flashing-firmware/esp32/index.mdx
View file

@ -12,9 +12,9 @@ The recommended method for firmware flashing is the [Web Flasher.](https://flash
## Flashing Method for ESP32 Devices
1. The [Web Flasher](/docs/getting-started/flashing-firmware/esp32/web-flasher.mdx) requires either Chrome or Edge browsers but is an excellent choice for quickly flashing devices. **This method is highly recommended for firmware flashing, especially for new users of the project, as it is easy to use.**
2. The [CLI Script](/docs/getting-started/flashing-firmware/esp32/cli-script) is considered the "manual process" for flashing firmware.
3. Flashing your device using an [external serial adapter](/docs/getting-started/flashing-firmware/esp32/external-serial-adapter) should only be attempted as a last resort if no other method has been successful.
1. The [Web Flasher](/docs/support-troubleshooting/flashing-firmware/esp32/web-flasher.mdx) requires either Chrome or Edge browsers but is an excellent choice for quickly flashing devices. **This method is highly recommended for firmware flashing, especially for new users of the project, as it is easy to use.**
2. The [CLI Script](/docs/support-troubleshooting/flashing-firmware/esp32/cli-script) is considered the "manual process" for flashing firmware.
3. Flashing your device using an [external serial adapter](/docs/support-troubleshooting/flashing-firmware/esp32/external-serial-adapter) should only be attempted as a last resort if no other method has been successful.
:::info note

2
docs/getting-started/flashing-firmware/esp32/web-flasher.mdx → docs/support-troubleshooting/flashing-firmware/esp32/web-flasher.mdx
View file

@ -22,7 +22,7 @@ After flashing the Meshtastic firmware to the device, you can proceed with the i
<Link
className={"button button--outline button--lg cta--button"}
style={{ fontSize: '0.8em', padding: '8px 16px' }}
to={"/docs/getting-started/initial-config"}
to={"/docs/getting-started/quick-start/"}
>
Connect and Configure Device
</Link>

4
docs/getting-started/flashing-firmware/nrf52/convert-rak4631r.mdx → docs/support-troubleshooting/flashing-firmware/nrf52/convert-rak4631r.mdx
View file

@ -26,7 +26,7 @@ Here are two ways to flash the bootloader:
adafruit-nrfutil --verbose dfu serial --package ./WisCore_RAK4631_Board_Bootloader.zip -p /dev/ttyACM0 -b 115200 --singlebank --touch 1200
```
Note: The serial port name (`/dev/ttyACM0`) may differ depending on your operating system. Make sure to identify the correct port name for your setup.
6. Continue with the normal [flashing instructions](/docs/getting-started/flashing-firmware/nrf52/drag-n-drop)
6. Continue with the normal [flashing instructions](/docs/support-troubleshooting/flashing-firmware/nrf52/drag-n-drop)
## Debugger
@ -44,6 +44,6 @@ This conversion requires the use of either a [DAPLink](https://daplink.io/) or [
```shell
pyocd flash -t nrf52840 .\WisCore_RAK4631_Board_Bootloader.hex
```
6. Continue with the normal [flashing instructions](/docs/getting-started/flashing-firmware/nrf52/drag-n-drop)
6. Continue with the normal [flashing instructions](/docs/support-troubleshooting/flashing-firmware/nrf52/drag-n-drop)
Alternate methods of flashing are outlined [here](https://github.com/RAKWireless/WisBlock/tree/master/bootloader/RAK4630).

6
docs/getting-started/flashing-firmware/nrf52/drag-n-drop.mdx → docs/support-troubleshooting/flashing-firmware/nrf52/drag-n-drop.mdx
View file

@ -41,7 +41,7 @@ After flashing the Meshtastic firmware to the device, you can proceed with the i
<div className="indexCtasBody">
<Link
className={"button button--outline button--lg cta--button"}
to={"/docs/getting-started/initial-config"}
to={"/docs/getting-started/quick-start/"}
>
Connect and Configure Device
</Link>
@ -51,7 +51,7 @@ After flashing the Meshtastic firmware to the device, you can proceed with the i
:::info
Before flashing confirm that you have [RAK4631](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK4631/) and not a [RAK4631-R](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK4631-R/) If this is not the case, fear not. The hardware is identical but requires changing the bootloader. Instructions on how to do this are located [here](/docs/getting-started/flashing-firmware/nrf52/convert-rak4631r).
Before flashing confirm that you have [RAK4631](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK4631/) and not a [RAK4631-R](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK4631-R/) If this is not the case, fear not. The hardware is identical but requires changing the bootloader. Instructions on how to do this are located [here](/docs/support-troubleshooting/flashing-firmware/nrf52/convert-rak4631r).
:::
@ -59,6 +59,6 @@ Before flashing confirm that you have [RAK4631](https://docs.rakwireless.com/Pro
Previous versions of the Meshtastic firmware may save stale data, causing devices to get stuck in a crash loop during startup. If you experience issues when upgrading your nRF52 device from a previous version of Meshtastic, you may need to perform a full factory reset of the internal flash memory.
Follow the guide to [factory erase your nRF52](/docs/getting-started/flashing-firmware/nrf52/nrf52-erase) device before continuing to [flash firmware](#flash-firmware).
Follow the guide to [factory erase your nRF52](/docs/support-troubleshooting/flashing-firmware/nrf52/nrf52-erase) device before continuing to [flash firmware](#flash-firmware).
:::

26
docs/support-troubleshooting/flashing-firmware/nrf52/index.mdx Normal file
View file

@ -0,0 +1,26 @@
---
id: flashing-nrf52-devices
title: Flash nRF52 & RP2040 Devices
sidebar_label: nRF52/RP2040 Device
sidebar_position: 2
description: Instructions to flash Meshtastic firmware to nRF52 or RP2040 chipset devices.
---
## Flashing Methods for nRF52 and RP2040 Devices
nRF52 and RP2040 based devices have the easiest firmware upgrade process. No driver or software install is required on any platform.
### Drag & Drop
nRF52 and RP2040 devices use the [Drag & Drop](/docs/support-troubleshooting/flashing-firmware/nrf52/drag-n-drop) installation method to install firmware releases.
### Over-The-Air (OTA)
nRF52 devices are able to accept [OTA firmware updates](/docs/support-troubleshooting/flashing-firmware/nrf52/ota) from a mobile device over bluetooth.
### nRF Factory Erase
You may wish to perform a [Factory Erase](/docs/support-troubleshooting/flashing-firmware/nrf52/nrf52-erase) prior to installing firmware to clear data that may change format and location between releases.
### Convert RAK4631-R to RAK4631
If your device did not come with the Arduino bootloader you will need to [perform the conversion](/docs/support-troubleshooting/flashing-firmware/nrf52/convert-rak4631r).
### Use Raspberry Pi as a SWDIO Flash Tool
If your device can't be flashed through USB or Bluetooth, another option might be a [direct SWDIO connection](/docs/support-troubleshooting/flashing-firmware/nrf52/swdio).

2
docs/getting-started/flashing-firmware/nrf52/nrf52-erase.mdx → docs/support-troubleshooting/flashing-firmware/nrf52/nrf52-erase.mdx
View file

@ -47,7 +47,7 @@ Once the device has been erased, you can proceed to install the latest Meshtasti
<div className="indexCtasBody">
<Link
className={"button button--outline button--lg cta--button"}
to={"/docs/getting-started/flashing-firmware/nrf52/"}
to={"/docs/support-troubleshooting/flashing-firmware/nrf52/"}
>
Flash nRF52/RP2040 Firmware
</Link>

0
docs/getting-started/flashing-firmware/nrf52/ota.mdx → docs/support-troubleshooting/flashing-firmware/nrf52/ota.mdx
View file

0
docs/getting-started/flashing-firmware/nrf52/swdio.mdx → docs/support-troubleshooting/flashing-firmware/nrf52/swdio.mdx
View file

4
docs/getting-started/flashing-firmware/nrf52/update-booloader.mdx → docs/support-troubleshooting/flashing-firmware/nrf52/update-booloader.mdx
View file

@ -28,7 +28,7 @@ Depending on your device, you need to select the correct bootloader package. Bel
2. Connect your device to your computer via USB.
3. Activate bootloader mode by quickly double pressing the RESET button on your device. For The Seeed Tracker 1000-E, you need to press-and-hold the user button and quickly connect the USB cable to the magsafe port twice. The device should appear as a removable drive on your computer.
4. Drag and drop the UF2 file you downloaded into the removable drive. The device will automatically update the bootloader and reset.
5. Once the device resets, the update is complete. Your device is now running the latest bootloader version and you can proceed with [flashing the firmware](/docs/getting-started/flashing-firmware/nrf52/drag-n-drop/).
5. Once the device resets, the update is complete. Your device is now running the latest bootloader version and you can proceed with [flashing the firmware](/docs/support-troubleshooting/flashing-firmware/nrf52/drag-n-drop/).
### Method 2: Using adafruit-nrfutil
@ -66,4 +66,4 @@ pip install adafruit-nrfutil
adafruit-nrfutil --singlebank --touch 1200 --verbose dfu serial --package <downloaded file>.zip -p /dev/ttyACM0 -b 115200
```
5. Once the process finishes, the update is complete. Your device is now running the latest bootloader version and you can proceed with [flashing the firmware](/docs/getting-started/flashing-firmware/nrf52/drag-n-drop/).
5. Once the process finishes, the update is complete. Your device is now running the latest bootloader version and you can proceed with [flashing the firmware](/docs/support-troubleshooting/flashing-firmware/nrf52/drag-n-drop/).

3
docs/getting-started/serial-drivers/_category_.yml → docs/support-troubleshooting/serial-drivers/_category_.yml
View file

@ -1,7 +1,6 @@
label: Install Serial Drivers
collapsible: true # make the category collapsible
position: 1
link:
type: generated-index
title: Installing Serial Drivers
slug: /getting-started/serial-drivers
slug: /support-troubleshooting/serial-drivers

4
docs/getting-started/serial-drivers/serial-drivers-esp32.mdx → docs/support-troubleshooting/serial-drivers/serial-drivers-esp32.mdx
View file

@ -59,7 +59,7 @@ values={[
After installing the driver, make sure to reboot your computer to finish the installation process.
You can also [test your serial driver installation](/docs/getting-started/serial-drivers/test-serial-driver-installation) at this step if required.
You can also [test your serial driver installation](/docs/support-troubleshooting/serial-drivers/test-serial-driver-installation) at this step if required.
:::
@ -70,7 +70,7 @@ After installing the serial drivers, you can now flash the Meshtastic firmware o
<div className="indexCtasBody">
<Link
className={"button button--outline button--lg cta--button"}
to={"/docs/getting-started/flashing-firmware/esp32/"}
to={"/docs/support-troubleshooting/flashing-firmware/esp32/"}
>
Flash ESP32 Firmware
</Link>

4
docs/getting-started/serial-drivers/serial-drivers-nrf52.mdx → docs/support-troubleshooting/serial-drivers/serial-drivers-nrf52.mdx
View file

@ -79,7 +79,7 @@ Uninstall the kernel extension:
After installing the driver, make sure to reboot your computer to finish the installation process.
You can also [test your serial driver installation](/docs/getting-started/serial-drivers/test-serial-driver-installation) at this step if required.
You can also [test your serial driver installation](/docs/support-troubleshooting/serial-drivers/test-serial-driver-installation) at this step if required.
:::
@ -90,7 +90,7 @@ After installing the serial drivers, you can now flash the Meshtastic firmware o
<div className="indexCtasBody">
<Link
className={"button button--outline button--lg cta--button"}
to={"/docs/getting-started/flashing-firmware/nrf52/"}
to={"/docs/support-troubleshooting/flashing-firmware/nrf52/"}
>
Flash nRF52/RP2040 Firmware
</Link>

6
docs/getting-started/serial-drivers/test-serial-driver-installation.mdx → docs/support-troubleshooting/serial-drivers/test-serial-driver-installation.mdx
View file

@ -77,7 +77,7 @@ values={[
If you are unable to see your device:
- Make sure that your cable is not only for charging but also for [data transfer](/docs/getting-started#verify-data-cable).
- It's possible that you need to [reinstall the USB serial driver](/docs/getting-started/serial-drivers).
- It's possible that you need to [reinstall the USB serial driver](/docs/support-troubleshooting/serial-drivers/).
:::
@ -90,7 +90,7 @@ After completing the previous steps, you can now flash the Meshtastic firmware o
<div className="split-item">
<Link
className={"button button--outline button--lg cta--button"}
to={"/docs/getting-started/flashing-firmware/esp32/"}
to={"/docs/support-troubleshooting/flashing-firmware/esp32/"}
>
Flash ESP32 Firmware
</Link>
@ -99,7 +99,7 @@ After completing the previous steps, you can now flash the Meshtastic firmware o
<div className="split-item">
<Link
className={"button button--outline button--lg cta--button"}
to={"/docs/getting-started/flashing-firmware/nrf52/"}
to={"/docs/support-troubleshooting/flashing-firmware/nrf52/"}
>
Flash nRF52/RP2040 Firmware
</Link>

8
docs/terms/index.mdx
View file

@ -28,13 +28,13 @@ Device
DFU
: Device Firmware Update, a state which a device is placed into for it to receive a firmware update
ESP32 | [Drivers](/docs/getting-started/serial-drivers/esp32/) | [Firmware](/docs/getting-started/flashing-firmware/esp32/)
ESP32 | [Drivers](/docs/support-troubleshooting/serial-drivers/esp32/) | [Firmware](/docs/support-troubleshooting/flashing-firmware/esp32/)
: A chipset of microcontroller made/designed by Espressif, used by a number of devices. Higher power usage than NRF52, but often cheaper and supports WiFi if desired.
Firmware | [Guide](https://meshtastic.org/docs/getting-started/flashing-firmware/)
Firmware | [Guide](https://meshtastic.org/docs/support-troubleshooting/flashing-firmware/)
: The low-level software programmed onto a Meshtastic device, controlling its hardware functions and enabling it to communicate within the mesh network using LoRa technology. Firmware
Flash/Flashing | [Guide](https://meshtastic.org/docs/getting-started/flashing-firmware/)
Flash/Flashing | [Guide](https://meshtastic.org/docs/support-troubleshooting/flashing-firmware/)
: The process of updating or installing firmware on a Meshtastic device. This is typically done using a computer to load new firmware versions or custom software to enhance or modify device functionality.
GPIO
@ -64,7 +64,7 @@ Module | [Software Modules](/docs/configuration/module/) | [Hardware Modules](/d
Node
: A unit within the Meshtastic network that can send, receive, and relay messages, helping to form and extend the mesh network's coverage.
NRF52 | [Drivers](/docs/getting-started/serial-drivers/nrf52/) | [Firmware](/docs/getting-started/flashing-firmware/nrf52/)
NRF52 | [Drivers](/docs/support-troubleshooting/serial-drivers/nrf52/) | [Firmware](/docs/support-troubleshooting/flashing-firmware/nrf52/)
: A microcontroller chipset made by Nordic, used by a number of devices used by several devices such as the RAK Meshtastic Starter Kit and the Lilygo T-Echo. Lower power usage than ESP32.
Packet