ui: preserve custom button presses

# Conflicts:
#	opendbc_repo
#	selfdrive/ui/feedback/feedbackd.py
#	sunnypilot/sunnylink/params_metadata.json

openpilot/common/params_keys.h

@@ -186,6 +186,7 @@ inline static std::unordered_map<std::string, ParamKeyAttributes> keys = {
     {"ShowTurnSignals", {PERSISTENT | BACKUP, BOOL, "0"}},
     {"StandstillTimer", {PERSISTENT | BACKUP, BOOL, "0"}},
     {"TrueVEgoUI", {PERSISTENT | BACKUP, BOOL, "0"}},
+    {"CustomButtonAction", {PERSISTENT | BACKUP, INT, "0"}},
 
     // MADS params
     {"Mads", {PERSISTENT | BACKUP, BOOL, "1"}},

openpilot/selfdrive/ui/layouts/main.py

@@ -3,6 +3,7 @@ from enum import IntEnum
 import openpilot.cereal.messaging as messaging
 from openpilot.system.ui.lib.application import gui_app
 from openpilot.system.ui.widgets import Widget
+from openpilot.selfdrive.ui.sunnypilot.custom_button import CustomButtonAction, handle_custom_button
 from openpilot.selfdrive.ui.layouts.sidebar import Sidebar, SIDEBAR_WIDTH
 from openpilot.selfdrive.ui.layouts.home import HomeLayout
 from openpilot.selfdrive.ui.layouts.settings.settings import SettingsLayout, PanelType
@@ -27,6 +28,7 @@ class MainLayout(Widget):
     super().__init__()
 
     self._pm = messaging.PubMaster(['bookmarkButton', 'userBookmark'])
+    self._custom_button_sock = messaging.sub_sock('carState')
 
     self._sidebar = Sidebar()
     self._current_mode = MainState.HOME
@@ -40,6 +42,10 @@ class MainLayout(Widget):
       MainState.SETTINGS: SettingsLayout(),
       MainState.ONROAD: AugmentedRoadView(),
     }
+    self._custom_button_callbacks = {
+      CustomButtonAction.BOOKMARK: self._on_bookmark_clicked,
+      CustomButtonAction.CYCLE_UI: self._cycle_ui,
+    }
 
     self._sidebar_rect = rl.Rectangle(0, 0, 0, 0)
     self._content_rect = rl.Rectangle(0, 0, 0, 0)
@@ -55,6 +61,7 @@ class MainLayout(Widget):
       gui_app.push_widget(self._onboarding_window)
 
   def _render(self, _):
+    handle_custom_button(messaging.drain_sock(self._custom_button_sock), ui_state.params, self._custom_button_callbacks)
     self._handle_onroad_transition()
     self._render_main_content()
 
@@ -114,6 +121,18 @@ class MainLayout(Widget):
   def _on_settings_clicked(self):
     self.open_settings(PanelType.DEVICE)
 
+  def _show_onroad(self):
+    self._set_current_layout(MainState.ONROAD)
+    self._sidebar.set_visible(False)
+
+  def _cycle_ui(self):
+    if self._current_mode == MainState.ONROAD and not self._sidebar.is_visible:
+      self._sidebar.set_visible(True)
+    elif self._current_mode == MainState.SETTINGS:
+      self._show_onroad()
+    else:
+      self._on_settings_clicked()
+
   def _on_bookmark_clicked(self):
     for service in ('bookmarkButton', 'userBookmark'):
       msg = messaging.new_message(service, valid=True)

openpilot/selfdrive/ui/mici/layouts/main.py

@@ -4,6 +4,7 @@ from openpilot.selfdrive.ui.mici.layouts.home import MiciHomeLayout
 from openpilot.selfdrive.ui.mici.layouts.settings.settings import SettingsLayout
 from openpilot.selfdrive.ui.mici.layouts.offroad_alerts import MiciOffroadAlerts
 from openpilot.selfdrive.ui.mici.onroad.augmented_road_view import AugmentedRoadView
+from openpilot.selfdrive.ui.sunnypilot.custom_button import CustomButtonAction, handle_custom_button
 from openpilot.selfdrive.ui.ui_state import device, ui_state
 from openpilot.selfdrive.ui.mici.layouts.onboarding import OnboardingWindow
 from openpilot.selfdrive.ui.body.layouts.onroad import BodyLayout
@@ -23,6 +24,7 @@ class MiciMainLayout(Scroller):
     super().__init__(snap_items=True, spacing=0, pad=0, scroll_indicator=False, edge_shadows=False)
 
     self._pm = messaging.PubMaster(['bookmarkButton', 'userBookmark'])
+    self._custom_button_sock = messaging.sub_sock('carState')
 
     self._prev_onroad = False
     self._prev_standstill = False
@@ -35,6 +37,10 @@ class MiciMainLayout(Scroller):
     self._settings_layout = SettingsLayout()
     self._car_onroad_layout = AugmentedRoadView(bookmark_callback=self._on_bookmark_clicked)
     self._body_onroad_layout = BodyLayout()
+    self._custom_button_callbacks = {
+      CustomButtonAction.BOOKMARK: self._on_bookmark_clicked,
+      CustomButtonAction.CYCLE_UI: self._cycle_ui,
+    }
 
     # Initialize widget rects
     for widget in (self._home_layout, self._alerts_layout, self._settings_layout,
@@ -95,6 +101,8 @@ class MiciMainLayout(Scroller):
     self._alerts_layout._update_state()
 
   def _render(self, _):
+    handle_custom_button(messaging.drain_sock(self._custom_button_sock), ui_state.params, self._custom_button_callbacks)
+
     if not self._setup:
       if self._alerts_layout.active_alerts() > 0:
         self._scroller.scroll_to(self._alerts_layout.rect.x)
@@ -150,6 +158,23 @@ class MiciMainLayout(Scroller):
       msg = messaging.new_message(service, valid=True)
       self._pm.send(service, msg)
 
+  def _show_layout(self, layout: Widget):
+    if gui_app.widget_in_stack(self._onboarding_window):
+      return
+    gui_app.pop_widgets_to(self, lambda: self._scroll_to(layout))
+
+  def _layout_visible(self, layout: Widget) -> bool:
+    return abs(layout.rect.x - self._rect.x) < self._rect.width / 2
+
+  def _cycle_ui(self):
+    if gui_app.widget_in_stack(self._settings_layout):
+      self._show_layout(self._onroad_layout)
+    elif gui_app.get_active_widget() is self and self._layout_visible(self._home_layout):
+      if not gui_app.widget_in_stack(self._onboarding_window):
+        gui_app.push_widget(self._settings_layout)
+    else:
+      self._show_layout(self._home_layout)
+
   def _on_body_changed(self):
     self._car_onroad_layout.set_visible(not ui_state.is_body)
     self._body_onroad_layout.set_visible(bool(ui_state.is_body))

openpilot/selfdrive/ui/sunnypilot/custom_button.py

@@ -0,0 +1,19 @@
+from enum import IntEnum
+
+from opendbc.car.structs import car
+
+
+class CustomButtonAction(IntEnum):
+  NONE = 0
+  BOOKMARK = 1
+  CYCLE_UI = 3
+
+
+def handle_custom_button(messages, params, callbacks):
+  for msg in messages:
+    custom_pressed = any(be.type == car.CarState.ButtonEvent.Type.altButton2 and be.pressed
+                         for be in msg.carState.buttonEvents)
+    if custom_pressed:
+      action = CustomButtonAction(params.get('CustomButtonAction', return_default=True))
+      if callback := callbacks.get(action):
+        callback()

openpilot/selfdrive/ui/tests/test_custom_button.py

@@ -0,0 +1,21 @@
+from types import SimpleNamespace
+from unittest.mock import Mock
+
+from opendbc.car.structs import car
+
+from openpilot.selfdrive.ui.sunnypilot.custom_button import CustomButtonAction, handle_custom_button
+
+
+def test_custom_button_actions():
+  params = Mock()
+  press = SimpleNamespace(carState=SimpleNamespace(buttonEvents=[SimpleNamespace(
+      type=car.CarState.ButtonEvent.Type.altButton2,
+      pressed=True,
+    )]))
+  messages = [press, SimpleNamespace(carState=SimpleNamespace(buttonEvents=[])), press]
+  callbacks = {action: Mock() for action in CustomButtonAction if action != CustomButtonAction.NONE}
+
+  for action, callback in callbacks.items():
+    params.get.return_value = action
+    handle_custom_button(messages, params, callbacks)
+    assert callback.call_count == 2

openpilot/sunnypilot/sunnylink/settings_ui.json

@@ -2172,6 +2172,26 @@
       "title": "Hyundai / Kia / Genesis Settings",
       "description": "",
       "items": [
+        {
+          "key": "CustomButtonAction",
+          "widget": "multiple_button",
+          "title": "Steering Custom Button",
+          "description": "Choose the openpilot action for the steering wheel custom/star button. OEM functionality is unchanged.",
+          "options": [
+            {
+              "value": 0,
+              "label": "None"
+            },
+            {
+              "value": 1,
+              "label": "Bookmark"
+            },
+            {
+              "value": 3,
+              "label": "Cycle UI"
+            }
+          ]
+        },
         {
           "key": "HyundaiLongitudinalTuning",
           "widget": "multiple_button",

openpilot/sunnypilot/sunnylink/settings_ui_src/pages/vehicle.yaml

@@ -10,6 +10,17 @@ sections:
   title: Hyundai / Kia / Genesis Settings
   description: ''
   items:
+  - key: CustomButtonAction
+    widget: multiple_button
+    title: Steering Custom Button
+    description: Choose the openpilot action for the steering wheel custom/star button. OEM functionality is unchanged.
+    options:
+    - value: 0
+      label: None
+    - value: 1
+      label: Bookmark
+    - value: 3
+      label: Cycle UI
   - key: HyundaiLongitudinalTuning
     widget: multiple_button
     title: Custom Longitudinal Tuning