diff --git a/mesh.proto b/mesh.proto index 5fdc5f1..f0fb50e 100644 --- a/mesh.proto +++ b/mesh.proto @@ -487,19 +487,21 @@ enum RegionCode { Note: This is independent of how our location is shared with other devices. For that see LocationSharing **/ enum GpsOperation { - // This is treated as GpsOpMobileSlow - it is the default settting + // This is treated as GpsOpMobile - it is the default settting GpsOpUnset = 0; + // Note: This mode was removed, because it is identical go GpsOpMobile with a gps_update_rate of once per day + // // This node is mostly stationary, we should try to get location only once per day, // Once we have that position we should turn the GPS to sleep mode // This is the recommendated configuration for stationary 'router' nodes - GpsOpStationary = 1; + // GpsOpStationary = 1; // This node is mobile and we should get GPS position at a rate governed by gps_update_rate GpsOpMobile = 2; // We should only use the GPS to get time (no location data should be acquired/stored) - // Once we have that position we should turn the GPS to sleep mode + // Once we have the time we treat gps_update_rate as MAXINT (i.e. sleep forever) GpsOpTimeOnly = 3; // GPS is always turned off - this mode is not recommended - use GpsOpTimeOnly instead @@ -563,8 +565,11 @@ message RadioConfig { LocationSharing location_share = 32; GpsOperation gps_operation = 33; - /// 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 30 seconds + /** 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 30 seconds + + or a very large value (maxint) to update only once at boot. + */ uint32 gps_update_rate = 34; /** How long should we try to get our position during each gps_update_rate attempt? (in seconds) @@ -675,7 +680,13 @@ message MyNodeInfo { /// of macaddr, but it will be fixed if that is already in use uint32 my_node_num = 1; - /// if false it would be great if the phone can help provide gps coordinates + /** + Note: this bool no longer means "we have our own GPS". Because gps_operation is more advanced, + but we'd like old phone apps to keep working. So for legacy reasons we set this flag as follows: + + if false it would be great if the phone can help provide gps coordinates. If true we don't need location + assistance from the phone. + */ bool has_gps = 2; /// # of legal channels (set at build time in the device flash image)