Add 'log_info' definition to metadata schema (#448)

aurora-opensource · Jul 8, 2019 · 66b5d2d · 66b5d2d
1 parent 38b8521
commit 66b5d2d
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 4 deletions.
diff --git a/docs/api-reference/xviz-metadata-builder.md b/docs/api-reference/xviz-metadata-builder.md
@@ -213,8 +213,8 @@ special and cannot be overwritten.
 
 Special keys:
 
-- `start_time`
-- `end_time`
+- `start_time` (Number) - Start time for the log data
+- `end_time` (Number) - End time for the log data
 
 Parameters:
 

diff --git a/docs/protocol-schema/session-protocol.md b/docs/protocol-schema/session-protocol.md
@@ -146,7 +146,12 @@ created.
 
 **map_info** - currently unspecified
 
-**log_info** - currently unspecified
+**log_info** - timing information
+
+| Name         | Type                  | Description                    |
+| ------------ | --------------------- | ------------------------------ |
+| `start_time` | `optional<timestamp>` | Starting timestamp for the log |
+| `end_time`   | `optional<timestamp>` | Final timestamp for the log    |
 
 **vehicle_info** - currently unspecified
 

diff --git a/modules/schema/examples/session/metadata/complete.json b/modules/schema/examples/session/metadata/complete.json
@@ -37,5 +37,9 @@
       ],
       "config": ""
     }
+  },
+  "log_info": {
+    "start_time": 1557530200.0,
+    "end_time": 1557530300.0
   }
 }
diff --git a/modules/schema/schema/session/log_info.schema.json b/modules/schema/schema/session/log_info.schema.json
@@ -0,0 +1,15 @@
+{
+  "id": "https://xviz.org/schema/session/log_info.json",
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "description": "XVIZ Metadata Log timing information",
+  "type": "object",
+  "properties": {
+    "start_time": {
+      "type": "number"
+    },
+    "end_time": {
+      "type": "number"
+    }
+  },
+  "additionalProperties": true
+}
diff --git a/modules/schema/schema/session/metadata.schema.json b/modules/schema/schema/session/metadata.schema.json
@@ -32,7 +32,7 @@
       }
     },
     "log_info": {
-      "type": "object"
+      "$ref": "https://xviz.org/schema/session/log_info.json"
     },
     "map_info": {
       "type": "object"

diff --git a/xviz/v2/session.proto b/xviz/v2/session.proto
@@ -93,6 +93,7 @@ message Metadata {
   map<string, CameraInfo> cameras = 3;
   map<string, string> stream_aliases = 4;
   map<string, UIPanelInfo> ui_config = 5;
+  LogInfo log_info = 6;
 }
 
 message Error {
@@ -186,3 +187,10 @@ message UIPanelInfo {
   repeated string needed_streams = 2;
   string config = 3;
 }
+
+message LogInfo
+{
+    option (xviz_json_schema) = "session/log_info";
+    double start_time = 1;
+    double end_time = 2;
+}