acknowledgement.py 1.03 KB
Newer Older
1 2 3 4
"""
    schemas: Acknowledgement status sent by the surface platform to report
    receipt of message.
"""
5
acknowledgement_schema = {
6
    "type": "object",
7
    "properties": {
8 9 10 11 12
        "message_type": {
            "type": "string",
            "description": "Type of message",
            "example": "acknowledgement",
        },
13 14 15 16 17
        "autonomy_engine_plan_ID": {
            "type": "integer",
            "description": "Mission plan ID (according to Autonomy"
            + " Engine's mission plan number sent) executed by platform",
            "example": 1,
18
        },
19
        "platform_ID": {
20
            "type": "string",
21 22 23 24 25
            "description": "Unique identifier for this platform",
            "example": "reav-x-1",
        },
        "approved": {
            "type": "boolean",
Trishna Saeharaseelan's avatar
Trishna Saeharaseelan committed
26 27
            "description": "Human-in-the-loop approval."
            + "1 - Plan approved; 0 - Plan Rejected",
28
        },
29
    },
Trishna Saeharaseelan's avatar
Trishna Saeharaseelan committed
30 31 32 33 34 35
    "required": [
        "message_type",
        "autonomy_engine_plan_ID",
        "platform_ID",
        "approved",
    ],
36
}