planning_configuration.py 5.3 KB
Newer Older
1 2
"""
    schemas: configuration sent to Autonomy Engine (i.e. during an emergency,
3
    if a platform needs to be removed from the mission planning)
4 5
"""

6
emergency_schema = {
7 8
    "type": "object",
    "properties": {
9 10 11
        "safe_command": {
            "type": "string",
            "enum": ["go_home", "abort_now", "stop_mission"],
12 13
            "description": "Command/Action that is native to respective"
            + " partner's platform/C2",
14 15
            "example": "go_home",
        },
16
        "target_waypoint_latitude": {
17
            "type": "number",
18
            "format": "float",
19
            "description": "X-coordinate safe place for respective platform",
20
            "example": -7.432,
21
        },
22
        "target_waypoint_longitude": {
23
            "type": "number",
24
            "format": "float",
25
            "description": "Y-coordinate safe place for respective platform",
26
            "example": 50.365,
27
        },
28
        "target_depth": {
29
            "type": "number",
30
            "format": "float",
31
            "description": "Z-coordinate safe place for respective platform"
32
            + " . If platform to NOT stay at depth, key in `0.0`",
33
            "example": 10.0,
34 35 36 37
        },
        "additional_data": {
            "description": "Any addition fields/data to be added here",
            "example": {},
38
        },
39
    },
Trishna Saeharaseelan's avatar
Trishna Saeharaseelan committed
40 41 42 43 44
    "required": [
        "target_waypoint_latitude",
        "target_waypoint_longitude",
        "target_depth",
    ],
45
}
46

47

48 49 50 51
platform_schema = {
    "type": "object",
    "properties": {
        "platform_ID": {
52 53 54
            "type": "string",
            "description": "Unique identifier for this platform",
            "example": "reav-x-1",
55 56 57 58 59
        },
        "model": {
            "type": "string",
            "example": "reav",
        },
60 61 62
        "emergency": emergency_schema,
        "min_altitude": {
            "type": "number",
63
            "format": "float",
64 65 66 67 68
            "description": "Minimum altitude set for squad.",
            "example": 15.2,
        },
        "min_velocity": {
            "type": "number",
69
            "format": "float",
70 71 72 73 74
            "description": "Minimum velocity set for squad.",
            "example": 0.1,
        },
        "max_velocity": {
            "type": "number",
75
            "format": "float",
76 77 78
            "description": "Maximum altitude set for squad.",
            "example": 0.9,
        },
79
        "additional_data": {
80 81
            "description": "Any addition fields/data to be added here",
            "example": {"swath_width": 10.0, "scan_type": "DVL"},
82
            "type": "object",
83
        },
84
    },
85 86 87 88 89 90 91 92
    "required": [
        "platform_ID",
        "model",
        "emergency",
        "min_altitude",
        "min_velocity",
        "max_velocity",
    ],
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
}

region_schema = {
    "type": "object",
    "properties": {
        "geometry_coordinates": {
            "type": "array",  # TODO: Check if config defn is right.
            "example": [
                [
                    [-4.187143188645706, 50.37072283932642],
                    [-4.202697005964865, 50.368816892405874],
                    [-4.203156724702808, 50.365640144076906],
                    [-4.19449868846155, 50.362267670845654],
                ]
            ],
        },
109
    },
110 111
    "description": "Using GEOJSON, exact 4-point region (rectangle shaped)",
}
112

113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
squad_metadata_schema = {
    "type": "object",
    "properties": {
        "squad_ID": {
            "type": "integer",
            "description": "Identifier of given squad",
            "example": 23,
        },
        "no_of_platforms": {
            "type": "integer",
            "description": "Number of platforms",
            "example": 3,
        },
        "platforms": {
            "type": "array",
            "items": platform_schema,
            "description": "Squad consists of these platforms",
        },
        "squad_mission_type": {
            "type": "string",
            "enum": ["tracking", "survey", "inspection"],
            "description": "Mission of given squad: `tracking`, `survey`"
            + ", `inspection`",
            "example": "survey",
        },
        "squad_state": {
            "type": "string",
            "description": "In execution, Waiting.. <define further>",
            "example": False,
        },
        "region_of_interest": region_schema,
    },
    "required": [
        "squad_ID",
        "no_of_platforms",
        "platforms",
        "squad_mission_type",
        "squad_state",
    ],
}
153

154 155 156
planning_configuration_schema = {
    "type": "object",
    "properties": {
157 158 159 160
        "message_type": {
            "type": "string",
            "description": "Type of message",
            "example": "planning_configuration",
161
            "enum": ["planning_configuration"],
162
        },
163
        "planning_config_ID": {
164 165
            "type": "integer",
            "description": "Unique identifier tagged to version of this"
166
            + " configuration plan",
167 168
            "example": 3,
        },
169 170 171 172 173
        "exclusion_zones": {
            "type": "array",
            "items": region_schema,
            "description": "Exclusion zones for all platforms",
        },
174 175 176 177
        "squads": {
            "type": "array",
            "items": squad_metadata_schema,
        },
178
    },
179
    "required": [
180
        "message_type",
181
        "planning_config_ID",
182 183 184
        "squads",
        "exclusion_zones",
    ],
185
}