From fccdfd6199df613492599d632f0464cc0c5d3b4f Mon Sep 17 00:00:00 2001 From: Garth Vander Houwen Date: Wed, 26 Oct 2022 07:52:20 -0700 Subject: [PATCH 1/2] Explicit links to prevent 404 --- docs/settings/config/index.mdx | 18 +++++++++--------- docs/settings/moduleconfig/index.mdx | 16 ++++++---------- 2 files changed, 15 insertions(+), 19 deletions(-) diff --git a/docs/settings/config/index.mdx b/docs/settings/config/index.mdx index 07a176f7..f8bdf015 100644 --- a/docs/settings/config/index.mdx +++ b/docs/settings/config/index.mdx @@ -9,12 +9,12 @@ There are several config sections in the Meshtastic firmware, these are broken o | Name | Description | |:----:|:-----------:| -| [Bluetooth](bluetooth) | Bluetooth config options are: Enabled, Pairing Mode and Fixed PIN. | -| [Channels](channels) | Channels config options are: Index, Role and Settings. | -| [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) | 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 | +| [Bluetooth](docs/settings/config/bluetooth) | Bluetooth config options are: Enabled, Pairing Mode and Fixed PIN. | +| [Channels](docs/settings/config/channels) | Channels config options are: Index, Role and Settings. | +| [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, Always Point North, and GPS Format. | +| [LoRa](docs/settings/config/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](docs/settings/config/network) | Network config options are: WiFi Enabled, WiFi SSID, WiFi PSK, WiFi Mode and NTP Server. | +| [Position](docs/settings/config/position) | Position config options are: GPS Enabled, GPS Update Interval, GPS Attempt Time, Fixed Position, 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. | +| [User](docs/settings/config/user) | The user config options are: Long Name, Short Name, and Is Licensed | \ No newline at end of file diff --git a/docs/settings/moduleconfig/index.mdx b/docs/settings/moduleconfig/index.mdx index 7eea7552..032484cf 100644 --- a/docs/settings/moduleconfig/index.mdx +++ b/docs/settings/moduleconfig/index.mdx @@ -9,13 +9,9 @@ Modules are included in the firmware and allow users to extend the functionality | Name | Description | |:----:|:-----------:| -| [Canned Message](canned-message) | Set a number of predefined messages to send out directly from the device with the use of an input device like a rotary encoder. | -| [External Notification](external-notification) | Incoming messages are able to alert you using circuits you attach to the device (LEDs, Buzzers, etc) | -| [MQTT](mqtt) | Forward packets along to an MQTT server. This allows users on the local mesh to communicate with users on another mesh over the internet. | -| [Range Test](range-test) | Send messages with GPS location at an interval to test the distance your devices can communicate. Requires (at least) one device set up as a sender and one as a receiver. The receiver(s) will log all incoming messages to a CSV. | -| [Serial Module](serial) | Send messages across the mesh by sending strings over a serial port. | -| [Telemetry](telemetry) | Attach sensors to the device and transmit readings on a regular interval to the mesh. | - -:::tip -Once module settings are changed, a **reset** is required for them to take effect. -::: +| [Canned Message](docs/settings/config/canned-message) | Set a number of predefined messages to send out directly from the device with the use of an input device like a rotary encoder. | +| [External Notification](docs/settings/config/external-notification) | Incoming messages are able to alert you using circuits you attach to the device (LEDs, Buzzers, etc) | +| [MQTT](docs/settings/config/mqtt) | Forward packets along to an MQTT server. This allows users on the local mesh to communicate with users on another mesh over the internet. | +| [Range Test](docs/settings/config/range-test) | Send messages with GPS location at an interval to test the distance your devices can communicate. Requires (at least) one device set up as a sender and one as a receiver. The receiver(s) will log all incoming messages to a CSV. | +| [Serial Module](docs/settings/config/serial) | Send messages across the mesh by sending strings over a serial port. | +| [Telemetry](docs/settings/config/telemetry) | Attach sensors to the device and transmit readings on a regular interval to the mesh. | From ca47fcf67e617867344ebe3cff7c4b28b85e8fc5 Mon Sep 17 00:00:00 2001 From: Garth Vander Houwen Date: Wed, 26 Oct 2022 08:01:04 -0700 Subject: [PATCH 2/2] add moduleconfig --- docs/settings/moduleconfig/index.mdx | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/settings/moduleconfig/index.mdx b/docs/settings/moduleconfig/index.mdx index 032484cf..71570314 100644 --- a/docs/settings/moduleconfig/index.mdx +++ b/docs/settings/moduleconfig/index.mdx @@ -9,9 +9,9 @@ Modules are included in the firmware and allow users to extend the functionality | Name | Description | |:----:|:-----------:| -| [Canned Message](docs/settings/config/canned-message) | Set a number of predefined messages to send out directly from the device with the use of an input device like a rotary encoder. | -| [External Notification](docs/settings/config/external-notification) | Incoming messages are able to alert you using circuits you attach to the device (LEDs, Buzzers, etc) | -| [MQTT](docs/settings/config/mqtt) | Forward packets along to an MQTT server. This allows users on the local mesh to communicate with users on another mesh over the internet. | -| [Range Test](docs/settings/config/range-test) | Send messages with GPS location at an interval to test the distance your devices can communicate. Requires (at least) one device set up as a sender and one as a receiver. The receiver(s) will log all incoming messages to a CSV. | -| [Serial Module](docs/settings/config/serial) | Send messages across the mesh by sending strings over a serial port. | -| [Telemetry](docs/settings/config/telemetry) | Attach sensors to the device and transmit readings on a regular interval to the mesh. | +| [Canned Message](docs/settings/moduleconfig/canned-message) | Set a number of predefined messages to send out directly from the device with the use of an input device like a rotary encoder. | +| [External Notification](docs/settings/moduleconfig/external-notification) | Incoming messages are able to alert you using circuits you attach to the device (LEDs, Buzzers, etc) | +| [MQTT](docs/settings/moduleconfig/mqtt) | Forward packets along to an MQTT server. This allows users on the local mesh to communicate with users on another mesh over the internet. | +| [Range Test](docs/settings/moduleconfig/range-test) | Send messages with GPS location at an interval to test the distance your devices can communicate. Requires (at least) one device set up as a sender and one as a receiver. The receiver(s) will log all incoming messages to a CSV. | +| [Serial Module](docs/settings/moduleconfig/serial) | Send messages across the mesh by sending strings over a serial port. | +| [Telemetry](docs/settings/moduleconfig/telemetry) | Attach sensors to the device and transmit readings on a regular interval to the mesh. |