From ceb447d0677fbb95629a4a0b14a0c242b18dc25f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9C=BA=E6=A2=B0=E5=B0=8F=E9=B8=BD?= <128568434+jixiexiaoge@users.noreply.github.com> Date: Thu, 26 Dec 2024 20:41:56 +0800 Subject: [PATCH] Update README.md --- README.md | 248 ++++++++++++------------------------------------------ 1 file changed, 53 insertions(+), 195 deletions(-) diff --git a/README.md b/README.md index 1060e2a..8021fee 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ -[![openpilot on the comma 3X](https://i.imgur.com/6l2qbf5.png)](https://comma.ai/shop/comma-3x) What is openpilot? ------ @@ -19,210 +18,69 @@ What is FrogPilot? 🐸 FrogPilot is a fully open-sourced fork of openpilot, featuring clear and concise commits striving to be a resource for the openpilot developer community. It thrives on contributions from both users and developers, focusing on a collaborative, community-led approach to deliver an advanced openpilot experience for everyone! ------ -FrogPilot was last updated on: +# 分支介绍文档 -**June 1st, 2024** +## 概述 +本仓库包含多个分支，每个分支代表不同的功能或开发阶段。以下是每个主要分支的介绍，包括它们的用途和特点。 -Features ------- +## 分支列表 -FrogPilot offers a wide range of customizable features that are easily toggled on or off to suit your preferences. Whether you want a completely stock openpilot experience, or want to add some fun and personal touches, FrogPilot has you covered! Some of the features include: +### 1. `mazda-frogpilot` +- **功能描述**：该分支是 `MoreTore/openpilot` 仓库中的主要开发分支之一。它包含了为 Mazda 车型定制的功能和补丁，针对不同的硬件和软件环境进行了优化。 +- **特点**： + - 专门针对 Mazda 车型的 OpenPilot 配置。 + - 定期合并来自主仓库的更新。 + - 包括一些特定的调整和修复，以提高兼容性和性能。 ------- -⚡ **Advanced Customizations:** +### 2. `mazda-frogpilot-0.9.6` +- **功能描述**：`mazda-frogpilot-0.9.6` 是 `mazda-frogpilot` 分支的一个稳定版本，主要用于生产环境中的长期支持（LTS）版本。此版本包含了经过充分测试的功能，适合用于需要稳定性的场景。 +- **特点**： + - 版本号为 0.9.6，代表该分支处于一个较为稳定的状态。 + - 包括了与 `mazda-frogpilot` 相同的功能，但以稳定性为主，适合在长期使用中依赖。 + - 修复了一些已知问题和漏洞，提供了对旧版硬件的更好支持。 - - "Alert Volume Controller" to set the volume level for each of of openpilot's sounds - - Customize the following distance and jerk values for each personality profile - - Fine tune your car's "Steer Ratio" to perfect your lateral control - - Increase the distance when stopped behind lead vehicles - - Increase the max set speed by a custom interval (i.e. 2, 3, 4, 5, 6, etc. instead of just 1) - - Select between past, present, and future openpilot driving models ------- -🎨 **Custom Themes:** +### 3. `FrogPilot` +- **功能描述**：`FrogPilot` 分支是来自 `frogai` 仓库的主要开发分支，包含了一些较为实验性的新功能和对 OpenPilot 框架的扩展。此分支较为前沿，适合用于开发和测试。 +- **特点**： + - 包含最新的实验功能和改进，适合用于 OpenPilot 框架的扩展和新功能的测试。 + - 比较前沿，可能包含不稳定的功能，不建议直接用于生产环境。 + - 定期进行功能改进和修复。 - - 🐸 Frog theme (with a bonus 🐐 sound effect) - - Russia / Joseph Stalin theme - - 🔌 Tesla theme - - Holiday themes! Minor holidays last a day, while major holidays (Easter, Halloween, Thanksgiving, Christmas) last a week - - Random events triggered by specific actions while driving with openpilot +### 4. `FrogPilot-Development` +- **功能描述**：`FrogPilot-Development` 分支是 `frogai` 仓库中的开发版本，主要用于测试新特性和实验功能。它是 `FrogPilot` 分支的一个延伸，包含了更多的开发版本更新。 +- **特点**： + - 包含了对 `FrogPilot` 分支的进一步开发和实验功能。 + - 该分支可能不稳定，不适合直接投入生产使用。 + - 主要用于开发人员进行功能开发和测试。 - - 📢 Want to add a theme? Request one in the "feature-request" channel in the FrogPilot Discord! ------- -🚀 **Conditional Experimental Mode:** +### 5. `staging` +- **功能描述**：`staging` 分支是 `opgm/openpilot` 仓库中的预发布版本。此分支包含了一些待正式发布的特性和修复，通常会在发布前经过测试。 +- **特点**： + - 该分支包含了所有待发布的功能和修复，适合用于正式发布之前的最后阶段验证。 + - 包括了其他分支中的新特性，但这些特性经过了初步的测试。 + - 是发布过程中的过渡版本。 - - Auto-activates "Experimental Mode" under several conditions, including: - - Approaching intersections and turns while using navigation - - Approaching slower vehicles to take advantage of "Experimental Mode"'s smoother braking - - Curve and stop light/stop sign detection - - Driving below a set speed - - Turn signal activation below 55mph for turn assistance ------- -📊 **Developer UI:** +### 6. `carrot2-v6` +- **功能描述**：`carrot2-v6` 是 `ajouatom/openpilot` 仓库中的分支，针对特定硬件版本（如 Carrot 2 系列硬件）进行了优化。该分支包含了对硬件的兼容性调整和增强功能。 +- **特点**： + - 专为 `Carrot 2` 系列硬件设计，解决了与特定硬件的兼容性问题。 + - 包含了对硬件的优化和更新，适合用于特定硬件的部署。 + - 适合硬件开发人员和特定平台的用户。 - - Display various driving logics such as the distance, speed, and the desired following distance to your lead vehicle - - Lane measuring of the adjacent lanes for lane detection - - Tap the "VEHICLE ONLINE"/"CPU"/"GPU" gauge to toggle between CPU and GPU monitoring - - Tap the "CONNECT ONLINE"/"MEMORY"/"LEFT"/"USED" gauge to toggle between RAM and storage monitoring ------- -🛠 **Device Management:** +## 分支同步与管理 +所有分支都会定期与主仓库进行同步更新，确保它们与最新的代码库保持一致。下面是一些关键的同步步骤： - - Adjustable screen brightness for both onroad and offroad states - - Adjustable screen timeout times for both onroad and offroad states - - Backup and restore previous versions of FrogPilot - - Backup and restore previous versions of toggle configurations - - Battery level threshold to automatically shut the device down after you car's battery falls below a set voltage limit when offroad - - Delete stored driving data for increased privacy/space via the "Device" panel - - Device can operate offline indefinitely - - Disable logging and/or uploading - - Disable uploads while onroad to help reduce data usage - - Flash the Panda within the "Device" menu - - "Standby Mode" that wakes the screen up between engagement states or when important alerts are triggered - - Timer to automatically shut down after going offroad ------- -🚖 **Lateral Adjustments:** +1. **同步 `mazda-frogpilot` 和 `mazda-frogpilot-0.9.6`**： + - 每天同步来自 `MoreTore/openpilot` 仓库中的这两个分支，确保它们获得最新的 bug 修复和功能更新。 + - 删除任何可能存在的冲突分支，并推送到远程仓库。 - - Activate lateral control by simply pressing the "Cruise Control" button - - Force comma's auto tuning for unsupported vehicles - - Lateral control won't disengage on gas or brake - - Nudgeless lane changes with lane detection to prevent driving into curbs or going offroad - - Pause lateral control when below a set speed - - Pause lateral control when pressing the brake - - Pause lateral control when turn signals are active - - Precise turns by using turn desires when below the minimum lane change speed - - [Twilsonco's NNFF](https://github.com/twilsonco/openpilot) for smoother steering control ------- -🚘 **Longitudinal Adjustments:** +2. **同步 `FrogPilot` 和 `FrogPilot-Development`**： + - 从 `frogai` 仓库拉取最新的 `FrogPilot` 和 `FrogPilot-Development` 分支，并确保它们与主仓库保持同步。 + - 强制推送更新的分支，以确保没有遗漏的更改。 - - Aggressive acceleration when following a lead vehicle from a stop - - "Map Turn Speed Controller" to slow down for curves based on stored map data - - With an additional toggle to fine tune the speed aggressiveness - - Smoother braking behind slower leads - - "Speed Limit Controller" to adjust your speed to the posted speed limit - - With additional toggles to set offsets for "0-34 mph", "35-54 mph", "55-64 mph", and "65-99 mph" - - "Sport" and "Eco" acceleration and deceleration profiles - - "Traffic Mode" tailored towards driving in traffic - - Tweak the lead detection threshold to detect leads sooner for smoother braking on stopped/slower vehicles - - "Vision Turn Speed Controller" for smoother handling of curves - - With additional toggles to fine tune the speed aggressiveness and curve detection sensitivity ------- -🗺️ **Navigation:** +3. **同步 `staging` 和 `carrot2-v6`**： + - 从 `opgm/openpilot` 和 `ajouatom/openpilot` 仓库同步 `staging` 和 `carrot2-v6` 分支，确保它们包含所有最新的稳定功能和硬件支持。 + - 对冲突的分支进行删除和重置，确保只有最新的版本。 - - 3D buildings - - Custom map styles - - Full screen map that takes up the entire screen for a more expansive map view - - iOS shortcuts to quickly set navigation destinations - - Navigate on openpilot without a comma prime subscription - - Offline maps - - "Open Street Maps" integration for speed limit control and road name view ------- -🎮 **Onroad UI:** - - - Compass that rotates according to the direction you're driving - - FPS counter in the screen's border - - Hide various UI elements on the screen for a cleaner UI - - Pedals on the onroad UI indicate when the gas/brake pedals are being used - - Road UI Customizations: - - Acceleration path to show the model's desired acceleration/deceleration - - Blind spot path when a vehicle is detected in your blind spot - - Increase/decrease the lane line, path, and road edge widths - - Path edge colors based on specific driving statuses: - - 🔵 Blue - Navigation active - - 🟦 Light Blue - "Always On Lateral" active - - 🟢 Green - Default - - 🟠 Orange - "Experimental Mode" active - - 🔴 Red - "Traffic Mode" active - - 🟡 Yellow - "Conditional Experimental Mode" overridden - - "Unlimited" road UI that extends out as far as the model can see - - Sidebar retains it's previous position between reboots/ignition cycles - - Steering wheel icons - - 📢 Request your own steering wheel icon in the "feature-request" channel! - - Steering wheel in the onroad UI rotates alongside your physical steering wheel ------- -🚙 **Vehicle Specific Additions:** - - - Automatic/manual fingerprint selection to force a selected fingerprint - - Custom longitudinal tunings for GM EVs and trucks for smoother gas and brake control - - Custom longitudinal tunings for Toyota/Lexus for smoother gas and brake control - - Disable openpilot longitudinal control to use your car's stock cruise control - - GM Volt support - - Honda Clarity support - - Increased torque for the Subaru Crosstrek - - Lock doors automatically when in the drive gear for Toyota/Lexus and unlock when in park - - openpilot longitudinal control for GM vehicles without ACC - - Pedal interceptor support for GM vehicles - - "Stop and Go" hack for Toyota's without stop and go functionality - - ZSS support for the Toyota Prius and Sienna ------- -🚦 **Quality of Life Features:** - - - Automatic updates for a completely "set and forget" experience - - Camera view selection - - Custom alerts for green lights, vehicles in blindspot, lead departing, and the current speed limit changing - - Display the driver camera when in reverse - - Driving statistics to show how many hours and miles you've driven on the home screen - - Fleet Manager to easily access your driving data and screen recordings - - Numerical temperature gauge - - Retain tethering status between reboots - - Screenrecorder - - Toggle "Experimental Mode" via the "Lane Departure Alert" button, holding down the "Distance" button for 0.5+ seconds, or by double tapping the screen - -How to Install ------- - -Easiest way to install FrogPilot is via this URL at the installation screen: - -``` -frogpilot.download -``` - -DO NOT install the "FrogPilot-Development" branch. I'm constantly breaking things on there, so unless you don't want to use openpilot, NEVER install it! - -![](https://i.imgur.com/swr0kqJ.png) - -Bug reports / Feature Requests ------- - -If you encounter any issues or bugs while using FrogPilot, or if you have any suggestions for new features or improvements, please don't hesitate to post about it on the Discord! I'm always looking for ways to improve the fork and provide a better experience for everyone! - -To report a bug or request a new feature, make a post in the #bug-reports or #feature-requests channel respectively on the FrogPilot Discord. Please provide as much detail as possible about the issue you're experiencing or the feature you'd like to see added. Photos, videos, log files, or other relevant information are very helpful! - -I will do my best to respond to bug reports and feature requests in a timely manner, but please understand that I may not be able to address every request immediately. Your feedback and suggestions are valuable, and I appreciate your help in making FrogPilot the best it can be! - -Discord ------- - -[Join the FrogPilot Community Discord!](https://discord.gg/frogpilot) - -Credits ------- - -* [AlexandreSato](https://github.com/AlexandreSato) -* [Crwusiz](https://github.com/crwusiz) -* [DragonPilot](https://github.com/dragonpilot-community) -* [ErichMoraga](https://github.com/ErichMoraga) -* [Garrettpall](https://github.com/garrettpall) -* [Mike8643](https://github.com/mike8643) -* [Neokii](https://github.com/Neokii) -* [OPGM](https://github.com/opgm) -* [OPKR](https://github.com/openpilotkr) -* [Pfeiferj](https://github.com/pfeiferj) -* [ServerDummy](https://github.com/ServerDummy) -* [Twilsonco](https://github.com/twilsonco) - -Licensing ------- - -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.** - ---- - - - -![openpilot tests](https://github.com/commaai/openpilot/actions/workflows/selfdrive_tests.yaml/badge.svg) -[![codecov](https://codecov.io/gh/commaai/openpilot/branch/master/graph/badge.svg)](https://codecov.io/gh/commaai/openpilot) +## 结论 +本仓库中的各个分支代表了不同的开发阶段和稳定性需求。通过同步这些分支，我们能够保持项目的最新进展，同时确保对不同硬件和功能的兼容性。请根据需求选择适合的分支进行开发和测试。