nasa / nasa/EdsLib

Simple idiomatic usage example documentation?

Open
#87 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation question
Dominant language
C
Stars
43
Forks
19
Avg merge
3d 20h
Merged PRs (30d)
2

Description

Is your feature request related to a problem? Please describe.
Have been looking to get up to speed on this, and am trying to ensure I am using the tool idiomatically. (in C)

Have had a look at the doxygen docs and markdown documentation, but have not been able to find a minimal example of usage, I am just minimally trying to accomplish, reading an eds type from the network, unpacking to the unpacked type, and the opposite direction.

Also, have noticed that some of the doxygen docs may be out of date. Eg,
in: .../group__fsw.html#build

eds_start_toplevel(TOPLEVEL_TGT)

Have looked all over github, and can't see any usage of this this, outside of inside the doxygen docs

I do see this in:

.../group__fsw.html#build

"

Example statically linked embeded C application

The statically linked embedded application is nearly identical to the ground application, except it has no need for the user-friendly name information. Therefore it can leave out the SAMPLE_EDS_NAMEDICT_APPTBL object:

/*
 * Instantiate an EDS global object that brings all elements together
 */
EdsLib_MissionObject_t SAMPLE_EDS =
{
      .AppTableSize = SAMPLE_EDS_INDEX_MAX,
      .AppDataTable = SAMPLE_EDS_DATADICT_APPTBL
};

"
But this stops just short of further usage, which is the part that personally, I have been struggling to ensure I am using the tool right.

Describe the solution you'd like
Wondering if there could be a short section showing idiomatic usage. I realize, there is a chance without something like this, one might be able to accomplish usage of the database types, but perhaps not performed in the intended manner.

I realize, probably a bunch of docs might be too much overhead for this, but figure, an idiomatic simple example easily accessible might be pretty useful

But gotta say, been loving the tool, thanks for all the work you all have done! Really excited about the SOIS SEDS standard.
Thanks!

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start with the Doxygen fsw build section (group__fsw.html#build), the existing statically linked embedded C application example, and the related Markdown documentation. Trace the documented path for reading an EDS type from the network, unpacking it, and performing the reverse operation; done means a short idiomatic example covers both directions and the cited documentation is current.

Written by the indexing model from the issue text.

Assessment

Tech stack
c
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.