Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: added docs to dataCollection.hpp #139

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

charliekush
Copy link
Contributor

No description provided.

@@ -8,6 +8,9 @@

#include "Particle.h"

/**
* @brief struct for holding 10 measurements to upload
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is incorrect. This is the Ensemble 10 state/accumulation structure

@@ -20,9 +23,15 @@ typedef struct Ensemble10_eventData_
uint32_t accumulateCount;
}Ensemble10_eventData_t;

/**
* @brief staic variable for 10 measurements
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is incorrect. This is the Ensemble 10 state/accumulation data.

static Ensemble10_eventData_t ensemble10Data;


/**
* @brief collects data with 10 measurmenets for upload
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is incorrect. This is the implementation of Ensemble 10.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: src/cellular/dataCollection.cpp:11: error: Compound Ensemble10_eventData_ is not documented.
2 participants