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

Consolidate examples on 1.3 config pages

Browse source
This commit is contained in:
Garth Vander Houwen 2022-06-25 19:18:02 -07:00
parent 3de2cabfc7
commit 085f8e5398
3 changed files with 14 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/settings/config/display.mdx
View file

@ -62,19 +62,14 @@ All display config options are available on iOS, iPadOS and macOS at Settings >
All display config options are available in the python CLI. Example commands are below: All display config options are available in the python CLI. Example commands are below:
```shell title="Set display_screen_on_secs to default (10 minutes)" ```shell title="Set Screen On Duration (Default of 0 is 10 minutes)"
meshtastic --set screen_on_secs 0 meshtastic --set screen_on_secs 0
```
```shell title="Set display_screen_on_secs to 120 seconds (2 minutes)"
meshtastic --set screen_on_secs 120 meshtastic --set screen_on_secs 120
``` ```
```shell title="Set display_auto_screen_carousel_secs to default value of off" ```shell title="Set Auto Carousel Interval (Default of 0 is Off)"
meshtastic --set auto_screen_carousel_secs 0 meshtastic --set auto_screen_carousel_secs 0
``` // Set to 2 Minutes (120 Seconds)
```shell title="Set display_auto_screen_carousel_secs to 120 seconds (2 minutes)"
meshtastic --set auto_screen_carousel_secs 120 meshtastic --set auto_screen_carousel_secs 120
``` ```

27
docs/settings/config/position.mdx
View file

@ -111,22 +111,16 @@ All Position config conmmands are available in the python CLI. Example commands
| fixed_position | `true`, `false` | `false` | | fixed_position | `true`, `false` | `false` |
| position_broadcast_smart | `true`, `false` | `true` | | position_broadcast_smart | `true`, `false` | `true` |
| position_broadcast_secs | `integer` (seconds) | Default of `0` is 15 Minutes | | position_broadcast_secs | `integer` (seconds) | Default of `0` is 15 Minutes |
| position_flags | `POS_UNDEFINED`, `POS_ALTITUDE`, `POS_ALT_MSL`, `POS_GEO_SEP`, `POS_DOP`, `POS_HVDOP`, `PDOP`, `POS_BATTERY`, `POS_SATINVIEW`, `POS_SEQ_NOS`, `POS_TIMESTAMP` | `POS_UNDEFINED` | | position_flags | `POS_UNDEFINED`, `POS_ALTITUDE`, `POS_ALT_MSL`, `POS_GEO_SEP`, `POS_DOP`, `POS_HVDOP`, `PDOP`, `POS_BATTERY`, `POS_SATINVIEW`, `POS_SEQ_NOS`, `POS_TIMESTAMP`, `POS_HEADING`, `POS_SPEED` | `POS_UNDEFINED` |
```shell title="Set GPS update interval to default settings (every 30 seconds)" ```shell title="Set GPS update interval (Default of 0 is 30 seconds)"
meshtastic --set gps_update_interval 0 meshtastic --set gps_update_interval 0
```
```shell title="Set GPS update interval to every 45 seconds"
meshtastic --set gps_update_interval 45 meshtastic --set gps_update_interval 45
``` ```
```shell title="Set GPS attempt time to default (30 seconds)" ```shell title="Set GPS attempt time (Default of 0 is 30 seconds)"
meshtastic --set gps_attempt_time 0 meshtastic --set gps_attempt_time 0
```
```shell title="Set GPS attempt time to 45 seconds"
meshtastic --set gps_attempt_time 45 meshtastic --set gps_attempt_time 45
``` ```
@ -146,19 +140,13 @@ meshtastic --setlat 37.8651 --setlon -119.5383
meshtastic --set fixed_position false meshtastic --set fixed_position false
``` ```
```shell title="Enable smart position broadcast (default)" ```shell title="Enable / Disable Smart position broadcast (Enabled by default)"
meshtastic --set position_broadcast_smart true meshtastic --set position_broadcast_smart true
```
```shell title="Disable smart position broadcast"
meshtastic --set position_broadcast_smart false meshtastic --set position_broadcast_smart false
``` ```
```shell title="Set GPS update interval to default settings (every 15 minutes)" ```shell title="Set Position Broadcast Interval (Default of 0 is 15 minutes)"
meshtastic --set position_broadcast_secs 0 meshtastic --set position_broadcast_secs 0
```
```shell title="Set GPS update interval to every 60 seconds"
meshtastic --set position_broadcast_secs 60 meshtastic --set position_broadcast_secs 60
``` ```
@ -170,11 +158,8 @@ It may take some time to see that the change has taken effect. The GPS location
Include each flag desired separated by a single space. Include each flag desired separated by a single space.
::: :::
```shell title="Set Position Flags" ```shell title="Set / Unset Position Flags"
meshtastic --pos-fields POS_ALTITUDE POS_ALT_MSL meshtastic --pos-fields POS_ALTITUDE POS_ALT_MSL
```
```shell title="Unset Position Flags"
meshtastic --pos-fields POS_UNDEFINED meshtastic --pos-fields POS_UNDEFINED
``` ```

16
docs/settings/config/wifi.mdx
View file

@ -87,11 +87,8 @@ All WiFi config options are available in the python CLI.
| wifi_password | string | `""` | | wifi_password | string | `""` |
| wifi_ssid | string | `""` | | wifi_ssid | string | `""` |
```shell title="Enable SoftAP" ```shell title="Enable / Disable SoftAP"
meshtastic --set wifi_ap_mode true meshtastic --set wifi_ap_mode true
```
```shell title="Disable SoftAP"
meshtastic --set wifi_ap_mode false meshtastic --set wifi_ap_mode false
``` ```
@ -99,19 +96,16 @@ meshtastic --set wifi_ap_mode false
meshtastic --set wifi_ap_hidden false meshtastic --set wifi_ap_hidden false
``` ```
```shell title="Set WiFi network" ```shell title="Set WiFi SSID"
meshtastic --set wifi_ssid mynetwork
```
```shell title="Set WiFi network (with spaces)" meshtastic --set wifi_ssid mynetwork
// With spaces
meshtastic --set wifi_ssid "my network" meshtastic --set wifi_ssid "my network"
``` ```
```shell title="Set WiFi password" ```shell title="Set WiFi password"
meshtastic --set wifi_password mypassword meshtastic --set wifi_password mypassword
``` // With spaces
```shell title="Set WiFi password (with spaces)"
meshtastic --set wifi_password "my password" meshtastic --set wifi_password "my password"
``` ```