mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2025-03-05 21:00:08 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

trunk fmt (#1522)

Browse source
This commit is contained in:
rcarteraz 2024-10-23 12:54:01 -07:00 committed by GitHub
parent ba487d7eec
commit 44ee59ec7d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 109 additions and 81 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/configuration/module/serial.mdx
View file

@ -14,7 +14,11 @@ This is an interface to talk to and control your Meshtastic device over a serial
![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>
<object
data="https://www.youtube.com/embed/HdOiGKBtapw?autohide=1&autoplay=0"
width="100%"
height="400"
></object>
## Serial Module Config Values
@ -121,7 +125,7 @@ All serial module config options are available in the python CLI. Example comman
:::
| Setting | Acceptable Values | Default |
| :------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------: |
| :---------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------: |
| serial.enabled | `true`, `false` | `false` |
| serial.echo | `true`, `false` | `false` |
| serial.mode | `DEFAULT` `SIMPLE` `PROTO` `TEXTMSG`, `NMEA`, `CALTOPO` | `DEFAULT` |
@ -131,7 +135,6 @@ All serial module config options are available in the python CLI. Example comman
| serial.timeout | `integer` (milli seconds) | Default of `0` corresponds to 250 ms |
| serial.override_console_serial_port | `true`, `false` | `false` |
:::tip
Because the device will reboot after each command is sent via CLI, it is recommended when setting multiple values in a config section that commands be chained together as one.
@ -264,6 +267,7 @@ while True:
```
#### Arduino Mini Pro BOM
- An Arduino Mini Pro with example sketch from below uploaded to it.
- T-Beam V1.1 running Meshtastic
- PIR Sensor ([Adafruit Breadboard Model](https://www.adafruit.com/product/4871))

1
docs/configuration/radio/channels.mdx
View file

@ -164,7 +164,6 @@ Tap "Edit" to access the Channel Menu:
5. Precise location (if position is enabled)
6. Position precision (if precise location is disabled)
</TabItem>
<TabItem value="apple">

79
docs/software/android/usage.mdx
View file

@ -6,10 +6,9 @@ sidebar_position: 2
---
import PositionPrecision from "@site/docs/blocks/_position-precision.mdx";
import Link from "@docusaurus/Link"
import ThemedImage from '@theme/ThemedImage';
import useBaseUrl from '@docusaurus/useBaseUrl';
import Link from "@docusaurus/Link";
import ThemedImage from "@theme/ThemedImage";
import useBaseUrl from "@docusaurus/useBaseUrl";
## Introduction
@ -46,8 +45,10 @@ The cloud icon at the top right corner indicates if you are connected to a devic
alt="Not connected"
className="max-h-14"
sources={{
light: useBaseUrl('/img/android/android-no-ack_lt.webp'),
dark: useBaseUrl('/img/android/android-no-ack_dk.webp'),}}/>
light: useBaseUrl("/img/android/android-no-ack_lt.webp"),
dark: useBaseUrl("/img/android/android-no-ack_dk.webp"),
}}
/>
</center>
Cloud with a slash through it: No device connected to the application.
@ -56,8 +57,10 @@ Cloud with a slash through it: No device connected to the application.
alt="Connected"
className="max-h-14"
sources={{
light: useBaseUrl('/img/android/android-imp-ack_lt.webp'),
dark: useBaseUrl('/img/android/android-imp-ack_dk.webp'),}}/>
light: useBaseUrl("/img/android/android-imp-ack_lt.webp"),
dark: useBaseUrl("/img/android/android-imp-ack_dk.webp"),
}}
/>
</center>
Cloud with a check in it: Device connected to the application.
@ -66,16 +69,20 @@ Cloud with a check in it: Device connected to the application.
alt="Sleeping"
className="max-h-14"
sources={{
light: useBaseUrl('/img/android/android-waiting_lt.webp'),
dark: useBaseUrl('/img/android/android-waiting_dk.webp'),}}/>
light: useBaseUrl("/img/android/android-waiting_lt.webp"),
dark: useBaseUrl("/img/android/android-waiting_dk.webp"),
}}
/>
</center>
Cloud with an up arrow in it: Device is connected, but currently sleeping or out of range.
Cloud with an up arrow in it: Device is connected, but currently sleeping or out
of range.
## Common tasks
### Set your region
In order to start communicating with your mesh, you must select a region. This setting controls which frequency range your device uses and should be set according to your location. See [Region Settings](https://meshtastic.org/docs/getting-started/initial-config#set-regional-settings) for a list of region codes and their meanings.
- Tap on the "Region" dropdown in the top-right corner and make the appropriate selection.
### Change your name
@ -113,6 +120,7 @@ The app will generate a new QR code on the screen. This encodes the channel det
2. If the channel is shared from a file or link using the `Share` button, you can click on the file or link and you need to choose "Open with Meshtastic".
:::info If a QR or URL opens a webpage instead of the APP or "Open with Meshtastic" is not an option:
1. Go to Android Settings > Apps > Default apps > Meshtastic > Opening links
2. Make sure you have in "links/web address": www.meshtastic.org
3. If you see the option "Open the supported links", make sure it is enabled.
@ -134,6 +142,7 @@ You can test changing channels with the QR code shown below.
### Adjust a channel
You can change the following settings by tapping on the name of an existing channel:
1. MQTT Uplink
2. MQTT Downlink
3. Position enabled
@ -141,6 +150,7 @@ You can change the following settings by tapping on the name of an existing chan
5. Position precision (if precise location is disabled)
#### Position Precision
The precision levels currently used in the app correspond the values in the table below. These can be thought of as the radius of a circle around a point (not your current location) which you are within.
<PositionPrecision />
@ -161,50 +171,65 @@ With LoRa (or any radio) there is some uncertainty that the message has been rec
alt="cloud up"
className="max-h-18"
sources={{
light: useBaseUrl('/img/android/android-waiting_lt.webp'),
dark: useBaseUrl('/img/android/android-waiting_dk.webp'),}}/>
light: useBaseUrl("/img/android/android-waiting_lt.webp"),
dark: useBaseUrl("/img/android/android-waiting_dk.webp"),
}}
/>
</center>
Cloud with an up arrow: the message is queued in the app, waiting to be handed to the device.
Cloud with an up arrow: the message is queued in the app, waiting to be handed
to the device.
<center>
<ThemedImage
alt="cloud only"
className="max-h-18"
sources={{
light: useBaseUrl('/img/android/android-sent_lt.webp'),
dark: useBaseUrl('/img/android/android-sent_dk.webp'),}}/>
light: useBaseUrl("/img/android/android-sent_lt.webp"),
dark: useBaseUrl("/img/android/android-sent_dk.webp"),
}}
/>
</center>
- Cloud only: the device received the message from the app, and it has been sent and transmitted via LoRa.
- Cloud only: the device received the message from the app, and it has been sent
and transmitted via LoRa.
<center>
<ThemedImage
alt="Cloud with a check mark"
className="max-h-18"
sources={{
light: useBaseUrl('/img/android/android-imp-ack_lt.webp'),
dark: useBaseUrl('/img/android/android-imp-ack_dk.webp'),}}/>
light: useBaseUrl("/img/android/android-imp-ack_lt.webp"),
dark: useBaseUrl("/img/android/android-imp-ack_dk.webp"),
}}
/>
</center>
- Cloud with a check mark: received at least one node's acknowledgement response. Confirmations could be from any one device.
- Cloud with a check mark: received at least one node's acknowledgement
response. Confirmations could be from any one device.
<center>
<ThemedImage
alt="Person with a check mark"
className="max-h-18"
sources={{
light: useBaseUrl('/img/android/android-DM-ack_lt.webp'),
dark: useBaseUrl('/img/android/android-DM-ack_dk.webp'),}}/>
light: useBaseUrl("/img/android/android-DM-ack_lt.webp"),
dark: useBaseUrl("/img/android/android-DM-ack_dk.webp"),
}}
/>
</center>
- Person with a check mark - The intended recipient node of your direct message acknowledged the message.
- Person with a check mark - The intended recipient node of your direct message
acknowledged the message.
<center>
<ThemedImage
alt="Cloud crossed out"
className="max-h-18"
sources={{
light: useBaseUrl('/img/android/android-no-ack_lt.webp'),
dark: useBaseUrl('/img/android/android-no-ack_dk.webp'),}}/>
light: useBaseUrl("/img/android/android-no-ack_lt.webp"),
dark: useBaseUrl("/img/android/android-no-ack_dk.webp"),
}}
/>
</center>
- Cloud crossed out: the initial sender did not receive any confirmation within a certain timeout.
- Cloud crossed out: the initial sender did not receive any confirmation within
a certain timeout.
By default there is no long-term store-and-forward of messages, so messages not received during transmission are lost.
@ -225,7 +250,6 @@ The network list shows all the users (devices) that have connected to the same C
The Map tab will show a local map with an icon for each active mesh node that has a known position. The users names are shown above the icon.
[![Map Layers](/img/android/android-map-layers-c.webp)](/img/android/android-map-layers.webp)
- Clicking the layers icon in the top-right will allow you to select the map type.
@ -253,6 +277,7 @@ The debug panel allows you to see all packets sent between the application and t
[![Meshtastic configuration options](/img/android/android-radio-configuration-c.webp)](/img/android/android-radio-configuration.webp)
Radio Configuration opens a list of all radio and module configuration settings.
- See [Radio Config](/docs/configuration/radio) for radio settings.
- See [Module Config](/docs/configuration/module) for module settings.
- At the end of this list are buttons for Reboot, Shutdown, Factory reset, and NodeDB reset.