From a7575a84fc19df5cfa18fb7c302a0e2f6443d27b Mon Sep 17 00:00:00 2001 From: Garth Vander Houwen Date: Tue, 14 Jun 2022 16:42:04 -0700 Subject: [PATCH] Clean up Comments (#169) * Update module_config.proto Update Comments in module config * Update config.proto * Update config.proto * Update config.proto * Update config.proto * Update config.proto * Update config.proto * Update config.proto * Update config.proto --- config.proto | 43 +++++++++++++++++++++++-------------------- module_config.proto | 27 +++++++++++++-------------- 2 files changed, 36 insertions(+), 34 deletions(-) diff --git a/config.proto b/config.proto index bd75d48..9be6f10 100644 --- a/config.proto +++ b/config.proto @@ -7,15 +7,12 @@ option go_package = "github.com/meshtastic/gomeshproto"; message Config { /* - * TODO: REPLACE + * Configuration */ message DeviceConfig { /* * Defines the device's role on the Mesh network - * unset - * Behave normally. - * Router - * Functions as a router + * unset - 0 */ enum Role { @@ -34,7 +31,7 @@ message Config { /* * Router device role. * Uses an agressive algirithem for the flood networking so packets will - * prefer to be routed over this node. Also assume that this will be generally + * prefer to be routed over this node. Also assume that this will be * unattended and so will turn off the wifi/ble radio as well as the oled screen. */ Router = 2; @@ -80,7 +77,7 @@ message Config { } /* - * TODO: REPLACE + * Position Config */ message PositionConfig { /* @@ -184,13 +181,14 @@ message Config { } /* - * TODO: REPLACE + * Power Config\ + * See [power management](/docs/software/other/power) for additional power management state machine option details. */ message PowerConfig { /* - * Sets the charge control current of devices with a battery charger that can be - * configured. This is passed into the axp power management chip like on the tbeam. + * Sets the charge control current of devices with a battery charger that can be configured + * **TBEAM 1.1 Only** */ enum ChargeCurrent { @@ -282,6 +280,7 @@ message Config { /* * Sets the current of the battery charger + * TBEAM 1.1 Only */ ChargeCurrent charge_current = 1; @@ -289,6 +288,7 @@ message Config { * 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). + * CLI Only Option */ bool is_power_saving = 2; @@ -311,36 +311,39 @@ message Config { float adc_multiplier_override = 6; /* - * Power management state machine option. - * See [power management](/docs/software/other/power) for details. + * Wait Bluetooth Seconds + * The number of seconds for to wait before turning of BLE in No Bluetooth states\ * 0 for default of 1 minute */ uint32 wait_bluetooth_secs = 7; /* - * Power management state machine option. - * See [power management](/docs/software/other/power) for details. + * Mesh Super Deep Sleep Timeout Seconds + * While in Light Sleep if this value is exceeded we will lower into super deep sleep + * for sds_secs (default 1 year) or a button press * 0 for default of two hours, MAXUINT for disabled */ uint32 mesh_sds_timeout_secs = 9; /* - * Power management state machine option. - * See [power management](/docs/software/other/power) for details. + * Super Deep Sleep Seconds + * While in Light Sleep if mesh_sds_timeout_secs is exceeded we will lower into super deep sleep + * for this value (default 1 year) or a button press * 0 for default of one year */ uint32 sds_secs = 10; /* - * Power management state machine option. - * See [power management](/docs/software/other/power) for details. + * 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 3600 */ uint32 ls_secs = 11; /* - * Power management state machine option. - * See [power management](/docs/software/other/power) for details. + * 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 */ uint32 min_wake_secs = 12; diff --git a/module_config.proto b/module_config.proto index efedfdb..369d258 100644 --- a/module_config.proto +++ b/module_config.proto @@ -7,12 +7,12 @@ option optimize_for = LITE_RUNTIME; option go_package = "github.com/meshtastic/gomeshproto"; /* - * TODO: REPLACE + * Module Config */ message ModuleConfig { /* - * TODO: REPLACE + * MQTT Client Config */ message MQTTConfig { @@ -53,7 +53,7 @@ message ModuleConfig { } /* - * TODO: REPLACE + * Serial Config */ message SerialConfig { @@ -127,7 +127,7 @@ message ModuleConfig { } /* - * TODO: REPLACE + * External Notifications Config */ message ExternalNotificationConfig { @@ -166,12 +166,11 @@ message ModuleConfig { } /* - * TODO: REPLACE + * Store and Forward Module Config */ message StoreForwardConfig { /* - * Preferences for the StoreForwardModule - *FIXME - Move this out of UserPreferences and into a section for module configuration. (was 136) + * Enable the Store and Forward Module */ bool enabled = 1; @@ -198,22 +197,22 @@ message ModuleConfig { } /* - * TODO: REPLACE + * Preferences for the RangeTestModule */ message RangeTestConfig { /* - * Preferences for the RangeTestModule - * FIXME - Move this out of UserPreferences and into a section for module configuration. + * Enable the Range Test Module */ bool enabled = 1; /* - * TODO: REPLACE + * Send out range test messages from this node */ uint32 sender = 2; /* - * TODO: REPLACE + * Bool value indicating that this node should save a RangeTest.csv file. + * ESP32 Only */ bool save = 3; } @@ -225,7 +224,7 @@ message ModuleConfig { /* * Interval in seconds of how often we should try to send our - * device measurements to the mesh + * device metrics to the mesh */ uint32 device_update_interval = 1; @@ -428,4 +427,4 @@ message ModuleConfig { CannedMessageConfig canned_message = 7; } -} \ No newline at end of file +}