mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-12-27 14:39:54 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #389 from meshtastic/updated_device_confi

Browse source 
1.3 Config updates
This commit is contained in:
Garth Vander Houwen 2022-08-18 07:37:46 -07:00 committed by GitHub
parent 8fe8ea30f7 a1210afc34
commit dbc10977d1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 5 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -12,9 +12,9 @@ Default settings values are prefered whenever possible as they consume no bandwi
| Name | Description |
|:----:|:-----------:|
| [Device](device) | Device config options are: Device Role, Serial Output, Debug Log and Factory Reset. |
| [Display](display) | Display config options are: Screen On Duration, Auto Carousel Interval, and GPS Format. |
| [Display](display) | Display config options are: Screen On Duration, Auto Carousel Interval, Always Point North, and GPS Format. |
| [LoRa](lora) | The LoRa config options are: Region, Modem Preset, Max Hops, Transmit Power, Bandwidth, Spread Factor, Coding Rate, Frequency Offset, Transmit Disabled and Ignore Incoming Array. |
| [Position](position) | Positon config options are: GPS Enabled, GPS Update Interval, GPS Attempt Time, Fixed Postion, Smart Broadcast, Broadcast Interval and Position Packet Flags. |
| [Power](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. |
| [User](user) | The user config options are: Short Name, Long Name, Licensed Operator, Transmit Power at Antenna Connector, Antenna Gain and Antenna Azimuth. |
| [WiFi](wifi) | WiFi config options are: AP Mode, Hidden AP, SSID and Password. |
| [WiFi](wifi) | WiFi config options are: Enabled, SSID, PSK and WiFi Mode. |

2
docs/settings/config/lora.mdx
View file

@ -12,7 +12,7 @@ The LoRa config options are: Region, Modem Preset, Max Hops, Transmit Power, Ban
## 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.
You must set your device's `lora.region` setting. This will ensure that you are operating within the legal limits for your area.
:::
### Region

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

@ -7,7 +7,7 @@ sidebar_label: WiFi
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
The WiFi config options are: Enabled, SSID, Password and WiFi Mode. WiFi config uses an admin message sending a `Config.WiFi` protobuf.
The WiFi config options are: Enabled, SSID, PSK and WiFi Mode. 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.
@ -27,7 +27,7 @@ Enables WiFi.
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
### WiFi PSK
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.
@ -79,7 +79,6 @@ No WiFi config options are available in the python CLI.
| Setting | Acceptable Values | Default |
| :-----------: | :---------------: | :-----: |
| wifi.enabled | `true`, `false` | `false` |
| wifi.psk | string | `""` |
| wifi.ssid | string | `""` |
| wifi.mode | `client`, `accessPoint`, `accessPointHidden` | `client` |