From 7a8654934a177ac1a3a1b72b3f2b056d2c02beea Mon Sep 17 00:00:00 2001 From: "thomas.ekstrand" Date: Fri, 1 Mar 2024 17:47:41 -0600 Subject: [PATCH 1/4] Increase clarity around Power Saving and ROUTER --- docs/configuration/radio/device.mdx | 28 +++++++++++++++------------- docs/configuration/radio/power.mdx | 8 +++++++- 2 files changed, 22 insertions(+), 14 deletions(-) diff --git a/docs/configuration/radio/device.mdx b/docs/configuration/radio/device.mdx index 5ba782b0..c9fd035e 100644 --- a/docs/configuration/radio/device.mdx +++ b/docs/configuration/radio/device.mdx @@ -30,20 +30,22 @@ The device config options are: Role, Serial Output, and Debug Log. Device config This table shows the **default** values after selecting a preset. As always, individual settings can be adjusted after choosing a preset. -| Device Role | Bluetooth/Wi-Fi Enabled | Screen Enabled | Power Consumption | Retransmit | Prioritized Routing | Visible in Nodes List | -| -------------- | ----------------------- | -------------- | ----------------- | ---------- | ------------------- | --------------------- | -| CLIENT | Yes | Yes | Regular | Yes | No | Yes | -| CLIENT_MUTE | Yes | Yes | Lowest | No | No | Yes | -| CLIENT_HIDDEN | Yes | Yes | Lowest | Local only | No | No | -| TRACKER | Yes | No | Regular | No | No | Yes | -| LOST_AND_FOUND | Yes | No | Regular | No | No | Yes | -| SENSOR | Yes | No | High | No | No | Yes | -| TAK | Yes | Optional | Regular | Yes | No | Yes | -| TAK_TRACKER | Yes | Optional | Regular | Yes | No | Yes | -| ROUTER | No | No | High | Yes | Yes | Yes | -| ROUTER_CLIENT | Yes | Yes | Highest | Yes | Yes | Yes | -| REPEATER | Yes | No | High | Yes | Yes | No | +| Device Role | BLE/WiFi/Serial | Screen Enabled | Power Consumption | Retransmit | Prioritized Routing | Visible in Nodes List | +| -------------- | --------------- | -------------- | ----------------- | ---------- | ------------------- | --------------------- | +| CLIENT | Yes | Yes | Regular | Yes | No | Yes | +| CLIENT_MUTE | Yes | Yes | Lowest | No | No | Yes | +| CLIENT_HIDDEN | Yes | Yes | Lowest | Local only | No | No | +| TRACKER | Yes | No | Regular | No | No | Yes | +| LOST_AND_FOUND | Yes | No | Regular | No | No | Yes | +| SENSOR | Yes | No | High | No | No | Yes | +| TAK | Yes | Optional | Regular | Yes | No | Yes | +| TAK_TRACKER | Yes | Optional | Regular | Yes | No | Yes | +| ROUTER | No1 | No | High | Yes | Yes | Yes | +| ROUTER_CLIENT | Yes | Yes | Highest | Yes | Yes | Yes | +| REPEATER | Yes | No | High | Yes | Yes | No | +##### Citations +1. Caution: The Router role enables [Power Saving](/docs/configuration/radio/power/#power-saving) by default. Consider ROUTER_CLIENT if BLE/WiFi/Serial are still needed. ### Rebroadcast Mode diff --git a/docs/configuration/radio/power.mdx b/docs/configuration/radio/power.mdx index ff3e089e..db3c2962 100644 --- a/docs/configuration/radio/power.mdx +++ b/docs/configuration/radio/power.mdx @@ -19,7 +19,13 @@ The power config options are: Power Saving, Shutdown after losing power, ADC Mul ### Power Saving -If set, Bluetooth, Wifi, and screen (if applicable) are turned off. When using the Router device role, this setting is on by default. The assumption for a Router is that the device will be used in a standalone manner where these features are not needed, and will be shut off to conserve power. This is especially useful when a device is powered from a low-current source (i.e. solar). +:::warning +Enabling Power Saving will disable Bluetooth, Serial, and WiFi, preventing further changes to the device. Press the user button or reset the device to make changes. +::: + +If enabled, turns off Bluetooth, Serial, WiFi, and Screen. Useful when a device is powered from a low-current source (i.e. solar). To see device roles this is enabled for by default, visit [Device Config](/docs/configuration/radio/device). + + ### Shutdown after losing power From 8de74bb3f6648290bc78216005fc9141dd8949e9 Mon Sep 17 00:00:00 2001 From: "thomas.ekstrand" Date: Sat, 2 Mar 2024 09:53:40 -0600 Subject: [PATCH 2/4] use footnote, update sleep warning --- docs/configuration/radio/device.mdx | 5 ++--- docs/configuration/radio/power.mdx | 2 +- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/configuration/radio/device.mdx b/docs/configuration/radio/device.mdx index c9fd035e..00c1d3b5 100644 --- a/docs/configuration/radio/device.mdx +++ b/docs/configuration/radio/device.mdx @@ -40,12 +40,11 @@ This table shows the **default** values after selecting a preset. As always, ind | SENSOR | Yes | No | High | No | No | Yes | | TAK | Yes | Optional | Regular | Yes | No | Yes | | TAK_TRACKER | Yes | Optional | Regular | Yes | No | Yes | -| ROUTER | No1 | No | High | Yes | Yes | Yes | +| ROUTER | No[^1] | No | High | Yes | Yes | Yes | | ROUTER_CLIENT | Yes | Yes | Highest | Yes | Yes | Yes | | REPEATER | Yes | No | High | Yes | Yes | No | -##### Citations -1. Caution: The Router role enables [Power Saving](/docs/configuration/radio/power/#power-saving) by default. Consider ROUTER_CLIENT if BLE/WiFi/Serial are still needed. +[^1]: The Router role enables [Power Saving](/docs/configuration/radio/power/#power-saving) by default. Consider ROUTER_CLIENT if BLE/WiFi/Serial are still needed. ### Rebroadcast Mode diff --git a/docs/configuration/radio/power.mdx b/docs/configuration/radio/power.mdx index db3c2962..d57105c3 100644 --- a/docs/configuration/radio/power.mdx +++ b/docs/configuration/radio/power.mdx @@ -20,7 +20,7 @@ The power config options are: Power Saving, Shutdown after losing power, ADC Mul ### Power Saving :::warning -Enabling Power Saving will disable Bluetooth, Serial, and WiFi, preventing further changes to the device. Press the user button or reset the device to make changes. +If enabled, to modify settings afterward, wake the device by pressing the user button or resetting. ::: If enabled, turns off Bluetooth, Serial, WiFi, and Screen. Useful when a device is powered from a low-current source (i.e. solar). To see device roles this is enabled for by default, visit [Device Config](/docs/configuration/radio/device). From 3ca467716dcb58758cb55cf3e67b261dfb73553d Mon Sep 17 00:00:00 2001 From: "thomas.ekstrand" Date: Sat, 2 Mar 2024 09:55:03 -0600 Subject: [PATCH 3/4] update power saving description --- docs/configuration/radio/power.mdx | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/configuration/radio/power.mdx b/docs/configuration/radio/power.mdx index d57105c3..7b54d7f0 100644 --- a/docs/configuration/radio/power.mdx +++ b/docs/configuration/radio/power.mdx @@ -23,9 +23,7 @@ The power config options are: Power Saving, Shutdown after losing power, ADC Mul If enabled, to modify settings afterward, wake the device by pressing the user button or resetting. ::: -If enabled, turns off Bluetooth, Serial, WiFi, and Screen. Useful when a device is powered from a low-current source (i.e. solar). To see device roles this is enabled for by default, visit [Device Config](/docs/configuration/radio/device). - - +When activated, this feature disables Bluetooth, Serial, WiFi, and the device's screen to conserve power. This is particularly beneficial for devices relying on low-current power sources, like solar panels. For details on which device roles have this feature enabled by default, please check the [Device Config](/docs/configuration/radio/device) section. ### Shutdown after losing power From 95e3e74f1ec2ba4a14f54adf47f7d265743059e1 Mon Sep 17 00:00:00 2001 From: "thomas.ekstrand" Date: Sat, 2 Mar 2024 13:53:22 -0600 Subject: [PATCH 4/4] add remote admin to power saving warning --- docs/configuration/radio/power.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/radio/power.mdx b/docs/configuration/radio/power.mdx index 7b54d7f0..e2f2dab9 100644 --- a/docs/configuration/radio/power.mdx +++ b/docs/configuration/radio/power.mdx @@ -20,7 +20,7 @@ The power config options are: Power Saving, Shutdown after losing power, ADC Mul ### Power Saving :::warning -If enabled, to modify settings afterward, wake the device by pressing the user button or resetting. +If enabled, modifications to settings can be made by waking the device through pressing the user button, resetting, or through the [admin channel](/docs/configuration/remote-admin/) for remote administration. ::: When activated, this feature disables Bluetooth, Serial, WiFi, and the device's screen to conserve power. This is particularly beneficial for devices relying on low-current power sources, like solar panels. For details on which device roles have this feature enabled by default, please check the [Device Config](/docs/configuration/radio/device) section.