Merge pull request #945 from tekstrand/hardware-unification

Standardize hardware documentation
This commit is contained in:
pdxlocations 2024-01-28 11:24:54 -08:00 committed by GitHub
commit a58aa6afbe
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
13 changed files with 384 additions and 273 deletions

View file

@ -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/)

View file

@ -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,14 +82,15 @@ 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)
@ -92,6 +98,8 @@ This board is still in production but for various reasons not recommended for ne
</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,24 +156,25 @@ 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)
@ -170,6 +182,8 @@ Early versions of some of these boards contained the wrong component in the LiPo
<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)

View file

@ -24,9 +24,11 @@ values={[
<TabItem value="g2">
## Nano G2 Ultra
The Nano G2 Ultra and Nano G1 Explorer have exactly the same Lora front-end circuit design and internal wideband Lora antenna. The primary design goal of the Nano G2 Ultra is to reduce power consumption and improve battery life by using the low power MCU NRF52840. The typical battery life is optimized to be about 3.5 days. As with the Nano G1 Explorer, the Nano G2 Ultra's design also takes into account the potential impact of the human body on its antenna performance, ensuring optimal RF performance even when carried in a pocket.
### Nano G2 Ultra Specifications
### Specifications
- **MCU:**
- NRF52840
@ -42,7 +44,7 @@ The Nano G2 Ultra and Nano G1 Explorer have exactly the same Lora front-end circ
- **Connectors:**
- USB-C
### Nano G2 Ultra Features
### Features
- Meshtastic pre-installed.
- New internal GPS antenna that significantly reduces GPS lock time compared to the Nano G1. Additionally, the GPS module can be set to a low-power mode with the GPS physical switch.
@ -54,7 +56,7 @@ The Nano G2 Ultra and Nano G1 Explorer have exactly the same Lora front-end circ
- NXP PCF8563 Real Time Clock (RTC)
- Optional I2C Extension Board (1x GROVE I2C Socket and 1x SparkFun QWIIC I2C Socket for Sensors and Keyboard)
### Nano G2 Ultra Resources
### Resources
- Firmware file: `firmware-nano-g2-ultra-X.X.X.xxxxxxx.uf2`
- Official Purchase Links:
@ -66,11 +68,14 @@ Further information on the Nano G2 Ultra can be found on [Unit Engineering's Wik
![Nano G2 Ultra](/img/hardware/nano_g2_ultra.jpeg)
</TabItem>
<TabItem value="g1-e">
<TabItem value="g1-e">
## Nano G1 Explorer
The Nano G1 Explorer, powered by Meshtastic, is a significant upgrade from the Nano G1. It incorporates the latest RF technologies from B&Q Consulting, featuring a new internal wide-band LoRa antenna that can support frequencies ranging from 815 MHz to 940 MHz. With this new antenna, combined with an optimized wide-band LoRa RF frontend circuit, the Nano G1 Explorer is capable of working with the majority of LoRa frequency bands worldwide without the need for antenna changes. The device's design also takes into account the potential impact of the human body on its antenna performance, ensuring optimal RF performance even when carried in a pocket.
### Nano G1 Explorer Specifications
### Specifications
- **MCU:**
- ESP32 WROOM (WiFi & Bluetooth)
@ -86,7 +91,7 @@ The Nano G1 Explorer, powered by Meshtastic, is a significant upgrade from the N
- **Connectors:**
- USB-C
### Nano G1 Explorer Features
### Features
- Meshtastic pre-installed.
- New internal GPS antenna that significantly reduces GPS lock time compared to the Nano G1. Additionally, the GPS module can be set to a low-power mode with the GPS physical switch.
@ -96,7 +101,7 @@ The Nano G1 Explorer, powered by Meshtastic, is a significant upgrade from the N
- Internal Li-Polymer Battery Charger. _(An optional 3.7V 603450 JST 1.25mm Rechargeable Li-Polymer Battery can also be installed.)_
- Buck-boost converter to provide stable 3.3V to the system even in the event the Li-Polymer battery voltage drops to as low as 2.5V. Supply voltage stability is very important to ensure that the performance of RF circuits meets design expectations.
### Nano G1 Explorer Resources
### Resources
- Firmware file: `firmware-nano-g1-explorer-X.X.X.xxxxxxx.bin`
- Official Purchase Links:
@ -108,11 +113,14 @@ Further information on the Nano G1 can be found on [Unit Engineering's Wiki](htt
![Nano G1 Explorer](/img/hardware/nano_g1_explorer.jpeg)
</TabItem>
<TabItem value="g1">
## Nano G1
The Nano G1 is the first dedicated hardware device to be designed from scratch purely for Meshtastic by Neil Hao. It has been designed to be small and compact with the inclusion of a high quality internal PCB antenna.
### Nano G1 Specifications
### Specifications
- **MCU**
- ESP32 WROOM (WiFi & Bluetooth)
@ -129,14 +137,14 @@ The Nano G1 is the first dedicated hardware device to be designed from scratch p
- **Connectors**
- USB-C
### Nano G1 Features
### Features
- Meshtastic pre-installed
- User button
- 1.3 inch OLED screen
- Buzzer
### Nano G1 Resources
### Resources
- Firmware file: `firmware-nano-g1-X.X.X.xxxxxxx.bin`

View file

@ -8,7 +8,7 @@ sidebar_position: 1
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
## WisBlock Base
Operation requires both a base board and a [core module](/docs/hardware/devices/rak/core-module).
<Tabs
groupId="rakbase board"
@ -22,7 +22,7 @@ values={[
]}>
<TabItem value="RAK5005-O">
### RAK5005-O
## RAK5005-O
:::caution
The RAK5005-O is no longer in production. It is recommended to use the RAK19007 instead.
@ -60,7 +60,7 @@ Further information on the RAK5005-O can be found on the [RAK Documentation Cent
<TabItem value="RAK19007">
### RAK19007
## RAK19007
- [RAK19007](https://store.rakwireless.com/products/rak19007-wisblock-base-board-2nd-gen) - WisBlock Base Board (2nd Generation, an upgrade to the RAK5005-O)
- **Slots**
@ -80,13 +80,19 @@ Further information on the RAK5005-O can be found on the [RAK Documentation Cent
Further information on the RAK19007 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK19007/Overview/#product-description).
US Distributor - Purchase link: [Rokland](https://store.rokland.com/products/rak-wireless-wisblock-base-board-2nd-gen-rak19007-ver-b-pid-110082)
### Resources
- Purchase links
- US
- [Rokland](https://store.rokland.com/products/rak-wireless-wisblock-base-board-2nd-gen-rak19007-ver-b-pid-110082)
- International
- [RAK Wireless](https://store.rakwireless.com/products/wisblock-base?variant=42441632284870)
- [RAK Wireless Starter Kit](https://store.rakwireless.com/products/wisblock-meshtastic-starter-kit)
</TabItem>
<TabItem value="RAK19003">
### RAK19003
## RAK19003
- [RAK19003](https://store.rakwireless.com/products/wisblock-base-board-rak19003) - WisBlock's Mini Base Board.
- **Slots**
@ -100,13 +106,18 @@ US Distributor - Purchase link: [Rokland](https://store.rokland.com/products/rak
- Connector for 3.7v LiPo battery (with charge controller)
- Connector for 5v solar panel (max 5.5v)
- I<sup>2</sup>C, UART and BOOT headers accessible with solder contacts
- USB Type-C port for debugging and power
- USB-C port for debugging and power
- **Screen Support**
- OLED screen support (OLED screen sold separately)
Further information on the RAK19003 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK19003/Overview/#product-description)
US Distributor - Purchase link: [Rokland](https://store.rokland.com/products/rak-wireless-wisblock-mini-base-board-rak19003-ver-b-pid-306024)
### Resources
- Purchase links
- US
- [Rokland](https://store.rokland.com/products/rak-wireless-wisblock-mini-base-board-rak19003-ver-b-pid-306024)
- International
- [RAK Wireless](https://store.rakwireless.com/products/wisblock-base?variant=42441632252102)
<img
alt="RAK4631 19003"
@ -117,7 +128,7 @@ US Distributor - Purchase link: [Rokland](https://store.rokland.com/products/rak
</TabItem>
<TabItem value="RAK19001">
### RAK19001
## RAK19001
- [RAK19001](https://store.rakwireless.com/products/rak19001-wisblock-dual-io-base-board) - WisBlock's Dual IO Base Board.
- **Slots**
@ -140,7 +151,13 @@ US Distributor - Purchase link: [Rokland](https://store.rokland.com/products/rak
Further information on the RAK19001 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK19001/Overview/#product-description).
US Distributor - Purchase link: [Rokland](https://store.rokland.com/products/rak-wireless-wisblock-dual-io-base-board-rak19001-pid-110081)
### Resources
- Purchase links
- US
- [Rokland](https://store.rokland.com/products/rak-wireless-wisblock-dual-io-base-board-rak19001-pid-110081)
- International
- [RAK Wireless](https://store.rakwireless.com/products/wisblock-base?variant=42441631924422)
</TabItem>
</Tabs>

View file

@ -8,8 +8,6 @@ sidebar_position: 2
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
## WisBlock Core
<Tabs
groupId="rakcore"
queryString="rakcore"
@ -47,13 +45,16 @@ Please be aware of the difference between the RAK4631 (Arduino bootloader) and t
- **Connectors:**
- U.FL/IPEX antenna connector for LoRa
### RAK4631 Resources
### Resources
- Firmware file: `firmware-rak4631-X.X.X.xxxxxxx.uf2`
- Further information on the RAK4631 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK4631/Overview/#product-description).
- US Distributor - Purchase link: [Rokland - US915 Mhz](https://store.rokland.com/products/rak-wireless-rak4631-nordic-nrf52840-ble-core-module-for-lorawan-with-lora-sx1262)
- Purchase Link: [RAK Wireless Store](https://store.rakwireless.com/products/rak4631-lpwan-node?variant=37505443856582)
- Purchase Link: [RAK Wireless Aliexpress](https://www.aliexpress.us/item/3256801470104151.html)
- Purchase Links
- US
- [Rokland - US915 Mhz](https://store.rokland.com/products/rak-wireless-rak4631-nordic-nrf52840-ble-core-module-for-lorawan-with-lora-sx1262)
- International
- [RAK Wireless Store](https://store.rakwireless.com/products/rak4631-lpwan-node?variant=37505443856582)
- [RAK Wireless Aliexpress](https://www.aliexpress.us/item/3256801470104151.html)
<img
alt="RAK4631 Core Module"
@ -110,12 +111,14 @@ The RAK11200 does not contain a LoRa transceiver, and thus needs to be added sep
- WiFi 802.11 b/g/n
- High power consumption (relative to nRF52)
### RAK11200 Resources
### Resources
- Firmware file: `firmware-rak11200-X.X.X.xxxxxxx.bin`
- Further information on the RAK11200 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK11200/Overview/#product-description).
- Purchase Link: [RAK Wireless Store](https://store.rakwireless.com/products/wiscore-esp32-module-rak11200)
- Purchase Link: [RAK Wireless Aliexpress](https://www.aliexpress.us/item/3256802312474717.html)
- Purchase Links
- International
- [RAK Wireless Store](https://store.rakwireless.com/products/wiscore-esp32-module-rak11200)
- [RAK Wireless Aliexpress](https://www.aliexpress.us/item/3256802312474717.html)
<img
alt="RAK4631 5005 11200"
@ -153,12 +156,14 @@ The RAK11200 does not contain a LoRa transceiver, and thus needs to be added sep
- **Connectors:**
- U.FL/IPEX antenna connector for LoRa
### RAK11310 Resources
### Resources
- Firmware file: `firmware-rak11310-X.X.X.xxxxxxx.uf2`
- Further information on the RAK11310 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK11310/Overview/#product-description).
- Purchase Link: [RAK Wireless Store](https://store.rakwireless.com/products/rak11310-wisblock-lpwan-module)
- Purchase Link: [RAK Wireless Aliexpress](https://www.aliexpress.us/item/3256803225175784.html)
- Purchase Links
- International
- [RAK Wireless Store](https://store.rakwireless.com/products/rak11310-wisblock-lpwan-module)
- [RAK Wireless Aliexpress](https://www.aliexpress.us/item/3256803225175784.html)
</TabItem>
</Tabs>

View file

@ -8,8 +8,6 @@ sidebar_position: 1
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
<!-- RAK LOGO here? -->
The RAK WisBlock is a modular hardware system that can be used to build Meshtastic devices.
RAK Wireless currently sells a [Meshtastic Starter kit](https://store.rakwireless.com/products/wisblock-meshtastic-starter-kit) that has the minimum you need to get started.
@ -23,5 +21,7 @@ Please see the RAK documentation for the correct way to connect your hardware to
## Resources
- RAK's Wisblock [Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock)
- [American Distributor - Rokland - Purchase Link](https://store.rokland.com/products/rak-wireless-wisblock-meshtastic-starter-kit?ref=8Bb2mUO5i-jKwt)
- RAK's [GitHub Page](https://github.com/RAKWireless/WisBlock) for the WisBlock
- Purchase links
- See purchase links under specific base boards, core modules, and peripherals
- US Distributor [RAK Wireless Starter Kit](https://store.rakwireless.com/products/wisblock-meshtastic-starter-kit)

View file

@ -20,34 +20,52 @@ values={[
]}>
<TabItem value="GPS">
## GPS Modules
### RAK5005-0 / RAK1910
To add a GPS to the RAK5005-O base board, you need the [RAK1910 GPS sensor](https://store.rakwireless.com/collections/wisblock-sensor/products/rak1910-max-7q-gnss-location-sensor). It is supported on slot A of the 5005 board via UART.
- uBlox MAX-7Q GPS module
- GPS and GLONASS satellite support
Further information on the RAK1910 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK1910/Overview/#product-description).
US Distributor - Purchase link: [Rokland](https://store.rokland.com/products/rak-wireless-rak1910-wisblock-gnss-location-module)
### RAK19003 / RAK12500
To add a GPS to the RAK19003 base board, you need the [RAK12500 GPS sensor](https://store.rakwireless.com/products/wisblock-gnss-location-module-rak12500). It is supported via I<sup>2</sup>C on slot B for firmware versions 1.49 and above.
- uBlox Zoe-M8Q GNSS receiver
- GPS, GLONASS, QZSS and BeiDou satellite support
Further information on the RAK12500 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK12500/Overview/#product-description).
US Distributor - Purchase link: [Rokland](https://store.rokland.com/products/rak-wireless-rak12500-gnss-gps-location-module-u-blox-zoe-m8q)
### Resources
- RAK Documentation Center
- [RAK12500](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK12500/Overview/#product-description)
- [RAK1910](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK1910/Overview/#product-description)
- Purchase Links
- US
- [Rokland RAK1910](https://store.rokland.com/products/rak-wireless-rak1910-wisblock-gnss-location-module)
- [Rokland RAK12500](https://store.rokland.com/products/rak-wireless-rak12500-gnss-gps-location-module-u-blox-zoe-m8q)
- International
- [RAK Wireless RAK1910](https://store.rakwireless.com/products/rak1910-max-7q-gnss-location-sensor)
- [RAK Wireless RAK12500](https://store.rakwireless.com/products/wisblock-gnss-location-module-rak12500)
</TabItem>
<TabItem value="Buzzer">
## Buzzer
The [RAK18001 Buzzer Module](https://store.rakwireless.com/products/wisblock-buzzer-module-rak18001) is currently being tested for integration with the External Notifications plugin. There is currently a known conflict with buzzer if the module is placed in Slot D, although other slots should work.
Further information on the RAK18001 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK18001/Overview/#product-description).
### Resources
- [RAK Documentation Center RAK18001](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK18001/Overview/#product-description)
- Purchase Links
- International
- [RAK Wireless](https://store.rakwireless.com/products/wisblock-buzzer-module-rak18001)
</TabItem>
<TabItem value="IO">
## IO Module
The [RAK13002 IO Module](https://store.rakwireless.com/collections/wisblock-interface/products/adapter-module-rak13002) can be used to, among other things, add a user button to the RAK base boards (excluding the RAK19003 Mini base board). It features a number of different interface options:
- 2x I<sup>2</sup>C interfaces
@ -57,22 +75,22 @@ The [RAK13002 IO Module](https://store.rakwireless.com/collections/wisblock-inte
- 2x ADC interfaces
- 3.3v Power rails
There is development activity in progress to get sensors such as this added to the Meshtastic Core.
Further information on the RAK13002 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK13002/Overview).
There is development activity in progress to get sensors such as this added to the Meshtastic Core.
### Resources
- [RAK Documentation Center RAK13002](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK13002/Overview)
- Purchase Links
- US
- [Rokland](https://store.rokland.com/products/rak-wireless-rak13002-wisblock-io-adapter-module)
- International
- [RAK Wireless](https://store.rakwireless.com/collections/wisblock-interface/products/adapter-module-rak13002)
</TabItem>
<TabItem value="Sensors">
<Tabs
groupId="sensors"
queryString="sensors"
defaultValue="RAK1901"
values={[
{label: 'RAK1901', value: 'RAK1901'},
{label: 'RAK1902', value: 'RAK1902'},
{label: 'RAK1906', value: 'RAK1906'},
]}>
<TabItem value="RAK1901">
## Environmental Sensors
### RAK1901 Temperature and Humidity Sensor
The [RAK1901 Temperature and Humidity Sensor](https://store.rakwireless.com/products/rak1901-shtc3-temperature-humidity-sensor) is based on the Sensirion SHTC3 module and has the following features:
@ -80,13 +98,7 @@ The [RAK1901 Temperature and Humidity Sensor](https://store.rakwireless.com/prod
- Humidity measurement (Range 0% to 100%)
- Lower power consumption
Further information on the RAK1901 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK1901/Overview/#product-description).
US Distributor - Purchase link: [Rokland](https://store.rokland.com/products/rak-wireless-rak1901-temperature-and-humidity-sensor-sensirion-shtc3-pid-100001)
</TabItem>
<TabItem value="RAK1902">
### RAK-1902 Barometric Pressure Sensor
The [RAK1902 Barometric Pressure Sensor](https://store.rakwireless.com/products/rak1902-kps22hb-barometric-pressure-sensor) is based on the STMicroelectronics LPS22HB module and has the following features:
@ -94,11 +106,7 @@ The [RAK1902 Barometric Pressure Sensor](https://store.rakwireless.com/products/
- Low power consumption of 3uA
- Small form factor
Further information on the RAK1902 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK1902/Overview/#product-description).
</TabItem>
<TabItem value="RAK1906">
### RAK1906 Environment Sensor
The [RAK1906 Environment Sensor](https://store.rakwireless.com/products/rak1906-bme680-environment-sensor) is based on the Bosch BME680 module and has the following features:
@ -107,11 +115,20 @@ The [RAK1906 Environment Sensor](https://store.rakwireless.com/products/rak1906-
- Barometer measurement (Range 300 to 1100 hPa)
- Air Quality measurement
Further information on the RAK1906 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK1906/Overview/#product-description).
</TabItem>
</Tabs>
#### Resources
- RAK Documentation Center
- [RAK1901](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK1901/Overview/#product-description)
- [RAK1902](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK1902/Overview/#product-description)
- [RAK1906](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK1906/Overview/#product-description)
- Purchase Links
- US
- [Rokland RAK1901](https://store.rokland.com/products/rak-wireless-rak1901-temperature-and-humidity-sensor-sensirion-shtc3-pid-100001)
- [Rokland RAK1902](https://store.rokland.com/products/rak-wireless-rak1902-barometric-pressure-sensor-stmicroelectronics-lps22hb-100010-2-pack)
- [Rokland RAK1906](https://store.rokland.com/products/rak-wireless-rak1906-wisblock-environment-sensor-bosch-bme680)
- International
- [RAK Wireless RAK1901](https://store.rakwireless.com/products/rak1901-shtc3-temperature-humidity-sensor)
- [RAK Wireless RAK1902](https://store.rakwireless.com/products/rak1902-kps22hb-barometric-pressure-sensor)
- [RAK Wireless RAK1906](https://store.rakwireless.com/products/rak1906-bme680-environment-sensor)
</TabItem>

View file

@ -20,23 +20,33 @@ values={[
]}>
<TabItem value="OLED">
## RAK1921 OLED Display
The [RAK1921 OLED display](https://store.rakwireless.com/products/rak1921-oled-display-panel) is a 0.96 inch monochrome display.
US Distributor - Purchase link: [Rokland](https://store.rokland.com/products/rak-wireless-wisblock-oled-display-rak1921-pid-110004)
- 0.96 inch OLED display
- Resolution 128 x 64 pixels
- I<sup>2</sup>C interface
This item requires soldering.
Further information on the RAK1921 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK1921/Overview/#product-description).
This item requires soldering.
Similar modules are widely available from other suppliers, but do check the boards as some have the VDD and GND pins swapped round. This will prevent directly soldering the display to the baseboard. The preferred order is VDD, GND, SCL, SDA.
If pin ordering on the OLED board are swapped, there are some tricks to allow either reconfiguring the pins of the OLED via soldered jumpers, or by carefully soldering wire for those pins that are out-of-sequence. The final option is to use longer wires between the board and display, which permits re-ordering the wires as required.
### Resources
- [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK1921/Overview/#product-description)
- Purchase Links
- US
- [Rokland](https://store.rokland.com/products/rak-wireless-wisblock-oled-display-rak1921-pid-110004)
- International
- [RAK Wireless](https://store.rakwireless.com/products/rak1921-oled-display-panel)
[<img alt="0.96 inch OLED display" src="/img/hardware/screen.png" style={{zoom:'25%'}} />](/img/hardware/screen.png)
</TabItem>
<TabItem value="E-Ink">
## RAK1400 E-Ink Display
The [RAK1400 EPD module](https://store.rakwireless.com/products/wisblock-epd-module-rak14000) is an ultra low power E-Ink display with three user buttons.
- 2.13 inch black and white E-Ink display
@ -44,8 +54,17 @@ The [RAK1400 EPD module](https://store.rakwireless.com/products/wisblock-epd-mod
- Resolution 212 x 104 pixels
- Occupies the IO Port of a Wisblock Base
- US Distributor - Purchase link: [Rokland](https://store.rokland.com/products/rak-wireless-wisblock-epd-module-rak14000-pid-110024)
Please note only the white-black display is supported at this time, the white-black-red display may work, but is not supported.
### Resources
- Firmware for 5005 with RAK14000 e-paper: [`firmware-rak4631_eink-X.X.X.xxxxxxx.uf2`](/downloads)
- [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK14000/Overview/#product-description)
- Purchase Links
- US
- [Rokland](https://store.rokland.com/products/rak-wireless-wisblock-epd-module-rak14000-pid-110024)
- International
- [RAK Wireless](https://store.rakwireless.com/products/wisblock-epd-module-rak14000)
<img
alt="RAK4631 5005 14000"
@ -53,8 +72,5 @@ The [RAK1400 EPD module](https://store.rakwireless.com/products/wisblock-epd-mod
style={{ zoom: "50%" }}
/>
Please note only the white-black display is supported at this time, the white-black-red display may work, but is not supported.
Further information on the RAK14000 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK14000/Overview/#product-description).
</TabItem>
</Tabs>

View file

@ -17,16 +17,18 @@ groupId="t-beam"
queryString="t-beam"
defaultValue="sx1262"
values={[
{label: 'T-Beam v0.7', value:'0.7'},
{label: 'T-Beam v1.1', value: '1.1'},
{label: 'T-Beam with M8N', value: 'm8n'},
{label: 'T-Beam with M8N & SX1262', value: 'sx1262'},
{label: 'T-Beam S3-Core', value: 's3core'},
{label: 'T-Beam Supreme', value: 'supreme'}
{label: 'v0.7', value:'0.7'},
{label: 'v1.1', value: '1.1'},
{label: 'M8N', value: 'm8n'},
{label: 'M8N & SX1262', value: 'sx1262'},
{label: 'S3-Core', value: 's3core'},
{label: 'Supreme', value: 'supreme'}
]}>
<TabItem value="0.7">
## T-Beam v0.7
:::caution Firmware Version Notice
This is an earlier version of the T-Beam board. Due to changes in the design this board uses a specific firmware file different from the other T-Beam boards. This board is no longer in production and not recommended for new purchases.
:::
@ -45,14 +47,14 @@ This is an earlier version of the T-Beam board. Due to changes in the design thi
- Micro USB
- Antenna: SMA antenna connector
## Features
### Features
- Meshtastic preinstalled
- Power, Program and Reset switches
- Screen sold separately
- No GPS
## Resources
### Resources
- Firmware file: `firmware-tbeam0.7-X.X.X.xxxxxxx.bin`
- Purchase link: [AliExpress](https://www.aliexpress.com/item/4000469332610.html)
@ -61,8 +63,11 @@ This is an earlier version of the T-Beam board. Due to changes in the design thi
![T-Beam v0.7 pin map](/img/hardware/t-beam_v0.7_pinmap.jpeg)
</TabItem>
<TabItem value="1.1">
## T-Beam v1.1
- **MCU**
- ESP32 (WiFi & Bluetooth)
- **LoRa Transceiver**
@ -78,13 +83,13 @@ This is an earlier version of the T-Beam board. Due to changes in the design thi
- Micro USB
- Antenna: SMA antenna connector
## Features
### Features
- Meshtastic preinstalled
- Power, Program and Reset switches
- **Comes with 0.96 inch OLED display** (soldering required to assemble)
## Resources
### Resources
- Firmware file: `firmware-tbeam-X.X.X.xxxxxxx.bin`
- Purchase link: [AliExpress](https://www.aliexpress.com/item/4001178678568.html)
@ -97,6 +102,8 @@ This is an earlier version of the T-Beam board. Due to changes in the design thi
<TabItem value="m8n">
## T-Beam with M8N and SX1276
- **MCU**
- ESP32 (WiFi & Bluetooth)
- **LoRa Transceiver**
@ -112,13 +119,13 @@ This is an earlier version of the T-Beam board. Due to changes in the design thi
- Micro USB
- Antenna: U.FL antenna connector
## Features
### Features
- Meshtastic preinstalled
- Power, Program and Reset switches
- Screen sold separately
## Resources
### Resources
- Firmware file: `firmware-tbeam-X.X.X.xxxxxxx.bin`
- Purchase link: [AliExpress](https://www.aliexpress.com/item/32889583204.html)
@ -127,8 +134,11 @@ This is an earlier version of the T-Beam board. Due to changes in the design thi
![TTGO T-Beam M8N](/img/hardware/t-beam-m8n.png)
</TabItem>
<TabItem value="sx1262">
## T-Beam with M8N and SX1276
- **MCU**
- ESP32 (WiFi & Bluetooth)
- **LoRa Transceiver**
@ -144,13 +154,13 @@ This is an earlier version of the T-Beam board. Due to changes in the design thi
- Micro USB
- Antenna: U.FL antenna connector
## Features
### Features
- Meshtastic preinstalled
- Power, Program and Reset switches
- Screen sold separately
## Resources
### Resources
- Firmware file: `firmware-tbeam-X.X.X.xxxxxxx.bin`
- Purchase link: [AliExpress](https://www.aliexpress.com/item/4001287221970.html)
@ -159,8 +169,11 @@ This is an earlier version of the T-Beam board. Due to changes in the design thi
![T-Beam M8N & SX1262](/img/hardware/t-beam-sx1262.png)
</TabItem>
<TabItem value = "s3core">
## T-Beam S3 Core
- **MCU**
- ESP32-S3 (WiFi & Bluetooth 5LE)
- **LoRa Transceiver**
@ -176,13 +189,13 @@ This is an earlier version of the T-Beam board. Due to changes in the design thi
- USB-C
- Antenna: U.FL antenna connector
## Features
### Features
- SoftRF preinstalled (flashing to Meshtastic required)
- Boot and Reset switches
- Can be used standalone without 'Supreme' daughterboard in a headless configuration
## Resources
### Resources
- Firmware file: `firmware-tbeam-s3-core-X.X.X.xxxxxxx.bin`
- Purchase Link: [AliExpress](https://www.aliexpress.com/item/1005005418286231.html)
@ -190,8 +203,11 @@ This is an earlier version of the T-Beam board. Due to changes in the design thi
![T-Beam S3-Core](/img/hardware/T-BEAM-S3Core.jpg)
</TabItem>
<TabItem value = "supreme">
## T-Beam Supreme
- **MCU**
- ESP32-S3 (WiFi & Bluetooth 5LE)
- **LoRa Transceiver**
@ -207,7 +223,7 @@ This is an earlier version of the T-Beam board. Due to changes in the design thi
- USB-C
- Antenna: U.FL antenna connector
## Features
### Features
- Includes T-Beam S3-Core Module
- SoftRF preinstalled (flashing to Meshtastic required)
@ -219,7 +235,7 @@ 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
### Flashing
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.
@ -238,7 +254,7 @@ 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 "Tbeam S3 Core from the device drop-down.
## Resources
### Resources
- Firmware file: `firmware-tbeam-s3-core-X.X.X.xxxxxxx.bin`
- Purchase links:

View file

@ -7,7 +7,7 @@ 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
## Specifications
- **MCU**
- ESP32-S3FN16R8 (WiFi & Bluetooth 5 LE)
@ -22,14 +22,14 @@ The T-Deck is a compact device featuring a 2.8-inch IPS LCD touch screen with a
- **Connectors**
- USB-C
### Features
## 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
## Flashing
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.
@ -49,7 +49,7 @@ 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 "T Deck" from the device drop-down.
### Resources
## Resources
- Firmware file: `firmware-t-deck-X.X.X.xxxxxxx.bin`
- Purchase links:

View file

@ -9,7 +9,7 @@ The T-Echo is the latest device to be release by LILYGO® supporting a low power
Further information on the LILYGO® T-Echo devices can be found on LILYGO®'s [GitHub page](https://github.com/Xinyuan-LilyGO/LilyGO-T-Echo).
### Specifications
## Specifications
- **MCU**
- nRF52840 (Bluetooth BLE 5.0 & NFC)
@ -24,14 +24,14 @@ Further information on the LILYGO® T-Echo devices can be found on LILYGO®'s [G
- **Connectors**
- U.FL antenna connector
### Features
## Features
- Reset, Program and capacitive touch buttons
- 1.54" eInk display
- Optional BME280 - Humidity and Pressure Sensor
- Comes with a case and battery
### Resources
## Resources
- Firmware file: `firmware-t-echo-2.x.x.uf2`
- Purchase links:

View file

@ -7,7 +7,7 @@ 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
## Specifications
- **MCU**
- ESP32-S3 (WiFi & Bluetooth 5 LE)
@ -22,7 +22,7 @@ The T-Watch S3 is a compact wearable device featuring a 1.54-inch IPS LCD touch
- **Connectors**
- Micro-USB
### Features
## Features
- 1.54 inch ST7789V TFT LCD (Resolution: 240 x 240)
- DRV2605 Haptic Driver
@ -31,7 +31,7 @@ The T-Watch S3 is a compact wearable device featuring a 1.54-inch IPS LCD touch
- BMA423 Three Axis accelerometer
- Real-Time Clock
## Flashing the T-Watch S3
## Flashing
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.
@ -54,7 +54,7 @@ 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 "T Watch S3" from the device drop-down.
### Resources
## Resources
- Firmware file: `firmware-t-watch-X.X.X.xxxxxxx.bin`
- Purchase links:

View file

@ -4,136 +4,136 @@ require("dotenv").config();
/** @type {import('@docusaurus/types').Config} */
const config = {
title: "Meshtastic",
tagline:
"An open source, off-grid, decentralized, mesh network built to run on affordable, low-power devices",
url: "https://meshtastic.org",
baseUrl: "/",
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "warn",
favicon: "design/web/favicon.ico",
organizationName: "meshtastic",
projectName: "meshtastic",
themeConfig: /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ {
docs: {
sidebar: {
autoCollapseCategories: true,
},
},
navbar: {
title: "Meshtastic",
hideOnScroll: true,
logo: {
alt: "Meshtastic Logo",
src: "design/logo/svg/Mesh_Logo_Black.svg",
srcDark: "design/logo/svg/Mesh_Logo_White.svg",
},
items: [
{
label: "Docs",
to: "docs/introduction",
},
{
label: "Downloads",
to: "downloads",
},
{
label: "About",
position: "right",
items: [
{
label: "Introduction",
to: "docs/introduction",
},
{
label: "Getting Started",
to: "docs/getting-started",
},
{
label: "Contributing",
to: "docs/contributing",
},
{
label: "Legal",
to: "docs/legal",
},
{
label: "FAQs",
to: "docs/faq",
},
],
},
{
href: "https://github.com/meshtastic",
position: "right",
className: "header-github-link",
"aria-label": "GitHub repository",
},
],
},
footer: {
copyright: `<a href="https://vercel.com/?utm_source=meshtastic&utm_campaign=oss">Powered by ▲ Vercel</a> | Meshtastic® is a registered trademark of Meshtastic LLC. | <a href="/docs/legal">Legal Information</a>.`,
},
algolia: {
appId: "IG2GQB8L3V",
apiKey: "2e4348812173ec7ea6f7879c7032bb21",
indexName: "meshtastic",
contextualSearch: false,
searchPagePath: "search",
},
colorMode: {
respectPrefersColorScheme: true,
},
mermaid: {
theme: { light: "base", dark: "base" },
options: {
themeVariables: {
primaryColor: "#67EA94",
primaryTextColor: "var(--tw-prose-headings)",
primaryBorderColor: "#4D4D4D",
lineColor: "#EAD667",
secondaryColor: "#EA67BD",
tertiaryColor: "#677CEA",
},
},
},
},
plugins: [
() => {
return {
name: "docusaurus-tailwindcss",
configurePostCss(postcssOptions) {
postcssOptions.plugins.push(require("tailwindcss"));
postcssOptions.plugins.push(require("autoprefixer"));
return postcssOptions;
},
};
},
],
presets: [
[
"@docusaurus/preset-classic",
/** @type {import('@docusaurus/preset-classic').Options} */
{
docs: {
sidebarPath: require.resolve("./sidebars.js"),
editUrl: "https://github.com/meshtastic/meshtastic/edit/master/",
breadcrumbs: false,
showLastUpdateAuthor: true,
},
theme: {
customCss: require.resolve("./src/css/custom.css"),
},
},
],
],
customFields: {
API_URL: process.env.API_URL,
},
markdown: {
mermaid: true,
},
themes: ["@docusaurus/theme-mermaid"],
title: "Meshtastic",
tagline:
"An open source, off-grid, decentralized, mesh network built to run on affordable, low-power devices",
url: "https://meshtastic.org",
baseUrl: "/",
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "warn",
favicon: "design/web/favicon.ico",
organizationName: "meshtastic",
projectName: "meshtastic",
themeConfig: /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ {
docs: {
sidebar: {
autoCollapseCategories: true,
},
},
navbar: {
title: "Meshtastic",
hideOnScroll: true,
logo: {
alt: "Meshtastic Logo",
src: "design/logo/svg/Mesh_Logo_Black.svg",
srcDark: "design/logo/svg/Mesh_Logo_White.svg",
},
items: [
{
label: "Docs",
to: "docs/introduction",
},
{
label: "Downloads",
to: "downloads",
},
{
label: "About",
position: "right",
items: [
{
label: "Introduction",
to: "docs/introduction",
},
{
label: "Getting Started",
to: "docs/getting-started",
},
{
label: "Contributing",
to: "docs/contributing",
},
{
label: "Legal",
to: "docs/legal",
},
{
label: "FAQs",
to: "docs/faq",
},
],
},
{
href: "https://github.com/meshtastic",
position: "right",
className: "header-github-link",
"aria-label": "GitHub repository",
},
],
},
footer: {
copyright: `<a href="https://vercel.com/?utm_source=meshtastic&utm_campaign=oss">Powered by ▲ Vercel</a> | Meshtastic® is a registered trademark of Meshtastic LLC. | <a href="/docs/legal">Legal Information</a>.`,
},
algolia: {
appId: "IG2GQB8L3V",
apiKey: "2e4348812173ec7ea6f7879c7032bb21",
indexName: "meshtastic",
contextualSearch: false,
searchPagePath: "search",
},
colorMode: {
respectPrefersColorScheme: true,
},
mermaid: {
theme: { light: "base", dark: "base" },
options: {
themeVariables: {
primaryColor: "#67EA94",
primaryTextColor: "var(--tw-prose-headings)",
primaryBorderColor: "#4D4D4D",
lineColor: "#EAD667",
secondaryColor: "#EA67BD",
tertiaryColor: "#677CEA",
},
},
},
},
plugins: [
() => {
return {
name: "docusaurus-tailwindcss",
configurePostCss(postcssOptions) {
postcssOptions.plugins.push(require("tailwindcss"));
postcssOptions.plugins.push(require("autoprefixer"));
return postcssOptions;
},
};
},
],
presets: [
[
"@docusaurus/preset-classic",
/** @type {import('@docusaurus/preset-classic').Options} */
{
docs: {
sidebarPath: require.resolve("./sidebars.js"),
editUrl: "https://github.com/meshtastic/meshtastic/edit/master/",
breadcrumbs: false,
showLastUpdateAuthor: true,
},
theme: {
customCss: require.resolve("./src/css/custom.css"),
},
},
],
],
customFields: {
API_URL: process.env.API_URL,
},
markdown: {
mermaid: true,
},
themes: ["@docusaurus/theme-mermaid"],
};
module.exports = config;