mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-12-25 05:34:11 -08:00
Hardware pages (#299)
* initial devices.json * initial hardware components * testing page at /docs/hardware/supported/template * WIP Changes * Home page work & updates * Fix build * Fix external link button * Setup linting * rename, cleanup & lint * seperate lint cmd for now Co-authored-by: Foster Irwin <foster@jfirwin.com> Co-authored-by: Sacha Weatherstone <sachaw100@hotmail..om>
This commit is contained in:
parent
065c287941
commit
9dc879235f
8
.eslintrc.cjs
Normal file
8
.eslintrc.cjs
Normal file
|
@ -0,0 +1,8 @@
|
||||||
|
/** @type {import("eslint").Linter.Config} */
|
||||||
|
module.exports = {
|
||||||
|
extends: "@meshtastic/eslint-config",
|
||||||
|
parserOptions: {
|
||||||
|
tsconfigRootDir: __dirname,
|
||||||
|
project: ["./tsconfig.json"],
|
||||||
|
},
|
||||||
|
};
|
1
.prettierrc
Normal file
1
.prettierrc
Normal file
|
@ -0,0 +1 @@
|
||||||
|
"@meshtastic/eslint-config/prettier"
|
|
@ -47,24 +47,24 @@ nodejs is required in your dev. environment. The method for installing nodejs de
|
||||||
|
|
||||||
Fork then clone the repository:
|
Fork then clone the repository:
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
git clone https://github.com/meshtastic/meshtastic
|
git clone https://github.com/meshtastic/meshtastic
|
||||||
```
|
```
|
||||||
|
|
||||||
Go to the root directory of your repository and install dependencies:
|
Go to the root directory of your repository and install dependencies:
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
yarn install
|
yarn install
|
||||||
```
|
```
|
||||||
|
|
||||||
Build the project with the following command
|
Build the project with the following command
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
yarn build
|
yarn build
|
||||||
```
|
```
|
||||||
|
|
||||||
Start a local dev. instance with the following command
|
Start a local dev. instance with the following command
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
yarn start
|
yarn start
|
||||||
```
|
```
|
||||||
|
|
|
@ -14,7 +14,7 @@ Meshtastic uses the [PlatformIO](https://platformio.org) development environment
|
||||||
|
|
||||||
3. Clone the [Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules)
|
3. Clone the [Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules)
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
git submodule update --init
|
git submodule update --init
|
||||||
```
|
```
|
||||||
|
|
|
@ -4,7 +4,7 @@ title: Bluetooth/serial/TCP protocol API
|
||||||
sidebar_label: Device API
|
sidebar_label: Device API
|
||||||
---
|
---
|
||||||
|
|
||||||
This document describes the protocol for external API clients using our devices. If you are interested in running your own code on the device itself, see the [module API](module-api.md) documentation instead.
|
This document describes the protocol for external API clients using our devices. If you are interested in running your own code on the device itself, see the [module API](module-api) documentation instead.
|
||||||
|
|
||||||
The Device API is design to have only a simple stream of ToRadio and FromRadio packets and all polymorphism comes from the flexible set of Google Protocol Buffers which are sent over the wire. We use protocol buffers extensively both for the Bluetooth API and for packets inside the mesh or when providing packets to other applications on the phone.
|
The Device API is design to have only a simple stream of ToRadio and FromRadio packets and all polymorphism comes from the flexible set of Google Protocol Buffers which are sent over the wire. We use protocol buffers extensively both for the Bluetooth API and for packets inside the mesh or when providing packets to other applications on the phone.
|
||||||
|
|
|
@ -10,7 +10,7 @@ The routing protocol for Meshtastic is really quite simple (and suboptimal). It
|
||||||
|
|
||||||
### A Note About Protocol Buffers
|
### A Note About Protocol Buffers
|
||||||
|
|
||||||
Because we want our devices to work across various vendors and implementations, we use [Protocol Buffers](https://github.com/meshtastic/Meshtastic-protobufs) pervasively. For information on how the protocol buffers are used with respect to API clients see [sw-design](/software/other/sw-design.md), for purposes of this document you mostly only
|
Because we want our devices to work across various vendors and implementations, we use [Protocol Buffers](https://github.com/meshtastic/Meshtastic-protobufs) pervasively. For information on how the protocol buffers are used with respect to API clients see [sw-design](/docs/software/other/sw-design), for purposes of this document you mostly only
|
||||||
need to consider the MeshPacket and Subpacket message types.
|
need to consider the MeshPacket and Subpacket message types.
|
||||||
|
|
||||||
### Later 0: LoRa Radio
|
### Later 0: LoRa Radio
|
|
@ -74,7 +74,7 @@ Note: The link budget used by these calculations assumes a transmit power of 17d
|
||||||
|
|
||||||
You may want to select other channels for your usage. The other settings can be set by using the Python API.
|
You may want to select other channels for your usage. The other settings can be set by using the Python API.
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
meshtastic --ch-set spread_factor 10 --ch-set coding_rate 4 --ch-set bandwidth 125 --ch-index 0
|
meshtastic --ch-set spread_factor 10 --ch-set coding_rate 4 --ch-set bandwidth 125 --ch-index 0
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -110,6 +110,6 @@ The preshared key used by the devices can be modified.
|
||||||
|
|
||||||
Use of cryptography can also be modified. To disable cryptography (maybe useful if you have Ham radio license):
|
Use of cryptography can also be modified. To disable cryptography (maybe useful if you have Ham radio license):
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
meshtastic --setchan psk 0
|
meshtastic --setchan psk 0
|
||||||
```
|
```
|
|
@ -20,7 +20,7 @@ Backtrace: 0x....
|
||||||
|
|
||||||
Now run the exception decoder:
|
Now run the exception decoder:
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
bin/exception_decoder.py backtrace.txt
|
bin/exception_decoder.py backtrace.txt
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -28,6 +28,6 @@ bin/exception_decoder.py backtrace.txt
|
||||||
|
|
||||||
In order to decode stack traces in real time, kep the following command (replacing `DEVICE_PORT` with your device's port) running in your terminal with the suspect device connected
|
In order to decode stack traces in real time, kep the following command (replacing `DEVICE_PORT` with your device's port) running in your terminal with the suspect device connected
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
pio device monitor --port DEVICE_PORT -f esp32_exception_decoder
|
pio device monitor --port DEVICE_PORT -f esp32_exception_decoder
|
||||||
```
|
```
|
|
@ -34,34 +34,34 @@ Assuming you have the [prerequisites installed](serve-docs-locally#prerequisites
|
||||||
|
|
||||||
1. Fork/Clone the [meshtastic/Meshtastic](https://github.com/meshtastic/Meshtastic) repository and navigate to the root directory of the project.
|
1. Fork/Clone the [meshtastic/Meshtastic](https://github.com/meshtastic/Meshtastic) repository and navigate to the root directory of the project.
|
||||||
|
|
||||||
```bash title="Clone the project"
|
```shell title="Clone the project"
|
||||||
git clone https://github.com/meshtastic/Meshtastic.git
|
git clone https://github.com/meshtastic/Meshtastic.git
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Clone fork of the project"
|
```shell title="Clone fork of the project"
|
||||||
git clone https://github.com/[username]/Meshtastic.git
|
git clone https://github.com/[username]/Meshtastic.git
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Change Directory"
|
```shell title="Change Directory"
|
||||||
cd ~/Meshtastic
|
cd ~/Meshtastic
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Install Dependencies
|
2. Install Dependencies
|
||||||
|
|
||||||
```bash title="Install dependencies using Yarn"
|
```shell title="Install dependencies using Yarn"
|
||||||
yarn install
|
yarn install
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Run Docusaurus
|
3. Run Docusaurus
|
||||||
|
|
||||||
```bash title="Run node.js server"
|
```shell title="Run node.js server"
|
||||||
yarn start
|
yarn start
|
||||||
```
|
```
|
||||||
|
|
||||||
:::tip
|
:::tip
|
||||||
Before submitting a pull request, it's helpful to run the following command to ensure there are no broken links or errors:
|
Before submitting a pull request, it's helpful to run the following command to ensure there are no broken links or errors:
|
||||||
|
|
||||||
```bash title="Build Project"
|
```shell title="Build Project"
|
||||||
yarn build
|
yarn build
|
||||||
```
|
```
|
||||||
|
|
|
@ -27,32 +27,32 @@ Log into Github and create a fork of the [meshtastic/Meshtastic](https://github.
|
||||||
Replace `username` with your Github username.
|
Replace `username` with your Github username.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
```bash title="Clone username/Meshtastic Repo"
|
```shell title="Clone username/Meshtastic Repo"
|
||||||
git clone https://github.com/username/Meshtastic.git
|
git clone https://github.com/username/Meshtastic.git
|
||||||
```
|
```
|
||||||
|
|
||||||
### Change directory to Local copy
|
### Change directory to Local copy
|
||||||
|
|
||||||
```bash title="Change Directory"
|
```shell title="Change Directory"
|
||||||
cd ~/Meshtastic
|
cd ~/Meshtastic
|
||||||
```
|
```
|
||||||
|
|
||||||
### Install Dependencies
|
### Install Dependencies
|
||||||
|
|
||||||
```bash title="Install dependencies using Yarn"
|
```shell title="Install dependencies using Yarn"
|
||||||
yarn install
|
yarn install
|
||||||
```
|
```
|
||||||
|
|
||||||
### Run Development Server
|
### Run Development Server
|
||||||
|
|
||||||
```bash title="Run node.js server"
|
```shell title="Run node.js server"
|
||||||
yarn start
|
yarn start
|
||||||
```
|
```
|
||||||
|
|
||||||
:::tip
|
:::tip
|
||||||
Before submitting a pull request, it's helpful to run the following command to ensure there are no broken links or errors:
|
Before submitting a pull request, it's helpful to run the following command to ensure there are no broken links or errors:
|
||||||
|
|
||||||
```bash title="Build Project"
|
```shell title="Build Project"
|
||||||
yarn build
|
yarn build
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -62,20 +62,26 @@ yarn build
|
||||||
|
|
||||||
### Verify Upstream Remote is Set
|
### Verify Upstream Remote is Set
|
||||||
|
|
||||||
```bash title="Check Remote and Upstream Repositories"
|
```shell title="Check Remote and Upstream Repositories"
|
||||||
git remote -v
|
git remote -v
|
||||||
```
|
```
|
||||||
|
|
||||||
If it's set, skip to [Align with meshtastic/Meshtastic Master branch](#align-with-meshtasticmeshtastic-master-branch)
|
If it's set, skip to [Align with meshtastic/Meshtastic Master branch](#align-with-meshtasticmeshtastic-master-branch)
|
||||||
|
|
||||||
#### Update/Set Upstream if it isn't configured properly
|
#### Update/Set Upstream if it isn't configured properly
|
||||||
|
|
||||||
If upstream exists, set the url:
|
If upstream exists, set the url:
|
||||||
```bash title="Update Upstream Repository"
|
|
||||||
|
```shell title="Update Upstream Repository"
|
||||||
git remote set-url upstream https://github.com/meshtastic/Meshtastic.git
|
git remote set-url upstream https://github.com/meshtastic/Meshtastic.git
|
||||||
```
|
```
|
||||||
|
|
||||||
If upstream doesn't exist, add the url:
|
If upstream doesn't exist, add the url:
|
||||||
```bash title="Add Upstream Repository"
|
|
||||||
|
```shell title="Add Upstream Repository"
|
||||||
git remote add upstream https://github.com/meshtastic/Meshtastic.git
|
git remote add upstream https://github.com/meshtastic/Meshtastic.git
|
||||||
```
|
```
|
||||||
|
|
||||||
### Align with meshtastic/Meshtastic Master branch
|
### Align with meshtastic/Meshtastic Master branch
|
||||||
|
|
||||||
:::caution
|
:::caution
|
||||||
|
@ -86,6 +92,6 @@ This will delete any unfinished work. Make sure that you've saved and committed
|
||||||
The following command assumes the clone of your Meshtastic fork is in the home directory (`~/Meshtastic`). Adjust the path to the correct path on your machine.
|
The following command assumes the clone of your Meshtastic fork is in the home directory (`~/Meshtastic`). Adjust the path to the correct path on your machine.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
```bash title="Rebase local Meshtastic to remote Meshtastic"
|
```shell title="Rebase local Meshtastic to remote Meshtastic"
|
||||||
cd ~/Meshtastic ; git fetch upstream ; git checkout master ; git rebase upstream/master
|
cd ~/Meshtastic ; git fetch upstream ; git checkout master ; git rebase upstream/master
|
||||||
```
|
```
|
|
@ -12,7 +12,7 @@ If you’d like to do ‘real’ releases with your changes, the procedure is:
|
||||||
|
|
||||||
- Update protobufs
|
- Update protobufs
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
cd proto
|
cd proto
|
||||||
git checkout master && git pull
|
git checkout master && git pull
|
||||||
cd ..
|
cd ..
|
|
@ -4,7 +4,7 @@ title: Meshtastic Clients
|
||||||
sidebar_label: Meshtastic Clients
|
sidebar_label: Meshtastic Clients
|
||||||
---
|
---
|
||||||
|
|
||||||
import { DownloadCard } from '/src/pages/downloads/\_components/DownloadCard.tsx'
|
import { DownloadCard } from '/src/pages/downloads/_components/DownloadCard.tsx';
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
|
@ -20,11 +20,11 @@ To install the prebuilt binary refer to: [Meshtastic-python standalone executabl
|
||||||
|
|
||||||
To install/upgrade Meshtastic-python manually, see below:
|
To install/upgrade Meshtastic-python manually, see below:
|
||||||
|
|
||||||
```bash title="Install Meshtastic-python (includes CLI)"
|
```shell title="Install Meshtastic-python (includes CLI)"
|
||||||
pip install meshtastic
|
pip install meshtastic
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Upgrade Meshtastic-python (includes CLI)"
|
```shell title="Upgrade Meshtastic-python (includes CLI)"
|
||||||
pip install --upgrade meshtastic
|
pip install --upgrade meshtastic
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -36,11 +36,11 @@ Some installations of python may require you to substitute 'pip3' for the 'pip'
|
||||||
|
|
||||||
After installing, run one of the following commands to see if the device is communicating correctly.
|
After installing, run one of the following commands to see if the device is communicating correctly.
|
||||||
|
|
||||||
```bash title="View connected node info"
|
```shell title="View connected node info"
|
||||||
meshtastic --info
|
meshtastic --info
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="View nodes detected on mesh"
|
```shell title="View nodes detected on mesh"
|
||||||
meshtastic --nodes
|
meshtastic --nodes
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -50,25 +50,35 @@ For more details about CLI usage, see the [settings](/docs/settings) pages or [C
|
||||||
|
|
||||||
<ul
|
<ul
|
||||||
style={{
|
style={{
|
||||||
position: "relative",
|
position: 'relative',
|
||||||
display: "grid",
|
display: 'grid',
|
||||||
gap: "1.5rem",
|
gap: '1.5rem',
|
||||||
gridTemplateColumns: "repeat(auto-fill, minmax(280px, 1fr))",
|
gridTemplateColumns: 'repeat(auto-fill, minmax(280px, 1fr))',
|
||||||
paddingLeft: "0",
|
paddingLeft: '0',
|
||||||
}}
|
}}
|
||||||
>
|
>
|
||||||
<DownloadCard
|
<DownloadCard
|
||||||
client="Android"
|
client="Android"
|
||||||
imgUrl="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png"
|
imgUrl="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png"
|
||||||
url="https://play.google.com/store/apps/details?id=com.geeksville.mesh&referrer=utm_source=downloads-page"
|
url="https://play.google.com/store/apps/details?id=com.geeksville.mesh&referrer=utm_source=downloads-page"
|
||||||
notes={["To sideload, ",<a href="https://github.com/meshtastic/Meshtastic-Android/releases/latest" rel="noreferrer" target="_blank">download the latest .apk</a>," from Github", ]}
|
notes={[
|
||||||
/>
|
'To sideload, ',
|
||||||
<DownloadCard
|
<a
|
||||||
client="iOS"
|
href="https://github.com/meshtastic/Meshtastic-Android/releases/latest"
|
||||||
url="https://testflight.apple.com/join/c8nNl8q1"
|
rel="noreferrer"
|
||||||
buttonText="Download on TestFlight"
|
target="_blank"
|
||||||
notes="Currently only available in TestFlight"
|
>
|
||||||
/>
|
download the latest .apk
|
||||||
|
</a>,
|
||||||
|
' from Github',
|
||||||
|
]}
|
||||||
|
/>
|
||||||
|
<DownloadCard
|
||||||
|
client="iOS"
|
||||||
|
url="https://testflight.apple.com/join/c8nNl8q1"
|
||||||
|
buttonText="Download on TestFlight"
|
||||||
|
notes="Currently only available in TestFlight"
|
||||||
|
/>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
### Serial
|
### Serial
|
|
@ -41,27 +41,27 @@ values={[
|
||||||
|
|
||||||
Check if you have `python3` and `pip` installed with the following command
|
Check if you have `python3` and `pip` installed with the following command
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
python3 --version
|
python3 --version
|
||||||
pip3 --version
|
pip3 --version
|
||||||
```
|
```
|
||||||
|
|
||||||
If `python3` is not installed, install with
|
If `python3` is not installed, install with
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
sudo apt-get update
|
sudo apt-get update
|
||||||
sudo apt-get install python3
|
sudo apt-get install python3
|
||||||
```
|
```
|
||||||
|
|
||||||
If `pip` is not installed, install with
|
If `pip` is not installed, install with
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
sudo apt-get install python3-pip
|
sudo apt-get install python3-pip
|
||||||
```
|
```
|
||||||
|
|
||||||
### Install `esptool`
|
### Install `esptool`
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
pip3 install --upgrade esptool
|
pip3 install --upgrade esptool
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -75,7 +75,7 @@ OS X comes with `Python 2.7` installed, but not `pip`. The following uses Homebr
|
||||||
:::note
|
:::note
|
||||||
Check if you have Homebrew installed with the following command
|
Check if you have Homebrew installed with the following command
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
brew -v
|
brew -v
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -84,7 +84,7 @@ If it's not installed, follow the instructions on the [Homebrew website](https:/
|
||||||
|
|
||||||
Check if you have `python3` and `pip` installed with the following command
|
Check if you have `python3` and `pip` installed with the following command
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
python3 --version
|
python3 --version
|
||||||
pip3 --version
|
pip3 --version
|
||||||
```
|
```
|
||||||
|
@ -92,19 +92,19 @@ pip3 --version
|
||||||
If `python3` is not installed, install with
|
If `python3` is not installed, install with
|
||||||
Install Python3
|
Install Python3
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
brew install python3
|
brew install python3
|
||||||
```
|
```
|
||||||
|
|
||||||
Confirm `pip3` was installed alongside `python3`
|
Confirm `pip3` was installed alongside `python3`
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
pip3 -v
|
pip3 -v
|
||||||
```
|
```
|
||||||
|
|
||||||
### Install `esptool`
|
### Install `esptool`
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
pip3 install --upgrade esptool
|
pip3 install --upgrade esptool
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -117,11 +117,11 @@ pip3 install --upgrade esptool
|
||||||
:::note
|
:::note
|
||||||
Confirm installation of `python` & `pip` with the following commands.
|
Confirm installation of `python` & `pip` with the following commands.
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
py --version
|
py --version
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
pip --version
|
pip --version
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -129,7 +129,7 @@ pip --version
|
||||||
|
|
||||||
### Install `esptool`
|
### Install `esptool`
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
pip install --upgrade esptool
|
pip install --upgrade esptool
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -159,11 +159,11 @@ On Windows, you must explicitly declare esptool as a .py script. Use `esptool.py
|
||||||
|
|
||||||
Connect the radio to your computer using a data USB cable. Confirm your device is talking to your computer using the following command:
|
Connect the radio to your computer using a data USB cable. Confirm your device is talking to your computer using the following command:
|
||||||
|
|
||||||
```bash title="Command"
|
```shell title="Command"
|
||||||
esptool chip_id
|
esptool chip_id
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Expected Output"
|
```shell title="Expected Output"
|
||||||
# You should see a result similar to this:
|
# You should see a result similar to this:
|
||||||
mydir$ esptool chip_id
|
mydir$ esptool chip_id
|
||||||
esptool.py v2.6
|
esptool.py v2.6
|
||||||
|
@ -186,7 +186,7 @@ Hard resetting via RTS pin...
|
||||||
|
|
||||||
`cd` into the directory where you unzipped the latest release. For example:
|
`cd` into the directory where you unzipped the latest release. For example:
|
||||||
|
|
||||||
```bash title="Example"
|
```shell title="Example"
|
||||||
cd ~/Downloads/firmware/
|
cd ~/Downloads/firmware/
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -210,13 +210,13 @@ values={[
|
||||||
|
|
||||||
#### Install
|
#### Install
|
||||||
|
|
||||||
```bash title="Command"
|
```shell title="Command"
|
||||||
./device-install.sh -f firmware-BOARD-VERSION.bin
|
./device-install.sh -f firmware-BOARD-VERSION.bin
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Update
|
#### Update
|
||||||
|
|
||||||
```bash title="Command"
|
```shell title="Command"
|
||||||
./device-update.sh -f firmware-BOARD-VERSION.bin
|
./device-update.sh -f firmware-BOARD-VERSION.bin
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -225,13 +225,13 @@ values={[
|
||||||
|
|
||||||
#### Install
|
#### Install
|
||||||
|
|
||||||
```bash title="Command"
|
```shell title="Command"
|
||||||
./device-install.sh -f firmware-BOARD-VERSION.bin
|
./device-install.sh -f firmware-BOARD-VERSION.bin
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Update
|
#### Update
|
||||||
|
|
||||||
```bash title="Command"
|
```shell title="Command"
|
||||||
./device-update.sh -f firmware-BOARD-VERSION.bin
|
./device-update.sh -f firmware-BOARD-VERSION.bin
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -240,13 +240,13 @@ values={[
|
||||||
|
|
||||||
#### Install
|
#### Install
|
||||||
|
|
||||||
```bash title="Command"
|
```shell title="Command"
|
||||||
./device-install.bat -f firmware-BOARD-VERSION.bin
|
./device-install.bat -f firmware-BOARD-VERSION.bin
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Update
|
#### Update
|
||||||
|
|
||||||
```bash title="Command"
|
```shell title="Command"
|
||||||
./device-update.bat -f firmware-BOARD-VERSION.bin
|
./device-update.bat -f firmware-BOARD-VERSION.bin
|
||||||
```
|
```
|
||||||
|
|
|
@ -45,11 +45,12 @@ values={[
|
||||||
<TabItem value="linux">
|
<TabItem value="linux">
|
||||||
Connect your Meshtastic device to your USB port, open a `Terminal` and enter the following command:
|
Connect your Meshtastic device to your USB port, open a `Terminal` and enter the following command:
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
lsusb
|
lsusb
|
||||||
```
|
```
|
||||||
|
|
||||||
You should see something like: `ID xxxx:xxxx Silicon Labs CP210x UART Bridge`, `ID xxxx:xxxx QinHeng Electronics USB Single Serial`, or `FIXME (WISBLOCK OUTPUT)`.
|
You should see something like: `ID xxxx:xxxx Silicon Labs CP210x UART Bridge`, `ID xxxx:xxxx QinHeng Electronics USB Single Serial`, or `FIXME (WISBLOCK OUTPUT)`.
|
||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
<TabItem value="macos">
|
<TabItem value="macos">
|
||||||
|
|
||||||
|
@ -134,13 +135,18 @@ With the latest versions of MacOS, the USB Serial driver is built-in. Do _NOT_ d
|
||||||
<summary>Removing the CH34x (CH340/CH341) USB Drivers</summary>
|
<summary>Removing the CH34x (CH340/CH341) USB Drivers</summary>
|
||||||
<div>
|
<div>
|
||||||
<div>
|
<div>
|
||||||
If you have already downloaded/installed the MacOS WCH-IC CH340 ("CH341SER_MAC") drivers via the CH34x_Install_V1.5.pkg, you will have to Uninstall the kernel extension:
|
If you have already downloaded/installed the MacOS WCH-IC CH340
|
||||||
<br />
|
("CH341SER_MAC") drivers via the CH34x_Install_V1.5.pkg, you will have to
|
||||||
<br />
|
Uninstall the kernel extension:
|
||||||
1. Unplug your device<br />
|
<br />
|
||||||
2. Open the Terminal and run:<br />
|
<br />
|
||||||
3. sudo rm -rf /Library/Extensions/usbserial.kext<br />
|
1. Unplug your device
|
||||||
4. Reboot
|
<br />
|
||||||
|
2. Open the Terminal and run:
|
||||||
|
<br />
|
||||||
|
3. sudo rm -rf /Library/Extensions/usbserial.kext
|
||||||
|
<br />
|
||||||
|
4. Reboot
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</details>
|
</details>
|
|
@ -18,7 +18,8 @@ Meshtastic uses LoRa for the long range communications and depending on settings
|
||||||
<div className="indexCtasBody">
|
<div className="indexCtasBody">
|
||||||
<Link
|
<Link
|
||||||
className={'button button--outline button--lg cta--button'}
|
className={'button button--outline button--lg cta--button'}
|
||||||
to={'/docs/about'}>
|
to={'/docs/about'}
|
||||||
|
>
|
||||||
Learn More
|
Learn More
|
||||||
</Link>
|
</Link>
|
||||||
</div>
|
</div>
|
||||||
|
@ -39,8 +40,9 @@ One option for people located in the US to buy the necessary 18650 Li-Ion batter
|
||||||
|
|
||||||
<div className="indexCtasBody">
|
<div className="indexCtasBody">
|
||||||
<Link
|
<Link
|
||||||
className={'button button--outline button--lg cta--button'}
|
className={'button button--outline button--lg cta--button'}
|
||||||
to={'/docs/hardware'}>
|
to={'/docs/hardware'}
|
||||||
|
>
|
||||||
Purchase Hardware
|
Purchase Hardware
|
||||||
</Link>
|
</Link>
|
||||||
</div>
|
</div>
|
||||||
|
@ -72,7 +74,8 @@ The manual firmware installation method will also depend on whether you have an
|
||||||
<div className="indexCtasBody">
|
<div className="indexCtasBody">
|
||||||
<Link
|
<Link
|
||||||
className={'button button--outline button--lg cta--button'}
|
className={'button button--outline button--lg cta--button'}
|
||||||
to={'/docs/getting-started/flashing-firmware'}>
|
to={'/docs/getting-started/flashing-firmware'}
|
||||||
|
>
|
||||||
Flash Firmware
|
Flash Firmware
|
||||||
</Link>
|
</Link>
|
||||||
</div>
|
</div>
|
||||||
|
@ -90,7 +93,8 @@ There are many ways to connect to your new radio!
|
||||||
<div className="indexCtasBody">
|
<div className="indexCtasBody">
|
||||||
<Link
|
<Link
|
||||||
className={'button button--outline button--lg cta--button'}
|
className={'button button--outline button--lg cta--button'}
|
||||||
to={'/docs/getting-started/clients'}>
|
to={'/docs/getting-started/clients'}
|
||||||
|
>
|
||||||
Connect to Node
|
Connect to Node
|
||||||
</Link>
|
</Link>
|
||||||
</div>
|
</div>
|
||||||
|
@ -102,7 +106,8 @@ This is the best part of Meshtastic. Deploying, testing, and optimizing your per
|
||||||
<div className="indexCtasBody">
|
<div className="indexCtasBody">
|
||||||
<Link
|
<Link
|
||||||
className={'button button--outline button--lg cta--button'}
|
className={'button button--outline button--lg cta--button'}
|
||||||
to={'/docs/getting-started/first-steps'}>
|
to={'/docs/getting-started/first-steps'}
|
||||||
|
>
|
||||||
First Steps
|
First Steps
|
||||||
</Link>
|
</Link>
|
||||||
</div>
|
</div>
|
|
@ -29,7 +29,7 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="linux">
|
<TabItem value="linux">
|
||||||
|
|
||||||
```bash title="Check python3 version"
|
```shell title="Check python3 version"
|
||||||
python3 --version
|
python3 --version
|
||||||
# If version is less than v3.6, please update python3
|
# If version is less than v3.6, please update python3
|
||||||
```
|
```
|
||||||
|
@ -37,7 +37,7 @@ python3 --version
|
||||||
</TabItem>
|
</TabItem>
|
||||||
<TabItem value="macos">
|
<TabItem value="macos">
|
||||||
|
|
||||||
```bash title="Check python3 version"
|
```shell title="Check python3 version"
|
||||||
python3 --version
|
python3 --version
|
||||||
# If version is less than v3.6, please update python3
|
# If version is less than v3.6, please update python3
|
||||||
```
|
```
|
||||||
|
@ -45,7 +45,7 @@ python3 --version
|
||||||
</TabItem>
|
</TabItem>
|
||||||
<TabItem value="windows">
|
<TabItem value="windows">
|
||||||
|
|
||||||
```bash title="Check python3 version"
|
```shell title="Check python3 version"
|
||||||
python3 --version
|
python3 --version
|
||||||
# If version is less than v3.9+, please update python3
|
# If version is less than v3.9+, please update python3
|
||||||
```
|
```
|
||||||
|
@ -65,7 +65,7 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="linux">
|
<TabItem value="linux">
|
||||||
|
|
||||||
```bash title="Install python3, pip, and venv"
|
```shell title="Install python3, pip, and venv"
|
||||||
sudo apt update
|
sudo apt update
|
||||||
sudo apt upgrade
|
sudo apt upgrade
|
||||||
sudo apt install -y python3 python3-pip python3-venv
|
sudo apt install -y python3 python3-pip python3-venv
|
||||||
|
@ -100,7 +100,7 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="linux">
|
<TabItem value="linux">
|
||||||
|
|
||||||
```bash title="Install Meshtastic Flasher"
|
```shell title="Install Meshtastic Flasher"
|
||||||
python3 --version
|
python3 --version
|
||||||
# ensure you are using at least python v3.6
|
# ensure you are using at least python v3.6
|
||||||
# change to a directory where you want to create a python virtual environment
|
# change to a directory where you want to create a python virtual environment
|
||||||
|
@ -116,7 +116,7 @@ pip install --upgrade pip
|
||||||
pip install meshtastic-flasher
|
pip install meshtastic-flasher
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Running Meshtastic Flasher"
|
```shell title="Running Meshtastic Flasher"
|
||||||
meshtastic-flasher
|
meshtastic-flasher
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -130,7 +130,6 @@ To install `meshtastic-flasher`, download Meshtastic-flasher.app.zip from https:
|
||||||
|
|
||||||
To install meshtastic-flasher, download meshtastic-flasher.zip from https://github.com/meshtastic/Meshtastic-gui-installer/releases/tag/winapp1.0.3, unzip and run.
|
To install meshtastic-flasher, download meshtastic-flasher.zip from https://github.com/meshtastic/Meshtastic-gui-installer/releases/tag/winapp1.0.3, unzip and run.
|
||||||
|
|
||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
|
|
||||||
|
@ -148,7 +147,7 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="linux">
|
<TabItem value="linux">
|
||||||
|
|
||||||
```bash title="Install Meshtastic Flasher"
|
```shell title="Install Meshtastic Flasher"
|
||||||
python3 --version
|
python3 --version
|
||||||
# ensure you are using at least python v3.6
|
# ensure you are using at least python v3.6
|
||||||
# change to a directory where you want to create a python virtual environment
|
# change to a directory where you want to create a python virtual environment
|
||||||
|
@ -164,14 +163,14 @@ pip install --upgrade pip
|
||||||
pip install meshtastic-flasher
|
pip install meshtastic-flasher
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Running Meshtastic Flasher"
|
```shell title="Running Meshtastic Flasher"
|
||||||
meshtastic-flasher
|
meshtastic-flasher
|
||||||
```
|
```
|
||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
<TabItem value="macos">
|
<TabItem value="macos">
|
||||||
|
|
||||||
```bash title="Install Meshtastic Flasher"
|
```shell title="Install Meshtastic Flasher"
|
||||||
python3 --version
|
python3 --version
|
||||||
# ensure you are using at least python v3.6
|
# ensure you are using at least python v3.6
|
||||||
# change to a directory where you want to create a python virtual environment
|
# change to a directory where you want to create a python virtual environment
|
||||||
|
@ -186,14 +185,14 @@ pip install --upgrade pip
|
||||||
pip install meshtastic-flasher
|
pip install meshtastic-flasher
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Running Meshtastic Flasher"
|
```shell title="Running Meshtastic Flasher"
|
||||||
meshtastic-flasher
|
meshtastic-flasher
|
||||||
```
|
```
|
||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
<TabItem value="windows">
|
<TabItem value="windows">
|
||||||
|
|
||||||
```bash title="Install Meshtastic Flasher"
|
```shell title="Install Meshtastic Flasher"
|
||||||
# open a command prompt
|
# open a command prompt
|
||||||
# create a new directory for the python virtual environment
|
# create a new directory for the python virtual environment
|
||||||
cd c:\
|
cd c:\
|
||||||
|
@ -207,7 +206,7 @@ venv\Scripts\activate
|
||||||
pip install meshtastic-flasher
|
pip install meshtastic-flasher
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Running Meshtastic Flasher"
|
```shell title="Running Meshtastic Flasher"
|
||||||
meshtastic-flasher
|
meshtastic-flasher
|
||||||
```
|
```
|
||||||
|
|
|
@ -54,6 +54,10 @@ There is currently no pin required to pair RAK devices via BLE.
|
||||||
- Don't forget to [update the bootloader](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK4631/Quickstart/#updating-the-bootloader) first! This can be done easily with [Meshtastic-flasher](https://github.com/meshtastic/Meshtastic-gui-installer)
|
- Don't forget to [update the bootloader](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK4631/Quickstart/#updating-the-bootloader) first! This can be done easily with [Meshtastic-flasher](https://github.com/meshtastic/Meshtastic-gui-installer)
|
||||||
- RAK's [GitHub Page](https://github.com/RAKWireless/WisBlock) for the WisBlock
|
- RAK's [GitHub Page](https://github.com/RAKWireless/WisBlock) for the WisBlock
|
||||||
|
|
||||||
<img alt="RAK4631 Core Module" src="/img/hardware/rak4631.png" style={{zoom:'50%'}} />
|
<img
|
||||||
|
alt="RAK4631 Core Module"
|
||||||
|
src="/img/hardware/rak4631.png"
|
||||||
|
style={{ zoom: '50%' }}
|
||||||
|
/>
|
||||||
|
|
||||||
There is development activity to get sensors added in Meshtastic core. For example, the Environment Sensor.
|
There is development activity to get sensors added in Meshtastic core. For example, the Environment Sensor.
|
|
@ -23,4 +23,8 @@ The T-Echo has been in development by LILYGO® over the past few months and has
|
||||||
<!-- * BME280 - Humidity and Pressure Sensor -->
|
<!-- * BME280 - Humidity and Pressure Sensor -->
|
||||||
- Optional case and battery
|
- Optional case and battery
|
||||||
|
|
||||||
<img alt="LILYGO T-Echo" src="/img/hardware/t-echo.png" style={{zoom: '15%'}} />
|
<img
|
||||||
|
alt="LILYGO T-Echo"
|
||||||
|
src="/img/hardware/t-echo.png"
|
||||||
|
style={{ zoom: '15%' }}
|
||||||
|
/>
|
|
@ -16,7 +16,7 @@ This project is still pretty young but moving at a pretty good pace. Not all fea
|
||||||
|
|
||||||
### Q: Do you have plans to commercialize this project
|
### 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).
|
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](/docs/legal/licensing).
|
||||||
|
|
||||||
### Q: Does this project use patented algorithms?
|
### Q: Does this project use patented algorithms?
|
||||||
|
|
|
@ -63,11 +63,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set Allowed Input Source"
|
```shell title="Set Allowed Input Source"
|
||||||
meshtastic --set canned_message_module_allow_input_source "_any"
|
meshtastic --set canned_message_module_allow_input_source "_any"
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Specify Allowed Input Source"
|
```shell title="Specify Allowed Input Source"
|
||||||
meshtastic --set canned_message_module_allow_input_source "rotEnc1"
|
meshtastic --set canned_message_module_allow_input_source "rotEnc1"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -116,11 +116,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Enable Canned Message Module"
|
```shell title="Enable Canned Message Module"
|
||||||
meshtastic --set canned_message_module_enabled true
|
meshtastic --set canned_message_module_enabled true
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable Canned Message Module"
|
```shell title="Disable Canned Message Module"
|
||||||
meshtastic --set canned_message_module_enabled false
|
meshtastic --set canned_message_module_enabled false
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -170,11 +170,12 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Enable Bell Character"
|
|
||||||
|
```shell title="Enable Bell Character"
|
||||||
meshtastic --set canned_message_module_send_bell true
|
meshtastic --set canned_message_module_send_bell true
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable Bell Character"
|
```shell title="Disable Bell Character"
|
||||||
meshtastic --set canned_message_module_send_bell false
|
meshtastic --set canned_message_module_send_bell false
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -224,7 +225,7 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set Canned Messages"
|
```shell title="Set Canned Messages"
|
||||||
meshtastic --set canned_message_module_messages "I'm fine|I'm out|I'm back|Need helping hand|Help me with saw|I need an alpinist|I need ambulance|Keep Calm|On my way|I will be late|I'm already waiting|We have company|Beer is cold|Roger"
|
meshtastic --set canned_message_module_messages "I'm fine|I'm out|I'm back|Need helping hand|Help me with saw|I need an alpinist|I need ambulance|Keep Calm|On my way|I will be late|I'm already waiting|We have company|Beer is cold|Roger"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -264,7 +265,7 @@ Configuring this setting is not yet available for the selected platform. If this
|
||||||
:::note
|
:::note
|
||||||
Replace each `GPIO` (x3) below with the GPIO numbers from hardware setup.
|
Replace each `GPIO` (x3) below with the GPIO numbers from hardware setup.
|
||||||
|
|
||||||
```bash title="Canned Message Module - Required Rotary Encoder Module Settings"
|
```shell title="Canned Message Module - Required Rotary Encoder Module Settings"
|
||||||
meshtastic --set rotary1_pin_a GPIO
|
meshtastic --set rotary1_pin_a GPIO
|
||||||
meshtastic --set rotary1_pin_b GPIO
|
meshtastic --set rotary1_pin_b GPIO
|
||||||
meshtastic --set rotary1_pin_press GPIO
|
meshtastic --set rotary1_pin_press GPIO
|
|
@ -43,7 +43,7 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
meshtastic --ch-set bandwidth 125 --ch-index 0
|
meshtastic --ch-set bandwidth 125 --ch-index 0
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -133,7 +133,7 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
meshtastic --ch-set coding_rate 8 --ch-index 0
|
meshtastic --ch-set coding_rate 8 --ch-index 0
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -223,7 +223,7 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
meshtastic --ch-set spread_factor 12 --ch-index 0
|
meshtastic --ch-set spread_factor 12 --ch-index 0
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -274,11 +274,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set Default"
|
```shell title="Set Default"
|
||||||
meshtastic --ch-set tx_power 0 --ch-index 0
|
meshtastic --ch-set tx_power 0 --ch-index 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set to 2dBM"
|
```shell title="Set to 2dBM"
|
||||||
meshtastic --ch-set tx_power 2 --ch-index 0
|
meshtastic --ch-set tx_power 2 --ch-index 0
|
||||||
```
|
```
|
||||||
|
|
|
@ -40,7 +40,7 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set the PRIMARY channel ID"
|
```shell title="Set the PRIMARY channel ID"
|
||||||
meshtastic --ch-set id 1234 --ch-index 0
|
meshtastic --ch-set id 1234 --ch-index 0
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -96,7 +96,7 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set Modem - LongSlow"
|
```shell title="Set Modem - LongSlow"
|
||||||
meshtastic --ch-set modem_config Bw125Cr48Sf4096 --ch-index 0
|
meshtastic --ch-set modem_config Bw125Cr48Sf4096 --ch-index 0
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -145,11 +145,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set channel name for the PRIMARY channel"
|
```shell title="Set channel name for the PRIMARY channel"
|
||||||
meshtastic --ch-set name MyChannel --ch-index 0
|
meshtastic --ch-set name MyChannel --ch-index 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set channel name for the PRIMARY channel with spaces"
|
```shell title="Set channel name for the PRIMARY channel with spaces"
|
||||||
meshtastic --ch-set name "My Channel" --ch-index 0
|
meshtastic --ch-set name "My Channel" --ch-index 0
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -211,23 +211,23 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set encryption to default on PRIMARY channel"
|
```shell title="Set encryption to default on PRIMARY channel"
|
||||||
meshtastic --ch-set psk default --ch-index 0
|
meshtastic --ch-set psk default --ch-index 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set encryption to random on PRIMARY channel"
|
```shell title="Set encryption to random on PRIMARY channel"
|
||||||
meshtastic --ch-set psk random --ch-index 0
|
meshtastic --ch-set psk random --ch-index 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set encryption to single byte on PRIMARY channel"
|
```shell title="Set encryption to single byte on PRIMARY channel"
|
||||||
meshtastic --ch-set psk simple15 --ch-index 0
|
meshtastic --ch-set psk simple15 --ch-index 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set encryption to your own key on PRIMARY channel"
|
```shell title="Set encryption to your own key on PRIMARY channel"
|
||||||
meshtastic --ch-set psk 0x1a1a1a1a2b2b2b2b1a1a1a1a2b2b2b2b1a1a1a1a2b2b2b2b1a1a1a1a2b2b2b2b --ch-index 0
|
meshtastic --ch-set psk 0x1a1a1a1a2b2b2b2b1a1a1a1a2b2b2b2b1a1a1a1a2b2b2b2b1a1a1a1a2b2b2b2b --ch-index 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable encryption on PRIMARY channel"
|
```shell title="Disable encryption on PRIMARY channel"
|
||||||
meshtastic --ch-set psk none --ch-index 0
|
meshtastic --ch-set psk none --ch-index 0
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -289,11 +289,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Unset Region"
|
```shell title="Unset Region"
|
||||||
meshtastic --set region Unset
|
meshtastic --set region Unset
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set Region"
|
```shell title="Set Region"
|
||||||
meshtastic --set region US
|
meshtastic --set region US
|
||||||
```
|
```
|
||||||
|
|
|
@ -60,11 +60,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="GPIO active high"
|
```shell title="GPIO active high"
|
||||||
meshtastic --set ext_notification_module_active true
|
meshtastic --set ext_notification_module_active true
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="GPIO active low (default)"
|
```shell title="GPIO active low (default)"
|
||||||
meshtastic --set ext_notification_module_active false
|
meshtastic --set ext_notification_module_active false
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -109,11 +109,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Enable alert on incoming bell"
|
```shell title="Enable alert on incoming bell"
|
||||||
meshtastic --set ext_notification_module_alert_bell true
|
meshtastic --set ext_notification_module_alert_bell true
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable alert on incoming bell"
|
```shell title="Disable alert on incoming bell"
|
||||||
meshtastic --set ext_notification_module_alert_bell false
|
meshtastic --set ext_notification_module_alert_bell false
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -158,11 +158,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Enable alert on incoming message"
|
```shell title="Enable alert on incoming message"
|
||||||
meshtastic --set ext_notification_module_alert_message true
|
meshtastic --set ext_notification_module_alert_message true
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable alert on incoming message"
|
```shell title="Disable alert on incoming message"
|
||||||
meshtastic --set ext_notification_module_alert_message false
|
meshtastic --set ext_notification_module_alert_message false
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -207,11 +207,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Enable Module"
|
```shell title="Enable Module"
|
||||||
meshtastic --set ext_notification_module_enabled true
|
meshtastic --set ext_notification_module_enabled true
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable Module"
|
```shell title="Disable Module"
|
||||||
meshtastic --set ext_notification_module_enabled false
|
meshtastic --set ext_notification_module_enabled false
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -264,7 +264,7 @@ values={[
|
||||||
Replace `GPIO` in the below command with the GPIO number your circuit is attached to.
|
Replace `GPIO` in the below command with the GPIO number your circuit is attached to.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
```bash title="Specify GPIO that circuit is connected to"
|
```shell title="Specify GPIO that circuit is connected to"
|
||||||
meshtastic --set ext_notification_module_output GPIO
|
meshtastic --set ext_notification_module_output GPIO
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -309,11 +309,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set to default (1000ms)"
|
```shell title="Set to default (1000ms)"
|
||||||
meshtastic --set ext_notification_module_output_ms 0
|
meshtastic --set ext_notification_module_output_ms 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set to other value"
|
```shell title="Set to other value"
|
||||||
meshtastic --set ext_notification_module_output_ms 1500
|
meshtastic --set ext_notification_module_output_ms 1500
|
||||||
```
|
```
|
||||||
|
|
|
@ -56,7 +56,7 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set Fixed Position - Current Location"
|
```shell title="Set Fixed Position - Current Location"
|
||||||
meshtastic --set fixed_position true
|
meshtastic --set fixed_position true
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -64,17 +64,18 @@ meshtastic --set fixed_position true
|
||||||
The device will continue to acquire GPS coordinates according to the `gps_update_interval`, but will use the last saved coordinates as its fixed point.
|
The device will continue to acquire GPS coordinates according to the `gps_update_interval`, but will use the last saved coordinates as its fixed point.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
```bash title="Set Fixed Position - User Defined"
|
```shell title="Set Fixed Position - User Defined"
|
||||||
meshtastic --setlat 37.8651 --setlon -119.5383
|
meshtastic --setlat 37.8651 --setlon -119.5383
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Unset Fixed Position"
|
```shell title="Unset Fixed Position"
|
||||||
meshtastic --set fixed_position false
|
meshtastic --set fixed_position false
|
||||||
```
|
```
|
||||||
|
|
||||||
:::note
|
:::note
|
||||||
It may take some time to see that the change has taken effect. The GPS location is updated according to the value specified on `gps_update_interval` and the mesh will be notified of the new position in relation to the `position_broadcast_secs` value.
|
It may take some time to see that the change has taken effect. The GPS location is updated according to the value specified on `gps_update_interval` and the mesh will be notified of the new position in relation to the `position_broadcast_secs` value.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
<TabItem value="android">
|
<TabItem value="android">
|
||||||
|
|
||||||
|
@ -116,11 +117,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Enable 2D GPS Fixes"
|
```shell title="Enable 2D GPS Fixes"
|
||||||
meshtastic --set gps_accept_2d true
|
meshtastic --set gps_accept_2d true
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable 2D GPS Fixes"
|
```shell title="Disable 2D GPS Fixes"
|
||||||
meshtastic --set gps_accept_2d false
|
meshtastic --set gps_accept_2d false
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -165,11 +166,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set GPS attempt time to default (30 seconds)"
|
```shell title="Set GPS attempt time to default (30 seconds)"
|
||||||
meshtastic --set gps_attempt_time 0
|
meshtastic --set gps_attempt_time 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set GPS attempt time to 45 seconds"
|
```shell title="Set GPS attempt time to 45 seconds"
|
||||||
meshtastic --set gps_attempt_time 45
|
meshtastic --set gps_attempt_time 45
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -223,7 +224,7 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Specify GPS format on device screen"
|
```shell title="Specify GPS format on device screen"
|
||||||
meshtastic --set gps_format GpsFormatUTM
|
meshtastic --set gps_format GpsFormatUTM
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -268,15 +269,15 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set GPS max DOP to default (accept all GPS readings)"
|
```shell title="Set GPS max DOP to default (accept all GPS readings)"
|
||||||
meshtastic --set gps_max_dop 0
|
meshtastic --set gps_max_dop 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set GPS max DOP to 3m"
|
```shell title="Set GPS max DOP to 3m"
|
||||||
meshtastic --set gps_max_dop 1
|
meshtastic --set gps_max_dop 1
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set GPS max DOP to < ~200m"
|
```shell title="Set GPS max DOP to < ~200m"
|
||||||
meshtastic --set gps_max_dop 64
|
meshtastic --set gps_max_dop 64
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -317,7 +318,7 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Specify GPS format on device screen"
|
```shell title="Specify GPS format on device screen"
|
||||||
meshtastic --set gps_format GpsFormatUTM
|
meshtastic --set gps_format GpsFormatUTM
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -374,15 +375,15 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set GPS to default settings"
|
```shell title="Set GPS to default settings"
|
||||||
meshtastic --set gps_operation GpsOpUnset
|
meshtastic --set gps_operation GpsOpUnset
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set GPS to only be used for time"
|
```shell title="Set GPS to only be used for time"
|
||||||
meshtastic --set gps_operation GpsOpTimeOnly
|
meshtastic --set gps_operation GpsOpTimeOnly
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable GPS Completely"
|
```shell title="Disable GPS Completely"
|
||||||
meshtastic --set gps_operation GpsOpDisabled
|
meshtastic --set gps_operation GpsOpDisabled
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -431,11 +432,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set GPS update interval to default settings (every 30 seconds)"
|
```shell title="Set GPS update interval to default settings (every 30 seconds)"
|
||||||
meshtastic --set gps_update_interval 0
|
meshtastic --set gps_update_interval 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set GPS update interval to every 45 seconds"
|
```shell title="Set GPS update interval to every 45 seconds"
|
||||||
meshtastic --set gps_update_interval 45
|
meshtastic --set gps_update_interval 45
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -486,7 +487,7 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Disable Location Sharing"
|
```shell title="Disable Location Sharing"
|
||||||
meshtastic --set location_share LocDisabled
|
meshtastic --set location_share LocDisabled
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -537,11 +538,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set GPS update interval to default settings (every 15 minutes)"
|
```shell title="Set GPS update interval to default settings (every 15 minutes)"
|
||||||
meshtastic --set position_broadcast_secs 0
|
meshtastic --set position_broadcast_secs 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set GPS update interval to every 60 seconds"
|
```shell title="Set GPS update interval to every 60 seconds"
|
||||||
meshtastic --set position_broadcast_secs 60
|
meshtastic --set position_broadcast_secs 60
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -607,11 +608,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Enable smart position broadcast"
|
```shell title="Enable smart position broadcast"
|
||||||
meshtastic --set position_broadcast_smart true
|
meshtastic --set position_broadcast_smart true
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable smart position broadcast"
|
```shell title="Disable smart position broadcast"
|
||||||
meshtastic --set position_broadcast_smart false
|
meshtastic --set position_broadcast_smart false
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -673,11 +674,11 @@ values={[
|
||||||
Include each flag desired from the table above separated by a single space.
|
Include each flag desired from the table above separated by a single space.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
```bash title="Set Position Flags"
|
```shell title="Set Position Flags"
|
||||||
meshtastic --pos-fields POS_ALTITUDE POS_ALT_MSL
|
meshtastic --pos-fields POS_ALTITUDE POS_ALT_MSL
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Unset Position Flags"
|
```shell title="Unset Position Flags"
|
||||||
meshtastic --pos-fields POS_UNDEFINED
|
meshtastic --pos-fields POS_UNDEFINED
|
||||||
```
|
```
|
||||||
|
|
|
@ -50,7 +50,7 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set HAM ID"
|
```shell title="Set HAM ID"
|
||||||
meshtastic --set-ham KI1345
|
meshtastic --set-ham KI1345
|
||||||
```
|
```
|
||||||
|
|
|
@ -59,11 +59,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Enable rotary1"
|
```shell title="Enable rotary1"
|
||||||
meshtastic --set rotary1_enabled true
|
meshtastic --set rotary1_enabled true
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable rotary1"
|
```shell title="Disable rotary1"
|
||||||
meshtastic --set rotary1_enabled true
|
meshtastic --set rotary1_enabled true
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -112,11 +112,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set rotary1 event cw to 'KEY_UP'"
|
```shell title="Set rotary1 event cw to 'KEY_UP'"
|
||||||
meshtastic --set rotary1_event_press KEY_UP
|
meshtastic --set rotary1_event_press KEY_UP
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Unset rotary1 event cw"
|
```shell title="Unset rotary1 event cw"
|
||||||
meshtastic --set rotary1_event_press ""
|
meshtastic --set rotary1_event_press ""
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -165,11 +165,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set rotary1 event ccw to 'KEY_DOWN'"
|
```shell title="Set rotary1 event ccw to 'KEY_DOWN'"
|
||||||
meshtastic --set rotary1_event_ccw KEY_DOWN
|
meshtastic --set rotary1_event_ccw KEY_DOWN
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Unset rotary1 event ccw"
|
```shell title="Unset rotary1 event ccw"
|
||||||
meshtastic --set rotary1_event_ccw ""
|
meshtastic --set rotary1_event_ccw ""
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -218,11 +218,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set rotary1 event press to 'KEY_SELECT'"
|
```shell title="Set rotary1 event press to 'KEY_SELECT'"
|
||||||
meshtastic --set rotary1_event_press KEY_SELECT
|
meshtastic --set rotary1_event_press KEY_SELECT
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Unset rotary1 event press"
|
```shell title="Unset rotary1 event press"
|
||||||
meshtastic --set rotary1_event_press ""
|
meshtastic --set rotary1_event_press ""
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -275,7 +275,7 @@ values={[
|
||||||
Replace `GPIO` below with the GPIO number from hardware setup.
|
Replace `GPIO` below with the GPIO number from hardware setup.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
```bash title="Specify rotary1 pin a"
|
```shell title="Specify rotary1 pin a"
|
||||||
meshtastic --set rotary1_pin_a GPIO
|
meshtastic --set rotary1_pin_a GPIO
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -328,7 +328,7 @@ values={[
|
||||||
Replace `GPIO` below with the GPIO number from hardware setup.
|
Replace `GPIO` below with the GPIO number from hardware setup.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
```bash title="Specify rotary1 pin b"
|
```shell title="Specify rotary1 pin b"
|
||||||
meshtastic --set rotary1_pin_b GPIO
|
meshtastic --set rotary1_pin_b GPIO
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -381,7 +381,7 @@ values={[
|
||||||
Replace `GPIO` below with the GPIO number from hardware setup.
|
Replace `GPIO` below with the GPIO number from hardware setup.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
```bash title="Specify rotary1 pin press"
|
```shell title="Specify rotary1 pin press"
|
||||||
meshtastic --set rotary1_pin_press GPIO
|
meshtastic --set rotary1_pin_press GPIO
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -434,7 +434,7 @@ values={[
|
||||||
Replace each `GPIO` (x3) below with the GPIO numbers from hardware setup.
|
Replace each `GPIO` (x3) below with the GPIO numbers from hardware setup.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
```bash title="Canned Message Module - Required Rotary Encoder Module Settings"
|
```shell title="Canned Message Module - Required Rotary Encoder Module Settings"
|
||||||
meshtastic --set rotary1_pin_a GPIO
|
meshtastic --set rotary1_pin_a GPIO
|
||||||
meshtastic --set rotary1_pin_b GPIO
|
meshtastic --set rotary1_pin_b GPIO
|
||||||
meshtastic --set rotary1_pin_press GPIO
|
meshtastic --set rotary1_pin_press GPIO
|
|
@ -37,11 +37,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set auto_screen_carousel_secs to default"
|
```shell title="Set auto_screen_carousel_secs to default"
|
||||||
meshtastic --set auto_screen_carousel_secs 0
|
meshtastic --set auto_screen_carousel_secs 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set auto_screen_carousel_secs to 120 seconds"
|
```shell title="Set auto_screen_carousel_secs to 120 seconds"
|
||||||
meshtastic --set auto_screen_carousel_secs 120
|
meshtastic --set auto_screen_carousel_secs 120
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -86,11 +86,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Enable debug log"
|
```shell title="Enable debug log"
|
||||||
meshtastic --set debug_log_enabled true
|
meshtastic --set debug_log_enabled true
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable debug log"
|
```shell title="Disable debug log"
|
||||||
meshtastic --set debug_log_enabled false
|
meshtastic --set debug_log_enabled false
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -135,7 +135,7 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Example - Factory reset"
|
```shell title="Example - Factory reset"
|
||||||
meshtastic --set factory_reset true
|
meshtastic --set factory_reset true
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -180,11 +180,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Enable ignore_incoming"
|
```shell title="Enable ignore_incoming"
|
||||||
meshtastic --set ignore_incoming true
|
meshtastic --set ignore_incoming true
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable ignore_incoming"
|
```shell title="Disable ignore_incoming"
|
||||||
meshtastic --set ignore_incoming false
|
meshtastic --set ignore_incoming false
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -229,11 +229,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Enable serial"
|
```shell title="Enable serial"
|
||||||
meshtastic --set serial_disabled false
|
meshtastic --set serial_disabled false
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable serial"
|
```shell title="Disable serial"
|
||||||
meshtastic --set serial_disabled true
|
meshtastic --set serial_disabled true
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -282,11 +282,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set hop_limit to default (3 hops)"
|
```shell title="Set hop_limit to default (3 hops)"
|
||||||
meshtastic --set hop_limit 0
|
meshtastic --set hop_limit 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set hop_limit to max (7 hops)"
|
```shell title="Set hop_limit to max (7 hops)"
|
||||||
meshtastic --set hop_limit 7
|
meshtastic --set hop_limit 7
|
||||||
```
|
```
|
||||||
|
|
|
@ -50,19 +50,19 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Enable downlink_enabled on PRIMARY channel"
|
```shell title="Enable downlink_enabled on PRIMARY channel"
|
||||||
meshtastic --ch-set downlink_enabled true --ch-index 0
|
meshtastic --ch-set downlink_enabled true --ch-index 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable downlink_enabled on PRIMARY channel"
|
```shell title="Disable downlink_enabled on PRIMARY channel"
|
||||||
meshtastic --ch-set downlink_enabled false --ch-index 0
|
meshtastic --ch-set downlink_enabled false --ch-index 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Enable downlink_enabled on OTHER channel"
|
```shell title="Enable downlink_enabled on OTHER channel"
|
||||||
meshtastic --ch-set downlink_enabled true --ch-index 1
|
meshtastic --ch-set downlink_enabled true --ch-index 1
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable downlink_enabled on OTHER channel"
|
```shell title="Disable downlink_enabled on OTHER channel"
|
||||||
meshtastic --ch-set downlink_enabled false --ch-index 1
|
meshtastic --ch-set downlink_enabled false --ch-index 1
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -107,11 +107,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Enable MQTT (Default)"
|
```shell title="Enable MQTT (Default)"
|
||||||
meshtastic --set mqtt_disabled false
|
meshtastic --set mqtt_disabled false
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable MQTT"
|
```shell title="Disable MQTT"
|
||||||
meshtastic --set mqtt_disabled true
|
meshtastic --set mqtt_disabled true
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -160,11 +160,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Publish decrypted packets to MQTT (Default)"
|
```shell title="Publish decrypted packets to MQTT (Default)"
|
||||||
meshtastic --set mqtt_encryption_enabled false
|
meshtastic --set mqtt_encryption_enabled false
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Publish encrypted packets to MQTT"
|
```shell title="Publish encrypted packets to MQTT"
|
||||||
meshtastic --set mqtt_encryption_enabled true
|
meshtastic --set mqtt_encryption_enabled true
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -209,15 +209,15 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set mqtt_password"
|
```shell title="Set mqtt_password"
|
||||||
meshtastic --set mqtt_password mypassword
|
meshtastic --set mqtt_password mypassword
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set mqtt_password (with spaces)"
|
```shell title="Set mqtt_password (with spaces)"
|
||||||
meshtastic --set mqtt_password "my password"
|
meshtastic --set mqtt_password "my password"
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Unset mqtt_password (Default)"
|
```shell title="Unset mqtt_password (Default)"
|
||||||
meshtastic --set mqtt_password ""
|
meshtastic --set mqtt_password ""
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -266,15 +266,15 @@ values={[
|
||||||
When the mqtt_server is set to `""`, it will default to `mqtt.meshtastic.org`
|
When the mqtt_server is set to `""`, it will default to `mqtt.meshtastic.org`
|
||||||
:::
|
:::
|
||||||
|
|
||||||
```bash title="Enable MQTT Server - Public Meshtastic MQTT Server (Default)"
|
```shell title="Enable MQTT Server - Public Meshtastic MQTT Server (Default)"
|
||||||
meshtastic --set mqtt_server ""
|
meshtastic --set mqtt_server ""
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Enable MQTT Server - Personal MQTT Server (by IP)"
|
```shell title="Enable MQTT Server - Personal MQTT Server (by IP)"
|
||||||
meshtastic --set mqtt_server 198.168.0.2
|
meshtastic --set mqtt_server 198.168.0.2
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Enable MQTT Server - Personal MQTT Server (by URL)"
|
```shell title="Enable MQTT Server - Personal MQTT Server (by URL)"
|
||||||
meshtastic --set mqtt_server mqtt.mydomain.com
|
meshtastic --set mqtt_server mqtt.mydomain.com
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -319,15 +319,15 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set mqtt_username"
|
```shell title="Set mqtt_username"
|
||||||
meshtastic --set mqtt_username myusername
|
meshtastic --set mqtt_username myusername
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set mqtt_username (with spaces)"
|
```shell title="Set mqtt_username (with spaces)"
|
||||||
meshtastic --set mqtt_username "my username"
|
meshtastic --set mqtt_username "my username"
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Unset mqtt_username (Default)"
|
```shell title="Unset mqtt_username (Default)"
|
||||||
meshtastic --set mqtt_username ""
|
meshtastic --set mqtt_username ""
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -372,19 +372,19 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Enable uplink_enabled on PRIMARY channel"
|
```shell title="Enable uplink_enabled on PRIMARY channel"
|
||||||
meshtastic --ch-set uplink_enabled true --ch-index 0
|
meshtastic --ch-set uplink_enabled true --ch-index 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable uplink_enabled on PRIMARY channel"
|
```shell title="Disable uplink_enabled on PRIMARY channel"
|
||||||
meshtastic --ch-set uplink_enabled false --ch-index 0
|
meshtastic --ch-set uplink_enabled false --ch-index 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Enable uplink_enabled on OTHER channel"
|
```shell title="Enable uplink_enabled on OTHER channel"
|
||||||
meshtastic --ch-set uplink_enabled true --ch-index 1
|
meshtastic --ch-set uplink_enabled true --ch-index 1
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable uplink_enabled on OTHER channel"
|
```shell title="Disable uplink_enabled on OTHER channel"
|
||||||
meshtastic --ch-set uplink_enabled false --ch-index 1
|
meshtastic --ch-set uplink_enabled false --ch-index 1
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -429,21 +429,22 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set server"
|
```shell title="Set server"
|
||||||
meshtastic --set mqtt_server 192.168.123.234
|
meshtastic --set mqtt_server 192.168.123.234
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Enable MQTT server to mesh"
|
```shell title="Enable MQTT server to mesh"
|
||||||
meshtastic --ch-set uplink_enabled true --ch-set downlink_enabled true --ch-index 0
|
meshtastic --ch-set uplink_enabled true --ch-set downlink_enabled true --ch-index 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="View raw encoded messages using mosquitto"
|
```shell title="View raw encoded messages using mosquitto"
|
||||||
mosquitto_sub -h 192.168.123.234 -v -t msh/#
|
mosquitto_sub -h 192.168.123.234 -v -t msh/#
|
||||||
```
|
```
|
||||||
|
|
||||||
:::note
|
:::note
|
||||||
FIXME some documentation says msh/# , some says mesh/# . As of 1.2.39 the messages are on msh/#
|
FIXME some documentation says msh/# , some says mesh/# . As of 1.2.39 the messages are on msh/#
|
||||||
:::
|
:::
|
||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
<TabItem value="android">
|
<TabItem value="android">
|
||||||
|
|
|
@ -51,7 +51,7 @@ values={[
|
||||||
The CLI examples will require you to utilize the Command line Interface that is available through Meshtastic-python. Installation instructions can be found [here](software/python/python-installation).
|
The CLI examples will require you to utilize the Command line Interface that is available through Meshtastic-python. Installation instructions can be found [here](software/python/python-installation).
|
||||||
:::
|
:::
|
||||||
|
|
||||||
```bash title="Example - Set Region (an important first step!)"
|
```shell title="Example - Set Region (an important first step!)"
|
||||||
meshtastic --set region Unset
|
meshtastic --set region Unset
|
||||||
```
|
```
|
||||||
|
|
|
@ -64,11 +64,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Unset charge current"
|
```shell title="Unset charge current"
|
||||||
meshtastic --set charge_current MAUnset
|
meshtastic --set charge_current MAUnset
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set charge current"
|
```shell title="Set charge current"
|
||||||
meshtastic --set charge_current MA100
|
meshtastic --set charge_current MA100
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -101,11 +101,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Enable is_always_powered"
|
```shell title="Enable is_always_powered"
|
||||||
meshtastic --set is_always_powered true
|
meshtastic --set is_always_powered true
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable is_always_powered"
|
```shell title="Disable is_always_powered"
|
||||||
meshtastic --set is_always_powered false
|
meshtastic --set is_always_powered false
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -144,11 +144,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Enable is_low_power"
|
```shell title="Enable is_low_power"
|
||||||
meshtastic --set is_low_power true
|
meshtastic --set is_low_power true
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable is_low_power"
|
```shell title="Disable is_low_power"
|
||||||
meshtastic --set is_low_power false
|
meshtastic --set is_low_power false
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -181,11 +181,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Enable is_router"
|
```shell title="Enable is_router"
|
||||||
meshtastic --set is_router true
|
meshtastic --set is_router true
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable is_router"
|
```shell title="Disable is_router"
|
||||||
meshtastic --set is_router false
|
meshtastic --set is_router false
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -218,11 +218,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set ls_secs to default (1 hour/3600 seconds)"
|
```shell title="Set ls_secs to default (1 hour/3600 seconds)"
|
||||||
meshtastic --set ls_secs 0
|
meshtastic --set ls_secs 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set ls_secs to 120 seconds"
|
```shell title="Set ls_secs to 120 seconds"
|
||||||
meshtastic --set ls_secs 120
|
meshtastic --set ls_secs 120
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -255,15 +255,15 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set mesh_sds_timeout_secs to default (2 hour/7200 seconds)"
|
```shell title="Set mesh_sds_timeout_secs to default (2 hour/7200 seconds)"
|
||||||
meshtastic --set mesh_sds_timeout_secs 0
|
meshtastic --set mesh_sds_timeout_secs 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set mesh_sds_timeout_secs to 120 seconds"
|
```shell title="Set mesh_sds_timeout_secs to 120 seconds"
|
||||||
meshtastic --set mesh_sds_timeout_secs 120
|
meshtastic --set mesh_sds_timeout_secs 120
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable mesh_sds_timeout_secs (using MAXUINT)"
|
```shell title="Disable mesh_sds_timeout_secs (using MAXUINT)"
|
||||||
meshtastic --set mesh_sds_timeout_secs 4294967295
|
meshtastic --set mesh_sds_timeout_secs 4294967295
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -296,11 +296,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set min_wake_secs to default (10 seconds)"
|
```shell title="Set min_wake_secs to default (10 seconds)"
|
||||||
meshtastic --set min_wake_secs 0
|
meshtastic --set min_wake_secs 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set min_wake_secs to 120 seconds"
|
```shell title="Set min_wake_secs to 120 seconds"
|
||||||
meshtastic --set min_wake_secs 120
|
meshtastic --set min_wake_secs 120
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -333,11 +333,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Disable on_battery_shutdown_after_secs"
|
```shell title="Disable on_battery_shutdown_after_secs"
|
||||||
meshtastic --set on_battery_shutdown_after_secs 0
|
meshtastic --set on_battery_shutdown_after_secs 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set device to shutdown after 120 seconds on battery"
|
```shell title="Set device to shutdown after 120 seconds on battery"
|
||||||
meshtastic --set on_battery_shutdown_after_secs 120
|
meshtastic --set on_battery_shutdown_after_secs 120
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -370,15 +370,15 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set phone_sds_timeout_sec to default (2 hours)"
|
```shell title="Set phone_sds_timeout_sec to default (2 hours)"
|
||||||
meshtastic --set phone_sds_timeout_sec 0
|
meshtastic --set phone_sds_timeout_sec 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable phone_sds_timeout_sec"
|
```shell title="Disable phone_sds_timeout_sec"
|
||||||
meshtastic --set phone_sds_timeout_sec 4294967295
|
meshtastic --set phone_sds_timeout_sec 4294967295
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set phone_sds_timeout_sec to 120 seconds"
|
```shell title="Set phone_sds_timeout_sec to 120 seconds"
|
||||||
meshtastic --set phone_sds_timeout_sec 120
|
meshtastic --set phone_sds_timeout_sec 120
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -411,11 +411,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set phone_timeout_secs to default (15 minutes)"
|
```shell title="Set phone_timeout_secs to default (15 minutes)"
|
||||||
meshtastic --set phone_timeout_secs 0
|
meshtastic --set phone_timeout_secs 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set phone_timeout_secs to 120 seconds"
|
```shell title="Set phone_timeout_secs to 120 seconds"
|
||||||
meshtastic --set phone_timeout_secs 120
|
meshtastic --set phone_timeout_secs 120
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -448,11 +448,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set screen_on_secs to default (1 minute)"
|
```shell title="Set screen_on_secs to default (1 minute)"
|
||||||
meshtastic --set screen_on_secs 0
|
meshtastic --set screen_on_secs 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set screen_on_secs to 120 seconds"
|
```shell title="Set screen_on_secs to 120 seconds"
|
||||||
meshtastic --set screen_on_secs 120
|
meshtastic --set screen_on_secs 120
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -485,11 +485,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set sds_secs to default (1 year)"
|
```shell title="Set sds_secs to default (1 year)"
|
||||||
meshtastic --set sds_secs 0
|
meshtastic --set sds_secs 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set sds_secs to 120 seconds"
|
```shell title="Set sds_secs to 120 seconds"
|
||||||
meshtastic --set sds_secs 120
|
meshtastic --set sds_secs 120
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -522,11 +522,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set send_owner_interval to default (every 4 network pings)"
|
```shell title="Set send_owner_interval to default (every 4 network pings)"
|
||||||
meshtastic --set send_owner_interval 0
|
meshtastic --set send_owner_interval 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set send_owner_interval to every 10 network pings"
|
```shell title="Set send_owner_interval to every 10 network pings"
|
||||||
meshtastic --set send_owner_interval 10
|
meshtastic --set send_owner_interval 10
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -561,11 +561,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set wait_bluetooth_secs to default (60 seconds)"
|
```shell title="Set wait_bluetooth_secs to default (60 seconds)"
|
||||||
meshtastic --set wait_bluetooth_secs 0
|
meshtastic --set wait_bluetooth_secs 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set wait_bluetooth_secs to 120 seconds"
|
```shell title="Set wait_bluetooth_secs to 120 seconds"
|
||||||
meshtastic --set wait_bluetooth_secs 120
|
meshtastic --set wait_bluetooth_secs 120
|
||||||
```
|
```
|
||||||
|
|
|
@ -42,11 +42,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Enable the module"
|
```shell title="Enable the module"
|
||||||
meshtastic --set range_test_module_enabled true
|
meshtastic --set range_test_module_enabled true
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable the module"
|
```shell title="Disable the module"
|
||||||
meshtastic --set range_test_module_enabled true
|
meshtastic --set range_test_module_enabled true
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -91,11 +91,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Enable range test save"
|
```shell title="Enable range test save"
|
||||||
meshtastic --set range_test_module_save true
|
meshtastic --set range_test_module_save true
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable range test save"
|
```shell title="Disable range test save"
|
||||||
meshtastic --set range_test_module_save false
|
meshtastic --set range_test_module_save false
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -140,11 +140,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Enable range test sender (send every 60 seconds)"
|
```shell title="Enable range test sender (send every 60 seconds)"
|
||||||
meshtastic --set range_test_module_sender 60
|
meshtastic --set range_test_module_sender 60
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable range test sender"
|
```shell title="Disable range test sender"
|
||||||
meshtastic --set range_test_module_sender 0
|
meshtastic --set range_test_module_sender 0
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -217,7 +217,7 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Example - Sender Node"
|
```shell title="Example - Sender Node"
|
||||||
meshtastic --set range_test_module_enabled true
|
meshtastic --set range_test_module_enabled true
|
||||||
meshtastic --set range_test_module_sender 60
|
meshtastic --set range_test_module_sender 60
|
||||||
```
|
```
|
||||||
|
@ -259,7 +259,7 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Example - Receiver Node"
|
```shell title="Example - Receiver Node"
|
||||||
meshtastic --set range_test_module_enabled true
|
meshtastic --set range_test_module_enabled true
|
||||||
meshtastic --set range_test_module_save true
|
meshtastic --set range_test_module_save true
|
||||||
```
|
```
|
|
@ -32,11 +32,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Enable router mode"
|
```shell title="Enable router mode"
|
||||||
meshtastic --set is_router true
|
meshtastic --set is_router true
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable router mode"
|
```shell title="Disable router mode"
|
||||||
meshtastic --set is_router false
|
meshtastic --set is_router false
|
||||||
```
|
```
|
||||||
|
|
|
@ -18,7 +18,6 @@ GPIO access is fundamentally dangerous because invalid options can physically da
|
||||||
This module requires attaching a peripheral accessory to your device. It will not work without one.
|
This module requires attaching a peripheral accessory to your device. It will not work without one.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
This is a simple interface to send messages over the mesh network by sending strings over a serial port. Anything you send the node will be turned into a message sent out over the mesh, and anything received from the mesh will be sent to the serial port. Note that this module does not (yet) allow arbitrary protobuf commands to be sent over the serial connection.
|
This is a simple interface to send messages over the mesh network by sending strings over a serial port. Anything you send the node will be turned into a message sent out over the mesh, and anything received from the mesh will be sent to the serial port. Note that this module does not (yet) allow arbitrary protobuf commands to be sent over the serial connection.
|
||||||
|
@ -57,11 +56,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Enable module"
|
```shell title="Enable module"
|
||||||
meshtastic --set serial_module_enabled true
|
meshtastic --set serial_module_enabled true
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable module"
|
```shell title="Disable module"
|
||||||
meshtastic --set serial_module_enabled false
|
meshtastic --set serial_module_enabled false
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -104,11 +103,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Enable serial_module_echo"
|
```shell title="Enable serial_module_echo"
|
||||||
meshtastic --set serial_module_echo true
|
meshtastic --set serial_module_echo true
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable serial_module_echo"
|
```shell title="Disable serial_module_echo"
|
||||||
meshtastic --set serial_module_echo false
|
meshtastic --set serial_module_echo false
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -202,7 +201,7 @@ values={[
|
||||||
Replace `GPIO` in the below command with the GPIO number your circuit is attached to.
|
Replace `GPIO` in the below command with the GPIO number your circuit is attached to.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
```bash title="Set RXD to GPIO pin number"
|
```shell title="Set RXD to GPIO pin number"
|
||||||
meshtastic --set serial_module_rxd GPIO
|
meshtastic --set serial_module_rxd GPIO
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -245,7 +244,7 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set serial_module_timeout to 15 seconds"
|
```shell title="Set serial_module_timeout to 15 seconds"
|
||||||
meshtastic --set serial_module_timeout 15
|
meshtastic --set serial_module_timeout 15
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -296,7 +295,7 @@ values={[
|
||||||
Replace `GPIO` in the below command with the GPIO number your circuit is attached to.
|
Replace `GPIO` in the below command with the GPIO number your circuit is attached to.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
```bash title="Set TXD to GPIO pin number"
|
```shell title="Set TXD to GPIO pin number"
|
||||||
meshtastic --set serial_module_txd GPIO
|
meshtastic --set serial_module_txd GPIO
|
||||||
```
|
```
|
||||||
|
|
|
@ -55,11 +55,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Enable the module"
|
```shell title="Enable the module"
|
||||||
meshtastic --set store_forward_module_enabled true
|
meshtastic --set store_forward_module_enabled true
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable the module"
|
```shell title="Disable the module"
|
||||||
meshtastic --set store_forward_module_enabled false
|
meshtastic --set store_forward_module_enabled false
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -102,7 +102,7 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set store_forward_module_heartbeat to default"
|
```shell title="Set store_forward_module_heartbeat to default"
|
||||||
meshtastic --set store_forward_module_heartbeat 0
|
meshtastic --set store_forward_module_heartbeat 0
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -145,11 +145,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set store_forward_module_history_return_max to default"
|
```shell title="Set store_forward_module_history_return_max to default"
|
||||||
meshtastic --set store_forward_module_history_return_max 0
|
meshtastic --set store_forward_module_history_return_max 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set store_forward_module_history_return_max to 100 messages"
|
```shell title="Set store_forward_module_history_return_max to 100 messages"
|
||||||
meshtastic --set store_forward_module_history_return_max 100
|
meshtastic --set store_forward_module_history_return_max 100
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -192,11 +192,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set store_forward_module_history_return_window to default"
|
```shell title="Set store_forward_module_history_return_window to default"
|
||||||
meshtastic --set store_forward_module_history_return_window 0
|
meshtastic --set store_forward_module_history_return_window 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set store_forward_module_history_return_window to 1 day (1440 minutes)"
|
```shell title="Set store_forward_module_history_return_window to 1 day (1440 minutes)"
|
||||||
meshtastic --set store_forward_module_history_return_window 1440
|
meshtastic --set store_forward_module_history_return_window 1440
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -239,11 +239,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set store_forward_module_records to default (≈11,000 records)"
|
```shell title="Set store_forward_module_records to default (≈11,000 records)"
|
||||||
meshtastic --set store_forward_module_records 0
|
meshtastic --set store_forward_module_records 0
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set store_forward_module_records to 100 records"
|
```shell title="Set store_forward_module_records to 100 records"
|
||||||
meshtastic --set store_forward_module_records 100
|
meshtastic --set store_forward_module_records 100
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -300,7 +300,7 @@ Either use a custom channel configuration with at an at least 1kbit data rate or
|
||||||
|
|
||||||
Recommended channel setting is for 1.343kbps:
|
Recommended channel setting is for 1.343kbps:
|
||||||
|
|
||||||
```bash title="Recommended channel setting for S&F module"
|
```shell title="Recommended channel setting for S&F module"
|
||||||
meshtastic --setchan spread_factor 11 --setchan coding_rate 4 --setchan bandwidth 500
|
meshtastic --setchan spread_factor 11 --setchan coding_rate 4 --setchan bandwidth 500
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -315,10 +315,10 @@ Don't enable the Store and Forward module on multiple routers!
|
||||||
- Configure your device as a [meshtastic router](router).
|
- Configure your device as a [meshtastic router](router).
|
||||||
- Name your router node something that makes it easily identifiable, aka "Router".
|
- Name your router node something that makes it easily identifiable, aka "Router".
|
||||||
- Configure the Store and Forward module
|
- Configure the Store and Forward module
|
||||||
```bash title="Required - Enable the module"
|
```shell title="Required - Enable the module"
|
||||||
meshtastic --set store_forward_module_enabled true
|
meshtastic --set store_forward_module_enabled true
|
||||||
```
|
```
|
||||||
```bash title="Optional - Set maximum number of records to save to device"
|
```shell title="Optional - Set maximum number of records to save to device"
|
||||||
meshtastic --set store_forward_module_records 100
|
meshtastic --set store_forward_module_records 100
|
||||||
```
|
```
|
||||||
:::tip
|
:::tip
|
|
@ -57,10 +57,10 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set module update interval to default"
|
```shell title="Set module update interval to default"
|
||||||
meshtastic --set telemetry_module_device_update_interval 0
|
meshtastic --set telemetry_module_device_update_interval 0
|
||||||
```
|
```
|
||||||
```bash title="Set module update interval to 120 seconds"
|
```shell title="Set module update interval to 120 seconds"
|
||||||
meshtastic --set telemetry_module_device_update_interval 120
|
meshtastic --set telemetry_module_device_update_interval 120
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -106,12 +106,21 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Display Farenheit"
|
<<<<<<< HEAD:docs/settings/environmental-measurment-module.mdx
|
||||||
|
```shell title="Display Farenheit"
|
||||||
|
meshtastic --set telemetry_module_display_farenheit true
|
||||||
|
```
|
||||||
|
|
||||||
|
```shell title="Display Celsius"
|
||||||
|
meshtastic --set telemetry_module_display_farenheit false
|
||||||
|
=======
|
||||||
|
```shell title="Display Farenheit"
|
||||||
meshtastic --set telemetry_module_environment_display_fahrenheit true
|
meshtastic --set telemetry_module_environment_display_fahrenheit true
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Display Celsius"
|
```shell title="Display Celsius"
|
||||||
meshtastic --set telemetry_module_environment_display_fahrenheit false
|
meshtastic --set telemetry_module_environment_display_fahrenheit false
|
||||||
|
>>>>>>> master:docs/settings/telemetry-module.md
|
||||||
```
|
```
|
||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
|
@ -155,12 +164,21 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Enable Module"
|
<<<<<<< HEAD:docs/settings/environmental-measurment-module.mdx
|
||||||
|
```shell title="Enable Module"
|
||||||
|
meshtastic --set telemetry_module_measurement_enabled true
|
||||||
|
```
|
||||||
|
|
||||||
|
```shell title="Disable Module"
|
||||||
|
meshtastic --set telemetry_module_measurement_enabled false
|
||||||
|
=======
|
||||||
|
```shell title="Enable Module"
|
||||||
meshtastic --set telemetry_module_environment_measurement_enabled true
|
meshtastic --set telemetry_module_environment_measurement_enabled true
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable Module"
|
```shell title="Disable Module"
|
||||||
meshtastic --set telemetry_module_environment_measurement_enabled false
|
meshtastic --set telemetry_module_environment_measurement_enabled false
|
||||||
|
>>>>>>> master:docs/settings/telemetry-module.md
|
||||||
```
|
```
|
||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
|
@ -204,8 +222,13 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Configure telemetry_module_environment_read_error_count_threshold to 3 tries"
|
<<<<<<< HEAD:docs/settings/environmental-measurment-module.mdx
|
||||||
|
```shell title="Configure telemetry_module_read_error_count_threshold to 3 tries"
|
||||||
|
meshtastic --set telemetry_module_read_error_count_threshold 3
|
||||||
|
=======
|
||||||
|
```shell title="Configure telemetry_module_environment_read_error_count_threshold to 3 tries"
|
||||||
meshtastic --set telemetry_module_environment_read_error_count_threshold 3
|
meshtastic --set telemetry_module_environment_read_error_count_threshold 3
|
||||||
|
>>>>>>> master:docs/settings/telemetry-module.md
|
||||||
```
|
```
|
||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
|
@ -249,8 +272,13 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Configure telemetry_module_environment_recovery_interval to 120 seconds"
|
<<<<<<< HEAD:docs/settings/environmental-measurment-module.mdx
|
||||||
|
```shell title="Configure telemetry_module_recovery_interval to 120 seconds"
|
||||||
|
meshtastic --set telemetry_module_recovery_interval 120
|
||||||
|
=======
|
||||||
|
```shell title="Configure telemetry_module_environment_recovery_interval to 120 seconds"
|
||||||
meshtastic --set telemetry_module_environment_recovery_interval 120
|
meshtastic --set telemetry_module_environment_recovery_interval 120
|
||||||
|
>>>>>>> master:docs/settings/telemetry-module.md
|
||||||
```
|
```
|
||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
|
@ -294,12 +322,21 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Enable on device screen"
|
<<<<<<< HEAD:docs/settings/environmental-measurment-module.mdx
|
||||||
|
```shell title="Enable on device screen"
|
||||||
|
meshtastic --set telemetry_module_screen_enabled true
|
||||||
|
```
|
||||||
|
|
||||||
|
```shell title="Disable on device screen"
|
||||||
|
meshtastic --set telemetry_module_screen_enabled false
|
||||||
|
=======
|
||||||
|
```shell title="Enable on device screen"
|
||||||
meshtastic --set telemetry_module_environment_screen_enabled true
|
meshtastic --set telemetry_module_environment_screen_enabled true
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable on device screen"
|
```shell title="Disable on device screen"
|
||||||
meshtastic --set telemetry_module_environment_screen_enabled false
|
meshtastic --set telemetry_module_environment_screen_enabled false
|
||||||
|
>>>>>>> master:docs/settings/telemetry-module.md
|
||||||
```
|
```
|
||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
|
@ -351,8 +388,13 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set module sensor pin"
|
<<<<<<< HEAD:docs/settings/environmental-measurment-module.mdx
|
||||||
|
```shell title="Set module sensor pin"
|
||||||
|
meshtastic --set telemetry_module_sensor_pin PINNUMBER
|
||||||
|
=======
|
||||||
|
```shell title="Set module sensor pin"
|
||||||
meshtastic --set telemetry_module_environment_sensor_pin PINNUMBER
|
meshtastic --set telemetry_module_environment_sensor_pin PINNUMBER
|
||||||
|
>>>>>>> master:docs/settings/telemetry-module.md
|
||||||
```
|
```
|
||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
|
@ -419,12 +461,21 @@ values={[
|
||||||
The CLI is able to take the `value` or the `name` of the sensor from the table above.
|
The CLI is able to take the `value` or the `name` of the sensor from the table above.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
```bash title="Set sensor type to DS18B20"
|
<<<<<<< HEAD:docs/settings/environmental-measurment-module.mdx
|
||||||
|
```shell title="Set sensor type to DS18B20"
|
||||||
|
meshtastic --set telemetry_module_sensor_type 1
|
||||||
|
```
|
||||||
|
|
||||||
|
```shell title="Set sensor type to DS18B20"
|
||||||
|
meshtastic --set telemetry_module_sensor_type DS18B20
|
||||||
|
=======
|
||||||
|
```shell title="Set sensor type to DS18B20"
|
||||||
meshtastic --set telemetry_module_environment_sensor_type 2
|
meshtastic --set telemetry_module_environment_sensor_type 2
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set sensor type to DS18B20"
|
```shell title="Set sensor type to DS18B20"
|
||||||
meshtastic --set telemetry_module_environment_sensor_type DS18B20
|
meshtastic --set telemetry_module_environment_sensor_type DS18B20
|
||||||
|
>>>>>>> master:docs/settings/telemetry-module.md
|
||||||
```
|
```
|
||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
|
@ -464,8 +515,13 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set module update interval to 120 seconds"
|
<<<<<<< HEAD:docs/settings/environmental-measurment-module.mdx
|
||||||
|
```shell title="Set module update interval to 15 seconds"
|
||||||
|
meshtastic --set telemetry_module_update_interval 15
|
||||||
|
=======
|
||||||
|
```shell title="Set module update interval to 120 seconds"
|
||||||
meshtastic --set telemetry_module_environment_update_interval 120
|
meshtastic --set telemetry_module_environment_update_interval 120
|
||||||
|
>>>>>>> master:docs/settings/telemetry-module.md
|
||||||
```
|
```
|
||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
|
@ -52,11 +52,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Enable SoftAP"
|
```shell title="Enable SoftAP"
|
||||||
meshtastic --set wifi_ap_mode true
|
meshtastic --set wifi_ap_mode true
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Disable SoftAP"
|
```shell title="Disable SoftAP"
|
||||||
meshtastic --set wifi_ap_mode false
|
meshtastic --set wifi_ap_mode false
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -99,11 +99,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set WiFi password"
|
```shell title="Set WiFi password"
|
||||||
meshtastic --set wifi_password mypassword
|
meshtastic --set wifi_password mypassword
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set WiFi password (with spaces)"
|
```shell title="Set WiFi password (with spaces)"
|
||||||
meshtastic --set wifi_password "my password"
|
meshtastic --set wifi_password "my password"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -146,11 +146,11 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Set WiFi network"
|
```shell title="Set WiFi network"
|
||||||
meshtastic --set wifi_ssid mynetwork
|
meshtastic --set wifi_ssid mynetwork
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="Set WiFi network (with spaces)"
|
```shell title="Set WiFi network (with spaces)"
|
||||||
meshtastic --set wifi_ssid "my network"
|
meshtastic --set wifi_ssid "my network"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -254,18 +254,19 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Enabling WiFi Client"
|
```shell title="Enabling WiFi Client"
|
||||||
meshtastic --set wifi_ap_mode false --set wifi_ssid mywifissid --set wifi_password mywifipassword
|
meshtastic --set wifi_ap_mode false --set wifi_ssid mywifissid --set wifi_password mywifipassword
|
||||||
```
|
```
|
||||||
|
|
||||||
:::note
|
:::note
|
||||||
If your `wifi_ssid` or `wifi_password` contain spaces, be sure to put quotation marks around the whole thing:
|
If your `wifi_ssid` or `wifi_password` contain spaces, be sure to put quotation marks around the whole thing:
|
||||||
|
|
||||||
```bash title="Example with spaces"
|
```shell title="Example with spaces"
|
||||||
meshtastic --set wifi_ssid "my wifi ssid" --set wifi_password "my wifi password"
|
meshtastic --set wifi_ssid "my wifi ssid" --set wifi_password "my wifi password"
|
||||||
```
|
```
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
<TabItem value="android">
|
<TabItem value="android">
|
||||||
|
|
||||||
|
@ -305,14 +306,14 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Software Access Point Example"
|
```shell title="Software Access Point Example"
|
||||||
meshtastic --set wifi_ap_mode true --set wifi_ssid mywifissid --set wifi_password mywifipassword
|
meshtastic --set wifi_ap_mode true --set wifi_ssid mywifissid --set wifi_password mywifipassword
|
||||||
```
|
```
|
||||||
|
|
||||||
:::note
|
:::note
|
||||||
If your `wifi_ssid` or `wifi_password` contain spaces, be sure to put quotation marks around the whole thing:
|
If your `wifi_ssid` or `wifi_password` contain spaces, be sure to put quotation marks around the whole thing:
|
||||||
|
|
||||||
```bash title="Example with spaces"
|
```shell title="Example with spaces"
|
||||||
meshtastic --set wifi_ssid "my wifi ssid" --set wifi_password "my wifi password"
|
meshtastic --set wifi_ssid "my wifi ssid" --set wifi_password "my wifi password"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -357,7 +358,7 @@ values={[
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
```bash title="Example - Disabling WiFi"
|
```shell title="Example - Disabling WiFi"
|
||||||
meshtastic --set wifi_ap_mode false --set wifi_ssid "" --set wifi_password ""
|
meshtastic --set wifi_ap_mode false --set wifi_ssid "" --set wifi_password ""
|
||||||
```
|
```
|
||||||
|
|
|
@ -6,7 +6,15 @@ sidebar_label: Installation
|
||||||
|
|
||||||
Our Android application is available to download on Google Play Store.
|
Our Android application is available to download on Google Play Store.
|
||||||
|
|
||||||
<p align="center"><a href="https://play.google.com/store/apps/details?id=com.geeksville.mesh"><img alt="Download at https://play.google.com/store/apps/details?id=com.geeksville.mesh" src="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png" style={{zoom:'35%'}} /></a></p>
|
<p align="center">
|
||||||
|
<a href="https://play.google.com/store/apps/details?id=com.geeksville.mesh">
|
||||||
|
<img
|
||||||
|
alt="Download at https://play.google.com/store/apps/details?id=com.geeksville.mesh"
|
||||||
|
src="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png"
|
||||||
|
style={{ zoom: '35%' }}
|
||||||
|
/>
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
The app is also available on the Amazon [Appstore](https://www.amazon.com/Geeksville-Industries-Meshtastic/dp/B08CY9394Q). You will need to install the Amazon Appstore onto your phone in order to install the Meshtastic application.
|
The app is also available on the Amazon [Appstore](https://www.amazon.com/Geeksville-Industries-Meshtastic/dp/B08CY9394Q). You will need to install the Amazon Appstore onto your phone in order to install the Meshtastic application.
|
||||||
|
|
|
@ -81,10 +81,16 @@ You should see a message with the option "open with Meshtastic".
|
||||||
<summary>Troubleshooting: Can't "open with Meshtastic".</summary>
|
<summary>Troubleshooting: Can't "open with Meshtastic".</summary>
|
||||||
<div>
|
<div>
|
||||||
<div>
|
<div>
|
||||||
If you don't see "Meshtastic" as an option to open the file or link with:<br />
|
If you don't see "Meshtastic" as an option to open the file or link with:
|
||||||
1. Go to Android Settings > Apps > Default apps > Meshtastic > Opening links<br />
|
<br />
|
||||||
2. Make sure you have in "links/web address": www.meshtastic.org<br />
|
1. Go to Android Settings > Apps > Default apps > Meshtastic > Opening
|
||||||
3. If you see the option "Open the supported links", make sure it is enabled.<br />
|
links
|
||||||
|
<br />
|
||||||
|
2. Make sure you have in "links/web address": www.meshtastic.org
|
||||||
|
<br />
|
||||||
|
3. If you see the option "Open the supported links", make sure it is
|
||||||
|
enabled.
|
||||||
|
<br />
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</details>
|
</details>
|
|
@ -20,7 +20,7 @@ This can be installed using pip.
|
||||||
python -m pip install --upgrade meshtastic-pygui
|
python -m pip install --upgrade meshtastic-pygui
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="MacOS/Linux"
|
```shell title="MacOS/Linux"
|
||||||
pip3 install --upgrade meshtastic-pygui
|
pip3 install --upgrade meshtastic-pygui
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -30,7 +30,7 @@ And launched using python.
|
||||||
python -m meshtastic_pygui
|
python -m meshtastic_pygui
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash title="MacOS/Linux"
|
```shell title="MacOS/Linux"
|
||||||
python3 -m meshtastic_pygui
|
python3 -m meshtastic_pygui
|
||||||
```
|
```
|
||||||
|
|
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue