__init__.py 3.16 KB
Newer Older
1 2
# from flask_restx import fields
# from . import api
3 4 5 6 7 8 9 10 11
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"
]

12 13
# TODO: Define units for all schemas

14 15 16 17 18 19
# message_types = [
#     "platform_status",
#     "mission_plan_ecosub",
#     "mission_plan_reav",
#     "mission_plan_autosub",
# ]  # TODO: Add full range of message types once scoped out
20

21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
# full_message_schema = api.model(
#     "FullMessageSchema",
#     {
#         "message_ID": fields.String(
#             required=True,
#             description="UUID assigned to this message",
#             example="b427003c-7bc8-11ed-a1eb-0242ac120002",
#         ),
#         "timestamp": fields.DateTime(
#             required=True,
#             description="Timestamp of message",
#             example="2022-11-16T00:00:00Z",
#         ),
#         "version": fields.Float(
#             required=True,
#             description="Version of comms bacbone messaging format protocol",
#             example=2.0,
#         ),
#         "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": fields.Raw(
#             required=True,
#             description="Content of Message",
#             # example="{}",
#         ),
#     },
# )
67

68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
# constraints_schema = api.model(
#     "ConstraintsSchema",
#     {
#         "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,
#         ),
#     },
# )
88

89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
# platform_schema = api.model(
#     "PlatformSchema",
#     {
#         "platform_ID": fields.Integer(
#             required=True,
#             description="unique identifier for platform",
#             example=1,
#         ),
#         "serial": fields.String(
#             required=True,
#             description="platform serial number",
#             example="reav-60",
#         ),
#         "model": fields.String(
#             required=True,
#             description="platform serial number",
#             example="reav",
#         ),
#         "constraints": fields.Nested(constraints_schema),
#     },
# )