From dcc9f0ef0b1b976cb777e0609475fe5524cb98e0 Mon Sep 17 00:00:00 2001 From: Iha Date: Thu, 21 Nov 2024 17:05:51 -0800 Subject: [PATCH 1/5] 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/5] 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]; /** From 6e842b0e50e94150378e4c9bed28cbe85fa40a22 Mon Sep 17 00:00:00 2001 From: Iha Date: Tue, 7 Jan 2025 08:30:24 -0800 Subject: [PATCH 3/5] docs: variable doc changes --- src/cellular/dataCollection.cpp | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/src/cellular/dataCollection.cpp b/src/cellular/dataCollection.cpp index 46e8a62c..6de83528 100644 --- a/src/cellular/dataCollection.cpp +++ b/src/cellular/dataCollection.cpp @@ -24,6 +24,9 @@ typedef struct Ensemble10_eventData_ /** * @brief Array saving average of the accumulated accelerometer data on the * x, y, and z axis in g scaled up by 16834 + * + * Values {1, 0, 0} would have an array value of [0.000061, 0, 0] + * Values {16384, 0, 0} so the array values would be [1, 0, 0] */ int32_t acc[3]; /** @@ -43,8 +46,12 @@ typedef struct Ensemble10_eventData_ */ int32_t location[2]; /** - * @brief Indicates if GNSS point is locked and more than 4 point + * @brief Indicates if GNSS point is locked and more than 4 point * satellites in view + * + * All possible values are [0,1]: + * 0 - less than 4 point satellites are in view thus GNSS point is not locked + * 1 - 4 or more point satellites are in view thus GNSS point is locked */ uint8_t hasGPS; /** From 401d77873b780026782e321fc2673840be77909f Mon Sep 17 00:00:00 2001 From: Iha Date: Tue, 7 Jan 2025 13:18:18 -0800 Subject: [PATCH 4/5] docs: fix variable docs --- src/cellular/dataCollection.cpp | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/cellular/dataCollection.cpp b/src/cellular/dataCollection.cpp index 6de83528..718ee7ef 100644 --- a/src/cellular/dataCollection.cpp +++ b/src/cellular/dataCollection.cpp @@ -25,8 +25,10 @@ typedef struct Ensemble10_eventData_ * @brief Array saving average of the accumulated accelerometer data on the * x, y, and z axis in g scaled up by 16834 * - * Values {1, 0, 0} would have an array value of [0.000061, 0, 0] - * Values {16384, 0, 0} so the array values would be [1, 0, 0] + * Values {1, 0, 0} would have an array value of [0.000061g, 0g, 0g] + * Values {16384, 0, 0} so the array values would be [1g, 0g, 0g] + * + * g is approximately equal to 9.81 m/s^2 */ int32_t acc[3]; /** From 08475cb6cd7813fa405b96b2c4cc3ba0fab3bd88 Mon Sep 17 00:00:00 2001 From: Iha Date: Mon, 13 Jan 2025 10:38:51 -0800 Subject: [PATCH 5/5] docs: variable documentation fixes --- src/cellular/dataCollection.cpp | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/src/cellular/dataCollection.cpp b/src/cellular/dataCollection.cpp index 718ee7ef..74d7690a 100644 --- a/src/cellular/dataCollection.cpp +++ b/src/cellular/dataCollection.cpp @@ -23,22 +23,29 @@ typedef struct Ensemble10_eventData_ int32_t water; /** * @brief Array saving average of the accumulated accelerometer data on the - * x, y, and z axis in g scaled up by 16834 + * x, y, and z axis such that acc[i] = acceleration[i] * 16384, where + * `acceleration` is the acceleration in G's (multiple of Earth gravity), + * and acc is the stored representation, stored as `int32_t`.Thus, acc[i] = + * 16384 = 1 G. * - * Values {1, 0, 0} would have an array value of [0.000061g, 0g, 0g] - * Values {16384, 0, 0} so the array values would be [1g, 0g, 0g] - * - * g is approximately equal to 9.81 m/s^2 + * G is approximately equal to 9.81 m/s^2 */ int32_t acc[3]; /** * @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 + * on the x, y, and z axis such that ang[i] = angular_velocity * 131.072, + * where 'angular_velocity' is the angular velocity in degrees per second and + * ang is the stored representation, stored as `int32_t`. Thus, ang[i] = + * 131.072 = 1 degree/second + * */ int32_t ang[3]; /** * @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. + * data on the x, y, and z axis in mag[i] = magnetic_field/0.15, + * where 'magnetic_field' is the magnetic_field in uT and + * mag is the stored representation, stored as `int32_t`. Thus, mag[i] = + * 1 = 0.15 degree/second * */ int32_t mag[3];