IMCInter Module Communication
v5.5.11

Plan Control

PlanControl ID 559
Payload
≥ 12 bytes, variable
Packet
≥ 34 bytes
Source
ccu, vehicle
Category
Plan Supervision

Plan control request/reply.

#Fields

Offset FieldTypeUnitRangeDescription
0 #typeType uint8_t Enumerated –

Indicates if the message is a request or a reply to a previous request. The op, request_id and plan_id fields of a request will be echoed in one or more responses to that request.

0PC_REQUESTRequest
1PC_SUCCESSReply -- Success
2PC_FAILUREReply -- Failure
3PC_IN_PROGRESSReply -- In Progress
1 #opOperation uint8_t Enumerated –

Plan control operation.

0PC_STARTStart Plan

Start plan identified by plan_id field. The command will try to load the corresponding plan if none is loaded, and in that case will follow the same discipline as the LOAD command.

If the message in arg is a Maneuver, a single-maneuver plan will be generated and executed.

This will override any current plan being executed.

1PC_STOPStop Plan

Stop current plan being executed if any.

2PC_LOADLoad Plan

Load Plan. If a PlanSpecification is given with the request in the data field, then that plan is used and stored in the Plan DB. Otherwise, the plan is loaded from the Plan DB.

3PC_GETGet Plan

Get loaded plan. For a successful reply, the data field will contain the PlanSpecification message that corresponds to the currently loaded plan.

2 #request_idRequest ID uint16_t – –

Request ID. This may be used by interfacing modules e.g. using sequence counters. to annotate requests and appropriately identify replies.

4 #plan_idPlan Identifier plaintext – –

The identifier for the plan to be stopped / started / loaded / retrieved according to the command requested (op field).

var #flagsFlags uint16_t Bitfield –
0x0001FLG_CALIBRATECalibrate Vehicle

Perform vehicle calibration.

0x0002FLG_IGNORE_ERRORSIgnore Errors

Execute current plan while ignoring some errors that might be active.

var #argRequest/Reply Argument message<any> – –

Complementary message argument for requests/replies.

var #infoComplementary Info plaintext – –

Complementary human-readable information. This is used in association to replies.