Skip to content

Commit 6338ac4

Browse files
natashadsouzaycool
natashadsouza
authored and
ycool
committed
All documents for 3.0
1 parent 42d9db3 commit 6338ac4

File tree

94 files changed

+1395
-80
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

94 files changed

+1395
-80
lines changed

‎RELEASE.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,20 @@
1+
# Release 3.0
2+
3+
Apollo 3.0 enables L4 product level solution that allows vehicles to drive in a closed venue setting at a low speed. Automakers can now leverage this one stop solution for autonomous driving without having to customize on their own.
4+
5+
## Major Features And Improvements
6+
* New Safety module called Guardian
7+
* Enhanced Surveillance module - Monitor
8+
* Hardware service layer that will now act like a platform and not a product, giving developers the flexibility to integrate their own Hardware
9+
* Apollo Sensor Unit (ASU)
10+
* New Gatekeeper - Ultrasonic Sensor
11+
* Perception module changes:
12+
- **CIPV detection/ Tailgating** – moving within a single lane
13+
- Whole lane line support - bold line support for long range accuracy. There are 2 different types on installations for Camera, low and high installation.
14+
- **Online pose estimation** – determines angle change and estimates it when there are bumps or slopes to ensure that the sensors move with the car and the angle/pose changes accordingly
15+
- **Visual localization** – we now use camera for localization. This functionality is currently being tested.
16+
- **Ultrasonic Sensor** – Currently being tested as the final gatekeeper to be used in conjunction with Guardian for Automated Emergency brake and vertical/perpendicular parking.
17+
118
# Release 2.5
219
This release allows the vehicle to autonomously run on geo-fenced highways. Vehicles are able to do lane keeping cruise and avoid collisions with the leading vehicles.
320

‎docs/howto/How_to_use_a_different_vehicle.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# How to use a different vehicle
2+
3+
To add a different Vehicle, you must first follow the [Readme Installation steps](https://github.com/ApolloAuto/apollo/blob/master/README.md) to assemble and launch Apollo successfully.
4+
5+
In order to support a new vehicle in DreamView, please follow the steps below:
6+
7+
1. Create a new folder for your vehicle under `modules/calibration/data`
8+
9+
2. There is already a sample file in the `modules/calibration/data` folder named `mkz_example`. Refer to this structure and include all necessary configuration files in the same file structure as “mkz_example”. Remember to update the configuration files with your own parameters if needed.
10+
11+
3. Restart DreamView and you will be able to see your new vehicle (name is the same as your newly created folder) in the `Vehicle` dropdown menu.
12+
13+
4. Select the newly configured vehicle.
14+

‎docs/quickstart/apollo_3_0_hardware_system_installation_guide.md

Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
# Apollo 3.0 Hardware and System Installation Guide
2+
3+
* [About This Guide](#about-this-guide)
4+
* [Document Conventions](#document-conventions)
5+
* [Introduction](#introduction)
6+
* [Documentation](#documentation)
7+
* [Key Hardware Components](#key-hardware-components)
8+
* [Additional Components Required](#additional-components-required)
9+
* [Steps for the Installation Tasks](#steps-for-the-installation-tasks)
10+
* [At the Office](#at-the-office)
11+
* [In the Vehicle](#in-the-vehicle)
12+
* [Prerequisites](#prerequisites)
13+
* [Diagrams of the Major Component Installations](#diagrams-of-the-major-component-installations)
14+
* [Additional Tasks Required](#additional-tasks-required)
15+
* [Next Steps](#next-steps)
16+
17+
18+
## About This Guide
19+
20+
The *Apollo 3.0 Hardware and System Installation Guide* provides the instructions to install all of the hardware components and system software for the **Apollo Project**. The system installation information included pertains to the procedures to download and install the Apollo Linux Kernel.
21+
22+
### Document Conventions
23+
24+
The following table lists the conventions that are used in this document:
25+
26+
| **Icon** | **Description** |
27+
| ----------------------------------- | ---------------------------------------- |
28+
| **Bold** | Emphasis |
29+
| `Mono-space font` | Code, typed data |
30+
| _Italic_ | Titles of documents, sections, and headings Terms used |
31+
| ![info](images/info_icon.png) | **Info** Contains information that might be useful. Ignoring the Info icon has no negative consequences. |
32+
| ![tip](images/tip_icon.png) | **Tip**. Includes helpful hints or a shortcut that might assist you in completing a task. |
33+
| ![online](images/online_icon.png) | **Online**. Provides a link to a particular web site where you can get more information. |
34+
| ![warning](images/warning_icon.png) | **Warning**. Contains information that must **not** be ignored or you risk failure when you perform a certain task or step. |
35+
36+
## Introduction
37+
38+
The **Apollo Project** is an initiative that provides an open, complete, and reliable software platform for Apollo partners in the automotive and autonomous driving industries. The aim of this project is to enable these entities to develop their own self-driving systems based on the Apollo software stack.
39+
40+
### Documentation
41+
42+
The following set of documentation describes Apollo 3.0:
43+
44+
- ***<u>[Apollo Hardware and System Installation Guide]</u>*** ─ Provides the instructions to install the hardware components and the system software for the vehicle:
45+
46+
- **Vehicle**:
47+
48+
- Industrial PC (IPC)
49+
- Global Positioning System (GPS)
50+
- Inertial Measurement Unit (IMU)
51+
- Controller Area Network (CAN) card
52+
- GPS Antenna
53+
- GPS Receiver
54+
- Light Detection and Ranging System (LiDAR)
55+
- Camera
56+
- Radar
57+
- Apollo Sensor Unit (ASU)
58+
59+
- **Software**:
60+
- Ubuntu Linux
61+
- Apollo Linux Kernel
62+
- NVIDIA GPU Driver
63+
64+
- ***<u>[Apollo Quick Start Guide]</u>*** ─ The combination of a tutorial and a roadmap that provides the complete set of end-to-end instructions. The Quick Start Guide also provides links to additional documents that describe the conversion of a regular car to an autonomous-driving vehicle.
65+
66+
## Key Hardware Components
67+
68+
The key hardware components to install include:
69+
70+
- Onboard computer system ─ Neousys Nuvo-6108GC
71+
- Controller Area Network (CAN) Card ─ ESD CAN-PCIe/402-B4
72+
- General Positioning System (GPS) and Inertial Measurement Unit (IMU) ─
73+
You can select one of the following options:
74+
- NovAtel SPAN-IGM-A1
75+
- NovAtel SPAN® ProPak6™ and NovAtel IMU-IGM-A1
76+
- Navtech NV-GI120
77+
- Light Detection and Ranging System (LiDAR) ─ You can select one of the following options:
78+
- Velodyne HDL-64E S3
79+
- Velodyne Puck series
80+
- Innovusion LiDAR
81+
- Hesai's Pandora
82+
- Cameras — You can select one of the following options:
83+
- Leopard Imaging LI-USB30-AR023ZWDR with USB 3.0 case
84+
- Argus Camera
85+
- Wissen Camera
86+
- Radar — You can select one of the following options:
87+
- Continental ARS408-21
88+
- Delphi ESR 2.5
89+
- Racobit B01HC
90+
91+
### Additional Components Required
92+
93+
You need to provide these additional components for the Additional Tasks Required:
94+
95+
- Apollo Sensor Unit (ASU)
96+
- A 4G router for Internet access
97+
- A USB hub for extra USB ports
98+
- A monitor, keyboard, and mouse for debugging at the car onsite
99+
- Cables: a Digital Visual Interface (DVI) cable (optional), a customized cable for GPS-LiDAR time synchronization
100+
- Apple iPad Pro: 9.7-inch, Wi-Fi (optional)
101+
102+
The features of the key hardware components are presented in the subsequent sections.
103+
104+
## Steps for the Installation Tasks
105+
106+
This section describes the steps to install:
107+
108+
- The key hardware and software components
109+
- The hardware in the vehicle
110+
111+
### At the Office
112+
113+
Perform the following tasks:
114+
115+
- Prepare the IPC:
116+
- Install the CAN card
117+
- Install or replace the hard drive
118+
- Prepare the IPC for powering up
119+
120+
- Install the software for the IPC:
121+
- Ubuntu Linux
122+
- Apollo Kernel
123+
- Nvidia GPU Driver
124+
125+
The IPC is now ready to be mounted on the vehicle.
126+
127+
### In the Vehicle
128+
129+
Perform these tasks:
130+
131+
- Make the necessary modifications to the vehicle as specified in the list of prerequisites
132+
- Install the major components:
133+
- GPS Antenna
134+
- IPC
135+
- GPS Receiver and IMU
136+
- LiDAR's
137+
- Cameras
138+
- Radar
139+
140+
141+
#### Prerequisites
142+
143+
**![warning_icon](images/warning_icon.png)WARNING**: Prior to mounting the major components (GPS Antenna, IPC, and GPS Receiver) in the vehicle, perform certain modifications as specified in the list of prerequisites. The instructions for making the mandatory changes in the list are outside the scope of this document.
144+
145+
The list of prerequisites are as follows:
146+
147+
- The vehicle must be modified for “drive-by-wire” technology by a professional service company. Also, a CAN interface hookup must be provided in the trunk where the IPC will be mounted.
148+
- A power panel must be installed in the trunk to provide power to the IPC and the GPS-IMU. The power panel would also service other devices in the vehicle such as a 4G LTE router. The power panel should be hooked up to the power system in the vehicle.
149+
- A custom-made rack must be installed to mount the GPS-IMU Antenna, the cameras and the LiDAR's on top of the vehicle.
150+
- A custom-made rack must be installed to mount the GPS-IMU in the trunk.
151+
- A custom-made rack must be installed in front of the vehicle to mount the front-facing radar.
152+
- A 4G LTE router must be mounted in the trunk to provide Internet access for the IPC. The router must have built-in Wi-Fi access point (AP) capability to connect to other devices, such as an iPad, to interface with the autonomous driving (AD) system. A user would be able to use the mobile device to start AD mode or monitor AD status, for example.
153+
154+
#### Diagrams of the Major Component Installations
155+
156+
The following two diagrams indicate the locations of where the three major components (GPS Antenna, IPC, GPS Receiver and LiDAR) should be installed on the vehicle:
157+
158+
![major_component_side_view](https://github.com/ApolloAuto/apollo/blob/master/docs/demo_guide/images/Hardware_overview.png)
159+
160+
![major_component_rear_view](images/Car_Rearview.png)
161+
162+
## Additional Tasks Required
163+
164+
Use the components that you were required to provide to perform the following tasks:
165+
166+
1. Connect a monitor using the DVI or the HDMI cables and connect the keyboard and mouse to perform debugging tasks at the car onsite.
167+
168+
2. Establish a Wi-Fi connection on the Apple iPad Pro to access the HMI and control the Apollo ADS that is running on the IPC.
169+
170+
## Next Steps
171+
172+
After you complete the hardware installation in the vehicle, see the [Apollo Quick Start](https://github.com/ApolloAuto/apollo/blob/master/docs/quickstart/apollo_3_0_quick_start.md) for the steps to complete the software installation.
173+

‎docs/quickstart/apollo_3_0_quick_start.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# Apollo 3.0 Quick Start Guide
2+
3+
The following guide serves as a user manual for launching the Apollo 3.0
4+
software and hardware stack on vehicle.
5+
6+
The Apollo 3.0 Quick Start Guide focuses on Apollo 3.0's new features. For general
7+
Apollo concepts, please refer to
8+
[Apollo 1.0 Quick Start](https://github.com/ApolloAuto/apollo/blob/master/docs/quickstart/apollo_1_0_quick_start.md).
9+
10+
## Contents
11+
12+
- [Calibration Guide](#calibration-guide)
13+
- [Hardware and Software Installation](#hardware-and-software-installation)
14+
- [Dreamview Usage Table](#dreamview-usage-table)
15+
- [Onboard Test](#onboard-test)
16+
17+
## Calibration Guide
18+
19+
For the vehicle's onboard testing make sure you have calibrated all the sensors. For
20+
sensor calibration, please refer to
21+
[Apollo 2.0 Sensor Calibration Guide](https://github.com/ApolloAuto/apollo/blob/master/docs/quickstart/apollo_2_0_sensor_calibration_guide.md)
22+
before you proceed.
23+
24+
## Hardware and Software Installation
25+
26+
Please refer to
27+
[Apollo 3.0 Hardware and System Installation Guide](https://github.com/ApolloAuto/apollo/blob/master/docs/quickstart/apollo_3_0_hardware_system_installation_guide.md)
28+
for the steps to install the hardware components and the system software, as well as
29+
[Apollo Software Installation Guide](https://github.com/ApolloAuto/apollo/blob/master/docs/quickstart/apollo_software_installation_guide.md).
30+
31+
## Dreamview Usage Table
32+
33+
For questions regarding Dreamview icons refer to the
34+
[Dreamview Usage Table](https://github.com/ApolloAuto/apollo/blob/master/docs/specs/dreamview_usage_table.md).
35+
36+
## Onboard Test
37+
38+
1. Plug-in an external hard-drive to any available USB port in the host machine.
39+
40+
2. Turn on the vehicle, and then the host machine.
41+
42+
3. Launch Docker Release Container.
43+
44+
4. Launch DreamView.
45+
46+
Note\: Use your favorite browser to access Dreamview web service in your host
47+
machine browser with URL http://localhost:8888.
48+
49+
![](images/dreamview_2_5.png)
50+
51+
5. Select Mode, Vehicle and Map.
52+
53+
![](images/dreamview_2_5_setup_profile.png)
54+
55+
Note\: You'll be required to setup profile before doing anything else. Click
56+
the dropdown menu to select **Navigation** mode, the HDMap and vehicle you
57+
want to use. The lists are defined in
58+
[HMI config file](https://raw.githubusercontent.com/ApolloAuto/apollo/master/modules/dreamview/conf/hmi.conf).
59+
60+
Note\: It's also possible to change the profile on the right panel of the
61+
HMI, but just remember to click `Reset All` on the top-right corner to
62+
restart the system.
63+
64+
6. Start the Modules.
65+
66+
Click the `Setup` button.
67+
68+
![](images/dreamview_2_5_setup.png)
69+
70+
Go to **Module Controller** tab, check if all modules and hardware are ready.
71+
(Note\: In your offline environment, the hardware modules such as GPS,
72+
CANBus, Velodyne, Camera and Radar cannot be brought up.)
73+
(Note\: You may need to drive around a bit to get a good GPS signal.)
74+
75+
![](images/dreamview_2_5_module_controller.png)
76+
77+
7. Under `Default Routing` select your desired route.
78+
79+
8. Under Tasks click `Start Auto`. (Note: Be cautious when starting the autonomous
80+
driving, you should now be in autonomous mode.)
81+
82+
![](images/dreamview_2_5_start_auto.png)
83+
84+
9. After the autonomous testing is complete, under Tasks click `Reset All`, close all
85+
windows and shutdown the machine.
86+
87+
10. Remove the hard drive.

0 commit comments

Comments
 (0)