Skip to content

Commit

Permalink
docs: variable documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ihagad committed Nov 22, 2024
1 parent bda7f59 commit dcc9f0e
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions src/cellular/dataCollection.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down

0 comments on commit dcc9f0e

Please sign in to comment.