From 47d502b9c561ba0ac37a6c68fac9631eaca066a1 Mon Sep 17 00:00:00 2001 From: Ben Meadors Date: Sat, 26 Mar 2022 14:09:18 -0500 Subject: [PATCH 1/9] Split device and environment metrics --- telemetry.options | 4 +++ telemetry.proto | 69 ++++++++++++++++++++++++++++++++++------------- 2 files changed, 54 insertions(+), 19 deletions(-) create mode 100644 telemetry.options diff --git a/telemetry.options b/telemetry.options new file mode 100644 index 0000000..6c80df9 --- /dev/null +++ b/telemetry.options @@ -0,0 +1,4 @@ +# options for nanopb +# https://jpa.kapsi.fi/nanopb/docs/reference.html#proto-file-options + + diff --git a/telemetry.proto b/telemetry.proto index 03038a3..e9f1099 100644 --- a/telemetry.proto +++ b/telemetry.proto @@ -1,30 +1,30 @@ syntax = "proto3"; + +option java_package = "com.geeksville.mesh"; +option optimize_for = LITE_RUNTIME; option go_package = "github.com/meshtastic/gomeshproto"; +option java_outer_classname = "TelemetryProtos"; + /* - * TODO: REPLACE + * Key native device metrics such as battery level */ -message Telemetry { - - /* - * This is usually not sent over the mesh (to save space), but it is sent - * from the phone so that the local device can set its RTC If it is sent over - * the mesh (because there are devices on the mesh without GPS), it will only - * be sent by devices which has a hardware GPS clock (IE Mobile Phone). - * seconds since 1970 - */ - fixed32 time = 1; - +message DeviceMetrics { /* * 1-100 (0 means powered) */ - uint32 battery_level = 2; + uint32 battery_level = 1; + + /* + * Voltage measured + */ + float voltage = 2; /* * Utilization for the current channel, including well formed TX, RX and malformed RX (aka noise). */ float channel_utilization = 3; - + /* * Percent of airtime for transmission used within the last hour. */ @@ -35,34 +35,65 @@ message Telemetry { * and is not being sent as a reliable message. */ bool router_heartbeat = 5; +} +/* + * Weather station or other environmental metrics + */ +message EnvironmentMetrics { /* * Temperature measured */ - float temperature = 6; + float temperature = 1; /* * Relative humidity percent measured */ - float relative_humidity = 7; + float relative_humidity = 2; /* * Barometric pressure in hPA measured */ - float barometric_pressure = 8; + float barometric_pressure = 3; /* * Gas resistance in mOhm measured */ - float gas_resistance = 9; + float gas_resistance = 4; /* * Voltage measured */ - float voltage = 10; + float voltage = 10; /* * Current measured */ float current = 11; } + +/* + * Types of Measurements the telemetry module is equipped to handle + */ +message Telemetry { + /* + * This is usually not sent over the mesh (to save space), but it is sent + * from the phone so that the local device can set its RTC If it is sent over + * the mesh (because there are devices on the mesh without GPS), it will only + * be sent by devices which has a hardware GPS clock (IE Mobile Phone). + * seconds since 1970 + */ + fixed32 time = 1; + + oneof variant { + /* + * Key native device metrics such as battery level + */ + DeviceMetrics device_metrics = 2; + + /* + * Weather station or other environmental metrics + */ + EnvironmentMetrics environment_metrics = 3; + } +} From 8ea037476d2ca31a08c553a6a59f0e5249681d08 Mon Sep 17 00:00:00 2001 From: Ben Meadors Date: Sat, 26 Mar 2022 14:25:48 -0500 Subject: [PATCH 2/9] Distinct prefs for environment and device --- radioconfig.proto | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/radioconfig.proto b/radioconfig.proto index 8a46c6e..f4fc151 100644 --- a/radioconfig.proto +++ b/radioconfig.proto @@ -741,29 +741,29 @@ message RadioConfig { reserved 136; /* - * Preferences for the Teletry Module + * Preferences for the Telemetry Module (Environment) * FIXME - Move this out of UserPreferences and into a section for module configuration. * Enable/Disable the telemetry measurement module measurement collection */ - bool telemetry_module_measurement_enabled = 140; + bool telemetry_module_environment_measurement_enabled = 140; /* * Enable/Disable the telemetry measurement module on-device display */ - bool telemetry_module_screen_enabled = 141; + bool telemetry_module_environment_screen_enabled = 141; /* * Sometimes sensor reads can fail. * If this happens, we will retry a configurable number of attempts, * each attempt will be delayed by the minimum required refresh rate for that sensor */ - uint32 telemetry_module_read_error_count_threshold = 142; + uint32 telemetry_module_environment_read_error_count_threshold = 142; /* * Interval in seconds of how often we should try to send our * measurements to the mesh */ - uint32 telemetry_module_update_interval = 143; + uint32 telemetry_module_device_update_interval = 143; /* * Sometimes we can end up with more than read_error_count_threshold failures. @@ -968,6 +968,12 @@ message RadioConfig { * Overrides the ADC_MULTIPLIER defined in variant for battery voltage calculation. */ float adc_multiplier_override = 175; + + /* + * Interval in seconds of how often we should try to send our + * environent measurements to the mesh + */ + uint32 telemetry_module_environment_update_interval = 176; } /* From e3b2aeab5047f77fe3e72aa8637aee6b8b70e91d Mon Sep 17 00:00:00 2001 From: Ben Meadors Date: Sat, 26 Mar 2022 14:30:35 -0500 Subject: [PATCH 3/9] Spacing --- telemetry.proto | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/telemetry.proto b/telemetry.proto index e9f1099..f1dbb68 100644 --- a/telemetry.proto +++ b/telemetry.proto @@ -18,7 +18,7 @@ message DeviceMetrics { /* * Voltage measured */ - float voltage = 2; + float voltage = 2; /* * Utilization for the current channel, including well formed TX, RX and malformed RX (aka noise). @@ -64,7 +64,7 @@ message EnvironmentMetrics { /* * Voltage measured */ - float voltage = 10; + float voltage = 10; /* * Current measured From 17795f9be786b1a7a09d49e9d64a5cb434de0b09 Mon Sep 17 00:00:00 2001 From: Ben Meadors Date: Sat, 26 Mar 2022 14:34:37 -0500 Subject: [PATCH 4/9] Space --- radioconfig.proto | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/radioconfig.proto b/radioconfig.proto index f4fc151..ebe587c 100644 --- a/radioconfig.proto +++ b/radioconfig.proto @@ -973,7 +973,7 @@ message RadioConfig { * Interval in seconds of how often we should try to send our * environent measurements to the mesh */ - uint32 telemetry_module_environment_update_interval = 176; + uint32 telemetry_module_environment_update_interval = 176; } /* From 4fb1330c73e5ae05cb9d97448e66c9a308c771c0 Mon Sep 17 00:00:00 2001 From: Ben Meadors Date: Sat, 26 Mar 2022 14:41:53 -0500 Subject: [PATCH 5/9] Reindex values --- telemetry.proto | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/telemetry.proto b/telemetry.proto index f1dbb68..82be278 100644 --- a/telemetry.proto +++ b/telemetry.proto @@ -64,12 +64,12 @@ message EnvironmentMetrics { /* * Voltage measured */ - float voltage = 10; + float voltage = 5; /* * Current measured */ - float current = 11; + float current = 6; } /* From dd0b91ffbb3602949e8f85dacfb43cb3b99f2e80 Mon Sep 17 00:00:00 2001 From: Ben Meadors Date: Sat, 26 Mar 2022 15:16:09 -0500 Subject: [PATCH 6/9] Remove router heartbeat --- telemetry.proto | 6 ------ 1 file changed, 6 deletions(-) diff --git a/telemetry.proto b/telemetry.proto index 82be278..1c36be7 100644 --- a/telemetry.proto +++ b/telemetry.proto @@ -29,12 +29,6 @@ message DeviceMetrics { * Percent of airtime for transmission used within the last hour. */ float air_util_tx = 4; - - /* - * This is sent by node only if it a router and if hop_limit is set to 0 - * and is not being sent as a reliable message. - */ - bool router_heartbeat = 5; } /* From 8f33fbdb26ee5c45118746944ca3386fcc838dd5 Mon Sep 17 00:00:00 2001 From: Ben Meadors Date: Sat, 26 Mar 2022 17:49:01 -0500 Subject: [PATCH 7/9] Fixed conflict --- radioconfig.proto | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/radioconfig.proto b/radioconfig.proto index ebe587c..1bf4582 100644 --- a/radioconfig.proto +++ b/radioconfig.proto @@ -973,7 +973,7 @@ message RadioConfig { * Interval in seconds of how often we should try to send our * environent measurements to the mesh */ - uint32 telemetry_module_environment_update_interval = 176; + uint32 telemetry_module_environment_update_interval = 177; } /* From 76d4e35fe4c7b9f226e63ad28c4ea3688090981d Mon Sep 17 00:00:00 2001 From: Ben Meadors Date: Sat, 26 Mar 2022 18:01:42 -0500 Subject: [PATCH 8/9] Environment rename --- radioconfig.proto | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/radioconfig.proto b/radioconfig.proto index 1bf4582..5c13e4e 100644 --- a/radioconfig.proto +++ b/radioconfig.proto @@ -770,13 +770,13 @@ message RadioConfig { * In this case, we will stop trying to read from the sensor for a while. * Wait this long until trying to read from the sensor again */ - uint32 telemetry_module_recovery_interval = 144; + uint32 telemetry_module_environment_recovery_interval = 144; /* * We'll always read the sensor in Celsius, but sometimes we might want to * display the results in Fahrenheit as a "user preference". */ - bool telemetry_module_display_fahrenheit = 145; + bool telemetry_module_environment_display_fahrenheit = 145; /* * TODO: REPLACE @@ -835,12 +835,12 @@ message RadioConfig { /* * Specify the sensor type */ - TelemetrySensorType telemetry_module_sensor_type = 146; + TelemetrySensorType telemetry_module_environment_sensor_type = 146; /* * Specify the peferred GPIO Pin for sensor readings */ - uint32 telemetry_module_sensor_pin = 147; + uint32 telemetry_module_environment_sensor_pin = 147; /* * Bit field of boolean configuration options for POSITION messages From 0a4e99a151eca110995c5e39acbc9394b0b98b44 Mon Sep 17 00:00:00 2001 From: Ben Meadors Date: Sun, 27 Mar 2022 08:06:19 -0500 Subject: [PATCH 9/9] Comment distinction --- mesh.proto | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mesh.proto b/mesh.proto index 8e6a4ec..30aaffe 100644 --- a/mesh.proto +++ b/mesh.proto @@ -1053,7 +1053,7 @@ message NodeInfo { */ fixed32 last_heard = 5; /* - * The latest telemetry data for the node. + * The latest device telemetry data for the node. */ Telemetry telemetry = 6; }