openpilot README

The project's README from github.com/commaai/openpilot. As one markdown file: README.md.

openpilot

openpilot is an operating system for robotics.
Currently, it upgrades the driver assistance system in 300+ supported cars.

Docs · Roadmap · Contribute · Community · Try it on a comma four

Quick start: bash <(curl -fsSL openpilot.comma.ai)

openpilot tests License: MIT X Follow Discord

Using openpilot in a car

To use openpilot in a car, you need four things:

  1. Supported Device: a comma four, available at comma.ai/shop/comma-four.
  2. Software: The setup procedure for the comma four allows users to enter a URL for custom software. Use the URL openpilot.comma.ai to install the release version.
  3. Supported Car: Ensure that you have one of the 300+ supported cars.
  4. Car Harness: You will also need a car harness to connect your comma four to your car.

We have detailed instructions for how to install the harness and device in a car. Note that it's possible to run openpilot on other hardware, although it's not plug-and-play.

Branches

Running master and other branches directly is supported, but it's recommended to run one of the following prebuilt branches:

comma four branch comma 3X branch URL description
release-mici release-tizi openpilot.comma.ai This is openpilot's release branch.
release-mici-staging release-tizi-staging openpilot-test.comma.ai This is the staging branch for releases. Use it to get new releases slightly early.
nightly nightly openpilot-nightly.comma.ai This is the bleeding edge development branch. Do not expect this to be stable.
nightly-dev nightly-dev installer.comma.ai/commaai/nightly-dev Same as nightly, but includes experimental development features for some cars.

For chestnut, use the following installer URLs:

branch URL description
release-chestnut installer.comma.ai/commaai/release-chestnut This is openpilot's release branch.
release-chestnut-staging installer.comma.ai/commaai/release-chestnut-staging This is the staging branch for releases. Use it to get new releases slightly early.
nightly-chestnut installer.comma.ai/commaai/nightly-chestnut This is the bleeding edge development branch. Do not expect this to be stable.
nightly-chestnut-dev installer.comma.ai/commaai/nightly-chestnut-dev Same as nightly, but includes experimental development features for some cars.

To start developing openpilot

openpilot is developed by comma and by users like you. We welcome both pull requests and issues on GitHub.

Want to get paid to work on openpilot? comma is hiring and offers lots of bounties for external contributors.

Safety and Testing

MIT Licensed

openpilot is released under the MIT license. Some parts of the software are released under other licenses as specified.

Any user of this software shall indemnify and hold harmless Comma.ai, Inc. and its directors, officers, employees, agents, stockholders, affiliates, subcontractors and customers from and against all allegations, claims, actions, suits, demands, damages, liabilities, obligations, losses, settlements, judgments, costs and expenses (including without limitation attorneys’ fees and costs) which arise out of, relate to or result from any use of this software by user.

THIS IS ALPHA QUALITY SOFTWARE FOR RESEARCH PURPOSES ONLY. THIS IS NOT A PRODUCT. YOU ARE RESPONSIBLE FOR COMPLYING WITH LOCAL LAWS AND REGULATIONS. NO WARRANTY EXPRESSED OR IMPLIED.

User Data and comma Account

By default, openpilot uploads driving data to our servers. You can also access your data through comma connect. We use your data to train better models and improve openpilot for everyone.

openpilot is open source software, and users can disable data collection if they wish.

openpilot logs the road-facing cameras, CAN, GPS, IMU, magnetometer, thermal sensors, crashes, and operating system logs. The driver-facing camera and microphone are only logged if you explicitly opt-in in settings.

By using openpilot, you agree to our Privacy Policy. You understand that use of this software or its related services will generate certain types of user data, which may be logged and stored at the sole discretion of comma. By accepting this agreement, you grant an irrevocable, perpetual, worldwide right to comma for the use of this data.

openpilot (commaai/openpilot)

Searching Database…

63.9K ·GitHub
这是什么?openpilot 是一个面向机器人的操作系统,目前为超过 300 款受支持车型的驾驶辅助系统提供动力。
这是要装在手机上的应用,还是专用硬件?它运行在一台名为 comma 设备(comma four)的专用硬件上,安装在车内,而不是你的手机上。
我要怎样才能让 openpilot 在我的车上运行?购买一台 comma four,使用 openpilot.comma.ai 安装器网址刷入以获取发行版构建,确认你的车在 300 多款受支持车型名单中,再安装汽车线束,将设备连接到车辆线路上。
使用前我到底需要准备什么?一台 comma four 设备、一辆受支持的汽车,以及一根汽车线束,用于把设备接入该车的系统线路。以上各项必须同时具备。
这是一款成熟的量产产品吗?不是。README 明确说明,它是 alpha 质量的研究性软件,而不是产品;使用者有责任在使用时遵守当地法律。
我的驾驶数据被收集后会怎样?默认情况下,openpilot 会将驾驶数据(朝向道路的摄像头、CAN、GPS、IMU、磁力计、热传感器、碰撞事件、操作系统日志)上传至 comma 的服务器,用于训练和改进模型;面向驾驶员的摄像头和麦克风仅在你选择加入时才会记录。由于它是开源的,你可以关闭数据收集。
我究竟应该运行哪个分支?追求稳定请使用 release 分支(comma four 用 release-mici,comma 3X 用 release-tizi);想要最新的开发构建可用 nightly;如果想为部分车型体验实验性功能,可用 nightly-dev。所有分支都已预构建,可通过网址直接安装。
为什么安全关键代码要单独放在一个名为 panda 的组件中?panda 用 C 语言实现安全模型,并配有自己的软件在环与硬件在环测试,将关键的制动和转向安全逻辑与 openpilot 其余的 Python 代码库隔离开。
我能在 comma 自家设备之外的硬件上运行 openpilot 吗?可以,但 README 指出,它不像官方 comma four 那样即插即用,你需要自行完成设置。
这套安全模型实际经过了多少测试?openpilot 遵循 ISO26262 指南,每次提交都会运行软件在环测试;comma 内部还通过基于 Jenkins 的硬件在环测试套件,在一个机柜中的 10 台 comma 设备上持续回放行车路线。
Creator
commaai
Size
2.9 GB
Stars
63.9K
Age
9y
Commits · 90 Days