Skip to content

Commit

Permalink
docs: variable doc changes
Browse files Browse the repository at this point in the history
  • Loading branch information
ihagad committed Jan 7, 2025
1 parent b2b99ab commit 6e842b0
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion src/cellular/dataCollection.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -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];
/**
Expand All @@ -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;
/**
Expand Down

0 comments on commit 6e842b0

Please sign in to comment.