mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-11-10 07:34:11 -08:00
added power examples
This commit is contained in:
Foster Irwin
parent
ac42a13d5a
commit
bb2a6ba464
|
|
@ -59,6 +59,8 @@ When you change the following settings to `0` they assume the following defaults
|
|||
|
||||
Sets the current of the battery charger.
|
||||
|
||||
#### Specify charge_current
|
||||
|
||||
<Tabs
|
||||
groupId="settings"
|
||||
defaultValue="cli"
|
||||
|
|
@ -70,9 +72,12 @@ Sets the current of the battery charger.
|
|||
]}>
|
||||
<TabItem value="cli">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
```bash title="Unset charge current"
|
||||
meshtastic --set charge_current MAUnset
|
||||
```
|
||||
```bash title="Set charge current"
|
||||
meshtastic --set charge_current MA100
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="android">
|
||||
|
|
@ -102,6 +107,7 @@ Configuring this setting is not yet available for the selected platform. If this
|
|||
|
||||
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
|
||||
<Tabs
|
||||
groupId="settings"
|
||||
defaultValue="cli"
|
||||
|
|
@ -113,9 +119,12 @@ Circumvents the logic block for determining whether the device is powered or not
|
|||
]}>
|
||||
<TabItem value="cli">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
```bash title="Enable is_always_powered"
|
||||
meshtastic --set is_always_powered true
|
||||
```
|
||||
```bash title="Disable is_always_powered"
|
||||
meshtastic --set is_always_powered false
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="android">
|
||||
|
|
@ -149,6 +158,7 @@ If set, we are powered from a low-current source (i.e. solar), so even if it loo
|
|||
You do **not** need to set this if you've set `is_router` (it is implied in that case).
|
||||
:::
|
||||
|
||||
#### Enable/Disable is_low_power
|
||||
<Tabs
|
||||
groupId="settings"
|
||||
defaultValue="cli"
|
||||
|
|
@ -160,9 +170,12 @@ You do **not** need to set this if you've set `is_router` (it is implied in that
|
|||
]}>
|
||||
<TabItem value="cli">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
```bash title="Enable is_low_power"
|
||||
meshtastic --set is_low_power true
|
||||
```
|
||||
```bash title="Disable is_low_power"
|
||||
meshtastic --set is_low_power false
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="android">
|
||||
|
|
@ -192,6 +205,8 @@ Configuring this setting is not yet available for the selected platform. If this
|
|||
|
||||
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
|
||||
<Tabs
|
||||
groupId="settings"
|
||||
defaultValue="cli"
|
||||
|
|
@ -203,9 +218,12 @@ Are we operating as a router. Changes behavior in the following ways: The device
|
|||
]}>
|
||||
<TabItem value="cli">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
```bash title="Enable is_router"
|
||||
meshtastic --set is_router true
|
||||
```
|
||||
```bash title="Disable is_router"
|
||||
meshtastic --set is_router false
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="android">
|
||||
|
|
@ -235,6 +253,7 @@ Configuring this setting is not yet available for the selected platform. If this
|
|||
|
||||
Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of 3600.
|
||||
|
||||
#### Configure ls_secs
|
||||
<Tabs
|
||||
groupId="settings"
|
||||
defaultValue="cli"
|
||||
|
|
@ -246,9 +265,12 @@ Power management state machine option. See the [power page](/docs/software/other
|
|||
]}>
|
||||
<TabItem value="cli">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
```bash title="Set ls_secs to default (1 hour/3600 seconds)"
|
||||
meshtastic --set ls_secs 0
|
||||
```
|
||||
```bash title="Set ls_secs to 120 seconds"
|
||||
meshtastic --set ls_secs 120
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="android">
|
||||
|
|
@ -278,6 +300,7 @@ Configuring this setting is not yet available for the selected platform. If this
|
|||
|
||||
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.
|
||||
|
||||
#### Configure mesh_sds_timeout_secs
|
||||
<Tabs
|
||||
groupId="settings"
|
||||
defaultValue="cli"
|
||||
|
|
@ -289,9 +312,15 @@ Power management state machine option. See the [power page](/docs/software/other
|
|||
]}>
|
||||
<TabItem value="cli">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
```bash title="Set mesh_sds_timeout_secs to default (2 hour/7200 seconds)"
|
||||
meshtastic --set mesh_sds_timeout_secs 0
|
||||
```
|
||||
```bash title="Set mesh_sds_timeout_secs to 120 seconds"
|
||||
meshtastic --set mesh_sds_timeout_secs 120
|
||||
```
|
||||
```bash title="Disable mesh_sds_timeout_secs (using MAXUINT)"
|
||||
meshtastic --set mesh_sds_timeout_secs 4294967295
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="android">
|
||||
|
|
@ -321,6 +350,8 @@ Configuring this setting is not yet available for the selected platform. If this
|
|||
|
||||
Power management state machine option. See the [power page](/docs/software/other/power)for details. 0 for default of 10 seconds.
|
||||
|
||||
#### Configure min_wake_secs
|
||||
|
||||
<Tabs
|
||||
groupId="settings"
|
||||
defaultValue="cli"
|
||||
|
|
@ -332,9 +363,12 @@ Power management state machine option. See the [power page](/docs/software/other
|
|||
]}>
|
||||
<TabItem value="cli">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
```bash title="Set min_wake_secs to default (10 seconds)"
|
||||
meshtastic --set min_wake_secs 0
|
||||
```
|
||||
```bash title="Set min_wake_secs to 120 seconds"
|
||||
meshtastic --set min_wake_secs 120
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="android">
|
||||
|
|
@ -364,6 +398,7 @@ Configuring this setting is not yet available for the selected platform. If this
|
|||
|
||||
If non-zero, the device will fully power off this many seconds after external power is removed.
|
||||
|
||||
#### Enable/Disable on_battery_shutdown_after_secs
|
||||
<Tabs
|
||||
groupId="settings"
|
||||
defaultValue="cli"
|
||||
|
|
@ -375,9 +410,12 @@ If non-zero, the device will fully power off this many seconds after external po
|
|||
]}>
|
||||
<TabItem value="cli">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
```bash title="Disable on_battery_shutdown_after_secs"
|
||||
meshtastic --set on_battery_shutdown_after_secs 0
|
||||
```
|
||||
```bash title="Set device to shutdown after 120 seconds on battery"
|
||||
meshtastic --set on_battery_shutdown_after_secs 120
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="android">
|
||||
|
|
@ -407,6 +445,7 @@ Configuring this setting is not yet available for the selected platform. If this
|
|||
|
||||
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.
|
||||
|
||||
#### Enable/Disable phone_sds_timeout_sec
|
||||
<Tabs
|
||||
groupId="settings"
|
||||
defaultValue="cli"
|
||||
|
|
@ -418,9 +457,15 @@ Power management state machine option. See the [power page](/docs/software/other
|
|||
]}>
|
||||
<TabItem value="cli">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
```bash title="Set phone_sds_timeout_sec to default (2 hours)"
|
||||
meshtastic --set phone_sds_timeout_sec 0
|
||||
```
|
||||
```bash title="Disable phone_sds_timeout_sec"
|
||||
meshtastic --set phone_sds_timeout_sec 4294967295
|
||||
```
|
||||
```bash title="Set phone_sds_timeout_sec to 120 seconds"
|
||||
meshtastic --set phone_sds_timeout_sec 120
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="android">
|
||||
|
|
@ -450,6 +495,8 @@ Configuring this setting is not yet available for the selected platform. If this
|
|||
|
||||
Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of 15 minutes.
|
||||
|
||||
#### Configure phone_timeout_secs
|
||||
|
||||
<Tabs
|
||||
groupId="settings"
|
||||
defaultValue="cli"
|
||||
|
|
@ -461,9 +508,12 @@ Power management state machine option. See the [power page](/docs/software/other
|
|||
]}>
|
||||
<TabItem value="cli">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
```bash title="Set phone_timeout_secs to default (15 minutes)"
|
||||
meshtastic --set phone_timeout_secs 0
|
||||
```
|
||||
```bash title="Set phone_timeout_secs to 120 seconds"
|
||||
meshtastic --set phone_timeout_secs 120
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="android">
|
||||
|
|
@ -493,6 +543,8 @@ Configuring this setting is not yet available for the selected platform. If this
|
|||
|
||||
Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of one minute.
|
||||
|
||||
#### Configure screen_on_secs
|
||||
|
||||
<Tabs
|
||||
groupId="settings"
|
||||
defaultValue="cli"
|
||||
|
|
@ -504,9 +556,12 @@ Power management state machine option. See the [power page](/docs/software/other
|
|||
]}>
|
||||
<TabItem value="cli">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
```bash title="Set screen_on_secs to default (1 minute)"
|
||||
meshtastic --set screen_on_secs 0
|
||||
```
|
||||
```bash title="Set screen_on_secs to 120 seconds"
|
||||
meshtastic --set screen_on_secs 120
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="android">
|
||||
|
|
@ -536,6 +591,8 @@ Configuring this setting is not yet available for the selected platform. If this
|
|||
|
||||
Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of one year.
|
||||
|
||||
#### Configure sds_secs
|
||||
|
||||
<Tabs
|
||||
groupId="settings"
|
||||
defaultValue="cli"
|
||||
|
|
@ -547,9 +604,12 @@ Power management state machine option. See the [power page](/docs/software/other
|
|||
]}>
|
||||
<TabItem value="cli">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
```bash title="Set sds_secs to default (1 year)"
|
||||
meshtastic --set sds_secs 0
|
||||
```
|
||||
```bash title="Set sds_secs to 120 seconds"
|
||||
meshtastic --set sds_secs 120
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="android">
|
||||
|
|
@ -579,6 +639,8 @@ Configuring this setting is not yet available for the selected platform. If this
|
|||
|
||||
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
|
||||
|
||||
<Tabs
|
||||
groupId="settings"
|
||||
defaultValue="cli"
|
||||
|
|
@ -590,9 +652,12 @@ This sets how often to send the database of node owner information with other no
|
|||
]}>
|
||||
<TabItem value="cli">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
```bash title="Set send_owner_interval to default (every 4 network pings)"
|
||||
meshtastic --set send_owner_interval 0
|
||||
```
|
||||
```bash title="Set send_owner_interval to every 10 network pings"
|
||||
meshtastic --set send_owner_interval 10
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="android">
|
||||
|
|
@ -620,49 +685,11 @@ Configuring this setting is not yet available for the selected platform. If this
|
|||
|
||||
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.
|
||||
|
||||
<Tabs
|
||||
groupId="settings"
|
||||
defaultValue="cli"
|
||||
values={[
|
||||
{label: 'CLI', value: 'cli'},
|
||||
{label: 'Android', value: 'android'},
|
||||
{label: 'iOS', value: 'iOS'},
|
||||
{label: 'Web', value: 'web'},
|
||||
]}>
|
||||
<TabItem value="cli">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="android">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="iOS">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="web">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### 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.
|
||||
|
||||
#### Configure wait_bluetooth_secs
|
||||
<Tabs
|
||||
groupId="settings"
|
||||
defaultValue="cli"
|
||||
|
|
@ -674,60 +701,12 @@ Wait number of seconds for Bluetooth - Power management state machine option. Se
|
|||
]}>
|
||||
<TabItem value="cli">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="android">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="iOS">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="web">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Examples
|
||||
|
||||
<Tabs
|
||||
groupId="settings"
|
||||
defaultValue="cli"
|
||||
values={[
|
||||
{label: 'CLI', value: 'cli'},
|
||||
{label: 'Android', value: 'android'},
|
||||
{label: 'iOS', value: 'iOS'},
|
||||
{label: 'Web', value: 'web'},
|
||||
]}>
|
||||
<TabItem value="cli">
|
||||
|
||||
```bash
|
||||
meshtastic --set mesh_sds_timeout_secs 0
|
||||
```
|
||||
|
||||
Note: Probably only want to set the wait_bluetooth_secs this high during testing:
|
||||
|
||||
```bash
|
||||
meshtastic --set wait_bluetooth_secs 28800
|
||||
```
|
||||
|
||||
```bash
|
||||
meshtastic --set is_always_powered true
|
||||
```
|
||||
```bash title="Set wait_bluetooth_secs to default (60 seconds)"
|
||||
meshtastic --set wait_bluetooth_secs 0
|
||||
```
|
||||
```bash title="Set wait_bluetooth_secs to 120 seconds"
|
||||
meshtastic --set wait_bluetooth_secs 120
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="android">
|
||||
|
|
|
|||
Loading…
Reference in a new issue