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

Updated YAML descriptions. #59

Merged
merged 1 commit into from
Mar 31, 2015
Merged

Updated YAML descriptions. #59

merged 1 commit into from
Mar 31, 2015

Conversation

mookerji
Copy link
Contributor

  1. Clarifies and adds some field and message descriptions that were previously missing.
  2. Adds short_desc messages where they were previously missing.
  3. Refactors some messages in piksi.yaml into separate modules reflecting
    hierarchy in piksi_firmware.

Replaces #58 . Closes #45 .

TODO:

  • Finish describing piksi.yaml message fields.
  • Copyedit.

/cc @mfine @denniszollo @cbeighley @soulcmdc

@mookerji mookerji self-assigned this Mar 30, 2015
@mookerji mookerji added this to the libsbp release milestone Mar 30, 2015
@mookerji mookerji changed the title WIP! Updated YAML descriptions. Updated YAML descriptions. Mar 31, 2015
Results of an attempted GPS signal acquisition. Contains the
parameters of the point in the acquisition search space with the
best signal-to-noise ratio.
This message describes the results from an attempted GPS signal
Copy link
Contributor Author

Choose a reason for hiding this comment

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

attempted => successful

Copy link
Contributor

Choose a reason for hiding this comment

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

Attempted is correct. The message is sent even if the SNR is below the acceptable threshold. Should this be changed in the firmware?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Nope.

@mfine
Copy link
Contributor

mfine commented Mar 31, 2015

Quick note here: the public tag as currently working, is applied to both the package and the definition - if you want to get a message documented, it needs to be public: True at both the package level and the message level.

# THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
# EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Add public

0. Clarifies and adds some field and message descriptions that were
previously missing.
1. Adds short_desc messages where they were previously missing.
2. Refactors some messages in piksi.yaml into separate modules
reflecting hierarchy in piksi_firmware.

/cc @mfine @denniszollo @cbeighley
@mookerji
Copy link
Contributor Author

sgtc (sounds good to @cbeighley ).

mookerji added a commit that referenced this pull request Mar 31, 2015
@mookerji mookerji merged commit 9c5b9e2 into swift-nav:master Mar 31, 2015
Earth Centered Earth Fixed (ECEF) coordinates and the status
(single point absolute vs RTK) of the position solution. If the
rover receiver knows the single-point point position of the base
station and has an RTK solution, this reports a pseudo-absolute
Copy link
Contributor

Choose a reason for hiding this comment

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

This should say "Surveyed position of the base station". The user has to know an accurate position of the base station in order for the absolute RTK positions to be correspondingly accurate.

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.

Update documentation descriptions and payload info for various piksi.yaml messages.
5 participants