Skip to content

Commit d989c77

Browse files
kyleApolloquning18
authored andcommitted
framework: add Cyber_Terms.md (ApolloAuto#6714)
1 parent e8da7bf commit d989c77

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

docs/cyber/CyberRT_Terms.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
This page describes the definitions of the most common used Cyber-RT terms.
2+
3+
- Component
4+
5+
In autonomous driving system, modules(like perception, localization, control systems...) exist as a form of components under Cyber-RT. Each component communicate with each other through Cyber channels. The component concept not only decouples modules but also provides the flexibility for modules to be divided into components based individual module design.
6+
- Channel
7+
8+
Channels are used to manage the data communication in Cyber-RT. Users can publish/subscribe to the same channel to achieve p2p communication.
9+
- Task
10+
11+
Task is the abstract description of asynchronous computation task in Cyber-RT.
12+
- Node
13+
14+
Node is the fundamental building block of Cyber-RT; every module contains a node and communicates through the node. A module can have different types of communication by defining read/write, service/client in a node.
15+
- Reader/Writer
16+
17+
Message read/write class from/to channel. Reader/Writer are normally created within a node as the major message transfer interface in Cyber-RT.
18+
- Service/Client
19+
20+
Besides reader/writer, Cyber-RT also provides service/client pattern for module communication. It supports two-way communication between nodes. A client node will receive a response when send a request to a service.
21+
- Parameter
22+
23+
Parameter service provides the global parameter access interface in Cyber-RT. It's built based on service/client pattern.
24+
- Service discovery
25+
26+
As a decentralized design framework, Cyber-RT doesn't have a master/center node for service registration. All nodes are treated equally and can find other service nodes through `service discovery`. `UDP` is used in Service discovery.
27+
- CRoutine
28+
29+
Referred to Coroutine concept, Cyber-RT implemented CRoutine to optimize thread usage and system reource allocation.
30+
- Scheduler
31+
32+
To better support autonomous driving scenarios, Cyber-RT provides different kinds of resource scheduling algorithms for developers to choose from.
33+
- Messages
34+
35+
Message is the data unit used in Cyber-RT for data transfer between modules.
36+
- Dag file
37+
38+
Dag file is the config file of module topology. You can define components used, upstream/downstream channels in dag file.
39+
- Launch files
40+
41+
Launch file provides a easy way to start modules. By defining 1 or multiple dag files in the launch file, you can start multiple modules at the same time.
42+
- Record file
43+
44+
Record file is used to record messages sent/received to/from channels in Cyber-RT. Reply record files can help reproduce the behavior of earlier operation of Cyber-RT.
45+

0 commit comments

Comments
 (0)