Restructure hardware pages

This commit is contained in:
Sacha Weatherstone 2022-01-02 17:54:49 +11:00
parent 403136ae6a
commit 187e3cc9aa
20 changed files with 750 additions and 310 deletions

View file

@ -55,9 +55,9 @@ values={[
Firmware can be downloaded from the [Firmware](/firmware) page. Your initial installation has to happen over USB from your Mac, Windows or Linux PC. Once our software is installed, all future software updates happen over Bluetooth from your phone.
:::note
The [T-Beam 0.7](../hardware/tbeam-hardware#t-beam---v07) board is an earlier version of the T-Beam board, and due to changes in the design in subsequent iterations this board uses a specific firmware file different from the other T-Beam boards.
The [T-Beam 0.7](../hardware/supported/tbeam#t-beam---v07) board is an earlier version of the T-Beam board, and due to changes in the design in subsequent iterations this board uses a specific firmware file different from the other T-Beam boards.
`firmware-tbeam0.7-1.x.x.bin` is the correct firmware. `firmware-tbeam-1.x.x.bin` is incompatible. For all other [T-Beam](../hardware/tbeam-hardware) boards `firmware-tbeam-1.x.x.bin` is the correct selection.
`firmware-tbeam0.7-1.x.x.bin` is the correct firmware. `firmware-tbeam-1.x.x.bin` is incompatible. For all other [T-Beam](../hardware/supported/tbeam) boards `firmware-tbeam-1.x.x.bin` is the correct selection.
:::
## Command Line Interface Instructions

View file

@ -15,7 +15,7 @@ Meshtastic uses LoRa for the long range communications and depending on settings
## Purchase a Radio
The easiest way is to [buy a device with the software already installed](https://www.aliexpress.com/item/4001178678568.html). Other devices are [available](/docs/hardware/tbeam-hardware). In the Americas get the 915MHz version, in Europe the 868MHz, or Asia 923MHz. See this listing by [The Things Network](https://www.thethingsnetwork.org/docs/lorawan/frequencies-by-country.html) for frequencies by specific countries.
The easiest way is to [buy a device with the software already installed](https://www.aliexpress.com/item/4001178678568.html). Other devices are [available](/docs/hardware/supported/tbeam-hardware). In the Americas get the 915MHz version, in Europe the 868MHz, or Asia 923MHz. See this listing by [The Things Network](https://www.thethingsnetwork.org/docs/lorawan/frequencies-by-country.html) for frequencies by specific countries.
## Setup the Radio

13
docs/hardware/battery.md Normal file
View file

@ -0,0 +1,13 @@
---
id: battery
title: Adding and sizing batteries
sidebar_label: Batteries
---
import { BatteryCalculator } from '../../src/components/BatteryCalculator';
Sizing a battery for a node depends on several factors.
Please use this calculator to aid you in sizing your battery.
<BatteryCalculator />

View file

@ -1,7 +1,7 @@
---
id: buttons
title: Modifying devices to add buttons
sidebar_label: Adding buttons
sidebar_label: Buttons
---
Many of the TTGO Lora32 devices do not have a program button to navigate the displayed pages. It is possible to add a button to the following device:
@ -11,4 +11,3 @@ Many of the TTGO Lora32 devices do not have a program button to navigate the dis
Shorting IO12 to ground will progress the screen pages, wake up the device, etc. A simple push switch can be added for this purpose.
[<img src="/img/hardware/lora32-v2-1.6-button.jpg" style={{zoom:'30%'}} />](/img/hardware/lora32-v2-1.6-button.jpg)

View file

@ -1,31 +0,0 @@
---
id: heltec-hardware
title: Heltec device
sidebar_label: Heltec
---
## WiFi LoRa 32 (V2)
* ESP32 - Wifi & Bluetooth
* SX127x - LoRa Transceiver
* Frequency options:
* 433 MHz
* 470-510 MHz
* 863-870 MHz
* 902-928 MHz
* Built in 0.96 inch OLED display
* U.FL antenna connector
* Reset and Program switches
* No GPS
* Firmware file: `firmware-heltec-1.x.x.bin`
* [Purchase link](https://heltec.org/project/wifi-lora-32/)
[<img src="Heltec WiFi LoRa 32 (V2)" src="/img/hardware/heltec-v2.png" style={{zoom:'25%'}} />](/img/hardware/heltec-v2.png)
* There are two versions of the Heltec (V2). Below is a picture highlighting the visual differences:
[<img src="Heltec WiFi LoRa 32 (V2)" src="/img/hardware/heltec_v2_vs_v21.png" style={{zoom:'25%'}} />](/img/hardware/heltec_v2_vs_v21.png)
* See [hardware update log](https://heltec-automation-docs.readthedocs.io/en/latest/esp32/wifi_lora_32/hardware_update_log.html) for more details

View file

@ -1,86 +0,0 @@
---
id: lora-hardware
title: LILYGO® TTGO Lora devices
sidebar_label: LILYGO® Lora
---
## Lora V1
* ESP32 - Wifi & Bluetooth
* SX1276 - LoRa Transceiver
* Frequency options:
* 868 MHz
* 915 MHz
* Built in 0.96 inch OLED display
* U.FL antenna connector
* Reset and Program switches
* No GPS
* Firmware file: `firmware-tlora-v1-1.x.x.bin`
* [Purchase link](https://www.aliexpress.com/item/32840238513.html)
[<img alt="LILYGO® TTGO Lora V1" src="/img/hardware/lora-v1.png" style={{zoom:'25%'}} />](/img/hardware/lora-v1.png)
## Lora V1.3
* ESP32 - Wifi & Bluetooth
* SX127x - LoRa Transceiver
* Frequency options:
* 868 MHz
* 915 MHz
* Built in 0.96 inch OLED display
* U.FL antenna connector
* Reset and Program switches
* No GPS
* Firmware file: `firmware-tlora_v1_3-1.x.x.bin`
* [Purchase link](https://www.aliexpress.com/item/4000628100802.html)
[<img alt="LILYGO® TTGO Lora V1.3" src="/img/hardware/lora-v1.3.png" style={{zoom:'25%'}} />](/img/hardware/lora-v1.3.png)
## Lora V2.0
* ESP32 - Wifi & Bluetooth
* SX127x - LoRa Transceiver
* Frequency options:
* 433 MHz
* 868 MHz
* 915 MHz
* Built in 0.96 inch OLED display
* U.FL antenna connector
* Power and Reset switches
* microSD connector
* No GPS
* Firmware file: `firmware-tlora-v2-1.x.x.bin`
* [Purchase link](https://www.aliexpress.com/item/32846302183.html)
[<img alt="LILYGO® TTGO Lora V2" src="/img/hardware/lora-v2.0.png" style={{zoom:'25%'}} />](/img/hardware/lora-v2.0.png)
## Lora V2.1-1.6
* ESP32 - Wifi & Bluetooth
* SX127x - LoRa Transceiver
* Frequency options:
* 433 MHz
* 868 MHz
* 915 MHz
* Built in 0.96 inch OLED display
* SMA antenna connector
* Power and Reset switches
* microSD connector
* No GPS
* Firmware file: `firmware-tlora-v2-1-1.6-1.x.x.bin`
* [Purchase link](https://www.aliexpress.com/item/32915894264.html)
:::warning
Some of these boards contained the wrong component in the LiPo battery charging circuit allowing the battery to be overcharged. While this does appear to have been fixed recently, please see the [warning](https://www.thethingsnetwork.org/community/berlin/post/warning-attention-users-of-ttgo21-v16-boards-labeled-t3_v16-on-pcb-battery-exploded-and-got-on-fire) on The Things Network for more information.
:::
[<img src="/img/hardware/lora-v2.1-1.6.png" alt="LILYGO® TTGO Lora V2.1-1.6" style={{zoom:'25%'}} />](/img/hardware/lora-v2.1-1.6.png)

View file

@ -12,14 +12,16 @@ We currently support devices that use the ESP32 and the nRF52 microcontrollers.
The ESP32 devices have the advantage of having a Wifi interface. This allows you to connect to an access point, or run the device as an access point, and host the [web interface](/docs/software/web/web-app-software). Unfortunately the ESP32 does not support Bluetooth 5.0, and so has to wake up from sleep mode now and then to connect to Bluetooth devices to receive messages. This can result in delays sending a message from your phone.
The following ESP32 devices are supported:
* [Lilygo TTGO T-Beam](/docs/hardware/tbeam-hardware) - versions 0.7, 1.1 (including M8N GPS and SX1262 LoRa variants)
* [Lilygo TTGO Lora](/docs/hardware/lora-hardware) - versions 1, 1.3, 2.0, 2.1-1.6
* [Heltec LoRa 32 (V2)](/docs/hardware/heltec-hardware)
- [Lilygo TTGO T-Beam](/docs/hardware/supported/tbeam) - versions 0.7, 1.1 (including M8N GPS and SX1262 LoRa variants)
- [Lilygo TTGO Lora](/docs/hardware/supported/lora) - versions 1, 1.3, 2.0, 2.1-1.6
- [Heltec LoRa 32 (V2)](/docs/hardware/supported/heltec)
## nRF52
The nRF52 devices have the advantage of a Bluetooth 5.0 implementation. This allows for very low power Bluetooth connections to be maintained without having to wake the microprocessor up at regular intervals. Unfortunately, the nRF52 devices do not have Wifi built in, meaning that currently you cannot use the web interface with these devices.
The following nRF52 devices are currently supported:
* [Lilygo TTGO T-Echo](/docs/hardware/techo-hardware)
* [Wisblock RAK4631](/docs/hardware/wisBlock-hardware)
- [Lilygo TTGO T-Echo](/docs/hardware/supported/techo)
- [Wisblock RAK4631](/docs/hardware/supported/wisBlock)

View file

@ -0,0 +1,30 @@
---
id: heltec
title: Heltec device
sidebar_label: Heltec
---
## WiFi LoRa 32 (V2)
- ESP32 - Wifi & Bluetooth
- SX127x - LoRa Transceiver
- Frequency options:
- 433 MHz
- 470-510 MHz
- 863-870 MHz
- 902-928 MHz
- Built in 0.96 inch OLED display
- U.FL antenna connector
- Reset and Program switches
- No GPS
- Firmware file: `firmware-heltec-1.x.x.bin`
- [Purchase link](https://heltec.org/project/wifi-lora-32/)
[<img src="Heltec WiFi LoRa 32 (V2)" src="/img/hardware/heltec-v2.png" style={{zoom:'25%'}} />](/img/hardware/heltec-v2.png)
- There are two versions of the Heltec (V2). Below is a picture highlighting the visual differences:
[<img src="Heltec WiFi LoRa 32 (V2)" src="/img/hardware/heltec_v2_vs_v21.png" style={{zoom:'25%'}} />](/img/hardware/heltec_v2_vs_v21.png)
- See [hardware update log](https://heltec-automation-docs.readthedocs.io/en/latest/esp32/wifi_lora_32/hardware_update_log.html) for more details

View file

@ -1,5 +1,5 @@
---
id: linux-hardware
id: linux
title: Linux Compatible Hardware
sidebar_label: Linux
---

View file

@ -0,0 +1,81 @@
---
id: lora
title: LILYGO® TTGO Lora devices
sidebar_label: LILYGO® Lora
---
## Lora V1
- ESP32 - Wifi & Bluetooth
- SX1276 - LoRa Transceiver
- Frequency options:
- 868 MHz
- 915 MHz
- Built in 0.96 inch OLED display
- U.FL antenna connector
- Reset and Program switches
- No GPS
- Firmware file: `firmware-tlora-v1-1.x.x.bin`
- [Purchase link](https://www.aliexpress.com/item/32840238513.html)
[<img alt="LILYGO® TTGO Lora V1" src="/img/hardware/lora-v1.png" style={{zoom:'25%'}} />](/img/hardware/lora-v1.png)
## Lora V1.3
- ESP32 - Wifi & Bluetooth
- SX127x - LoRa Transceiver
- Frequency options:
- 868 MHz
- 915 MHz
- Built in 0.96 inch OLED display
- U.FL antenna connector
- Reset and Program switches
- No GPS
- Firmware file: `firmware-tlora_v1_3-1.x.x.bin`
- [Purchase link](https://www.aliexpress.com/item/4000628100802.html)
[<img alt="LILYGO® TTGO Lora V1.3" src="/img/hardware/lora-v1.3.png" style={{zoom:'25%'}} />](/img/hardware/lora-v1.3.png)
## Lora V2.0
- ESP32 - Wifi & Bluetooth
- SX127x - LoRa Transceiver
- Frequency options:
- 433 MHz
- 868 MHz
- 915 MHz
- Built in 0.96 inch OLED display
- U.FL antenna connector
- Power and Reset switches
- microSD connector
- No GPS
- Firmware file: `firmware-tlora-v2-1.x.x.bin`
- [Purchase link](https://www.aliexpress.com/item/32846302183.html)
[<img alt="LILYGO® TTGO Lora V2" src="/img/hardware/lora-v2.0.png" style={{zoom:'25%'}} />](/img/hardware/lora-v2.0.png)
## Lora V2.1-1.6
- ESP32 - Wifi & Bluetooth
- SX127x - LoRa Transceiver
- Frequency options:
- 433 MHz
- 868 MHz
- 915 MHz
- Built in 0.96 inch OLED display
- SMA antenna connector
- Power and Reset switches
- microSD connector
- No GPS
- Firmware file: `firmware-tlora-v2-1-1.6-1.x.x.bin`
- [Purchase link](https://www.aliexpress.com/item/32915894264.html)
:::warning
Some of these boards contained the wrong component in the LiPo battery charging circuit allowing the battery to be overcharged. While this does appear to have been fixed recently, please see the [warning](https://www.thethingsnetwork.org/community/berlin/post/warning-attention-users-of-ttgo21-v16-boards-labeled-t3_v16-on-pcb-battery-exploded-and-got-on-fire) on The Things Network for more information.
:::
[<img src="/img/hardware/lora-v2.1-1.6.png" alt="LILYGO® TTGO Lora V2.1-1.6" style={{zoom:'25%'}} />](/img/hardware/lora-v2.1-1.6.png)

View file

@ -1,10 +1,10 @@
---
id: wisBlock-hardware
id: wisBlock
title: RAK WisBlock 4631
sidebar_label: RAK WisBlock
---
The RAK WisBlock is a low power modular hardware system that can be used to build Meshtastic devices. Soldering is only required for the optional OLED screen.
The RAK WisBlock is a low power modular hardware system that can be used to build Meshtastic devices. Soldering is only required for the optional OLED screen.
You will need a [base board](https://store.rakwireless.com/collections/wisblock-base), a [core 4631 LPWAN module](https://store.rakwireless.com/collections/wisblock-core/products/rak4631-lpwan-node) and optionally a GPS Sensor to build a Meshtastic device.
@ -20,27 +20,26 @@ Flashing the firmware is a simple process connect your device via USB and click
There is currently no pin required to pair RAK devices via BLE.
* nRF52840 - Bluetooth BLE 5.0 and very low power consumption
* SX1262 - LoRa transceiver
* Frequency options:
* 433 MHz
* 470 MHz
* 799 MHz
* 865 MHz
* 868 MHz
* 915 MHz
* 920 MHz
* 923 MHz
* Optional GPS
* U.FL antenna connector
* Optional switches
* Optional screen
- nRF52840 - Bluetooth BLE 5.0 and very low power consumption
- SX1262 - LoRa transceiver
- Frequency options:
- 433 MHz
- 470 MHz
- 799 MHz
- 865 MHz
- 868 MHz
- 915 MHz
- 920 MHz
- 923 MHz
- Optional GPS
- U.FL antenna connector
- Optional switches
- Optional screen
* Firmware for 5005 base board: [`firmware-rak4631_5005-1.x.x.uf2`](https://meshtastic.org/firmware)
* Firmware for 19003 base board: [`firmware-rak4631_19003-1.x.x.uf2`](https://meshtastic.org/firmware)
* [Installation instructions](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK4631/Quickstart/#rak4631-lora-mesh-via-meshtastic)
* Don't forget to [update the bootloader](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK4631/Quickstart/#updating-the-bootloader) first!
* RAK's [GitHub Page](https://github.com/RAKWireless/WisBlock) for the WisBlock
- Firmware for 5005 base board: [`firmware-rak4631_5005-1.x.x.uf2`](https://meshtastic.org/firmware)
- Firmware for 19003 base board: [`firmware-rak4631_19003-1.x.x.uf2`](https://meshtastic.org/firmware)
- [Installation instructions](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK4631/Quickstart/#rak4631-lora-mesh-via-meshtastic)
- Don't forget to [update the bootloader](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK4631/Quickstart/#updating-the-bootloader) first!
- RAK's [GitHub Page](https://github.com/RAKWireless/WisBlock) for the WisBlock
<img alt="RAK4631 Core Module" src="/img/hardware/rak4631.png" style={{zoom:'50%'}} />

View file

@ -0,0 +1,113 @@
---
id: tbeam
title: LILYGO® TTGO T-Beam devices
sidebar_label: LILYGO® T-Beam
---
## T-Beam - Meshtastic
- Meshtastic pre-installed
- ESP32 - Wifi & Bluetooth
- SX1276 - LoRa Transceiver
- Frequency options:
- 433 MHz
- 868 MHz
- 915 MHz
- 923 MHz
- NEO-6M - GPS receiver
- SMA antenna connector
- Power, Program and Reset switches
- Comes with 0.96 inch OLED display (some soldering required to assemble)
- Firmware file: `firmware-tbeam-1.x.x.bin`
- [Purchase link](https://www.aliexpress.com/item/4001178678568.html)
[<img alt="LILYGO® TTGO T-Beam Meshtastic" src="/img/hardware/t-beam-meshtastic.png" style={{zoom:'25%'}} />](/img/hardware/t-beam-meshtastic.png)
## T-Beam - v0.7
:::note
This is an earlier version of the T-Beam board, and due to changes in the design in subsequent iterations this board uses a specific firmware file different from the other T-Beam boards.
`firmware-tbeam0.7-1.x.x.bin` is the correct firmware. `firmware-tbeam-1.x.x.bin` is incompatible. For all other T-Beam boards `firmware-tbeam-1.x.x.bin` is the correct selection.
:::
- ESP32 - Wifi & Bluetooth
- SX1276 - LoRa Transceiver
- Frequency options:
- 868 MHz
- 915 MHz
- NEO-6M - GPS receiver
- SMA antenna connector
- Power, Program and Reset switches
- No GPS
- Screen sold separately
- Firmware file: `firmware-tbeam0.7-1.x.x.bin`
- [Purchase link](https://www.aliexpress.com/item/4000469332610.html)
[<img alt="LILYGO TTGO T-Beam v0.7" src="/img/hardware/t-beam-v0.7.png" style={{zoom:'25%'}} />](/img/hardware/t-beam-v0.7.png)
## T-Beam - V1.1
- ESP32 - Wifi & Bluetooth
- SX1276 - LoRa Transceiver
- Frequency options:
- 433 MHz
- 868 MHz
- 915 MHz
- 923 MHz
- NEO-6M - GPS receiver
- SMA antenna connector
- Power, Program and Reset switches
- Comes with 0.96 inch OLED display (some soldering required to assemble)
- Firmware file: `firmware-tbeam-1.x.x.bin`
- [Purchase link](https://www.aliexpress.com/item/4001178678568.html)
[<img alt="LILYGO® TTGO T-Beam v1.1" src="/img/hardware/t-beam-v1.1.png" style={{zoom:'35%'}} />](/img/hardware/t-beam-v1.1.png)
## T-Beam - M8N
- ESP32 - Wifi & Bluetooth
- SX1276 - LoRa Transceiver
- Frequency options:
- 433 MHz
- 868 MHz
- 915 MHz
- 923 MHz
- NEO-M8N - GPS receiver - better GPS sensitivity
- U.FL antenna connector
- Power, Program and Reset switches
- Screen sold separately
- Firmware file: `firmware-tbeam-1.x.x.bin`
- [Purchase link](https://www.aliexpress.com/item/33047631119.html)
[<img alt="LILYGO® TTGO T-Beam M8N" src="/img/hardware/t-beam-m8n.png" style={{zoom:'25%'}} />](/img/hardware/t-beam-m8n.png)
## T-Beam - M8N & SX1262
- ESP32 - Wifi & Bluetooth
- SX1262 - LoRa Transceiver - improved performance
- Frequency options:
- 433 MHz
- 868 MHz
- 915 MHz
- 923 MHz
- NEO-M8N - GPS receiver - better GPS sensitivity
- U.FL antenna connector
- Power, Program and Reset switches
- Screen sold separately
- Firmware file: `firmware-tbeam-1.x.x.bin`
- [Purchase link](https://www.aliexpress.com/item/4001287221970.html)
[<img alt="LILYGO® TTGO T-Beam M8N & SX1262" src="/img/hardware/t-beam-sx1262.png" style={{zoom:'25%'}} />](/img/hardware/t-beam-sx1262.png)
## Screen
- 0.96 inch OLED i<sup>2</sup>c display
- [Purchase link](https://www.aliexpress.com/item/32922106384.html)
[<img alt="0.96 inch OLED display" src="/img/hardware/screen.png" style={{zoom:'25%'}} />](/img/hardware/screen.png)

View file

@ -0,0 +1,26 @@
---
id: techo
title: LILYGO® TTGO T-Echo devices
sidebar_label: LILYGO® T-Echo
---
The T-Echo has been in development by LILYGO® over the past few months and has now been released.
### See [Getting Started](../getting-started/flashing-nrf52)
- firmware file: `firmware-t-echo-1.x.x.uf2`
- [Purchase link](https://www.aliexpress.com/item/1005002842456390.html)
- TTGO's [GitHub page](https://github.com/Xinyuan-LilyGO/LilyGO-T-Echo) for the T-Echo
### Features
- nRF52840 - Bluetooth BLE 5.0, NFC and very low power consumption
- SX1262 - LoRa transceiver
- 1.54" eInk display
- L76K - GNSS receiver - Supporting GPS, BeiDou, GLONASS & QZSS
- Reset, Program and capacitive touch buttons
- U.FL antenna connector
<!-- * BME280 - Humidity and Pressure Sensor -->
- Optional case and battery
<img alt="LILYGO T-Echo" src="/img/hardware/t-echo.png" style={{zoom: '15%'}} />

View file

@ -1,6 +0,0 @@
---
id: supported-hardware
title: Supported hardware
sidebar_label: Supported hardware
slug: /hardware/supported-hardware
---

View file

@ -1,118 +0,0 @@
---
id: tbeam-hardware
title: LILYGO® TTGO T-Beam devices
sidebar_label: LILYGO® T-Beam
---
## T-Beam - Meshtastic
* Meshtastic pre-installed
* ESP32 - Wifi & Bluetooth
* SX1276 - LoRa Transceiver
* Frequency options:
* 433 MHz
* 868 MHz
* 915 MHz
* 923 MHz
* NEO-6M - GPS receiver
* SMA antenna connector
* Power, Program and Reset switches
* Comes with 0.96 inch OLED display (some soldering required to assemble)
* Firmware file: `firmware-tbeam-1.x.x.bin`
* [Purchase link](https://www.aliexpress.com/item/4001178678568.html)
[<img alt="LILYGO® TTGO T-Beam Meshtastic" src="/img/hardware/t-beam-meshtastic.png" style={{zoom:'25%'}} />](/img/hardware/t-beam-meshtastic.png)
## T-Beam - v0.7
:::note
This is an earlier version of the T-Beam board, and due to changes in the design in subsequent iterations this board uses a specific firmware file different from the other T-Beam boards.
`firmware-tbeam0.7-1.x.x.bin` is the correct firmware. `firmware-tbeam-1.x.x.bin` is incompatible. For all other T-Beam boards `firmware-tbeam-1.x.x.bin` is the correct selection.
:::
* ESP32 - Wifi & Bluetooth
* SX1276 - LoRa Transceiver
* Frequency options:
* 868 MHz
* 915 MHz
* NEO-6M - GPS receiver
* SMA antenna connector
* Power, Program and Reset switches
* No GPS
* Screen sold separately
* Firmware file: `firmware-tbeam0.7-1.x.x.bin`
* [Purchase link](https://www.aliexpress.com/item/4000469332610.html)
[<img alt="LILYGO TTGO T-Beam v0.7" src="/img/hardware/t-beam-v0.7.png" style={{zoom:'25%'}} />](/img/hardware/t-beam-v0.7.png)
## T-Beam - V1.1
* ESP32 - Wifi & Bluetooth
* SX1276 - LoRa Transceiver
* Frequency options:
* 433 MHz
* 868 MHz
* 915 MHz
* 923 MHz
* NEO-6M - GPS receiver
* SMA antenna connector
* Power, Program and Reset switches
* Comes with 0.96 inch OLED display (some soldering required to assemble)
* Firmware file: `firmware-tbeam-1.x.x.bin`
* [Purchase link](https://www.aliexpress.com/item/4001178678568.html)
[<img alt="LILYGO® TTGO T-Beam v1.1" src="/img/hardware/t-beam-v1.1.png" style={{zoom:'35%'}} />](/img/hardware/t-beam-v1.1.png)
## T-Beam - M8N
* ESP32 - Wifi & Bluetooth
* SX1276 - LoRa Transceiver
* Frequency options:
* 433 MHz
* 868 MHz
* 915 MHz
* 923 MHz
* NEO-M8N - GPS receiver - better GPS sensitivity
* U.FL antenna connector
* Power, Program and Reset switches
* Screen sold separately
* Firmware file: `firmware-tbeam-1.x.x.bin`
* [Purchase link](https://www.aliexpress.com/item/33047631119.html)
[<img alt="LILYGO® TTGO T-Beam M8N" src="/img/hardware/t-beam-m8n.png" style={{zoom:'25%'}} />](/img/hardware/t-beam-m8n.png)
## T-Beam - M8N & SX1262
* ESP32 - Wifi & Bluetooth
* SX1262 - LoRa Transceiver - improved performance
* Frequency options:
* 433 MHz
* 868 MHz
* 915 MHz
* 923 MHz
* NEO-M8N - GPS receiver - better GPS sensitivity
* U.FL antenna connector
* Power, Program and Reset switches
* Screen sold separately
* Firmware file: `firmware-tbeam-1.x.x.bin`
* [Purchase link](https://www.aliexpress.com/item/4001287221970.html)
[<img alt="LILYGO® TTGO T-Beam M8N & SX1262" src="/img/hardware/t-beam-sx1262.png" style={{zoom:'25%'}} />](/img/hardware/t-beam-sx1262.png)
## Screen
* 0.96 inch OLED i<sup>2</sup>c display
* [Purchase link](https://www.aliexpress.com/item/32922106384.html)
[<img alt="0.96 inch OLED display" src="/img/hardware/screen.png" style={{zoom:'25%'}} />](/img/hardware/screen.png)

View file

@ -1,27 +0,0 @@
---
id: techo-hardware
title: LILYGO® TTGO T-Echo devices
sidebar_label: LILYGO® T-Echo
---
The T-Echo has been in development by LILYGO® over the past few months and has now been released.
### See [Getting Started](../getting-started/flashing-nrf52)
* firmware file: `firmware-t-echo-1.x.x.uf2`
* [Purchase link](https://www.aliexpress.com/item/1005002842456390.html)
* TTGO's [GitHub page](https://github.com/Xinyuan-LilyGO/LilyGO-T-Echo) for the T-Echo
### Features
* nRF52840 - Bluetooth BLE 5.0, NFC and very low power consumption
* SX1262 - LoRa transceiver
* 1.54" eInk display
* L76K - GNSS receiver - Supporting GPS, BeiDou, GLONASS & QZSS
* Reset, Program and capacitive touch buttons
* U.FL antenna connector
<!-- * BME280 - Humidity and Pressure Sensor -->
* Optional case and battery
<img alt="LILYGO T-Echo" src="/img/hardware/t-echo.png" style={{zoom: '15%'}} />

View file

@ -0,0 +1,396 @@
---
id: python-commands
title: Meshtastic-python Commands
sidebar_label: Commands
---
# Python API Commands Guide
The python pip package installs a "meshtastic" command line executable, which displays packets sent over the network as JSON and lets you see serial debugging information from the meshtastic devices. This command is not run inside of python, you run it from your operating system shell prompt directly. If when you type "meshtastic" it doesn't find the command and you are using Windows: Check that the python "scripts" directory is in your path.
## Optional Arguments
### -h or --help
Shows a help message that describes the arguments.
**Usage**
```shell
meshtastic -h
```
### --port PORT
The port the Meshtastic device is connected to, i.e. /dev/ttyUSB0 or COM4. if unspecified, meshtastic will try to find it. Important to use when multiple devices are connected to ensure you call the command for the correct device.
**Usage**
```shell
meshtastic --port /dev/ttyUSB0 --info
meshtastic --port COM4 --info
```
### --host HOST
The hostname/ipaddr of the device to connect to (over TCP).
**Usage**
```shell
meshtastic --host HOST
```
### --seriallog SERIALLOG
Logs device serial output to either 'stdout', 'none' or a filename to append to.
**Usage**
```shell
meshtastic --port /dev/ttyUSB0 --seriallog
```
### --info
Read and display the radio config information.
**Usage**
```shell
meshtastic --port /dev/ttyUSB0 --info
```
### --nodes
Prints a node list in a pretty, formatted table.
**Usage**
```shell
meshtastic --nodes
```
### --qr
Displays the QR code that corresponds to the current channel.
**Usage**
```shell
meshtastic --qr
```
### --get GET
Gets a preferences field.
**Usage**
```shell
meshtastic --get modem_config
```
### --set SET SET
Sets a preferences field.
**Usage**
```shell
meshtastic --set region Unset
```
### --seturl SETURL
Set a channel URL.
**Usage**
```shell
meshtastic --seturl https://www.meshtastic.org/c/GAMiIE67C6zsNmlWQ-KE1tKt0fRKFciHka-DShI6G7ElvGOiKgZzaGFyZWQ=
```
### --ch-index CH_INDEX
Set the specified channel index
**Usage**
```shell
meshtastic --ch-index 1 --ch-disable
```
### --ch-add CH_ADD
Add a secondary channel, you must specify a channel name.
**Usage**
```shell
meshtastic --ch-add testing-channel
```
### --ch-del
Delete the ch-index channel.
**Usage**
```shell
meshtastic --ch-index 1 --ch-del
```
### --ch-enable
Enable the specified channel.
**Usage**
```shell
meshtastic --ch-index 1 --ch-enable
```
### --ch-disable
Disable the specified channel.
**Usage**
```shell
meshtastic --ch-index 1 --ch-disable
```
### --ch-set CH_SET CH_SET
Set a channel parameter.
**Usage**
```shell
meshtastic --ch-set id 1234
```
### --ch-longslow
Change to the standard long-range (but slow) channel.
**Usage**
```shell
meshtastic --ch-longslow
```
### --ch-shortfast
Change to the standard fast (but short range) channel.
**Usage**
```shell
meshtastic --ch-shortfast
```
### --set-owner SET_OWNER
Set device owner name.
**Usage**
```shell
meshtastic --dest \!28979058 --set-owner "MeshyJohn"
```
### --set-ham SET_HAM
Set licensed Ham ID and turn off encryption.
**Usage**
```shell
meshtastic --set-ham KI1345
```
### --dest DEST
The destination node id for any sent commands
**Usage**
```shell
meshtastic --dest \!28979058 --set-owner "MeshyJohn"
```
### --sendtext SENDTEXT
Send a text message.
**Usage**
```shell
meshtastic --sendtext "Hello Mesh!"
```
### --sendping
Send a ping message (which requests a reply).
**Usage**
```shell
meshtastic --sendping
```
### --reboot
Tell the destination node to reboot.
**Usage**
```shell
meshtastic --dest \!28979058 --reboot
```
### --reply
Reply to received messages.
**Usage**
```shell
meshtastic --reply
```
### --gpio-wrb GPIO_WRB GPIO_WRB
Set a particular GPIO # to 1 or 0.
**Usage**
```shell
meshtastic --port /dev/ttyUSB0 --gpio-wrb 4 1 --dest \!28979058
```
### --gpio-rd GPIO_RD
Read from a GPIO mask.
**Usage**
```shell
meshtastic --port /dev/ttyUSB0 --gpio-rd 0x10 --dest \!28979058
```
### --gpio-watch GPIO_WATCH
Start watching a GPIO mask for changes.
**Usage**
```shell
meshtastic --port /dev/ttyUSB0 --gpio-watch 0x10 --dest \!28979058
```
### --no-time
Suppress sending the current time to the mesh.
**Usage**
```shell
meshtastic --port /dev/ttyUSB0 --no-time
```
### --setalt SETALT
Set device altitude (allows use without GPS).
**Usage**
```shell
meshtastic --setalt 120
```
### --setlat SETLAT
Set device latitude (allows use without GPS).
**Usage**
```shell
meshtastic --setlat 25.2
```
### --setlon SETLON
Set device longitude (allows use without GPS).
**Usage**
```shell
meshtastic --setlon -16.8
```
### --debug
Show API library debug log messages.
**Usage**
```shell
meshtastic --debug --info
```
### --test
Run stress test against all connected Meshtastic devices.
**Usage**
```shell
meshtastic --test
```
### --ble BLE
BLE mac address to connect to (BLE is not yet supported for this tool).
**Usage**
```shell
meshtastic --ble "83:38:92:32:37:48"
```
### --noproto
Don't start the API, just function as a dumb serial terminal.
**Usage**
```shell
meshtastic --noproto
```
### --version
Show program's version number and exit.
**Usage**
```shell
meshtastic --version
```
## Deprecated Arguments
### --setchan
Deprecated - use "--ch-set param value" instead.
### --set-router
Deprecated - use "--set is_router true" instead.
### --unset-router
Deprecated - use "--set is_router false" instead.

View file

@ -0,0 +1,23 @@
---
id: python-stream
title: Meshtastic-python stream protocol
sidebar_label: Stream Protocol
---
# Stream protocol
Documentation on how out protobufs get encoded when placed onto any stream transport (i.e. TCP or serial, but not UDP or BLE)
## Wire encoding
When sending protobuf packets over serial or TCP each packet is preceded by uint32 sent in network byte order (big endian).
The upper 16 bits must be 0x94C3. The lower 16 bits are packet length (this encoding gives room to eventually allow quite large packets).
Implementations validate length against the maximum possible size of a BLE packet (our lowest common denominator) of 512 bytes. If the
length provided is larger than that we assume the packet is corrupted and begin again looking for 0x4403 framing.
The packets flowing towards the device are ToRadio protobufs, the packets flowing from the device are FromRadio protobufs.
The 0x94C3 marker can be used as framing to (eventually) resync if packets are corrupted over the wire.
Note: the 0x94C3 framing was chosen to prevent confusion with the 7 bit ascii character set. It also doesn't collide with any valid utf8 encoding. This makes it a bit easier to start a device outputting regular debug output on its serial port and then only after it has received a valid packet from the PC, turn off unencoded debug printing and switch to this
packet encoding.

View file

@ -52,8 +52,8 @@ module.exports = {
"software/python/python-installation",
"software/python/python-cli",
"software/python/python-uses",
"software/python/python-using-library",
"software/python/python-development",
"software/python/python-commands",
"software/python/python-stream",
{
type: "link",
label: "API Docs",
@ -132,15 +132,16 @@ module.exports = {
"hardware/overview",
{
"Supported Hardware": [
"hardware/tbeam-hardware",
"hardware/lora-hardware",
"hardware/heltec-hardware",
"hardware/techo-hardware",
"hardware/wisBlock-hardware",
"hardware/linux-hardware",
"hardware/supported/tbeam",
"hardware/supported/lora",
"hardware/supported/heltec",
"hardware/supported/techo",
"hardware/supported/wisBlock",
"hardware/supported/linux",
],
},
"hardware/buttons",
"hardware/battery",
{
Antennas: [
"hardware/antenna/antenna",

View file

@ -0,0 +1,25 @@
import React from 'react';
export const BatteryCalculator = (): JSX.Element => {
return (
<div className="card">
<div className="card__header">
<h3>Battery Calculator</h3>
</div>
<div className="card__body" style={{ display: "flex", gap: "2rem" }}>
<div>
<input placeholder="Search" />
<input placeholder="Search" />
<input placeholder="Search" />
<input placeholder="Search" />
</div>
<div></div>
</div>
<div className="card__footer">
<button className="button button--secondary button--block">
See All
</button>
</div>
</div>
);
};