← All message topics · schema GroundTruth/BlockageList/blockagelist_groundtruth_message.json

header

Field	Type	Required	Allowed values	Description
timestamp	string	✓
message_type	string	✓	`groundtruth`
version	string	✓		The message format version

msg

Field	Type	Required	Allowed values
experiment_id	string	✓
trial_id	string
timestamp	string	✓
source	string	✓
sub_type	string	✓	`Mission:BlockageList`
version	string	✓
replay_parent_type	string\|null		`TRIAL` `REPLAY` `null`
replay_parent_id	string\|null
replay_id	string\|null

data

Field	Type	Required
mission	string	✓
mission_blockage_list	array<object>	✓
mission_blockage_list[].x	number	✓
mission_blockage_list[].y	number	✓
mission_blockage_list[].z	number	✓
mission_blockage_list[].block_type	string	✓
mission_blockage_list[].room_name	string
mission_blockage_list[].feature_type	string

Example message

{
	"header": {
		"timestamp": "2019-12-26T12:47:23.1234Z",
		"message_type": "groundtruth",
		"version": "0.5"
	},
	"msg": { 
		"experiment_id": "563e4567-e89b-12d3-a456-426655440000",
		"trial_id": "123e4567-e89b-12d3-a456-426655440000",
		"timestamp": "2019-12-26T14:05:02.1412Z",
		"source": "simulator",
		"sub_type": "Mission:BlockageList",
		"version": "0.5"
	},
	"data": {
		"mission": "Falcon",	
	   	"mission_blockage_list" : [ {
			"x" : -2088.0,
			"y" : 60.0,
			"z" : 146.0,
			"block_type" : "cobblestone",
			"room_name" : "",
			"feature_type" : "Blockage"
		}, {
			"x" : -2087.0,
			"y" : 60.0,
			"z" : 146.0,
			"block_type" : "dirt",
			"room_name" : "",
			"feature_type" : "Blockage"
		} ]
	}
}

Raw JSON Schema (resolved)

{
  "$id": "http://asist.aptima.com/schemas/event_state.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "definitions": {},
  "properties": {
    "data": {
      "$id": "#/properties/message/properties/data",
      "properties": {
        "mission": {
          "$id": "#/properties/data/properties/mission",
          "examples": [
            "Singleplayer",
            "Multiplayer"
          ],
          "pattern": "^(.*)$",
          "title": "The Mission Name Schema",
          "type": "string"
        },
        "mission_blockage_list": {
          "$id": "#/properties/data/properties/mission_blockage_list",
          "default": "",
          "examples": [
            "[ {\"x\" : -2088.0,\"y\" : 60.0,\"z\" : 146.0,\"block_type\" : \"cobblestone\",\"feature_type\" : \"Blockage\"}]"
          ],
          "items": {
            "$id": "http://asist.aptima.com/schemas/mission_blockage.json",
            "$schema": "http://json-schema.org/draft-07/schema#",
            "definitions": {},
            "properties": {
              "block_type": {
                "$id": "#/properties/block_type",
                "examples": [
                  "cobblestone",
                  "dirt"
                ],
                "pattern": "^(.*)$",
                "title": "The Block Type Schema",
                "type": "string"
              },
              "feature_type": {
                "$id": "#/properties/feature_type",
                "examples": [
                  "Blockage"
                ],
                "pattern": "^(.*)$",
                "title": "The Feature Type Schema",
                "type": "string"
              },
              "room_name": {
                "$id": "#/properties/room_name",
                "examples": [
                  "Security Office"
                ],
                "pattern": "^(.*)$",
                "title": "The Room Name Schema",
                "type": "string"
              },
              "x": {
                "$id": "#/properties/x",
                "default": 0.0,
                "examples": [
                  -2194.8933503172193
                ],
                "title": "The X Schema",
                "type": "number"
              },
              "y": {
                "$id": "#/properties/y",
                "default": 0.0,
                "examples": [
                  24.0
                ],
                "title": "The Y Schema",
                "type": "number"
              },
              "z": {
                "$id": "#/properties/z",
                "default": 0.0,
                "examples": [
                  190.33727
                ],
                "title": "The Z Schema",
                "type": "number"
              }
            },
            "required": [
              "x",
              "y",
              "z",
              "block_type"
            ],
            "title": "Misson Blockage Schema",
            "type": "object",
            "version": "0.2"
          },
          "title": "The Blockage List Schema",
          "type": "array"
        }
      },
      "required": [
        "mission",
        "mission_blockage_list"
      ],
      "title": "The GroundTruth Mission:BlockageList Schema",
      "type": "object"
    },
    "header": {
      "$id": "http://asist.aptima.com/schemas/common_header.json",
      "$schema": "http://json-schema.org/draft-07/schema#",
      "definitions": {},
      "properties": {
        "message_type": {
          "$id": "#/properties/message_type",
          "const": "groundtruth",
          "enum": [
            "control",
            "observation",
            "chat",
            "status",
            "trial",
            "event",
            "groundtruth",
            "experiment",
            "metadata",
            "agent"
          ],
          "examples": [
            "observation"
          ],
          "pattern": "^([a-z_]*?)$",
          "title": "The Message_type Schema",
          "type": "string"
        },
        "timestamp": {
          "$id": "#/properties/timestamp",
          "examples": [
            "2019-12-26T12:47:23.1234Z"
          ],
          "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}[.]?[0-9]{0,}?Z",
          "title": "The Timestamp Schema",
          "type": "string"
        },
        "version": {
          "$id": "#/properties/version",
          "examples": [
            "1.0",
            "2.3.1"
          ],
          "pattern": "^([0-9]+\\.)?([0-9]+\\.)?([0-9]+)$",
          "title": "The message format version",
          "type": "string"
        }
      },
      "required": [
        "timestamp",
        "message_type",
        "version"
      ],
      "title": "ASIST message common header Schema",
      "type": "object",
      "version": "0.3"
    },
    "msg": {
      "$id": "http://asist.aptima.com/schemas/event_message.json",
      "$schema": "http://json-schema.org/draft-07/schema#",
      "definitions": {},
      "properties": {
        "experiment_id": {
          "$id": "#/properties/experiment_id",
          "default": "",
          "examples": [
            "123e4567-e89b-12d3-a456-426655440000"
          ],
          "pattern": "(([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})|Not Set|Null|null)",
          "title": "The Experiment Id Schema",
          "type": "string"
        },
        "replay_id": {
          "$id": "#/properties/replay_id",
          "default": "",
          "examples": [
            "123e4567-e89b-12d3-a456-426655440000"
          ],
          "pattern": "(([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})|Not Set|null|Null)",
          "title": "The Replay Id Schema",
          "type": [
            "string",
            "null"
          ]
        },
        "replay_parent_id": {
          "$id": "#/properties/replay_parent_id",
          "default": "",
          "examples": [
            "123e4567-e89b-12d3-a456-426655440000"
          ],
          "pattern": "(([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})|Not Set|null|Null)",
          "title": "The Replay Parent Id Schema",
          "type": [
            "string",
            "null"
          ]
        },
        "replay_parent_type": {
          "$id": "#/properties/replay_parent_type",
          "enum": [
            "TRIAL",
            "REPLAY",
            null
          ],
          "title": "The Replay Parent Type Schema",
          "type": [
            "string",
            "null"
          ]
        },
        "source": {
          "$id": "#/properties/source",
          "default": "",
          "examples": [
            "simulator"
          ],
          "pattern": "^(.*)$",
          "title": "The Source Schema",
          "type": "string"
        },
        "sub_type": {
          "$id": "#/properties/sub_type",
          "const": "Mission:BlockageList",
          "default": "",
          "examples": [
            "equip",
            "triage"
          ],
          "pattern": "^([a-zA-Z0-9_:]*?)$",
          "title": "The Sub Type Schema",
          "type": "string"
        },
        "timestamp": {
          "$id": "#/properties/timestamp",
          "default": "",
          "examples": [
            "2019-12-26T14:05:02.3412Z"
          ],
          "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}[.]?[0-9]{0,}?Z",
          "title": "The Timestamp Schema",
          "type": "string"
        },
        "trial_id": {
          "$id": "#/properties/trial_id",
          "default": "",
          "examples": [
            "123e4567-e89b-12d3-a456-426655440000"
          ],
          "pattern": "(([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})|Not Set|null|Null)",
          "title": "The Trial Id Schema",
          "type": "string"
        },
        "version": {
          "$id": "#/properties/version",
          "default": "",
          "examples": [
            "0.1",
            "1.0.1"
          ],
          "pattern": "^([.]*)|(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$",
          "title": "The Version Schema",
          "type": "string"
        }
      },
      "required": [
        "experiment_id",
        "timestamp",
        "source",
        "sub_type",
        "version"
      ],
      "title": "The Event Message Schema",
      "type": "object",
      "version": "0.5"
    }
  },
  "required": [
    "header",
    "msg",
    "data"
  ],
  "title": "The GroundTruth Mission:BlockageList Schema",
  "type": "object",
  "version": "0.5"
}

Upstream spec documentation

GroundTruth Subtype:Mission:BlockageList Message Format

This GroundTruth message subtype is used to communicate the blockage list.

TOPIC

ground_truth/mission/blockages_list

Message Fields

Field Name	Type	Description
header	object	From Common Header Format section
msg	object	From the Common Event Message Format section
data.mission	string	The name of the mission in progress
data.mission_blockage_list	List of mission_blockage	the list of blockages in the mission

Message Example

{
    "header": {
        "timestamp": "2019-12-26T12:47:23.1234Z",
        "message_type": "groundtruth",
        "version": "0.5"
    },
    "msg": { 
        "experiment_id": "563e4567-e89b-12d3-a456-426655440000",
        "trial_id": "123e4567-e89b-12d3-a456-426655440000",
        "timestamp": "2019-12-26T14:05:02.1412Z",
        "source": "simulator",
        "sub_type": "Mission:BlockageList",
        "version": "0.5"
    },
    "data": {
        "mission": "Falcon",    
        "mission_blockage_list" : [ {
            "x" : -2088.0,
            "y" : 60.0,
            "z" : 146.0,
            "block_type" : "cobblestone",
            "room_name" : "",
            "feature_type" : "Blockage"
        }, {
            "x" : -2087.0,
            "y" : 60.0,
            "z" : 146.0,
            "block_type" : "dirt",
            "room_name" : "",
            "feature_type" : "Blockage"
        } ]
    }
}