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

Update 1.2 pages

Browse source
This commit is contained in:
Garth Vander Houwen 2022-06-24 19:42:37 -07:00
parent 7ca2e57faa
commit 79468bd8b3
16 changed files with 904 additions and 85 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
.pnpm-debug.log Normal file
View file

@ -0,0 +1,22 @@
{
"0 debug pnpm:scope": {
"selected": 1
},
"1 error pnpm": {
"code": "ELIFECYCLE",
"errno": "ENOENT",
"syscall": "spawn",
"file": "sh",
"pkgid": "meshtastic@0.0.0",
"stage": "build",
"script": "docusaurus build",
"pkgname": "meshtastic",
"err": {
"name": "pnpm",
"message": "meshtastic@0.0.0 build: `docusaurus build`\nspawn ENOENT",
"code": "ELIFECYCLE",
"stack": "pnpm: meshtastic@0.0.0 build: `docusaurus build`\nspawn ENOENT\n at ChildProcess.<anonymous> (/opt/homebrew/Cellar/pnpm/7.3.0/libexec/lib/node_modules/pnpm/dist/pnpm.cjs:94974:22)\n at ChildProcess.emit (node:events:537:28)\n at maybeClose (node:internal/child_process:1091:16)\n at ChildProcess._handle.onexit (node:internal/child_process:302:5)"
}
},
"2 warn pnpm:global": " Local package.json exists, but node_modules missing, did you mean to install?"
}

4
docs/settings/channel-advanced.mdx
View file

@ -1,7 +1,7 @@
---
id: channel-advanced
title: Channel Settings - Advanced
sidebar_label: Channel
title: 1.2 Channel Settings - Advanced
sidebar_label: 1.2 Channel - Advanced
---
import Tabs from '@theme/Tabs';

4
docs/settings/channel.mdx
View file

@ -1,7 +1,7 @@
---
id: channel
title: Channel Settings
sidebar_label: Channel
title: 1.2 Channel Settings
sidebar_label: 1.2 Channel
---
import Tabs from '@theme/Tabs';

20
docs/settings/config/index.mdx Normal file
View file

@ -0,0 +1,20 @@
---
id: config
title: Config Sections Overview
sidebar_label: Config Sections
---
There are six config sections in the Meshtastic firmware, these are broken out so they can be sent as small admin messages over the mesh.
Default settings values are prefered whenever possible as they consume no bandwidth when sent over the mesh.
| Name | Description |
|:----:|:-----------:|
| [Device](/docs/settings/config/device) | Device config options are: Device Role, Serial Output, Debug Log and Factory Reset. |
| [Display](/docs/settings/config/display) | Display config options are: Screen On Duration, Auto Carousel Interval, and GPS Format. |
| [LoRa](/docs/settings/config/lora) | LoRa config options are: Region, Modem Preset, and Number of Hops. |
| [Position](/docs/settings/config/position) | Positon config options are: GPS Enabled, GPS Update Interval, GPS Attempt Time, Fixed Postion, Smart Broadcast, Broadcast Interval and Position Packet Flags. |
| [Power](/docs/settings/config/power) | Power config options are: Charge Current, Power Saving, Shutdown after losing power, ADC Multiplier Override Wait Bluetooth Interval, Mesh Super Deep Sleep Timeout, Super Deep Sleep Interval, Light Sleep Interval and Minimum Wake Interval. |
| [WiFi](/docs/settings/config/wifi) | WiFi config options are: AP Mode, Hidden AP, SSID and Password. |

94
docs/settings/config/lora.mdx Normal file
View file

@ -0,0 +1,94 @@
---
id: lora
title: LoRa Configuration
sidebar_label: LoRa
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
The LoRa config options are: Region, Modem Preset, and Number of Hops. LoRa config uses an admin message sending a `Config.LoRa` protobuf.
## LoRa Config Values
:::note
It is very important that you set your device's `lora_region` setting. This will ensure that you are operating within the legal limits for your area.
:::
### Region
Sets the region for your node. Default is `unset`.
| Region Code | Description |
| :-------: | :---------------------------------------------------------------------------------------: |
| `unset` | Unset |
| `us` | United States |
| `eu433` | European Union 433mhz |
| `eu868` | European Union 868mhz |
| `cn` | China |
| `jp` | Japan |
| `anz` | Australia & New Zealand |
| `kr` | Korea |
| `tw` | Taiwan |
| `ru` | Russia |
| `in` | India |
| `nz865` | New Zealand 865mhz |
| `th` | Thailand |
### Modem Preset
### Max Hops
## LoRa Config Client Availability
<Tabs
groupId="settings"
defaultValue="flasher"
values={[
{label: 'Android', value: 'android'},
{label: 'Apple', value: 'apple'},
{label: 'Command Line', value: 'cli'},
{label: 'Flasher', value: 'flasher'},
{label: 'Web', value: 'web'},
]}>
<TabItem value="android">
:::info
Region and Modem Preset can be configured on Android.
:::
</TabItem>
<TabItem value="apple">
:::info
Configuration of Region, Modem Preset and Hop Limit is available on iOS, iPadOS and macOS at Settings > Radio Configuration > LoRa.
:::
</TabItem>
<TabItem value="cli">
Select LoRa config conmmands are available in the python CLI. Example commands are below:
| Setting | Acceptable Values | Default |
| :----------: | :---------------------------------------------------------------------------: | :---------------: |
| lora_modem_preset | `longFast`, `longSlow`, `vlongSlow`, `medSlow`, `medFast`, `shortSlow`, `shortFast` | `longFast` |
| lora_region | `Unset`, `us`, `eu433`, `eu868`, `cn`, `jp`, `anz`, `kr`, `tw`, `ru` ,`in`, ` nz865`, `th` | `Unset` |
| lora_hop_limit | `1`,`2`,`3`,`4`,`5`,`6`,`7` | `3`
</TabItem>
<TabItem value="flasher">
:::info
LoRa config is not available in the Flasher.
:::
</TabItem>
<TabItem value="web">
:::info
LoRa config is not available for in the Web UI.
:::
</TabItem>
</Tabs>

200
docs/settings/config/position.mdx Normal file
View file

@ -0,0 +1,200 @@
---
id: config-position
title: Position Configuration
sidebar_label: Position
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
The positon config options are: GPS Enabled, GPS Update Interval, GPS Attempt Time, Fixed Postion, Smart Broadcast, Broadcast Interval and Position Packet Flags. Position config uses an admin message sending a `Config.Position` protobuf.
Position data from GPS is provided by either the radio or your paired phone. Position data is not required to use Meshtastic but time calculations require at least one device on the mesh have either a gps or internet connection for time.
## Position Config Values
### GPS Enabled
Acceptable values: `true` or `false`
Enabled by default. Should the device GPS be enabled for this node?
### GPS Update Interval
How often should we try to get GPS position (in seconds), or zero for the default of once every 30 seconds, or a very large value (maxint) to update only once at boot.
### GPS Attempt Time
How long should we try to get our position during each GPS update interval attempt? (in seconds) Or if zero, use the default of 30 seconds.
### Fixed Position
Acceptable values: `true` or `false`
Off by default
If set, this node is at a fixed position. The device will generate GPS updates at the regular GPS update interval, but use whatever the last lat/lon/alt it saved for the node. The lat/lon/alt can be set by an internal GPS or with the help of the mobile device's GPS.
### Smart Broadcast
Acceptable values: `true` or `false`
On by default
Smart broadcast will send out your position at an increased frequency only if your location has changed enough for a position update to be useful.
Smart broadcast complements broadcast interval (doesn't override that setting) but will apply an algorithm to more frequently update your mesh network if you are in motion and then throttle it down when you are standing still. If you use this feature, it's best to leave broadcast interval at the default.
Smart broadcast will calculate an ideal position update interval based on the data rate of your selected channel configuration.
### Broadcast Interval
Default of `0` is 15 minutes
If smart broadcast is of we should send our position this often (but only if it has changed significantly)
The GPS updates will be sent out every Broadcast Interval, with either the actual GPS location, or an empty location if no GPS fix was achieved. This defaults to broadcast every 15 minutes.
### Position Flags
Bit field of boolean configuration options for POSITION messages (bitwise OR of PositionFlags)
| Value | Description |
| :-----------: | :---------------------------------------------------------: |
| POS_UNDEFINED | Required for compilation |
| POS_ALTITUDE | Include an altitude value (if available) |
| POS_ALT_MSL | Altitude value is MSL |
| POS_GEO_SEP | Include geoidal separation |
| POS_DOP | Include the DOP value ; PDOP used by default, see below |
| POS_HVDOP | If POS_DOP set, send separate HDOP / VDOP values instead of PDOP |
| POS_SATINVIEW | Include number of "satellites in view" |
| POS_SEQ_NOS | Include a sequence number incremented per packet |
| POS_TIMESTAMP | Include positional timestamp (from GPS solution) |
| POS_HEADING | Include positional heading (from GPS solution) |
| POS_SPEED | Include positional speed (from GPS solution) |
## Position Config Client Availability
<Tabs
groupId="settings"
defaultValue="flasher"
values={[
{label: 'Android', value: 'android'},
{label: 'Apple', value: 'apple'},
{label: 'Command Line', value: 'cli'},
{label: 'Flasher', value: 'flasher'},
{label: 'Web', value: 'web'},
]}>
<TabItem value="android">
:::info
Position config is not available for Android.
:::
</TabItem>
<TabItem value="apple">
:::info
All position config values except for postion flag are available on iOS, iPadOS and macOS at Settings > Radio Configuration > Position.
:::
</TabItem>
<TabItem value="cli">
Select Position config conmmands are available in the python CLI. Example commands are below:
| Setting | Acceptable Values | Default |
| :----------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------: |
| gps_enabled | `true`, `false` | `true` |
| gps_update_interval | `integer` (seconds) | Default `0` is 30 Seconds |
| gps_attempt_time | `integer` (seconds) | Default of `0` is 30 Seconds |
| fixed_position | `true`, `false` | `false` |
| position_broadcast_smart | `true`, `false` | `true` |
| 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` |
```shell title="Set GPS update interval to default settings (every 30 seconds)"
meshtastic --set gps_update_interval 0
```
```shell title="Set GPS update interval to every 45 seconds"
meshtastic --set gps_update_interval 45
```
```shell title="Set GPS attempt time to default (30 seconds)"
meshtastic --set gps_attempt_time 0
```
```shell title="Set GPS attempt time to 45 seconds"
meshtastic --set gps_attempt_time 45
```
```shell title="Set Fixed Position - Current Location"
meshtastic --set fixed_position true
```
:::note
The device will continue to acquire GPS coordinates according to the `gps_update_interval`, but will use the last saved coordinates as its fixed point.
:::
```shell title="Set Fixed Position - User Defined"
meshtastic --setlat 37.8651 --setlon -119.5383
```
```shell title="Unset Fixed Position"
meshtastic --set fixed_position false
```
```shell title="Enable smart position broadcast (default)"
meshtastic --set position_broadcast_smart true
```
```shell title="Disable smart position broadcast"
meshtastic --set position_broadcast_smart false
```
```shell title="Set GPS update interval to default settings (every 15 minutes)"
meshtastic --set position_broadcast_secs 0
```
```shell title="Set GPS update interval to every 60 seconds"
meshtastic --set position_broadcast_secs 60
```
:::note
It may take some time to see that the change has taken effect. The GPS location is updated according to the value specified on `gps_update_interval` and the mesh will be notified of the new position in relation to the `position_broadcast_secs` value.
:::
:::tip
Include each flag desired separated by a single space.
:::
```shell title="Set Position Flags"
meshtastic --pos-fields POS_ALTITUDE POS_ALT_MSL
```
```shell title="Unset Position Flags"
meshtastic --pos-fields POS_UNDEFINED
```
</TabItem>
<TabItem value="flasher">
:::info
Position config is not available in the Flasher.
:::
</TabItem>
<TabItem value="web">
:::info
Position config is not available in the Web UI.
:::
</TabItem>
</Tabs>
:::caution
Altering/disabling the GPS functionality does not mean that you will be unable to be found. Via triangulation of your radio, location may be given up to someone if they are determined enough.
:::

199
docs/settings/config/power.mdx Normal file
View file

@ -0,0 +1,199 @@
---
id: power
title: Power Configuration
sidebar_label: Power
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
The power config options are: Charge Current, Power Saving, Shutdown after losing power, ADC Multiplier Override Wait Bluetooth Interval, Mesh Super Deep Sleep Timeout, Super Deep Sleep Interval, Light Sleep Interval and Minimum Wake Interval. Power config uses an admin message sending a `Config.Power` protobuf.
Power settings are advanced configuration, most users should choose a role under Device Config to manage power for their device.
## Power Config Values
### Charge Current
**Tbeam 1.1 only setting**
Sets the current of the battery charger using the AXP power chip on the Tbeam 1.1
### Power Saving
If set, we are powered from a low-current source (i.e. solar), so even if it looks like we have power flowing in we should try to minimize power consumption as much as possible.
### Shutdown after losing power
Automatically shut down a device after a defined time period if power is lost.
### ADC Multiplier Override
**Fixes issues on Heltec v2**
Ratio of voltage divider for battery pin eg. 3.20 (R1=100k, R2=220k)
Overrides the ADC_MULTIPLIER defined in the firmware device variant file for battery voltage calculation.
Should be set to floating point value between 2 and 4
### Wait Bluetooth Interval
How long wait before turning off BLE in no Bluetooth states
`0` for default of 1 minute
### Mesh Super Deep Sleep Timeout
While in Light Sleep if this value is exceeded we will lower into super deep sleep
or Super Deep Sleep Interval (default 1 year) or a button press
`0` for default of two hours, MAXUINT for disabled
### Super Deep Sleep Interval
While in Light Sleep if Mesh Super Deep Sleep Timeout Seconds is exceeded we will lower into super deep sleep or this value (default 1 year) or a button press
`0` for default of one year
### Light Sleep Interval
**ESP32 Only Setting**
In light sleep the CPU is suspended, LoRa radio is on, BLE is off an GPS is on
`0` for default of five minutes
### Minimum Wake Interval
While in light sleep when we receive packets on the LoRa radio we will wake and handle them and stay awake in no Bluetooth mode for this interval
`0` for default of 10 seconds
## Power Config Client Availability
<Tabs
groupId="settings"
defaultValue="flasher"
values={[
{label: 'Android', value: 'android'},
{label: 'Apple', value: 'apple'},
{label: 'Command Line', value: 'cli'},
{label: 'Flasher', value: 'flasher'},
{label: 'Web', value: 'web'},
]}>
<TabItem value="android">
:::info
Light Sleep Interval and Wait Bluetooth Interval are available under advanced settings for Android.
:::
</TabItem>
<TabItem value="apple">
:::info
Power config is not available on Apple OS's.
:::
</TabItem>
<TabItem value="cli">
All Power config options are available in the python CLI.
| Setting | Acceptable Values | Default |
| :----------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------: |
| charge_current | `MAUnset`, `MA100`, `MA190`, `MA280`, `MA360`, `MA450`, `MA550`, `MA630`, `MA700`, `MA780`, `MA880`, `MA960`, `MA1000`, `MA1080`, `MA1160`, `MA1240`, `MA1320`: | `MAUnset` |
| is_power_saving | `true`, `false` | `false` |
| on_battery_shutdown_after_secs | `integer` (seconds) | Default of `0` is off |
| adc_multiplier_override | `2-4` (floating point value) | Default of `0` uses firmware values |
| wait_bluetooth_secs | `integer` (seconds) | Default of `0` is 1 minute |
| mesh_sds_timeout_secs | `integer` (seconds) | Default of `0` is 2 hours |
| sds_secs | `integer` (seconds) | Default of `0` is 1 year |
| ls_secs | `integer` (seconds) | Default of `0` is 1 hour |
| min_wake_secs | `integer` (seconds) | Default of `0` is 10 seconds |
```shell title="Unset charge current"
meshtastic --set charge_current MAUnset
```
```shell title="Set charge current"
meshtastic --set charge_current MA100
```
```shell title="Enable is_power_saving"
meshtastic --set is_power_saving true
```
```shell title="Disable is_power_saving"
meshtastic --set is_power_saving false
```
```shell title="Disable on_battery_shutdown_after_secs"
meshtastic --set on_battery_shutdown_after_secs 0
```
```shell title="Set device to shutdown after 120 seconds on battery"
meshtastic --set on_battery_shutdown_after_secs 120
```
```shell title="Set wait_bluetooth_secs to default (60 seconds)"
meshtastic --set wait_bluetooth_secs 0
```
```shell title="Set wait_bluetooth_secs to 120 seconds"
meshtastic --set wait_bluetooth_secs 120
```
```shell title="Set mesh_sds_timeout_secs to default (2 hour/7200 seconds)"
meshtastic --set mesh_sds_timeout_secs 0
```
```shell title="Set mesh_sds_timeout_secs to 120 seconds"
meshtastic --set mesh_sds_timeout_secs 120
```
```shell title="Disable mesh_sds_timeout_secs (using MAXUINT)"
meshtastic --set mesh_sds_timeout_secs 4294967295
```
```shell title="Set sds_secs to default (1 year)"
meshtastic --set sds_secs 0
```
```shell title="Set sds_secs to 120 seconds"
meshtastic --set sds_secs 120
```
```shell title="Set ls_secs to default (5 minutes 300 seconds)"
meshtastic --set ls_secs 0
```
```shell title="Set ls_secs to 120 seconds"
meshtastic --set ls_secs 120
```
```shell title="Set min_wake_secs to default (10 seconds)"
meshtastic --set min_wake_secs 0
```
```shell title="Set min_wake_secs to 120 seconds"
meshtastic --set min_wake_secs 120
```
</TabItem>
<TabItem value="flasher">
:::info
Power config is not available in the Flasher.
:::
</TabItem>
<TabItem value="web">
:::info
Power config is not available in the Web UI.
:::
</TabItem>
</Tabs>

341
docs/settings/config/wifi.mdx Normal file
View file

@ -0,0 +1,341 @@
---
id: wifi
title: WiFi Configuration
sidebar_label: WiFi
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
The WiFi config options are: AP Mode, Hidden AP, SSID and Password. WiFi config uses an admin message sending a `Config.WiFi` protobuf.
:::info
Enabling WiFi will disable bluetooth. Only one connection method will work at a time.
:::
ESP32 devices have the ability to connect to WiFi as a client and also are able to create a software based access point (SoftAP). WiFi can be configured in either mode.
:::note
The device can be either a WiFi client or a software access point. It **cannot** operate as both at the same time.
:::
You can [force the device to boot into SoftAP mode](#software-access-point) by rebooting the device with the program switch depressed. If forced into AP mode, it will revert to previous settings after a reboot.
## WiFi Config Values
### Software Access Point (AP)
A boolean value that toggles the [Software Access Point](#software-access-point)
Acceptable values are `true` or `false`
### Hidden Access Point (AP)
A boolean value that toggles the hidden access point
Acceptable values are `true` or `false`
If set, the node AP will broadcast as a hidden SSID
### WiFi SSID
In [SoftAP](#software-access-point) mode, this is the SSID broadcast to access your device's WiFi. In [Client](#wifi-client) mode, this is your WiFi Networks SSID. This string is case sensitive.
### WiFi Password
In [SoftAP](#software-access-point) mode, this is the password to access your device's WiFi. In [Client](#wifi-client) mode, this is your WiFi Networks password. This string is case sensitive.
:::tip
The first time your device restarts after enabling the WiFi access point, it will take an additional 20-30 seconds to boot. This is to generate self-signed SSL keys. The keys will be saved for future reuse.
:::
## WiFi Config Client Availability
<Tabs
groupId="settings"
defaultValue="flasher"
values={[
{label: 'Android', value: 'android'},
{label: 'Apple', value: 'apple'},
{label: 'Command Line', value: 'cli'},
{label: 'Flasher', value: 'flasher'},
{label: 'Web', value: 'web'},
]}>
<TabItem value="android">
:::info
WiFi config is not available for Android.
:::
</TabItem>
<TabItem value="apple">
:::info
WiFi config is not available on Apple OS's.
:::
</TabItem>
<TabItem value="cli">
All WiFi config options are available in the python CLI.
| Setting | Acceptable Values | Default |
| :-----------: | :---------------: | :-----: |
| wifi_ap_mode | `true`, `false` | `false` |
| wifi_ap_hidden | `true`, `false` | `false` |
| wifi_password | string | `""` |
| wifi_ssid | string | `""` |
```shell title="Enable SoftAP"
meshtastic --set wifi_ap_mode true
```
```shell title="Disable SoftAP"
meshtastic --set wifi_ap_mode false
```
```shell title="Make Access Point Hidden"
meshtastic --set wifi_ap_hidden false
```
```shell title="Set WiFi network"
meshtastic --set wifi_ssid mynetwork
```
```shell title="Set WiFi network (with spaces)"
meshtastic --set wifi_ssid "my network"
```
```shell title="Set WiFi password"
meshtastic --set wifi_password mypassword
```
```shell title="Set WiFi password (with spaces)"
meshtastic --set wifi_password "my password"
```
</TabItem>
<TabItem value="flasher">
:::info
Available in the flasher.
:::
</TabItem>
<TabItem value="web">
:::info
Available in the web ui.
:::
</TabItem>
</Tabs>
## Details
### Software Access Point
With the SoftAP enabled, a DNS server will run on the device. The DNS server will respond to all DNS requests with the IP address of your device. This will simplify device discovery because you will not have to remember the device's IP – any unencrypted HTTP request will direct you to the right location.
If you set your SoftAP up using a client like the CLI and have a screen attached to your device, the final page will display something similar to the following:
```
WiFi: Software AP
IP: 192.168.42.1 (0/4)
SSID: myNetwork / PWD: myPassword (alternating)
http://meshtastic.local
* * * * *
```
You should then be able to connect to the node using either the displayed IP address or the HTTP link.
#### Force SoftAP
You can also enable the SoftAP by following these directions:
- Hold down the user button
- Press and release the reset button
- Count to two
- Let go of the user button
This will reboot the device with the SSID set to `meshtasticAdmin` and the password set to `12345678`. Using the Force SoftAP method, once you reboot, the SoftAP will be turned off.
If you have a screen attached to your device, the final page will display something similar to the following:
```
WiFi: Software AP (Admin)
IP: 192.168.42.1 (0/4)
SSID: meshtasticAdmin / PWD: 12345678 (alternating)
http://meshtastic.local
* * * * *
```
You should then be able to connect to the node using either the displayed IP address or the HTTP link.
### WiFi Client
With `wifi_ssid` & `wifi_password` populated, the device will now to connect to your network. Make sure you are in range of your WiFi. If you have a single device on your local network it's easy to connect to your device `http://meshtastic.local`. If you have multiple devices you will need to connect using their respective IP addresses.
If you have a screen attached to your device, the final page will display something similar to the following:
```
WiFi: Software AP (Admin)
IP: 192.168.42.1 (0/4)
SSID: myNetwork
http://meshtastic.local
* * * * *
```
You should then be able to connect to the node using either the displayed IP address or the HTTP link.
### Disable WiFi
To disable WiFi completely, set `wifi_ap_mode` to `false`, and both `wifi_ssid` & `wifi_password` to an empty string `""`.
## Examples
### Enable WiFi (as client)
<Tabs
groupId="settings"
defaultValue="cli"
values={[
{label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'},
{label: 'iOS', value: 'iOS'},
{label: 'Web', value: 'web'},
]}>
<TabItem value="cli">
```shell title="Enabling WiFi Client"
meshtastic --set wifi_ap_mode false --set wifi_ssid mywifissid --set wifi_password mywifipassword
```
:::note
If your `wifi_ssid` or `wifi_password` contain spaces, be sure to put quotation marks around the whole thing:
```shell title="Example with spaces"
meshtastic --set wifi_ssid "my wifi ssid" --set wifi_password "my wifi password"
```
:::
</TabItem>
<TabItem value="android">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="iOS">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="web">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
</Tabs>
In the above example, the device will join a network with the SSID `mywifissid` and the password `mywifipassword`.
### Enable WiFi (as SoftAP)
<Tabs
groupId="settings"
defaultValue="cli"
values={[
{label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'},
{label: 'iOS', value: 'iOS'},
{label: 'Web', value: 'web'},
]}>
<TabItem value="cli">
```shell title="Software Access Point Example"
meshtastic --set wifi_ap_mode true --set wifi_ssid mywifissid --set wifi_password mywifipassword
```
:::note
If your `wifi_ssid` or `wifi_password` contain spaces, be sure to put quotation marks around the whole thing:
```shell title="Example with spaces"
meshtastic --set wifi_ssid "my wifi ssid" --set wifi_password "my wifi password"
```
:::
</TabItem>
<TabItem value="android">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="iOS">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="web">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
</Tabs>
In the above example, the device will broadcast a network with the SSID `mywifissid` and the password `mywifipassword`.
### Disable WiFi Completely
<Tabs
groupId="settings"
defaultValue="cli"
values={[
{label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'},
{label: 'iOS', value: 'iOS'},
{label: 'Web', value: 'web'},
]}>
<TabItem value="cli">
```shell title="Example - Disabling WiFi"
meshtastic --set wifi_ap_mode false --set wifi_ssid "" --set wifi_password ""
```
</TabItem>
<TabItem value="android">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="iOS">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="web">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
</Tabs>

4
docs/settings/gps.mdx
View file

@ -1,7 +1,7 @@
---
id: gps
title: GPS Settings
sidebar_label: GPS
title: 1.2 GPS Settings
sidebar_label: 1.2 GPS
---
import Tabs from '@theme/Tabs';

75
docs/settings/index.mdx
View file

@ -1,6 +1,6 @@
---
title: Device Settings
sidebar_label: Device Settings
title: Radio Configuration
sidebar_label: Radio Configuration
slug: /settings
sidebar_position: 5
---
@ -8,73 +8,16 @@ sidebar_position: 5
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Customization of your settings is vital to configuring your own mesh. Changing settings is currently most reliably done using the command line interface available within `Meshtastic-python`. Setting support is being added to all other methods of interfacing with your device.
Configuration for Meshtastic devices has been completely overhauled in version 1.3.
## Settings
In order to facilitate a more stable admin channel for remote management of nodes we have broken our large monolithic config structure into six sections that can be saved individually, protecting our precious mesh bandwidth.
Below are some of the most common settings that a new user will want to become acquainted with, but it isn't an exhaustive list. Make sure to take a look at the sidebar for additional settings. If you find something missing or incorrect, please help us improve our docs by filing an issue, creating a pull request, or mentioning it in our forum.
Default settings values are prefered whenever possible as they consume no bandwidth when sent over the mesh.
### Channel Settings
## Config Sections
Channel settings are very important, if channels are misconfigured between devices they won't be able to communicate! A freshly flashed device will use the default channel settings. Depending on your use case you may want to change your encryption using `psk`, your range of communication by setting one of the four pre-set bands using `modem_config`, or even just the name of your channel! Before you begin, don't forget to set your `region` correctly! Take a look at the [basic channel configuration](settings/channel) and if you're tech savvy or a radio head check out the [advanced channel settings](settings/channel-advanced).
Meshtastic config is now broken into 6 sections. [Device](/docs/settings/config/device), [Display](/docs/config/display), [LoRa](/docs/config/lora), [Position](/docs/config/position), [Power](/docs/config/power) and [WiFi](/docs/config/wifi)
:::note
It is very important that you set your device's `region` setting. This will ensure that you are operating within the legal limits for your area.
:::
## Module Config
### GPS Settings
For most, GPS is a really cool, desirable feature. Knowing where everyone on your local mesh is has some major advantages. However, it's possible you want to hide the location of a particular device (like a router mounted on your home). All of the settings related to GPS are located [here](settings/gps).
### WiFi Settings
Whether you're using the upcoming [web interface](software/web) or you're interested in broadcasting messages to/from the internet using [MQTT](settings/mqtt), the [WiFi settings](settings/wifi) are your first stop towards an IoT radio.
## Examples
At the bottom of each setting page, examples will be available displaying how to adjust settings using the various platforms available to interface with your device. The examples will look like this:
### Introducing Examples
<Tabs
groupId="settings"
defaultValue="cli"
values={[
{label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'},
{label: 'iOS', value: 'iOS'},
{label: 'Web', value: 'web'},
]}>
<TabItem value="cli">
:::note
The CLI examples will require you to utilize the Command line Interface that is available through Meshtastic-python. Installation instructions can be found [here](software/python/python-installation).
:::
```shell title="Example - Set Region (an important first step!)"
meshtastic --set region Unset
```
</TabItem>
<TabItem value="android">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="iOS">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="web">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
</Tabs>
Meshtastic includes the following modules: Canned Messages, External Notification, Range Test, Serial, Store & Forward and Telemetry (sensors).

4
docs/settings/misc.mdx
View file

@ -1,7 +1,7 @@
---
id: misc
title: Miscellaneous Settings
sidebar_label: Miscellaneous
title: 1.2 Miscellaneous Settings
sidebar_label: 1.2 Miscellaneous
---
import Tabs from '@theme/Tabs';

4
docs/settings/modules/index.mdx
View file

@ -1,7 +1,7 @@
---
id: modules
title: Firmware Modules Overview
sidebar_label: Firmware Modules
title: Module Config Overview
sidebar_label: Module Config
---
import ModuleOverviewText from '@site/docs/_blocks/_module_overview_text.mdx';

4
docs/settings/mqtt.mdx
View file

@ -1,7 +1,7 @@
---
id: mqtt
title: MQTT Settings
sidebar_label: MQTT
title: 1.2 MQTT Settings
sidebar_label: 1.2 MQTT
---
import Tabs from '@theme/Tabs';

4
docs/settings/power.mdx
View file

@ -1,7 +1,7 @@
---
id: power
title: Power Settings
sidebar_label: Power
title: 1.2 Power Settings
sidebar_label: 1.2 Power
---
import Tabs from '@theme/Tabs';

4
docs/settings/router.mdx
View file

@ -1,7 +1,7 @@
---
id: router
title: Router Settings
sidebar_label: Router
title: 1.2 Router Settings
sidebar_label: 1.2 Router
---
import Tabs from '@theme/Tabs';

6
docs/settings/wifi.mdx
View file

@ -1,7 +1,7 @@
---
id: wifi
title: WiFi Settings
sidebar_label: WiFi
title: 1.2 WiFi Settings
sidebar_label: 1.2 WiFi
---
import Tabs from '@theme/Tabs';
@ -19,7 +19,7 @@ The ESP32 based devices have the ability to connect to WiFi as a client and also
The device can be either a WiFi client or a software access point. It **cannot** operate as both at the same time.
:::
:::info
:::tip
The first time your device restarts after enabling the WiFi access point, it will take an additional 20-30 seconds to boot. This is to generate self-signed SSL keys. The keys will be saved for future reuse.
:::