From 09d60380169bb89750360d8886c85b81b17d7710 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Wed, 2 Feb 2022 13:46:00 -0700 Subject: [PATCH] add placeholders --- docs/software/settings/power.md | 603 +++++++++++++++++++++++++++++++- 1 file changed, 594 insertions(+), 9 deletions(-) diff --git a/docs/software/settings/power.md b/docs/software/settings/power.md index 0105d03b..516d9535 100644 --- a/docs/software/settings/power.md +++ b/docs/software/settings/power.md @@ -57,61 +57,646 @@ When you change the following settings to `0` they assume the following defaults ### charge_current -Sets the current of the battery charger +Sets the current of the battery charger. + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + ### is_always_powered Circumvents the logic block for determining whether the device is powered or not. Useful for devices with finicky ADC issues on the battery sense pins. + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### is_low_power If set, we are powered from a low-current source (i.e. solar), so even if it looks like we have power flowing in we should try to minimize power consumption as much as possible. YOU DO NOT NEED TO SET THIS IF YOU'VE set is_router (it is implied in that case). + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### is_router -Are we operating as a router. Changes behavior in the following ways: The device will only sleep for critically low battery level (i.e. always tries to stay alive for the mesh) In the future routing decisions will preferentially route packets through nodes with this attribute (because assumed good line of sight) +Are we operating as a router. Changes behavior in the following ways: The device will only sleep for critically low battery level (i.e. always tries to stay alive for the mesh) In the future routing decisions will preferentially route packets through nodes with this attribute (because assumed good line of sight). + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + ### ls_secs -Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of 3600 +Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of 3600. + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + ### mesh_sds_timeout_secs -Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of two hours, use the MAXUINT or 4294967295 to disable +Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of two hours, use the MAXUINT or 4294967295 to disable. + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + ### min_wake_secs -Power management state machine option. See the [power page](/docs/software/other/power)for details. 0 for default of 10 seconds +Power management state machine option. See the [power page](/docs/software/other/power)for details. 0 for default of 10 seconds. + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + ### on_battery_shutdown_after_secs If non-zero, the device will fully power off this many seconds after external power is removed. + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### phone_sds_timeout_sec -Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of two hours, use the MAXUINT or 4294967295 to disable +Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of two hours, use the MAXUINT or 4294967295 to disable. + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + ### phone_timeout_secs -Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of 15 minutes +Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of 15 minutes. + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + ### screen_on_secs Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of one minute. + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### sds_secs -Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of one year +Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of one year. + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + ### send_owner_interval This sets how often to send the database of node owner information with other nodes in the mesh (per mesh network ping). + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + For instance the default interval of 4 will send the node owner information for every 4 mesh network pings. This information is also transmitted after the node first boots up. + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### wait_bluetooth_secs -Wait number of seconds for Bluetooth - Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of 1 minute +Wait number of seconds for Bluetooth - Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of 1 minute. + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + ## Examples