wip

openpilot/clearpilot_devqueue_amain.txt

@@ -6,8 +6,13 @@ Latest:
 - the acc cancel does nothing.
 - must simulate actual button presses.
 - add radar dist, model dist, radar speed, model speed to debug hud
+- add wheel touched, wheel override to hud
+
 - fix always on lateral saying its on when actually fully engaged
 
+Notes on speed limit override:
+- we need to capture the original speed and feed it to vtsc and model whule we
+  are under speed adjustment
 
 ------
 - fix lane lines

openpilot/clearpilot_feature_documentation.txt

@@ -1,3 +1,5 @@
+Actual log:
+
 - Pause lateral on lane change
 - Updated color scheme
 - Updated boot / ready logo
@@ -7,4 +9,121 @@
 - Removed nearly everything from onroad ui
 - Monitor never fully fatals
 - Engage / Disengage sounds silenced
-- Removed all 'prime' functionality including map features
+- Removed all 'Prime' functionality including "Navigate on Openpilot"
+
+
+
+Goal, to be able to say:
+
+ClearPilot
+
+-----------------
+
+ClearPilot is a simplified, enhanced, and opinionated modification of OpenPilot 
+with a focus on a consistency, privacy, and ease of use.  The self driving 
+behaviors compared to OpenPilot have been reduced and simplified to focus on lane keep assistance, 
+and to disengage more gracefully on operator override behaviors such as highway lane change or 
+turning at an intersection. It features a redesigned and customized user interface, 
+a dashcam module with a frontend for reviewing dashcam footage, and tools for managing
+device data via wifi or a self hosted web control panel.
+
+ClearPilot aims to provide a consistent, private, and permanent user experience.  Feature updates
+will not change or remove existing configured features, or de-select or remove older driving models. 
+The requirement to be online and periodically check for updates has also been removed - you can install 
+the software once, and never have to update it or go online again.
+
+-------------------
+
+ClearPilot is based on FrogPilot (link), and has been forked from the "May 1st, 2024 Update for FrogPilot 
+v0.9.7", which itself is based off of "Feb 27th, 2024 OpenPilot 0.9.6" release.  It is designed
+for use with Comma 3 / 3X and is not compatable with Comma 2 or older.
+
+ClearPilot is open source software and comes with no guaranteel of mercantability or fitness of any kind.
+
+ClearPilot has some features which may violate local laws or guidelines, or Comma OpenPilot developer 
+safety guidelines, particularly as it relates to driver monitoring.  It is your responsibility to ensure
+that the software you run is allowed by local reguilations.  
+
+It is your responsibility to test the software in a zero traffic environment to evaluate and understand it's behaviors and limitations, 
+and to validate it is sutable and for your usage. You are responsible for what your Comma device and veichele 
+does at all times. 
+
+The software was provided as is, without any guarantee or promise that it is able to perform any task at all with
+or without issue, and useof the software is at your descression and your own risk. (reword)
+
+We need testers! If you would like to help make your car fully compatable with ClearPilot, please
+contact the author at xyz.
+
+-------------------------------
+
+Full Feature Set:
+
+Driving:
+
+- Drastically simplified minimal user interface, with a focus on ease of use for non power users.
+
+- Ability to use a car's stock radar / cruise control functionality, while emulating clicks
+  on the accel + decel buttons to slow down for detected curves.  This is for veicheles which
+  don't support OpenPilot Longitudial Control, or for users who prefer their veicheles stock
+  radar cruise control feature over OpenPilot Longitudial Control.
+
+    - Special support for some specific HKG and Jeep Veichles
+
+- Speed limit control feature - when over or under speed limit, the system prompts
+  for you to increase or decrease speed to ideal cruising speed.
+
+- Feature to disable lane keep assistance when making a turn at an intersection or lane change on the 
+  freeway.  The standard OpenPilot lane change assistance feature is still available.
+
+- Feature to use paddle shifter button to execute a nudgeless assisted lane change at highway speeds.
+
+- Custom trip recording and dashcam module and playback feature.
+
+- Feature to turn off the screen display via steering wheel button.
+
+- Toggle to show camera feed as monochrome for enhanced ui contrast.
+
+- Feature to relax relax driver monitoring requirements & timeouts 50% never / at night / always. 
+   
+- Feature to enhance driver engagement by requiring hands on wheel never / at night / always.
+
+- Ability to create a second driver profile with settings menu pin lockout which can have 
+  alternative requirements for driver safety, such as requiring hands on the wheel at all times,
+  or a maximum amount cruise control speed can be set over the posted speed limit. 
+
+- Warning when traffic in the distance is dected to be significantly slower than current speed.
+
+- Ability to set a custom startup logo and customize some aspects of the user experience.
+
+- All telemetry, features, and connectivity related to Comma.AI / Comma Prime removed. 
+
+- Requirement to get online to update your software every few weeks removed.  Checking for a 
+  new version of the software is only done by user request or by enabling automatic update
+  checks. 
+
+- Ability to set wifi networks as prefered or bandwidth limited.  If connected to a bandwidth
+  limited wifi network and a prefered network becomes available, the system will switch to the
+  prefered network.
+
+- Various automations for other car features on supported veicheles, such as automatic window 
+  roll up and automatically enable HVAC on startup.
+
+- Wifi accessible control panel for for managing device data including dashcam recordings.
+
+- Available self hosted companion application for backing up and managing device data remotly for 
+  power users.  You will be able to host your own ClearPilot installer to ensure you permanently
+  have a copy of the software for your own use.
+
+- Basic Home Assistant integration.
+
+Full documentation for ClearPilot and each of these features is available (here.) 
+
+
+Hidden features, enable by shell:
+
+- Temporarirly suspend monitoring feature.  This mode is canceled whenever a sharp
+      curve is detected, a lead veichele is detected, or lane line detection is weak.
+      This feature is disabled by default and must me enabled by modifying a file on
+
+- If ClearPilot disengages due to driver monitoring detection issue, it will allow
+      re-engagement or driver assistance without a system restart.