From f1182cdbb216ab06b106edd610e8548c6413e3eb Mon Sep 17 00:00:00 2001 From: Jonathan Hudson Date: Fri, 12 Nov 2021 15:12:44 +0000 Subject: [PATCH] tidy up mission file XSD and improve documentation (#7594) * tidy up mission file XSD and improve documentation * tidy up mission file XSD and improve documentation --- docs/development/wp_mission_schema/README.md | 44 +++--- .../wp_mission_schema/mw-mission.xsd | 149 +++++++++--------- 2 files changed, 99 insertions(+), 94 deletions(-) diff --git a/docs/development/wp_mission_schema/README.md b/docs/development/wp_mission_schema/README.md index 850c6fe055..4c458632ae 100644 --- a/docs/development/wp_mission_schema/README.md +++ b/docs/development/wp_mission_schema/README.md @@ -8,52 +8,54 @@ The format is defined the XSD schema here. * Lower case tags are preferred by inav. Older tools may prefer uppercase (the original MW usage). * For inav 4.0 and later, the `missionitem/flags` attribute is required for "fly-by home" waypoints and multi-mission files. -* For inav 4.0 and later, multi-mission files; mission segments are delimited by a flag value of `165` (the MSP protocol value). -* For multi-mission files, the waypoints may be numbered either sequentially across the whole file, or "reset-numbering" within each mission segment. The latter may (or not) be considered to be more "human readable". -* The `mwp` tag was introduced by the eponymous mission planner. Other mission planners may consider that reusing some of the tags (`cx`, `cy` - centre location, `zoom` TMS zoom level) is useful. +* For inav 4.0 and later, multi-mission files; mission segments are delimited by a flag value of `165` (the MSP protocol 'last WP' value). +* For multi-mission files, the waypoints may be numbered either sequentially across the whole file, or "reset-numbering" within each mission segment. The latter may (or not) be considered to be more "human readable", particularly where `JUMP` is used. +* The `mwp` tag was introduced by the eponymous mission planner. Other mission planners may consider that reusing some of the tags (`cx`, `cy` - centre location, `zoom` TMS zoom level, `home-x`, `home-y` - home location) is useful. +* `meta` may be used as a synonym for `mwp`. * The `version` tag may be intepreted by mission planners as they see fit. For example, the (obsolete) Android 'ez-gui' application requires '2.3-pre8'. For multi-mission files it is recommended to use another `version`. +* the `mwp` / `meta` element may be interleaved with `missionitem` in a multi-mission file to provide mission segment specific home, centre locations and zoom. ## Examples ### Multi-mission file with sequential numbering ``` - + - - - - - - - - - - - - + + + + + + + + + + + + ``` -### Multi-mission file with "reset" numbering and per-segment metadata +### Multi-mission file with "reset" numbering and per-segment metadata with `meta` tag ``` -
+
-
+
- -
+ +
``` diff --git a/docs/development/wp_mission_schema/mw-mission.xsd b/docs/development/wp_mission_schema/mw-mission.xsd index 667cc1027f..acc34b2049 100644 --- a/docs/development/wp_mission_schema/mw-mission.xsd +++ b/docs/development/wp_mission_schema/mw-mission.xsd @@ -1,15 +1,18 @@ - - + + - - + + + + @@ -18,7 +21,56 @@ - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -26,40 +78,42 @@ + - - + - + - - - - + + + + - - - - + + + + + + - + - + @@ -74,59 +128,8 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + -