From 6c6954aefcef26d0eae70c6ef24796c1b18d20c3 Mon Sep 17 00:00:00 2001 From: Natasha Dsouza Date: Mon, 7 Jan 2019 05:09:10 -0800 Subject: [PATCH] Docs: Cyber documents and corresponding images --- cyber/README.md | 26 +++++++++--------- docs/{cyber => FAQs}/CyberRT_FAQs.md | 1 + docs/specs/cyber/.DS_Store | Bin 0 -> 6148 bytes .../cyber/CyberRT_Developer_Tools.md | 2 +- docs/{ => specs}/cyber/CyberRT_Quick_Start.md | 22 +++++++-------- docs/specs/cyber/images/cyber_monitor.png | 3 ++ docs/specs/cyber/images/cyber_visualizer1.png | 3 ++ docs/specs/cyber/images/cyber_visualizer2.png | 3 ++ docs/specs/cyber/images/cyber_visualizer3.png | 3 ++ docs/specs/cyber/images/cyber_visualizer4.png | 3 ++ 10 files changed, 41 insertions(+), 25 deletions(-) rename docs/{cyber => FAQs}/CyberRT_FAQs.md (99%) create mode 100644 docs/specs/cyber/.DS_Store rename docs/{ => specs}/cyber/CyberRT_Developer_Tools.md (99%) rename docs/{ => specs}/cyber/CyberRT_Quick_Start.md (88%) create mode 100644 docs/specs/cyber/images/cyber_monitor.png create mode 100644 docs/specs/cyber/images/cyber_visualizer1.png create mode 100644 docs/specs/cyber/images/cyber_visualizer2.png create mode 100644 docs/specs/cyber/images/cyber_visualizer3.png create mode 100644 docs/specs/cyber/images/cyber_visualizer4.png diff --git a/cyber/README.md b/cyber/README.md index 95beaab770a..a1e0db45054 100644 --- a/cyber/README.md +++ b/cyber/README.md @@ -1,8 +1,8 @@ # Introduction -Apollo Cyber is an open source high performance runtime framework designed specifically for autonomous driving scenarios. Based on centralized computing model, it is highly optimized for high concurrency, low latency, and high throughput in autonomous driving. +Apollo Cyber RT is an open source, high performance runtime framework designed specifically for autonomous driving scenarios. Based on a centralized computing model, it is greatly optimized for high concurrency, low latency, and high throughput in autonomous driving. -During years of development of autonomous driving technologies, we have learned a lot from our previous experience with Apollo. The industry is evolving, so does Apollo. Going forward, Apollo has already moved from development to productization, with volume deployments in the real world, we see the demands for the highest robustness and high performance. That’s why we spent years of building Apollo Cyber RT, which addresses that requirements of autonomous driving solutions. +During the last few years of the development of autonomous driving technologies, we have learned a lot from our previous experience with Apollo. The industry is evolving and so is Apollo. Going forward, Apollo has already moved from development to productization, with volume deployments in the real world, we see the demands for the highest level of robustness and performance. That’s why we spent years building and perfecting Apollo Cyber RT, which addresses that requirements of autonomous driving solutions. Key benefits of using Apollo Cyber RT: @@ -19,14 +19,14 @@ Key benefits of using Apollo Cyber RT: + Building blocks specifically designed for autonomous driving + Plug and play your own AD system -# Documents - -* [Apollo Cyber RT Quick Start](https://github.com/ApolloAuto/apollo/tree/master/docs/cyber/CyberRT_Quick_Start.md): Everything you need to know about how to start developing your first application module on top of Apollo Cyber RT. - -* [Apollo Cyber RT Developer Tools](https://github.com/ApolloAuto/apollo/tree/master/docs/cyber/CyberRT_Developer_Tools.md): Detailed guidance on how to use the developer tools from Apollo Cyber RT. - -* [Apollo Cyber RT API for Developers](https://github.com/ApolloAuto/apollo/tree/master/docs/cyber/CyberRT_API_for_Developers.md): A comprehensive guide to explore all the APIs of Apollo Cyber RT, with many concrete examples in source code. - -* [Apollo Cyber RT FAQs](https://github.com/ApolloAuto/apollo/tree/master/docs/cyber/CyberRT_FAQs.md): Answers to the most frequently asked questions about Apollo Cyber RT. - -More documents to come soon! +# Documents + +* [Apollo Cyber RT Quick Start](https://github.com/ApolloAuto/apollo/tree/master/docs/specs/cyber/CyberRT_Quick_Start.md): Everything you need to know about how to start developing your first application module on top of Apollo Cyber RT. + +* [Apollo Cyber RT Developer Tools](https://github.com/ApolloAuto/apollo/tree/master/docs/specs/cyber/CyberRT_Developer_Tools.md): Detailed guidance on how to use the developer tools from Apollo Cyber RT. + +* [Apollo Cyber RT API for Developers](https://github.com/ApolloAuto/apollo/tree/master/docs/specs/cyber/CyberRT_API_for_Developers.md): A comprehensive guide to explore all the APIs of Apollo Cyber RT, with many concrete examples in source code. + +* [Apollo Cyber RT FAQs](https://github.com/ApolloAuto/apollo/tree/master/docs/FAQs/cyber/CyberRT_FAQs.md): Answers to the most frequently asked questions about Apollo Cyber RT. + +More documents to come soon! diff --git a/docs/cyber/CyberRT_FAQs.md b/docs/FAQs/CyberRT_FAQs.md similarity index 99% rename from docs/cyber/CyberRT_FAQs.md rename to docs/FAQs/CyberRT_FAQs.md index eb5616ceedb..2d9b3400a5c 100644 --- a/docs/cyber/CyberRT_FAQs.md +++ b/docs/FAQs/CyberRT_FAQs.md @@ -58,3 +58,4 @@ If you have not modified anything at runtime framework layer and have only worke - Fork and clone the Apollo repo with the new framework code which can be found at [apollo/cyber](https://github.com/ApolloAuto/apollo/tree/master/cyber/) --- +More FAQs to follow... \ No newline at end of file diff --git a/docs/specs/cyber/.DS_Store b/docs/specs/cyber/.DS_Store new file mode 100644 index 0000000000000000000000000000000000000000..a6f6f0fb1b9bd51047f469f16ea6c0b7d4d6cb6a GIT binary patch literal 6148 zcmeHKT}lHn5T4N@3%>Nx#~eVA-XNCs1igUPN)@_nL44oC^dQBncmi+W_hm+5H6ZvP zRc0XhCYhhje#<5q5z+b6Y9=xjkp_*ZR4T&hs_Dp`CqOMZ?&NW^o-JmbhvUQ*<4u=pxWrOE4xmX2-!07KmCX&_dNq z47G5~C-=*agQ10sdhwzD>!RK5|x!W>3`NmmLQ~X5oAZ2gXI9 M5E5N5@CyvQ0n_a*nE(I) literal 0 HcmV?d00001 diff --git a/docs/cyber/CyberRT_Developer_Tools.md b/docs/specs/cyber/CyberRT_Developer_Tools.md similarity index 99% rename from docs/cyber/CyberRT_Developer_Tools.md rename to docs/specs/cyber/CyberRT_Developer_Tools.md index 6ba026c65e9..f9f8fe62a49 100644 --- a/docs/cyber/CyberRT_Developer_Tools.md +++ b/docs/specs/cyber/CyberRT_Developer_Tools.md @@ -36,7 +36,7 @@ username@computername:~$: cyber_visualizer As for a point cloud or an image, you can select the source channel through its `ChannelName` sub-item, and `Action` sub-item to play or stop the data from the corresponding channel. As shown in figure below, three cameras' channel data on the buttom sections and one point cloud channel data on the top section are displayed simultaneously. - ![visualization](images/cyber_visualizer3.png) + ![visualization](images/cyber_visualizer3.png) - To adjust the virtual camera in the 3D point cloud scene, you can right click on the point cloud display section. A dialog box will pop up as shown in figure below. diff --git a/docs/cyber/CyberRT_Quick_Start.md b/docs/specs/cyber/CyberRT_Quick_Start.md similarity index 88% rename from docs/cyber/CyberRT_Quick_Start.md rename to docs/specs/cyber/CyberRT_Quick_Start.md index 06d0fe9342c..3c7f644da20 100644 --- a/docs/cyber/CyberRT_Quick_Start.md +++ b/docs/specs/cyber/CyberRT_Quick_Start.md @@ -18,9 +18,9 @@ The example below demonstrates how to create a simple component, then build, run ## Set up the component file structure Please create the following files, assumed under the directory of `/apollo/cyber/examples/common_component_example/`: -- header file: common_component_example.h -- source file: common_component_example.cc -- build file: BUILD +- Header file: common_component_example.h +- Source file: common_component_example.cc +- Build file: BUILD - DAG dependency file: common.dag - Launch file: common.launch @@ -114,9 +114,9 @@ cpplint() To configure the DAG dependency file (common.dag), specify the following items as below: - - channel names: for data input and output - - library path: library built from component class - - class name: the class name of the component + - Channel names: for data input and output + - Library path: library built from component class + - Class name: the class name of the component ```bash # Define all coms in DAG streaming. @@ -141,9 +141,9 @@ To configure the DAG dependency file (common.dag), specify the following items a To configure the launch (common.launch) file, specify the following items: - - the name of the component - - the dag file you just created in the previous step. - - the name of the process which the component runs within + - The name of the component + - The dag file you just created in the previous step. + - The name of the process which the component runs within ```bash @@ -174,13 +174,13 @@ source setup.bash There are two ways to launch the component: -- launch with the launch file (recommended) +- Launch with the launch file (recommended) ```bash cyber_launch start /apollo/cyber/examples/common_component_example/common.launch ``` -- launch with the DAG file +- Launch with the DAG file ```bash mainboard -d /apollo/cyber/examples/common_component_example/common.dag diff --git a/docs/specs/cyber/images/cyber_monitor.png b/docs/specs/cyber/images/cyber_monitor.png new file mode 100644 index 00000000000..d9a050acc93 --- /dev/null +++ b/docs/specs/cyber/images/cyber_monitor.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8ceb7a9ea49131cbba31e76cbfad8eb9536d7b378046208f748d58631bf5e276 +size 184682 diff --git a/docs/specs/cyber/images/cyber_visualizer1.png b/docs/specs/cyber/images/cyber_visualizer1.png new file mode 100644 index 00000000000..3174f554097 --- /dev/null +++ b/docs/specs/cyber/images/cyber_visualizer1.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4f3601dbb02a600ffc589b555aa7e63e6a06cf278a7a0ad1d874aa252e99457e +size 36483 diff --git a/docs/specs/cyber/images/cyber_visualizer2.png b/docs/specs/cyber/images/cyber_visualizer2.png new file mode 100644 index 00000000000..62e979d2b88 --- /dev/null +++ b/docs/specs/cyber/images/cyber_visualizer2.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9092e574e14f628871ae6c6470053ba0eda8df1254a7645640a13a8cd0e3052b +size 199451 diff --git a/docs/specs/cyber/images/cyber_visualizer3.png b/docs/specs/cyber/images/cyber_visualizer3.png new file mode 100644 index 00000000000..76cfb663ec3 --- /dev/null +++ b/docs/specs/cyber/images/cyber_visualizer3.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0416f28339271b8cc4e5486fd843d215a39d48d50eb5460419db831884e29453 +size 893383 diff --git a/docs/specs/cyber/images/cyber_visualizer4.png b/docs/specs/cyber/images/cyber_visualizer4.png new file mode 100644 index 00000000000..7a812b41026 --- /dev/null +++ b/docs/specs/cyber/images/cyber_visualizer4.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:049eb92ab860e2bac187bb3132e13706c4510fbd282330d6bdbebf1347bcc205 +size 24008