mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-09-19 23:57:31 -07:00
Merge pull request #331 from jfirwin/getting-started
Getting started fixes
This commit is contained in:
Foster Irwin
GitHub
commit
f4bfbd7d7e
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
id: clients
|
||||
title: Meshtastic Clients
|
||||
sidebar_label: Meshtastic Clients
|
||||
title: Connect to Clients
|
||||
sidebar_label: Connect to Clients
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
import { DownloadCard } from '/src/pages/downloads/_components/DownloadCard.tsx';
|
||||
|
|
@ -104,4 +105,4 @@ The web interface is available for all browsers, but [bluetooth and serial capab
|
|||
|
||||
The Meshtastic firmware incorporates an embedded web server 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.
|
||||
|
||||
There is active development ongoing to fix some issues with updating the web interface from the web interface directly. Please be patient with us as we work on this. Use [Meshtastic-flasher](/docs/getting-started/meshtastic-flasher) to update your device to the current stable build which includes the web interface.
|
||||
There is active development ongoing to fix some issues with updating the web interface from the web interface directly. Please be patient with us as we work on this. Use [Meshtastic-flasher](/docs/getting-started/flashing-firmware/meshtastic-flasher) to update your device to the current stable build which includes the web interface.
|
||||
81
docs/getting-started/first-steps/configuration.mdx
Normal file
81
docs/getting-started/first-steps/configuration.mdx
Normal file
|
|
@ -0,0 +1,81 @@
|
|||
---
|
||||
id: configuration
|
||||
title: Configure Device
|
||||
sidebar_label: Configure Device
|
||||
sidebar_position: 2
|
||||
---
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
The following are important steps you should take before transmitting any messages. Make sure that you have flashed your device with Meshtastic and connected with a client before proceeding.
|
||||
|
||||
### Set Region
|
||||
|
||||
:::important
|
||||
Make sure to set your `region` to the correct region so you don't transmit on an incorrect frequency.
|
||||
:::
|
||||
|
||||
The `region` variable sets which region your radio is configured to work in. It is important to ensure that you've set it to the correct region. If left `Unset`, it will default to `US` settings.
|
||||
|
||||
| Name | Center Frequency | Spacing | Number of Channels | Power Limit |
|
||||
| :---: | :--------------: | :-----: | :----------------: | :---------: |
|
||||
| US | 903.08 | 2.16 | 13 | 0 |
|
||||
| EU433 | 433.175 | 0.2 | 8 | 0 |
|
||||
| EU868 | 865.2 | 0.3 | 10 | 0 |
|
||||
| CN | 470.0 | 2.0 | 20 | 0 |
|
||||
| JP | 920.0 | 0.5 | 10 | 13 |
|
||||
| ANZ | 916.0 | 0.5 | 20 | 0 |
|
||||
| KR | 921.9 | 0.2 | 8 | 0 |
|
||||
| TW | 923.0 | 0.2 | 10 | 0 |
|
||||
| RU | 868.9 | 0.2 | 2 | 20 |
|
||||
| Unset | 903.08 | 2.16 | 13 | 0 |
|
||||
|
||||
:::note
|
||||
For more details about `region` settings, you can see the source code [here](https://github.com/meshtastic/Meshtastic-device/blob/master/src/mesh/RadioInterface.cpp)
|
||||
:::
|
||||
| Setting | Acceptable Values | Default |
|
||||
| :--: | :---: | :------: |
|
||||
| region | `Unset`, `US`, `EU433`, `EU865`, `CN`, `JP`, `ANZ`, `KR`, `TW`, `RU` | `Unset` |
|
||||
|
||||
<Tabs
|
||||
groupId="settings"
|
||||
defaultValue="cli"
|
||||
values={[
|
||||
{label: 'CLI', value: 'cli'},
|
||||
{label: 'Android', value: 'android'},
|
||||
{label: 'iOS', value: 'iOS'},
|
||||
{label: 'Web', value: 'web'},
|
||||
]}>
|
||||
<TabItem value="cli">
|
||||
|
||||
```shell title="Unset Region"
|
||||
meshtastic --set region Unset
|
||||
```
|
||||
|
||||
```shell title="Set Region"
|
||||
meshtastic --set region US
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="android">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="iOS">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="web">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
11
docs/getting-started/first-steps/index.mdx
Normal file
11
docs/getting-started/first-steps/index.mdx
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
---
|
||||
id: first-steps
|
||||
title: First Steps
|
||||
sidebar_label: First Steps
|
||||
sidebar_position: 2
|
||||
---
|
||||
Congratulations! Your device should now be running Meshtastic! The next few pages should help you connect to your device and do some important initial configuration. After that, you'll be able to begin testing out your device on the mesh. Welcome to Meshtastic!
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
Hopefully your firmware flashing 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.
|
||||
|
|
@ -1,21 +1,9 @@
|
|||
---
|
||||
id: first-steps
|
||||
title: First Steps
|
||||
sidebar_label: First Steps
|
||||
id: tests
|
||||
title: Mesh Testing
|
||||
sidebar_label: Mesh Testing
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
Congratulations! Your node should now be running Meshtastic and hopefully you've paired to a client on your mobile device, desktop, or browser.
|
||||
|
||||
## Configuration
|
||||
|
||||
:::important
|
||||
Make sure to set your `region` to the correct region so you don't transmit on an incorrect frequency.
|
||||
:::
|
||||
|
||||
## Connection Tests
|
||||
|
||||
### Connect via USB and CLI
|
||||
|
||||
If you have at least two radios with the Meshtastic firmware, you may consider connecting one via USB and the other battery powered. Communicate with the USB radio using a CLI like [Meshtastic-python](/docs/software/python/python-installation).
|
||||
|
|
@ -51,7 +39,3 @@ The Android app is currently more robust than the iOS app. But, they both should
|
|||
- Verify that all radios are receiving the message(s). Might have to click on the button on the radio(s) to see most recent message.
|
||||
- Open up a browser to http://meshtastic.local to view the web UI (currently under development). You may need to open http://meshtastic.local/static )
|
||||
- If you want to switch back to Bluetooth, you will need to set the _wifi_ssid_ and _wifi_password_ values to blank values (ex: `meshtastic --set wifi_ssid '' --set wifi_password ''`).
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
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.
|
||||
|
|
@ -1,19 +1,24 @@
|
|||
---
|
||||
id: flashing-esp32
|
||||
title: Flashing ESP32 devices firmware
|
||||
sidebar_label: ESP32 devices
|
||||
pagination_prev: getting-started/flashing-firmware
|
||||
pagination_next: getting-started/clients
|
||||
sidebar_label: Manual Method - ESP32 devices
|
||||
pagination_prev: getting-started/flashing-firmware/flashing-firmware
|
||||
pagination_next: getting-started/first-steps/first-steps
|
||||
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!
|
||||
:::
|
||||
|
||||
## Prerequisites
|
||||
|
||||
### Device connectivity
|
||||
|
||||
Ensure your computer is communicating with the device correctly by following [these instructions](flashing-firmware).
|
||||
Ensure your computer is communicating with the device correctly by following [these instructions](/docs/getting-started/flashing-firmware/).
|
||||
|
||||
### Download Latest Firmware
|
||||
|
||||
|
|
@ -1,19 +1,24 @@
|
|||
---
|
||||
id: flashing-nrf52
|
||||
title: Flashing nRF52 devices firmware
|
||||
sidebar_label: nRF52 devices
|
||||
pagination_prev: getting-started/flashing-firmware
|
||||
pagination_next: getting-started/clients
|
||||
sidebar_label: Manual Method - NRF52 devices
|
||||
pagination_prev: getting-started/flashing-firmware/flashing-firmware
|
||||
pagination_next: getting-started/first-steps/first-steps
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
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!
|
||||
:::
|
||||
|
||||
## Prerequisites
|
||||
|
||||
### Device connectivity
|
||||
|
||||
Ensure your computer is communicating with the device correctly by following [these instructions](flashing-firmware).
|
||||
Ensure your computer is communicating with the device correctly by following [these instructions](/docs/getting-started/flashing-firmware/).
|
||||
|
||||
### Download Latest Firmware
|
||||
|
||||
|
|
@ -24,7 +29,7 @@ Firmware can be downloaded from the [Downloads](/downloads) page. Your initial i
|
|||
Please ensure that you have updated the bootloader to the latest version using the information on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK4631/Quickstart/#how-to-check-if-you-have-the-updated-rak4631-bootloader) website.
|
||||
|
||||
:::tip
|
||||
[Meshtastic Flasher](meshtastic-flasher) can assist you in updating the bootloader to the latest version.
|
||||
[Meshtastic Flasher](/docs/getting-started/flashing-firmware/meshtastic-flasher) can assist you in updating the bootloader to the latest version.
|
||||
:::
|
||||
|
||||
## Install/Update Firmware
|
||||
|
|
@ -1,12 +1,17 @@
|
|||
---
|
||||
id: flashing-firmware
|
||||
title: Firmware Flashing Prerequisites
|
||||
sidebar_label: Prerequisites
|
||||
sidebar_label: Flashing Firmware
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
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!
|
||||
:::
|
||||
|
||||
## Overview
|
||||
|
||||
Before you flash your device it is prudent to verify that we have proper connectivity with the device being flashed. Outlined below are steps that can be taken to verify connectivity and, if necessary, to install the appropriate drivers. If you end up needing to install drivers be sure to reboot your computer afterwards to verify the installation is complete.
|
||||
|
|
@ -1,12 +1,18 @@
|
|||
---
|
||||
id: meshtastic-flasher
|
||||
title: Using Meshtastic Flasher
|
||||
sidebar_label: Using Meshtastic Flasher
|
||||
pagination_next: getting-started/clients
|
||||
sidebar_label: Meshtastic Flasher Method
|
||||
pagination_next: getting-started/first-steps/first-steps
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
import Link from '@docusaurus/Link';
|
||||
|
||||
:::caution
|
||||
Make sure not to power the radio on without first attaching the antenna! You could damage the radio chip!
|
||||
:::
|
||||
|
||||
## Overview
|
||||
|
||||
|
|
@ -53,8 +59,10 @@ python3 --version
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
#### Install `python3`
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
Install/Update `python3`
|
||||
</summary>
|
||||
<Tabs
|
||||
groupId="operating-system"
|
||||
defaultValue="linux"
|
||||
|
|
@ -86,6 +94,8 @@ sudo apt install -y python3 python3-pip python3-venv
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
</details>
|
||||
|
||||
### Install App
|
||||
|
||||
This is the preferred installation method for `meshtastic-flasher`.
|
||||
|
|
@ -123,18 +133,38 @@ meshtastic-flasher
|
|||
</TabItem>
|
||||
<TabItem value="macos">
|
||||
|
||||
To install `meshtastic-flasher`, download Meshtastic-flasher.app.zip from https://github.com/meshtastic/Meshtastic-gui-installer/releases/tag/macapp1.0.0 , unzip and drag to /Applications.
|
||||
<div className="indexCtasBody">
|
||||
<Link
|
||||
className={'button button--outline button--lg cta--button'}
|
||||
to={'https://github.com/meshtastic/Meshtastic-gui-installer/releases/tag/macapp1.0.0'}
|
||||
>
|
||||
Download macOS application
|
||||
</Link>
|
||||
</div>
|
||||
|
||||
Once downloaded, unzip the file and drag it to `~/Applications`. It may take a moment to load as it downloads dependencies required to interact with your device, so be patient. The first time running it can take a few minutes.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="windows">
|
||||
|
||||
To install meshtastic-flasher, download meshtastic-flasher.zip from https://github.com/meshtastic/Meshtastic-gui-installer/releases/tag/winapp1.0.3, unzip and run.
|
||||
<div className="indexCtasBody">
|
||||
<Link
|
||||
className={'button button--outline button--lg cta--button'}
|
||||
to={'https://github.com/meshtastic/Meshtastic-gui-installer/releases/tag/winapp1.0.3'}
|
||||
>
|
||||
Download Windows application
|
||||
</Link>
|
||||
</div>
|
||||
|
||||
Once downloaded, unzip the file and run it. It may take a moment to load as it downloads dependencies required to interact with your device, so be patient. The first time running it can take a few minutes.
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### Install using `pip`
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
Install using `pip`
|
||||
</summary>
|
||||
This option is typically for developers.
|
||||
|
||||
<Tabs
|
||||
|
|
@ -213,6 +243,8 @@ meshtastic-flasher
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
</details>
|
||||
|
||||
## Flashing the Device
|
||||
|
||||
The Meshtastic Flasher will flash the latest firmware to esp32 and nrf52 devices. This is a newly developed application (as of February 1, 2022), so there may be some issues discovered as it is tested by users.
|
||||
|
|
@ -94,7 +94,7 @@ There are many ways to connect to your new radio!
|
|||
<div className="indexCtasBody">
|
||||
<Link
|
||||
className={'button button--outline button--lg cta--button'}
|
||||
to={'/docs/getting-started/clients'}
|
||||
to={'/docs/getting-started/first-steps/clients'}
|
||||
>
|
||||
Connect to Node
|
||||
</Link>
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ sidebar_position: 4
|
|||
|
||||
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-nrf52)
|
||||
### See [Getting Started](/docs/getting-started/flashing-firmware/flashing-nrf52)
|
||||
|
||||
- firmware file: `firmware-t-echo-1.x.x.uf2`
|
||||
- [Purchase link](https://www.aliexpress.com/item/1005002842456390.html)
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ The method with the least platform support, uses the [Web Serial API](https://we
|
|||
|
||||
## Updating
|
||||
|
||||
The web interface is now included in firmware releases. There is active development ongoing to fix some issues with updating the web interface from the web interface directly. Please be patient with us as we work on this. Use [Meshtastic-flasher](/docs/getting-started/meshtastic-flasher) to update your device to the current stable build which includes the web interface.
|
||||
The web interface is now included in firmware releases. There is active development ongoing to fix some issues with updating the web interface from the web interface directly. Please be patient with us as we work on this. Use [Meshtastic-flasher](/docs/getting-started/flashing-firmware/meshtastic-flasher) to update your device to the current stable build which includes the web interface.
|
||||
|
||||
:::warning
|
||||
|
||||
|
|
@ -65,7 +65,7 @@ The first time your device restarts after enabling WiFi, it will take an additio
|
|||
### Problem: File not found: /static/index.html
|
||||
|
||||
:::note
|
||||
This issue is likely found on old versions of the web interface. Device firmware now includes the web interface and the file system has been changed. Flashing the device with [Meshtastic-flasher](/docs/getting-started/meshtastic-flasher) will update you to the current web interface. Access to the files in the filesystem is actively being developed, but is not currently available.
|
||||
This issue is likely found on old versions of the web interface. Device firmware now includes the web interface and the file system has been changed. Flashing the device with [Meshtastic-flasher](/docs/getting-started/flashing-firmware/meshtastic-flasher) will update you to the current web interface. Access to the files in the filesystem is actively being developed, but is not currently available.
|
||||
:::
|
||||
|
||||
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.
|
||||
|
|
@ -81,7 +81,7 @@ Option 3) Flash the device with the SPIFFS instructions in platform.io.
|
|||
### Insufficient space to upload new files
|
||||
|
||||
:::note
|
||||
This issue is likely found on old versions of the web interface. Device firmware now includes the web interface and the file system has been changed. Flashing the device with [Meshtastic-flasher](/docs/getting-started/meshtastic-flasher) will update you to the current web interface. Access to the files in the filesystem is actively being developed, but is not currently available.
|
||||
This issue is likely found on old versions of the web interface. Device firmware now includes the web interface and the file system has been changed. Flashing the device with [Meshtastic-flasher](/docs/getting-started/flashing-firmware/meshtastic-flasher) will update you to the current web interface. Access to the files in the filesystem is actively being developed, but is not currently available.
|
||||
:::
|
||||
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ sidebar_label: ESP32 partitions
|
|||
---
|
||||
|
||||
:::caution
|
||||
It has been reported that some of this information is out of date. Flashing the device with [Meshtastic-flasher](/docs/getting-started/meshtastic-flasher) should fix these partition issues and update you to the current web interface.
|
||||
It has been reported that some of this information is out of date. Flashing the device with [Meshtastic-flasher](/docs/getting-started/flashing-firmware/meshtastic-flasher) should fix these partition issues and update you to the current web interface.
|
||||
|
||||
FIXME - Investigate and rewrite document to reflect the current ESP32 Partition mitigation.
|
||||
:::
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ const Firmware = (): JSX.Element => {
|
|||
'To download using ',
|
||||
<code>pip</code>,
|
||||
' follow ',
|
||||
<a href="/docs/getting-started/meshtastic-flasher#install-using-pip">
|
||||
<a href="/docs/getting-started/flashing-firmware/meshtastic-flasher#install-using-pip">
|
||||
these instructions
|
||||
</a>,
|
||||
'.',
|
||||
|
|
@ -149,7 +149,7 @@ const Firmware = (): JSX.Element => {
|
|||
</ul>
|
||||
Once downloaded, follow the flashing instructions for{' '}
|
||||
<a
|
||||
href="/docs/getting-started/flashing-esp32"
|
||||
href="/docs/getting-started/flashing-firmware/flashing-esp32"
|
||||
rel="noreferrer"
|
||||
target="_blank"
|
||||
>
|
||||
|
|
@ -157,7 +157,7 @@ const Firmware = (): JSX.Element => {
|
|||
</a>
|
||||
,{' '}
|
||||
<a
|
||||
href="/docs/getting-started/flashing-nrf52"
|
||||
href="/docs/getting-started/flashing-firmware/flashing-nrf52"
|
||||
rel="noreferrer"
|
||||
target="_blank"
|
||||
>
|
||||
|
|
@ -165,7 +165,7 @@ const Firmware = (): JSX.Element => {
|
|||
</a>
|
||||
, or the{' '}
|
||||
<a
|
||||
href="/docs/getting-started/meshtastic-flasher"
|
||||
href="/docs/getting-started/flashing-firmware/meshtastic-flasher"
|
||||
rel="noreferrer"
|
||||
target="_blank"
|
||||
>
|
||||
|
|
|
|||
Loading…
Reference in a new issue