← All message topics · schema Door/door_event_message.json

header

Field	Type	Required	Allowed values	Description
timestamp	string	✓
message_type	string	✓	`event`
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	✓	`Event:Door`
version	string	✓
replay_parent_type	string\|null		`TRIAL` `REPLAY` `null`
replay_parent_id	string\|null
replay_id	string\|null

data

Field	Type	Required	Allowed values
mission_timer	string	✓
elapsed_milliseconds	number	✓
participant_id	string	✓
playername	string
open	boolean	✓	`True` `False`
door_x	number	✓
door_y	number	✓
door_z	number	✓

Example message

{"header": {
	"timestamp": "2019-12-26T12:47:23.1234Z",
	"message_type": "event",
	"version": "0.4"
	},
"msg": {
	"experiment_id": "123e4567-e89b-12d3-a456-426655440000", 
    "trial_id": "123e4567-e89b-12d3-a456-426655440000",
	"timestamp": "2019-12-26T14:05:02.1412Z",
	"source": "simulator",
	"sub_type": "Event:Door",
	"version": "0.4"},
"data": {
	"mission_timer":"8 : 36",
	"elapsed_milliseconds": 15113,
	"participant_id": "E000213",	
	"open": true,	
	"door_x": -2185,
	"door_y":28,
	"door_z":198,	
	}
}

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/data",
      "properties": {
        "door_x": {
          "$id": "#/properties/event/state/lever_x",
          "examples": [
            -2185
          ],
          "pattern": "^([0-9]+?)$",
          "title": "The Door_X Schema",
          "type": "number"
        },
        "door_y": {
          "$id": "#/properties/event/state/lever_y",
          "examples": [
            52
          ],
          "pattern": "^([0-9]+?)$",
          "title": "The Door_Y Schema",
          "type": "number"
        },
        "door_z": {
          "$id": "#/properties/event/state/lever_z",
          "examples": [
            194
          ],
          "pattern": "^([0-9]+?)$",
          "title": "The Door_Z Schema",
          "type": "number"
        },
        "elapsed_milliseconds": {
          "$id": "#/properties/event/state/elapsed_milliseconds",
          "examples": [
            5000,
            77459,
            689457
          ],
          "pattern": "^[0-9]+$",
          "title": "The Elapsed Milliseconds Schema",
          "type": "number"
        },
        "mission_timer": {
          "$id": "#/properties/event/state/mission_timer",
          "examples": [
            "8 : 36"
          ],
          "pattern": "^(.*)$",
          "title": "The Mission Timer Schema",
          "type": "string"
        },
        "open": {
          "$id": "#/properties/event/state/powered",
          "enum": [
            true,
            false
          ],
          "examples": [
            true
          ],
          "title": "The Door Open Schema",
          "type": "boolean"
        },
        "participant_id": {
          "$id": "#/properties/event/state/participant_id",
          "examples": [
            "E000231"
          ],
          "pattern": "^(.*)$",
          "title": "The Participant id Schema",
          "type": "string"
        },
        "playername": {
          "$id": "#/properties/event/state/playername",
          "examples": [
            "Aptiminer1"
          ],
          "pattern": "^(.*)$",
          "title": "The Playername Schema",
          "type": "string"
        }
      },
      "required": [
        "mission_timer",
        "elapsed_milliseconds",
        "participant_id",
        "open",
        "door_x",
        "door_y",
        "door_z"
      ],
      "title": "The Door State Data 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": "event",
          "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": "Event:Door",
          "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 Event State Schema",
  "type": "object",
  "version": "0.1"
}

Upstream spec documentation

Data Subtype: Event Message Format

This data message subtype is used to communicate event data for both the world and the player.

TOPIC

observations/events/player/door

Message Fields

Field Name	Type	Description
header	object	From Common Message Format section
msg	object	From the Common Event Message Format section
data.mission_timer	string	the mission time of the event
data.elapsed_milliseconds	number	the number of elapsed milliseconds since mission start
data.participant_id	string	The participant id of the player being reported
data.playername	string	[Deprecated]The name of the entity that changed state
data.door_x	integer	the x location of the entity
data.door_y	integer	the y location of the entity
data.door_z	integer	the z location of the entity
data.open	boolean	the new state of the entity

Message Example

{"header": {
    "timestamp": "2019-12-26T12:47:23.1234Z",
    "message_type": "event",
    "version": "0.4"
    },
"msg": {
    "experiment_id": "123e4567-e89b-12d3-a456-426655440000", 
    "trial_id": "123e4567-e89b-12d3-a456-426655440000",
    "timestamp": "2019-12-26T14:05:02.1412Z",
    "source": "simulator",
    "sub_type": "Event:Door",
    "version": "0.4"},
"data": {
    "mission_timer":"8 : 36",
    "elapsed_milliseconds": 15113,
    "participant_id": "E000213",    
    "open": true,   
    "door_x": -2185,
    "door_y":28,
    "door_z":198,   
    }
}

Version Change History

Version	Date	Description
1.2	8/12/2021	added participant_id and made playername optional and deprecated
1.1	3/1/2021	Added elapsed_milliseconds field
1.0	6/30/2021	Initial version