shared/uavobjectdefinition/pathdesired.xml

   1 <xml>
   2     <object name="PathDesired" singleinstance="true" settings="false" category="Navigation">
   3         <description>The endpoint or path the craft is trying to achieve.  Can come from @ref ManualControl or @ref PathPlanner </description>
   4
   5         <field name="Start" units="m" type="float" elementnames="North,East,Down" default="0"/>
   6         <field name="End" units="m" type="float" elementnames="North,East,Down" default="0"/>
   7         <field name="StartingVelocity" units="m/s" type="float" elements="1" default="0"/>
   8         <field name="EndingVelocity" units="m/s" type="float" elements="1" default="0"/>
   9
  10         <!-- ensure the following Mode options are exactly the same as in pathaction mode -->
  11         <field name="Mode" units="" type="enum" elements="1" options="GoToEndpoint,FollowVector,CircleRight,CircleLeft,
  12             FixedAttitude,SetAccessory,DisarmAlarm,Land,Brake,Velocity,AutoTakeoff" default="GoToEndpoint" />
  13
  14         <!-- Endpoint mode - move directly towards endpoint regardless of position -->
  15         <!-- Straight Mode - move across linear path through Start towards the waypoint end, adjusting velocity - continue straight -->
  16         <!-- Circle Mode - move a circular pattern around End with radius End-Start (straight line in the vertical)-->
  17         <field name="ModeParameters" units="" type="float" elements="4" default="0"/>
  18
  19         <field name="UID" units="" type="int16" elements="1" default="0"/>
  20         <!-- unique ID confirmed with pathfollower in pathstatus to acknowledge a change in PathDesired -->
  21
  22         <access gcs="readwrite" flight="readwrite"/>
  23         <telemetrygcs acked="false" updatemode="manual" period="0"/>
  24         <telemetryflight acked="false" updatemode="periodic" period="1000"/>
  25         <logging updatemode="manual" period="0"/>
  26     </object>
  27 </xml>