docs: variable documentation #134
Conversation
| 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 |
There was a problem hiding this comment.
Does this mean that if acc has the value {1, 0, 0}, I should interpret this as [0.000059, 0, 0] g's of acceleration?
Conversely, should I expect [1, 0, 0] g's of acceleration to be represented at {16834, 0, 0}?
There was a problem hiding this comment.
when you specify this, please add units for the real-world value so that it is unambiguously the real-world value vs the stored representation.
There was a problem hiding this comment.
This ends up being confusing - are we stating that the values as stored in memory are directly interpretable as G's of acceleration?
Additionally, in line 26, I think you have the wrong constant.
One suggested wording might be this:
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.
Consider updating the other field documentation to be similar.
src/cellular/dataCollection.cpp
Outdated
| * @brief Indicates if GNSS point is locked and more than 4 point | ||
| * satellites in view |
There was a problem hiding this comment.
Is the set of possible values [0, 1]? If so, what does each value mean?
| 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 |
There was a problem hiding this comment.
when you specify this, please add units for the real-world value so that it is unambiguously the real-world value vs the stored representation.
| 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 |
There was a problem hiding this comment.
This ends up being confusing - are we stating that the values as stored in memory are directly interpretable as G's of acceleration?
Additionally, in line 26, I think you have the wrong constant.
One suggested wording might be this:
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.
Consider updating the other field documentation to be similar.
No description provided.