Skip to content

Commit

Permalink
Loads of images added
Browse files Browse the repository at this point in the history
  • Loading branch information
OPC CI committed Jul 15, 2018
1 parent 078702b commit dd61f21
Show file tree
Hide file tree
Showing 33 changed files with 272 additions and 30 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Introduction
# Welcome

Welcome to The Openpilot Documentation Project.

Expand All @@ -14,6 +14,12 @@ So the goal is to bring a fresh take to the on-boarding experience to the table.

What better way to do that than with GitHub and some Markdown.

## What is Openpilot?

openpilot is an open source driving assistant. Currently it can be used as an after-market alternative to perform the functions of Adaptive Cruise Control (ACC) and Lane Keeping Assist System (LKAS) for Hondas, Acuras, Toyotas, and a Chevy. It's about on par with Tesla Autopilot and GM Super Cruise, and better than all other manufacturers.

The openpilot codebase has been written to be concise and enable rapid prototyping. We look forward to your contributions - improving real vehicle automation has never been easier.

## Help create documentation

Your contributions to the documentation are always welcome and will continue to make this a necessary resource for newcomers and veterans alike.
Expand Down
13 changes: 10 additions & 3 deletions TABLE_OF_CONTENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,14 @@

### Getting Started

* [Installation](./getting-started/guides/installing-openpilot-on-eon.md)
* [Quick Start](./getting-started/quick-start.md)
* [Installation](./getting-started/installation.md)

### Driving

* [First Drive](./driving/first-drive.md)
* [Safety](./driving/safety.md)
* [Driver Monitoring](./driving/driver-monitoring.md)

### Vehicles

Expand Down Expand Up @@ -60,14 +67,14 @@

### Development

* [Customizations](./development/customizations.md)
* [Future Releases](./development/releases.md)
* [Releases](./development/releases.md)
* [Developer Guides](./development/guides/README.md)
* [Connecting to EON with SSH](./development/guides/connecting-to-eon-with-ssh.md)
* [Installing Addl. Tools for SSH on Windows](./development/guides/installing-additional-tools-ssh-windows10.md)
* [Adding Vehicle Support](./development/guides/add-support-for-a-vehicle.md)
* [Capture a screenshot](./development/guides/capture-a-screenshot.md)
* [Compare two fingerprints](./development/guides/diff-fingerprints.md)
* [Customize the drive ui](./development/guides/customize-the-drive-ui.md)

### Help us document

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Customizations

Recently a lot of folks are interested in customizing Openpilot in one way or another.
We would like to begin organizing these ideas so people can easily find them and make use of them if they desire.

Expand All @@ -7,11 +8,21 @@ Although some things will never be supported by Comma.ai, Inc. They're kind enou
That being said, starting it off here.

## Driving UI

The first and seemingly most popular request is showing more statistics / information on the screen as you're driving.
This code is not available in the core codebase and has been added by various community members.

![](/images/customizations_2018-07-09-10-31-02.png)

### Code for this customization

Find this customization at [ErichMoraga/openpilot](https://github.com/ErichMoraga/openpilot/blob/94bee05480ed00251e72b0a5f87617d45dc6eb16/selfdrive/ui/ui.c)
<style type="text/css">
.gist {width:500px !important;}
.gist-file
.gist-data {max-height: 500px;max-width: 500px;}
</style>
<script src="https://gist.github.com/jfrux/1d0e420684985997ab9af342ebe314e3.js"></script>

### Images of customizations done by community members

![](/images/2018-07-14-21-14-40.png)
28 changes: 14 additions & 14 deletions development/releases.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,22 @@
# Future Releases
# Releases

**PLEASE NOTE:** These are purely based on things released by Comma.ai, Inc.'s CEO publicly on Slack and Periscopes and may or may not change in the future.
**PLEASE NOTE:** These are purely based on things released by Comma.ai, Inc.'s README, George Hotz CEO and/or publicly on Slack and Periscopes and may or may not be subject to change in the future.

## Release Cycle

Comma tries to stick to a 2 week sprint cycle and they release to devel mostly on Sunday's and to release2 on Monday's.

### Latest Release

* **v0.5.x**
* Removes Waze and Spotify
* Driver Monitoring Beta
* Updated UI for the "Home" screen

Comma.ai, Inc. released a tool that helps drivers report disengagement reasons so that the system can learn how to respond to them later. It's only getting smarter from here on out folks.

Visit https://my.comma.ai/ to test out the alpha/beta release of this service.

### Features to look for in future releases

* **v0.6.x**
Expand All @@ -14,15 +25,4 @@ Comma tries to stick to a 2 week sprint cycle and they release to devel mostly o
* White Panda will no longer be supported.
* locationd should ship
* a very integrated location finder daemon with &lt; 1m accuracy
* includes SLAM and dead reckons down to cm
* **v0.5.x**

* Removes Waze and Spotify
* Driver Monitoring
* Updated UI for the "Home" screen _NOTE: The below image may not represent the actual UI but is merely a concept based on information released by George over Periscope._

![](/images/dashboard-3x.png)

![](/images/image%20%283%29.png)


* includes SLAM and dead reckons down to cm
22 changes: 22 additions & 0 deletions driving/driver-monitoring.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Driver Monitoring

Openpilot now comes equipped with Driver Monitoring as of v0.5.
It is not enabled by default and is currently considered beta software.

The prior cutoff limit for engagements was 6 to 6 1/2 minutes without touching the wheel before Openpilot would require you to make contact with the wheel and apply a slight bit of torque.

It still does have these cutoffs if you do not enable Driver Monitoring.
The cut offs have been lowered to 3 minutes in v0.5.

## How does it work

The EON's front facing camera monitors the driver’s head movements.

![](/images/2018-07-14-23-28-27.png)

Whenever you are not watching the road, a warning will appear on the EON's screen immediately.

![](/images/2018-07-14-23-30-26.png)

After **FOUR** seconds of not watching the road and your vehicle will alert you with a loud audible series of beeps.
After **SIX** seconds of not watching the road and the openpilot system will disengage and begin to slow down.
10 changes: 10 additions & 0 deletions driving/first-drive.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# First Drive with Openpilot

Your first drive after [installing Openpilot](/getting-started/installation.md) is always exciting.
You're dying to know if it'll work and what it will be like.

Sometimes the first drive can be kind of discouraging to newcomers that aren't quite sure what to expect.

The first install of Openpilot requires calibration for the software to determine how it is [mounted](/hardware/eon/installation/how-to-mount.md) and what kinds of offsets it has to account for.

This can take anywhere from 10 seconds ([in future versions](/development/releases.md) of Openpilot) all the way up to 30 minutes or so.
51 changes: 51 additions & 0 deletions driving/safety.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Safety

Driving assistants like Openpilot are so nice. I totally forget what life was like without them it seems.
Whenever I'm driving our other vehicles I find myself missing that little special button that makes the car go magically down the street by itself.

But with all of this magic comes great responsibility... to ourselves, our families, and to our fellow drivers.

Openpilot makes a lot of mistakes, especially when it's in unpredictable situations.

This guide will hopefully give you some good advice on how you should operate your vehicle to get the best experience possible out of Openpilot.

## When to engage

Knowing when the right time to engage is important for your safety.

The Comma system does not need you to have Openpilot engaged to contribute driving data about your current drive.
All of that information is captured regardless.

Yes, it does capture disengagement data but that's not worth your life or the lives of your family.

### When NOT to engage

- Do **NOT** engage on winding roads or roads with short or no shoulder.
- Do **NOT** engage while you're in parking lots or other places where there are potentially many people crossing the roadways. Openpilot is not currently able to quickly and accurately detect pedestrians.
- Do **NOT** engage in downtown or highly populated city streets.
- **Avoid** express way lanes that have exit ramps, lanes with cement barriers with no shoulder.

### Recommended places to engage

- Ensure there are always clearly marked lane-lines.
- Do engage on long state routes (with minimal hills and bends) with at least 12 to 24 inches of shoulder.
- Do engage on interstates with clearly marked lane-lines and safe shoulders. Interstates are the best place to use Openpilot. Our experience is that Openpilot loves middle lanes.

## Driver Monitoring

Openpilot comes standard with Driver Monitoring.
This is a safety feature that helps you keep your eye on the road.

Read more about that in [Driver Monitoring](/driving/driver-monitoring.md).

## Seat belt required

Openpilot will not engage if you do not have your seat belt fastened or if you do not have your doors securely closed.

![](/images/2018-07-14-23-06-25.png)

## Collision Mitigation System

The software may also flash red and warn you if it might not be able to stop your vehicle in time or there is concern that there might be a collision.

![](/images/2018-07-14-23-04-54.png)
Binary file modified favicon.ico
Binary file not shown.
133 changes: 131 additions & 2 deletions getting-started/installation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,132 @@
# Installation
# Installing Openpilot on EON

Go to [Installing Openpilot on EON](./guides/installing-openpilot-on-eon.html)
## Required Hardware

Some hardware is required for Openpilot to work.
Currently you must run it on the [EON](../hardware/eon/).
But you'll also need a [Panda](../hardware/eon/), and a [Giraffe](../hardware/giraffe/).

## Preface

It’s important to note that some of these steps and screens may change as the software updates change so please bare with me as I keep this up to date as quickly as possible. Use your imagination if some things are different.

## Guide

### 1. Plug in the EON

Using the provided USB power adapter and cable plug in the EON to power.
This will trigger the EON to boot up.

![](https://cdn-images-1.medium.com/max/800/1*6aT5C-CySd-dUNX1yUj3yA.png)

### 2. Welcome to EON

The initial setup just sets up the initial dashcam software.
We will get to the installation of OpenPilot next.

Tap the `Set up your EON` button to continue.

![](https://cdn-images-1.medium.com/max/800/1*DN19B8_Sjmtpg_NzIk83Xw.png)

### 3. Review the terms

Read through the terms & conditions by scrolling down with your finger until you get to the bottom.

Then click **I agree**.

![](https://cdn-images-1.medium.com/max/800/1*Ivmdq6yZHEt5tvlRcHlabQ.png)

### 4. Select your WiFi

This step may not be available in some versions of OpenPilot.
I’ve seen it get skipped in some cases but if it shows for you, feel free to select your WiFi and connect.
If it does automatically skip for some reason, no fear — you can add this later.

![](https://cdn-images-1.medium.com/max/800/1*6qZ3TdJHdD3WtPu2Wg9NTg.png)

### 5. Adding a SIM Card

If you have a SIM card with an active data plan, insert it into the slot on the side of the EON. If not, no worries — you can either roll without a SIM card and upload via WiFi \(like I do\) or you can go get one later.

![](https://cdn-images-1.medium.com/max/800/1*BnCJeT6nVnVlNHghs8HVSQ.png)

### 6. The EON Dashboard

![](https://cdn-images-1.medium.com/max/800/1*VJZMGXAhbaPdyuegXCRxeA.png)

This is the basic “Home” screen you’ll see whenever EON comes on.

The `New Destination` and `My Drives` buttons are for Chffrplus.
If you’re seriously just using the EON for Chffrplus, then you can stop now with this guide and enjoy.

If you’re planning to use OpenPilot, you probably won’t ever use the buttons on this screen very often.

### 7. Uninstall Chffrplus

In order to install OpenPilot, we must first uninstall the existing Chffrplus software. In the end, Chffrplus is just OpenPilot minus a basic setting… but this is the friendly installer so we must go through this process.

Tap on **Settings** on the home screen.

Scroll down the setting screen and tap on **Uninstall**

![](https://cdn-images-1.medium.com/max/800/1*zXlCqgZngJoslgbSLSpWYA.png)

Confirm your choice by tapping `Uninstall` once more.

![](https://cdn-images-1.medium.com/max/800/1*cdpTM6pdomx2FFXDwiBfjg.png)

Your EON will restart.

![](https://cdn-images-1.medium.com/max/800/1*ILU-HP2sp2rlMeXfx7-aXA.png)

Now you will be taken through a series of prompts.

### 8. SIM card prompt

If you did not insert a SIM card earlier, you will probably get prompted again for this. You can just skip it as you could before.

![](https://cdn-images-1.medium.com/max/800/1*70vSS6_qHb5YeEKMgMx-8Q.png)

In some versions of OpenPilot there is a prompt like this that temporarily displays. It’ll go away on its own I believe, or just hit Skip.

![](https://cdn-images-1.medium.com/max/800/1*9nYJzUifdCPtOZogJrBVsA.png)

### 9. Select Wi-Fi network

You will be definitely need to connect to Wi-Fi at this point since the next step requires a download from Comma.

Enter that now.

![](https://cdn-images-1.medium.com/max/800/1*1H6mOtwDqg7NJ6J4TK7ZLQ.png)

### 10. Install NEOS Program

A NEOS Program as of right now is just OpenPilot.
Enter the following address in the box:

```text
https://openpilot.comma.ai
```

Press `Done` to continue.

![](https://cdn-images-1.medium.com/max/800/1*eQPNvE-vhsz9PAvaVpz6pA.png)

Review the Terms & Conditions and press `Accept`.

![](https://cdn-images-1.medium.com/max/800/1*6f6hmxHbrmltrcV-7cBJrw.png)

Now you will be taken back to the Dashboard screen where you will press Sign In, which will load a prompt to Google Login.

You will need a Google Login to continue as of today. This may change later I’m sure as Comma’s system matures.

![](https://cdn-images-1.medium.com/max/800/1*_ZcKLv8APq_vfWtzi9_FqQ.png)

Once logged in, that’s it! You should now be running OpenPilot.

It looks a lot like Chffrplus, the only difference is — when plugged into a Giraffe / Panda, you will enable LKAS / ACC features of OpenPilot when you start your car and it’s plugged in correctly.

A special thanks to the original author of this write up found here:

Comma EON: Initial Setup with OpenPilot
https://medium.com/@jfrux/comma-eon-initial-setup-with-openpilot-2b5ea58354a
3 changes: 3 additions & 0 deletions getting-started/quick-start.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Quick Start

This will be a list of the first things you'll want to do to get started quickly running Openpilot.
1 change: 0 additions & 1 deletion googlefd78eb180e46817e.html

This file was deleted.

1 change: 1 addition & 0 deletions hardware/eon/installation/universal-ball-mount.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ This is a universal ball bracket for mounting the Eon Dashcam Kit to any windshi

Thingieverse: [Universal Ball Mount for Eon Dashcam](https://www.thingiverse.com/thing:2921054)

![](/images/2018-07-14-21-19-44.png)
Binary file added images/![](/images/2018-07-14-23-11-56.png).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/2018-07-14-21-14-40.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file renamed openpilot.pdf → images/2018-07-14-21-18-45.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/2018-07-14-21-19-44.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/2018-07-14-21-21-22.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/2018-07-14-23-02-03.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/2018-07-14-23-04-54.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/2018-07-14-23-06-25.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/2018-07-14-23-11-56.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/2018-07-14-23-28-27.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/2018-07-14-23-30-26.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/eon_screen_training_02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/eon_screen_training_08.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/images/2018-07-14-23-02-03.png.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/verge-article-02.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/verge-article.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/verse-article-03.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed openpilot.epub
Binary file not shown.
5 changes: 0 additions & 5 deletions vehicles/.base/vehicle-make.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,8 @@ If you have checked your vehicle model page and are confident your vehicle is su
- 1 x [Panda](/hardware/panda/)
- 1 x [Giraffe](/hardware/giraffe/)

{% if addlRequirements %}

### Addl. Requirements for {{ page.title }}

{% block addlRequirements %}
{% endblock %}
{% endif %}

## How to add support for a vehicle

Expand Down
Loading

0 comments on commit dd61f21

Please sign in to comment.