From f1cd4925291fd004a2a2e082b34b098f5f3abc10 Mon Sep 17 00:00:00 2001 From: Kevin Hester Date: Mon, 21 Dec 2020 10:15:48 +0800 Subject: [PATCH] doc updates --- docs/docs.md | 26 ++++++++++++-------------- mesh.proto | 31 +++++++++++++++++++++---------- 2 files changed, 33 insertions(+), 24 deletions(-) diff --git a/docs/docs.md b/docs/docs.md index 60e03e3..2d1674e 100644 --- a/docs/docs.md +++ b/docs/docs.md @@ -318,27 +318,25 @@ see sw-design.md for more information on these preferences | position_broadcast_secs | [uint32](#uint32) | | We should send our position this often (but only if it has changed significantly). Defaults to 15 minutes | | send_owner_interval | [uint32](#uint32) | | Send our owner info at least this often (also we always send once at boot - to rejoin the mesh) | | num_missed_to_fail | [uint32](#uint32) | | If we miss this many owner messages from a node, we declare the node / offline (defaults to 3 - to allow for some lost packets) | -| wait_bluetooth_secs | [uint32](#uint32) | | 0 for default of 1 minute | -| screen_on_secs | [uint32](#uint32) | | 0 for default of one minute | -| phone_timeout_secs | [uint32](#uint32) | | 0 for default of 15 minutes | -| phone_sds_timeout_sec | [uint32](#uint32) | | 0 for default of two hours, MAXUINT for disabled | -| mesh_sds_timeout_secs | [uint32](#uint32) | | 0 for default of two hours, MAXUINT for disabled | -| sds_secs | [uint32](#uint32) | | 0 for default of one year | -| ls_secs | [uint32](#uint32) | | 0 for default of 3600 | -| min_wake_secs | [uint32](#uint32) | | 0 for default of 10 seconds | +| wait_bluetooth_secs | [uint32](#uint32) | | Power management state machine option. See https://github.com/meshtastic/Meshtastic-device/blob/master/docs/software/power.md for details. 0 for default of 1 minute | +| screen_on_secs | [uint32](#uint32) | | Power management state machine option. See https://github.com/meshtastic/Meshtastic-device/blob/master/docs/software/power.md for details. 0 for default of one minute | +| phone_timeout_secs | [uint32](#uint32) | | Power management state machine option. See https://github.com/meshtastic/Meshtastic-device/blob/master/docs/software/power.md for details. 0 for default of 15 minutes | +| phone_sds_timeout_sec | [uint32](#uint32) | | Power management state machine option. See https://github.com/meshtastic/Meshtastic-device/blob/master/docs/software/power.md for details. 0 for default of two hours, MAXUINT for disabled | +| mesh_sds_timeout_secs | [uint32](#uint32) | | Power management state machine option. See https://github.com/meshtastic/Meshtastic-device/blob/master/docs/software/power.md for details. 0 for default of two hours, MAXUINT for disabled | +| sds_secs | [uint32](#uint32) | | Power management state machine option. See https://github.com/meshtastic/Meshtastic-device/blob/master/docs/software/power.md for details. 0 for default of one year | +| ls_secs | [uint32](#uint32) | | Power management state machine option. See https://github.com/meshtastic/Meshtastic-device/blob/master/docs/software/power.md for details. 0 for default of 3600 | +| min_wake_secs | [uint32](#uint32) | | Power management state machine option. See https://github.com/meshtastic/Meshtastic-device/blob/master/docs/software/power.md for details. 0 for default of 10 seconds | | wifi_ssid | [string](#string) | | If set, this node will try to join the specified wifi network and acquire an address via DHCP | | wifi_password | [string](#string) | | If set, will be use to authenticate to the named wifi | | wifi_ap_mode | [bool](#bool) | | If set, the node will operate as an AP (and DHCP server), otherwise it will be a station | | region | [RegionCode](#RegionCode) | | The region code for my radio (US, CN, EU433, etc...) | -| is_router | [bool](#bool) | | Are we operating as a router. Changes behavior in the following ways: FIXME | +| is_router | [bool](#bool) | | 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) | | is_low_power | [bool](#bool) | | 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. Often combined with is_router. | -| fixed_position | [bool](#bool) | | If set, this node is at a fixed position. We will generate GPS position updates at the regular interval, but use whatever the last lat/lon/alt we have for the node. - -The lat/lon/alt can be set by an internal GPS or with the help of the app. | +| fixed_position | [bool](#bool) | | If set, this node is at a fixed position. We will generate GPS position updates at the regular interval, but use whatever the last lat/lon/alt we have for the node. The lat/lon/alt can be set by an internal GPS or with the help of the app. | | factory_reset | [bool](#bool) | | This setting is never saved to disk, but if set, all device settings will be returned to factory defaults. (Region, serial number etc... will be preserved) | | debug_log_enabled | [bool](#bool) | | By default we turn off logging as soon as an API client connects (to keep shared serial link quiet). Set this to true to leave the debug log outputting even when API is active. | -| location_share | [LocationSharing](#LocationSharing) | | | -| gps_operation | [GpsOperation](#GpsOperation) | | | +| location_share | [LocationSharing](#LocationSharing) | | How our location is shared with other nodes (or the local phone) | +| gps_operation | [GpsOperation](#GpsOperation) | | How the GPS hardware in this unit is operated. Note: This is independent of how our location is shared with other devices. For that see LocationSharing | | gps_update_interval | [uint32](#uint32) | | How often should we try to get GPS position (in seconds) when we are in GpsOpMobile mode? or zero for the default of once every 120 seconds or a very large value (maxint) to update only once at boot. | | gps_attempt_time | [uint32](#uint32) | | How long should we try to get our position during each gps_update_interval attempt? (in seconds) Or if zero, use the default of 30 seconds. If we don't get a new gps fix in that time, the gps will be put into sleep until the next gps_update_rate window. | | ignore_incoming | [uint32](#uint32) | repeated | For testing it is useful sometimes to force a node to never listen to particular other nodes (simulating radio out of range). All nodenums listed in ignore_incoming will have packets they send droped on receive (by router.cpp) | diff --git a/mesh.proto b/mesh.proto index 581d81d..24a4624 100644 --- a/mesh.proto +++ b/mesh.proto @@ -516,20 +516,22 @@ message RadioConfig { /// offline (defaults to 3 - to allow for some lost packets) uint32 num_missed_to_fail = 3; - uint32 wait_bluetooth_secs = 4; // 0 for default of 1 minute - uint32 screen_on_secs = 5; // 0 for default of one minute - uint32 phone_timeout_secs = 6; // 0 for default of 15 minutes - uint32 phone_sds_timeout_sec = 7; // 0 for default of two hours, MAXUINT for disabled - uint32 mesh_sds_timeout_secs = 8; // 0 for default of two hours, MAXUINT for disabled - uint32 sds_secs = 9; // 0 for default of one year - uint32 ls_secs = 10; // 0 for default of 3600 - uint32 min_wake_secs = 11; // 0 for default of 10 seconds + uint32 wait_bluetooth_secs = 4; // Power management state machine option. See https://github.com/meshtastic/Meshtastic-device/blob/master/docs/software/power.md for details. 0 for default of 1 minute + uint32 screen_on_secs = 5; // Power management state machine option. See https://github.com/meshtastic/Meshtastic-device/blob/master/docs/software/power.md for details. 0 for default of one minute + uint32 phone_timeout_secs = 6; // Power management state machine option. See https://github.com/meshtastic/Meshtastic-device/blob/master/docs/software/power.md for details. 0 for default of 15 minutes + uint32 phone_sds_timeout_sec = 7; // Power management state machine option. See https://github.com/meshtastic/Meshtastic-device/blob/master/docs/software/power.md for details. 0 for default of two hours, MAXUINT for disabled + uint32 mesh_sds_timeout_secs = 8; // Power management state machine option. See https://github.com/meshtastic/Meshtastic-device/blob/master/docs/software/power.md for details. 0 for default of two hours, MAXUINT for disabled + uint32 sds_secs = 9; // Power management state machine option. See https://github.com/meshtastic/Meshtastic-device/blob/master/docs/software/power.md for details. 0 for default of one year + uint32 ls_secs = 10; // Power management state machine option. See https://github.com/meshtastic/Meshtastic-device/blob/master/docs/software/power.md for details. 0 for default of 3600 + uint32 min_wake_secs = 11; // Power management state machine option. See https://github.com/meshtastic/Meshtastic-device/blob/master/docs/software/power.md for details. 0 for default of 10 seconds /** If set, this node will try to join the specified wifi network and * acquire an address via DHCP */ string wifi_ssid = 12; + /** If set, will be use to authenticate to the named wifi */ string wifi_password = 13; + /** If set, the node will operate as an AP (and DHCP server), otherwise it * will be a station */ bool wifi_ap_mode = 14; @@ -539,7 +541,9 @@ message RadioConfig { /** Are we operating as a router. Changes behavior in the following ways: - FIXME + 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) */ bool is_router = 37; @@ -552,7 +556,6 @@ message RadioConfig { /** If set, this node is at a fixed position. We will generate GPS position updates at the regular interval, but use whatever the last lat/lon/alt we have for the node. - The lat/lon/alt can be set by an internal GPS or with the help of the app. */ bool fixed_position = 39; @@ -571,7 +574,15 @@ message RadioConfig { */ bool debug_log_enabled = 101; + /** + How our location is shared with other nodes (or the local phone) + */ LocationSharing location_share = 32; + + /** + How the GPS hardware in this unit is operated. + Note: This is independent of how our location is shared with other devices. For that see LocationSharing + */ GpsOperation gps_operation = 33; /** How often should we try to get GPS position (in seconds) when we are in GpsOpMobile mode?