mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-12-27 14:39:54 -08:00
Sacha Weatherstone
GitHub
commit
f35c0b54b7
|
|
@ -1,101 +0,0 @@
|
|||
---
|
||||
id: about
|
||||
title: What is Meshtastic?
|
||||
sidebar_label: About
|
||||
slug: /about
|
||||
---
|
||||
|
||||
<!--- TODO create new about page and remove it from the "documentation" section --->
|
||||
|
||||
Meshtastic® is a project that lets you use inexpensive ($30 ish) LoRa radios as an extensible, long battery life, secure, mesh GPS communicator. These radios are great for hiking, skiing, paragliding - essentially any hobby where you don't have reliable internet access. Each member of your private mesh can always see the location and distance of all other members and any text messages sent to your group chat.
|
||||
|
||||
The radios automatically create a mesh to forward packets as needed, so everyone in the group can receive messages from even the furthest member. The radios will optionally work with your phone, but no phone is required.
|
||||
|
||||
Note: Questions after reading this? See our new [forum](https://meshtastic.discourse.group/).
|
||||
|
||||
## Uses
|
||||
|
||||
- Outdoor sports where cellular coverage is limited. (Hiking, Skiing, Boating, Paragliding, Gliders etc..)
|
||||
- Applications where closed source GPS communicators just won't cut it (it is easy to add features for glider pilots etc...)
|
||||
- Secure long-range communication within groups without depending on cellular providers
|
||||
- Finding your lost kids ;-)
|
||||
- Through our [python API](https://pypi.org/project/meshtastic/) use these inexpensive radios to easily add mesh networking to your own projects.
|
||||
|
||||
## Features
|
||||
|
||||
Not all of these features are fully implemented yet - see **important** disclaimers below. But they should be in by the time we decide to call this project beta (three months?)
|
||||
|
||||
- Very long battery life (should be about eight days with the beta software)
|
||||
- Built in GPS and [LoRa](https://en.wikipedia.org/wiki/LoRa) radio, but we manage the radio automatically for you
|
||||
- Long range - a few miles per node but each node will forward packets as needed
|
||||
- Secure - channels are encrypted by AES256 (But see important disclaimers below wrt this feature)
|
||||
- Shows direction and distance to all members of your channel
|
||||
- Directed or broadcast text messages for channel members
|
||||
- Open and extensible codebase supporting multiple hardware vendors - no lock in to one vendor
|
||||
- Communication API for bluetooth devices (such as our Android app) to use the mesh. An iOS application is in the works. And [Meshtastic-python](https://pypi.org/project/meshtastic/) provides access from desktop computers.
|
||||
- Very easy sharing of private secured channels. Just share a special link or QR code with friends and they can join your encrypted mesh
|
||||
|
||||
This project is currently in beta testing but it is fairly stable and feature complete - if you have questions please [join our discussion forum](https://meshtastic.discourse.group/).
|
||||
|
||||
This software is 100% open source and developed by a group of hobbyist experimenters. No warranty is provided, if you'd like to improve it - we'd love your help. Please post in the [forum](https://meshtastic.discourse.group/).
|
||||
|
||||
### Beginner's Guide
|
||||
|
||||
For an detailed walk-through aimed at beginners, we recommend [meshtastic.letstalkthis.com](https://meshtastic.letstalkthis.com/).
|
||||
|
||||
### Related Groups
|
||||
|
||||
Telegram group for **Italy**-based users [t.me/meshtastic_italia](http://t.me/meshtastic_italia) (Italian language, unofficial).<br/>
|
||||
Telegram group for **Russian**-based users [t.me/meshtastic_russia](https://t.me/meshtastic_russia) (Russian language, unofficial).
|
||||
|
||||
## Updates
|
||||
|
||||
Note: Updates are happening almost daily, only major updates are listed below. For more details see our forum.
|
||||
|
||||
- 09/14/2020 - 1.0.0 Now with over 1700 android users, over 2000 nodes and translated into 15 languages. This project will always be a "beta" experiment, but now quite usable. We are currently selecting 1.1 features in our discussion forum.
|
||||
- 06/24/2020 - 0.7.x Now with over 1000 android users, over 600 people using the radios and translated into 22 languages. Fairly stable and we are working through bugs to get to 1.0.
|
||||
- 06/04/2020 - 0.6.7 Beta releases of both the application and the device code are released. Features are fairly solid now with a sizable number of users.
|
||||
- 04/28/2020 - 0.6.0 [Python API](https://pypi.org/project/meshtastic/) released. Makes it easy to use meshtastic devices as "zero config / just works" mesh transport adapters for other projects.
|
||||
- 04/20/2020 - 0.4.3 Pretty solid now both for the android app and the device code. Many people have donated translations and code. Probably going to call it a beta soon.
|
||||
- 03/03/2020 - 0.0.9 of the Android app and device code is released. Still an alpha but fairly functional.
|
||||
- 02/25/2020 - 0.0.4 of the Android app is released. This is a very early alpha, see below to join the alpha-testers group.
|
||||
- 02/23/2020 - 0.0.4 release. Still very bleeding edge but much closer to the final power management, a charged T-BEAM should run for many days with this load. If you'd like to try it, we'd love your feedback. Click [here](https://github.com/meshtastic/Meshtastic-esp32/blob/master/README.md) for instructions.
|
||||
- 02/20/2020 - Our first alpha release (0.0.3) of the radio software is ready brave early people.
|
||||
|
||||
### Meshtastic Android app
|
||||
|
||||
Our Android application is available here:
|
||||
|
||||
[](https://play.google.com/store/apps/details?id=com.geeksville.mesh&referrer=utm_source%3Dgithub-homepage)
|
||||
|
||||
The link above will return older more stable releases. We would prefer if you join our alpha-test group, because the application is rapidly improving. Three steps to opt-in to the alpha- test:
|
||||
|
||||
1. Join [this Google group](https://groups.google.com/forum/#!forum/meshtastic-alpha-testers) with the account you use in Google Play.
|
||||
2. Go to this [URL](https://play.google.com/apps/testing/com.geeksville.mesh) to opt-in to the alpha test.
|
||||
3. If you encounter any problems or have questions, post in our [forum](https://meshtastic.discourse.group/) and we'll help.
|
||||
|
||||
If you'd like to help with development, the source code is [on github](https://github.com/meshtastic/Meshtastic-Android).
|
||||
|
||||
The app is also distributed for Amazon Fire devices via the Amazon appstore: [](https://www.amazon.com/Geeksville-Industries-Meshtastic/dp/B08CY9394Q)
|
||||
|
||||
### Supported hardware
|
||||
|
||||
We currently support two brands of radios. The [TTGO T-Beam](https://www.aliexpress.com/item/4001178678568.html) and the [Heltec LoRa 32](https://heltec.org/project/wifi-lora-32/). Most people should buy the T-Beam and a 18650 battery (total cost less than $35). Also, the version of the T-Beam we link to is shipped with Meshtastic **preinstalled** by TTGO, so you don't have to install it yourself.
|
||||
|
||||
Make sure to buy the frequency range which is legal for your country. For the USA, you should buy the 915MHz version. Getting a version that include a screen is optional, but highly recommended.
|
||||
|
||||
Instructions for installing prebuilt firmware can be found [here](https://github.com/meshtastic/Meshtastic-esp32/blob/master/README.md).
|
||||
|
||||
For a nice looking cases:
|
||||
|
||||
- 3D printable cases
|
||||
1. TTGO T-Beam V0 see this [design](https://www.thingiverse.com/thing:3773717) by [bsiege](https://www.thingiverse.com/bsiege).
|
||||
2. TTGO T_Beam V1 (SMA) see this [design](https://www.thingiverse.com/thing:3830711) by [rwanrooy](https://www.thingiverse.com/rwanrooy) or this [remix](https://www.thingiverse.com/thing:3949330) by [8ung](https://www.thingiverse.com/8ung)
|
||||
3. TTGO T_Beam V1 (IPEX) see this [design](https://www.thingiverse.com/thing:4587297) by [drewsed](https://www.thingiverse.com/drewsed)
|
||||
4. Heltec Lora32 see this [design](https://www.thingiverse.com/thing:3125854) by [ornotermes](https://www.thingiverse.com/ornotermes).
|
||||
- Laser-cut cases
|
||||
1. TTGO T_Beam V1 (SMA) see this [design](https://www.thingiverse.com/thing:4552771) by [jefish](https://www.thingiverse.com/jefish)
|
||||
|
||||
## IMPORTANT DISCLAIMERS AND FAQ
|
||||
|
||||
<!-- For a listing of currently missing features and a FAQ click [here](developers/device/faq). -->
|
||||
|
|
@ -110,6 +110,21 @@ brew -v
|
|||
If it's not installed, follow the instructions on the [Homebrew website](https://brew.sh) before continuing.
|
||||
:::
|
||||
|
||||
Check if you have `python3` and `pip` installed with the following command
|
||||
```bash
|
||||
python3 --version
|
||||
pip3 --version
|
||||
```
|
||||
If `python3` is not installed, install with
|
||||
Install Python3
|
||||
```bash
|
||||
brew install python3
|
||||
```
|
||||
Confirm `pip3` was installed alongside `python3`
|
||||
```bash
|
||||
pip3 -v
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="windows">
|
||||
|
||||
|
|
|
|||
|
|
@ -31,7 +31,6 @@ If your device already has Meshtastic flashed to it, You can update it over the
|
|||
|
||||
- Install using the command line interface (CLI)
|
||||
- Install using a graphical user interface (GUI)
|
||||
- Install using over-the-air (OTA)
|
||||
|
||||
## Connect to your Device
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ slug: /hardware/antenna
|
|||
If you have sufficient range with your existing aerial, skip this section. If you don't, consider either getting more nodes and / or replace the stock aerial with one tuned (to your region transmitter's frequency):
|
||||
|
||||
- A quarter quarter wave _tuned_ stubby aerial (<10cm for fit-in-pocket) should have a real-world range of a couple of km without significant obstacles (buildings / hills).
|
||||
- Aerial criteria: 50 Ohm, appropriate connector (usually SMA male of U.FL), low VSWR (<2) (at tuning frequency - see its datasheet), gain > 0 dbi .
|
||||
- Aerial criteria: 50 Ohm, appropriate connector (usually SMA male or U.FL), low VSWR (<2) (at tuning frequency - see its datasheet), gain > 0 dbi .
|
||||
- Caution, avoid suppliers who:
|
||||
- don't state the aerial's tuned frequency and its specific purpose (LoRa network)
|
||||
- claim huge gain figures on omni-directional aerials
|
||||
|
|
|
|||
|
|
@ -29,9 +29,11 @@ slug: /hardware/resources
|
|||
* [Solwise Link Budget Calculator](https://www.solwise.co.uk/link-budget.htm)
|
||||
* Predict the received signal strength
|
||||
|
||||
|
||||
* [Amateur Radio Toolkit](https://play.google.com/store/apps/details?id=com.daveyhollenberg.amateurradiotoolkit)
|
||||
* Android app with lots of antenna information
|
||||
|
||||
|
||||
### Antenna designs
|
||||
|
||||
* [1/4 Wave Ground Plane Antenna Calculator](https://m0ukd.com/calculators/quarter-wave-ground-plane-antenna-calculator/)
|
||||
|
|
|
|||
|
|
@ -1,6 +0,0 @@
|
|||
---
|
||||
id: behaviour
|
||||
title: Button Behaviour
|
||||
sidebar_label: Behaviour
|
||||
slug: /hardware/behaviour
|
||||
---
|
||||
|
|
@ -4,3 +4,22 @@ title: Overview
|
|||
sidebar_label: Overview
|
||||
slug: /hardware
|
||||
---
|
||||
|
||||
We currently support devices that use the ESP32 and the nRF52 microcontrollers. Both of these offer low power consumption and long battery life, but each come with their own advantages:
|
||||
|
||||
## ESP32
|
||||
|
||||
The ESP32 devices have the advantage of having a wifi interface. This allows you to connect to an access point, or run the device as an access point, and host the [web interface](/docs/software/web/web-app-software). Unfortunately the ESP32 does not support Bluetooth 5.0, and so has to wake up from sleep mode every now and then to connect to bluetooth devices to receive messages. This can result in delays sending a message from your phone.
|
||||
|
||||
The following ESP32 devices are supported:
|
||||
* [Lilygo TTGO T-Beam](/docs/hardware/tbeam-hardware) - versions 0.7, 1.1 (including M8N gps and SX1262 LoRa variants)
|
||||
* [Lilygo TTGO Lora](/docs/hardware/lora-hardware) - versions 1, 1.3, 2.0, 2.1-1.6
|
||||
* [Heltec Lora 32 (V2)](/docs/hardware/heltec-hardware)
|
||||
|
||||
## nRF52
|
||||
|
||||
The nRF52 devices have the advantage of a Bluetooth 5.0 implementation. This allows for very low power bluetooth connections to be maintained without having to wake the microprocessor up at regular intervals. Unfortunately, the nRF52 devices do not have wifi built in, meaning that currently you cannot use the web interface with these devices.
|
||||
|
||||
The following nRF52 devices are currently supported:
|
||||
* [Lilygo TTGO T-Echo](/docs/hardware/techo-hardware)
|
||||
* [Wisblock RAK4631](/docs/hardware/wisBlock-hardware)
|
||||
|
|
|
|||
|
|
@ -4,3 +4,22 @@ title: Overview
|
|||
sidebar_label: Overview
|
||||
slug: /software
|
||||
---
|
||||
|
||||
The following applications are available to support your Meshtastic network:
|
||||
* The [firmware](/docs/software/device/device-software) to run on the devices
|
||||
* Connect to the devices with our [Android app](/docs/software/android/android-installation)
|
||||
* An [iOS application](/docs/software/ios/ios-development) is in the works
|
||||
* [Meshtastic.js](/docs/software/js/getting-started) provides a javascript library to interface with devices
|
||||
* [Meshtastic-python](/docs/software/python/python-installation) provides access from desktop computers including a command line interface
|
||||
* A [web interface](/docs/software/web/web-app-software) can be accessed over wifi on ESP32 devices
|
||||
* Pre-installed device plugins for:
|
||||
* [Range testing](/docs/software/plugins/range-test-plugin)
|
||||
* [External notifications](/docs/software/plugins/ext-notif-plugin)
|
||||
* [Serial communication](/docs/software/plugins/serial-plugin)
|
||||
* [Store and forewarding messages](/docs/software/plugins/store-forward-plugin) (in development)
|
||||
* [Environment measurement](/docs/software/plugins/environment-plugin) (in development)
|
||||
* Community projects include:
|
||||
* A [plugin](/docs/software/community/community-atak) for the [Android Team Awareness Kit (ATAK)](https://play.google.com/store/apps/details?id=com.atakmap.app.civ)
|
||||
* [PyGUI](/docs/software/community/community-pygui), a platform agnostic graphical user interface for devices
|
||||
|
||||
The devices running Meshtastic have a large number of preferences that can be set, see the [Settings](/docs/settings) pages for more details.
|
||||
|
|
@ -3,16 +3,26 @@ id: python-installation
|
|||
title: Meshtastic-python installation
|
||||
sidebar_label: Installation
|
||||
---
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
This is a python library for using Meshtastic devices. This small library (and example application) provides an easy API for sending and receiving messages over mesh radios. It also provides access to any of the operations/data available in the device user interface or the Android application. Events are delivered using a publish-subscribe model, and you can subscribe to only the message types you are interested in.
|
||||
|
||||
[Full documentation](https://meshtastic.github.io/Meshtastic-python) for the library, including examples, is available.
|
||||
|
||||
Installation is easily done through the Python package installer pip (note, you must use pip version 20 or later):
|
||||
Installation is easily done through the [Python package installer pip](https://pypi.org/project/meshtastic/) (note, you must use pip version 20 or later):
|
||||
|
||||
## Linux
|
||||
<Tabs
|
||||
groupId="operating-system"
|
||||
defaultValue="linux"
|
||||
values={[
|
||||
{label: 'Linux', value: 'linux'},
|
||||
{label: 'macOS', value: 'macos'},
|
||||
{label: 'Windows', value: 'windows'},
|
||||
]}>
|
||||
<TabItem value="linux">
|
||||
|
||||
- Check that your computer has the required serial drivers installed
|
||||
* Check that your computer has the required serial drivers installed
|
||||
* Connect your Meshtastic device to your USB port
|
||||
* Use the command
|
||||
```bash
|
||||
|
|
@ -20,50 +30,94 @@ Installation is easily done through the Python package installer pip (note, you
|
|||
```
|
||||
* You should see something like `CP210X USB to UART Bridge Controller`
|
||||
* If not download the drivers from [Silicon Labs](https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers).
|
||||
- Check that your computer has Python 3 installed.
|
||||
* Check that your computer has Python 3 installed.
|
||||
* Use the command
|
||||
```bash
|
||||
python3 -V
|
||||
```
|
||||
* If this does not return a version, install [python](https://www.python.org)
|
||||
- Pip is typically installed if you are using python 3 version >= 3.4
|
||||
* Pip is typically installed if you are using python 3 version >= 3.4
|
||||
* Check that pip is installed using this command
|
||||
```bash
|
||||
pip3 -V
|
||||
```
|
||||
* If this does not return a version, install [pip](https://pip.pypa.io/en/stable/installing/)
|
||||
- Install pytap2
|
||||
* Install pytap2
|
||||
```bash
|
||||
sudo pip3 install --upgrade pytap2
|
||||
```
|
||||
- Install meshtastic:
|
||||
* Install meshtastic:
|
||||
```bash
|
||||
sudo pip3 install --upgrade meshtastic
|
||||
```
|
||||
## Windows
|
||||
|
||||
- Check that your computer has the required serial drivers installed
|
||||
</TabItem>
|
||||
<TabItem value="macos">
|
||||
|
||||
* Check that your computer has the required serial drivers installed
|
||||
* Connect your Meshtastic device to your USB port
|
||||
* Navigate to `Apple Menu > About This Mac > System Report... > Hardware > USB`
|
||||
* You should see something like `CP210X USB to UART Bridge Controller`
|
||||
* If not download the drivers from [Silicon Labs](https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers).
|
||||
* Check that your computer has Python 3 installed.
|
||||
* Use the command
|
||||
```bash
|
||||
python3 -V
|
||||
```
|
||||
* If this does not return a version, install [python](https://www.python.org)
|
||||
* The following uses Homebrew to install `python3` which includes `pip3`.
|
||||
* 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.
|
||||
* Install Python3
|
||||
```bash
|
||||
brew install python3
|
||||
```
|
||||
* Pip is typically installed if you are using python 3 version >= 3.4
|
||||
* Check that pip is installed using this command
|
||||
```bash
|
||||
pip3 -V
|
||||
```
|
||||
* If this does not return a version, install [pip](https://pip.pypa.io/en/stable/installing/)
|
||||
* Install pytap2
|
||||
```bash
|
||||
sudo pip3 install --upgrade pytap2
|
||||
```
|
||||
* Install meshtastic:
|
||||
```bash
|
||||
sudo pip3 install --upgrade meshtastic
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="windows">
|
||||
|
||||
* Check that your computer has the required serial drivers installed
|
||||
* Connect your Meshtastic device to your USB port
|
||||
* Open Device Manager
|
||||
* Under `Ports (COM & LPT)` you should see something like `Silicon Labs CP210X USB to UART Bridge (COM5)`
|
||||
* If not download the drivers from [Silicon Labs](https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers).
|
||||
- Check that your computer has Python 3 installed.
|
||||
* Check that your computer has Python 3 installed.
|
||||
* Use the command
|
||||
```powershell
|
||||
py -V
|
||||
```
|
||||
* If this does not return a version, install [python](https://www.python.org)
|
||||
- Pip is typically installed if you are using python 3 version >= 3.4
|
||||
* Pip is typically installed if you are using python 3 version >= 3.4
|
||||
* Check that pip is installed using this command
|
||||
```powershell
|
||||
pip3 -V
|
||||
```
|
||||
* If this does not return a version, install [pip](https://pip.pypa.io/en/stable/installing/)
|
||||
- Install pytap2
|
||||
* Install pytap2
|
||||
```powershell
|
||||
pip3 install --upgrade pytap2
|
||||
```
|
||||
- Install meshtastic:
|
||||
* Install meshtastic:
|
||||
```powershell
|
||||
pip3 install --upgrade meshtastic
|
||||
```
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
|
@ -1,7 +1,6 @@
|
|||
module.exports = {
|
||||
Sidebar: {
|
||||
"Getting Started": [
|
||||
"getting-started/about",
|
||||
"getting-started/overview",
|
||||
"getting-started/flashing-firmware",
|
||||
{
|
||||
|
|
@ -135,7 +134,6 @@ module.exports = {
|
|||
"hardware/wisBlock-hardware",
|
||||
],
|
||||
},
|
||||
"hardware/behaviour",
|
||||
{
|
||||
"Antennas": [
|
||||
"hardware/antenna/antenna",
|
||||
|
|
|
|||
Loading…
Reference in a new issue