mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-12-28 23:19:47 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge branch 'master' into store-and-forward

Browse source
This commit is contained in:
rcarteraz 2023-06-18 22:44:35 -07:00 committed by GitHub
parent baa1c821d9 e482da82ea
commit a4e4c888a1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
18 changed files with 26 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/about/overview/mesh-alg.mdx
View file

@ -10,6 +10,8 @@ sidebar_position: 2
The routing protocol for Meshtastic is really quite simple (and sub-optimal). If you want to test its theoretical performance, you can have a look at the [simulator](https://github.com/GUVWAF/Meshtasticator). The protocol is heavily influenced by the mesh routing algorithm used in [RadioHead](https://www.airspayce.com/mikem/arduino/RadioHead) (which was used in very early versions of this project). It has four conceptual layers.
<object data="https://www.youtube.com/embed/7v6UbC5blJU?autohide=1&autoplay=0" width="100%" height="400"></object>
### 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/protobufs) pervasively. For purposes of this document you mostly only

2
docs/configuration/device-config/bluetooth.mdx
View file

@ -57,7 +57,7 @@ values={[
All Bluetooth config options are available for Android.
1. Open the Meshtastic App
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Device Settings > Bluetooth Config**
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Radio Configuration > Bluetooth**
:::

2
docs/configuration/device-config/device.mdx
View file

@ -88,7 +88,7 @@ values={[
Device Config is available for Android.
1. Open the Meshtastic App
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Device Settings > Device Config**
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Radio Configuration > Device**
:::

2
docs/configuration/device-config/display.mdx
View file

@ -90,7 +90,7 @@ values={[
Display Config is available for Android.
1. Open the Meshtastic App
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Device Settings > Display Config**
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Radio Configuration > Display**
:::

2
docs/configuration/device-config/lora.mdx
View file

@ -138,7 +138,7 @@ values={[
LoRa Config options such as Region, Modem Preset, and Hop Limit can be configured on Android.
1. Open the Meshtastic App
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Device Settings > LoRa Config**
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Radio Configuration > LoRa**
:::

2
docs/configuration/device-config/network.mdx
View file

@ -79,7 +79,7 @@ values={[
Network Config options are available for Android.
1. Open the Meshtastic App
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Device Settings > Network Config**
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Radio Configuration > Network**
:::

2
docs/configuration/device-config/position.mdx
View file

@ -96,7 +96,7 @@ values={[
Position Config options are available for Android.
1. Open the Meshtastic App
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Device Settings > Position Config**
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Radio Configuration > Position**
:::

2
docs/configuration/device-config/power.mdx
View file

@ -141,7 +141,7 @@ values={[
Power Config options are available for Android.
1. Open the Meshtastic App
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Device Settings > Power Config**
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Radio Configuration > Power**
:::

2
docs/configuration/device-config/user.mdx
View file

@ -54,7 +54,7 @@ values={[
User Config options are available for Android.
1. Open the Meshtastic App
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Device Settings > User Config**
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Radio Configuration > User**
:::

3
docs/configuration/module-config/audio.mdx
View file

@ -74,7 +74,8 @@ values={[
Audio Config options are available for Android.
1. Open the Meshtastic App
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Module Settings > Audio Config**
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Radio Configuration > Audio**
:::

2
docs/configuration/module-config/canned-message.mdx
View file

@ -90,7 +90,7 @@ values={[
Canned Message Config options are available for Android.
1. Open the Meshtastic App
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Module Settings > Canned Message Config**
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Radio Configuration > Canned Message**
:::

2
docs/configuration/module-config/external-notification.mdx
View file

@ -65,7 +65,7 @@ values={[
External Notification Config options are available for Android.
1. Open the Meshtastic App
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Module Settings > External Notification Config**
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Radio Configuration > External Notification**
:::

2
docs/configuration/module-config/mqtt.mdx
View file

@ -58,7 +58,7 @@ values={[
MQTT Config options are available for Android.
1. Open the Meshtastic App
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Module Settings > MQTT Config**
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Radio Configuration > MQTT**
:::

2
docs/configuration/module-config/range-test.mdx
View file

@ -44,7 +44,7 @@ values={[
Range Test Config options are available for Android.
1. Open the Meshtastic App
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Module Settings > Range Test Config**
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Radio Configuration > Range Test**
:::

4
docs/configuration/module-config/serial.mdx
View file

@ -14,6 +14,8 @@ This is a simple interface to send messages over the mesh network by sending str
![image](https://user-images.githubusercontent.com/9000580/205529843-962c3187-8411-452c-b729-42c58b1571f5.png)
<object data="https://www.youtube.com/embed/HdOiGKBtapw?autohide=1&autoplay=0" width="100%" height="400"></object>
## Serial Module Config Values
### Enabled
@ -83,7 +85,7 @@ values={[
Serial Module Config options are available for Android.
1. Open the Meshtastic App
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Module Settings > Serial Config**
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Radio Configuration > Serial**
:::

4
docs/configuration/module-config/telemetry.mdx
View file

@ -12,6 +12,8 @@ The Telemetry Module provides three types of data over the mesh: Device metrics
Supported sensors connected to the I2C bus of the device will be automatically detected at startup. Environment Telemetry and Air Quality must be enabled for them to be instrumented and their readings sent over the mesh.
<object data="https://www.youtube.com/embed/6jj1s-fsPlc?autohide=1&autoplay=0" width="100%" height="400"></object>
### Currently Supported Sensor Types
| Sensor | I<sup>2</sup>C Address | Data Points |
@ -87,7 +89,7 @@ values={[
Telemetry Config options are available for Android.
1. Open the Meshtastic App
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Module Settings > Telemetry Config**
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Radio Configuration > Telemetry**
:::

2
docs/configuration/module-config/traceroute.mdx
View file

@ -14,6 +14,8 @@ Only nodes that know the encryption key of the channel you use can be tracked. A
In order to use it, make sure your devices use firmware version 2.0.8 or higher.
<object data="https://www.youtube.com/embed/PKUmaELKaUo?autohide=1&autoplay=0" width="100%" height="400"></object>
## Traceroute Module Client Availability
<Tabs

2
docs/hardware/antennas/lora-antennas.mdx
View file

@ -20,6 +20,8 @@ The antenna's design will affect:
While the LoRa devices we use for Meshtastic are relatively low power radios, care should be taken _not_ to operate any radio transmission device without an antenna or with a poorly matched antenna. Un-transmitted radio signal reflected back to the transmitter can damage the device.
:::
<object data="https://www.youtube.com/embed/V3f-Y3EfsBU?autohide=1&autoplay=0" width="100%" height="400"></object>
## Important considerations
### What transmission frequency are you using?