forked from ApolloAuto/apollo
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
09a4f00
commit d25a574
Showing
1 changed file
with
20 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,23 @@ | ||
# Storytelling | ||
|
||
Storytelling is a new module as a part of Project Lego. It is a global and high | ||
level Scenario Manager to help coordinate cross-module actions. | ||
## Introduction | ||
Storytelling is a global and high-level Scenario Manager to help coordinate cross-module actions. In order to safely operate the autonomous vehicle on urban roads, complex planning scenarios are needed to ensure safe driving. These complex scenarios may involve different modules to ensure proper maneuvering. In order to avoid a sequential based approach to such scenarios, a new isolated scenario manager, the "Story Telling" module was created. This module creates stories which are complex scenarios that would trigger multiple modules' actions. Per some predefined rules, this module creates ne or multiple stories and publishes to | ||
`/apollo/storytelling` channel. The main advantage of this module is to fine tune the driving experience and also isolate complex scenarios packaging them into stories that can be subscribed to by other modules like Planning, Control etc. | ||
|
||
It selects criteria to decide one or multiple stories and publishes to | ||
`/apollo/storytelling` channel. A story is a high level scenario for the whole | ||
system which could trigger multiple modules' actions. | ||
## Input | ||
|
||
* Localization | ||
* HD Map | ||
|
||
## Output | ||
|
||
* Story - which can be subscribed to by other modules | ||
|
||
## Sample Story | ||
|
||
Please refer to [CloseToJunction](https://github.com/ApolloAuto/apollo/tree/master/modules/storytelling/story_tellers) sample scenario to understand the Story Telling module | ||
|
||
``` | ||
Note: | ||
The base_teller.h is a virtual class to help you implement your own story. Please inherit this class when writing your own story. | ||
``` |