mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-12-25 05:34:11 -08:00
updated gettings started and supported hardware page
This commit is contained in:
sigmahour
parent
9c749591a8
commit
d8182cee8a
22
.gitignore
vendored
22
.gitignore
vendored
|
|
@ -1,8 +1,28 @@
|
|||
# Project specific
|
||||
node_modules/
|
||||
*.Identifier
|
||||
.docusaurus
|
||||
build
|
||||
.vercel
|
||||
.DS_Store
|
||||
.env
|
||||
.pnpm-debug.log
|
||||
|
||||
# macOS
|
||||
.DS_Store
|
||||
|
||||
# IntelliJ
|
||||
.idea
|
||||
*.iml
|
||||
out
|
||||
gen
|
||||
|
||||
# VS Code
|
||||
.vscode/*
|
||||
!.vscode/settings.json
|
||||
!.vscode/tasks.json
|
||||
!.vscode/launch.json
|
||||
!.vscode/extensions.json
|
||||
!.vscode/*.code-snippets
|
||||
.history/
|
||||
*.vsix
|
||||
*.code-workspace
|
||||
46
docs/1.2-End-of-life/hardware/techo.mdx
Normal file
46
docs/1.2-End-of-life/hardware/techo.mdx
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
---
|
||||
id: techo
|
||||
title: LILYGO® TTGO T-Echo devices
|
||||
sidebar_label: LILYGO® T-Echo
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
The T-Echo is the latest device to be release by LILYGO® supporting a low power consumption microcontroller.
|
||||
|
||||
### 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
|
||||
- Optional BME280 - Humidity and Pressure Sensor
|
||||
- Comes with a case and battery
|
||||
|
||||
### Resources
|
||||
|
||||
- Firmware file: `firmware-t-echo-2.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
|
||||
|
||||
<img
|
||||
alt="LILYGO T-Echo"
|
||||
src="/img/hardware/t-echo.png"
|
||||
style={{ zoom: '15%' }}
|
||||
/>
|
||||
|
||||
### T-Echo button functions
|
||||
|
||||
- Capacitive top button
|
||||
- A short press refreshes the current screen
|
||||
- Button 1
|
||||
- A single press resets the device
|
||||
- A double press puts the device into bootloader mode ready to receive a new firmware
|
||||
- Button 2
|
||||
- A single press changes the page displayed on the device
|
||||
- A double press turns the screen backlight on/off
|
||||
- A long press turns the device off
|
||||
|
||||
|
||||
[<img alt="LILYGO T-Echo" src="/img/hardware/t-echo-lilygo.jpg" style={{zoom:'25%'}} />](/img/hardware/t-echo-lilygo.jpg)
|
||||
|
|
@ -20,7 +20,7 @@ This can be installed using pip.
|
|||
python -m pip install --upgrade meshtastic-pygui
|
||||
```
|
||||
|
||||
```shell title="MacOS/Linux"
|
||||
```shell title="macOS/Linux"
|
||||
pip3 install --upgrade meshtastic-pygui
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: faq
|
||||
title: FAQs
|
||||
slug: /faq
|
||||
sidebar_position: 6
|
||||
sidebar_position: 8
|
||||
---
|
||||
|
||||
<!---
|
||||
|
|
|
|||
7
docs/field-tests/_category_.yml
Normal file
7
docs/field-tests/_category_.yml
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
position: 7 # float position is supported
|
||||
label: 'Field Tests'
|
||||
collapsible: true # make the category collapsible
|
||||
link:
|
||||
type: generated-index
|
||||
title: Field Tests
|
||||
slug: field-tests
|
||||
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
id: antenna-reports
|
||||
title: Antenna Testing Reports
|
||||
title: LoRa Antenna Testing Reports
|
||||
sidebar_label: Testing Reports
|
||||
slug: /hardware/antenna-report
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
|
|
@ -1,13 +1,9 @@
|
|||
---
|
||||
id: lora-antenna
|
||||
title: LoRa Antennas
|
||||
title: Testing LoRa Antennas
|
||||
sidebar_label: LoRa Antennas
|
||||
sidebar_position: 2
|
||||
slug: /hardware/antenna
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
## TL; DR
|
||||
|
||||
If you have sufficient range with your existing aerial, skip this section. If you don't, consider either getting more nodes and / or replace the stock aerial with one tuned (to your region transmitter's frequency):
|
||||
|
||||
- A quarter wave _tuned_ stubby aerial (<10cm for fit-in-pocket) should have a real-world range of a couple of km without significant obstacles (buildings / hills).
|
||||
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
id: resources
|
||||
title: Antenna Resources
|
||||
title: LoRa Antenna Resources
|
||||
sidebar_label: Resources
|
||||
slug: /hardware/resources
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
id: antenna-testing
|
||||
title: Antenna Testing
|
||||
sidebar_label: Testing
|
||||
sidebar_position: 3
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
Testing of antennas can be both simple and complex. At its simplest, testing involves sending messages from different locations and seeing which ones are received, and then comparing the results against other antennas. At the complex end, this can be using expensive test chambers and equipment to measure the signal strength, gain, and radiation patterns. However, it seems that a reasonable job can be done with cheaper methods.
|
||||
7
docs/getting-started/flashing-firmware/_category_.yml
Normal file
7
docs/getting-started/flashing-firmware/_category_.yml
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
label: Flash Firmware
|
||||
collapsible: true # make the category collapsible
|
||||
position: 2
|
||||
link:
|
||||
type: generated-index
|
||||
title: Flashing Firmware
|
||||
slug: /getting-started/flashing-firmware
|
||||
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
id: flashing-esp32
|
||||
title: Flashing ESP32 device firmware
|
||||
id: cli-script
|
||||
title: Flashing with the CLI
|
||||
sidebar_label: CLI Script
|
||||
pagination_prev: getting-started/flashing-firmware/flashing-firmware
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
|
|
@ -13,7 +12,6 @@ import TabItem from '@theme/TabItem';
|
|||
Make sure not to power the radio on without first attaching the antenna! You could damage the radio chip!
|
||||
:::
|
||||
|
||||
|
||||
For ESP32 devices if the device already has a version of Meshtastic installed using the OTA firmware upgrade tool in the Android app is the friendliest path for users. OTA firmware updates are not yet available on Apple platforms.
|
||||
|
||||
If your ESP32 device does not have Meshtastic pre-installed flashing
|
||||
|
|
@ -150,7 +148,7 @@ values={[
|
|||
<TabItem value="macos">
|
||||
|
||||
:::important
|
||||
On MacOS, you may need to explicitly declare esptool as a .py script. Use `esptool.py chip_id`.
|
||||
On macOS, you may need to explicitly declare esptool as a .py script. Use `esptool.py chip_id`.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
id: flashing-external-serial-adapter
|
||||
title: Flashing Firmware with an External Serial Adapter (ESP32)
|
||||
sidebar_label: Serial Adapters
|
||||
id: external-serial-adapter
|
||||
title: Flashing with an External Serial Adapter
|
||||
sidebar_label: External Serial Adapter
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
|
|
@ -9,7 +9,7 @@ import Tabs from '@theme/Tabs';
|
|||
import TabItem from '@theme/TabItem';
|
||||
|
||||
:::info
|
||||
This information will likely only be helpful if you've already attempted to go through the prerequisites and processes outlined in [meshtastic flasher](/docs/software/python/flasher) or [manually flashing](/docs/getting-started/flashing-firmware/esp32/flashing-esp32)
|
||||
This information will likely only be helpful if you've already attempted to go through the prerequisites and processes outlined in [meshtastic flasher](/docs/software/python/flasher) or [manually flashing](/docs/getting-started/flashing-firmware/esp32/cli-script)
|
||||
:::
|
||||
|
||||
:::caution
|
||||
|
|
@ -40,7 +40,7 @@ There are multiple ways to connect the pins of the adapter to the target device:
|
|||
:::
|
||||
Disconnect your USB to Serial Adapter from the computer before starting this process.
|
||||
|
||||
1. Connect the RX pin of the adapter to the TX pin of the device
|
||||
1. Connect the RX pin of the adapter to the TX pin of the devices
|
||||
2. Connect the TX pin of the adapter to the RX pin of the device
|
||||
3. Connect a GND pin of the adapter to the GND pin of the device
|
||||
4. Connect either the 5V pin of the adapter to the 5V pin of the device (illustrated) or the 3.3V pin of the adapter to the 3.3V pin of device.
|
||||
|
|
@ -53,7 +53,7 @@ Disconnect your USB to Serial Adapter from the computer before starting this pro
|
|||
|
||||
### Flashing
|
||||
|
||||
After following the steps above, your device should be in flash mode. You can flash your device using the [Meshtastic flasher](/docs/software/python/flasher) or [manual method](https://meshtastic.org/docs/getting-started/flashing-firmware/flashing-esp32)
|
||||
After following the steps above, your device should be in flash mode. You can flash your device using the [Meshtastic flasher](/docs/software/python/flasher) or [manual method](/docs/getting-started/flashing-firmware/esp32/cli-script)
|
||||
|
||||
Example using the Meshtastic Flasher
|
||||
|
||||
|
|
@ -73,7 +73,3 @@ Sometimes you might receive an error for COM port permission in the Mestastic Fl
|
|||
|
||||
You might need to run the process as an administrator, check to ensure software like Cura isn't monopolizing COM ports, or reboot.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -5,14 +5,11 @@ sidebar_label: ESP32 Device
|
|||
sidebar_position: 2
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
## Recommended Flashing Method for ESP32 Devices
|
||||
|
||||
For ESP32 based device users (TBEAM, TLORA, Heltec etc.)
|
||||
## Flashing Method for ESP32 Devices
|
||||
|
||||
We recommend using the following methods for flashing ESP32 devices:
|
||||
|
||||
1. [Web-based installer](https://flasher.meshtastic.org) - The browser application requires either Chrome or Edge broswers but is an excellent choice for quickly flashing devices.
|
||||
2. [Python Flasher](/docs/software/python/flasher) - The flasher application does a lot under the hood to prevent you from needing to use the terminal. It also allows you to configure your device.
|
||||
1. The [Web-based installer](https://flasher.meshtastic.org) requires either Chrome or Edge broswers but is an excellent choice for quickly flashing devices.
|
||||
2. The [Python Flasher](/docs/software/python/flasher) does a lot under the hood to prevent you from needing to use the terminal. It also allows you to configure your device.
|
||||
3. The [CLI Script](/docs/getting-started/flashing-firmware/esp32/cli-script) is considered the "manual process" for flashing firmware.
|
||||
4. Flashing your device using an [external serial adapter](/docs/getting-started/flashing-firmware/esp32/external-serial-adapter) should only be attempted as a last resort if no other method has been successful.
|
||||
|
|
@ -1,19 +0,0 @@
|
|||
---
|
||||
id: flashing-firmware
|
||||
title: Flashing Firmware
|
||||
sidebar_label: Flash Firmware
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
:::caution
|
||||
Make sure not to power the radio on without first attaching the antenna! You could damage the radio chip!
|
||||
:::
|
||||
|
||||
## Manual Firmware Installation
|
||||
|
||||
Firmware can be downloaded from the [Downloads](/downloads) page. Your initial installation has to happen over USB from your Mac, Windows, or Linux computer.
|
||||
|
||||
If you choose to flash the firmware using the manual method, [ESP32 based devices](/docs/getting-started/flashing-firmware/esp32/) and [NRF52 based devices](/docs/getting-started/flashing-firmware/nrf52/) have different methods. Select the appropriate one. If you don't know what chipset your device is, take a look at our [supported hardware](/docs/category/supported-hardware) section.
|
||||
|
|
@ -2,8 +2,6 @@
|
|||
id: drag-n-drop
|
||||
title: Drag & Drop NRF52 Firmware Updates
|
||||
sidebar_label: Drag & Drop (recommended)
|
||||
pagination_prev: getting-started/flashing-firmware/flashing-firmware
|
||||
pagination_next: getting-started/flashing-firmware/esp32/flashing-esp32
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -5,14 +5,12 @@ sidebar_label: NRF52 Device
|
|||
sidebar_position: 2
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
## Recommended Flashing Method for NRF52 Devices
|
||||
## Flashing Methods for NRF52 Devices
|
||||
|
||||
If you have RAK NRF based devices or a LilyGO T-Echo
|
||||
|
||||
1. The [drag and drop](/docs/getting-started/flashing-firmware/nrf52/drag-n-drop) firmware installation process is the easiest solution.
|
||||
1. The [drag and drop](/docs/getting-started/flashing-firmware/nrf52/drag-n-drop) firmware installation is considered the "manual process" and recommended as the easiest solution.
|
||||
2. The [Python Flasher](/docs/software/python/flasher) application does a lot under the hood to prevent you from needing to use the terminal. It also allows you to configure your device.
|
||||
|
||||
## Convert RAK4631-R to RAK4631
|
||||
|
||||
|
|
|
|||
|
|
@ -7,46 +7,157 @@ sidebar_position: 2
|
|||
---
|
||||
|
||||
import Link from '@docusaurus/Link';
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
## What is Meshtastic?
|
||||
## Identify your Hardware
|
||||
|
||||
Meshtastic® is a project that lets you use inexpensive LoRa radios as a long range off-grid communicator for areas without reliable cellular service. These radios are great for hiking, skiing, paragliding - essentially any hobby where you don't have reliable internet access. Each member of the mesh can send and view text messages and enable optional GPS based location features.
|
||||
The first order of business in getting started is determining what type of hardware you will be working with. Meshtastic currently supports devices with either of the two Microcontroller Units (MCU):
|
||||
|
||||
The radios automatically create a mesh to forward packets as needed, so everyone in the group can receive messages from even the furthest member. The radios will optionally work with your phone, but no phone is required.
|
||||
### ESP32
|
||||
|
||||
Meshtastic uses LoRa for the long range communications and depending on settings used up to 80 device nodes. Each device supports a connection from a single user at a time.
|
||||
The ESP32 is older and consumes more power than the nrf52, but is equiped with both WiFi and Bluetooth. Supported ESP32 devices:
|
||||
|
||||
- LILYGO® TTGO T-Beam
|
||||
- LILYGO® TTGO Lora
|
||||
- Nano G1
|
||||
- Station G1
|
||||
|
||||
### NRF52
|
||||
|
||||
The NRF52 is much more power effecient than the esp32 and easier to update, but is only equiped Bluetooth. Supported NRF52 devices:
|
||||
|
||||
- RAK WisBlock
|
||||
- LILYGO® TTGO T-Echo
|
||||
|
||||
:::info
|
||||
If your device is not listed above, please review our [supported hardware](/docs/category/supported-hardware) devices to determine which MCU your device has or contact us in [Discord](https://discord.gg/ktMAKGBnBs) with any questions.
|
||||
:::
|
||||
|
||||
## Connect your device
|
||||
|
||||
:::danger
|
||||
Stop! Never power on the radio without attaching an antenna! (it could damage the radio chip)
|
||||
:::
|
||||
|
||||
Prior to connecting your Meshtastic device to the computer, you should perform the following basic checks.
|
||||
|
||||
### Verify data cable
|
||||
|
||||
Some cables only provide _charging_, verify that your cable is also capable of _transfering data_ before proceeding.
|
||||
|
||||
There is no definitive way to determine the difference in cables if you aren't willing to pull it apart. Trying out a few cables will be the best way to verify.
|
||||
|
||||
Once you've located a working data cable, [install the correct serial driver](#install-serial-drivers) and [test for driver installation](#test-for-driver-installation).
|
||||
|
||||
|
||||
### Install Serial Drivers
|
||||
|
||||
<div className="indexCtasBody">
|
||||
<Link
|
||||
<Link target="_blank"
|
||||
className={'button button--outline button--lg cta--button'}
|
||||
to={'/docs/about'}
|
||||
to={'/docs/getting-started/serial-drivers'}
|
||||
>
|
||||
Learn More
|
||||
Install Serial Drivers
|
||||
</Link>
|
||||
</div>
|
||||
|
||||
## Supported Hardware
|
||||
### Test for driver installation
|
||||
|
||||
<div className="indexCtasBody">
|
||||
<Link
|
||||
className={'button button--outline button--lg cta--button'}
|
||||
to={'/docs/category/supported-hardware'}
|
||||
>
|
||||
Supported Hardware
|
||||
</Link>
|
||||
</div>
|
||||
You can verify that you have a proper data cable (rather than a charge-only type cable) and that the appropriate drivers for your system are installed by performing the following test:
|
||||
|
||||
<Tabs
|
||||
groupId="operating-system"
|
||||
defaultValue="linux"
|
||||
values={[
|
||||
{label: 'Linux', value: 'linux'},
|
||||
{label: 'macOS', value: 'macos'},
|
||||
{label: 'Windows', value: 'windows'},
|
||||
]}>
|
||||
<TabItem value="linux">
|
||||
|
||||
1. Connect your Meshtastic device to your USB port
|
||||
2. Open a **Terminal** and enter the following command:
|
||||
|
||||
```shell
|
||||
lsusb
|
||||
```
|
||||
3. You should see something like:
|
||||
|
||||
```shell
|
||||
ID xxxx:xxxx Silicon Labs CP210x UART Bridge
|
||||
# or
|
||||
ID xxxx:xxxx QinHeng Electronics USB Single Serial
|
||||
# or
|
||||
FIXME (WISBLOCK OUTPUT)
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="macos">
|
||||
|
||||
1. Navigate to `Apple Menu > About This Mac > System Report... > Hardware > USB`.
|
||||
2. You should see similar to one of the following entries:
|
||||
- `CP210X USB to UART Bridge Controller`
|
||||
- `CH9102 USB to UART Bridge Controller`
|
||||
- `WisCore RAK4631 Board`
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="windows">
|
||||
|
||||
1. Navigate to `Device Manager > Ports (COM & LPT)`
|
||||
2. You should see similar to one of the following entries:
|
||||
- `Silicon Labs CP210X USB to UART Bridge (COM5)`
|
||||
- `Silicon Labs CH9102 USB to UART Bridge (COM5)`
|
||||
- `FIXME (WISBLOCK OUTPUT)`
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
:::info
|
||||
If you do not see your device:
|
||||
|
||||
1. You may be using a charging-only cable, [verify your cable](#verify-data-cable).
|
||||
2. You may need to [install the USB serial driver](/docs/getting-started/serial-drivers)).
|
||||
:::
|
||||
|
||||
## Flashing Firmware
|
||||
|
||||
### ESP32
|
||||
|
||||
<div className="indexCtasBody">
|
||||
<Link
|
||||
<Link target="_blank"
|
||||
className={'button button--outline button--lg cta--button'}
|
||||
to={'/docs/getting-started/flashing-firmware'}
|
||||
to={'/docs/getting-started/flashing-firmware/esp32/'}
|
||||
>
|
||||
Flash Firmware
|
||||
Flash ESP32 Firmware
|
||||
</Link>
|
||||
</div>
|
||||
|
||||
## Troubleshooting
|
||||
### NRF52
|
||||
|
||||
For RAK4631 users, if you have a RAK4631-R (the RUI3 bootloader version of the RAK4631), please [convert to the Arduino bootloader](/docs/getting-started/flashing-firmware/nrf52/#convert-rak4631-r-to-rak4631)
|
||||
|
||||
<div className="indexCtasBody">
|
||||
<Link target="_blank"
|
||||
className={'button button--outline button--lg cta--button'}
|
||||
to={'/docs/getting-started/flashing-firmware/nrf52/'}
|
||||
>
|
||||
Flash NRF52 Firmware
|
||||
</Link>
|
||||
</div>
|
||||
|
||||
## Use Meshtastic
|
||||
|
||||
There are many ways to interact with and use Meshtastic, please visit the [Software](/docs/software) page for more information.
|
||||
|
||||
### with mobile apps
|
||||
- [Android](/docs/software/android/)
|
||||
- [Apple](/docs/software/apple/)
|
||||
|
||||
### with a browser
|
||||
- https://client.meshtastic.org
|
||||
- [Meshtastic Web](/docs/software/web/)
|
||||
|
||||
### over the internet with MQTT
|
||||
- [MQTT](/docs/software/mqtt/)
|
||||
|
||||
Hopefully your "getting started" experience has been straight forward and headache free. If you've had issues, please consider updating our documentation to improve future user experiences. If you're still having issues. Reach out on the [forum](https://meshtastic.discourse.group) or [Discord](https://discord.gg/ktMAKGBnBs). Our support is 100% volunteer based. We are passionate about the project hope to help newcomers become Meshtastic experts.
|
||||
|
|
|
|||
7
docs/getting-started/serial-drivers/_category_.yml
Normal file
7
docs/getting-started/serial-drivers/_category_.yml
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
label: Install Serial Drivers
|
||||
collapsible: true # make the category collapsible
|
||||
position: 1
|
||||
link:
|
||||
type: generated-index
|
||||
title: Installing Serial Drivers
|
||||
slug: /getting-started/serial-drivers
|
||||
|
|
@ -31,7 +31,7 @@ Reboot your computer after you have installed the driver to complete the install
|
|||
|
||||
<TabItem value="macos">
|
||||
|
||||
- [CH9102 Driver - MacOS Download](https://github.com/WCHSoftGroup/ch34xser_macos)
|
||||
- [CH9102 Driver - macOS Download](https://github.com/WCHSoftGroup/ch34xser_macos)
|
||||
|
||||
:::important
|
||||
Reboot your computer after you have installed the driver to complete the installation.
|
||||
|
|
@ -43,7 +43,7 @@ With the latest versions of MacOS, the USB Serial driver is built-in. Do _NOT_ d
|
|||
|
||||
### Remove the CH34x USB Driver (macOS)
|
||||
|
||||
If you have already downloaded/installed the MacOS WCH-IC CH340/CH341
|
||||
If you have already downloaded/installed the macOS WCH-IC CH340/CH341
|
||||
("CH341SER_MAC") drivers via the CH34x_Install_V1.5.pkg, you will have to
|
||||
Uninstall the kernel extension:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,48 +0,0 @@
|
|||
---
|
||||
id: aerials
|
||||
title: Aerial Selection
|
||||
sidebar_label: Aerial Selection
|
||||
slug: /hardware/aerials
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
The stock aerials provided bundled with the t-Beam and other boards are a 'mixed bag'. They may not have been designed or tuned for your given frequency range, and they may not be of a quality design.
|
||||
|
||||
Matching an aerial to the transceiver frequency is important, as is choosing an appropriate design.
|
||||
|
||||
The aerial's design will affect:
|
||||
|
||||
- proportion of the signal which leaves the aerial (efficiency),
|
||||
- directions in which it's transmitted,
|
||||
- whether it will be affected by horizontal or vertical polarization,
|
||||
- and proportion of signal which is reflected back within the device itself.
|
||||
|
||||
:::caution
|
||||
While the LoRa devices we are using for Meshtastic are relatively low power radios, care should be taken _not_ to operate any radio transmission device without an aerial or with a poorly matched aerial. Un-transmitted radio signal reflected back to the transmitter can damage the device.
|
||||
:::
|
||||
|
||||
### Important considerations:
|
||||
|
||||
- What transmission frequency are you using?
|
||||
- Devices on another frequency will not be able to interact with yours.
|
||||
- See this listing by [The Things Network](https://www.thethingsnetwork.org/docs/lorawan/frequencies-by-country.html) for frequencies licensed for specific countries.
|
||||
- How will you be carrying / transporting the radio?
|
||||
- A large directional aerial will transmit over significantly greater distance than an omni-directional aerial. However, it must be pointed at its target so isn't optimal for mobile use.
|
||||
- A tuned half-wave whip aerial may have more omni-directional range than the quarter wave stubby; but it will be conspicuous in your pocket.
|
||||
- Many antennas, especially quarter wave stubby antennas, require the use of ground planes to transmit at peak performance.
|
||||
- Do you want transmission in all directions?
|
||||
- While humans (mostly water) don't attenuate signal greatly (at LoRa frequencies), buildings & walls do.
|
||||
- If your aerial is permanently positioned against a building, signal transmitted towards the wall will be largely lost or attenuated.
|
||||
- Does my Meshtastic device have the right power range, impedance, and connector for the aerial?
|
||||
- For the LoRa devices, it should be 50 Ohm impedance with SMA connector. Many antennas will be recommended for LoRa use in their technical details.
|
||||
- By contrast, a close range, contactless Personal Area Network antenna, or a huge aerial at the end of length of coax designed for a 100W transmitter, are not going to be operable.
|
||||
- Cost, quality, and supply service?
|
||||
- The perfect aerial on paper, sourced from the other side of the world with mixed reviews, doesn't compare to a local supplier who has spent time carefully collating all of the aerial data-sheets for comparison _and_ holds stock immediately available. Personally, I prefer to pay significantly more for a time saving, quality service.
|
||||
- How close will the antenna be to my Meshtastic device?
|
||||
- Most cables will significantly degrade the signal strength over any significant distance. It is often more effective to place a node outside, than to have it indoors with the antenna outside. (The exception might be if there is extreme heat, cold, or humidity, and if the shortest possible low loss cable is used. Still, a proper enclosure should mitigate bad weather.)
|
||||
|
||||
## Terminology / references
|
||||
|
||||
You could do a lot worse than reading the [Wikipedia entry for Antenna](<https://en.wikipedia.org/wiki/Antenna_(radio)>), along with the [Wikipedia entry for LoRa](https://en.wikipedia.org/wiki/LoRa).
|
||||
|
||||
Instead of listing the terms, let us recommend this superb [tutorial](https://www.youtube.com/watch?v=J3PBL9oLPX8) by Andreas Spiess (the 'guy with the Swiss accent').
|
||||
53
docs/hardware/antennas.mdx
Normal file
53
docs/hardware/antennas.mdx
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
---
|
||||
id: lora-antenna
|
||||
title: LoRa Antenna Selection
|
||||
sidebar_label: LoRa Antennas
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
The stock antennas provided with the T-Beam and other boards usually come from 'mixed bags'. They may not have been designed or tuned for your given frequency range, and they may not be of a quality design.
|
||||
|
||||
Matching an antenna to the transceiver frequency is important, as is choosing an appropriate design.
|
||||
|
||||
The antennas's design will affect:
|
||||
|
||||
- Efficiency - The proportion of the signal which leaves the antenna
|
||||
- Direction in which the signal is transmitted
|
||||
- Interference by horizontal or vertical polarization
|
||||
- Amount of signal which is reflected back to the device itself
|
||||
|
||||
:::caution
|
||||
While the LoRa devices we are using for Meshtastic are relatively low power radios, care should be taken _not_ to operate any radio transmission device without an aerial or with a poorly matched aerial. Un-transmitted radio signal reflected back to the transmitter can damage the device.
|
||||
:::
|
||||
|
||||
## Important considerations
|
||||
|
||||
### What transmission frequency are you using?
|
||||
- Devices on another frequency will not be able to interact with yours.
|
||||
- See this listing by [The Things Network](https://www.thethingsnetwork.org/docs/lorawan/frequencies-by-country.html) for frequencies licensed for specific countries.
|
||||
|
||||
### How will you be carrying / transporting the radio?
|
||||
- A large directional aerial will transmit over significantly greater distance than an omni-directional aerial. However, it must be pointed at its target so isn't optimal for mobile use.
|
||||
- A tuned half-wave whip aerial may have more omni-directional range than the quarter wave stubby; but it will be conspicuous in your pocket.
|
||||
- Many antennas, especially quarter wave stubby antennas, require the use of ground planes to transmit at peak performance.
|
||||
|
||||
### Do you want transmission in all directions?
|
||||
- While humans (mostly water) don't attenuate signal greatly (at LoRa frequencies), buildings & walls do.
|
||||
- If your aerial is permanently positioned against a building, signal transmitted towards the wall will be largely lost or attenuated.
|
||||
|
||||
### Does my Meshtastic device have the right power range, impedance, and connector for the aerial?
|
||||
- For the LoRa devices, it should be 50 Ohm impedance with SMA connector. Many antennas will be recommended for LoRa use in their technical details.
|
||||
- By contrast, a close range, contactless Personal Area Network antenna, or a huge aerial at the end of length of coax designed for a 100W transmitter, are not going to be operable.
|
||||
|
||||
|
||||
### Cost, quality, and supply service?
|
||||
- The perfect aerial on paper, sourced from the other side of the world with mixed reviews, doesn't compare to a local supplier who has spent time carefully collating all of the aerial data-sheets for comparison _and_ holds stock immediately available. Personally, I prefer to pay significantly more for a time saving, quality service.
|
||||
|
||||
### How close will the antenna be to my Meshtastic device?
|
||||
- Most cables will significantly degrade the signal strength over any significant distance. It is often more effective to place a node outside, than to have it indoors with the antenna outside. (The exception might be if there is extreme heat, cold, or humidity, and if the shortest possible low loss cable is used. Still, a proper enclosure should mitigate bad weather.)
|
||||
|
||||
## Terminology / references
|
||||
|
||||
You could do a lot worse than reading the [Wikipedia entry for Antenna](<https://en.wikipedia.org/wiki/Antenna_(radio)>), along with the [Wikipedia entry for LoRa](https://en.wikipedia.org/wiki/LoRa).
|
||||
|
||||
Instead of listing the terms, let us recommend this superb [tutorial](https://www.youtube.com/watch?v=J3PBL9oLPX8) by Andreas Spiess (the 'guy with the Swiss accent').
|
||||
|
|
@ -1,36 +0,0 @@
|
|||
---
|
||||
id: heltec
|
||||
title: Heltec device
|
||||
sidebar_label: Heltec
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
## WiFi LoRa 32 (V2) * Not Recommended - Support may be dropped
|
||||
|
||||
It continues to be a struggle to support this very old ESP32 chip, not officially supported in 1.3 / 2.0 and support may be dropped completely.
|
||||
|
||||
Using this device with a battery is not recommended.
|
||||
|
||||
- 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`
|
||||
|
||||
[<img src="Heltec WiFi LoRa 32 (V2)" src="/img/hardware/heltec-v2.png" style={{zoom:'25%'}} />](/img/hardware/heltec-v2.png)
|
||||
|
||||
[<img src="Heltec WiFi LoRa 32 (V2) Pinouts" src="/img/hardware/heltec_v2_pinmap.png" style={{zoom:'25%'}} />](/img/hardware/heltec_v2_pinmap.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://docs.heltec.org/en/node/esp32/dev-board/hardware_update_log.html) for more details
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
id: lora
|
||||
title: LILYGO® TTGO Lora devices
|
||||
sidebar_label: LILYGO® Lora
|
||||
sidebar_position: 2
|
||||
sidebar_position: 6
|
||||
---
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
|
|
|||
|
|
@ -2,14 +2,14 @@
|
|||
id: nano-g1
|
||||
title: Nano G1 device
|
||||
sidebar_label: Nano G1
|
||||
sidebar_position: 5
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
The Nano G1 is the first dedicated hardware 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.
|
||||
|
||||
Only the US 915 Mhz version is available currently. There should be an EU 868 Mhz version available in the future.
|
||||
|
||||
### Features:
|
||||
### Features
|
||||
|
||||
- Meshtastic pre-installed
|
||||
- ESP32 WROOM microprocessor - WiFi & Bluetooth
|
||||
|
|
@ -23,6 +23,8 @@ Only the US 915 Mhz version is available currently. There should be an EU 868 Mh
|
|||
- 1.3 inch OLED screen
|
||||
- Buzzer
|
||||
|
||||
### Resources
|
||||
|
||||
- Firmware file: `firmware-nano-g1-1.x.x.bin`
|
||||
- [Purchase link](https://www.tindie.com/products/neilhao/meshtastic-mesh-device-nano-edition/)
|
||||
|
||||
|
|
|
|||
32
docs/hardware/supported/station-g1.mdx
Normal file
32
docs/hardware/supported/station-g1.mdx
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
---
|
||||
id: station-g1
|
||||
title: Station G1 device
|
||||
sidebar_label: Station G1
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
The Station G1 is the first dedicated hardware 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.
|
||||
|
||||
Only the US 915 Mhz version is available currently. There should be an EU 433 Mhz version available in the future.
|
||||
|
||||
### Features
|
||||
|
||||
- Meshtastic pre-installed
|
||||
- ESP32 WROOM microprocessor - WiFi & Bluetooth
|
||||
- Semtech SX1262 - LoRa Transceiver
|
||||
- Frequency options:
|
||||
- 915 Mhz
|
||||
- Additional 35dBm Lora Power Amplifier to boost the transmit power
|
||||
- User button
|
||||
- 1.3 inch OLED screen
|
||||
- Optional GPS Module and IO Extension Socket
|
||||
- Optional 12V Battery Docker which can be used as Backup Power, or in scenarios that require mobility
|
||||
|
||||
### Resources
|
||||
|
||||
- Firmware file: `firmware-station-g1-1.x.x.bin`
|
||||
- [Purchase link](https://www.tindie.com/products/neilhao/meshtastic-mesh-device-station-edition/)
|
||||
|
||||
[<img alt="Station G1" src="https://uniteng.com/wiki/lib/exe/fetch.php?media=meshtastic:meshtastic_mesh_device_station_edition_overview.jpg" style={{zoom:'25%'}} />](https://uniteng.com/wiki/lib/exe/fetch.php?media=meshtastic:meshtastic_mesh_device_station_edition_overview.jpg)
|
||||
|
||||
Further information on the Station G1 can be found on [Unit Engineering's Wiki](https://uniteng.com/wiki/doku.php?id=meshtastic:station).
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
id: tbeam
|
||||
title: LILYGO® TTGO T-Beam devices
|
||||
sidebar_label: LILYGO® T-Beam
|
||||
sidebar_position: 1
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
|
@ -34,7 +34,6 @@ values={[
|
|||
- 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)
|
||||
|
||||
|
|
@ -42,7 +41,6 @@ values={[
|
|||
<!--[<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)-->
|
||||
[<img alt="LILYGO® TTGO T-Beam v1.1 pinmap" src="/img/hardware/t-beam_v1.1_pinmap.webp" style={{zoom:'35%'}} />](/img/hardware/t-beam_v1.1_pinmap.webp)
|
||||
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="m8n">
|
||||
|
||||
|
|
|
|||
|
|
@ -7,12 +7,6 @@ sidebar_position: 2
|
|||
|
||||
The T-Echo is the latest device to be release by LILYGO® supporting a low power consumption microcontroller.
|
||||
|
||||
### See [Getting Started](/docs/getting-started/flashing-firmware/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
|
||||
|
|
@ -24,6 +18,12 @@ The T-Echo is the latest device to be release by LILYGO® supporting a low power
|
|||
- Optional BME280 - Humidity and Pressure Sensor
|
||||
- Comes with a case and battery
|
||||
|
||||
### Resources
|
||||
|
||||
- Firmware file: `firmware-t-echo-2.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
|
||||
|
||||
<img
|
||||
alt="LILYGO T-Echo"
|
||||
src="/img/hardware/t-echo.png"
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Legal
|
||||
sidebar_label: Legal
|
||||
slug: /legal
|
||||
sidebar_position: 7
|
||||
sidebar_position: 9
|
||||
---
|
||||
|
||||
## Disclaimers
|
||||
|
|
|
|||
|
|
@ -94,7 +94,7 @@ sudo apt install -y python3 python3-pip python3-venv
|
|||
|
||||
For **Windows**, the [installer](https://github.com/meshtastic/Meshtastic-gui-installer/releases/tag/untagged-9a69e6946635cd38df7d) will manage installing python and flasher updates automatically.
|
||||
|
||||
For **MacOS** and **Linux**, it is recommended that you install using `pip`.
|
||||
For **macOS** and **Linux**, it is recommended that you install using `pip`.
|
||||
|
||||
<Tabs
|
||||
groupId="operating-system"
|
||||
|
|
|
|||
|
|
@ -38,10 +38,10 @@ export const DownloadCard = ({
|
|||
) : (
|
||||
<div>
|
||||
<a href={url}>
|
||||
<img style={{ height: '4rem' }} src={imgUrl}></img>
|
||||
<img alt="img1" style={{ height: '4rem' }} src={imgUrl}></img>
|
||||
</a>
|
||||
<a href={url2}>
|
||||
<img style={{ height: '4rem' }} src={imgUrl2}></img>
|
||||
<img alt="img2" style={{ height: '4rem' }} src={imgUrl2}></img>
|
||||
</a>
|
||||
</div>
|
||||
)}
|
||||
|
|
|
|||
|
|
@ -90,6 +90,15 @@ const Firmware = (): JSX.Element => {
|
|||
</div>
|
||||
<div className="m-auto flex flex-col gap-3">
|
||||
<h2>Android</h2>
|
||||
<a
|
||||
className="m-auto flex rounded-lg border-4 border-transparent bg-accent p-1 font-semibold text-black shadow-md hover:text-black hover:brightness-110 active:border-green-200"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
href="https://meshtastic.org/docs/software/android/#f-droid"
|
||||
>
|
||||
F-Droid
|
||||
<ArrowTopRightOnSquareIcon className="m-auto ml-2 h-4" />
|
||||
</a>
|
||||
<a
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
|
|
@ -99,15 +108,6 @@ const Firmware = (): JSX.Element => {
|
|||
Play Store
|
||||
<ArrowTopRightOnSquareIcon className="m-auto ml-2 h-4" />
|
||||
</a>
|
||||
<a
|
||||
className="absolute bottom-2 flex"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
href="https://meshtastic.org/docs/software/android/#f-droid"
|
||||
>
|
||||
F-Droid
|
||||
<ArrowTopRightOnSquareIcon className="m-auto ml-2 h-4" />
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -88,21 +88,21 @@ const SocialCards: SocialCardProps[] = [
|
|||
color: 'bg-[#5865F2]',
|
||||
link: 'https://discord.com/invite/UQJ5QuM7vq',
|
||||
children: (
|
||||
<img className="m-auto h-10" src="/img/homepage/Discord-Logo-White.svg" />
|
||||
<img alt="discord" className="m-auto h-10" src="/img/homepage/Discord-Logo-White.svg" />
|
||||
),
|
||||
},
|
||||
{
|
||||
color: 'bg-[#FF0000]',
|
||||
link: 'https://www.youtube.com/meshtastic',
|
||||
children: (
|
||||
<img className="m-auto h-16" src="/img/homepage/YouTube-Logo-White.svg" />
|
||||
<img alt="youtube" className="m-auto h-16" src="/img/homepage/YouTube-Logo-White.svg" />
|
||||
),
|
||||
},
|
||||
{
|
||||
color: 'bg-[#ffffff]',
|
||||
link: 'https://meshtastic.discourse.group',
|
||||
children: (
|
||||
<img
|
||||
<img alt="discourse"
|
||||
className="m-auto h-12"
|
||||
src="/img/homepage/Discourse-Logo-White.svg"
|
||||
/>
|
||||
|
|
@ -112,14 +112,14 @@ const SocialCards: SocialCardProps[] = [
|
|||
color: 'bg-[#FF4500]',
|
||||
link: 'https://reddit.com/r/meshtastic',
|
||||
children: (
|
||||
<img className="m-auto h-20" src="/img/homepage/Reddit-Logo-White.svg" />
|
||||
<img alt="reddit" className="m-auto h-20" src="/img/homepage/Reddit-Logo-White.svg" />
|
||||
),
|
||||
},
|
||||
{
|
||||
color: 'bg-[#ffffff]',
|
||||
link: 'https://github.com/meshtastic',
|
||||
children: (
|
||||
<img className="m-auto w-12" src="/img/homepage/GitHub-Logo-White.svg" />
|
||||
<img alt="github" className="m-auto w-12" src="/img/homepage/GitHub-Logo-White.svg" />
|
||||
),
|
||||
},
|
||||
];
|
||||
|
|
|
|||
Loading…
Reference in a new issue