Merge branch 'master' into hardware-selection

This commit is contained in:
pdxlocations 2023-12-13 08:53:24 -08:00
commit 04a3325754
17 changed files with 432 additions and 479 deletions

View file

@ -1,6 +1,6 @@
---
id: drag-n-drop
title: Drag & Drop nRF52 Firmware Updates
title: Drag & Drop nRF52 & RP2040 Firmware Updates
sidebar_label: Drag & Drop (recommended)
sidebar_position: 1
---
@ -11,15 +11,23 @@ import Link from "@docusaurus/Link";
## Flash Firmware
Download and unzip the latest firmware from [Meshtastic Downloads](https://meshtastic.org/downloads).
### nRF52
1. Connect your device to your computer with a USB data cable.
2. Double click the reset button on your device (this will put it into bootloader mode)
3. Notice a new drive will be mounted on your computer (Windows, Mac, or Linux)
4. Open this drive and you should see three files: `CURRENT.UF2`, `INDEX.HTM`, and `INFO_UF2.TXT`
5. Drop the appropriate firmware file (`firmware-DEVICE_NAME-x.x.x-xxxxxxx.uf2`) from the release onto this drive.
1. Download and unzip the latest firmware from [Meshtastic Downloads](https://meshtastic.org/downloads).
2. Connect your device to your computer with a USB data cable.
3. Double click the reset button on your device (this will put it into bootloader mode).
4. Notice a new drive will be mounted on your computer (Windows, Mac, or Linux).
5. Open this drive and you should see three files: `CURRENT.UF2`, `INDEX.HTM`, and `INFO_UF2.TXT`.
6. Copy the appropriate firmware file (`firmware-DEVICE_NAME-X.X.X-xxxxxxx.uf2`) from the release onto this drive.
7. Once the file has finished copying onto the drive, the device will reboot and install the Meshtastic firmware.
Once the file has finished copying onto the drive, the device will reboot and install the Meshtastic firmware.
### RP2040
1. Download and unzip the latest firmware from [Meshtastic Downloads](https://meshtastic.org/downloads).
2. Press the BOOTSEL button and while keeping it pressed, connect the device to your computer via a USB cable.
3. Notice a new drive will be mounted on your computer (Windows, Mac, or Linux).
4. Open this drive and you should see two files: `INDEX.HTM` and `INFO_UF2.TXT`.
5. Copy the appropriate firmware file (`firmware-DEVICE_NAME-X.X.X-xxxxxxx.uf2`) from the release onto this drive.
6. Once the file has finished copying onto the drive, the device will reboot and install the Meshtastic firmware.
## Connect and Configure Device

View file

@ -1,21 +1,21 @@
---
id: flashing-nrf52-devices
title: Flash nRF52 Devices
sidebar_label: nRF52 Device
title: Flash nRF52 & RP2040 Devices
sidebar_label: nRF52/RP2040 Device
sidebar_position: 2
---
## Flashing Methods for nRF52 Devices
## Flashing Methods for nRF52 and RP2040 Devices
The nRF52 based devices have the easiest firmware upgrade process. No driver or software install is required on any platform.
nRF52 and RP2040 based devices have the easiest firmware upgrade process. No driver or software install is required on any platform.
### Drag & Drop
nRF52 devices use the [Drag & Drop](/docs/getting-started/flashing-firmware/nrf52/drag-n-drop) installation method to install firmware releases.
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.
### Factory Erase
### 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

View file

@ -1,25 +1,39 @@
---
id: nrf52-erase
title: Flash nRF52 Factory Erase
sidebar_label: Factory Erase nRF52
title: Flash nRF52/RP2040 Factory Erase
sidebar_label: Factory Erase
sidebar_position: 3
---
import Link from "@docusaurus/Link";
Meshtastic uses the [littlefs](https://github.com/littlefs-project/littlefs) library to store configuration, logs, and other data in the internal flash of nRF52 devices. Updating the firmware does _not_ erase this additional data, which can cause issues when the format and location of data changes between releases.
Meshtastic uses the [littlefs](https://github.com/littlefs-project/littlefs) library to store configuration, logs, and other data in the internal flash of nRF52 & RP2040 devices. Updating the firmware does _not_ erase this additional data, which can cause issues when the format and location of data changes between releases.
### nRF52
To reset the flash storage on your nRF52 board:
Download and unzip the latest firmware from [Meshtastic Downloads](https://meshtastic.org/downloads).
1. Download and unzip the latest firmware from [Meshtastic Downloads](https://meshtastic.org/downloads).
2. Connect your device to your computer with a USB data cable.
3. Double click the reset button on your device (this will put it into bootloader mode)
4. Notice a new drive will be mounted on your computer (Windows, Mac, or Linux)
5. Open this drive and you should see three files: `CURRENT.UF2`, `INDEX.HTM`, and `INFO_UF2.TXT`
6. Find the file included in the downloaded firmware named `Meshtastic_nRF52_factory_erase.uf2` and copy it onto the new drive. The device should reboot.
7. With the [Meshtastic CLI](/docs/software/python/cli/) installed, open your Terminal/Console and enter the command: `meshtastic --noproto`.
8. Press any key, you should see the message: `Formatting... Done`.
Once the device has been erased, you can proceed to install the latest Meshtastic firmware on a clean storage filesystem by clicking the link below.
### RP2040
To reset the flash storage on your RP2040 board:
1. Download [flash_nuke.uf2](https://datasheets.raspberrypi.com/soft/flash_nuke.uf2) to your computer.
2. Press the BOOTSEL button and while keeping it pressed, connect it to your computer via a USB cable.
3. The board should now appear as a mass storage device on your computer with the label RPI-RP2.
4. Copy the flash_nuke.uf2 file to the device.
5. The board will now restart and the flash memory will be erased.
1. Connect your device to your computer with a USB data cable.
2. Double click the reset button on your device (this will put it into bootloader mode)
3. Notice a new drive will be mounted on your computer (Windows, Mac, or Linux)
4. Open this drive and you should see three files: `CURRENT.UF2`, `INDEX.HTM`, and `INFO_UF2.TXT`
5. Copy the included file named `Meshtastic_nRF52_factory_erase.uf2` onto the virtual disk device. The device should reboot.
6. Connect to the device via serial console using the [Meshtastic CLI `--noproto`](/docs/software/python/cli/#--noproto) mode or a standalone serial client like `minicom`.
7. Press any key, you should see the message: `Formatting... Done`.
Once the device has been erased, you can proceed to install the latest Meshtastic firmware on a clean storage filesystem by clicking the link below.
@ -28,6 +42,6 @@ Once the device has been erased, you can proceed to install the latest Meshtasti
className={"button button--outline button--lg cta--button"}
to={"/docs/getting-started/flashing-firmware/nrf52/"}
>
Flash nRF52 Firmware
Flash nRF52/RP2040 Firmware
</Link>
</div>

View file

@ -2,7 +2,7 @@
id: heltec
title: HELTEC® LoRa 32
sidebar_label: HELTEC® LoRa 32
sidebar_position: 5
sidebar_position: 7
---
import Tabs from "@theme/Tabs";
@ -77,9 +77,9 @@ This device may have issues charging a connected battery if utilizing a USB-C to
### Pin Map
![HTIT-WSL_V3_PIN_MAP](/img/hardware/HTIT-WB32LA(F)_V3.png)
![HTIT-WSL_V3_PIN_MAP](</img/hardware/HTIT-WB32LA(F)_V3.png>)
Image Source: [Heltec](https://resource.heltec.cn/download/WiFi_LoRa32_V3/HTIT-WB32LA(F)_V3.png)
Image Source: [Heltec](<https://resource.heltec.cn/download/WiFi_LoRa32_V3/HTIT-WB32LA(F)_V3.png>)
## Resources
@ -117,6 +117,7 @@ This device may have issues charging a connected battery if utilizing a USB-C to
- No GPS
### Meshtastic I2C Definitions
- SCL: GPIO47
- SDA: GPIO48
@ -158,6 +159,25 @@ This device may have issues charging a connected battery if utilizing a USB-C to
- Onboard 0.96-inch LCD display
- User and Reset Buttons
## Flashing the Wireless Tracker
If you are having issues flashing the wireless tracker, especially if it's your first attempt, you may need to manually place the device into Espressif's Firmware Download mode. Please follow the process below to do so.
:::warning
Do not proceed unless an antenna is connected to avoid possible damage to the device's radio.
:::
The following process will manually place the device into the Espressif Firmware Download mode:
1. Unplug the device.
2. Press and hold the USER button.
3. Plug device in.
4. After 2-3 seconds, release the USER button.
With the device now in the Espressif Firmware Download mode, you can proceed with flashing using one of the supported flashing methods. It's generally recommended to use the [Web Flasher](https://flasher.meshtastic.org/). You can select "Heltec Wireless Tracker" from the device drop-down.
## Pin Map
![HT-Tracker_V1 Pin Map](/img/hardware/HT-Tracker_V1_Pin_Map.png)

View file

@ -2,28 +2,26 @@
id: raspberry-pi
title: Raspberry Pi Pico
sidebar_label: Raspberry Pi Pico
sidebar_position: 8
sidebar_position: 10
---
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
The Raspberry Pi Pico series is a range of tiny, fast, and versatile boards built using RP2040, the flagship microcontroller chip designed by Raspberry Pi in the UK.
:::info
Only the Pico W has WiFi/BLE capabilities. However, Meshtastic does not currently support the Pico W's WiFi/BLE
Only the Pico W has WiFi/BLE capabilities. Meshtastic supports WiFi on the Pico W, but does not currently support BLE
:::
### Pico
- **MCU:**
- **MCU:**
- Raspberry Pi RP2040
- Dual M0+ Core
- 133MHz CPU Clock
- **Connectors (On Pico):**
- **Connectors (On Pico):**
- Micro-USB on Pico
:::note
@ -32,19 +30,18 @@ Please be aware that the Raspberry Pi Pico must be used in combination with a [W
:::
- **LoRa Transceiver (On LoRa Module):**
- **LoRa Transceiver (On LoRa Module):**
- SX1262
- **Frequency Options:**
- **Frequency Options:**
- 410 - 525 MHz
- 863 - 870 MHz
- 902 - 930 MHz
- **Connectors (On LoRa Module):**
- **Connectors (On LoRa Module):**
- U.FL/IPEX antenna connector for LoRa
- 1.25mm 2-Pin JST for battery
### Pico Resources
- Firmware file:`firmware-pico-X.X.X.xxxxxxx.uf2`
- for Pico W use: `firmware-picow-X.X.X.xxxxxxx.uf2`
- [Offical Website for the Raspberry Pi Pico](https://www.raspberrypi.com/products/raspberry-pi-pico/), including official reseller links.

View file

@ -2,7 +2,7 @@
id: station-g1
title: Station G1 device
sidebar_label: Station G1
sidebar_position: 6
sidebar_position: 9
---
The Station G1 is the second dedicated hardware device to be designed from scratch purely for Meshtastic Licensed (HAM) Operation by Neil Hao. It has been designed to be small and compact with the inclusion of 35dBm high power PA.
@ -39,9 +39,6 @@ The Station G1 is the second dedicated hardware device to be designed from scrat
- [Official Store](https://shop.uniteng.com/product/meshtastic-mesh-device-station-edition/)
- [Official Tindie Store](https://www.tindie.com/products/neilhao/meshtastic-mesh-device-station-edition/)
Further information on the Station G1 can be found on [Unit Engineering's Wiki](https://uniteng.com/wiki/doku.php?id=meshtastic:station).
![Station G1](/img/hardware/station-g1.jpg)

View file

@ -160,8 +160,8 @@ This is an earlier version of the T-Beam board. Due to changes in the design thi
</TabItem>
<TabItem value = "s3core">
- **MCU**
- ESP32-S3 (WiFi & Bluetooth 5LE)
- **MCU**
- ESP32-S3 (WiFi & Bluetooth 5LE)
- **LoRa Transceiver**
- **Semtech SX1262** (improved performance)
- **Frequency options**
@ -183,16 +183,16 @@ This is an earlier version of the T-Beam board. Due to changes in the design thi
## Resources
- Firmware file: `firmware-tbeam-s3-core-X.X.X.xxxxxxx.bin`
- Purchase Link: [AliExpress](https://www.aliexpress.com/item/1005005418286231.html)
- Firmware file: `firmware-tbeam-s3-core-X.X.X.xxxxxxx.bin`
- Purchase Link: [AliExpress](https://www.aliexpress.com/item/1005005418286231.html)
![T-Beam S3-Core](/img/hardware/T-BEAM-S3Core.jpg)
</TabItem>
<TabItem value = "supreme">
- **MCU**
- ESP32-S3 (WiFi & Bluetooth 5LE)
- **MCU**
- ESP32-S3 (WiFi & Bluetooth 5LE)
- **LoRa Transceiver**
- **Semtech SX1262** (improved performance)
- **Frequency options**
@ -218,13 +218,33 @@ This is an earlier version of the T-Beam board. Due to changes in the design thi
- PCF8563 RTC
- Micro-SD reader (not implemented in Meshtastic)
## Flashing the T-Beam Supreme
If you are having issues flashing the T-Beam Supreme, especially if it's your first attempt, you may need to manually place the device into Espressif's Firmware Download mode. Please follow the process below to do so.
:::warning
Do not proceed unless an antenna is connected to avoid possible damage to the device's radio.
:::
The following process will manually place the device into the Espressif Firmware Download mode:
1. Unplug the device.
2. Press and hold the BOOT button.
3. Plug device in.
4. After 2-3 seconds, release the BOOT button.
With the device now in the Espressif Firmware Download mode, you can proceed with flashing using one of the supported flashing methods. It's generally recommended to use the [Web Flasher](https://flasher.meshtastic.org/). You can select "Tbeam S3 Core from the device drop-down.
## Resources
- Firmware file: `firmware-tbeam-s3-core-X.X.X.xxxxxxx.bin`
- Purchase Link: [AliExpress](https://www.aliexpress.com/item/1005005418286231.html)
- Firmware file: `firmware-tbeam-s3-core-X.X.X.xxxxxxx.bin`
- Purchase links:
- LilyGO Store: [Meshtastic T-Beam 433/868/915/923Mhz](https://www.lilygo.cc/products/t-beam-v1-1-esp32-lora-module)
- AliExpress: [Meshtastic T-Beam 868/915MHz](https://www.aliexpress.com/item/1005005418286231.html)
- US Distributor - Purchase link: Rokland [NEO-M10S](https://store.rokland.com/products/lilygo-t-beam-supreme-esp32-s3-lora-development-board-sx1262-915mhz-gps-l76k-or-u-blox?variant=41051191378003), [Quectel L76K](https://store.rokland.com/products/lilygo-t-beam-supreme-esp32-s3-lora-development-board-sx1262-915mhz-gps-l76k-or-u-blox?variant=41051191345235)
![T-Beam Supreme](/img/hardware/T-BEAM-S3-Supreme.jpg)
</TabItem>

View file

@ -0,0 +1,60 @@
---
id: tdeck
title: LILYGO® T-Deck
sidebar_label: LILYGO® T-Deck
sidebar_position: 5
---
The T-Deck is a compact device featuring a 2.8-inch IPS LCD touch screen with a resolution of 320x240 pixels, integrated with a small keyboard, trackball, microphone and speaker running on an ESP32-S3 dual-core processor.
### Specifications
- **MCU**
- ESP32-S3FN16R8 (WiFi & Bluetooth 5 LE)
- **LoRa Transceiver**
- Semtech SX1262
- **Frequency options**
- 915 MHz
- 868 MHz
- 433 MHz
- **Antenna**
- U.FL/IPEX antenna connector for LoRa
- **Connectors**
- USB-C
### Features
- LILYGO® backlit T-Keyboard
- Trackball
- 2.8 inch ST7789 SPI Interface IPS LCD (Resolution: 320 x 240)
- I2S Speaker/Microphone
## Flashing the T-Deck
If you are having issues flashing the T-Deck, especially if it's your first attempt, you may need to manually place the device into Espressif's Firmware Download mode. Please follow the process below to do so.
:::warning
Do not proceed unless an antenna is connected to avoid possible damage to the device's radio.
:::
The following process will manually place the device into the Espressif Firmware Download mode:
1. Ensure the device's power switch is toggled OFF.
2. Press and hold the TRACKBALL.
3. Toggle device's power switch ON.
4. After 2-3 seconds, release the TRACKBALL button.
5. If the device screen is black and the backlight is off, the device is in the Firmware Download mode. If the backlight is on, repeat these steps.
With the device now in the Espressif Firmware Download mode, you can proceed with flashing using one of the supported flashing methods. It's generally recommended to use the [Web Flasher](https://flasher.meshtastic.org/). You can select "T Deck" from the device drop-down.
### Resources
- Firmware file: `firmware-t-deck-X.X.X.xxxxxxx.bin`
- Purchase links:
- LilyGO Store: [T-Deck 433/868/915Mhz](https://www.lilygo.cc/products/t-deck)
- AliExpress: [T-Deck 433/868/915MHz](https://www.aliexpress.us/item/3256805505920840.html)
- US Distributor - Purchase link: Rokland [915MHz](https://store.rokland.com/products/lilygo-t-deck-portable-microcontroller-programmer-lora-915-mhz-h642)
![T-Deck](/img/hardware/LILYGO-T-DECK.jpg)

View file

@ -35,7 +35,8 @@ Further information on the LILYGO® T-Echo devices can be found on LILYGO®'s [G
- Firmware file: `firmware-t-echo-2.x.x.uf2`
- Purchase links:
- AliExpress: [Lilygo Official Store](https://www.aliexpress.com/item/1005003026107533.html)
- LilyGO Store: [T-Echo Meshtastic 433/868/915MHz](https://www.lilygo.cc/products/t-echo)
- AliExpress: [T-Echo Meshtastic 433/868/915MHz with optional BME280 sensor](https://www.aliexpress.com/item/1005003026107533.html)
- US Distributor - Rokland: [915MHz](https://store.rokland.com/products/lilygo-ttgo-meshtastic-t-echo-white-lora-sx1262-wireless-module-915mhz-nrf52840-gps-for-arduino?ref=8Bb2mUO5i-jKwt) [915MHz BME280 Kit](https://store.rokland.com/products/lilygo-ttgo-meshtastic-t-echo-white-bme280-lora-sx1262-wireless-module-915mhz-nrf52840-gps-rtc-nfc-for-arduino?ref=8Bb2mUO5i-jKwt)
![LILYGO T-Echo](/img/hardware/t-echo.png)

View file

@ -0,0 +1,65 @@
---
id: twatch
title: LILYGO® T-Watch
sidebar_label: LILYGO® T-Watch
sidebar_position: 6
---
The T-Watch S3 is a compact wearable device featuring a 1.54-inch IPS LCD touch screen with a resolution of 240x240 pixels. It includes haptic feedback, an integrated microphone, speaker, real-time clock, and a three-axis accelerometer.
### Specifications
- **MCU**
- ESP32-S3 (WiFi & Bluetooth 5 LE)
- **LoRa Transceiver**
- Semtech SX1262
- **Frequency options**
- 915 MHz
- 868 MHz
- 433 MHz
- **Antenna**
- U.FL/IPEX antenna connector for LoRa
- **Connectors**
- Micro-USB
### Features
- 1.54 inch ST7789V TFT LCD (Resolution: 240 x 240)
- DRV2605 Haptic Driver
- I2S Speaker/Microphone & MAX98357 I2S Amp
- AXP2101 PMU and 400mAh battery.
- BMA423 Three Axis accelerometer
- Real-Time Clock
## Flashing the T-Watch S3
If you are having issues flashing the T-Watch S3, especially if it's your first attempt, you may need to manually place the device into Espressif's Firmware Download mode. Please follow the process below to do so.
:::warning
Do not proceed unless an antenna is connected to avoid possible damage to the device's radio.
:::
The following process will manually place the device into the Espressif Firmware Download mode:
1. Ensure the device is powered off by pressing and holding the crown button.
2. Remove the device's back cover.
3. Locate and press and hold the boot button.
![T Watch S3 Boot Button](/img/hardware/T-Watch-S3-BUTTON.jpg)
4. While holding the boot button, press the crown button once to turn the device on.
5. After 2-3 seconds, release the BOOT button.
With the device now in the Espressif Firmware Download mode, you can proceed with flashing using one of the supported flashing methods. It's generally recommended to use the [Web Flasher](https://flasher.meshtastic.org/). You can select "T Watch S3" from the device drop-down.
### Resources
- Firmware file: `firmware-t-watch-X.X.X.xxxxxxx.bin`
- Purchase links:
- LilyGO Store: [T-Watch 433/868/915Mhz](https://www.lilygo.cc/products/t-watch-s3)
- AliExpress: [T-Watch 433/868/915MHz](https://www.aliexpress.us/item/3256805456685117.html)
- US Distributor - Purchase link: Rokland [915MHz](https://store.rokland.com/products/lilygo-t-watch-s3-open-source-smartwatch-with-lora-and-esp32)
![T-Watch](/img/hardware/LILYGO-T-Watch-S3.jpg)

View file

@ -26,7 +26,7 @@ The minimum Android version is 5.0 (Lollipop 2014, first BLE support), however A
1. Download and Install the F-Droid app from [f-droid.org](https://f-droid.org/)
2. Open the F-Droid app and navigate to `Settings > Repositories`.
3. Click on the `+` icon to add a new repo.
4. Enter the Meshtastic repo address as follows: `https://apt.izzysoft.de/fdroid/repo/` (no fingerprint required)
4. Enter the Meshtastic repo address as follows: `https://apt.izzysoft.de/fdroid/repo/` as repository address and `3BF0D6ABFEAE2F401707B6D966BE743BF0EEE49C2561B9BA39073711F628937A` as fingerprint
5. Navigate to the `Categories` page and refresh (scroll down).
6. Search for and install the `Meshtastic` App.

View file

@ -13,11 +13,11 @@
},
"dependencies": {
"@algolia/client-search": "^4.20.0",
"@docusaurus/core": "3.0.0",
"@docusaurus/plugin-content-docs": "3.0.0",
"@docusaurus/preset-classic": "3.0.0",
"@docusaurus/theme-common": "3.0.0",
"@docusaurus/theme-mermaid": "3.0.0",
"@docusaurus/core": "3.0.1",
"@docusaurus/plugin-content-docs": "3.0.1",
"@docusaurus/preset-classic": "3.0.1",
"@docusaurus/theme-common": "3.0.1",
"@docusaurus/theme-mermaid": "3.0.1",
"@heroicons/react": "^2.0.18",
"@mdx-js/react": "^3.0.0",
"@meshtastic/meshtasticjs": "2.2.13-1",
@ -33,7 +33,7 @@
"tailwindcss": "^3.3.5"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "3.0.0",
"@docusaurus/module-type-aliases": "3.0.1",
"@tailwindcss/typography": "^0.5.10",
"@tsconfig/docusaurus": "^2.0.2",
"@types/node": "^20.9.3",

File diff suppressed because it is too large Load diff

View file

@ -60,11 +60,11 @@ const Firmware = (): JSX.Element => {
</div>
<div className="card m-4 border-2 border-secondary w-full">
<div className="card__header">
<h3>nRF52 Drag & Drop</h3>
<h3>nRF52/RP2040 Drag & Drop</h3>
</div>
<div className="card__body">
<p>
Devices such as T-Echo and RAK4631 are flashed via filesystem.
Devices such as T-Echo, RAK4631, and RAK11300 are flashed via filesystem.
</p>
</div>
<div className="card__footer mt-auto">

Binary file not shown.

After

Width:  |  Height:  |  Size: 89 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB