[messages] possibility to add descriptions

paparazzi · Nov 26, 2014 · fe02983 · fe02983
1 parent 1e21302
commit fe02983
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 7 deletions.
diff --git a/conf/messages.dtd b/conf/messages.dtd
@@ -6,14 +6,16 @@
   name CDATA #REQUIRED
 >
 
-<!ELEMENT message (field*)>
+<!ELEMENT message (description?,field*)>
 <!ATTLIST message
   name CDATA #REQUIRED
   id   CDATA #REQUIRED
   link CDATA #IMPLIED
 >
 
-<!ELEMENT field EMPTY>
+<!ELEMENT description (#PCDATA)>
+
+<!ELEMENT field (#PCDATA)>
 <!ATTLIST field
   name CDATA #REQUIRED
   type CDATA #REQUIRED

diff --git a/conf/messages.xml b/conf/messages.xml
@@ -9,10 +9,12 @@
    </message>
 
    <message name="ALIVE" id="2">
+     <description>alive/heartbeat message containing the MD5sum of the aircraft configuration</description>
      <field name="md5sum" type="uint8[]"/>
    </message>
 
    <message name="PONG" id="3">
+     <description>Answer to PING datalink message, to measure latencies</description>
    </message>
 
    <message name="TAKEOFF" id="4">
@@ -70,8 +72,8 @@
      <field name="utm_east"   type="int32"  unit="cm" alt_unit="m"/>
      <field name="utm_north"  type="int32"  unit="cm" alt_unit="m"/>
      <field name="course"     type="int16"  unit="decideg" alt_unit="deg"/>
-     <field name="alt"        type="int32"  unit="mm" alt_unit="m"/>
-     <field name="speed"      type="uint16" unit="cm/s" alt_unit="m/s"/>
+     <field name="alt"        type="int32"  unit="mm" alt_unit="m">Altitude above geoid (MSL)</field>
+     <field name="speed"      type="uint16" unit="cm/s" alt_unit="m/s">norm of 2d ground speed in cm/s</field>
      <field name="climb"      type="int16"  unit="cm/s" alt_unit="m/s"/>
      <field name="week"       type="uint16" unit="weeks"/>
      <field name="itow"       type="uint32" unit="ms"/>
@@ -471,7 +473,7 @@
   <message name="GPS_LLA" id="59">
     <field name="lat"        type="int32"  unit="1e7deg" alt_unit="deg" alt_unit_coef="0.0000001"/>
     <field name="lon"        type="int32"  unit="1e7deg" alt_unit="deg" alt_unit_coef="0.0000001"/>
-    <field name="alt"        type="int32"  unit="mm" alt_unit="m"/>
+    <field name="alt"        type="int32"  unit="mm" alt_unit="m">altitude above WGS84 reference ellipsoid</field>
     <field name="course"     type="int16"  unit="decideg" alt_unit="deg"/>
     <field name="speed"      type="uint16" unit="cm/s" alt_unit="m/s"/>
     <field name="climb"      type="int16"  unit="cm/s" alt_unit="m/s"/>
@@ -1384,8 +1386,8 @@
     <field name="ecef_z"  type="int32" unit="cm"   alt_unit="m"/>
     <field name="lat"     type="int32" unit="1e7deg" alt_unit="deg" alt_unit_coef="0.0000001"/>
     <field name="lon"     type="int32" unit="1e7deg" alt_unit="deg" alt_unit_coef="0.0000001"/>
-    <field name="alt"     type="int32" unit="mm"   alt_unit="m"/>
-    <field name="hmsl"    type="int32" unit="mm"   alt_unit="m"/>
+    <field name="alt"     type="int32" unit="mm"   alt_unit="m">altitude above WGS84 reference ellipsoid</field>
+    <field name="hmsl"    type="int32" unit="mm"   alt_unit="m">height above mean sea level (geoid)</field>
     <field name="ecef_xd" type="int32" unit="cm/s" alt_unit="m/s"/>
     <field name="ecef_yd" type="int32" unit="cm/s" alt_unit="m/s"/>
     <field name="ecef_zd" type="int32" unit="cm/s" alt_unit="m/s"/>