Desired Path
DesiredPath
ID 406
- Payload
- 56 bytes
- Packet
- 78 bytes
- Source
- vehicle
- Category
- Guidance
Perform path control.
The path is specified by two WGS-84 waypoints, respective altitude / depth settings, optional loitering at the end point, and some control flags.
The start and end waypoints are defined by the specified end point fields ('end_{lat/lon/z}') plus:
- the start waypoint fields ('start_{lat|lon|z}') if the 'START' flag (bit in 'flags' field) is set; or
- the end point of the previous path recently tracked; or
- the current location is the 'DIRECT' flag is set or if the tracker has been idle for some time.
Altitude and depth control can be performed as follows:
- by default, the tracker will just transmit an altitude/depth reference value equal to 'end_z' to the appropriate controller;
- if the 'NO_Z' flag is set no altitude/depth control will take place, hence they can be controlled independently;
- if the '3DTRACK' flag is set, 3D-tracking will be done (if supported by the active controller).
Loitering can be specified at the end point with a certain radius ('lradius'), duration ('lduration'), and clockwise or counter-clockwise direction ('CCLOCKW' flag).
#Fields
| Offset | Field | Type | Unit | Range | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 0 | #path_refPath Reference |
uint32_t |
– | – | Unsigned integer reference for the scope of the desired path message. Path reference should only be set by a maneuver. Should be set to an always increasing reference at the time of dispatching this message. Lower level path controllers must inherit the same path reference sent by maneuver. |
||||||||||||||||||||||||
| 4 | #start_latStart Point -- Latitude WGS-84 |
fp64_t |
rad | −π/2 … π/2 | WGS-84 latitude of start point. This will be ignored unless the 'START' flag is set. |
||||||||||||||||||||||||
| 12 | #start_lonStart Point -- WGS-84 Longitude |
fp64_t |
rad | −π … π | WGS-84 longitude of start point. This will be ignored unless the 'START' flag is set. |
||||||||||||||||||||||||
| 20 | #start_zStart Point -- Z Reference |
fp32_t |
m | – | Altitude or depth of start point. This parameter will be ignored if the 'NO_Z' flag is set, or if the 'START' flag is not set. |
||||||||||||||||||||||||
| 24 | #start_z_unitsStart Point -- Z Units |
uint8_t |
Enumerated | default
0 |
Units of the start point's z reference. 4 values from
|
0 | Z_NONE | None |
1 | Z_DEPTH | Depth |
2 | Z_ALTITUDE | Altitude |
3 | Z_HEIGHT | Height |
end_latEnd Point -- WGS84 Latitudefp64_tWGS-84 latitude of end point.
end_lonEnd Point -- WGS-84 Longitudefp64_tWGS-84 longitude of end point.
end_zEnd Point -- Z Referencefp32_tDepth or altitude for the end point. This parameter will be ignored if the 'NO_Z' flag is set.
end_z_unitsEnd Point -- Z Unitsuint8_t0Units of the end point's z reference.
4 values from ZUnits
0 | Z_NONE | None |
1 | Z_DEPTH | Depth |
2 | Z_ALTITUDE | Altitude |
3 | Z_HEIGHT | Height |
speedSpeedfp32_tManeuver speed reference.
speed_unitsSpeed Unitsuint8_t0Speed units.
3 values from SpeedUnits
0 | SUNITS_METERS_PS | Meters per second |
1 | SUNITS_RPM | RPM |
2 | SUNITS_PERCENTAGE | Percentage |
lradiusLoiter -- Radiusfp32_tRadius for loitering at end point. Specify less or equal to 0 for no loitering.
flagsFlagsuint8_tDesired Path flags.
0x01 | FL_START | Start Point Indicates that the start point specification is given, therefore it should be considered for tracking. |
0x02 | FL_DIRECT | Direct If start point is not given, ignore also the previous path's endpoint and take the start point to be the current vehicle location. |
0x04 | FL_NO_Z | No Altitude/Depth control Ignore altitude/depth setting and let them be controlled independently. |
0x08 | FL_3DTRACK | 3D Tracking Perform 3D-tracking, i.e., consider the path formed in the XYZ plane taking into account both the 'start_z' and 'end_z' values. |
0x10 | FL_CCLOCKW | Counter-Clockwise loiter Indicates that loitering, if defined, should be done counter-clockwise. Clockwise loitering will apply otherwise. |
0x20 | FL_LOITER_CURR | Loiter from current position Indicates that loitering, if defined, should be done from the current vehicle position. The end_lat and end_lon fields will be ignored. |
0x40 | FL_TAKEOFF | Takeoff Indicates that takeoff should be done before going to the end position. |
0x80 | FL_LAND | Land Indicates that the system should land at the end position. |
#References
Member of ControlCommand: it can be sent where that group is expected.
Carried inline by:
LowLevelControl.controlmessage · via ControlCommand