mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-11-09 23:24:10 -08:00
Merge branch 'clean-getting-started' of https://github.com/jfirwin/Meshtastic into jfirwin-clean-getting-started
This commit is contained in:
Sacha Weatherstone
commit
c5caac6706
|
|
@ -5,6 +5,8 @@ sidebar_label: Channels
|
|||
---
|
||||
## Overview
|
||||
|
||||
Meshtastic Channels: Can create a *somewhat* secure method of communication on the same mesh network. The channel can be encrypted to prevent normal people from listening in on the traffic. But, it could probably be easily [cracked](https://crypto.stackexchange.com/questions/46559/what-are-the-chances-that-aes-256-encryption-is-cracked) by determined individuals. See [Channel Config](https://meshtastic.org/docs/software/settings/channel) for more info. It is also possible that your location could be triangulated by determined individuals.
|
||||
|
||||
## Channels
|
||||
|
||||
### Primary Channel
|
||||
|
|
|
|||
|
|
@ -5,6 +5,8 @@ sidebar_label: Internet Connectivity
|
|||
---
|
||||
## Overview
|
||||
|
||||
Captive Portal: Using Meshtastic, you can create a separate Wifi network for you join your phone or computer on a mesh network. See [Web Interface](https://meshtastic.org/docs/software/web/web-app-software) for more info. This is ideal in a situation where you are remote, such as in the forest, on a mountain, or if there is a major power/internet outage such as in a storm or other disaster.
|
||||
|
||||
## Features using Internet Connectivity
|
||||
|
||||
### MQTT
|
||||
|
|
|
|||
|
|
@ -5,6 +5,8 @@ sidebar_label: Mesh Routing
|
|||
---
|
||||
## Overview
|
||||
|
||||
Mesh Networking: An interconnected network by using [low-power radios](https://meshtastic.org/docs/hardware) to connect other low-power radios using LoRa to be able to send and receive messages and data. This can be completely separate from any other networks such as the internet. You can start small and get two devices to start experimenting. Do not expect to stream music or videos as LoRa is intended for smaller, lower bandwidth type uses such as text communication.
|
||||
|
||||
## Devices
|
||||
|
||||
## Routers
|
||||
|
|
|
|||
18
docs/faq/bluetooth.md
Normal file
18
docs/faq/bluetooth.md
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
id: bluetooth
|
||||
title: FAQs - Bluetooth
|
||||
sidebar_label: Bluetooth
|
||||
---
|
||||
## Overview
|
||||
|
||||
### How do I pair my phone to the device if my device doesn't have a screen?
|
||||
|
||||
Use [Wifi](https://meshtastic.org/docs/software/device/device-wifi) or Bluetooth with screenless pairing: before you initiate pairing, double click on the device button. The LED will blink 3 times in confirmation and the PIN will be set temporarily to `123456`.
|
||||
|
||||
### Can I have Bluetooth enabled and use WiFi radio?
|
||||
|
||||
No. Only one method will work at a time.
|
||||
|
||||
### How do I disable WiFi so Bluetooth will work?
|
||||
|
||||
Ensure the wifi_ssid and wifi_password values are blank.
|
||||
26
docs/faq/channel.md
Normal file
26
docs/faq/channel.md
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
---
|
||||
id: channel
|
||||
title: FAQs - Channel
|
||||
sidebar_label: Channel
|
||||
---
|
||||
## Overview
|
||||
|
||||
### What is a Meshtastic Channel?
|
||||
|
||||
This is the LoRa channel you're broadcasting on, the modem configuration (spreading factor, bandwidth and error correction), along with a special identifier for your group, and optional encryption.
|
||||
|
||||
### What is a LoRa channel?
|
||||
|
||||
This is the LoRa frequency within the frequency band your device is configured to use.
|
||||
|
||||
### How do I share my Meshtastic Channel with other people?
|
||||
|
||||
Your Meshtastic client (Android, iOS, Web or Python) will provide you a URL or QR code. You can email, text or print this URL or QR code and share it with people you want to join your Meshtastic Channel.
|
||||
|
||||
### What is a Primary Channel?
|
||||
|
||||
This is the first channel that's created for you when you initially setup your Meshtastic Channel.
|
||||
|
||||
### What is a Secondary Channel?
|
||||
|
||||
As this is a new feature, secondary channels work on the device and the Python Script. Support for secondary channels by other clients is pending. For more information: https://meshtastic.org/docs/software/device/device-channels#how-to-use-secondary-channels
|
||||
21
docs/faq/client-android.md
Normal file
21
docs/faq/client-android.md
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
---
|
||||
id: client-android
|
||||
title: FAQs - Android
|
||||
sidebar_label: Android
|
||||
---
|
||||
## Overview
|
||||
|
||||
### What versions of Android does the Meshtastic Android App require?
|
||||
|
||||
Minimum requirement is Android 5 (Lollipop 2014, first BLE support), however Android 6 (Marshmallow 2015) is recommended as Bluetooth is more stable.
|
||||
|
||||
### What's the cloud icon next to the message?
|
||||
|
||||
- Empty Cloud - Queued on the app to be sent to your device.
|
||||
- Up Arrow - Queued on the device to be sent over the mesh.
|
||||
- Check Mark - Delivered over the mesh.
|
||||
- Cross Mark - Error.
|
||||
|
||||
### How can I clear the message history?
|
||||
|
||||
Long press any message to select and show the menu with "delete" and "select all" buttons.
|
||||
14
docs/faq/client-ios.md
Normal file
14
docs/faq/client-ios.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
id: client-ios
|
||||
title: FAQs - iOS
|
||||
sidebar_label: iOS
|
||||
---
|
||||
## Overview
|
||||
|
||||
### What version of iOS does the Meshtastic iOS App Require?
|
||||
|
||||
The now-in-beta iOS app requires iOS v15.
|
||||
|
||||
### How do I get the Meshtastic iOS App?
|
||||
|
||||
See [iOS App](https://meshtastic.org/docs/software/ios/ios-development)
|
||||
14
docs/faq/client-python-cli.md
Normal file
14
docs/faq/client-python-cli.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
id: client-python-cli
|
||||
title: FAQs - CLI
|
||||
sidebar_label: CLI
|
||||
---
|
||||
## Overview
|
||||
|
||||
### How do I find out more about installing (and using) Meshtastic via command line?
|
||||
|
||||
See https://meshtastic.org/docs/software/python/python-installation
|
||||
|
||||
### How do I find out more about using python to interact?
|
||||
|
||||
See https://meshtastic.org/docs/software/python/python-uses
|
||||
16
docs/faq/client-web.md
Normal file
16
docs/faq/client-web.md
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
id: client-web
|
||||
title: FAQs - Web
|
||||
sidebar_label: Web
|
||||
---
|
||||
## Overview
|
||||
|
||||
### How do I access the network from my web browser?
|
||||
|
||||
Visit http://meshtastic.local (Note: This is a work in progress.)
|
||||
|
||||
### I've Flashed my device but I can't access the Web UI
|
||||
|
||||
Ensure you have used the included `device-install` script to flash your device, and that the file `spiffs-*.bin` is present in the same folder as your firmware at the time of flashing.
|
||||
|
||||
Note: Currently only Chrome and Chromium based browsers offer reliable support for the Web UI.
|
||||
39
docs/faq/device.md
Normal file
39
docs/faq/device.md
Normal file
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
id: device
|
||||
title: FAQs - Device
|
||||
sidebar_label: Device
|
||||
---
|
||||
## Overview
|
||||
|
||||
### Where do I purchase the device hardware?
|
||||
|
||||
Each [supported device](https://meshtastic.org/docs/hardware/supported/tbeam) has a "Purchase Link".
|
||||
|
||||
### I have my hardware. How do I install the firmware and any required drivers?
|
||||
|
||||
See: https://meshtastic.org/docs/getting-started/flashing-esp32
|
||||
|
||||
### How do I update the firmware to the latest version?
|
||||
|
||||
If the device is running Meshtastic firmware, you might be able to update over-the-air like via the Android app.
|
||||
|
||||
### My device has gone to sleep. Are received messages lost?
|
||||
|
||||
The LoRa radio on the node is still active and will wake up the CPU when the device is sleeping. If your phone is in range, the node will relay any messages your phone may have missed. If you're in range and your device is active, messages have not been lost.
|
||||
|
||||
### My device has gone to sleep and I can't send any messages.
|
||||
|
||||
Once the node wakes up from sleep, your phone will relay any delayed messages through your node and to the mesh network. Give it a few minutes and it'll do the right thing.
|
||||
|
||||
### How do I turn off an ESP32 t-beam based device?
|
||||
|
||||
Hold down the left PWR button for about 10 seconds and the display should turn off.
|
||||
|
||||
### How do I turn on an ESP32 t-beam based device?
|
||||
|
||||
Push the left PWR button for about 1 second.
|
||||
|
||||
### How can I tell the device not to sleep?
|
||||
|
||||
- Android instructions see: [Android Usage](https://meshtastic.org/docs/software/android/android-usage#configuration-options)
|
||||
- Python CLI instructions see: [Python Usage](https://meshtastic.org/docs/software/python/python-cli#changing-device-settings)
|
||||
|
|
@ -21,3 +21,15 @@ Answer (Include links to settings/developers/supported hardware etc)
|
|||
|
||||
--->
|
||||
## Overview
|
||||
|
||||
### What is Meshtastic?
|
||||
|
||||
Meshtastic is the most awesome long range, low power communications service on the planet earth! That's not even an exaggeration!
|
||||
|
||||
### Where can I get additional help, ask questions, or bond with the Meshtastic community?
|
||||
|
||||
After reading this FAQ and checking out the links on the left, there are two places... The preferred place is to check out the [Forum](https://meshtastic.discourse.group). There you can be part of our growing community and search for previous posts that may be similar to what you're looking for. We also have the [Meshtastic Discord](https://discord.com/invite/UQJ5QuM7vq) server where you may connect with like-minded people.
|
||||
|
||||
### How can I contribute to Meshtastic?
|
||||
|
||||
Everyone contributes in a different way. Join the [Forum](https://meshtastic.discourse.group) and/or the [Meshtastic Discord](https://discord.com/invite/UQJ5QuM7vq) and introduce yourself. We're all very friendly. If you'd like to pitch in some code, check out the [Developers](https://meshtastic.org/docs/developers) menu on the left.
|
||||
|
|
|
|||
6
docs/faq/mqtt.md
Normal file
6
docs/faq/mqtt.md
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: mqtt
|
||||
title: FAQs - MQTT
|
||||
sidebar_label: MQTT
|
||||
---
|
||||
## Overview
|
||||
18
docs/faq/plugins.md
Normal file
18
docs/faq/plugins.md
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
id: plugins
|
||||
title: FAQs - Plugins
|
||||
sidebar_label: Plugins
|
||||
---
|
||||
## Overview
|
||||
|
||||
### What are Plugins?
|
||||
|
||||
Plugins are features that expand the basic device functionality and/or integrate with other services.
|
||||
|
||||
### What plugins do we have available?
|
||||
|
||||
To see the list of available plugins, please go to: https://meshtastic.org/docs/software/plugins/
|
||||
|
||||
### I'd like to write a plugin. How do I get started?
|
||||
|
||||
See: https://meshtastic.org/docs/developers/device/plugin-api
|
||||
|
|
@ -4,3 +4,11 @@ title: FAQs - WiFi
|
|||
sidebar_label: WiFi
|
||||
---
|
||||
## Overview
|
||||
|
||||
### How do I turn on the WiFI radio?
|
||||
|
||||
See: https://meshtastic.org/docs/software/device/device-wifi
|
||||
|
||||
### When I turn on WiFi, Bluetooth turns off. Why is this?
|
||||
|
||||
Currently WiFi and Bluetooth can not be enabled at the same time.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
id: clients
|
||||
title: Clients Overview
|
||||
sidebar_label: Clients Overview
|
||||
title: Meshtastic Clients
|
||||
sidebar_label: Meshtastic Clients
|
||||
---
|
||||
import { DownloadCard } from '/src/pages/downloads/_components/DownloadCard.tsx'
|
||||
|
||||
|
|
@ -11,7 +11,7 @@ There are many ways to connect to your newly flashed device. Below is a quicksta
|
|||
|
||||
### Commandline Interface (CLI)
|
||||
|
||||
The CLI is currently the best way to manage your settings. It is feature rich and well documented. The [settings pages](/docs/settings) have examples for each user preference for the device. The CLI is available as a standalone executable for Windows, Mac OS or linux or as part of the [Meshtastic-python](https://github.com/meshtastic/Meshtastic-python) project. If you'd like to use python to interface with a device, see the [API documentation](https://python.meshtastic.org).
|
||||
The CLI is currently the best way to manage your settings. It is feature rich and well documented. The [settings pages](/docs/settings) have examples for each user preference for the device. The CLI is available as a standalone executable for Windows, Mac OS or linux or as part of the [Meshtastic-python](https://github.com/meshtastic/Meshtastic-python) project. If you'd like to use python to interface with a device, see the [API documentation](https://python.meshtastic.org).
|
||||
|
||||
To install the prebuilt binary refer to: [Meshtastic-python standalone executable](/docs/software/python/python-standalone).
|
||||
|
||||
|
|
@ -24,7 +24,7 @@ pip install meshtastic
|
|||
pip install --upgrade meshtastic
|
||||
```
|
||||
:::note
|
||||
Some installations of python may require you to substitute 'pip3' for the 'pip' command.
|
||||
Some installations of python may require you to substitute 'pip3' for the 'pip' command.
|
||||
:::
|
||||
|
||||
### Mobile Client Downloads
|
||||
|
|
@ -60,3 +60,18 @@ Using your preferred program (PuTTy, Serial, etc) connect to your device with th
|
|||
| `921600` | `8` | `None` | `1` |
|
||||
|
||||
### Web
|
||||
|
||||
<!--- FIXME add self hosting details link --->
|
||||
|
||||
The web interface is available for all browsers, but [bluetooth and serial capabilities are limited](https://github.com/meshtastic/meshtastic.js#compatibility). You can connect to your node using:
|
||||
|
||||
- [client.meshtastic.org](https://client.meshtastic.org)
|
||||
- BLE
|
||||
- HTTP
|
||||
- Serial
|
||||
- [ESP32 WiFi SoftAP](/docs/settings/wifi#software-access-point)
|
||||
- [ESP32 as Client](/docs/settings/wifi#wifi-client)
|
||||
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -1,11 +0,0 @@
|
|||
---
|
||||
id: concepts
|
||||
title: Concepts
|
||||
sidebar_label: Concepts
|
||||
---
|
||||
|
||||
Various high level concepts used in the Meshtastic meta verse:
|
||||
|
||||
* Mesh Networking: An interconnected network by using [low-power radios](https://meshtastic.org/docs/hardware) to connect other low-power radios using LoRa to be able to send and receive messages and data. This can be completely separate from any other networks such as the internet. You can start small and get two devices to start experimenting. Do not expect to stream music or videos as LoRa is intended for smaller, lower bandwidth type uses such as text communication.
|
||||
* Captive Portal: Using Meshtastic, you can create a separate Wifi network for you join your phone or computer on a mesh network. See [Web Interface](https://meshtastic.org/docs/software/web/web-app-software) for more info. This is ideal in a situation where you are remote, such as in the forest, on a mountain, or if there is a major power/internet outage such as in a storm or other disaster.
|
||||
* Meshtastic Channels: Can create a *somewhat* secure method of communication on the same mesh network. The channel can be encrypted to prevent normal people from listening in on the traffic. But, it could probably be easily [cracked](https://crypto.stackexchange.com/questions/46559/what-are-the-chances-that-aes-256-encryption-is-cracked) by determined individuals. See [Channel Config](https://meshtastic.org/docs/software/settings/channel) for more info. It is also possible that your location could be triangulated by determined individuals.
|
||||
|
|
@ -1,177 +0,0 @@
|
|||
---
|
||||
id: faq
|
||||
title: Frequently Asked Questions (FAQ)
|
||||
sidebar_label: Frequently Asked Questions
|
||||
slug: /getting-started/faq
|
||||
---
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
<!--
|
||||
|
||||
**** FAQ Contributors, README ***
|
||||
*
|
||||
* Best Practices for the FAQ:
|
||||
*
|
||||
* - Keep the answers Non-Technical. The FAQ should be targeted to non-geeks.
|
||||
* - This FAQ is not the authoritative document. Provide a short answer and a link to learn more.
|
||||
*
|
||||
****
|
||||
|
||||
-->
|
||||
|
||||
## General
|
||||
|
||||
### What is Meshtastic?
|
||||
|
||||
Meshtastic is the most awesome long range, low power communications service on the planet earth! That's not even an exaggeration!
|
||||
|
||||
### Where can I get additional help, ask questions, or bond with the Meshtastic community?
|
||||
|
||||
After reading this FAQ and checking out the links on the left, there are two places... The preferred place is to check out the [Forum](https://meshtastic.discourse.group). There you can be part of our growing community and search for previous posts that may be similar to what you're looking for. We also have the [Meshtastic Discord](https://discord.com/invite/UQJ5QuM7vq) server where you may connect with like-minded people.
|
||||
|
||||
### How can I contribute to Meshtastic?
|
||||
|
||||
Everyone contributes in a different way. Join the [Forum](https://meshtastic.discourse.group) and/or the [Meshtastic Discord](https://discord.com/invite/UQJ5QuM7vq) and introduce yourself. We're all very friendly. If you'd like to pitch in some code, check out the [Developers](https://meshtastic.org/docs/developers) menu on the left.
|
||||
|
||||
## Device (aka Node)
|
||||
|
||||
### Where do I purchase the device hardware?
|
||||
|
||||
Each [supported device](https://meshtastic.org/docs/hardware/supported/tbeam) has a "Purchase Link".
|
||||
|
||||
### I have my hardware. How do I install the firmware and any required drivers?
|
||||
|
||||
See: https://meshtastic.org/docs/getting-started/flashing-esp32
|
||||
|
||||
### How do I update the firmware to the latest version?
|
||||
|
||||
If the device is running Meshtastic firmware, you might be able to update over-the-air like via the Android app.
|
||||
|
||||
### My device has gone to sleep. Are received messages lost?
|
||||
|
||||
The LoRa radio on the node is still active and will wake up the CPU when the device is sleeping. If your phone is in range, the node will relay any messages your phone may have missed. If you're in range and your device is active, messages have not been lost.
|
||||
|
||||
### My device has gone to sleep and I can't send any messages.
|
||||
|
||||
Once the node wakes up from sleep, your phone will relay any delayed messages through your node and to the mesh network. Give it a few minutes and it'll do the right thing.
|
||||
|
||||
### How do I turn off an ESP32 t-beam based device?
|
||||
|
||||
Hold down the left PWR button for about 10 seconds and the display should turn off.
|
||||
|
||||
### How do I turn on an ESP32 t-beam based device?
|
||||
|
||||
Push the left PWR button for about 1 second.
|
||||
|
||||
### How can I tell the device not to sleep?
|
||||
|
||||
- Android instructions see: [Android Usage](https://meshtastic.org/docs/software/android/android-usage#configuration-options)
|
||||
- Python CLI instructions see: [Python Usage](https://meshtastic.org/docs/software/python/python-cli#changing-device-settings)
|
||||
|
||||
### Plugins
|
||||
|
||||
### What are Plugins?
|
||||
|
||||
Plugins are features that expand the basic device functionality and/or integrate with other services.
|
||||
|
||||
### What plugins do we have available?
|
||||
|
||||
To see the list of available plugins, please go to: https://meshtastic.org/docs/software/plugins/
|
||||
|
||||
### I'd like to write a plugin. How do I get started?
|
||||
|
||||
See: https://meshtastic.org/docs/developers/device/plugin-api
|
||||
|
||||
## Android
|
||||
|
||||
### What versions of Android does the Meshtastic Android App require?
|
||||
|
||||
Minimum requirement is Android 5 (Lollipop 2014, first BLE support), however Android 6 (Marshmallow 2015) is recommended as Bluetooth is more stable.
|
||||
|
||||
### What's the cloud icon next to the message?
|
||||
|
||||
- Empty Cloud - Queued on the app to be sent to your device.
|
||||
- Up Arrow - Queued on the device to be sent over the mesh.
|
||||
- Check Mark - Delivered over the mesh.
|
||||
- Cross Mark - Error.
|
||||
|
||||
### How can I clear the message history?
|
||||
|
||||
Long press any message to select and show the menu with "delete" and "select all" buttons.
|
||||
|
||||
## iOS
|
||||
|
||||
### What version of iOS does the Meshtastic iOS App Require?
|
||||
|
||||
The now-in-beta iOS app requires iOS v15.
|
||||
|
||||
### How do I get the Meshtastic iOS App?
|
||||
|
||||
See [iOS App](https://meshtastic.org/docs/software/ios/ios-development)
|
||||
|
||||
## Bluetooth
|
||||
|
||||
### How do I pair my phone to the device if my device doesn't have a screen?
|
||||
|
||||
Use [Wifi](https://meshtastic.org/docs/software/device/device-wifi) or Bluetooth with screenless pairing: before you initiate pairing, double click on the device button. The LED will blink 3 times in confirmation and the PIN will be set temporarily to `123456`.
|
||||
|
||||
### Can I have Bluetooth enabled and use WiFi radio?
|
||||
|
||||
No. Only one method will work at a time.
|
||||
|
||||
### How do I disable WiFi so Bluetooth will work?
|
||||
|
||||
Ensure the wifi_ssid and wifi_password values are blank.
|
||||
|
||||
## WiFi / Web Browser
|
||||
|
||||
### How do I turn on the WiFI radio?
|
||||
|
||||
See: https://meshtastic.org/docs/software/device/device-wifi
|
||||
|
||||
### When I turn on WiFi, Bluetooth turns off. Why is this?
|
||||
|
||||
Currently WiFi and Bluetooth can not be enabled at the same time.
|
||||
|
||||
### How do I access the network from my web browser?
|
||||
|
||||
Visit http://meshtastic.local (Note: This is a work in progress.)
|
||||
|
||||
### I've Flashed my device but I can't access the Web UI
|
||||
|
||||
Ensure you have used the included `device-install` script to flash your device, and that the file `spiffs-*.bin` is present in the same folder as your firmware at the time of flashing.
|
||||
|
||||
Note: Currently only Chrome and Chromium based browsers offer reliable support for the Web UI.
|
||||
|
||||
## Channels
|
||||
|
||||
### What is a Meshtastic Channel?
|
||||
|
||||
This is the LoRa channel you're broadcasting on, the modem configuration (spreading factor, bandwidth and error correction), along with a special identifier for your group, and optional encryption.
|
||||
|
||||
### What is a LoRa channel?
|
||||
|
||||
This is the LoRa frequency within the frequency band your device is configured to use.
|
||||
|
||||
### How do I share my Meshtastic Channel with other people?
|
||||
|
||||
Your Meshtastic client (Android, iOS, Web or Python) will provide you a URL or QR code. You can email, text or print this URL or QR code and share it with people you want to join your Meshtastic Channel.
|
||||
|
||||
### What is a Primary Channel?
|
||||
|
||||
This is the first channel that's created for you when you initially setup your Meshtastic Channel.
|
||||
|
||||
### What is a Secondary Channel?
|
||||
|
||||
As this is a new feature, secondary channels work on the device and the Python Script. Support for secondary channels by other clients is pending. For more information: https://meshtastic.org/docs/software/device/device-channels#how-to-use-secondary-channels
|
||||
|
||||
## Command Line / Python
|
||||
|
||||
### How do I find out more about installing (and using) Meshtastic via command line?
|
||||
|
||||
See https://meshtastic.org/docs/software/python/python-installation
|
||||
|
||||
### How do I find out more about using python to interact?
|
||||
|
||||
See https://meshtastic.org/docs/software/python/python-uses
|
||||
55
docs/getting-started/first-steps.md
Normal file
55
docs/getting-started/first-steps.md
Normal file
|
|
@ -0,0 +1,55 @@
|
|||
---
|
||||
id: first-steps
|
||||
title: First Steps
|
||||
sidebar_label: First Steps
|
||||
---
|
||||
## 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).
|
||||
|
||||
- Ensure you can run `meshtastic --info`.
|
||||
- Ensure the region is set appropriately. If the radios are 915 MHz and you are in the US, then no region changes/settings are necessary. If you are in another region, you may need to run something like: `meshtastic --set region EU865`.
|
||||
- Send a message `meshtastic --sendtext hello1`
|
||||
- Note: The radio connected via USB will not show messages sent.
|
||||
- After a few seconds the other radios will show the message. You may need to press one of the buttons on the other radio to see if the message arrived.
|
||||
- Run `meshtastic --nodes` to see if other nodes show in the display.
|
||||
- Messages sent from the USB radio should be sent to the other radio(s) via LoRa. The default settings should allow this to work.
|
||||
|
||||
### Connect via Bluetooth
|
||||
|
||||
The Android app is currently more robust than the iOS app. But, they both should be able to interact with the radios.
|
||||
|
||||
- Install Android or iOS Meshtastic app
|
||||
- Start Meshtastic app
|
||||
- Connect to radio(s) from inside the app
|
||||
- Pair with radio(s). A paring code should show on the radio. Enter that value when prompted to pair a Bluetooth device.
|
||||
- Send message(s) from inside the app.
|
||||
- Note: The radio connected via Bluetooth will not show messages sent.
|
||||
- Verify that all other radios are receiving the message(s). Might have to click on the button on the radio to see most recent message.
|
||||
|
||||
### Connect via WiFi/HTTP
|
||||
|
||||
- Configure the _wifi_ssid_ and _wifi_password_. `meshtastic --set wifi_ssid 'xxx' --set wifi_password 'yyy'` (where xxx and yyy are the appropriate values for your network)
|
||||
- Reboot radio by either removing power or pressing the power button.
|
||||
- Click on the button to cycle through to the screen with IP address and verify that there was a connection to the Wifi access point.
|
||||
- Send message(s). `meshtastic --host 192.168.1.200 --sendtext hello`
|
||||
- Note: The radio connected via Wifi will not show messages sent.
|
||||
- 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.com/invite/UQJ5QuM7vq). Our support is 100% volunteer based. We are passionate about the project hope to help newcomers become Meshtastic experts.
|
||||
|
|
@ -2,6 +2,8 @@
|
|||
id: flashing-esp32
|
||||
title: Flashing ESP32 devices firmware
|
||||
sidebar_label: ESP32 devices
|
||||
pagination_prev: getting-started/flashing-firmware
|
||||
pagination_next: getting-started/clients
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
|
|
|||
|
|
@ -103,6 +103,10 @@ Some newer boards may require the CH9102 (CH340/CH341) Driver.
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
:::important
|
||||
Reboot your computer after you have installed the driver to complete the installation.
|
||||
:::
|
||||
|
||||
### NRF52 Drivers
|
||||
|
||||
<Tabs
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
id: flashing-nrf52
|
||||
title: Flashing nRF52 devices firmware
|
||||
sidebar_label: nRF52 devices
|
||||
pagination_prev: getting-started/flashing-firmware
|
||||
pagination_next: getting-started/clients
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
|
|
|||
|
|
@ -22,19 +22,29 @@ Meshtastic uses LoRa for the long range communications and depending on settings
|
|||
</Link>
|
||||
</div>
|
||||
|
||||
## Purchase a Radio
|
||||
## Hardware
|
||||
|
||||
### Purchasing
|
||||
|
||||
#### Purchase radio
|
||||
|
||||
The easiest way is to [buy a device with the software already installed](https://www.aliexpress.com/item/4001178678568.html). Other devices are [available](/docs/hardware/supported/tbeam). In the Americas get the 915MHz version, in Europe the 868MHz, or Asia 923MHz. See this listing by [The Things Network](https://www.thethingsnetwork.org/docs/lorawan/frequencies-by-country.html) for frequencies by specific countries.
|
||||
|
||||
#### Purchase battery
|
||||
|
||||
#### Purchase other accessories
|
||||
|
||||
<div className="indexCtasBody">
|
||||
<Link
|
||||
className={'button button--outline button--lg cta--button'}
|
||||
to={'/docs/hardware'}>
|
||||
className={'button button--outline button--lg cta--button'}
|
||||
to={'/docs/hardware'}>
|
||||
Purchase Hardware
|
||||
</Link>
|
||||
</div>
|
||||
|
||||
## Setup the Radio
|
||||
### Initial Setup
|
||||
|
||||
#### Setup the Radio
|
||||
|
||||
When it arrives, install your antenna and make sure you install the battery correctly. Reversing the battery can damage your device. Make sure the antenna is on when you power up the board.
|
||||
|
||||
|
|
@ -82,44 +92,18 @@ There are many ways to connect to your new radio!
|
|||
</Link>
|
||||
</div>
|
||||
|
||||
## Use Meshtastic
|
||||
|
||||
### A good first test (connect via USB and CLI)
|
||||
This is the best part of Meshtastic. Deploying, testing, and optimizing your personal mesh network. Click below for first steps, configurations, and tests.
|
||||
|
||||
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](https://meshtastic.org/docs/software/python/python-installation).
|
||||
|
||||
- Ensure you can run `meshtastic --info`.
|
||||
- Ensure the region is set appropriately. If the radios are 915 MHz and you are in the US, then no region changes/settings are necessary. If you are in another region, you may need to run something like: `meshtastic --set region EU865`.
|
||||
- Send a message `meshtastic --sendtext hello1`
|
||||
- Note: The radio connected via USB will not show messages sent.
|
||||
- After a few seconds the other radios will show the message. You may need to press one of the buttons on the other radio to see if the message arrived.
|
||||
- Run `meshtastic --nodes` to see if other nodes show in the display.
|
||||
- Messages sent from the USB radio should be sent to the other radio(s) via LoRa. The default settings should allow this to work.
|
||||
|
||||
### A good second test (connect via Bluetooth)
|
||||
|
||||
The Android app is currently more robust than the iOS app. But, they both should be able to interact with the radios.
|
||||
|
||||
- Install Android or iOS Meshtastic app
|
||||
- Start Meshtastic app
|
||||
- Connect to radio(s) from inside the app
|
||||
- Pair with radio(s). A paring code should show on the radio. Enter that value when prompted to pair a Bluetooth device.
|
||||
- Send message(s) from inside the app.
|
||||
- Note: The radio connected via Bluetooth will not show messages sent.
|
||||
- Verify that all other radios are receiving the message(s). Might have to click on the button on the radio to see most recent message.
|
||||
|
||||
### A good third test (connect via Wifi/HTTP)
|
||||
|
||||
- Configure the _wifi_ssid_ and _wifi_password_. `meshtastic --set wifi_ssid 'xxx' --set wifi_password 'yyy'` (where xxx and yyy are the appropriate values for your network)
|
||||
- Reboot radio by either removing power or pressing the power button.
|
||||
- Click on the button to cycle through to the screen with IP address and verify that there was a connection to the Wifi access point.
|
||||
- Send message(s). `meshtastic --host 192.168.1.200 --sendtext hello`
|
||||
- Note: The radio connected via Wifi will not show messages sent.
|
||||
- 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 ''`).
|
||||
<div className="indexCtasBody">
|
||||
<Link
|
||||
className={'button button--outline button--lg cta--button'}
|
||||
to={'/docs/getting-started/first-steps'}>
|
||||
First Steps
|
||||
</Link>
|
||||
</div>
|
||||
|
||||
## 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 and provide as much detail as possible.
|
||||
|
||||
We are also on [Discord](https://discord.gg/UQJ5QuM7vq).
|
||||
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.com/invite/UQJ5QuM7vq). Our support is 100% volunteer based. We are passionate about the project hope to help newcomers become Meshtastic experts.
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
id: meshtastic-flasher
|
||||
title: Using Meshtastic Flasher
|
||||
sidebar_label: Using Meshtastic Flasher
|
||||
pagination_next: getting-started/clients
|
||||
---
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
|
|
|||
|
|
@ -4,7 +4,18 @@ title: Web interface overview
|
|||
sidebar_label: Overview
|
||||
---
|
||||
|
||||
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.
|
||||
<!--- FIXME add self hosting details link --->
|
||||
|
||||
The web interface is available for all browsers, but [bluetooth and serial capabilities are limited](https://github.com/meshtastic/meshtastic.js#compatibility). You can connect to your node using:
|
||||
|
||||
- [client.meshtastic.org](https://client.meshtastic.org)
|
||||
- BLE
|
||||
- HTTP
|
||||
- Serial
|
||||
- [ESP32 WiFi SoftAP](/docs/settings/wifi#software-access-point)
|
||||
- [ESP32 as Client](/docs/settings/wifi#wifi-client)
|
||||
|
||||
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.
|
||||
|
||||
:::caution
|
||||
Please note that this is under active development and liable to change.
|
||||
|
|
|
|||
|
|
@ -49,10 +49,6 @@ const config = {
|
|||
{
|
||||
label: "Documentation",
|
||||
items: [
|
||||
{
|
||||
label: "About",
|
||||
to: "docs/about",
|
||||
},
|
||||
{
|
||||
label: "Getting Started",
|
||||
to: "docs/getting-started",
|
||||
|
|
|
|||
16
sidebars.js
16
sidebars.js
|
|
@ -17,7 +17,20 @@ module.exports = {
|
|||
"FAQs": [
|
||||
"faq/faq",
|
||||
"faq/antenna",
|
||||
"faq/bluetooth",
|
||||
"faq/channel",
|
||||
{
|
||||
"Clients": [
|
||||
"faq/client-android",
|
||||
"faq/client-python-cli",
|
||||
"faq/client-ios",
|
||||
"faq/client-web",
|
||||
],
|
||||
},
|
||||
"faq/device",
|
||||
"faq/mesh",
|
||||
"faq/mqtt",
|
||||
"faq/plugins",
|
||||
"faq/wifi",
|
||||
],
|
||||
}
|
||||
|
|
@ -128,7 +141,6 @@ module.exports = {
|
|||
Configuration: {
|
||||
"Getting Started": [
|
||||
"getting-started/overview",
|
||||
"getting-started/faq",
|
||||
{
|
||||
"Flashing firmware": [
|
||||
"getting-started/flashing-firmware",
|
||||
|
|
@ -146,7 +158,7 @@ module.exports = {
|
|||
"getting-started/clients",
|
||||
],
|
||||
},
|
||||
"getting-started/concepts",
|
||||
"getting-started/first-steps",
|
||||
],
|
||||
|
||||
"Device Settings": [
|
||||
|
|
|
|||
Loading…
Reference in a new issue