mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-12-27 14:39:54 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge branch 'master' of https://github.com/meshtastic/Meshtastic

Browse source
This commit is contained in:
KrazyKerbalnaut 2021-10-22 21:55:43 -06:00
parent 59c05b299a 0f669047c1
commit 84d0bb6100
2 changed files with 34 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.github/workflows/ci.yml vendored
View file

@ -17,6 +17,8 @@ jobs:
uses: arduino/setup-protoc@v1 uses: arduino/setup-protoc@v1
- name: Install Go - name: Install Go
uses: actions/setup-go@v2 uses: actions/setup-go@v2
with:
go-version: 1.17.2
- name: Install protoc-gen-doc - name: Install protoc-gen-doc
run: go get -u github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc run: go get -u github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc
- name: Checkout code - name: Checkout code

64
website/docs/software/settings/power.md
View file

@ -3,42 +3,42 @@ id: power
title: Power Settings title: Power Settings
sidebar_label: Power sidebar_label: Power
--- ---
import Tabs from '@theme/Tabs'; import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem'; import TabItem from '@theme/TabItem';
## Overview ## Overview
Power settings on a Meshtastic device can be set like other user-define settings with the `--set` command ([see Meshtastic-python](../python/usage)). 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. Power settings on a Meshtastic device can be set like other user-define settings with the `--set` command see ([see Meshtastic-python](../python/python-usage)). 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. Bellow is a list of all user-definable settings and the acceptable values that these settings can use.
For example, if we wanted to disable sleep mode, like when we put the device into router mode, we could use the command: For example, if we wanted to disable sleep mode, like when we put the device into router mode, we could use the command:
```bash ```bash
meshtastic --set mesh_sds_timeout_secs MAXUNIT meshtastic --set mesh_sds_timeout_secs MAXUNIT
``` ```
(see `MAXUNIT` under `mesh_sds_timeout_secs` below...)
For a description and more information on what exactly all of these mean, please refer to [Power Management State Machine](../other/power) For a description and more information on what exactly all of these mean, please refer to [Power Management State Machine](../other/power)
## Settings ## Settings
| Setting | Acceptable Values | Default | | Setting | Acceptable Values | Default |
| :-----: | :---------------: | :-----: | | :-------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| charge_current | `MAUnset`, `MA100`, `MA190`, `MA280`, `MA360`, `MA450`, `MA550`, `MA630`, `MA700`, `MA780`, `MA880`, `MA960`, `MA1000`, `MA1080`, `MA1160`, `MA1240`, `MA1320`: | `MAUnset` | | charge_current | `MAUnset`, `MA100`, `MA190`, `MA280`, `MA360`, `MA450`, `MA550`, `MA630`, `MA700`, `MA780`, `MA880`, `MA960`, `MA1000`, `MA1080`, `MA1160`, `MA1240`, `MA1320`: | `MAUnset` |
| is_low_power | `true`, `false` | `false` | 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). | | is_low_power | `true`, `false` | `false` | 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). |
| is_router | `true`, `false` | `false` | | is_router | `true`, `false` | `false` |
| ls_secs | `integer` (seconds) | `0` (see note) | | ls_secs | `integer` (seconds) | `0` (see note) |
| mesh_sds_timeout_secs | `integer` (seconds) | `0` | | mesh_sds_timeout_secs | `integer` (seconds) | `0` |
| min_wake_secs | `integer` (seconds) | `0` | | min_wake_secs | `integer` (seconds) | `0` |
| phone_sds_timeout_sec | `integer` (seconds) | `0` | Power management state machine option. See the [power page](other/power) for details. 0 for default of two hours, MAXUINT for disabled | | phone_sds_timeout_sec | `integer` (seconds) | `0` | Power management state machine option. See the [power page](../other/power) for details. 0 for default of two hours, MAXUINT for disabled |
| phone_timeout_secs | `integer` (seconds) | `0` | | phone_timeout_secs | `integer` (seconds) | `0` |
| screen_on_secs | `integer` (seconds) | `0` | | screen_on_secs | `integer` (seconds) | `0` |
| sds_secs | `integer` (seconds) | `0` | | sds_secs | `integer` (seconds) | `0` |
| send_owner_interval | `integer` (sent every x network pings) | `4` | | send_owner_interval | `integer` (sent every x network pings) | `4` |
| wait_bluetooth_secs | `integer` (seconds) | `0` | | wait_bluetooth_secs | `integer` (seconds) | `0` |
:::note :::note
When you the following settings to `0` they assume the following defaults: When you the following settings to `0` they assume the following defaults:
- `ls_secs`: 1 hour - `ls_secs`: 1 hour
- `mesh_sds_timeout_secs`: 2 hours - `mesh_sds_timeout_secs`: 2 hours
- `min_wake_secs`: 10 seconds - `min_wake_secs`: 10 seconds
@ -47,7 +47,7 @@ When you the following settings to `0` they assume the following defaults:
- `screen_on_secs`: 1 minute - `screen_on_secs`: 1 minute
- `sds_secs`: 1 year - `sds_secs`: 1 year
- `wait_bluetooth_secs`: 1 minute - `wait_bluetooth_secs`: 1 minute
::: :::
### charge_current ### charge_current
@ -91,7 +91,7 @@ Power management state machine option. See the [power page](../other/power) for
### send_owner_interval ### 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). This sets how often to send the database of node owner information with other nodes in the mesh (per mesh network ping).
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. 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.
@ -102,20 +102,20 @@ Power management state machine option. See the [power page](../other/power) for
## Examples ## Examples
<Tabs <Tabs
groupId="settings" groupId="settings"
defaultValue="cli" defaultValue="cli"
values={[ values={[
{label: 'CLI', value: 'cli'}, {label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'}, {label: 'Android', value: 'android'},
]}> ]}>
<TabItem value="cli"> <TabItem value="cli">
TODO TODO
</TabItem> </TabItem>
<TabItem value="android"> <TabItem value="android">
TODO TODO
</TabItem> </TabItem>
</Tabs> </Tabs>