Skip to content

Commit

Permalink
Update config.proto
Browse files Browse the repository at this point in the history
Update proto comments
  • Loading branch information
garthvh authored Feb 24, 2024
1 parent 863fd54 commit c183973
Showing 1 changed file with 11 additions and 17 deletions.
28 changes: 11 additions & 17 deletions meshtastic/config.proto
Original file line number Diff line number Diff line change
Expand Up @@ -350,30 +350,27 @@ message Config {
*/
message PowerConfig {
/*
* 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).
* Advanced Option
* Description: Will sleep everything as much as possible, for the tracker and sensor role this will also include the lora radio.
* Don't use this setting if you want to use your device with the phone apps or are using a device without a user button.
* Technical Details: Works for ESP32 devices and NRF52 devices in the Sensor or Tracker roles
*/
bool is_power_saving = 1;

/*
* If non-zero, the device will fully power off this many seconds after external power is removed.
* Description: If non-zero, the device will fully power off this many seconds after external power is removed.
*/
uint32 on_battery_shutdown_after_secs = 2;

/*
* Ratio of voltage divider for battery pin eg. 3.20 (R1=100k, R2=220k)
* Overrides the ADC_MULTIPLIER defined in variant for battery voltage calculation.
* Should be set to floating point value between 2 and 4
* Fixes issues on Heltec v2
* Should be set to floating point value between 2 and 6
*/
float adc_multiplier_override = 3;

/*
* Wait Bluetooth Seconds
* The number of seconds for to wait before turning off BLE in No Bluetooth states
* 0 for default of 1 minute
* Description: The number of seconds for to wait before turning off BLE in No Bluetooth states
* Technical Details: ESP32 Only 0 for default of 1 minute
*/
uint32 wait_bluetooth_secs = 4;

Expand All @@ -386,17 +383,14 @@ message Config {
uint32 sds_secs = 6;

/*
* Light Sleep Seconds
* In light sleep the CPU is suspended, LoRa radio is on, BLE is off an GPS is on
* ESP32 Only
* 0 for default of 300
* Description: In light sleep the CPU is suspended, LoRa radio is on, BLE is off an GPS is on
* Technical Details: ESP32 Only 0 for default of 300
*/
uint32 ls_secs = 7;

/*
* Minimum Wake Seconds
* While in light sleep when we receive packets on the LoRa radio we will wake and handle them and stay awake in no BLE mode for this value
* 0 for default of 10 seconds
* Description: While in light sleep when we receive packets on the LoRa radio we will wake and handle them and stay awake in no BLE mode for this value
* Technical Details: ESP32 Only 0 for default of 10 seconds
*/
uint32 min_wake_secs = 8;

Expand Down

0 comments on commit c183973

Please sign in to comment.