Skip to content

Commit 6c6954a

Browse files
natashadsouzaycool
authored andcommitted
Docs: Cyber documents and corresponding images
1 parent 9de8d16 commit 6c6954a

File tree

10 files changed

+41
-25
lines changed

10 files changed

+41
-25
lines changed

cyber/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Introduction
22

3-
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.
3+
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.
44

5-
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.
5+
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.
66

77
Key benefits of using Apollo Cyber RT:
88

@@ -19,14 +19,14 @@ Key benefits of using Apollo Cyber RT:
1919
+ Building blocks specifically designed for autonomous driving
2020
+ Plug and play your own AD system
2121

22-
# Documents
23-
24-
* [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.
25-
26-
* [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.
27-
28-
* [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.
29-
30-
* [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.
31-
32-
More documents to come soon!
22+
# Documents
23+
24+
* [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.
25+
26+
* [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.
27+
28+
* [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.
29+
30+
* [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.
31+
32+
More documents to come soon!

docs/cyber/CyberRT_FAQs.md renamed to docs/FAQs/CyberRT_FAQs.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,3 +58,4 @@ If you have not modified anything at runtime framework layer and have only worke
5858
- 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/)
5959

6060
---
61+
More FAQs to follow...

docs/specs/cyber/.DS_Store

6 KB
Binary file not shown.

docs/cyber/CyberRT_Developer_Tools.md renamed to docs/specs/cyber/CyberRT_Developer_Tools.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ username@computername:~$: cyber_visualizer
3636
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.
3737
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.
3838

39-
![visualization](images/cyber_visualizer3.png)
39+
![visualization](images/cyber_visualizer3.png)
4040

4141
- 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.
4242

docs/cyber/CyberRT_Quick_Start.md renamed to docs/specs/cyber/CyberRT_Quick_Start.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ The example below demonstrates how to create a simple component, then build, run
1818
## Set up the component file structure
1919
Please create the following files, assumed under the directory of `/apollo/cyber/examples/common_component_example/`:
2020

21-
- header file: common_component_example.h
22-
- source file: common_component_example.cc
23-
- build file: BUILD
21+
- Header file: common_component_example.h
22+
- Source file: common_component_example.cc
23+
- Build file: BUILD
2424
- DAG dependency file: common.dag
2525
- Launch file: common.launch
2626

@@ -114,9 +114,9 @@ cpplint()
114114

115115
To configure the DAG dependency file (common.dag), specify the following items as below:
116116

117-
- channel names: for data input and output
118-
- library path: library built from component class
119-
- class name: the class name of the component
117+
- Channel names: for data input and output
118+
- Library path: library built from component class
119+
- Class name: the class name of the component
120120

121121
```bash
122122
# Define all coms in DAG streaming.
@@ -141,9 +141,9 @@ To configure the DAG dependency file (common.dag), specify the following items a
141141

142142
To configure the launch (common.launch) file, specify the following items:
143143

144-
- the name of the component
145-
- the dag file you just created in the previous step.
146-
- the name of the process which the component runs within
144+
- The name of the component
145+
- The dag file you just created in the previous step.
146+
- The name of the process which the component runs within
147147

148148
```bash
149149
<cyber>
@@ -174,13 +174,13 @@ source setup.bash
174174

175175
There are two ways to launch the component:
176176

177-
- launch with the launch file (recommended)
177+
- Launch with the launch file (recommended)
178178

179179
```bash
180180
cyber_launch start /apollo/cyber/examples/common_component_example/common.launch
181181
```
182182

183-
- launch with the DAG file
183+
- Launch with the DAG file
184184

185185
```bash
186186
mainboard -d /apollo/cyber/examples/common_component_example/common.dag
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)