update Dreamview docs

birdfly8888 · Sep 22, 2017 · cc04486 · cc04486
1 parent 5e97dd3
commit cc04486
Show file tree

Hide file tree

Showing 40 changed files with 54 additions and 1 deletion.
diff --git a/docs/specs/dreamview_usage_table.md b/docs/specs/dreamview_usage_table.md
@@ -0,0 +1,49 @@
+# Dreamview Usage Table
+
+
+
+| Visual Element                           | Depiction Explanation                    |
+| ---------------------------------------- | ---------------------------------------- |
+| ![](images/dreamview_usage_table/0clip_image002.png)           | The  autonomous car.                     |
+| ![](images/dreamview_usage_table/0clip_image004.png)           | <ul><li>The wheel steering percentage.</li> <li>The status of left/right turn signals.</li></ul> |
+| ![](images/dreamview_usage_table/0clip_image006.png)           | <ul><li>The driving speed in km/h.</li> <li>The driving mode (AUTO/MANUAL/etc.).</li> <li>The accelerator/brake percentage.</li></ul> |
+| ![](images/dreamview_usage_table/0clip_image008.png)           | A  toggle menu for the types of visual elements displays. |
+| ![](images/dreamview_usage_table/0clip_image010.png)           | Vehicle  obstacle.                       |
+| ![](images/dreamview_usage_table/0clip_image012.png)           | Pedestrian  obstacle.                    |
+| ![](images/dreamview_usage_table/0clip_image014.png)           | Bicycle  obstacle.                       |
+| ![](images/dreamview_usage_table/0clip_image016.png)           | Unknown  obstacle.                       |
+| ![](images/dreamview_usage_table/0clip_image018.png)           | The  velocity arrow shows the direction of the movement with the length  proportional to the magnitude. |
+| ![](images/dreamview_usage_table/0clip_image020.png) | The  white arrow shows the directional heading of the obstacle. |
+| ![](images/dreamview_usage_table/0clip_image022.png)           | The  yellow text indicates the tracking ID of the obstacle. |
+| ![](images/dreamview_usage_table/0clip_image024.png)           | The  lines show the predicted movement of the obstacle with the same color as the  obstacle. |
+| ![](images/dreamview_usage_table/0clip_image026.png)           | The  red thick line shows the routing suggestion. |
+| ![](images/dreamview_usage_table/0clip_image028.png)           | **Stop** depicting the primary stopping reason. |
+| ![](images/dreamview_usage_table/0clip_image030.png)           | **Stop** depicting the object stopping reason. |
+| ![2](images/dreamview_usage_table/0clip_image032.png)          | **Follow** object.                       |
+| ![](images/dreamview_usage_table/0clip_image034.png)           | **Yield** object decision -- the dotted line connects with the respective object. |
+| ![](images/dreamview_usage_table/0clip_image036.png)           | **Overtake** object decision -- the dotted line connects with the respective  object. |
+| ![](images/dreamview_usage_table/0clip_image038.png)           | Nudge  object decision -- the orange zone indicates the area to avoid. |
+| ![](images/dreamview_usage_table/0clip_image040.png)           | Stopping  reason: **Clear-zone in front.** |
+| ![](images/dreamview_usage_table/0clip_image042.png)           | Stopping  reason: **Crosswalk in front.** |
+| ![](images/dreamview_usage_table/0clip_image044.png)           | Stopping  reason: **Destination arrival.** |
+| ![](images/dreamview_usage_table/0clip_image046.png)           | Stopping  reason: **Emergency.**         |
+| ![](images/dreamview_usage_table/0clip_image048.png)           | Stopping  reason: **Auto mode is not ready.** |
+| ![](images/dreamview_usage_table/0clip_image050.png)           | Stopping  reason: **Obstacle is blocking the route.** |
+| ![](images/dreamview_usage_table/0clip_image052.png)           | Stopping  reason: **Pedestrian crossing in front.** |
+| ![](images/dreamview_usage_table/0clip_image054.png)           | Stopping  reason: **Traffic light is yellow/red.** |
+| ![](images/dreamview_usage_table/0clip_image056.png)           | Stopping  reason: **Vehicle in front.**  |
+| ![](images/dreamview_usage_table/0clip_image058.png)           | Stopping  reason: **Stop sign in front.** |
+| ![](images/dreamview_usage_table/0clip_image060.png)           | Stopping  reason: **Yield sign in front.** |
+| ![](images/dreamview_usage_table/0clip_image062.png)           | The  green thick curvy band indicates the planned trajectory. |
+| ![](images/dreamview_usage_table/0clip_image064.png)           | Point  of view: **Default.**             |
+| ![](images/dreamview_usage_table/0clip_image066.png)           | Point  of view: **Near.**                |
+| ![](images/dreamview_usage_table/0clip_image068.png)           | Point  of view: **Overhead.**            |
+| ![](images/dreamview_usage_table/0clip_image070.png)           | Point  of view: Map.  **Zoom in/out:** mouse scroll or pinch with two fingers.  **Move around:** right-click and drag or swipe with three fingers. |
+| ![](images/dreamview_usage_table/0clip_image072.png)           | Send a routing request with the current location as the starting  point and a default end point. |
+| ![](images/dreamview_usage_table/0clip_image074.png)           | Switch to a route-editing page where routing points can be added by left-click. |
+
+
+
+
+
+
diff --git a/docs/specs/images/dreamview_usage_table/.gitattributes b/docs/specs/images/dreamview_usage_table/.gitattributes
@@ -0,0 +1 @@
+*.png filter=lfs diff=lfs merge=lfs -text
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image002.png b/docs/specs/images/dreamview_usage_table/0clip_image002.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image004.png b/docs/specs/images/dreamview_usage_table/0clip_image004.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image006.png b/docs/specs/images/dreamview_usage_table/0clip_image006.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image008.png b/docs/specs/images/dreamview_usage_table/0clip_image008.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image010.png b/docs/specs/images/dreamview_usage_table/0clip_image010.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image012.png b/docs/specs/images/dreamview_usage_table/0clip_image012.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image014.png b/docs/specs/images/dreamview_usage_table/0clip_image014.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image016.png b/docs/specs/images/dreamview_usage_table/0clip_image016.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image018.png b/docs/specs/images/dreamview_usage_table/0clip_image018.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image020.png b/docs/specs/images/dreamview_usage_table/0clip_image020.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image022.png b/docs/specs/images/dreamview_usage_table/0clip_image022.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image024.png b/docs/specs/images/dreamview_usage_table/0clip_image024.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image026.png b/docs/specs/images/dreamview_usage_table/0clip_image026.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image028.png b/docs/specs/images/dreamview_usage_table/0clip_image028.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image030.png b/docs/specs/images/dreamview_usage_table/0clip_image030.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image032.png b/docs/specs/images/dreamview_usage_table/0clip_image032.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image034.png b/docs/specs/images/dreamview_usage_table/0clip_image034.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image036.png b/docs/specs/images/dreamview_usage_table/0clip_image036.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image038.png b/docs/specs/images/dreamview_usage_table/0clip_image038.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image040.png b/docs/specs/images/dreamview_usage_table/0clip_image040.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image042.png b/docs/specs/images/dreamview_usage_table/0clip_image042.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image044.png b/docs/specs/images/dreamview_usage_table/0clip_image044.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image046.png b/docs/specs/images/dreamview_usage_table/0clip_image046.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image048.png b/docs/specs/images/dreamview_usage_table/0clip_image048.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image050.png b/docs/specs/images/dreamview_usage_table/0clip_image050.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image052.png b/docs/specs/images/dreamview_usage_table/0clip_image052.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image054.png b/docs/specs/images/dreamview_usage_table/0clip_image054.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image056.png b/docs/specs/images/dreamview_usage_table/0clip_image056.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image058.png b/docs/specs/images/dreamview_usage_table/0clip_image058.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image060.png b/docs/specs/images/dreamview_usage_table/0clip_image060.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image062.png b/docs/specs/images/dreamview_usage_table/0clip_image062.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image064.png b/docs/specs/images/dreamview_usage_table/0clip_image064.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image066.png b/docs/specs/images/dreamview_usage_table/0clip_image066.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image068.png b/docs/specs/images/dreamview_usage_table/0clip_image068.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image070.png b/docs/specs/images/dreamview_usage_table/0clip_image070.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image072.png b/docs/specs/images/dreamview_usage_table/0clip_image072.png
diff --git a/docs/specs/images/dreamview_usage_table/0clip_image074.png b/docs/specs/images/dreamview_usage_table/0clip_image074.png
diff --git a/modules/dreamview/README.md b/modules/dreamview/README.md
@@ -9,6 +9,9 @@
   * Chassis defined by Protobuf message `Chassis`, which can be found in file `canbus/proto/chassis.proto`.
   * Planning defined by Protobuf message `ADCTrajectory`, which can be found in file `planning/proto/planning.proto`.
   * Monitor defined by Protobuf message `MonitorMessage`, which can be found in file `common/monitor/proto/monitor.proto`.
+  * Perception Obstacles defined by Protobuf message `PerceptionObstacles`, which can be found in file `perception/proto/perception_obstacle.proto`.
+  * Prediction defined by Protobuf message `PredictionObstacles`, which can be found in file `prediction/proto/prediction_obstacle.proto`.
+  * Routing defined by Protobuf message `RoutingResponse`, which can be found in file `routing/proto/routing.proto`.
 
 ## Output
-  A web-based dynamic 3D rendering of the monitored messages in a simulated world.
+  A web-based dynamic 3D rendering of the monitored messages in a simulated world.