Skip to content

Commit

Permalink
Docs: Apollo 5.5 update
Browse files Browse the repository at this point in the history
  • Loading branch information
natashadsouza authored and xiaoxq committed Jan 3, 2020
1 parent d0a40a4 commit 8abb46d
Show file tree
Hide file tree
Showing 8 changed files with 207 additions and 1 deletion.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,27 @@ The car now has 360-degree visibility, along with upgraded perception deep learn
* Simulation
* [Apollo Synthetic Data Set](http://apollo.auto/synthetic.html)

[**Apollo 5.5:**](docs/quickstart/apollo_5_5_quick_start.md)

Apollo 5.5 enhances the complex urban road autonomous driving capabilities of previous Apollo releases, by introducing curb-to-curb driving support. With this new addition, Apollo is now a leap closer to fully autonomous urban road driving.
The car has complete 360-degree visibility, along with upgraded perception deep learning model and a brand new prediction model to handle the changing conditions of complex road and junction scenarios, making the car more secure and aware.

![](docs/demo_guide/images/Apollo_5_5_Architecture.png)

**For Setup:**

* Hardware:

* Same as Apollo 5.0

* Software:

* [Data Pipeline](https://github.com/ApolloAuto/apollo/tree/master/modules/tools/fuel_proxy)
* Perception
* Planning
* Control
* Prediction
* Simulation

## Architecture

Expand Down Expand Up @@ -277,6 +298,8 @@ Congratulations! You have successfully built out Apollo without Hardware. If you

* [Apollo 5.0 QuickStart Guide](docs/quickstart/apollo_5_0_quick_start.md)

* [Apollo 5.5 QuickStart Guide](docs/quickstart/apollo_5_5_quick_start.md)

## Documents

* [Technical Tutorial](docs/technical_tutorial/README.md): Everything you need to know about Apollo. Written as individual versions with links to every document related to that version.
Expand Down
21 changes: 21 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
# Release 5.5

Apollo 5.5 enhances the complex urban road autonomous driving capabilities of previous Apollo releases, by introducing curb-to-curb driving support. With this new addition, Apollo is now a leap closer to fully autonomous urban road driving.
The car has complete 360-degree visibility, along with upgraded perception deep learning model a brand new prediction model to handle the changing conditions of complex road and junction scenarios, making the car more secure and aware. New Planning scenarios have been introduced to support curb-side functionality.

## Major Features And Improvements
* Brand new Data Pipeline Service
* Sensor Calibration service
* Scenario - Based Planning with a new planning scenarios to support curb-to-curb driving
* Park and go
* Emergency pull over
* Prediction Model - Caution Obstacle
* Semantic LSTM evaluator
* Extrapolation predictor
* Control module
* Control profiling
* Simulation scenarios

## Autonomous Drive Capabilities
Vehicles with this version can drive autonomously in complex urban road conditions including both residential and downtown areas. **BE CAUTIOUS WHEN DRIVING AUTONOMOUSLY, ESPECIALLY AT NIGHT OR IN POOR VISION ENVIRONMENT. URBAN DRIVING INVOLVES NAVIGATING HIGH RISK ZONES LIKE SCHOOLS, PLEASE TEST APOLLO 5.0 WITH THE SUPPORT FROM APOLLO ENGINEERING TEAM, PLEASE AVOID DRIVING THE VEHICLE ON THE HIGHWAY OR AT SPEEDS THAT ARE ABOVE OUR SUPPORTED THRESHOLD**.

# Release 5.0

Apollo 5.0 is an effort to support volume production for Geo-Fenced Autonomous Driving. The car now has 360-degree visibility, along with upgraded perception deep learning model to handle the changing conditions of complex road scenarios, making the car more secure and aware. Scenario-based planning has been enhanced to support additional scenarios like pull over and crossing bare intersections.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions docs/quickstart/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Quick Start Guides

## Apollo 5.5

- [Apollo 5.5 quick start](apollo_5_5_quick_start.md)
- [Apollo 3.5 hardware system installation guide](apollo_3_5_hardware_system_installation_guide.md) - Since there are no changes in our Hardware setup, please refer to the Apollo 3.5 guide
- [Apollo 5.0 technical guide](https://github.com/ApolloAuto/apollo/blob/master/docs/technical_tutorial/apollo_5.5_technical_tutorial.md) - Everything you need to know about Apollo 5.0


## Apollo 5.0

- [Apollo 5.0 quick start](apollo_5_0_quick_start.md)
Expand Down
83 changes: 83 additions & 0 deletions docs/quickstart/apollo_5_5_quick_start.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# Apollo 5.5 Quick Start Guide

The following guide serves as a user manual for launching the Apollo upgraded software and hardware stack on vehicle.

The the latest Apollo upgrade, Quick Start Guide focuses on the new features. For general Apollo concepts, please refer to
[Apollo 3.5 Quick Start](https://github.com/ApolloAuto/apollo/blob/master/docs/quickstart/apollo_3_5_quick_start.md)

## Contents

- [Calibration Guide](#calibration-guide)
- [Hardware and Software Installation](#hardware-and-software-installation)
- [Dreamview Usage Table](#dreamview-usage-table)
- [Onboard Test](#onboard-test)

## Calibration Guide

Apollo currently offers a robust calibration service to support your calibration requirements from LiDARs to IMU to Cameras. This service is currently being offered to select partners only as part of our Data Pipeline service offering. If you would like to learn more about the calibration service, please reach out to us via email: **[email protected]**

## Hardware and Software Installation

The Hardware setup for Apollo 5.5 remains the same as Apollo 3.5, please refer to
[Apollo 3.5 Hardware and System Installation Guide](apollo_3_5_hardware_system_installation_guide.md)
for the steps to install the hardware components and the system software, as well as
[Apollo Software Installation Guide](apollo_software_installation_guide.md).

## Dreamview Usage Table

For questions regarding Dreamview icons refer to the
[Dreamview Usage Table](https://github.com/ApolloAuto/apollo/blob/master/docs/specs/dreamview_usage_table.md).
For questions regarding Dreamland and the scenario editor, please visit our [Dreamland Introduction guide](https://github.com/ApolloAuto/apollo/blob/master/docs/specs/Dreamland_introduction.md)

## Onboard Test

1. Plug-in an external hard-drive to any available USB port in the host machine

2. Turn on the vehicle, and then the host machine

3. Launch the Dev Docker Container

4. Launch DreamView

Note\: Use your favorite browser to access Dreamview web service in your host
machine browser with URL http://localhost:8888

![](images/dreamview_2_5.png)

5. Select Mode, Vehicle and Map

![](images/dreamview_2_5_setup_profile.png)

Note\: You'll be required to setup profile before doing anything else. Click
the dropdown menu to select **Navigation** mode, the HDMap and vehicle you
want to use. The lists are defined in
[HMI config file](https://raw.githubusercontent.com/ApolloAuto/apollo/master/modules/dreamview/conf/hmi.conf)

Note\: It's also possible to change the profile on the right panel of the
HMI, but just remember to click `Reset All` on the top-right corner to
restart the system

6. Start the Modules.

Click the `Setup` button

![](images/dreamview_2_5_setup.png)

Go to **Module Controller** tab, check if all modules and hardware are ready
(Note\: In your offline environment, the hardware modules such as GPS,
CANBus, Velodyne, Camera and Radar cannot be brought up)
(Note\: You may need to drive around a bit to get a good GPS signal)

![](images/dreamview_2_5_module_controller.png)

7. Under `Default Routing` select your desired route

8. Under Tasks click `Start Auto`. (Note: Be cautious when starting the autonomous
driving, you should now be in autonomous mode)

![](images/dreamview_2_5_start_auto.png)

9. After the autonomous testing is complete, under `Tasks` click `Reset All`, close all
windows and shutdown the machine

10. Remove the hard drive
1 change: 1 addition & 0 deletions docs/technical_tutorial/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

Refer these documents as a guide to all other relevant documents for the version of Apollo that you would like to build out.

- [Apollo 5.5](apollo_5.5_technical_tutorial.md)
- [Apollo 5.0](apollo_5.0_technical_tutorial.md)
- [Apollo 3.5](apollo_3.5_technical_tutorial.md)
- [Apollo 3.0](apollo_3.0_technical_tutorial.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/technical_tutorial/apollo_5.0_technical_tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
## Software architecture and algorithms
> Deep dive into Apollo's modules and algorithms
* [Apollo 5.0 software architecture](https://github.com/ApolloAuto/apollo/blob/master/docs/specs/Apollo_5.0_Software_Architecture.md "Apollo software architecture")
* [Apollo 5.0 software architecture](https://github.com/ApolloAuto/apollo/blob/master/docs/specs/Apollo_3.5_Software_Architecture.md "Apollo software architecture") - The core software architecture for Apollo 5.5 remains the same as Apollo 3.5
* [3D Obstacle Perception](https://github.com/ApolloAuto/apollo/blob/master/docs/specs/3d_obstacle_perception.md)
* [Apollo 5.0 Perception](https://github.com/ApolloAuto/apollo/blob/master/modules/perception/README.md)
* [Open Space Planner](https://github.com/ApolloAuto/apollo/blob/master/docs/specs/Open_Space_Planner.md)
Expand Down
71 changes: 71 additions & 0 deletions docs/technical_tutorial/apollo_5.5_technical_tutorial.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Apollo 5.5 Technical Tutorial

## Overview
> Learn how to setup Apollo 5.5
* [Apollo 5.5 quick start](https://github.com/ApolloAuto/apollo/blob/master/docs/quickstart/apollo_5_5_quick_start.md)

## Hardware system installation
> Learn the procedure of Apollo 5.5 hardware system installation
* [Apollo 5.5 Hardware System Installation guide](https://github.com/ApolloAuto/apollo/blob/master/docs/quickstart/apollo_3_5_hardware_system_installation_guide.md) - The Hardware setup for Apollo 5.5 remains the same as Apollo 3.5

## Software installation
> Apollo 5.5 Software and Dreamview installation
* [Apollo software installation guide](https://github.com/ApolloAuto/apollo/blob/master/docs/quickstart/apollo_software_installation_guide.md)
* [How to Build and Release](https://github.com/ApolloAuto/apollo/blob/master/docs/howto/how_to_build_and_release.md)
* [How to Debug a Dreamview Start Problem](https://github.com/ApolloAuto/apollo/blob/master/docs/howto/how_to_debug_dreamview_start_problem.md)


## Apollo Cyber
> All you need to know about Apollo Cyber RT
* [Apollo 5.5 all you need to know about Cyber RT](https://github.com/ApolloAuto/apollo/blob/master/docs/cyber/README.md)

## Software architecture and algorithms
> Deep dive into Apollo's modules and algorithms
* [Apollo 5.5 software architecture](https://github.com/ApolloAuto/apollo/blob/master/docs/specs/Apollo_3.5_Software_Architecture.md "Apollo software architecture") - The core software architecture for Apollo 5.5 remains the same as Apollo 3.5
* [3D Obstacle Perception](https://github.com/ApolloAuto/apollo/blob/master/docs/specs/3d_obstacle_perception.md)
* [Apollo 5.5 Perception](https://github.com/ApolloAuto/apollo/blob/master/modules/perception/README.md)
* [Open Space Planner](https://github.com/ApolloAuto/apollo/blob/master/docs/specs/Open_Space_Planner.md)
* [QP-Spline-Path Optimizer](https://github.com/ApolloAuto/apollo/blob/master/docs/specs/qp_spline_path_optimizer.md)
* [QP-Spline-ST-Speed Optimizer](https://github.com/ApolloAuto/apollo/blob/master/docs/specs/qp_spline_st_speed_optimizer.md)
* [Reference Line Smoother](https://github.com/ApolloAuto/apollo/blob/master/docs/specs/reference_line_smoother.md)
* [Traffic Light Perception](https://github.com/ApolloAuto/apollo/blob/master/docs/specs/traffic_light.md)


## Software modules
> Learn Apollo software modules and extension
* [Canbus module](https://github.com/ApolloAuto/apollo/blob/master/modules/canbus/README.md)
* [Common module](https://github.com/ApolloAuto/apollo/blob/master/modules/common/README.md)
* [Control module](https://github.com/ApolloAuto/apollo/blob/master/modules/control/README.md)
* [Data module](https://github.com/ApolloAuto/apollo/blob/master/modules/data/README.md)
* [Localization module](https://github.com/ApolloAuto/apollo/blob/master/modules/localization/README.md)
* [Perception module](https://github.com/ApolloAuto/apollo/blob/master/modules/perception/README.md)
* [Planning module](https://github.com/ApolloAuto/apollo/blob/master/modules/planning/README.md)
* [Prediction module](https://github.com/ApolloAuto/apollo/blob/master/modules/prediction/README.md)
* [Routing module](https://github.com/ApolloAuto/apollo/blob/master/modules/routing/README.md)

## Version relevant How to guides

* [How to run the new Map Verification tool](https://github.com/ApolloAuto/apollo/blob/master/docs/howto/how_to_run_map_verification_tool.md)
* [How to Add a New GPS Receiver](https://github.com/ApolloAuto/apollo/blob/master/docs/howto/how_to_add_a_gps_receiver.md)
* [How to Add a New CAN Card](https://github.com/ApolloAuto/apollo/blob/master/docs/howto/how_to_add_a_new_can_card.md )
* [How to Add a New Control Algorithm](https://github.com/ApolloAuto/apollo/blob/master/docs/howto/how_to_add_a_new_control_algorithm.md)
* [How to Add a New Evaluator in Prediction Module](https://github.com/ApolloAuto/apollo/blob/master/docs/howto/how_to_add_a_new_evaluator_in_prediction_module.md)
* [How to Add a New Predictor in Prediction Module](https://github.com/ApolloAuto/apollo/blob/master/docs/howto/how_to_add_a_new_predictor_in_prediction_module.md)
* [How to Add a New Vehicle](https://github.com/ApolloAuto/apollo/blob/master/docs/howto/how_to_add_a_new_vehicle.md)
* [How to Add a New External Dependency](https://github.com/ApolloAuto/apollo/blob/master/docs/howto/how_to_add_an_external_dependency.md)


## Developer Tools
> Learn Apollo developer tools
* [How to build and debug Apollo in VSCode](https://github.com/ApolloAuto/apollo/blob/master/docs/howto/how_to_build_and_debug_apollo_in_vscode_cn.md "How to build and debug Apollo in VSCode")
* [Introduction of Dreamview](https://github.com/ApolloAuto/apollo/blob/master/docs/specs/dreamview_usage_table.md)
* [Introduction to Dreamland](https://github.com/ApolloAuto/apollo/blob/master/docs/specs/Dreamland_introduction.md)


0 comments on commit 8abb46d

Please sign in to comment.