← All message topics · schema VictimSignal/victim_signal_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:VictimSignal`
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	✓
playername	string	✓
participant_id	string	✓
message	string	✓	`No Victim Detected` `Regular Victim Detected` `Critical Victim Detected`
x	number	✓
y	number	✓
z	number	✓
roomname	string	✓

Example message

{"header": {
	"timestamp": "2019-12-26T12:47:23.1234Z",
	"message_type": "event",
	"version": "0.5"
	},
"msg": { 
	"experiment_id": "523e4567-e89b-12d3-a456-426655440000",
    "trial_id": "123e4567-e89b-12d3-a456-426655440000",
	"timestamp": "2019-12-26T14:05:02.1412Z",
	"source": "simulator",
	"sub_type": "Event:Signal",
	"version": "2.0"},
"data": {
	"mission_timer":"8 : 36",
	"elapsed_milliseconds": 15113,
	"playername": "Aptiminer1",
	"participant_id": "P100",	
	"message": "Regular Victim Detected",	
	"x": -2185,
	"y":28,
	"z":198,
	"roomname":"A2"		
	}
}

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": {
        "elapsed_milliseconds": {
          "$id": "#/properties/event/state/elapsed_milliseconds",
          "examples": [
            5000,
            77459,
            689457
          ],
          "pattern": "^[0-9]+$",
          "title": "The Elapsed Milliseconds Schema",
          "type": "number"
        },
        "message": {
          "$id": "#/properties/event/state/message",
          "enum": [
            "No Victim Detected",
            "Regular Victim Detected",
            "Critical Victim Detected"
          ],
          "examples": [
            "No Victim Detected",
            "Regular Victim Detected",
            "Critical Victim Detected"
          ],
          "pattern": "^(.*)$",
          "title": "The Message Schema",
          "type": "string"
        },
        "mission_timer": {
          "$id": "#/properties/event/state/mission_timer",
          "examples": [
            "8 : 36"
          ],
          "pattern": "^(.*)$",
          "title": "The Mission Timer Schema",
          "type": "string"
        },
        "participant_id": {
          "$id": "#/properties/data/participant_id",
          "examples": [
            "E000321"
          ],
          "pattern": "^(.*)$",
          "title": "The Participant id Schema",
          "type": "string"
        },
        "playername": {
          "$id": "#/properties/event/state/source_entity",
          "examples": [
            "Player888, Aptiminer1"
          ],
          "pattern": "^(.*)$",
          "title": "The Playername Schema",
          "type": "string"
        },
        "roomname": {
          "$id": "#/properties/event/state/roomname",
          "examples": [
            "A1",
            "G8"
          ],
          "pattern": "^(.*)$",
          "title": "The Room Name Schema",
          "type": "string"
        },
        "x": {
          "$id": "#/properties/event/state/x",
          "examples": [
            -2185
          ],
          "pattern": "^([0-9]+?)$",
          "title": "The X Schema",
          "type": "number"
        },
        "y": {
          "$id": "#/properties/event/state/y",
          "examples": [
            52
          ],
          "pattern": "^([0-9]+?)$",
          "title": "The Y Schema",
          "type": "number"
        },
        "z": {
          "$id": "#/properties/event/state/z",
          "examples": [
            194
          ],
          "pattern": "^([0-9]+?)$",
          "title": "The Z Schema",
          "type": "number"
        }
      },
      "required": [
        "mission_timer",
        "elapsed_milliseconds",
        "playername",
        "participant_id",
        "message",
        "x",
        "y",
        "z",
        "roomname"
      ],
      "title": "The Victim Signal Event 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:VictimSignal",
          "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 Victim Signal Event State Schema",
  "type": "object",
  "version": "2.0"
}

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.

Message Fields

Field Name	Type	Description
header	object	From Common Header Format section
msg	object	From 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.playername	string	The name of the player triggering the Victim Signal Event
data.message	string	the message emitted by the signal device
data.x	integer	the x location of the entity
data.y	integer	the y location of the entity
data.z	integer	the z location of the entity
data.roomname	string	the roomname associated with this signal

TOPIC

observations/events/player/signal

Message Example

{"header": {
    "timestamp": "2019-12-26T12:47:23.1234Z",
    "message_type": "event",
    "version": "0.5"
    },
"msg": { 
    "experiment_id": "523e4567-e89b-12d3-a456-426655440000",
    "trial_id": "123e4567-e89b-12d3-a456-426655440000",
    "timestamp": "2019-12-26T14:05:02.1412Z",
    "source": "simulator",
    "sub_type": "Event:Signal",
    "version": "2.0"},
"data": {
    "mission_timer":"8 : 36",
    "elapsed_milliseconds": 15113,
    "playername": "Aptiminer1",
    "participant_id": "P100",   
    "message": "Regular Victim Detected",   
    "x": -2185,
    "y":28,
    "z":198,
    "roomname":"A2"     
    }
}

VERSION | DATE | DETAILS | --- | --- | --- | 2.1 | 12/21/2021 | updated message enums to ["No Victim Detected","Regular Victim Detected", "Critical_Victim_Detected"] 2.0 | 11/23/2021 | updated message from Beep to VictimSignal with new properties -> roomname, participant_id