Skip to content

GitLab

Merged
Created by Trishna Saeharaseelan@trishnaOwner

Create initial message schemas

11 unresolved threads
Compare
and
9 files
+ 222
- 131
Show latest version
examples/hydr‎osurv_adapter‎
acknowledg‎ement.json‎ +1 -1
for‎mats‎
__ini‎t__.py‎ +64 -0
acknowled‎gement.py‎ +3 -8
message_w‎rapper.py‎ +60 -60
mission‎_plan.py‎ +4 -1
observa‎tion.py‎ +30 -21
planning_con‎figuration.py‎ +4 -1
platform_‎status.py‎ +14 -1
generate_‎swagger.py‎ +42 -38
examples/hydrosurv_adapter/acknowledgement.json
+ 1
- 1
Show all unchanged lines Show 20 lines
"encoded": false,
"message_type": "acknowledgement",
"acknowledged_message_ID": "11111111-7bc8-11ed-a1eb-0242ac999999",
"status": "Approved and sent to platform"
"status": "c2_received"
}
\ No newline at end of file
formats/__init__.py
+ 64
- 0
Show all unchanged lines Show 20 lines
for x in os.listdir(os.path.dirname(__file__))
if x.endswith(".py") and x != "__init__.py"
]
abstract_schema = {
"allOf": [{"$ref": "#/definitions/Metadata"}],
"type": "object",
"properties": {
"payload": {}
}
}
message_metadata = {
"type": "object",
"discriminator": {
"propertyName": "message_type",
},
"properties": {
"message_ID": {
"type": "string",
"description": "An identifier for the type of message received.",
"example": "b427003c-0000-11aa-a1eb-bvcdfghjgfdd",
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "Timestamp of message",
"example": "2022-11-16T00:00:00Z",
},
"message_type": {
"type": "string",
"description": "Type of message",
"example": "platform_status",
},
"version": {
"type": "number",
"format": "float",
"description": "Version of comms backbone message format protocol",
"example": 2.0,
},
"source": {
"type": "string",
"description": "The sender; Where is this message from",
"example": "autonomy_engine",
},
"destination": {
"type": "string",
"description": "Publisher topic; What is the destination"
+ " of this message",
"example": "ah1",
},
"encoded": {
"type": "boolean",
"description": "Indicate that message raw (encoded) or decoded. "
+ "Options: encoded=True, decoded=False",
"example": False,
},
"delivery_type": {
"type": "string",
"description": "To publish or broadcast this message.",
"enum": ["broadcast", "publish"],
"example": "publish",
"default": "publish",
},
},
"required": ["message_type"],
}
\ No newline at end of file
formats/acknowledgement.py
+ 3
- 8
Show all unchanged lines Show 20 lines
schemas: Acknowledgement status sent by the surface platform to report
receipt of message.
"""
# from openapi_schema_validator import validate
# from jsonschema import validate
from formats import abstract_schema
acknowledgement_schema = {
"allOf": [{"$ref": "#/components/schemas/Message"}],
"type": "object",
"properties": {
"acknowledged_message_ID": {
Show 20 lines Show all unchanged lines Show 20 lines
"required": ["acknowledged_message_ID", "status"],
}
# validate(
# {"acknowledged_message_ID": "string-type-id", "status": "c2_received"},
# acknowledgement_schema,
# )
full_acknowledgement_schema = abstract_schema
full_acknowledgement_schema["properties"]["payload"] = acknowledgement_schema
formats/message_wrapper.py
+ 60
- 60
"""
schemas: Message Wrapper is used to wrap all message types that contain
details of where the message is coming from, which end client is its
destination and the type of message.
"""
# """
# schemas: Message Wrapper is used to wrap all message types that contain
# details of where the message is coming from, which end client is its
# destination and the type of message.
# """
message_wrapper_schema = {
"type": "object",
"discriminator": {
"propertyName": "message_type",
},
"properties": {
"message_ID": {
"type": "string",
"description": "An identifier for the type of message received.",
"example": "b427003c-0000-11aa-a1eb-bvcdfghjgfdd",
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "Timestamp of message",
"example": "2022-11-16T00:00:00Z",
},
"message_type": {
"type": "string",
"description": "Type of message",
"example": "platform_status",
},
"version": {
"type": "number",
"format": "float",
"description": "Version of comms backbone message format protocol",
"example": 2.0,
},
"source": {
"type": "string",
"description": "The sender; Where is this message from",
"example": "autonomy_engine",
},
"destination": {
"type": "string",
"description": "Publisher topic; What is the destination"
+ " of this message",
"example": "ah1",
},
"encoded": {
"type": "boolean",
"description": "Indicate that message raw (encoded) or decoded. "
+ "Options: encoded=True, decoded=False",
"example": False,
},
"delivery_type": {
"type": "string",
"description": "To publish or broadcast this message.",
"enum": ["broadcast", "publish"],
"example": "publish",
"default": "publish",
},
},
"required": ["message_type"],
}
# message_wrapper_schema = {
# "type": "object",
# "discriminator": {
# "propertyName": "message_type",
# },
# "properties": {
# "message_ID": {
# "type": "string",
# "description": "An identifier for the type of message received.",
# "example": "b427003c-0000-11aa-a1eb-bvcdfghjgfdd",
# },
# "timestamp": {
# "type": "string",
# "format": "date-time",
# "description": "Timestamp of message",
# "example": "2022-11-16T00:00:00Z",
# },
# "message_type": {
# "type": "string",
# "description": "Type of message",
# "example": "platform_status",
# },
# "version": {
# "type": "number",
# "format": "float",
# "description": "Version of comms backbone message format protocol",
# "example": 2.0,
# },
# "source": {
# "type": "string",
# "description": "The sender; Where is this message from",
# "example": "autonomy_engine",
# },
# "destination": {
# "type": "string",
# "description": "Publisher topic; What is the destination"
# + " of this message",
# "example": "ah1",
# },
# "encoded": {
# "type": "boolean",
# "description": "Indicate that message raw (encoded) or decoded. "
# + "Options: encoded=True, decoded=False",
# "example": False,
# },
# "delivery_type": {
# "type": "string",
# "description": "To publish or broadcast this message.",
# "enum": ["broadcast", "publish"],
# "example": "publish",
# "default": "publish",
# },
# },
# "required": ["message_type"],
# }
formats/mission_plan.py
+ 4
- 1
Show all unchanged lines Show 20 lines
sent to the respective platform's C2 to compile into a platform-specific
mission plan.
"""
from formats import abstract_schema
action_schema = {
"type": "object",
Show 20 lines Show all unchanged lines Show 20 lines
}
mission_plan_schema = {
"allOf": [{"$ref": "#/components/schemas/Message"}],
"type": "object",
"properties": {
"autonomy_engine_plan_ID": {
Show 20 lines Show all unchanged lines Show 20 lines
},
"required": ["plan_ID", "platform_ID", "plan"],
}
full_mission_plan_schema = abstract_schema
full_mission_plan_schema["properties"]["payload"] = mission_plan_schema
formats/observation.py
+ 30
- 21
Show all unchanged lines Show 20 lines
schema: Observation Message sent by platforms when points of
interest are found.
"""
from formats import abstract_schema
hits_schema = {
"type": "object",
Show 20 lines Show all unchanged lines Show 20 lines
}
observation_schema = {
"allOf": [{"$ref": "#/components/schemas/Message"}],
"type": "object",
"properties": {
"platform_ID": {
"type": "integer",
"description": "ID of platform to sending observations",
"example": 2,
},
"points_of_interest": {
"type": "array",
"items": hits_schema,
"description": "Points from features of interest identified by"
+ " platform if any found.", # TODO: DEFINE FORMAT.
},
"region_surveyed": {
"type": "null",
"description": "Region surveyed by given platform."
+ " GEOJSON", # TODO: DEFINE FORMAT.
"example": "",
},
"additional_data": {
"description": "Placeholder field for any additional data",
"example": {"sensor_payload": False},
"payload": {
"type": "object",
"properties": {
"platform_ID": {
"type": "integer",
"description": "ID of platform to sending observations",
"example": 2,
},
"points_of_interest": {
"type": "array",
"items": hits_schema,
"description": "Points from features of interest identified by"
+ " platform if any found.", # TODO: DEFINE FORMAT.
},
"region_surveyed": {
# "type": "null",
"nullable": True,
"description": "Region surveyed by given platform."
+ " GEOJSON", # TODO: DEFINE FORMAT.
"example": "",
},
"additional_data": {
"description": "Placeholder field for any additional data",
"example": {"sensor_payload": False},
},
},
},
},
"required": ["platform_ID"],
}
full_observation_schema = abstract_schema
full_observation_schema["properties"]["payload"] = observation_schema
formats/planning_configuration.py
+ 4
- 1
Show all unchanged lines Show 20 lines
schemas: configuration sent to Autonomy Engine (i.e. during an emergency,
if a platform needs to be removed from the mission planning)
"""
from formats import abstract_schema
emergency_schema = {
"type": "object",
Show 20 lines Show all unchanged lines Show 20 lines
}
planning_configuration_schema = {
"allOf": [{"$ref": "#/components/schemas/Message"}],
"type": "object",
"properties": {
"planning_config_ID": {
Show 20 lines Show all unchanged lines Show 20 lines
"exclusion_zones",
],
}
full_planning_configuration_schema = abstract_schema
full_planning_configuration_schema["properties"]["payload"] = planning_configuration_schema
formats/platform_status.py
+ 14
- 1
"""
schema: platform-specific decoded status message
"""
from formats import abstract_schema
sensor_schema = {
"type": "object",
"description": "Scanning sensor on platform available"
Show 20 lines Show all unchanged lines Show 20 lines
}
platform_status_message_schema = {
"allOf": [{"$ref": "#/components/schemas/Message"}],
"type": "object",
"properties": {
"platform_ID": {
Show 20 lines Show all unchanged lines Show 20 lines
+ " platform or USBL",
"example": "usbl",
},
"transmission_mode": {
"type": "string",
"enum": ["acoustics", "iridium", "wifi", "starlink"],
"description": "Mode in which status message was transmitted"
+ " when on the surface (i.e. iridium/wifi) or underwater"
+ " (i.e. acoustics)",
"example": "wifi",
},
"platform_timestamp": {
"type": "string",
"format": "date-time",
Show 20 lines Show all unchanged lines Show 20 lines
"longitude",
],
}
full_platform_status_message_schema = abstract_schema
full_platform_status_message_schema["properties"]["payload"] = platform_status_message_schema
generate_swagger.py
+ 42
- 38
from formats.message_wrapper import message_wrapper_schema
from formats.mission_plan import mission_plan_schema
from formats.observation import observation_schema
from formats.planning_configuration import planning_configuration_schema
from formats.platform_status import platform_status_message_schema
from formats.acknowledgement import acknowledgement_schema
from formats import message_metadata
from formats.mission_plan import full_mission_plan_schema
from formats.observation import full_observation_schema
from formats.planning_configuration import full_planning_configuration_schema
from formats.platform_status import full_platform_status_message_schema
from formats.acknowledgement import full_acknowledgement_schema
from flasgger import Swagger
from flask import Flask
Show 20 lines Show all unchanged lines Show 20 lines
"model_filter": lambda tag: True,
}
],
"components": {
"schemas": {
"Message": message_wrapper_schema,
"MissionPlan": mission_plan_schema,
"Observation": observation_schema,
"PlanningConfiguration": planning_configuration_schema,
"PlatformStatus": platform_status_message_schema,
"Acknowledgement": acknowledgement_schema,
}
# "components": {
"definitions": {
"Metadata": message_metadata,
"MissionPlan": full_mission_plan_schema,
"Observation": full_observation_schema,
"PlanningConfiguration": full_planning_configuration_schema,
"PlatformStatus": full_platform_status_message_schema,
"Acknowledgement": full_acknowledgement_schema,
# }
},
"paths": {
"/all_messages": {
Show 20 lines Show all unchanged lines Show 20 lines
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/"
+ "Acknowledgement"
},
{
"$ref": "#/components/schemas/"
+ "MissionPlan"
},
{
"$ref": "#/components/schemas/"
+ "Observation"
},
{
"$ref": "#/components/schemas/"
+ "PlanningConfiguration"
},
{
"$ref": "#/components/schemas/"
+ "PlatformStatus"
},
full_mission_plan_schema,
full_planning_configuration_schema,
full_platform_status_message_schema,
full_observation_schema,
# {
# "$ref": "#/definitions/"
# + "Acknowledgement"
# },
# {
# "$ref": "#/definitions/"
# + "MissionPlan"
# },
# {
# "$ref": "#/definitions/"
# + "Observation"
# },
# {
# "$ref": "#/definitions/"
# + "PlanningConfiguration"
# },
# {
# "$ref": "#/definitions/"
# + "PlatformStatus"
# },
],
"discriminator": {
"propertyName": "message_type",
Show 20 lines Show all unchanged lines Show 20 lines
"consumes": ["application/json"],
}
message_types = [
"Message",
"Acknowledgement",
"Metadata",
# "Acknowledgement",
"MissionPlan",
"Observation",
"PlanningConfiguration",
Show 20 lines Show all unchanged lines Show 20 lines
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/" + item,
"$ref": "#/definitions/" + item,
},
],
"discriminator": {
Show 20 lines Show all unchanged lines