search

mavlink / qgc-dev-guide

QGroundControl Developers Guide
https://dev.qgroundcontrol.com/en/
Other
42 stars 51 forks source link

Update plan file format docs #43

Closed hamishwillee closed 6 years ago

hamishwillee commented 6 years ago

@DonLakeFlyer This moves the file format doc update discussed in https://github.com/mavlink/mavlink-devguide/pull/89/files to QGC. It is WIP - there will be comments inlines.

  1. [x] Deleted the separate/old geofence/rally docs.
  2. You said that there is just one plan doc which includes rally, geofence and missions. I assume that even though these are uploaded together, the rally points and geofence will operate outside of a mission if they are triggered (e.g. by a failsafe)?
  3. Other questions inline.
DonLakeFlyer commented 6 years ago

You said that there is just one plan doc which includes rally, geofence and missions. I assume that even though these are uploaded together, the rally points and geofence will operate outside of a mission if they are triggered (e.g. by a failsafe)?

That is correct.

DonLakeFlyer commented 6 years ago

Current docs split rally and geofence format. I have not done that in this PR and will delete those docs unless you want them split up (?)

I think that makes sense. With older builds prior to .plan filee format there were separate files for fence/rally.

hamishwillee commented 6 years ago

@DonLakeFlyer OK, I have:

I will also delete the survey scan doc.

  1. Is there anything you want to capture from it?

This has lots of ? marking items I do not know. Most of the fields do not include units.

  1. What is the best way to get them filled in?

    • I push this to the main repo so you can edit directly?
    • Or should we just submit as is and you update the missing fields when you have time?
    • Something else?

  2. This will be hard to maintain. It would be better if we generated docs on-the-fly.

    • Does the system already contain docs for the fields/strings used?
    • if so, I know JSON does not support comments, but for the purpose of data export, might we allow developers to export a version with / comments / after every field from source or field definitions? That would make it easier to keep in step with code.
    • Better ideas?

Essentially, I'm about as far as I can reasonably go with this for now. How do you want to proceed?

DonLakeFlyer commented 6 years ago

Or should we just submit as is and you update the missing fields when you have time?

I think that's the best choice.

It would be better if we generated docs on-the-fly.

Would be nice, but not really possible given current coding.

hamishwillee commented 6 years ago

Thanks @DonLakeFlyer . OK, merging. I removed the survey doc (now part of plan). As discussed, this is now ready for you to update fields etc, "as you will"