From dcc9f0ef0b1b976cb777e0609475fe5524cb98e0 Mon Sep 17 00:00:00 2001 From: Iha Date: Thu, 21 Nov 2024 17:05:51 -0800 Subject: [PATCH 1/2] docs: variable documentation --- src/cellular/dataCollection.cpp | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/src/cellular/dataCollection.cpp b/src/cellular/dataCollection.cpp index 814423ba..b0a39f66 100644 --- a/src/cellular/dataCollection.cpp +++ b/src/cellular/dataCollection.cpp @@ -10,13 +10,44 @@ typedef struct Ensemble10_eventData_ { + /** + * @brief Temperature value of the water in Celsius provided + * by the temperature sensor + */ double temperature; + /** + * @brief Indicates how much of the water sensor is in water + * + * water = 0 indicates water sensor being dry + */ int32_t water; + /** + * @brief Array saving processed accelerometer data on the x, y, and z axis + */ int32_t acc[3]; + /** + * @brief Array of length 3 saving processed gyroscope data on the x, y, and + * z axis + */ int32_t ang[3]; + /** + * @brief Array of length 3 saving processed magnetometer data on the x, y, + * and z axis + */ int32_t mag[3]; + /** + * @brief Array of length 2 saving latitude and longitude values of the + * point at which data was collected + */ int32_t location[2]; + /** + * @brief Indicates if GNSS point is locked and more than 4 point + * satellites in view + */ uint8_t hasGPS; + /** + * @brief Number of times measurements gathered + */ uint32_t accumulateCount; }Ensemble10_eventData_t; From db88da8a665a93bb806f7db6fbdd73578aeae395 Mon Sep 17 00:00:00 2001 From: Iha Date: Thu, 19 Dec 2024 13:39:24 -0800 Subject: [PATCH 2/2] docs: data collection variable doc updates --- src/cellular/dataCollection.cpp | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/src/cellular/dataCollection.cpp b/src/cellular/dataCollection.cpp index b0a39f66..5a70abc4 100644 --- a/src/cellular/dataCollection.cpp +++ b/src/cellular/dataCollection.cpp @@ -11,33 +11,35 @@ typedef struct Ensemble10_eventData_ { /** - * @brief Temperature value of the water in Celsius provided + * @brief Average temperature value of the water in Celsius provided * by the temperature sensor */ double temperature; /** - * @brief Indicates how much of the water sensor is in water - * - * water = 0 indicates water sensor being dry + * @brief Truncated average of whether or not system in water over + * accumulation period + * */ int32_t water; /** - * @brief Array saving processed accelerometer data on the x, y, and z axis + * @brief Array saving average of the accumulated accelerometer data on the + * x, y, and z axis in g scaled up by 16834 */ int32_t acc[3]; /** - * @brief Array of length 3 saving processed gyroscope data on the x, y, and - * z axis + * @brief Array of length 3 saving average of the accumulated gyroscope data + * on the x, y, and z axis in degrees per second scaled up by 131.072 */ int32_t ang[3]; /** - * @brief Array of length 3 saving processed magnetometer data on the x, y, - * and z axis + * @brief Array of length 3 saving average of the accumulated magnetometer + * data on the x, y, and z axis in uT scaled down by 0.15. + * */ int32_t mag[3]; /** - * @brief Array of length 2 saving latitude and longitude values of the - * point at which data was collected + * @brief Array of length 2 saving latitude and longitude values, multiplied + * by 1e6, of the point at which data was collected */ int32_t location[2]; /**