Merge pull request #945 from tekstrand/hardware-unification

Standardize hardware documentation
meshtastic · Jan 28, 2024 · a58aa6a · a58aa6a · vercel · Jan 28, 2024
2 parents 43282ff + 5585b52
commit a58aa6a
Show file tree

Hide file tree

Showing 13 changed files with 384 additions and 273 deletions.
diff --git a/docs/hardware/devices/heltec/index.mdx b/docs/hardware/devices/heltec/index.mdx
@@ -21,6 +21,8 @@ values={[
 ]}>
 <TabItem value="v2.1">
 
+## HELTEC v2.1
+
 :::warning
 Not recommended because of design issues! Support is being phased out. Use V3 in new projects.
 :::
@@ -38,19 +40,22 @@ Not recommended because of design issues! Support is being phased out. Use V3 in
   - Antenna:
     - U.FL/IPEX antenna connector for LoRa
 
-## Features
+### Features
 
 - Built in 0.96 inch OLED display
 - User and Reset Buttons
 - No GPS
 
-## Resources
+### Resources
 
 - Firmware file: `firmware-heltec-v2.1-X.X.X.xxxxxxx.bin`
 
 </TabItem>
+
 <TabItem value="v3">
 
+## HELTEC v3
+
 :::info
 This device may have issues charging a connected battery if utilizing a USB-C to USB-C cable. It's recommended to use a USB-A to USB-C cable.
 :::
@@ -70,7 +75,7 @@ This device may have issues charging a connected battery if utilizing a USB-C to
     - Dedicated 2.4 GHz metal spring antenna for WiFi/Bluetooth
     - U.FL/IPEX antenna connector for LoRa
 
-## Features
+### Features
 
 - Built in 0.96 inch OLED display
 - User and Reset Buttons
@@ -82,15 +87,19 @@ This device may have issues charging a connected battery if utilizing a USB-C to
 
 Image Source: [Heltec](<https://resource.heltec.cn/download/WiFi_LoRa32_V3/HTIT-WB32LA(F)_V3.png>)
 
-## Resources
+### Resources
 
 - Firmware file: `firmware-heltec-v3-X.X.X.xxxxxxx.bin`
-- Purchase link: [Heltec](https://heltec.org/project/wifi-lora-32-v3/)
-- Purchase link: [AliExpress](https://www.aliexpress.us/item/3256805256690400.html)
+- Purchase links
+  - [Heltec](https://heltec.org/project/wifi-lora-32-v3/)
+  - [AliExpress](https://www.aliexpress.us/item/3256805256690400.html)
 
 </TabItem>
+
 <TabItem value="Wireless Stick Lite V3">
 
+## HELTEC Wireless Stick Lite V3
+
 :::info
 This device may have issues charging a connected battery if utilizing a USB-C to USB-C cable. It's recommended to use a USB-A to USB-C cable.
 :::
@@ -110,7 +119,7 @@ This device may have issues charging a connected battery if utilizing a USB-C to
     - Dedicated 2.4 GHz stamped metal antenna for WiFi/Bluetooth
     - U.FL/IPEX antenna connector for LoRa (next to the V3 icon)
 
-## Features
+### Features
 
 - No display.
 - User and Reset Buttons
@@ -128,14 +137,17 @@ This device may have issues charging a connected battery if utilizing a USB-C to
 
 Image Source: [Heltec](https://resource.heltec.cn/download/Wireless_Stick_Lite_V3/HTIT-WSL_V3.png)
 
-## Resources
+### Resources
 
 - Firmware file: `firmware-heltec-wsl-v3-X.X.X.xxxxxxx.bin`
 - Purchase link: [Heltec](https://heltec.org/project/wireless-stick-lite-v2/)
 - Purchase link: [AliExpress](https://www.aliexpress.us/item/3256805256996507.html)
 
 </TabItem>
- <TabItem value="tracker">
+
+<TabItem value="tracker">
+
+## HELTEC Tracker
 
 :::info
 This device may have issues charging a connected battery if utilizing a USB-C to USB-C cable. It's recommended to use a USB-A to USB-C cable.
@@ -155,12 +167,12 @@ This device may have issues charging a connected battery if utilizing a USB-C to
     - Dedicated 2.4 GHz metal spring antenna for WiFi/Bluetooth
     - U.FL/IPEX antenna connector for LoRa and GNSS
 
-## Features
+### Features
 
 - Onboard 0.96-inch LCD display
 - User and Reset Buttons
 
-## Flashing the Wireless Tracker
+### Flashing
 
 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.
 
@@ -179,21 +191,24 @@ The following process will manually place the device into the Espressif Firmware
 
 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
+### Pin Map
 
 ![HT-Tracker_V1 Pin Map](/img/hardware/HT-Tracker_V1_Pin_Map.png)
 
 Image Source: [Heltec](https://heltec.org/project/wireless-tracker/)
 
-## Resources
+### Resources
 
 - Firmware file: `firmware-heltec-wireless-tracker-X.X.X.xxxxxxx.bin`
 - Purchase link: [Heltec](https://heltec.org/project/wireless-tracker/)
 - Purchase link: [AliExpress](https://www.aliexpress.us/item/3256805495189423.html)
 
 </TabItem>
+
 <TabItem value="paper">
 
+## HELTEC Paper
+
 :::caution
 
 Currently the display is only supported in devices labeled v1.1.
@@ -217,13 +232,13 @@ This device may have issues charging a connected battery if utilizing a USB-C to
     - U.FL/IPEX antenna connector for LoRa
     - Integrated 2.4 GHz PCB antenna
 
-## Features
+### Features
 
 - Onboard 2.13-inch black and white E-Ink display screen
 - User and Reset switches
 - No GPS
 
-## Resources
+### Resources
 
 - Firmware file: `firmware-heltec-wireless-paper-X.X.X.xxxxxxx.bin`
 - Purchase link: [Heltec](https://heltec.org/project/wireless-paper/)

diff --git a/docs/hardware/devices/lora/index.mdx b/docs/hardware/devices/lora/index.mdx
@@ -24,6 +24,7 @@ values={[
 ]}>
 <TabItem value="v1">
 
+## Lora v1
 :::warning
 Not recommended with a battery! These boards contain the wrong component in the LiPo battery charging circuit allowing the battery to be overcharged.
 :::
@@ -43,21 +44,25 @@ This board is still in production but for various reasons not recommended for ne
   - Micro USB
   - Antenna: U.FL antenna connector
 
-## Features
+### Features
 
 - Built in 0.96 inch OLED display
 
-## Resources
+### Resources
 
 - Firmware file: `firmware-tlora-v1-X.X.X.xxxxxxx.bin`
-- Purchase link: [AliExpress](https://www.aliexpress.com/item/32996759721.html)
-- US Distributor - Purchase link: [Rokland](https://store.rokland.com/products/lilygo-ttgo-lora32-v1-0-wireless-module-esp32-lora-915mhz-oled-0-96-inch-display-wifi-bluetooth-esp-32-antenna-ch9102-q184?ref=8Bb2mUO5i-jKwt)
+- Purchase Links
+  - [AliExpress](https://www.aliexpress.com/item/32996759721.html)
+  - US Distributor [Rokland](https://store.rokland.com/products/lilygo-ttgo-lora32-v1-0-wireless-module-esp32-lora-915mhz-oled-0-96-inch-display-wifi-bluetooth-esp-32-antenna-ch9102-q184?ref=8Bb2mUO5i-jKwt)
 
 ![LILYGO® TTGO Lora V1](/img/hardware/lora-v1.png)
 
 </TabItem>
+
 <TabItem value="v1.3">
 
+## Lora v1.3
+
 :::warning
 Not recommended with a battery! These boards contain the wrong component in the LiPo battery charging circuit allowing the battery to be overcharged.
 :::
@@ -77,21 +82,24 @@ This board is still in production but for various reasons not recommended for ne
   - Micro USB
   - Antenna: U.FL antenna connector
 
-## Features
+### Features
 
 - Built in 0.96 inch OLED display
 
-## Resources
+### Resources
 
 - Firmware file: `firmware-tlora_v1_3-X.X.X.xxxxxxx.bin`
-- Purchase link: [AliExpress](https://www.aliexpress.com/item/4000628100802.html)
+- Purchase links
+  - [AliExpress](https://www.aliexpress.com/item/4000628100802.html)
 
 ![LILYGO® TTGO Lora V1.3](/img/hardware/lora-v1.3.png)
 ![LILYGO® TTGO Lora V1.3 pin map](/img/hardware/lora-v1.3_pinmap.webp)
 
 </TabItem>
 <TabItem value="v2.0">
 
+## Lora V2.0
+
 :::warning
 Not recommended with a battery! These boards contain the wrong component in the LiPo battery charging circuit allowing the battery to be overcharged.
 :::
@@ -112,23 +120,26 @@ This board is still in production but for various reasons not recommended for ne
   - Micro USB
   - Antenna: U.FL antenna connector
 
-## Features
+### Features
 
 - Built in 0.96 inch OLED display
 - Power and Reset switches
 - microSD connector
 - No GPS
 
-## Resources
+### Resources
 
 - Firmware file: `firmware-tlora-v2-X.X.X.xxxxxxx.bin`
-- Purchase link: [AliExpress](https://www.aliexpress.com/item/32846302183.html)
+- Purchase links
+  - [AliExpress](https://www.aliexpress.com/item/32846302183.html)
 
 ![LILYGO® TTGO Lora V2](/img/hardware/lora-v2.0.png)
 
 </TabItem>
 <TabItem value="v2.1">
 
+## Lora v2.1-1.6
+
 :::caution
 Early versions of some of these boards contained the wrong component in the LiPo battery charging circuit allowing the battery to be overcharged. Boards purchased after 2021 should be ok.
 :::
@@ -145,31 +156,34 @@ Early versions of some of these boards contained the wrong component in the LiPo
   - Micro USB
   - Antenna: SMA antenna connector
 
-## Variations of identifying marks
+### Variations of identifying marks
 
 - FCC ID: 2ASYE-T3-V1-6-1
 - "T3_v1.6.1 20210104" on the board
 - "Model T3 V1.6.1" on the FCC sticker
 
-## Features
+### Features
 
 - Built in 0.96 inch OLED display
 - Power and Reset switches
 - microSD connector
 - No GPS
 
-## Resources
+### Resources
 
 - Firmware file: `firmware-tlora-v2-1-1.6-X.X.X.xxxxxxx.bin`
-- Purchase link: [AliExpress](https://www.aliexpress.com/item/32915894264.html)
-- US Distributor - Purchase link: [Rokland](https://store.rokland.com/products/lilygo-ttgo-lora32-v2-1_1-6-version-915mhz-esp32-lora-oled-0-96-inch-sd-card-bluetooth-wifi-wireless-module-esp-32-sma-q211?ref=8Bb2mUO5i-jKwt)
+- Purchase Links
+  - [AliExpress](https://www.aliexpress.com/item/32915894264.html)
+  - US Distributor [Rokland](https://store.rokland.com/products/lilygo-ttgo-lora32-v2-1_1-6-version-915mhz-esp32-lora-oled-0-96-inch-sd-card-bluetooth-wifi-wireless-module-esp-32-sma-q211?ref=8Bb2mUO5i-jKwt)
 
 ![TTGO Lora V2.1-1.6](/img/hardware/lora-v2.1-1.6.png)
 
 </TabItem>
 
 <TabItem value="v2.1-1.8">
 
+## Lora v2.1-1.8
+
 - **MCU**
   - ESP32 (WiFi & Bluetooth)
 - **LoRa Transceiver**
@@ -180,14 +194,14 @@ Early versions of some of these boards contained the wrong component in the LiPo
   - USB-C
   - Antenna: SMA antenna connector
 
-## Features
+### Features
 
 - Built in 0.96 inch OLED display
 - Power and Reset switches
 - microSD connector
 - No GPS
 
-## Resources
+### Resources
 
 - Firmware file: `firmware-tlora-v2-1-1.8-X.X.X.xxxxxxx.bin`
 
@@ -197,6 +211,8 @@ Early versions of some of these boards contained the wrong component in the LiPo
 
 <TabItem value="S3-v1">
 
+## Lora T3S3 v1.0
+
 - **MCU**
   - ESP32-S3 (WiFi & Bluetooth)
 - **LoRa Transceiver**
@@ -211,14 +227,14 @@ Early versions of some of these boards contained the wrong component in the LiPo
   - USB-C
   - Antenna: SMA antenna connector
 
-## Features
+### Features
 
 - Built in 0.96 inch OLED display
 - Power and Reset switches, Boot / User Button
 - microSD connector
 - No GPS
 
-## Flashing the T3S3
+### Flashing the T3S3
 
 :::warning
 
@@ -242,10 +258,11 @@ If after successfully flashing the device and the screen remains black, you may
 
 :::
 
-## Resources
+### Resources
 
 - Firmware file: `firmware-tlora-t3s3-v1.xxxxxxx.bin`
-- Purchase link: [AliExpress](https://www.aliexpress.com/item/1005004627139838.html)
+- Purchase links
+  - [AliExpress](https://www.aliexpress.com/item/1005004627139838.html)
 
 ![TTGO Lora T3S3 V1](/img/hardware/lora-t3s3.jpg)