IMCInter Module Communication
v5.5.11

Formation

Formation ID 484
Payload
≥ 57 bytes, variable
Packet
≥ 79 bytes
Source
ccu, vehicle
Category
Maneuvering

The "Formation" is a controller to execute a maneuver with a team of vehicles. It defines the:

  • Vehicles included in the formation group
  • Vehicles relative positions inside the formation
  • Reference frame where the relative positions are defined
  • Formation shape configuration
  • Plan (set of maneuvers) to be followed by the formation center
  • Plan contrains (virtual leader speed and bank limits)
  • Supervision settings

The formation reference frame may be:

  • Earth Fixed: Where the vehicles relative position do not depend on the followed path. This results in all UAVs following the same path with an offset relative to each other;
  • Path Fixed: Where the vehicles relative position depends on the followed path, changing the inter-vehicle offset direction with the path direction.
  • Path Curved: Where the vehicles relative position depends on the followed path, changing the inter-vehicle offset direction with the path direction and direction change rate. An offset in the xx axis results in a distance over the curved path line. An offset in the yy axis results in an offset of the vehicle path line relative to the formation center path line.

#Fields

Offset FieldTypeUnitRangeDescription
0 #formation_nameFormation Name plaintext – –

Name of the formation configuration.

var #typeType uint8_t Enumerated –

Indicates if the message is a request, or a reply to a previous request.

0FC_REQUESTRequest
1FC_REPORTReport
var #opOperation uint8_t Enumerated –

Operation to perform.

0OP_STARTStart

Start the formation maneuver.

1OP_STOPStop

Stop the formation maneuver.

2OP_READYReady

Stop the formation maneuver.

3OP_EXECUTINGExecuting

Stop the formation maneuver.

4OP_FAILUREFailure

Stop the formation maneuver.

var #group_nameTarget Group Name plaintext – –

Target group for the formation plan.

var #plan_idFormation Plan ID plaintext – –

The flight plan's identifier. Flight plan defined to be tracked by the formation leader.

var #descriptionPlan Description plaintext – –

Verbose text description of plan.

var #reference_frameFormation Reference Frame uint8_t Enumerated –

Formation reference frame

0OP_EARTH_FIXEDEarth Fixed
1OP_PATH_FIXEDPath Fixed
2OP_PATH_CURVEDPath Curved
var #participantsFormation Participants message-list<VehicleFormationParticipant> – –

List of formation participants.

var #leader_bank_limFormation Leader Bank Limit fp32_t rad –

Maximum absolute bank allowed for the formation leader.

var #leader_speed_minFormation Leader Minimum Speed fp32_t m/s –

Minimum speed allowed for the formation leader flight.

var #leader_speed_maxFormation Leader Maximum Speed fp32_t m/s –

Maximum speed allowed for the formation leader flight.

var #leader_alt_minFormation Leader Minimum Altitude fp32_t m –

Minimum altitude allowed for the formation leader flight.

var #leader_alt_maxFormation Leader Maximum Altitude fp32_t m –

Maximum altitude allowed for the formation leader flight.

var #pos_sim_err_limPosition mismatch limit fp32_t m –

Limit for the position mismatch between real and simulated position, before a maneuver abort is asserted.

var #pos_sim_err_wrnPosition mismatch threshold fp32_t m –

Warning threshold for the position mismatch between real and simulated position. Above this threshold a time-out limit is evaluated to assert a maneuver abort state.

var #pos_sim_err_timeoutPosition mismatch time-out uint16_t s –

The amount of time the maneuver is allowed to run after the position mismatch threshold is surpassed.

var #converg_maxConvergence threshold fp32_t m –

Threshold for the convergence measure, above which a time-out limit is evaluated to assert a maneuver abort state.

var #converg_timeoutConvergence time-out uint16_t s –

The amount of time the maneuver is allowed to run after the convergence threshold is surpassed.

var #comms_timeoutCommunications time-out uint16_t s –

The amount of time the maneuver is allowed to run without any update on the other formation vehicles states.

var #turb_limTurbulence limit fp32_t m/s –

Turbulence limit above which a maneuver abort is asserted.

var #customCustom settings for maneuver plaintext TupleList –

Custom settings for maneuver.