Plan DB
PlanDB
ID 556
- Payload
- ≥ 10 bytes, variable
- Packet
- ≥ 32 bytes
- Source
- unspecified
- Category
- Plan Supervision
Request/reply to plan database.
#Fields
| Offset | Field | Type | Unit | Range | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 0 | #typeType |
uint8_t |
Enumerated | – | Indicates if the message is a request, or a reply to a previous request.
|
||||||||||||||||||||||||
| 1 | #opOperation |
uint8_t |
Enumerated | – | Indicates the operation affecting the DB. The operation may relate to a single plan or the entire plan DB. For each request, a plan DB may reply with any number of 'in progress' replies followed by a success or a failure reply. The 'op', 'request_id' and 'plan_id' fields of a request will be echoed in one or more responses to that request. The operation at stake also determines a certain type of the 'arg' field, and whether or not the 'plan_id' field needs to be set.
|
||||||||||||||||||||||||
| 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 ID |
plaintext |
– | – | Plan identifier for the operation, if one is required. |
||||||||||||||||||||||||
| var | #argArgument |
message<any> |
– | – | Request or reply argument. |
||||||||||||||||||||||||
| var | #infoComplementary Information |
plaintext |
– | – | Human-readable complementary information. For example this may be used to detail reasons for failure, or to report in-progress information. |
#References
Carried inline by:
ValidatePlan.planmessage