From a1210afc34ec7a40d3065880b0b1be962b933f05 Mon Sep 17 00:00:00 2001 From: Garth Vander Houwen Date: Thu, 18 Aug 2022 07:34:39 -0700 Subject: [PATCH] 1.3 Config updates --- docs/settings/config/index.mdx | 4 ++-- docs/settings/config/lora.mdx | 2 +- docs/settings/config/wifi.mdx | 5 ++--- 3 files changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/settings/config/index.mdx b/docs/settings/config/index.mdx index 716cb661..92139d2d 100644 --- a/docs/settings/config/index.mdx +++ b/docs/settings/config/index.mdx @@ -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. | diff --git a/docs/settings/config/lora.mdx b/docs/settings/config/lora.mdx index 7d087c2e..bf3e8c17 100644 --- a/docs/settings/config/lora.mdx +++ b/docs/settings/config/lora.mdx @@ -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 diff --git a/docs/settings/config/wifi.mdx b/docs/settings/config/wifi.mdx index de87926a..9583c7a1 100644 --- a/docs/settings/config/wifi.mdx +++ b/docs/settings/config/wifi.mdx @@ -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` |