From 9b5bea347c85e8f0f50a30fa7e9f56b121eaea6c Mon Sep 17 00:00:00 2001 From: Lennart Buhl Date: Wed, 5 Oct 2022 15:10:46 +0200 Subject: [PATCH 1/3] Correct some device settings doc issues --- docs/settings/config/bluetooth.mdx | 18 ++++++++++++------ docs/settings/config/index.mdx | 5 +++-- docs/settings/index.mdx | 24 +++++++++++++++++++----- docs/software/web/index.mdx | 2 +- 4 files changed, 35 insertions(+), 14 deletions(-) diff --git a/docs/settings/config/bluetooth.mdx b/docs/settings/config/bluetooth.mdx index 2d3d03b3..d2136f29 100644 --- a/docs/settings/config/bluetooth.mdx +++ b/docs/settings/config/bluetooth.mdx @@ -17,6 +17,12 @@ Enables bluetooth ### Pairing Mode +Specify pairing mode. + +`RANDOM_PIN` generates a random PIN during runtime. +`FIXED_PIN` uses the fixed PIN that should then be additionally specified. +Finally, `NO_PIN` disables PIN authentication. + ### Fixed PIN If your pairing mode is set to fixed PIN this is the value of that fixed 6 digit pin. Default value is 123456 @@ -53,9 +59,9 @@ All bluetooth module config options are available in the python CLI. Example com | Setting | Acceptable Values | Default | | :-----------------------: | :-----------------: | :-----: | -| bluetooth.enabled | `true`, `false` | `true` | -| bluetooth.mode | `RANDOM_PIN`, `FIXED_PIN`, `NO_PIN` | `RANDOM_PIN` | -| bluetooth.fixedPin | `integer` 6 Digits | `123456` | +| `bluetooth.enabled` | `true`, `false` | `true` | +| `bluetooth.mode` | `RANDOM_PIN`, `FIXED_PIN`, `NO_PIN` | `RANDOM_PIN` | +| `bluetooth.fixedPin` | `integer` (6 digits) | `123456` | ```shell title="Enable/Disable Bluetooth Module" meshtastic --set bluetooth.enabled true @@ -70,8 +76,8 @@ meshtastic --set bluetooth.fixed_pin 111111 :::info -All bluettoth module config options are available for the Web UI. +All bluetooth module config options are available for the Web UI. ::: - + - \ No newline at end of file + diff --git a/docs/settings/config/index.mdx b/docs/settings/config/index.mdx index c258dba6..0581fe12 100644 --- a/docs/settings/config/index.mdx +++ b/docs/settings/config/index.mdx @@ -5,16 +5,17 @@ sidebar_label: Config Sections sidebar_position: 1 --- -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. +There are several 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 | |:----:|:-----------:| +| [Bluetooth](bluetooth) | Bluetooth config options are: Enabled, Pairing Mode and Fixed PIN. | | [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, 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. | +| [Network](network) | Network config options are: Wifi Enabled, WiFi SSID, Wifi PSK, WiFi Mode and NTP Server. | | [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: Long Name, Short Name, and Is Licensed | -| [Network](network) | Network config options are: Wifi Enabled, WiFi SSID, Wifi PSK, WiFi Mode and NTP Server. | diff --git a/docs/settings/index.mdx b/docs/settings/index.mdx index 271be281..db96189b 100644 --- a/docs/settings/index.mdx +++ b/docs/settings/index.mdx @@ -8,16 +8,30 @@ sidebar_position: 5 import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Configuration for Meshtastic devices has been completely overhauled in version 1.3. +Configuration for Meshtastic devices has been completely overhauled in version 1.3. 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. Default settings values are prefered whenever possible as they consume no bandwidth when sent over the mesh. -## Config Sections +## [Config Sections](settings/config) -Meshtastic config is now broken into 6 sections. [Device](settings/config/device), [Display](settings/config/display), [LoRa](settings/config/lora), [Position](settings/config/position), [Power](settings/config/power), [User](settings/config/user) and [Network](settings/config/network). +Meshtastic config is broken into several sections: +[Bluetooth](settings/config/bluetooth), +[Device](settings/config/device), +[Display](settings/config/display), +[LoRa](settings/config/lora), +[Network](settings/config/network), +[Position](settings/config/position), +[Power](settings/config/power) and +[User](settings/config/user). -## Module Config +## [Module Config](settings/moduleconfig) -Meshtastic includes the following modules: [Canned Messages](settings/moduleconfig/canned-message), [External Notification](settings/moduleconfig/external-notification), [Range Test](settings/moduleconfig/range-test), [Serial](settings/moduleconfig/serial), and [Telemetry (sensors)](settings/moduleconfig/telemetry). \ No newline at end of file +Meshtastic includes the following modules: +[Canned Messages](settings/moduleconfig/canned-message), +[External Notification](settings/moduleconfig/external-notification), +[MQTT](settings/moduleconfig/mqtt), +[Range Test](settings/moduleconfig/range-test), +[Serial](settings/moduleconfig/serial), and +[Telemetry (sensors)](settings/moduleconfig/telemetry). diff --git a/docs/software/web/index.mdx b/docs/software/web/index.mdx index e77feda8..ca59a912 100644 --- a/docs/software/web/index.mdx +++ b/docs/software/web/index.mdx @@ -16,7 +16,7 @@ There are three ways of accessing the app: ## Compatibility -The application will work in all major browsers, but specific functionality is limited in some cases, for the best experience we reccomend using [Google Chrome](https://www.google.com/chrome) +The application will work in all major browsers, but specific functionality is limited in some cases, for the best experience we recommend using [Google Chrome](https://www.google.com/chrome). ### HTTP From bd18278c55baeb3876a4f37accf5ca01757a4ae5 Mon Sep 17 00:00:00 2001 From: Lennart Buhl Date: Wed, 5 Oct 2022 15:25:07 +0200 Subject: [PATCH 2/3] Fix several typos: --- docs/hardware/supported/lora.mdx | 4 ++-- docs/settings/config/device.mdx | 4 ++-- docs/settings/config/index.mdx | 6 +++--- docs/settings/config/lora.mdx | 12 ++++++------ docs/settings/config/network.mdx | 2 +- docs/settings/config/position.mdx | 6 +++--- docs/settings/config/power.mdx | 2 +- 7 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/hardware/supported/lora.mdx b/docs/hardware/supported/lora.mdx index 33e55727..43cf2058 100644 --- a/docs/hardware/supported/lora.mdx +++ b/docs/hardware/supported/lora.mdx @@ -7,7 +7,7 @@ sidebar_position: 2 import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -LILYGO® Lora23 v1-2.1 * Versions other than 2.1 not reccomended with a battery +LILYGO® Lora23 v1-2.1 * Versions other than 2.1 not recommended with a battery -Further information on the LILYGO® LoRa and T-beam devices can be found on LILYGO®'s [GitHub page](https://github.com/Xinyuan-LilyGO/LilyGo-LoRa-Series). \ No newline at end of file +Further information on the LILYGO® LoRa and T-beam devices can be found on LILYGO®'s [GitHub page](https://github.com/Xinyuan-LilyGO/LilyGo-LoRa-Series). diff --git a/docs/settings/config/device.mdx b/docs/settings/config/device.mdx index 89656957..cdb63e9c 100644 --- a/docs/settings/config/device.mdx +++ b/docs/settings/config/device.mdx @@ -20,14 +20,14 @@ Acceptable values: | :-------: | :---------------------------------------------------------------------------------------: | | `CLIENT` | Client (default) - App connected client. | | `CLIENT_MUTE` | Client Mute - Same as a client except packets will not hop over this node, does not contribute to routing packets for mesh. | -| `ROUTER` | Router - Mesh packets will prefer to be routed over this node. This node will not be used by client apps. The wifi/ble radios and the oled screen will be put to sleep. | +| `ROUTER` | Router - Mesh packets will prefer to be routed over this node. This node will not be used by client apps. The WiFi/BLE radios and the OLED screen will be put to sleep. | | `ROUTER_CLIENT` | Router Client - Mesh packets will prefer to be routed over this node. The Router Client can be used as both a Router and an app connected Client. | ### Serial Console Acceptable values: `true` or `false` -Disabling this will disable the SerialConsole by not initilizing the StreamAPI +Disabling this will disable the SerialConsole by not initializing the StreamAPI ### Debug Log Acceptable values: `true` or `false` diff --git a/docs/settings/config/index.mdx b/docs/settings/config/index.mdx index 0581fe12..6263f29c 100644 --- a/docs/settings/config/index.mdx +++ b/docs/settings/config/index.mdx @@ -7,7 +7,7 @@ sidebar_position: 1 There are several 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. +Default settings values are preferred whenever possible as they consume no bandwidth when sent over the mesh. | Name | Description | |:----:|:-----------:| @@ -15,7 +15,7 @@ Default settings values are prefered whenever possible as they consume no bandwi | [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, 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. | -| [Network](network) | Network config options are: Wifi Enabled, WiFi SSID, Wifi PSK, WiFi Mode and NTP Server. | -| [Position](position) | Positon config options are: GPS Enabled, GPS Update Interval, GPS Attempt Time, Fixed Postion, Smart Broadcast, Broadcast Interval and Position Packet Flags. | +| [Network](network) | Network config options are: WiFi Enabled, WiFi SSID, WiFi PSK, WiFi Mode and NTP Server. | +| [Position](position) | Position config options are: GPS Enabled, GPS Update Interval, GPS Attempt Time, Fixed Position, 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: Long Name, Short Name, and Is Licensed | diff --git a/docs/settings/config/lora.mdx b/docs/settings/config/lora.mdx index 5d596aa4..d74e1837 100644 --- a/docs/settings/config/lora.mdx +++ b/docs/settings/config/lora.mdx @@ -22,8 +22,8 @@ Sets the region for your node. Default is `unset`. | :-------: | :---------------------------------------------------------------------------------------: | | `unset` | Unset | | `us` | United States | -| `eu433` | European Union 433mhz | -| `eu868` | European Union 868mhz | +| `eu433` | European Union 433MHz | +| `eu868` | European Union 868MHz | | `cn` | China | | `jp` | Japan | | `anz` | Australia & New Zealand | @@ -31,7 +31,7 @@ Sets the region for your node. Default is `unset`. | `tw` | Taiwan | | `ru` | Russia | | `in` | India | -| `nz865` | New Zealand 865mhz | +| `nz865` | New Zealand 865MHz | | `th` | Thailand | @@ -41,7 +41,7 @@ Sets the region for your node. Default is `unset`. ### Transmit Power -If zero then, use default max legal continuous power (ie. something that won't burn out the radio hardware) +If zero then, use default max legal continuous power (i.e. something that won't burn out the radio hardware) In most cases you should use zero here. Units are in dBm. @@ -73,7 +73,7 @@ Defaults to false ### Ignore Incoming Array -For testing it is useful sometimes to force a node to never listen to particular other nodes (simulating radio out of range). All nodenums listed in the ignore_incoming array will have packets they send droped on receive (by router.cpp) +For testing it is useful sometimes to force a node to never listen to particular other nodes (simulating radio out of range). All nodenums listed in the ignore_incoming array will have packets they send dropped on receive (by router.cpp) ## LoRa Config Client Availability @@ -103,7 +103,7 @@ Configuration of Region, Modem Preset and Hop Limit is available on iOS, iPadOS -LoRa config conmmands are available in the python CLI. Example commands are below: +LoRa config commands are available in the python CLI. Example commands are below: | Setting | Acceptable Values | Default | | :----------: | :---------------------------------------------------------------------------: | :---------------: | diff --git a/docs/settings/config/network.mdx b/docs/settings/config/network.mdx index 244518f1..daee2de8 100644 --- a/docs/settings/config/network.mdx +++ b/docs/settings/config/network.mdx @@ -26,7 +26,7 @@ The NTP server used if IP networking is available. Set to `0.pool.ntp.org` by default. (Max Length: 33) -### Wifi Enabled +### WiFi Enabled Enables or Disables WiFi. diff --git a/docs/settings/config/position.mdx b/docs/settings/config/position.mdx index cef53197..f060714e 100644 --- a/docs/settings/config/position.mdx +++ b/docs/settings/config/position.mdx @@ -7,9 +7,9 @@ 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. +The position config options are: GPS Enabled, GPS Update Interval, GPS Attempt Time, Fixed Position, 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 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 @@ -101,7 +101,7 @@ All position config values are available on iOS, iPadOS and macOS at Settings > -All Position config conmmands are available in the python CLI. Example commands are below: +All Position config commands are available in the python CLI. Example commands are below: | Setting | Acceptable Values | Default | | :----------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------: | diff --git a/docs/settings/config/power.mdx b/docs/settings/config/power.mdx index c8473e7e..cba3a6c1 100644 --- a/docs/settings/config/power.mdx +++ b/docs/settings/config/power.mdx @@ -30,7 +30,7 @@ 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) +Ratio of voltage divider for battery pin e.g. 3.20 (R1=100k, R2=220k) Overrides the ADC_MULTIPLIER defined in the firmware device variant file for battery voltage calculation. From 23ff3e0e01a7330fb52a7d09d5e60c92d5717ae3 Mon Sep 17 00:00:00 2001 From: Lennart Buhl Date: Thu, 6 Oct 2022 15:24:16 +0200 Subject: [PATCH 3/3] remove superfluous line --- docs/settings/config/index.mdx | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/settings/config/index.mdx b/docs/settings/config/index.mdx index 6263f29c..fe051eee 100644 --- a/docs/settings/config/index.mdx +++ b/docs/settings/config/index.mdx @@ -7,8 +7,6 @@ sidebar_position: 1 There are several 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 preferred whenever possible as they consume no bandwidth when sent over the mesh. - | Name | Description | |:----:|:-----------:| | [Bluetooth](bluetooth) | Bluetooth config options are: Enabled, Pairing Mode and Fixed PIN. |