mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-11-12 16:44:20 -08:00
remove discourse links
This commit is contained in:
rcarteraz
parent
8a4296ec65
commit
fa11f7aa7f
|
|
@ -6,7 +6,7 @@ labels: ""
|
|||
assignees: ""
|
||||
---
|
||||
|
||||
Please - if you just have a question, post in our [forum](https://meshtastic.discourse.group) instead. Please reserve this system for requesting changes to the Meshtastic documentation.
|
||||
If you have a question, please post it on our [Meshtastic Discussions page](https://github.com/orgs/meshtastic/discussions) instead. This system is reserved specifically for requesting changes to the Meshtastic documentation.
|
||||
|
||||
**Describe what section of the docs is outdated or otherwise in need of change**
|
||||
Be as clear and concise as possible. Provide a URL or GitHub path to the doc you are referencing.
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ If you are interested in a more technical overview of how Meshtastic works, visi
|
|||
|
||||
## Contributors
|
||||
|
||||
Meshtastic is an open source project available on GitHub. Our generous volunteers donate their personal time to write and maintain this codebase. If you would like to contribute see our [GitHub](https://github.com/meshtastic), join our [Discord server](https://discord.gg/ktMAKGBnBs), and read up on our [forum](https://meshtastic.discourse.group).
|
||||
Meshtastic is an open source project available on GitHub. Our generous volunteers donate their personal time to write and maintain this codebase. If you would like to contribute see our [GitHub](https://github.com/meshtastic), join our [Discord server](https://discord.gg/ktMAKGBnBs), and read up on our [Meshtastic Discussions](https://github.com/orgs/meshtastic/discussions).
|
||||
|
||||
<div className="indexCtasBody">
|
||||
<Link
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ sidebar_position: 1
|
|||
description: "Maximize your Meshtastic device's potential with detailed radio settings instructions, including frequency bands, data rates, and encryption options."
|
||||
---
|
||||
|
||||
import {FrequencyCalculator} from "/src/components/tools/FrequencyCalculator";
|
||||
import { FrequencyCalculator } from "/src/components/tools/FrequencyCalculator";
|
||||
|
||||
:::info
|
||||
Meshtastic is **not** LoRaWAN, Helium or TTN (TheThingsNetwork). Meshtastic uses the full spectrum frequency range designated to LoRa technology per region. This allows for several hundred possible frequency channels in the US region alone.
|
||||
|
|
@ -80,7 +80,7 @@ Various data-rate options are available when configuring a frequency slot and ar
|
|||
We have eight LoRa radio presets. These are the most common settings and have been proven to work well:
|
||||
|
||||
| Channel setting | Alt Channel Name | Data-Rate | SF / Symbols | Coding Rate | Bandwidth | Link Budget |
|
||||
|:----------------------:|:----------------:|:----------:|:------------:|:-----------:|:---------:|:-----------:|
|
||||
| :--------------------: | :--------------: | :--------: | :----------: | :---------: | :-------: | :---------: |
|
||||
| Short Range / Turbo | Short Turbo | 21.88 kbps | 7 / 128 | 4/5 | 500[^1] | 140dB |
|
||||
| Short Range / Fast | Short Fast | 10.94 kbps | 7 / 128 | 4/5 | 250 | 143dB |
|
||||
| Short Range / Slow | Short Slow | 6.25 kbps | 8 / 256 | 4/5 | 250 | 145.5dB |
|
||||
|
|
@ -97,7 +97,6 @@ The link budget used by these calculations assumes a transmit power of 22dBm and
|
|||
|
||||
|
||||
|
||||
|
||||
### Custom Settings
|
||||
|
||||
Custom settings can be applied by using [supported software](/docs/software).
|
||||
|
|
@ -121,10 +120,10 @@ Some example settings:
|
|||
|
||||
The link budget used by these calculations assumes a transmit power of 17dBm and an antenna with 0dB gain. Adjust your link budget assumptions based on your actual devices.
|
||||
|
||||
These frequency slot settings may not have been tested. Use at your own discretion. Share on https://meshtastic.discourse.group with your successes or failure.
|
||||
These frequency slot settings may not have been tested. Use at your own discretion. Share on the [Meshtastic Discussions page](https://github.com/orgs/meshtastic/discussions) with your successes or failure.
|
||||
|
||||
## Cryptography
|
||||
|
||||
The pre-shared key (PSK) used by the devices can be an AES128 or AES256 sequence. Alternatively, encryption can be turned off, which may be useful if you are operating under a Ham Radio license.
|
||||
The pre-shared key (PSK) used by the devices can be an AES128 or AES256 sequence. Alternatively, encryption can be turned off, which may be useful if you are operating under a Ham Radio license.
|
||||
|
||||
[^1]: Short Turbo is the fastest preset and the only one with 500kHz bandwidth. It is not legal to use in all regions due to this wider bandwidth.
|
||||
[^1]: Short Turbo is the fastest preset and the only one with 500kHz bandwidth. It is not legal to use in all regions due to this wider bandwidth.
|
||||
|
|
|
|||
|
|
@ -88,6 +88,4 @@ In summary - wavelengths in Europe fair well in plain sight, curve over not-so-t
|
|||
|
||||
## Discussion
|
||||
|
||||
To comment on / join in antenna range [Meshtastic discourse](https://meshtastic.discourse.group/t/antenna-improved-range/227/35?u=sens8tion)
|
||||
|
||||
There, you will also find reference to Meshtastic range achievements and aerial recommendations. (Note we've stopped short of making specific supplier aerial recommendations in this wiki.)
|
||||
For further insights, join the conversation on antenna range and performance at [Meshtastic Discussions on GitHub.](https://github.com/orgs/meshtastic/discussions)
|
||||
|
|
|
|||
|
|
@ -14,6 +14,6 @@ If you opt-in to analytics on the Android app (thank you - that helps us know wh
|
|||
|
||||
The search engine for this website is provided by Algolia, please see their [privacy policy](https://www.algolia.com/policies/privacy) for details of what information they collect.
|
||||
|
||||
This is an open-source project run by hobbyists, and we try to be completely transparent. If you have questions on this policy, please [post on the forum](https://meshtastic.discourse.group/), and we'll reply/clarify/correct.
|
||||
This is an open-source project run by hobbyists, and we try to be completely transparent. If you have questions on this policy, please [post on the Meshtastic Discussions page](https://github.com/orgs/meshtastic/discussions), and we'll reply/clarify/correct.
|
||||
|
||||
Keep being awesome!
|
||||
|
|
|
|||
|
|
@ -41,8 +41,6 @@ The minimum Android version is 5.0 (Lollipop 2014, first BLE support), however A
|
|||
|
||||
There is a Play Store [testing program](https://play.google.com/apps/testing/com.geeksville.mesh) with the latest cutting edge changes, though this may come with extra bugs.
|
||||
|
||||
It is recommended that you follow the [Meshtastic Discourse Alpha Testers](https://meshtastic.discourse.group/c/development/alpha-testers) channel if you decide to join.
|
||||
|
||||
_Google Play and the Google Play logo are trademarks of Google LLC._
|
||||
|
||||
### Install by Sideloading
|
||||
|
|
@ -73,4 +71,4 @@ If you do sideload, you may have to give your browser permissions to run a packa
|
|||
|
||||
Obtainium allows you to install and update Open-Source Apps directly from their releases pages, and receive notifications when new releases are made available.
|
||||
|
||||
\*Alpha releases include the latest cutting edge changes which may come with extra bugs. It is recommended that you follow the [Meshtastic Discourse Alpha Testers](https://meshtastic.discourse.group/c/development/alpha-testers) channel if you decide to use these versions.
|
||||
\*Alpha releases include the latest cutting edge changes which may come with extra bugs. It is recommended that you follow the Meshtastic Alpha Testers Channel on [Discord](https://discord.com/invite/ktMAKGBnBs) if you decide to use these versions.
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ title: Meshtastic Python CLI installation
|
|||
sidebar_label: Installation
|
||||
slug: /software/python/cli/installation
|
||||
sidebar_position: 1
|
||||
description: This page offers comprehensive instructions on methods of installing the Meshtastic Python CLI across different operating systems.
|
||||
description: This page offers comprehensive instructions on methods of installing the Meshtastic Python CLI across different operating systems.
|
||||
---
|
||||
|
||||
import Tabs from "@theme/Tabs";
|
||||
|
|
@ -54,7 +54,7 @@ values={[
|
|||
- You should see something like:
|
||||
- `ID 10c4:ea60 Silicon Labs CP210x UART Bridge` for CP210X
|
||||
- `ID 1a86:55d4 QinHeng Electronics USB Single Serial` for CH9102
|
||||
- If there is no seral device shown that matches the device you are using, please review our [Install Serial Drivers](/docs/getting-started/serial-drivers/) page before proceeding.
|
||||
- If there is no seral device shown that matches the device you are using, please review our [Install Serial Drivers](/docs/getting-started/serial-drivers/) page before proceeding.
|
||||
|
||||
- Check that your computer has Python 3 installed.
|
||||
|
||||
|
|
@ -102,10 +102,10 @@ values={[
|
|||
```shell
|
||||
sudo apt install pipx && pipx install meshtastic
|
||||
```
|
||||
- If using `pipx` it may be necessary to update `$PATH` by running:
|
||||
```shell
|
||||
pipx ensurepath
|
||||
```
|
||||
- If using `pipx` it may be necessary to update `$PATH` by running:
|
||||
```shell
|
||||
pipx ensurepath
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="macos">
|
||||
|
|
@ -210,7 +210,7 @@ When installing Python, make sure to select the option to "Add Python to PATH" o
|
|||
```
|
||||
|
||||
:::note
|
||||
Be aware that the Meshtastic CLI is not able to control the nodes over USB through termux, but you can control devices over Wifi using the `--host x.x.x.x` option with the device IP address (ESP32 or Pico W only). Wifi connection is currently under development and may not be working properly just yet. If you would like to provide feedback or test this feature, please visit our [forum](https://meshtastic.discourse.group) or join our [Discord server](https://discord.gg/ktMAKGBnBs) for more information.
|
||||
Be aware that the Meshtastic CLI is not able to control the nodes over USB through termux, but you can control devices over Wifi using the `--host x.x.x.x` option with the device IP address (ESP32 or Pico W only). Wifi connection is currently under development and may not be working properly just yet. If you would like to provide feedback or test this feature, please join our [Discord server](https://discord.gg/ktMAKGBnBs) for more information.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
|
|
@ -218,7 +218,6 @@ Be aware that the Meshtastic CLI is not able to control the nodes over USB throu
|
|||
|
||||
**You may need to close and re-open the CLI. The path variables may or may not update for the current session when installing.**
|
||||
|
||||
|
||||
### Standalone Installation (Ubuntu only)
|
||||
|
||||
1. Download the `meshtastic_ubuntu` executable from the [Releases](https://github.com/meshtastic/Meshtastic-python/releases) page.
|
||||
|
|
@ -227,6 +226,7 @@ Be aware that the Meshtastic CLI is not able to control the nodes over USB throu
|
|||
```shell
|
||||
chmod +x meshtastic_ubuntu && mv meshtastic_ubuntu meshtastic
|
||||
```
|
||||
|
||||
3. To run the CLI:
|
||||
|
||||
```shell
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ The `meshtastic` command is not run within python but is a script run from your
|
|||
|
||||
## Viewing Serial Output
|
||||
|
||||
The `--noproto` command in the Meshtastic Python CLI is used to disable the API and function merely as a "dumb serial terminal." This mode of operation allows both the API and device functionalities to remain accessible for regular use, while simultaneously providing a window into the raw serial output. This feature can be particularly useful for debugging, development, or understanding the low-level communication between devices. Depends on a physically cabled serial connection. It will connect but not display information over a network (--host) or Bluetooth (--ble) connection.
|
||||
The `--noproto` command in the Meshtastic Python CLI is used to disable the API and function merely as a "dumb serial terminal." This mode of operation allows both the API and device functionalities to remain accessible for regular use, while simultaneously providing a window into the raw serial output. This feature can be particularly useful for debugging, development, or understanding the low-level communication between devices. Depends on a physically cabled serial connection. It will connect but not display information over a network (--host) or Bluetooth (--ble) connection.
|
||||
|
||||
```shellsession title="Example Usage"
|
||||
user@host % meshtastic --noproto
|
||||
|
|
@ -112,12 +112,12 @@ Writing modified channels to device
|
|||
|
||||
Toggling `set-ham` changes your device settings in the following ways.
|
||||
|
||||
| Setting | `set-ham` Default | Normal Default |
|
||||
| :----------: | :---------------: | :------------------------------------------------------------------------: |
|
||||
| Setting | `set-ham` Default | Normal Default |
|
||||
| :----------: | :---------------: | :----------------------------------------------------------------------------: |
|
||||
| `IsLicensed` | `true` | See [User Config - IsLicensed](/docs/configuration/radio/user#is-licensed-ham) |
|
||||
| `LongName` | _Your CallSign_ | See [User Config - LongName](/docs/configuration/radio/user#long-name) |
|
||||
| `ShortName` | _Abrv CallSign_ | See [User Config - ShortName](/docs/configuration/radio/user#short-name) |
|
||||
| `PSK` | `""` | See [Channel Settings - PSK](#changing-the-preshared-key) |
|
||||
| `PSK` | `""` | See [Channel Settings - PSK](#changing-the-preshared-key) |
|
||||
|
||||
## Changing the preshared key
|
||||
|
||||
|
|
@ -190,6 +190,7 @@ meshtastic --ble AA11BB22-CC33-DD44-EE55-FF6677889900 --info
|
|||
```shell
|
||||
meshtastic --ble Meshtastic_1234 --nodes
|
||||
```
|
||||
|
||||
#### Export device config with --export-config
|
||||
|
||||
```shell
|
||||
|
|
@ -214,8 +215,6 @@ This is a collection of common questions and answers from our friendly forum.
|
|||
|
||||
### Permission denied: ‘/dev/ttyUSB0’
|
||||
|
||||
As previously discussed on the [forum](https://meshtastic.discourse.group/t/question-on-permission-denied-dev-ttyusb0/590/3?u=geeksville)
|
||||
|
||||
This indicates an OS permission problem for access by your user to the USB serial port. Typically this is fixed by the following.
|
||||
|
||||
```shell
|
||||
|
|
@ -236,4 +235,4 @@ There is a problem with Big Sur and pyserial. The workaround is to install a new
|
|||
|
||||
```shell
|
||||
pip3 install -U --pre pyserial
|
||||
```
|
||||
```
|
||||
|
|
|
|||
|
|
@ -65,17 +65,6 @@ const SocialCards: SocialCardProps[] = [
|
|||
/>
|
||||
),
|
||||
},
|
||||
{
|
||||
color: "bg-[#ffffff]",
|
||||
link: "https://meshtastic.discourse.group",
|
||||
children: (
|
||||
<img
|
||||
alt="discourse"
|
||||
className="m-auto h-10"
|
||||
src="/img/homepage/Discourse-Logo-White.svg"
|
||||
/>
|
||||
),
|
||||
},
|
||||
{
|
||||
color: "bg-[#FF4500]",
|
||||
link: "https://reddit.com/r/meshtastic",
|
||||
|
|
|
|||
Loading…
Reference in a new issue