mirror of
https://github.com/meshtastic/meshtastic.git
synced 2025-01-12 22:37:33 -08:00
Additional docs cleanup, remove notes and out of date docs
This commit is contained in:
Garth Vander Houwen
parent
513b5f3e3f
commit
5e975b1348
|
|
@ -14,7 +14,7 @@ Meshtastic® is a project that lets you use inexpensive LoRa radios as a long ra
|
|||
|
||||
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.
|
||||
|
||||
Meshtastic uses LoRa for the long range communications and depending on settings used, the maximum theoretical group size ranges from 30-200 device nodes. Currently, each device can only support a connection from a single user at a time.
|
||||
Meshtastic uses LoRa for the long range communications and depending on settings used up to 80 device nodes. Each device supports a connection from a single user at a time.
|
||||
|
||||
<div className="indexCtasBody">
|
||||
<Link
|
||||
|
|
@ -25,26 +25,14 @@ Meshtastic uses LoRa for the long range communications and depending on settings
|
|||
</Link>
|
||||
</div>
|
||||
|
||||
## 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
|
||||
|
||||
One option for people located in the US to buy the necessary 18650 Li-Ion battery from https://www.18650batterystore.com/. At this store, the [Sanyo NCR18650GA 3500mAh 10A Battery](https://www.18650batterystore.com/collections/featured-products/products/sanyo-ncr18650ga) is considered a good option.
|
||||
|
||||
#### Purchase other accessories
|
||||
## Supported Hardware
|
||||
|
||||
<div className="indexCtasBody">
|
||||
<Link
|
||||
className={'button button--outline button--lg cta--button'}
|
||||
to={'/docs/hardware'}
|
||||
to={'/docs/category/supported-hardware'}
|
||||
>
|
||||
Purchase Hardware
|
||||
Supported Hardware
|
||||
</Link>
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ sidebar_label: Heltec
|
|||
sidebar_position: 6
|
||||
---
|
||||
|
||||
## WiFi LoRa 32 (V2)
|
||||
## WiFi LoRa 32 (V2) * Not Reccomended
|
||||
|
||||
- ESP32 - Wifi & Bluetooth
|
||||
- SX127x - LoRa Transceiver
|
||||
|
|
|
|||
|
|
@ -1,16 +0,0 @@
|
|||
---
|
||||
id: linux
|
||||
title: Linux Compatible Hardware
|
||||
sidebar_label: Linux
|
||||
sidebar_position: 7
|
||||
---
|
||||
|
||||
This page is a place holder.
|
||||
|
||||
The device software can run on hardware that runs Linux to execute unit tests.
|
||||
|
||||
Fledgling support for a LoRa USB dongle has been in the works.
|
||||
|
||||
This page will be updated with more information as information is made available.
|
||||
|
||||
Please be mindful that a lot of this is incomplete, so please don't get too excited and asking for builds and/or timelines.
|
||||
|
|
@ -7,7 +7,7 @@ sidebar_position: 2
|
|||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
There are several versions of the LILYGO® Lora
|
||||
LILYGO® Lora23 v1-2.1 * Versions other than 2.1 not reccomended with a battery
|
||||
|
||||
<Tabs
|
||||
groupId="t-lora"
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: wisBlock
|
||||
title: RAK WisBlock
|
||||
sidebar_label: RAK WisBlock
|
||||
sidebar_position: 3
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: techo
|
||||
title: LILYGO® TTGO T-Echo devices
|
||||
sidebar_label: LILYGO® T-Echo
|
||||
sidebar_position: 4
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
The T-Echo is the latest device to be release by LILYGO® supporting a low power consumption microcontroller.
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ Default settings values are prefered whenever possible as they consume no bandwi
|
|||
|
||||
## Config Sections
|
||||
|
||||
Meshtastic config is now broken into 6 sections. [Device](settings/config/device), [Display](settings/config/display), [LoRa](settings/config/lora), [Position](settings/config/position), [Power](settings/config/power) and [WiFi](settings/config/wifi).
|
||||
Meshtastic config is now broken into 6 sections. [Device](settings/config/device), [Display](settings/config/display), [LoRa](settings/config/lora), [Position](settings/config/position), [Power](settings/config/power), [User](settings/config/user) and [WiFi](settings/config/wifi).
|
||||
|
||||
## Module Config
|
||||
|
||||
|
|
|
|||
|
|
@ -1,61 +0,0 @@
|
|||
---
|
||||
id: install-OSX
|
||||
title: OSX Install
|
||||
sidebar_label: OSX
|
||||
---
|
||||
|
||||
(Here's some quick tips and [troubleshooting](#troubleshooting) on installing the device code from OS-X, thanks to @android606)
|
||||
|
||||
First time using LoRa for anything, just checking it out.
|
||||
|
||||
I bought a T-Beam on eBay, followed the instructions to install the firmware here:
|
||||
[https://github.com/meshtastic/Meshtastic-esp32](https://github.com/meshtastic/Meshtastic-esp32)
|
||||
|
||||
I'm using a Mac for this, so that might account for differences in the steps to get it working. I just swapped out my SSD last month, I'm using a pretty fresh install of OS X 10.15.3/Catalina.
|
||||
|
||||
I got it working fairly smoothly, but there were two hang-ups I thought I'd mention:
|
||||
|
||||
1. I am about 0% familiar with Python, so there were some issues getting esptool.py working. Basically, this OS X comes with Python 2.7 and no pip. Pip installed okay, so I used it to install esptool. Esptool appeared to install correctly, but I couldn't get it to work to save my life. Simply typing "esptool.py" doesn't work, and I just don't know enough python to figure out why. For some reason, it installs but isn't in the \$PATH anywhere, and I don't know where it went. Python 2.7 kept giving me warning messages about being old and unsupported, so I figured that might be a hint that I should upgrade.
|
||||
|
||||
I ended up doing this:
|
||||
|
||||
- brew install pyenv (to install pyenv)
|
||||
- pyenv install 3.7.7 (to install and select python 3.7.7)
|
||||
- pyenv global 3.7.7 (to select the new version of python)
|
||||
- brew install pip (to install pip3)
|
||||
- pip3 install --upgrade esptool (note I specifically had to use "pip3", not "pip")
|
||||
|
||||
...then I was able to execute esptool.py
|
||||
|
||||
2. esptool.py didn't work though, because the virtual com port wasn't showing up as a device. I had to install a driver from Silicon Labs, which I got here:
|
||||
[driver for the CP210X USB to UART bridge from Silicon Labs](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)
|
||||
|
||||
After I installed that, esptool.py was completely happy and the firmware loaded right up.
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
**1. Running into trouble when installing `esptool` via brew**
|
||||
|
||||
- Make sure that `openssl` is installed first:
|
||||
|
||||
```
|
||||
brew install openssl
|
||||
```
|
||||
|
||||
- Set some flags in your bash/zsh/whichever profile for `esptool` to install [cryptography](https://cryptography.io/en/latest/installation) as a dependency correctly:
|
||||
|
||||
```
|
||||
export LDFLAGS="-L/usr/local/opt/openssl/lib"
|
||||
export CPPFLAGS="-I/usr/local/opt/openssl/include"
|
||||
export PKG_CONFIG_PATH="/usr/local/opt/openssl/lib/pkgconfig"
|
||||
```
|
||||
|
||||
- attempt a reinstall of esptool
|
||||
|
||||
```
|
||||
pip3 install --upgrade esptool
|
||||
```
|
||||
|
||||
**2. I can't see the usb device as `/dev/tty[something]`:**
|
||||
|
||||
- Driver config successfully tested on Big Sur v11.6.2: https://github.com/WCHSoftGroup/ch34xser_macos
|
||||
|
|
@ -1,38 +0,0 @@
|
|||
---
|
||||
id: pinetab
|
||||
title: Pinetab
|
||||
sidebar_label: Pinetab
|
||||
---
|
||||
|
||||
These are **preliminary** notes on support for Meshtastic in the Pinetab.
|
||||
|
||||
A RF95 is connected via a CH341 USB-SPI chip.
|
||||
|
||||
Pin assignments:
|
||||
CS0 from RF95 goes to CS0 on CH341
|
||||
DIO0 from RF95 goes to INT on CH341
|
||||
RST from RF95 goes to RST on CH341
|
||||
|
||||
This Linux driver claims to provide USB-SPI support: https://github.com/gschorcht/spi-ch341-usb
|
||||
Notes here on using that driver: https://www.linuxquestions.org/questions/linux-hardware-18/ch341-usb-to-spi-adaptor-driver-doesn%27t-work-4175622736/
|
||||
|
||||
Or if **absolutely** necessary could bit bang: https://www.cnx-software.com/2018/02/16/wch-ch341-usb-to-serial-chip-gets-linux-driver-to-control-gpios-over-usb/
|
||||
|
||||
## Portduino tasks
|
||||
|
||||
- How to access SPI devices via ioctl (spidev): https://www.raspberrypi.org/documentation/hardware/raspberrypi/spi/README.md#:~:text=Troubleshooting-,Overview,bus)%2C%20UARTs%2C%20etc.
|
||||
- access GPIO via libgpiod?
|
||||
- Use dkms to distribute driver?
|
||||
- echo 100 > /sys/module/spi_ch341_usb/parameters/poll_period
|
||||
|
||||
## Task list
|
||||
|
||||
- Port meshtastic to build (under PlatformIO) for a POSIX target. spec: no screen, no GPIOs, SIM network interface, POSIX threads, POSIX semaphores & queues, IO to the console only
|
||||
Use ARM Linux: https://platformio.org/platforms/linux_arm
|
||||
And Linux native: https://platformio.org/platforms/native
|
||||
|
||||
- Test cs341 driver - just test reading/writing a register and detecting interrupts, confirm can see rf95
|
||||
- Make a radiolib SPI module that targets the cs341 (and builds on Linux)
|
||||
- use new radiolib module to hook pinebook LoRa to meshtastic, confirm mesh discovery works
|
||||
- Make a subclass of StreamAPI that works as a POSIX TCP server
|
||||
- Use new TCP endpoint from meshtastic-python
|
||||
|
|
@ -1,10 +0,0 @@
|
|||
---
|
||||
id: rak815
|
||||
title: RAK815
|
||||
sidebar_label: RAK815
|
||||
---
|
||||
|
||||
Notes on trying to get the RAK815 working with meshtastic.
|
||||
|
||||
good tutorial: https://www.hackster.io/naresh-krish/getting-started-with-rak815-tracker-module-and-arduino-1c7bc9
|
||||
(includes software serial link - possibly useful for GPS)
|
||||
Loading…
Reference in a new issue