Skip to content

GitLab

Merged
Created by Trishna Saeharaseelan@trishnaOwner

Create initial message schemas

11 unresolved threads
Compare
and
7 files
+ 391
- 96
Show latest version
do‎cs‎
generate_‎swagger.py‎ +38 -24
for‎mats‎
__ini‎t__.py‎ +78 -0
autonomy_con‎figuration.py‎ +101 -0
observa‎tion.py‎ +28 -0
platform_‎status.py‎ +124 -0
READ‎ME.md‎ +18 -5
__ini‎t__.py‎ +4 -67
docs/generate_swagger.py
+ 38
- 24
Show all unchanged lines Show 20 lines
2/ Go to http://127.0.0.1:5000/soardocs
WARNING: API Endpoints are NOT functional. Purely for easy-reading.
"""
# from .formats.autonomy_configuration import autonomy_configuration_schema
from flask import Flask, request
from flasgger import Swagger, LazyString
from flask_restx import Api, fields, Resource
app = Flask(__name__)
# app.json_encoder = LazyJSONEncoder
api = Api(app)
swagger_template = dict(
info={
Show 20 lines Show all unchanged lines Show 20 lines
)
platform_schema = api.model(
"PlatformSchema",
"Platform",
{
"platform_ID": fields.Integer(
required=True,
Show 20 lines Show all unchanged lines Show 20 lines
)
squad_metadata_schema = api.model(
"SquadMetadataSchema",
"SquadMetadata",
{
"squad_ID": fields.Integer(
required=True,
Show 20 lines Show all unchanged lines Show 20 lines
)
constraints_schema = api.model(
"ConstraintsSchema",
"Constraints",
# TODO: Should this be per platform instead of squad?
{
"min_altitude": fields.Float(
Show 20 lines Show all unchanged lines Show 20 lines
)
# Main Autonomy Configuration Schema
autonomy_configuration_schema = api.model(
"ConfigurationSchema",
"Configuration",
{
"message": fields.Nested(
message_header_schema,
Show 20 lines Show all unchanged lines Show 20 lines
),
},
)
observation_schema = api.model(
"Observation",
{
"message": fields.Nested(
message_header_schema,
required=True,
description="Message header",
),
"platform": fields.Nested(platform_schema),
"time": fields.String(
required=True,
description="Timestamp of message",
example="2022-11-16T00:00:00Z",
),
"discuss_other_fields": fields.String(
required=False,
description="", # we can track the version of the AE plan?
example="",
),
}
)
platform_status_message_schema = api.model(
"PlatformStatusMessage",
{
Show 20 lines Show all unchanged lines Show 20 lines
"produces": ["application/json"],
"consumes": ["application/json"],
}
swagger = Swagger(app, template=swagger_template, config=swagger_config)
ns1 = api.namespace("message", description="Message Header Format")
@ns1.route("/header")
class MessageHeader(Resource):
@ns1.response(200, "Success", message_header_schema)
Show 20 lines Show all unchanged lines Show 20 lines
ns2 = api.namespace("platform_status", description="Platform Status Message Format")
@ns2.route("")
class PlatformStatus(Resource):
@ns2.response(200, "Success", platform_status_message_schema)
Show 20 lines Show all unchanged lines Show 20 lines
"autonomy_configuration", description="Autonomy Configuration Format"
)
@ns3.route("")
class AutonomyConfiguration(Resource):
@ns3.response(200, "Success", autonomy_configuration_schema)
Show 20 lines Show all unchanged lines Show 20 lines
# @api.route('/mission-plan/<str:platform_type')
# @api.doc(params={"platform_type": "The type of platform of the mission plan to target."})
ns4 = api.namespace("mission_plan", description="Mission Plan Format per Platform")
ns4 = api.namespace("mission_plan", description="Mission Plan Format Per Platform")
@ns4.route("/ecosub")
class MissionPlanEcosub(Resource):
@ns4.response(200, "Success", message_header_schema)
@ns4.response(200, "Success", {})
def get(self):
pass
@ns4.route("/hydrosurv")
class MissionPlanHydrosurv(Resource):
@ns4.response(200, "Success", message_header_schema)
@ns4.route("/reav")
class MissionPlanReav(Resource):
@ns4.response(200, "Success", {})
def get(self):
pass
@ns4.route("/autosubhover")
class MissionPlanAutosubHover(Resource):
@ns4.response(200, "Success", message_header_schema)
@ns4.response(200, "Success", {})
def get(self):
pass
ns5 = api.namespace("observation", description="Observation Format --> Per Platform or generic?")
@ns5.route("")
class Observation(Resource):
@ns5.response(200, "Success", observation_schema)
def get(self):
pass
if __name__ == "__main__":
app.run()
formats/__init__.py
+ 78
- 0
from flask_restx import fields
from . import api
import os
__all__ = [
os.path.splitext(os.path.basename(x))[0]
for x in os.listdir(os.path.dirname(__file__))
if x.endswith(".py") and x != "__init__.py"
]
message_types = [
"platform_status",
"mission_plan_ecosub",
"mission_plan_reav",
"mission_plan_autosub",
] # TODO: Add full range of message types once scoped out
message_header_schema = api.model(
"MessageHeader",
{
"timestamp": fields.DateTime(
required=True,
description="Timestamp of message",
example="2022-11-16T00:00:00Z",
),
"source": fields.String(
required=True,
description="Where is this message from",
example="autonomy_engine",
),
"destination": fields.String(
required=True,
description="What is the destination of this message",
example="ah-1",
),
"encoded": fields.Boolean(
required=True,
description="Indicate that message raw (encoded) or decoded. "
+ "Options: encoded=True, decoded=False",
example=False,
),
"type": fields.String(
required=True,
description="Type of message",
example="platform_status",
),
# "payload":# TODO: schema applicable changes according to "type"
},
)
platform_schema = api.model(
"PlatformSchema",
{
"platform_ID": fields.Integer(
required=True,
description="unique identifier for platform",
example="ah-1",
),
"serial": fields.Integer(
required=True,
description="platform serial number",
example="ah-1",
),
"model": fields.Integer(
required=True,
description="platform serial number",
example="ah-1",
),
"active": fields.Boolean(
required=False,
description="platform in mission",
example=True,
),
},
)
# TODO: Add generic positions schema
# TODO: Define units for all schemas
formats/autonomy_configuration.py
+ 101
- 0
"""
schemas: configuration sent to Autonomy Engine (i.e. during an emergency,
if a platform needs to be removed from the mission planning)
"""
from . import api, message_header_schema, platform_schema
from flask_restx import fields
squad_metadata_schema = api.model(
"SquadMetadataSchema",
{
"squad_ID": fields.Integer(
required=True,
description="platform serial number",
example="ah-1",
),
"no_of_platforms": fields.Integer(
required=True,
description="number of platform serial number",
example="ah-1",
),
"platforms": fields.List(
fields.Nested(platform_schema),
required=True,
description="Metadata pf each platform",
),
"squad_mission_type": fields.String(
required=True,
description="Survey or Detail",
example="survey",
),
"squad_state": fields.Boolean(
required=True,
description="True if given Squad is executing mission type "
+ "according to the Autonomy Engine plan",
example=False,
),
},
)
constraints_schema = api.model(
"ConstraintsSchema",
# TODO: Should this be per platform instead of squad?
{
"min_altitude": fields.Float(
required=True,
description="Minimum altitude set for squad.",
example=15.2,
),
"min_velocity": fields.Float(
required=True,
description="Minimum velocity set for squad.",
example=0.1,
),
"max_velocity": fields.Float(
required=True,
description="Maximum altitude set for squad.",
example=0.9,
),
},
)
environment_config_schema = api.model( # TODO: Discuss how regions are defined
"EnvironmentConfig",
{
"region_of_interest": fields.String(),
"exclusion_zone": fields.String(),
},
)
# Main Autonomy Configuration Schema
autonomy_configuration_schema = api.model(
"SquadConfigurationSchema",
{
"message": fields.Nested(
message_header_schema,
required=True,
description="Message header",
),
"ID": fields.Integer(
required=True,
description="Unique identifier tagged to version of this"
+ " configuration plan",
example=3,
),
"time": fields.String(
required=True,
description="",
example="",
),
"squads": fields.Nested(
squad_metadata_schema,
required=False,
description="Details of each squad",
),
"environment": fields.Nested(
environment_config_schema,
required=False,
description="Region of interest and exclusion zone",
),
},
)
formats/observation.py
+ 28
- 0
formats/platform_status.py
+ 124
- 0
README.md
+ 18
- 5
__init__.py
+ 4
- 67