mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2025-01-11 13:57:49 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge branch 'master' into sx1262-doc-warning

Browse source
This commit is contained in:
Phil Johnston 2025-01-05 11:23:51 -08:00 committed by GitHub
parent 6f1413dec3 2d8c064bf1
commit fbc37386e0
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
10 changed files with 55 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
a0a26e4d40a5b9ccba9185eb70e2eaf66f0b0587_2_1380x888.jpeg
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 295 KiB

9
docs/blocks/_native-libraries.mdx Normal file
View file

@ -0,0 +1,9 @@
- Necessary system libraries should be installed before building or installing Meshtasticd.
```shell
sudo apt install libgpiod-dev libyaml-cpp-dev libbluetooth-dev libusb-1.0-0-dev libi2c-dev
```
- And optionally for web server support
```shell
sudo apt install openssl libssl-dev libulfius-dev liborcania-dev
```

11
docs/community/local-groups.mdx
View file

@ -47,6 +47,8 @@ us on [Discord](https://discord.com/invite/ktMAKGBnBs) to add your group.
- [Burgas Mesh](https://discord.gg/Kbs233rmq3) - [Burgas Mesh](https://discord.gg/Kbs233rmq3)
## Canada ## Canada
- [Canadaverse Mesh Wiki](https://wiki.mt.gt/)
- [Mesh Canada](https://t.me/meshtastic_canada)
### Alberta ### Alberta
@ -190,6 +192,7 @@ us on [Discord](https://discord.com/invite/ktMAKGBnBs) to add your group.
## United States ## United States
- [Midwest Mesh](https://discord.gg/wYwD56K439) - [Midwest Mesh](https://discord.gg/wYwD56K439)
- [Mountain Mesh (North GA / East TN)](https://mtnme.sh)
### Arizona ### Arizona
@ -218,6 +221,10 @@ us on [Discord](https://discord.com/invite/ktMAKGBnBs) to add your group.
- [Denver Mesh](https://denvermesh.org) - [Denver Mesh](https://denvermesh.org)
### Georgia
- [CSRA Mesh](https://discord.gg/rQSTQDZKgs)
### Hawaii ### Hawaii
- [Hawaii Meshnet](https://www.hawaiimesh.net/) - [Hawaii Meshnet](https://www.hawaiimesh.net/)
@ -259,6 +266,7 @@ us on [Discord](https://discord.com/invite/ktMAKGBnBs) to add your group.
- [Cincy Mesh](https://www.cincymesh.org) - [Cincy Mesh](https://www.cincymesh.org)
- [Dayton Mesh](https://daytonmesh.org/) - [Dayton Mesh](https://daytonmesh.org/)
- [Central Ohio (Columbus Metro Area) Mesh](https://meshcolumb.us/)
### Oklahoma ### Oklahoma
@ -278,12 +286,13 @@ us on [Discord](https://discord.com/invite/ktMAKGBnBs) to add your group.
- [Austin Mesh](https://austinmesh.org/) - [Austin Mesh](https://austinmesh.org/)
- [Cypress, Texas Meshtastic Club](https://discord.gg/KzuwNRwE6q) - [Cypress, Texas Meshtastic Club](https://discord.gg/KzuwNRwE6q)
- [DFW / North Texas Mesh](https://discord.gg/jyzYRTtyMD) - [DFW / North Texas Mesh](https://ntxmesh.net)
### Virginia ### Virginia
- [MadisonMesh](https://madisonmesh.com/) - [MadisonMesh](https://madisonmesh.com/)
- [Albemarle Mesh](https://albemarlemesh.com/) - [Albemarle Mesh](https://albemarlemesh.com/)
- [Shenandoah Valley Mesh](https://svmesh.org)
### Wisconsin ### Wisconsin

31
docs/configuration/radio/device.mdx
View file

@ -14,24 +14,26 @@ The device config options are: Role, Serial Output, and Debug Log. Device config
## Roles ## Roles
| Device Role | Description | Best Uses | | Device Role | Description | Best Uses |
| -------------- | ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| CLIENT | App connected or stand alone messaging device. | General use for individuals needing to communicate over the Meshtastic network with support for client applications. | | CLIENT | App connected or stand alone messaging device. Rebroadcasts packets when no other node has done so. | General use for individuals needing to communicate over the Meshtastic network with support for client applications. |
| CLIENT_MUTE | Device that does not forward packets from other devices. | Situations where a device needs to participate in the network without assisting in packet routing, reducing network load. | | CLIENT_MUTE | Device that does not forward packets from other devices. | Situations where a device needs to participate in the network without assisting in packet routing, reducing network load. |
| CLIENT_HIDDEN | Device that only broadcasts as needed for stealth or power savings. | Use in stealth/hidden deployments or to reduce airtime/power consumption while still participating in the network. | | CLIENT_HIDDEN | Device that only broadcasts as needed for stealth or power savings. | Use in stealth/hidden deployments or to reduce airtime/power consumption while still participating in the network. |
| TRACKER | Broadcasts GPS position packets as priority. | Tracking the location of individuals or assets, especially in scenarios where timely and efficient location updates are critical. | | TRACKER | Broadcasts GPS position packets as priority. | Tracking the location of individuals or assets, especially in scenarios where timely and efficient location updates are critical. |
| LOST_AND_FOUND | Broadcasts location as message to default channel regularly for to assist with device recovery. | Used for recovery efforts of a lost device. | | LOST_AND_FOUND | Broadcasts location as message to default channel regularly for to assist with device recovery. | Used for recovery efforts of a lost device. |
| SENSOR | Broadcasts telemetry packets as priority. | Deploying in scenarios where gathering environmental or other sensor data is crucial, with efficient power usage and frequent updates. | | SENSOR | Broadcasts telemetry packets as priority. | Deploying in scenarios where gathering environmental or other sensor data is crucial, with efficient power usage and frequent updates. |
| TAK | Optimized for ATAK system communication, reduces routine broadcasts. | Integration with ATAK systems (via the Meshtastic ATAK Plugin) for communication in tactical or coordinated operations. | | TAK | Optimized for ATAK system communication, reduces routine broadcasts. | Integration with ATAK systems (via the Meshtastic ATAK Plugin) for communication in tactical or coordinated operations. |
| TAK_TRACKER | Enables automatic TAK PLI broadcasts and reduces routine broadcasts. | Standalone PLI integration with ATAK systems for communication in tactical or coordinated operations. | | TAK_TRACKER | Enables automatic TAK PLI broadcasts and reduces routine broadcasts. | Standalone PLI integration with ATAK systems for communication in tactical or coordinated operations. |
| REPEATER | Infrastructure node for extending network coverage by relaying messages with minimal overhead. Not visible in Nodes list. | Best positioned in strategic locations to maximize the network's overall coverage. Device is not shown in topology. | | REPEATER | Infrastructure node for extending network coverage by always rebroadcasting packets once with minimal overhead. Not visible in Nodes list. | Best positioned in strategic locations to maximize the network's overall coverage. Device is not shown in topology. |
| ROUTER | Infrastructure node for extending network coverage by relaying messages. Visible in Nodes list. | Best positioned in strategic locations to maximize the network's overall coverage. Device is shown in topology. | | ROUTER | Infrastructure node for extending network coverage by always rebroadcasting packets once. Visible in Nodes list. | Best positioned in strategic locations to maximize the network's overall coverage. Device is shown in topology. |
| ROUTER_LATE | Infrastructure node that always rebroadcasts packets once but only after all other modes, ensuring additional coverage for local clusters. Visble in Nodes list. | Ideal for covering dead spots or ensuring reliability for a cluster of nodes where placement doesn’t benefit the broader mesh. Device is shown in topology. |
:::tip :::tip
Still not sure which role to use? Check out the [role configuration tips](/docs/configuration/tips/#roles) Still not sure which role to use? Check out our blog post: [Choosing the Right Device Role](/blog/choosing-the-right-device-role/)
::: :::
Looking for ROUTER_CLIENT? This role was deprecated in firmware 2.3.15. Learn more in the [2.3.15 release notes](https://github.com/meshtastic/firmware/releases/tag/v2.3.15.deb7c27) Looking for ROUTER_CLIENT? This role was deprecated in firmware 2.3.15. Learn more in the [2.3.15 release notes](https://github.com/meshtastic/firmware/releases/tag/v2.3.15.deb7c27)
### Role Comparison ### Role Comparison
This table shows the **default** values after selecting a preset. As always, individual settings can be adjusted after choosing a preset. This table shows the **default** values after selecting a preset. As always, individual settings can be adjusted after choosing a preset.
@ -47,6 +49,7 @@ This table shows the **default** values after selecting a preset. As always, ind
| TAK | Yes | Optional | Regular | Yes | No | Yes | | TAK | Yes | Optional | Regular | Yes | No | Yes |
| TAK_TRACKER | Yes | Optional | Regular | Yes | No | Yes | | TAK_TRACKER | Yes | Optional | Regular | Yes | No | Yes |
| ROUTER | No[^2] | No | High | Yes | Yes | Yes | | ROUTER | No[^2] | No | High | Yes | Yes | Yes |
| ROUTER_LATE | Yes | Yes | High | Yes | No | Yes |
| REPEATER | Yes | No | High | Yes | Yes | No | | REPEATER | Yes | No | High | Yes | Yes | No |
[^1]: **Awake Only** indicates retransmissions will occur normally but not while asleep between transmission intervals. [^1]: **Awake Only** indicates retransmissions will occur normally but not while asleep between transmission intervals.
@ -72,7 +75,7 @@ In the `TRACKER` and `SENSOR` roles, there are special sleep behaviors when comb
This setting defines the device's behavior for how messages are rebroadcasted. This setting defines the device's behavior for how messages are rebroadcasted.
| Value | Description | | Value | Description |
|:--------------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| | :------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| `ALL` | ALL (Default) - This setting will rebroadcast ALL messages from its primary mesh as well as other meshes with the same modem settings, including when encryption settings differ. | | `ALL` | ALL (Default) - This setting will rebroadcast ALL messages from its primary mesh as well as other meshes with the same modem settings, including when encryption settings differ. |
| `ALL_SKIP_DECODING` | ALL_SKIP_DECODING - Same as behavior as ALL, but skips packet decoding and simply rebroadcasts them. **Only available with Repeater role.** | | `ALL_SKIP_DECODING` | ALL_SKIP_DECODING - Same as behavior as ALL, but skips packet decoding and simply rebroadcasts them. **Only available with Repeater role.** |
| `LOCAL_ONLY` | LOCAL_ONLY - Ignores observed messages from foreign meshes that are open or those which it cannot decrypt. Only rebroadcasts message on the nodes local primary / secondary channels. | | `LOCAL_ONLY` | LOCAL_ONLY - Ignores observed messages from foreign meshes that are open or those which it cannot decrypt. Only rebroadcasts message on the nodes local primary / secondary channels. |

2
docs/configuration/radio/power.mdx
View file

@ -184,7 +184,7 @@ Power Config options are available for Android.
:::info :::info
Select Power config options are available on iOS, iPadOS and macOS at Settings > Deivce Configuration > Power. Select Power config options are available on iOS, iPadOS and macOS at Settings > Device Configuration > Power.
::: :::

3
docs/configuration/remote-admin.mdx
View file

@ -74,13 +74,12 @@ Legacy admin is enabled using the Legacy Admin channel option in [Security Confi
#### Setting up Remote Admin Using the PKC Method #### Setting up Remote Admin Using the PKC Method
1. Connect to the node that will be used to administer the remote node. 1. Connect to the node that will be used to administer the remote node.
2. Go to Settings > App Settings on this node and enable **Administration**. 2. Go to **Settings > App Settings** on this node and enable **Administration**.
3. Navigate to **Settings > Radio Configuration > [Security](/docs/configuration/radio/security/#public-key)** to find its public key. 3. Navigate to **Settings > Radio Configuration > [Security](/docs/configuration/radio/security/#public-key)** to find its public key.
4. Copy the public key to use for configuring the remote node. 4. Copy the public key to use for configuring the remote node.
5. Connect to the remote node. 5. Connect to the remote node.
6. In **Settings > Radio Configuration > Security**, add the public key of the local node as an Admin Key. 6. In **Settings > Radio Configuration > Security**, add the public key of the local node as an Admin Key.
7. Up to 3 Admin Keys may be supplied, allowing up to 3 controlling nodes. 7. Up to 3 Admin Keys may be supplied, allowing up to 3 controlling nodes.
8. On the remote node, go to **Settings > App Settings** and enable **Administration**.
#### Setting up Remote Admin using the Legacy method #### Setting up Remote Admin using the Legacy method

2
docs/hardware/devices/lilygo/tdeck/index.mdx
View file

@ -41,7 +41,7 @@ T-Deck Plus variant also comes with a GPS module and a 2000 mAh battery
| `alt` & `c` | Toggle modifier function. `Fn` displayed on screen. | | `alt` & `c` | Toggle modifier function. `Fn` displayed on screen. |
| `alt` & `c` + `m` | Disable/Enable notifications. | | `alt` & `c` + `m` | Disable/Enable notifications. |
| `alt` & `c` + `q` | Quit/Cancel (message, canned message, etc.) | | `alt` & `c` + `q` | Quit/Cancel (message, canned message, etc.) |
| `alt` & `c` + `t` | Tab Key (select channel/dm recipient) | | `alt` & `c` + `t` | Tab Key (once for dm recipient, twice for channel) |
| `alt` & `c` + `i` | Decrease screen brightness. | | `alt` & `c` + `i` | Decrease screen brightness. |
| `alt` & `c` + `o` | Increase screen brightness. | | `alt` & `c` + `o` | Increase screen brightness. |
| `alt` & `c` + `g` | Toggle GPS. | | `alt` & `c` + `g` | Toggle GPS. |

12
docs/hardware/devices/linux-native-hardware/linux-native-hardware.mdx
View file

@ -6,6 +6,8 @@ sidebar_position: 11
description: Set up and configure Meshtastic on Linux-native devices using the meshtasticd binary. description: Set up and configure Meshtastic on Linux-native devices using the meshtasticd binary.
--- ---
import NativeLibraries from "@site/docs/blocks/_native-libraries.mdx";
This page outlines the setup of Meshtastic on Linux-native devices, utilizing portduino to run the Meshtastic firmware under Linux. This page outlines the setup of Meshtastic on Linux-native devices, utilizing portduino to run the Meshtastic firmware under Linux.
## Prerequisites and Hardware Compatibility ## Prerequisites and Hardware Compatibility
@ -38,15 +40,7 @@ Before proceeding with the setup, ensure the device meets the following requirem
### Installing Meshtasticd ### Installing Meshtasticd
- Necessary system libraries should be installed before building or installing Meshtastic. <NativeLibraries />
```shell
sudo apt install libgpiod-dev libyaml-cpp-dev libbluetooth-dev
```
- And optionally for web server support
```shell
sudo apt install openssl libssl-dev libulfius-dev liborcania-dev
```
- The .deb Package is available as [part of the release](https://github.com/meshtastic/firmware/releases/latest), installing the binary, a systemd service, and a config file. It is compiled for Debian Bookworm and incompatible with Bullseye. - The .deb Package is available as [part of the release](https://github.com/meshtastic/firmware/releases/latest), installing the binary, a systemd service, and a config file. It is compiled for Debian Bookworm and incompatible with Bullseye.
```shell ```shell

4
docs/software/linux-native.mdx
View file

@ -5,6 +5,8 @@ sidebar_label: Linux Native
sidebar_position: 5 sidebar_position: 5
--- ---
import NativeLibraries from "@site/docs/blocks/_native-libraries.mdx";
The device software can also run on a native Linux machine thanks to the [Portduino framework](https://github.com/geeksville/framework-portduino). The device software can also run on a native Linux machine thanks to the [Portduino framework](https://github.com/geeksville/framework-portduino).
The application either simulates some of the interfaces, or uses the real hardware of your machine. The application either simulates some of the interfaces, or uses the real hardware of your machine.
@ -17,6 +19,8 @@ For instructions on how to use it, see the [interactive simulator](https://githu
The easiest way of building the native application is using Visual Studio Code with the PlatformIO extension. The easiest way of building the native application is using Visual Studio Code with the PlatformIO extension.
See the instructions for creating such a building environment [here](/docs/development/firmware/build). See the instructions for creating such a building environment [here](/docs/development/firmware/build).
<NativeLibraries />
Then after opening the firmware repository in Visual Studio Code, simply click on the PlatformIO extension in the left bar, select native and click on 'Build'. Then after opening the firmware repository in Visual Studio Code, simply click on the PlatformIO extension in the left bar, select native and click on 'Build'.
This will generate the binary file 'program' which you can find in `.pio/build/native/`. This will generate the binary file 'program' which you can find in `.pio/build/native/`.
Once in this directory or when you copied the file to your current directory, launch the application with `./program`. Once in this directory or when you copied the file to your current directory, launch the application with `./program`.

14
docs/software/python-cli/installation.mdx
View file

@ -96,11 +96,12 @@ values={[
``` ```
- Install meshtastic: - Install meshtastic:
```shell ```shell
pip3 install --upgrade meshtastic pip3 install --upgrade "meshtastic[cli]"
``` ```
(the `[cli]` suffix installs a few optional dependencies that match older versions of the CLI)
- Using pipx as an alternative to pip3 if `externally-managed-environment` error is encountered - Using pipx as an alternative to pip3 if `externally-managed-environment` error is encountered
```shell ```shell
sudo apt install pipx && pipx install meshtastic sudo apt install pipx && pipx install "meshtastic[cli]"
``` ```
- If using `pipx` it may be necessary to update `$PATH` by running: - If using `pipx` it may be necessary to update `$PATH` by running:
```shell ```shell
@ -147,8 +148,9 @@ values={[
``` ```
- Install meshtastic: - Install meshtastic:
```shell ```shell
sudo pip3 install --upgrade meshtastic sudo pip3 install --upgrade "meshtastic[cli]"
``` ```
(the `[cli]` suffix installs a few optional dependencies that match older versions of the CLI)
</TabItem> </TabItem>
<TabItem value="windows"> <TabItem value="windows">
@ -183,8 +185,9 @@ When installing Python, make sure to select the option to "Add Python to PATH" o
``` ```
- Install meshtastic: - Install meshtastic:
```powershell ```powershell
pip3 install --upgrade meshtastic pip3 install --upgrade "meshtastic[cli]"
``` ```
(the `[cli]` suffix installs a few optional dependencies that match older versions of the CLI)
</TabItem> </TabItem>
<TabItem value="termux"> <TabItem value="termux">
@ -206,8 +209,9 @@ When installing Python, make sure to select the option to "Add Python to PATH" o
``` ```
- Upgrade pip and installed meshtastic and some of its dependencies - Upgrade pip and installed meshtastic and some of its dependencies
```shell ```shell
pip install --upgrade pip pygatt pytap2 wheel meshtastic pip install --upgrade pip pygatt pytap2 wheel "meshtastic[cli]"
``` ```
(the `[cli]` suffix installs a few optional dependencies that match older versions of the CLI)
:::note :::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 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.