meshtastic/docs/settings/power.md at 0185fadb39130d366aa021875117dcdb455d889a

mirror of https://github.com/meshtastic/meshtastic.git synced 2024-09-22 00:57:32 -07:00

Foster Irwin a0a19798da moved settings folder

2022-02-21 14:07:19 -07:00

20 KiB

Raw Blame History

id	title	sidebar_label
power	Power Settings	Power

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Overview

Power settings on a Meshtastic device can be set like other user-define settings with the --set command see (see Meshtastic-python). Some of these options are implicit in other commands. For example, when you set the device to router mode using is_router true, it is implied that deep sleep is disabled and we want to constantly listen for messages. Below is a list of all user-definable settings and the acceptable values that these settings can use.

For a description and more information on what exactly all of these mean, please refer to Power Management State Machine

Settings

Setting	Acceptable Values	Default
charge_current	`MAUnset`, `MA100`, `MA190`, `MA280`, `MA360`, `MA450`, `MA550`, `MA630`, `MA700`, `MA780`, `MA880`, `MA960`, `MA1000`, `MA1080`, `MA1160`, `MA1240`, `MA1320`:	`MAUnset`
is_always_powered	`true`, `false`	`false`
is_low_power	`true`, `false`	`false`
is_router	`true`, `false`	`false`
ls_secs	`integer` (seconds)	`0`
mesh_sds_timeout_secs	`integer` (seconds)	`0`
min_wake_secs	`integer` (seconds)	`0`
on_battery_shutdown_after_secs	`integer` (seconds)	`0`
phone_sds_timeout_sec	`integer` (seconds)	`0`
phone_timeout_secs	`integer` (seconds)	`0`
screen_on_secs	`integer` (seconds)	`0`
sds_secs	`integer` (seconds)	`0`
send_owner_interval	`integer` (sent every x network pings)	`4`
wait_bluetooth_secs	`integer` (seconds)	`0`

:::note When you change the following settings to 0 they assume the following defaults:

ls_secs: 1 hour
mesh_sds_timeout_secs: 2 hours
min_wake_secs: 10 seconds
phone_sds_timeout_sec: 2 hours
phone_timeout_secs: 15 minutes
screen_on_secs: 1 minute
sds_secs: 1 year
wait_bluetooth_secs: 1 minute :::

charge_current

Sets the current of the battery charger.

Specify charge_current

meshtastic --set  charge_current MAUnset

meshtastic --set  charge_current MA100

:::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.

Enable/Disable is_always_powered

meshtastic --set is_always_powered true

meshtastic --set is_always_powered false

:::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.

:::note You do not need to set this if you've set is_router (it is implied in that case). :::

Enable/Disable is_low_power

meshtastic --set is_low_power true

meshtastic --set is_low_power false

:::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).

Enable/Disable is_router

meshtastic --set is_router true

meshtastic --set is_router false

:::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 for details. 0 for default of 3600.

Configure ls_secs

meshtastic --set ls_secs 0

meshtastic --set ls_secs 120

:::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 for details. 0 for default of two hours, use the MAXUINT or 4294967295 to disable.

Configure mesh_sds_timeout_secs

meshtastic --set mesh_sds_timeout_secs 0

meshtastic --set mesh_sds_timeout_secs 120

meshtastic --set mesh_sds_timeout_secs 4294967295

:::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 pagefor details. 0 for default of 10 seconds.

Configure min_wake_secs

meshtastic --set min_wake_secs 0

meshtastic --set min_wake_secs 120

:::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.

Enable/Disable on_battery_shutdown_after_secs

meshtastic --set on_battery_shutdown_after_secs 0

meshtastic --set on_battery_shutdown_after_secs 120

:::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 for details. 0 for default of two hours, use the MAXUINT or 4294967295 to disable.

Enable/Disable phone_sds_timeout_sec

meshtastic --set phone_sds_timeout_sec 0

meshtastic --set phone_sds_timeout_sec 4294967295

meshtastic --set phone_sds_timeout_sec 120

:::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 for details. 0 for default of 15 minutes.

Configure phone_timeout_secs

meshtastic --set phone_timeout_secs 0

meshtastic --set phone_timeout_secs 120

:::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 for details. 0 for default of one minute.

Configure screen_on_secs

meshtastic --set screen_on_secs 0

meshtastic --set screen_on_secs 120

:::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 for details. 0 for default of one year.

Configure sds_secs

meshtastic --set sds_secs 0

meshtastic --set sds_secs 120

:::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).

Configure send_owner_interval

meshtastic --set send_owner_interval 0

meshtastic --set send_owner_interval 10

:::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.

wait_bluetooth_secs

Wait number of seconds for Bluetooth - Power management state machine option. See the power page for details. 0 for default of 1 minute.

Configure wait_bluetooth_secs

meshtastic --set wait_bluetooth_secs 0

meshtastic --set wait_bluetooth_secs 120

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

20 KiB Raw Blame History

Overview

Settings

charge_current

Specify charge_current

is_always_powered

Enable/Disable is_always_powered

is_low_power

Enable/Disable is_low_power

is_router

Enable/Disable is_router

ls_secs

Configure ls_secs

mesh_sds_timeout_secs

Configure mesh_sds_timeout_secs

min_wake_secs

Configure min_wake_secs

on_battery_shutdown_after_secs

Enable/Disable on_battery_shutdown_after_secs

phone_sds_timeout_sec

Enable/Disable phone_sds_timeout_sec

phone_timeout_secs

Configure phone_timeout_secs

screen_on_secs

Configure screen_on_secs

sds_secs

Configure sds_secs

send_owner_interval

Configure send_owner_interval

wait_bluetooth_secs

Configure wait_bluetooth_secs

20 KiB

Raw Blame History