This repository was archived by the owner on Jan 28, 2021. It is now read-only.
Added constant descriptions and added new constants for future use #66
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Here are some small additions and expansions to the constants in the .h file, something I've been meaning to do for a while. Most of the descriptions are taken directly from the ZED-F9P Interface Description document or the NEO-M9N Interface Description document from u-blox.
I was unable to figure out how to insert links to highlighted sections of the code, so I have put line numbers from my code as a replacement. Hopefully they are sufficient.
Some constants may appear to have been deleted. They have been moved to their appropriate sections based on their contents (all UBX_CFG placed together, all UBX_CLASS placed together, etc.). If this format does not work, just let me know.
The first change (line 106-121) simply adds descriptions of the constants of the UBX Class IDs (UBX_CLASS). Useful to explain the abbreviations/short hand constants. Descriptions taken from ZED-F9P Interface Description: 5.6 UBX Class IDs.
The second change (line 123-153) adds descriptions of constants used for configuration (UBX_CFG). It also adds additional CFG messages that may not yet be implemented/needed. Listings and descriptions taken from ZED-F9P Interface Description: 5.7 UBX Messages Overview and NEO-M9N Interface Description: 3.8 UBX messages overview. Some messages appear in one or the other or both, depending on it they are usable by said GPS module.
The third change (line 155-185) adds descriptions of NMEA messages and also adds additional NMEA messages not yet defined in this library. Descriptions taken from ZED-F9P Interface Description: 4.1.8 Messages Overview. If the extra messages are not necessary as new constants, they can easily be removed. This change also adds some constants that, in the future once implemented (future PR by me hopefully), will allow the library to change the NMEA Talker ID (GPS, GLONASS, BeiDou, etc.).
The fourth change (line 195-296) adds constants and descriptions for the rest of the UBX messages listed in the ZED-F9P Interface Description: 5.7 UBX Messages Overview document. Most do not already exist in the library and may be excessive/never used by the user. But they may be useful for future development. Feel free to remove any ones you feel are excessive. I added these as I was already going through some of the existing UBX messages adding descriptions. Some of the UBX messages that appear to be deleted will most likely have been moved to their appropriate section in this block of new code.
The fifth and final change (line 356-367) adds descriptions for the dynamic platform model. Changing the dynamic platform model was a function I had planned to put into a PR, but it looks like someone beat me to it! Instead I will just add descriptions for the dynamic platform model options. Descriptions are taken from the ZED-F9P Integration Manual 3.1.7: Navigation configuration document.
As always, feedback on my work is greatly appreciated. Hopefully this PR provides useful info and not too much excessive info. Also hope that this PR is better than my previous PR months ago, which was just a confusing mess of code from someone who had no idea how to contribute :)