nasa / nasa/sample_app

sample_app should have a clearly-defined "publish telemetry" function

Open
#39 0 comments 0 reactions 1 assignee View on GitHub

@CDKnightNASA is already working on this.

Since Feb 10, 2020.

enhancement
Dominant language
C
Stars
67
Forks
60
PR merge metrics
No merged PRs in 30d

Description

Is your feature request related to a problem? Please describe.
I'd venture most folks who look at the sample_app code are looking to read some data from a sensor/instrument and publish the telemetry onto the software bus. The current code does not make it clear where such code would go...I'd venture it'd go in "ProcessCC()"? In fact, the only call to CFE_SB_SendMsg() is in ReportHousekeeping() function.

Describe the solution you'd like
The Sample App demonstrates reading from a table and calling a library, perhaps a call to a library function that iterates through an array (provided by a table) of values and publishes the next one on each command received?

Needless to say, a big comment block stating "add your code here" would be appropriate. The ProcessCC() function really has no documentation in the comments as to what it does.

Describe alternatives you've considered
I think some folks on the CCB consider the sample app to not be a skeleton for a real application. If that is the intent, it should be made more clear in the sample_app.c file and the README.md, and it would be appropriate to have a separate skeleton app for folks to start developing from. (In fact, such a skeleton would be a nice source for developers to fork from, and any major framework changes could be made in the skeleton and folks would see the change when they fetch from their upstreams.)

Additional context
Add any other context about the feature request here.

Requester Info
Christopher.D.Knight@nasa.gov

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.