Merge branches 'master' and 'master' of github.com:meshtastic/meshtastic
|
@ -1,40 +0,0 @@
|
|||
---
|
||||
id: faq
|
||||
title: Frequently Asked Questions
|
||||
sidebar_label: FAQ
|
||||
---
|
||||
|
||||
## Disclaimers
|
||||
|
||||
This project is still pretty young but moving at a pretty good pace. Not all features are fully implemented in the current alpha builds.
|
||||
Most of these problems should be solved by the beta release (within three months):
|
||||
|
||||
- We don't make these devices and they haven't been tested by UL or the FCC. If you use them you are experimenting and we can't promise they won't burn your house down ;-)
|
||||
- The encryption implementation is good but see this list of [caveats](/software/other/crypto.md#summary-of-strengthsweaknesses-of-our-current-implementation) to determine risks you might face.
|
||||
- A number of (straightforward) software work items have to be completed before battery life matches our measurements, currently battery life is about three days. Join us on chat if you want the spreadsheet of power measurements/calculations.
|
||||
- The Android API needs to be documented better
|
||||
- No one has written an iOS app yet. But some good souls [are talking about it](https://github.com/meshtastic/Meshtastic-esp32/issues/14) ;-)
|
||||
|
||||
For more details see the [device software TODO](https://github.com/meshtastic/Meshtastic-esp32/blob/master/docs/software/TODO.md) or the [Android app TODO](https://github.com/meshtastic/Meshtastic-Android/blob/master/TODO.md).
|
||||
|
||||
## FAQ
|
||||
|
||||
If you have a question missing from this faq, please [ask in our discussion forum](https://meshtastic.discourse.group/). And if you are feeling extra generous send in a pull-request for this faq.md with whatever we answered ;-).
|
||||
|
||||
### Q: Which of the various supported radios should I buy?
|
||||
|
||||
Basically you just need the radio + (optional but recommended) battery. The TBEAM is usually better because it has gps and huge battery socket. The Heltec is basically the same hardware but without the GPS (the phone provides position data to the radio in that case, so the behavior is similar - but it does burn some battery in the phone). Also the battery for the Heltec can be smaller.
|
||||
|
||||
In addition to Aliexpress, (banggood.com) usually has stock and faster shipping, or Amazon. If buying a TBEAM, make sure to buy a version that includes the OLED screen - this project doesn't absolutely require the screen, but we use it if is installed.
|
||||
|
||||
@claesg has added links to various 3D printable cases, you can see them at (www.meshtastic.org).
|
||||
|
||||
### Q: Do you have plans to commercialize this project
|
||||
|
||||
Nope. though if some other person/group wanted to use this software and a more customized device we think that would be awesome (as long as they obey the GPL license).
|
||||
|
||||
### Q: Does this project use patented algorithms?
|
||||
|
||||
(Kindly borrowed from the geeks at [ffmpeg](http://ffmpeg.org/legal.html))
|
||||
|
||||
We do not know, we are not lawyers so we are not qualified to answer this. Also we have never read patents to implement any part of this, so even if we were qualified we could not answer it as we do not know what is patented. Furthermore the sheer number of software patents makes it impossible to read them all so no one (lawyer or not) could answer such a question with a definite no. We are merely geeks experimenting on a fun and free project.
|
|
@ -2,5 +2,5 @@
|
|||
id: concepts
|
||||
title: Concepts
|
||||
sidebar_label: Concepts
|
||||
slug: /getting_started/concepts
|
||||
slug: /getting-started/concepts
|
||||
---
|
100
website/docs/getting-started/flashing-firmware/linux.md
Normal file
|
@ -0,0 +1,100 @@
|
|||
---
|
||||
id: linux
|
||||
title: Flashing Firmware – Linux
|
||||
sidebar_label: Linux
|
||||
---
|
||||
:::note
|
||||
To check if you have a data cable that will work, plug in your device and **then** navigate to `Terminal` and enter the following command:
|
||||
```bash
|
||||
lsusb
|
||||
```
|
||||
you should see something like `CP210X USB to UART Bridge Controller`.
|
||||
:::
|
||||
|
||||
## Download Firmware
|
||||
|
||||
<!--- TODO add buttons to links --->
|
||||
Download the [latest](https://github.com/meshtastic/meshtastic-device/releases/latest) firmware release. Unzip the file and locate the correct device and region within the list of prebuilt binaries.
|
||||
|
||||
## Command Line Instructions
|
||||
|
||||
:::note
|
||||
Check if you have `python3` and `pip` installed with the following command
|
||||
```bash
|
||||
python3 --version
|
||||
pip3 --version
|
||||
```
|
||||
If `python3` is not installed, install with
|
||||
```bash
|
||||
sudo apt-get update
|
||||
sudo apt-get install python3.6
|
||||
```
|
||||
If `pip` is not installed, install with
|
||||
```bash
|
||||
sudo apt-get install python3-pip
|
||||
```
|
||||
:::
|
||||
|
||||
1. Install `esptool`
|
||||
```bash
|
||||
pip install --upgrade esptool
|
||||
```
|
||||
2. Connect your radio to your USB port
|
||||
3. Confirm that your device is talking to your Mac by running the following command in Terminal
|
||||
```bash title="Command"
|
||||
esptool.py chip_id
|
||||
```
|
||||
```bash title="Expected Output"
|
||||
# You should see a result similar to this:
|
||||
mydir$ esptool.py chip_id
|
||||
esptool.py v2.6
|
||||
Found 2 serial ports
|
||||
Serial port /dev/ttyUSB0
|
||||
Connecting....
|
||||
Detecting chip type... ESP32
|
||||
Chip is ESP32D0WDQ6 (revision 1)
|
||||
Features: WiFi, BT, Dual Core, 240MHz, VRef calibration in efuse, Coding Scheme None
|
||||
MAC: 24:6f:28:b5:36:71
|
||||
Uploading stub...
|
||||
Running stub...
|
||||
Stub running...
|
||||
Warning: ESP32 has no Chip ID. Reading MAC instead.
|
||||
MAC: 24:6f:28:b5:36:71
|
||||
Hard resetting via RTS pin...
|
||||
```
|
||||
4. `cd` into the directory where you unzipped the latest release. For example:
|
||||
```bash title="Example"
|
||||
cd /Downloads/firmware/
|
||||
```
|
||||
5. Install the correct firmware for your board with
|
||||
:::caution
|
||||
Be very careful to install the correct load for your board. In particular the popular 'T-BEAM' radio from TTGO is not called 'TTGO-Lora' (that is a different board). So don't install the 'TTGO-Lora' build on a TBEAM, it won't work correctly.
|
||||
:::
|
||||
```bash title="Command"
|
||||
./device-install.sh -f firmware-BOARD-VERSION.bin
|
||||
```
|
||||
```bash title="Example"
|
||||
./device-install.sh -f firmware-heltec-EU865-1.2.0.bin
|
||||
```
|
||||
6. To update a the firmware on an existing Meshtastic device, run
|
||||
```bash title="Command"
|
||||
./device-update.sh -f firmware-BOARD-VERSION.bin
|
||||
```
|
||||
```bash title="Example"
|
||||
./device-update.sh -f firmware-heltec-EU865-1.2.0.bin
|
||||
```
|
||||
|
||||
## Graphical User Interface Instructions
|
||||
|
||||
:::note
|
||||
ESPHome Flasher for linux is a prebuilt binary for Ubuntu. These instructions were only testing on Ubuntu. Mileage may very on other distros. ESPHome Flasher also provides instructions to build from source or install via `pip` on their README.
|
||||
:::
|
||||
|
||||
1. Download [ESPHome Flasher](https://github.com/esphome/esphome-flasher)
|
||||
2. Connect your radio to your USB port.
|
||||
3. Open ESPHome Flasher. There should be no installation required.
|
||||
4. If your board is not showing under `Serial Port` then you may need to install the drivers for the [CP210X USB to UART bridge](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers).
|
||||
5. In ESPHome Flasher, refresh the serial ports and select the port to which your board is connected.
|
||||
6. Browse to the previously downloaded firmware and select the correct firmware based on the board type.
|
||||
7. Select Flash ESP.
|
||||
8. Once complete, “Done! Flashing is complete!” will be shown.
|
109
website/docs/getting-started/flashing-firmware/macos.md
Normal file
|
@ -0,0 +1,109 @@
|
|||
---
|
||||
id: macos
|
||||
title: Flashing Firmware – MacOS
|
||||
sidebar_label: MacOS
|
||||
---
|
||||
:::note
|
||||
To check if you have a data cable that will work, plug in your device and **then** navigate to `Apple Menu > About This Mac > System Report... > Hardware > USB` you should see something like `CP210X USB to UART Bridge Controller`.
|
||||
:::
|
||||
|
||||
## Download Firmware
|
||||
|
||||
<!--- TODO add buttons to links --->
|
||||
Download the [latest](https://github.com/meshtastic/meshtastic-device/releases/latest) firmware release. Unzip the file and locate the correct device and region within the list of prebuilt binaries.
|
||||
|
||||
## Command Line Instructions
|
||||
|
||||
OS X comes with `Python 2.7` installed, but not `pip`. The following uses Homebrew to install `python3` which includes `pip3`. On MacOS you will use `pip3` instead of `pip`.
|
||||
|
||||
:::note
|
||||
Check if you have Homebrew installed with the following command
|
||||
```bash
|
||||
brew -v
|
||||
```
|
||||
If it's not installed, follow the instructions on the [Homebrew website](https://brew.sh) before continuing.
|
||||
:::
|
||||
|
||||
1. Install Python3
|
||||
```bash
|
||||
brew install python3
|
||||
```
|
||||
2. Confirm `pip3` was installed alongside `python3`
|
||||
```bash
|
||||
pip3 -v
|
||||
```
|
||||
3. Install `esptool`
|
||||
```bash
|
||||
pip3 install --upgrade esptool
|
||||
```
|
||||
|
||||
:::note
|
||||
You may need to install a driver from Silicon Labs for the [CP210X USB to UART bridge](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)
|
||||
:::
|
||||
|
||||
4. Connect your radio to your USB port.
|
||||
5. Confirm that your device is talking to your Mac by running the following command in Terminal.
|
||||
```bash title="Command"
|
||||
esptool.py chip_id
|
||||
```
|
||||
```bash title="Expected Output"
|
||||
# You should see a result similar to this:
|
||||
mydir$ esptool.py chip_id
|
||||
esptool.py v2.6
|
||||
Found 2 serial ports
|
||||
Serial port /dev/ttyUSB0
|
||||
Connecting....
|
||||
Detecting chip type... ESP32
|
||||
Chip is ESP32D0WDQ6 (revision 1)
|
||||
Features: WiFi, BT, Dual Core, 240MHz, VRef calibration in efuse, Coding Scheme None
|
||||
MAC: 24:6f:28:b5:36:71
|
||||
Uploading stub...
|
||||
Running stub...
|
||||
Stub running...
|
||||
Warning: ESP32 has no Chip ID. Reading MAC instead.
|
||||
MAC: 24:6f:28:b5:36:71
|
||||
Hard resetting via RTS pin...
|
||||
```
|
||||
6. `cd` into the directory where you unzipped the latest release. For example:
|
||||
```bash title="Example"
|
||||
cd /Downloads/firmware/
|
||||
```
|
||||
7. Install the correct firmware for your board with
|
||||
:::caution
|
||||
Be very careful to install the correct load for your board. In particular the popular 'T-BEAM' radio from TTGO is not called 'TTGO-Lora' (that is a different board). So don't install the 'TTGO-Lora' build on a TBEAM, it won't work correctly.
|
||||
:::
|
||||
```bash title="Command"
|
||||
./device-install.sh -f firmware-BOARD-VERSION.bin
|
||||
```
|
||||
```bash title="Example"
|
||||
./device-install.sh -f firmware-heltec-EU865-1.2.0.bin
|
||||
```
|
||||
8. To update a the firmware on an existing Meshtastic device, run
|
||||
```bash title="Command"
|
||||
./device-update.sh -f firmware-BOARD-VERSION.bin
|
||||
```
|
||||
```bash title="Example"
|
||||
./device-update.sh -f firmware-heltec-EU865-1.2.0.bin
|
||||
```
|
||||
|
||||
## Graphical User Interface Instructions
|
||||
|
||||
:::note
|
||||
ESPHome Flasher also provides instructions to build from source or install via `pip` on their README.
|
||||
:::
|
||||
|
||||
1. Download [ESPHome Flasher](https://github.com/esphome/esphome-flasher)
|
||||
2. Connect your radio to your USB port.
|
||||
3. Open ESPHome Flasher. There should be no installation required.
|
||||
:::note
|
||||
If you get an error saying `The application "ESPHome-Flasher.app" can't be opened` it is likely a permissions issue. See [here](https://github.com/esphome/esphome-flasher/issues/26#issuecomment-671061140) for instructions.
|
||||
:::
|
||||
:::note
|
||||
If you get an error saying `"ESPHome-Flasher.app" cannot be opened because the developer cannot be verified`, click `cancel`. Right click on the application and select `Open`. Select `Open` on the confirmation alert.
|
||||
:::
|
||||
|
||||
4. If your board is not showing under `Serial Port` then you may need to install the drivers for the [CP210X USB to UART bridge](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers).
|
||||
5. In ESPHome Flasher, refresh the serial ports and select the port to which your board is connected.
|
||||
6. Browse to the previously downloaded firmware and select the correct firmware based on the board type.
|
||||
7. Select Flash ESP.
|
||||
8. Once complete, “Done! Flashing is complete!” will be shown.
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
id: flashing_firmware_ota
|
||||
id: ota
|
||||
title: Flashing Firmware – OTA
|
||||
sidebar_label: Over The Air
|
||||
slug: /getting_started/flashing_firmware/ota
|
||||
---
|
||||
:::caution
|
||||
Be very careful to install the correct load for your board. In particular the popular 'T-BEAM' radio from TTGO is not called 'TTGO-Lora' (that is a different board). So don't install the 'TTGO-Lora' build on a TBEAM, it won't work correctly.
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
id: flashing_firmware_overview
|
||||
id: overview
|
||||
title: Overview
|
||||
sidebar_label: Overview
|
||||
slug: /getting_started/flashing_firmware/overview
|
||||
---
|
||||
## Download Firmware
|
||||
|
||||
|
@ -16,11 +15,16 @@ Be very careful to install the correct load for your board. In particular the po
|
|||
| [Current Firmware](https://github.com/meshtastic/meshtastic-device/releases/latest) | [List of Firmware Versions](https://github.com/meshtastic/meshtastic-device/releases/) |
|
||||
| :--------------: | :-----------------------: |
|
||||
|
||||
Firmware Flashing Methods
|
||||
- [Command line interface](cli)
|
||||
- [Graphic user interface](gui)
|
||||
Firmware flashing methods
|
||||
- Command line interface
|
||||
- [Linux](linux#command-line-instructions)
|
||||
- [MacOS](macos#command-line-instructions)
|
||||
- [Windows](windows#command-line-instructions)
|
||||
- Graphical user interface
|
||||
- [Linux](linux#graphical-user-interface-instructions)
|
||||
- [MacOS](macos#graphical-user-interface-instructions)
|
||||
- [Windows](windows#graphical-user-interface-instructions)
|
||||
- [Over the air](ota)
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
For any issues during setup, search [our forum](https://meshtastic.discourse.group) to find a solution. If you can't find one, please post your problem, providing as much detail as possible.
|
||||
:::note
|
||||
Over the air (OTA) firmware installation is currently only available on the Android App.
|
||||
:::
|
90
website/docs/getting-started/flashing-firmware/windows.md
Normal file
|
@ -0,0 +1,90 @@
|
|||
---
|
||||
id: windows
|
||||
title: Flashing Firmware – Windows
|
||||
sidebar_label: Windows
|
||||
---
|
||||
:::note
|
||||
To check if you have a data cable that will work, plug in your device and navigate to `Device Manager > Ports` and ensure the device is shown. You should see something like `CP210X USB to UART Bridge Controller`.
|
||||
|
||||
If your device is showing up under `Device Manager > Ports > Other Devices` you need to install the driver from Silicon Labs for the [CP210X USB to UART bridge](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)
|
||||
:::
|
||||
## Download Firmware
|
||||
|
||||
<!--- TODO add buttons to links --->
|
||||
Download the [latest](https://github.com/meshtastic/meshtastic-device/releases/latest) firmware release. Unzip the file and locate the correct device and region within the list of prebuilt binaries.
|
||||
|
||||
## Command Line Instructions
|
||||
|
||||
1. Download and install [Python](https://www.python.org/). Make sure to click `Add Python X.Y to PATH`.
|
||||
2. Download and install [Gitbash](https://gitforwindows.org/) (or other appropriate shell) and run all subsequent commands from that shell.
|
||||
3. Confirm installation of `python` & `pip` with the following commands.
|
||||
```bash
|
||||
py --version
|
||||
```
|
||||
```bash
|
||||
pip --version
|
||||
```
|
||||
<!--- Check on `gitbash` requirements --->
|
||||
4. Install `esptool`
|
||||
```bash
|
||||
pip install --upgrade esptool
|
||||
```
|
||||
5. Connect your radio to your USB port.
|
||||
6. Confirm that your device is talking to your Mac by running the following command in Terminal.
|
||||
```bash title="Command"
|
||||
esptool.py chip_id
|
||||
```
|
||||
```bash title="Expected Output"
|
||||
# You should see a result similar to this:
|
||||
mydir$ esptool.py chip_id
|
||||
esptool.py v2.6
|
||||
Found 2 serial ports
|
||||
Serial port /dev/ttyUSB0
|
||||
Connecting....
|
||||
Detecting chip type... ESP32
|
||||
Chip is ESP32D0WDQ6 (revision 1)
|
||||
Features: WiFi, BT, Dual Core, 240MHz, VRef calibration in efuse, Coding Scheme None
|
||||
MAC: 24:6f:28:b5:36:71
|
||||
Uploading stub...
|
||||
Running stub...
|
||||
Stub running...
|
||||
Warning: ESP32 has no Chip ID. Reading MAC instead.
|
||||
MAC: 24:6f:28:b5:36:71
|
||||
Hard resetting via RTS pin...
|
||||
```
|
||||
7. `cd` into the directory where you unzipped the latest release. For example:
|
||||
```bash title="Example"
|
||||
cd /Downloads/firmware/
|
||||
```
|
||||
8. Install the correct firmware for your board with
|
||||
:::caution
|
||||
Be very careful to install the correct load for your board. In particular the popular 'T-BEAM' radio from TTGO is not called 'TTGO-Lora' (that is a different board). So don't install the 'TTGO-Lora' build on a TBEAM, it won't work correctly.
|
||||
:::
|
||||
```bash title="Command"
|
||||
./device-install.sh -f firmware-BOARD-VERSION.bin
|
||||
```
|
||||
```bash title="Example"
|
||||
./device-install.sh -f firmware-heltec-EU865-1.2.0.bin
|
||||
```
|
||||
9. To update a the firmware on an existing Meshtastic device, run
|
||||
```bash title="Command"
|
||||
./device-update.sh -f firmware-BOARD-VERSION.bin
|
||||
```
|
||||
```bash title="Example"
|
||||
./device-update.sh -f firmware-heltec-EU865-1.2.0.bin
|
||||
```
|
||||
|
||||
## Graphical User Interface Instructions
|
||||
|
||||
:::note
|
||||
ESPHome Flasher also provides instructions to build from source or install via `pip` on their README.
|
||||
:::
|
||||
|
||||
1. Download [ESPHome Flasher](https://github.com/esphome/esphome-flasher)
|
||||
2. Connect your radio to your USB port.
|
||||
3. Open ESPHome Flasher. There should be no installation required.
|
||||
4. If your board is not showing under `Serial Port` then you may need to install the drivers for the [CP210X USB to UART bridge](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers).
|
||||
5. In ESPHome Flasher, refresh the serial ports and select the port to which your board is connected.
|
||||
6. Browse to the previously downloaded firmware and select the correct firmware based on the board type.
|
||||
7. Select Flash ESP.
|
||||
8. Once complete, “Done! Flashing is complete!” will be shown.
|
|
@ -2,7 +2,7 @@
|
|||
id: overview
|
||||
title: Overview
|
||||
sidebar_label: Overview
|
||||
slug: /getting_started
|
||||
slug: /getting-started
|
||||
---
|
||||
|
||||
## Purchase a Radio
|
||||
|
@ -29,9 +29,9 @@ Prebuilt binaries for the supported radios are available in our releases. Your i
|
|||
|
||||
If your device already has Meshtastic flashed to it, You can update over the air (OTA). Otherwise you'll need a computer and a **data** USB cable.
|
||||
|
||||
- [Install using the command line interface (CLI)](getting_started/flashing_firmware/cli)
|
||||
- [Install using a graphical user interface (GUI)](getting_started/flashing_firmware/gui)
|
||||
- [Install using over-the-air (OTA)](getting_started/flashing_firmware/ota)
|
||||
- Install using the command line interface (CLI)
|
||||
- Install using a graphical user interface (GUI)
|
||||
- Install using over-the-air (OTA)
|
||||
|
||||
## Connect to your Device
|
||||
|
|
@ -1,77 +0,0 @@
|
|||
---
|
||||
id: flashing_firmware_cli
|
||||
title: Flashing Firmware – CLI
|
||||
sidebar_label: Command Line Interface
|
||||
slug: /getting_started/flashing_firmware/cli
|
||||
---
|
||||
|
||||
:::caution
|
||||
Be very careful to install the correct load for your board. In particular the popular 'T-BEAM' radio from TTGO is not called 'TTGO-Lora' (that is a different board). So don't install the 'TTGO-Lora' build on a TBEAM, it won't work correctly.
|
||||
:::
|
||||
|
||||
## Linux
|
||||
|
||||
Requires `Python` and `pip`
|
||||
|
||||
1. Download and unzip the latest Meshtastic firmware [release](https://github.com/meshtastic/Meshtastic-esp32/releases).
|
||||
2. `pip install --upgrade esptool` - Installs esptool on your machine
|
||||
3. Connect your radio to your USB port
|
||||
4. `esptool.py chip_id` - Confirm that your device is talking to your PC by running
|
||||
You should see something like:
|
||||
```
|
||||
mydir$ esptool.py chip_id
|
||||
esptool.py v2.6
|
||||
Found 2 serial ports
|
||||
Serial port /dev/ttyUSB0
|
||||
Connecting....
|
||||
Detecting chip type... ESP32
|
||||
Chip is ESP32D0WDQ6 (revision 1)
|
||||
Features: WiFi, BT, Dual Core, 240MHz, VRef calibration in efuse, Coding Scheme None
|
||||
MAC: 24:6f:28:b5:36:71
|
||||
Uploading stub...
|
||||
Running stub...
|
||||
Stub running...
|
||||
Warning: ESP32 has no Chip ID. Reading MAC instead.
|
||||
MAC: 24:6f:28:b5:36:71
|
||||
Hard resetting via RTS pin...
|
||||
```
|
||||
5. `cd` into the directory where you unzipped the latest release.
|
||||
6. Install the correct firmware for your board with `device-install.sh -f firmware-BOARD-VERSION.bin`
|
||||
```
|
||||
./device-install.sh -f firmware-heltec-1.2.x.bin
|
||||
```
|
||||
7. To update a the firmware on an existing Meshtastic device, run `device-update.sh -f firmware-BOARD-VERSION.bin`
|
||||
```
|
||||
./device-update.sh -f firmware-heltec-1.2.x.bin
|
||||
```
|
||||
|
||||
|
||||
|
||||
## MacOS
|
||||
|
||||
Installing on OS X through the commandline uses the same method as linux, but requires a slightly different method to install Python, pip and esptool.
|
||||
|
||||
OS X (10.15.3/Catalina) comes with Python 2.7 installed, but not pip.
|
||||
|
||||
:::note
|
||||
If you don't know if Homebrew is installed on your Mac, open terminal and enter the command `brew -v` if it doesn't work [install Homebrew](https://brew.sh) before continuing.
|
||||
:::
|
||||
|
||||
1. `brew install pyenv` - Installs PyEnv
|
||||
2. `pyenv install 3.7.7` - To install and select Python 3.7.7
|
||||
3. `pyenv global 3.7.7` - Selects the new version of Python
|
||||
4. `brew install pip` - Installs pip3
|
||||
5. `pip3 install --upgrade esptool` - Installs esptool
|
||||
|
||||
You may need to install a driver from Silicon Labs for the [CP210X USB to UART bridge](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)
|
||||
|
||||
6. Now install as per installing on the Linux commandline. Replace `pip` with `pip3` in your commands.
|
||||
|
||||
## Windows
|
||||
|
||||
Requires `Python`, `pip`, `Gitbash`
|
||||
|
||||
1. Download and install [Python](https://www.python.org/)
|
||||
2. If you have a recent version of Python, pip should be installed by default. Check using the command `py -m pip --version`. This will display the installed version of pip. If it returns an error, you will need to [install pip](https://pip.pypa.io/en/stable/installing/).
|
||||
3. Download and install [Gitbash](https://gitforwindows.org/) (or other appropriate shell)
|
||||
4. Run `gitbash` and complete the installation as per the instructions for linux commandline.
|
|
@ -1,24 +0,0 @@
|
|||
---
|
||||
id: flashing_firmware_gui
|
||||
title: Flashing Firmware – GUI
|
||||
sidebar_label: Graphic User Interface
|
||||
slug: /getting_started/flashing_firmware/gui
|
||||
---
|
||||
|
||||
:::caution
|
||||
Be very careful to install the correct load for your board. In particular the popular 'T-BEAM' radio from TTGO is not called 'TTGO-Lora' (that is a different board). So don't install the 'TTGO-Lora' build on a TBEAM, it won't work correctly.
|
||||
:::
|
||||
|
||||
## Windows & MacOS
|
||||
|
||||
1. Download and unzip the latest Meshtastic firmware [release](https://github.com/meshtastic/meshtastic-device/releases/latest).
|
||||
2. Download [ESPHome Flasher](https://github.com/esphome/esphome-flasher) following their installation instructions.
|
||||
3. Connect your radio to your USB port and open ESPHome Flasher.
|
||||
4. If your board is not showing under Serial Port then you likely need to install the drivers for the CP210X serial chip. In Windows you can check by searching “Device Manager” and ensuring the device is shown under “Ports”.
|
||||
5. If there is an error, download the [drivers](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers), then unzip and run the Installer application.
|
||||
6. In ESPHome Flasher, refresh the serial ports and select the port to which your board is connected.
|
||||
7. Browse to the previously downloaded firmware and select the correct firmware based on the board type.
|
||||
8. Select Flash ESP.
|
||||
9. Once complete, “Done! Flashing is complete!” will be shown.
|
||||
10. The board will boot and show the Meshtastic logo.
|
||||
11. Debug messages sent from the Meshtastic device can be viewed with a terminal program such as PuTTY. Within PuTTY, click “Serial”, enter the “Serial line” com port (can be found at step 4), enter “Speed” as `921600`, then click “Open”.
|
26
website/docs/hardware/heltec.md
Normal file
|
@ -0,0 +1,26 @@
|
|||
---
|
||||
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)
|
||||
|
82
website/docs/hardware/lora.md
Normal file
|
@ -0,0 +1,82 @@
|
|||
---
|
||||
id: lora-hardware
|
||||
title: LILYGO® TTGO Lora devices
|
||||
sidebar_label: LILYGO® Lora
|
||||
---
|
||||
|
||||
|
||||
## Lora V1
|
||||
|
||||
* ESP32 - Wifi & Bluetooth
|
||||
* SX1276 - LoRa Tranceiver
|
||||
* 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)
|
||||
|
||||
[<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)
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: supported_hardware
|
||||
id: supported-hardware
|
||||
title: Supported hardware
|
||||
sidebar_label: Supported hardware
|
||||
slug: /hardware/supported_hardware
|
||||
slug: /hardware/supported-hardware
|
||||
---
|
||||
|
|
113
website/docs/hardware/tbeam.md
Normal file
|
@ -0,0 +1,113 @@
|
|||
---
|
||||
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
|
||||
|
||||
|
||||
* ESP32 - Wifi & Bluetooth
|
||||
* SX1276 - LoRa Tranceiver
|
||||
* 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
|
||||
* SX1272 - 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)
|
11
website/docs/hardware/techo.md
Normal file
|
@ -0,0 +1,11 @@
|
|||
---
|
||||
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 appears to be nearing release. Once it is released we will update this page with more information.
|
||||
|
||||
<img alt="LILYGO T-Echo" src="/img/hardware/t-echo.png" style={{zoom: '15%'}} />
|
||||
|
||||
See this [recent tweet](https://twitter.com/lilygo9/status/1383323118756712457) from LILYGO® showing the function of the T-Echo.
|
10
website/docs/legal/licensing.md
Normal file
|
@ -0,0 +1,10 @@
|
|||
---
|
||||
id: licensing
|
||||
title: Licensing & Commercial Projects Usage
|
||||
sidebar_label: Licensing
|
||||
---
|
||||
You are hereby granted a two year non-exclusive license to use the Meshtastic® logo and trademark on your product/project. No fee is required for this usage, though if you wish keeping $1/unit set-aside so that it can eventually fund [meshtastic.org](https://meshtastic.org) it would be appreciated.
|
||||
|
||||
We only ask that you include a line in your support text that states:
|
||||
|
||||
> Meshtastic® is a registered trademark of Geeksville Industries LLC. Meshtastic software components are released under various licenses, see github for details. No warranty is provided - use at your own risk.
|
24
website/docs/legal/overview.md
Normal file
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
id: overview
|
||||
title: Overview
|
||||
sidebar_label: Overview
|
||||
slug: /legal
|
||||
---
|
||||
## Disclaimers
|
||||
|
||||
This project is still pretty young but moving at a pretty good pace. Not all features are fully implemented in the current alpha builds.
|
||||
|
||||
* We don't make these devices and they haven't been tested by UL or the FCC. If you use them you are experimenting and we can't promise they won't burn your house down ;-)
|
||||
* The encryption implementation is good but see this list of [caveats](/software/other/crypto.md#summary-of-strengthsweaknesses-of-our-current-implementation) to determine risks you might face.
|
||||
|
||||
## Legal FAQ
|
||||
|
||||
### Q: Do you have plans to commercialize this project
|
||||
|
||||
Nope. though if some other person/group wanted to use this software and a more customized device we think that would be awesome (as long as they obey the GPL license). [See more details here](licensing.md).
|
||||
|
||||
### Q: Does this project use patented algorithms?
|
||||
|
||||
(Kindly borrowed from the geeks at [ffmpeg](http://ffmpeg.org/legal.html))
|
||||
|
||||
We do not know, we are not lawyers so we are not qualified to answer this. Also we have never read patents to implement any part of this, so even if we were qualified we could not answer it as we do not know what is patented. Furthermore the sheer number of software patents makes it impossible to read them all so no one (lawyer or not) could answer such a question with a definite no. We are merely geeks experimenting on a fun and free project.
|
6
website/docs/legal/trademark.md
Normal file
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: trademark
|
||||
title: Trademark Rules & Brand Guidelines
|
||||
sidebar_label: Trademark
|
||||
---
|
||||
Meshtastic® is a registered trademark of Geeksville Industries LLC. Meshtastic software components are released under various licenses, see github for details. No warranty is provided - use at your own risk.
|
81
website/docs/software/web/config.md
Normal file
|
@ -0,0 +1,81 @@
|
|||
---
|
||||
id: web-config-software
|
||||
title: Initial configuration
|
||||
sidebar_label: Configuration
|
||||
---
|
||||
|
||||
## Manual Installation
|
||||
|
||||
Pre-requisite: You have Meshtastic Device firmware between version 1.0.32 - 1.1.50. A client for version 1.2.x will be released shortly and the documentation will be updated accordingly.
|
||||
|
||||
We do realize this installation method is not "easy" and are exploring ways to simplify this in the future, ideally rolling it out as part of the device firmware.
|
||||
|
||||
Once you have your device loaded with the Meshtastic Device firmware you need to connect to it's wifi and then manually upload the web interface files.
|
||||
|
||||
### Connect to device wifi
|
||||
|
||||
The easiest way to turn on the device wifi is to do the following after the device has been powered on:
|
||||
|
||||
* Hold down the user button
|
||||
* Press and release the reset button
|
||||
* Count to 2
|
||||
* Let go of the user button
|
||||
|
||||
:::note
|
||||
Some devices call this the “prog” button. On devices with two buttons where one is a reset button — it’s usually the other one. On T-beam devices it is the middle button.
|
||||
:::
|
||||
|
||||
The device will now go into WiFi SoftAP Admin Mode. In this mode, your device will broadcast the following credentials on a built in Access Point:
|
||||
|
||||
* SSID: meshtasticAdmin
|
||||
* Password: 12345678
|
||||
|
||||
:::note
|
||||
The first time your device restarts after enabling WiFi, it will take an additional 20-30 seconds to boot. This is to generate self-signed SSL keys. The keys will be saved for future reuse.
|
||||
:::
|
||||
|
||||
### Upload web interface files
|
||||
|
||||
Next download the three files (app.css.gz, app.js.gz and index.html.gz) from:
|
||||
|
||||
[https://github.com/meshtastic/meshtastic-web/releases](https://github.com/meshtastic/meshtastic-web/releases)
|
||||
|
||||
Then manually upload them to your device by going to:
|
||||
|
||||
* Hostname over mDNS
|
||||
* * [http://meshtastic.local/static](http://meshtastic.local/static)
|
||||
* If mDNS doesn't work for you
|
||||
* * http://{your device IP address here}/static
|
||||
* * Device IP address typically defaults to 192.168.42.1
|
||||
|
||||
The web interface application can then be accessed by visiting [http://meshtastic.local/](http://meshtastic.local/) or [http://192.168.42.1/](http://192.168.42.1/)
|
||||
|
||||
We do realize this is not "easy" and are exploring ways to simplify this in the future, ideally rolling it out as part of the device firmware.
|
||||
|
||||
### Wifi configuration
|
||||
|
||||
To enable the WiFi to access the web interface, you must at minimum set two preferences:
|
||||
|
||||
`wifi_ssid`
|
||||
`wifi_password`
|
||||
|
||||
For the wifi features to be enabled, those two properties must be set.
|
||||
|
||||
To turn it off, either of preference must be set as an empty string, that is a pair of double quotes each:
|
||||
|
||||
`wifi_ssid ""`
|
||||
`wifi_password ""`
|
||||
|
||||
Alternatively, you can enable the internal Soft Access Point:
|
||||
|
||||
`wifi_ap_mode true`
|
||||
|
||||
With that enabled, we will broadcast a new wifi network with the SSID and password you set. In AP mode, your device will act as a Captive Portal with a built in DNS server that resolves all name requests back to the device. Additionally, Apple Captive Portal Assistant is implemented -- if you're on an Apple device, the web interface will pop up automagically.
|
||||
|
||||
To turn it off, simply reboot the device.
|
||||
|
||||
Right now, the only way to set those preference is through the Meshtastic-python command line tool. At some point, we will be able to configure this from your mobile phone over Bluetooth.
|
||||
|
||||
:::note
|
||||
The first time your device restarts after enabling WiFi, it will take an additional 20-30 seconds to boot. This is to generate self-signed SSL keys. The keys will be saved for future reuse.
|
||||
:::
|
100
website/docs/software/web/development.md
Normal file
|
@ -0,0 +1,100 @@
|
|||
---
|
||||
id: web-development-software
|
||||
title: Information for developers of the web interface
|
||||
sidebar_label: Development
|
||||
---
|
||||
|
||||
|
||||
## Considerations
|
||||
|
||||
We have a total of 458752 bytes (448KB) available on the SPIFFS (Serial Peripheral Interface Flash File System) -- the on board storage of the ESP32. Of that space, let's not use more than half of that (224KB) in order to leave space for other uses.
|
||||
|
||||
Right now, the Meshtastic Device Preferences as well as SSL keys use that space. We can imagine other future uses as well such as logging chat messages and possibly saving received signal strength with GPS coordinates to create coverage heat maps.
|
||||
|
||||
## Static Files
|
||||
|
||||
Static files can be placed in the /data folder. All files should be compressed in the .gz format with a .gz extension regardless of the file type.
|
||||
|
||||
As an example, this would mean we will have files such as:
|
||||
|
||||
* style.css.gz
|
||||
* meshtastic.js.gz
|
||||
* meshtasticlogo.png.gz
|
||||
|
||||
Unless otherwise stated, files in the `/data` folder of the source code will be stored in `/static` on the device.
|
||||
|
||||
## Application Interface
|
||||
|
||||
We make extensive use of [Meshtastic.js](https://github.com/meshtastic/meshtastic.js).
|
||||
|
||||
## Embedded Server
|
||||
|
||||
### Root
|
||||
|
||||
When requesting to the root of the web server, the either /static/index.html or /static/index.html.gz will be fetched from the file system and served to the client. We require that the file is in the gzip format. Serving an uncompressed file is not supported. If both index.html and index.html.gz are on the filesystem, index.html will be served and index.html.gz will be ignored.
|
||||
|
||||
### /static
|
||||
|
||||
All files stored in /data/static in the Meshtastic source code will be available in /static on the Meshtastic device.
|
||||
|
||||
If a file is uploaded in a .gz format, the .gz extension will be stripped prior to being served to the client. Keep your filenames as short as possible. Short filenames work better than long file names.
|
||||
|
||||
An experimental file system browser with upload and delete capability is available by going to either:
|
||||
|
||||
* http://meshtastic.local/static
|
||||
* https://meshtastic.local/static
|
||||
|
||||
There are known issues with uploading files with large file sizes.
|
||||
|
||||
The current preferred method to upload data is through PlatformIO and the file system browser is provided without guarantees.
|
||||
|
||||
### /restart
|
||||
|
||||
A post to this location will cause the device to restart.
|
||||
|
||||
### /favicon.ico
|
||||
|
||||
The Meshtastic logo in .ico format.
|
||||
|
||||
### /hotspot-detect.html
|
||||
|
||||
Used by the Apple Captive Portal Assistant.
|
||||
|
||||
### /upload
|
||||
|
||||
End point to upload files. Used by the file manager.
|
||||
|
||||
### /json/report
|
||||
|
||||
Return a report of airtime statistics and current status.
|
||||
|
||||
Formula to calculate when the current time period will roll over:
|
||||
|
||||
`data.airtime.seconds_per_period - (data.airtime.seconds_since_boot % data.airtime.seconds_per_period)`
|
||||
|
||||
### /json/scanNetworks
|
||||
|
||||
Returns a json data structure of WiFi networks in the area. It's recommended to call this at least 2 or 3 times and combine the results.
|
||||
|
||||
We purposely exclude open (insecure) networks from the list.
|
||||
|
||||
### /json/spiffs/browse/static
|
||||
|
||||
Returns a json data structure with the contents of /static.
|
||||
|
||||
If a filename includes a '.gz' extension, will also return a modified version of the filename with the extension stripped. This is to support the functionality in /static (see above).
|
||||
|
||||
### /json/spiffs/delete/static
|
||||
|
||||
Delete file specified by the parameter "delete". Use the method "DELETE".
|
||||
|
||||
eg: /json/spiffs/delete/static?delete=static/something.txt
|
||||
|
||||
### Performance
|
||||
|
||||
As a general guide, the ESP32 will return HTTP requests significantly faster than HTTPS requests. For responses of 1kb or less, expect the following for real world performance:
|
||||
|
||||
HTTP - 3.0 requests / sec
|
||||
HTTPS - 0.4 requests / sec
|
||||
|
||||
The bottleneck of HTTPS is with the SSL handshake. We will get better performance serving one large file rather than multiple small files.
|
57
website/docs/software/web/partitions.md
Normal file
|
@ -0,0 +1,57 @@
|
|||
---
|
||||
id: web-partitions-software
|
||||
title: Managing ESP32 partitions
|
||||
sidebar_label: ESP32 partitions
|
||||
---
|
||||
|
||||
## Insufficient space to upload web interface files
|
||||
|
||||
This problem seems to occur when your board has the partitioning structure set incorrectly. This typically occurs when the board has had a firmware other than Meshtastic on it previously. In this situation, the file upload page on the device typically shows a free space of around 48,000 bytes, rather than the ~300,000 bytes that it should have free.
|
||||
|
||||

|
||||
|
||||
There are a number of methods that essentially involve erasing the flash and then re-uploading the Meshtastic firmware.
|
||||
|
||||
### Install Script
|
||||
|
||||
The most reliable way to fix this problem is to use the install script that is included in the meshtastic firmware zip. If that doesn’t work, these other methods may work:
|
||||
|
||||
### Alternative methods
|
||||
|
||||
#### Using the Arduino IDE:
|
||||
|
||||
https://meshtastic.discourse.group/t/solved-help-installing-with-other-than-esphome-flasher/2214/9
|
||||
|
||||
#### Using Pio in Windows
|
||||
```powershell
|
||||
pio run --target erase --environment tbeam
|
||||
```
|
||||
Then re-install the firmware ie using ESPHome Flasher
|
||||
|
||||
Requires: [Python](https://www.python.org/), [Pio](https://pypi.org/project/pio/), command to be run in the root directory of the meshtastic-device project once you’ve cloned it (this last requirement is an assumption based on pio not knowing what a tbeam is, may also require Visual Studio Code and PlatformIO as these were installed during use).
|
||||
|
||||
#### Esptool.py
|
||||
@1984 posted another method using the python based esptool.py to erase and re-flash the firmware:
|
||||
```bash
|
||||
esptool.py --baud 921600 erase_flash
|
||||
esptool.py --baud 921600 write_flash 0x1000 system-info.bin
|
||||
esptool.py --baud 921600 write_flash 0x00390000 spiffs-*.bin
|
||||
esptool.py --baud 921600 write_flash 0x10000 firmware-tbeam-EU865-1.1.42.bin
|
||||
```
|
||||
|
||||
Requires: [Python](https://www.python.org/) and [esptool.py](https://github.com/espressif/esptool)
|
||||
|
||||
#### Visual Studio & PlatformIO
|
||||
There is also the method of using the Visual Studio IDE. This requires having Visual Studio and PlatformIO installed, along with having cloned the meshtastic-device code as per the [build instructions](https://github.com/meshtastic/Meshtastic-device/blob/master/docs/software/build-instructions.md)<!-- link to be changed once build page is completed -->. After loading the project in Visual Studio, select the PlatformIO alien icon, then find the appropriate device, and then click the Erase Flash command.
|
||||
|
||||

|
||||
|
||||
https://meshtastic.discourse.group/t/configuring-channel-via-python-api/1948/17
|
||||
|
||||
Requires: [Visual Studio Code](https://code.visualstudio.com/), [PlatformIO](https://platformio.org/), cloned copy of the Meshtastic-device project
|
||||
|
||||
## How do I know it's worked?
|
||||
|
||||
Once it has been successfully erased and re-flashed, visiting https://192.168.42.1/static should leave you with free space on the order of 300,000 bytes, rather than the ~48,000 bytes you currently have. You can then upload the files from the meshtastic-web release.
|
||||
|
||||
Occasionally this may glitch when uploading the larger app.js.gz file, but a further erase and flash typically solves this.
|
35
website/docs/software/web/usage.md
Normal file
|
@ -0,0 +1,35 @@
|
|||
---
|
||||
id: web-usage-software
|
||||
title: Using the web interface
|
||||
sidebar_label: Usage
|
||||
---
|
||||
|
||||
Assuming your device is connected to a wireless network, push the User Button (that's the middle button on the T-Beam) until you get to the Network settings screen.
|
||||
|
||||
That screen will display four lines (example):
|
||||
|
||||
* WiFi: Software AP (Admin)
|
||||
* IP: 192.168.42.123 (0/4)
|
||||
* SSID: dogsRuleCatsDrool - alternating with - PWD: butDogsFearCats
|
||||
* http://meshtastic.local
|
||||
|
||||
If you have just one Meshtastic device on your network, the easiest thing to do is to go the URL printed on the display. That URL should work provided that mDNS (aka ZeroConf) is not blocked on your local network. If you have more than one device or there's a problem with mDNS name resolution, you will have to refer to the device's IP address.
|
||||
|
||||
|
||||
## Common Problems
|
||||
|
||||
### Problem: File not found: /static/index.html
|
||||
|
||||
Cause: This most likely means that the file system for the web server has not been loaded. You probably used esphome-flasher or some other GUI tool to flash the firmware.
|
||||
|
||||
Solutions:
|
||||
|
||||
Option 1) Flash the device with the `device-install.sh` script that comes packaged with the firmware zip file (you'll lose previous settings). Then follow the instructions under configuration to upload the web interface
|
||||
|
||||
Option 2) Flash the device with the OTA update from within the Android application.
|
||||
|
||||
Option 3) Flash the device with the SPIFFS instructions in platform.io.
|
||||
|
||||
### Insufficient space to upload new files
|
||||
|
||||
Cause: Typically a small partition has been set aside from previous firmware installed on the module. Instructions for how to fix this can be found on the [ESP32-Partitions](/docs/software/web/web-partitions-software) page.
|
11
website/docs/software/web/web-app.md
Normal file
|
@ -0,0 +1,11 @@
|
|||
---
|
||||
id: web-app-software
|
||||
title: Web interface overview
|
||||
sidebar_label: Overview
|
||||
---
|
||||
|
||||
The Meshtastic firmware incorporates an embedded webserver using the [ESP32 HTTPS Server](https://github.com/fhessel/esp32_https_server) project. This allows the wifi supporting ESP32 devices to run our web interface to access Meshtastic directly from your browser. This imports the [Meshtastic.js library](/docs/software/js/getting-started) to provide a web page capable of interacting with the device.
|
||||
|
||||
:::caution
|
||||
Please note that this is under active development and liable to change
|
||||
:::
|
|
@ -21,8 +21,8 @@ module.exports = {
|
|||
},
|
||||
items: [
|
||||
{
|
||||
to: "docs/getting_started",
|
||||
activeBasePath: "docs/getting_started",
|
||||
to: "docs/getting-started",
|
||||
activeBasePath: "docs/getting-started",
|
||||
label: "Getting Started",
|
||||
position: "left",
|
||||
},
|
||||
|
@ -65,7 +65,7 @@ module.exports = {
|
|||
items: [
|
||||
{
|
||||
label: "Getting Started",
|
||||
to: "docs/getting_started",
|
||||
to: "docs/getting-started",
|
||||
},
|
||||
{
|
||||
label: "Software",
|
||||
|
@ -101,6 +101,10 @@ module.exports = {
|
|||
label: "GitHub",
|
||||
href: "https://github.com/meshtastic/meshtastic",
|
||||
},
|
||||
{
|
||||
label: "Legal",
|
||||
to: "docs/legal",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
|
|
|
@ -1,18 +1,19 @@
|
|||
module.exports = {
|
||||
Sidebar: {
|
||||
"Getting Started": [
|
||||
"getting_started/about",
|
||||
"getting_started/overview",
|
||||
"getting-started/about",
|
||||
"getting-started/overview",
|
||||
{
|
||||
"Flashing Firmware": [
|
||||
"getting_started/flashing_firmware/flashing_firmware_overview",
|
||||
"getting_started/flashing_firmware/flashing_firmware_cli",
|
||||
"getting_started/flashing_firmware/flashing_firmware_gui",
|
||||
"getting_started/flashing_firmware/flashing_firmware_ota",
|
||||
"getting-started/flashing-firmware/overview",
|
||||
"getting-started/flashing-firmware/linux",
|
||||
"getting-started/flashing-firmware/macos",
|
||||
"getting-started/flashing-firmware/ota",
|
||||
"getting-started/flashing-firmware/windows",
|
||||
],
|
||||
"Howto's": [],
|
||||
},
|
||||
"getting_started/concepts",
|
||||
"getting-started/concepts",
|
||||
],
|
||||
Software: [
|
||||
"software/overview",
|
||||
|
@ -51,6 +52,15 @@ module.exports = {
|
|||
"software/plugins/environment-plugin",
|
||||
],
|
||||
},
|
||||
{
|
||||
"Web interface": [
|
||||
"software/web/web-app-software",
|
||||
"software/web/web-config-software",
|
||||
"software/web/web-usage-software",
|
||||
"software/web/web-partitions-software",
|
||||
"software/web/web-development-software",
|
||||
],
|
||||
},
|
||||
{
|
||||
Other: [
|
||||
"software/other/sw-design",
|
||||
|
@ -73,7 +83,14 @@ module.exports = {
|
|||
],
|
||||
Hardware: [
|
||||
"hardware/overview",
|
||||
"hardware/supported_hardware",
|
||||
{
|
||||
"Supported Hardware": [
|
||||
"hardware/tbeam-hardware",
|
||||
"hardware/lora-hardware",
|
||||
"hardware/heltec-hardware",
|
||||
"hardware/techo-hardware",
|
||||
],
|
||||
},
|
||||
"hardware/behaviour",
|
||||
"hardware/antenna",
|
||||
],
|
||||
|
@ -87,11 +104,15 @@ module.exports = {
|
|||
Device: [
|
||||
"developers/device/radio-settings",
|
||||
"developers/device/supported-hardware",
|
||||
"developers/device/faq",
|
||||
"developers/device/http-api",
|
||||
"developers/device/documents",
|
||||
],
|
||||
},
|
||||
],
|
||||
Legal: [
|
||||
"legal/overview",
|
||||
"legal/licensing",
|
||||
"legal/trademark",
|
||||
],
|
||||
},
|
||||
};
|
||||
|
|
BIN
website/static/img/hardware/heltec-v2.png
Normal file
After Width: | Height: | Size: 439 KiB |
BIN
website/static/img/hardware/link.png
Normal file
After Width: | Height: | Size: 659 KiB |
BIN
website/static/img/hardware/lora-v1.3.png
Normal file
After Width: | Height: | Size: 471 KiB |
BIN
website/static/img/hardware/lora-v1.png
Normal file
After Width: | Height: | Size: 956 KiB |
BIN
website/static/img/hardware/lora-v2.0.png
Normal file
After Width: | Height: | Size: 541 KiB |
BIN
website/static/img/hardware/lora-v2.1-1.6.png
Normal file
After Width: | Height: | Size: 463 KiB |
BIN
website/static/img/hardware/meshtastic-logo.png
Normal file
After Width: | Height: | Size: 5.9 KiB |
BIN
website/static/img/hardware/screen.png
Normal file
After Width: | Height: | Size: 459 KiB |
BIN
website/static/img/hardware/t-beam-m8n.png
Normal file
After Width: | Height: | Size: 568 KiB |
BIN
website/static/img/hardware/t-beam-meshtastic.png
Normal file
After Width: | Height: | Size: 562 KiB |
BIN
website/static/img/hardware/t-beam-sx1262.png
Normal file
After Width: | Height: | Size: 751 KiB |
BIN
website/static/img/hardware/t-beam-v0.7.png
Normal file
After Width: | Height: | Size: 533 KiB |
BIN
website/static/img/hardware/t-beam-v1.1.png
Normal file
After Width: | Height: | Size: 378 KiB |
BIN
website/static/img/hardware/t-echo.png
Normal file
After Width: | Height: | Size: 12 MiB |