Device: Driving Screen Off (#1252)

* init

* onroad brightness control

* new icon

* update touch handlling

* don't touch me

* now i feel every touch

* resolve review comments

* tired of this shit

* ugh

* translate

* duplicate

* fix

* adjust

* update param in the same function

* flip

* format

* reorder

---------

Co-authored-by: Jason Wen <haibin.wen3@gmail.com>

common/params_keys.h

@@ -157,6 +157,9 @@ inline static std::unordered_map<std::string, ParamKeyAttributes> keys = {
     {"ModelRunnerTypeCache", {CLEAR_ON_ONROAD_TRANSITION, INT}},
     {"OffroadMode", {CLEAR_ON_MANAGER_START, BOOL}},
     {"Offroad_TiciSupport", {CLEAR_ON_MANAGER_START, JSON}},
+    {"OnroadScreenOffBrightness", {PERSISTENT | BACKUP, INT, "100"}},
+    {"OnroadScreenOffControl", {PERSISTENT | BACKUP, BOOL}},
+    {"OnroadScreenOffTimer", {PERSISTENT | BACKUP, INT, "0"}},
     {"QuickBootToggle", {PERSISTENT | BACKUP, BOOL, "0"}},
     {"QuietMode", {PERSISTENT | BACKUP, BOOL, "0"}},
     {"RainbowMode", {PERSISTENT | BACKUP, BOOL, "0"}},

selfdrive/ui/sunnypilot/SConscript

@@ -91,9 +91,13 @@ brand_settings_qt_src = [
   "sunnypilot/qt/offroad/settings/vehicle/volkswagen_settings.cc",
 ]
 
+display_panel_qt_src = [
+  "sunnypilot/qt/offroad/settings/display/onroad_screen_brightness.cc",
+]
 
 sp_widgets_src = widgets_src + network_src
-sp_qt_src = qt_src + lateral_panel_qt_src + vehicle_panel_qt_src + brand_settings_qt_src + longitudinal_panel_qt_src + osm_panel_qt_src
+sp_qt_src = qt_src + lateral_panel_qt_src + vehicle_panel_qt_src + brand_settings_qt_src + \
+            longitudinal_panel_qt_src + osm_panel_qt_src + display_panel_qt_src
 sp_qt_util = qt_util
 
 Export('sp_widgets_src', 'sp_qt_src', "sp_qt_util")

selfdrive/ui/sunnypilot/qt/offroad/settings/display/onroad_screen_brightness.cc

@@ -0,0 +1,63 @@
+/**
+ * Copyright (c) 2021-, Haibin Wen, sunnypilot, and a number of other contributors.
+ *
+ * This file is part of sunnypilot and is licensed under the MIT License.
+ * See the LICENSE.md file in the root directory for more details.
+ */
+
+#include "selfdrive/ui/sunnypilot/qt/offroad/settings/display/onroad_screen_brightness.h"
+
+OnroadScreenBrightnessControl::OnroadScreenBrightnessControl(const QString &param, const QString &title,
+                                                             const QString &description, const QString &icon,
+                                                             QWidget *parent)
+  : ExpandableToggleRow(param, title, description, icon, parent) {
+  auto *mainFrame = new QFrame(this);
+  auto *mainFrameLayout = new QGridLayout();
+  mainFrame->setLayout(mainFrameLayout);
+  mainFrameLayout->setSpacing(0);
+
+  onroadScreenOffTimer = new OptionControlSP(
+    "OnroadScreenOffTimer",
+    "",
+    "",
+    "",
+    {0, 11}, 1, true, &onroadScreenOffTimerOptions);
+
+  onroadScreenBrightness = new OptionControlSP(
+    "OnroadScreenOffBrightness",
+    "",
+    "",
+    "",
+    {0, 100}, 10, true, nullptr, false);
+
+  connect(onroadScreenOffTimer, &OptionControlSP::updateLabels, this, &OnroadScreenBrightnessControl::refresh);
+  connect(onroadScreenBrightness, &OptionControlSP::updateLabels, this, &OnroadScreenBrightnessControl::refresh);
+  onroadScreenOffTimer->setFixedWidth(280);
+  onroadScreenBrightness->setFixedWidth(280);
+  mainFrameLayout->addWidget(onroadScreenOffTimer, 0, 0, Qt::AlignLeft);
+  mainFrameLayout->addWidget(onroadScreenBrightness, 0, 1, Qt::AlignRight);
+
+  addItem(mainFrame);
+
+  refresh();
+}
+
+void OnroadScreenBrightnessControl::refresh() {
+  // Driving Screen Off Timer
+  int valTimer = std::atoi(params.get("OnroadScreenOffTimer").c_str());
+  std::string labelTimer = "<span style='font-size: 45px; font-weight: 450; color: #FFFFFF;'>";
+  labelTimer += "Delay";
+  labelTimer += " <br><span style='font-size: 40px; font-weight: 450; color:rgb(174, 255, 195);'>";
+  labelTimer += (valTimer < 60 ? std::to_string(valTimer) + "s" : std::to_string(valTimer / 60) + "m");
+  labelTimer += "</span></span>";
+  onroadScreenOffTimer->setLabel(QString::fromStdString(labelTimer));
+
+  // Driving Screen Off Brightness
+  std::string valBrightness = params.get("OnroadScreenOffBrightness");
+  std::string labelBrightness = "<span style='font-size: 45px; font-weight: 450; color: #FFFFFF;'>";
+  labelBrightness += "Brightness";
+  labelBrightness += " <br><span style='font-size: 40px; font-weight: 450; color:rgb(174, 255, 195);'>";
+  labelBrightness += (valBrightness == "0" ? " Screen Off" : valBrightness + "%");
+  labelBrightness += "</span></span>";
+  onroadScreenBrightness->setLabel(QString::fromStdString(labelBrightness));
+}

selfdrive/ui/sunnypilot/qt/offroad/settings/display/onroad_screen_brightness.h

@@ -0,0 +1,42 @@
+/**
+ * Copyright (c) 2021-, Haibin Wen, sunnypilot, and a number of other contributors.
+ *
+ * This file is part of sunnypilot and is licensed under the MIT License.
+ * See the LICENSE.md file in the root directory for more details.
+ */
+
+#pragma once
+
+#include "selfdrive/ui/sunnypilot/ui.h"
+#include "selfdrive/ui/sunnypilot/qt/offroad/settings/settings.h"
+#include "selfdrive/ui/sunnypilot/qt/widgets/controls.h"
+#include "selfdrive/ui/sunnypilot/qt/widgets/expandable_row.h"
+
+static const QMap<QString, QString> onroadScreenOffTimerOptions = {
+  {"0", "15"},
+  {"1", "30"},
+  {"2", "60"},
+  {"3", "120"},
+  {"4", "180"},
+  {"5", "240"},
+  {"6", "300"},
+  {"7", "360"},
+  {"8", "420"},
+  {"9", "480"},
+  {"10", "540"},
+  {"11", "600"}
+};
+
+class OnroadScreenBrightnessControl : public ExpandableToggleRow {
+  Q_OBJECT
+
+public:
+  OnroadScreenBrightnessControl(const QString &param, const QString &title, const QString &desc, const QString &icon,
+                                QWidget *parent = nullptr);
+  void refresh();
+
+private:
+  Params params;
+  OptionControlSP *onroadScreenOffTimer;
+  OptionControlSP *onroadScreenBrightness;
+};

selfdrive/ui/sunnypilot/qt/offroad/settings/display_panel.cc

@@ -15,6 +15,16 @@ DisplayPanel::DisplayPanel(QWidget *parent) : QWidget(parent) {
   QVBoxLayout* vlayout = new QVBoxLayout(sunnypilotScreen);
   vlayout->setContentsMargins(50, 20, 50, 20);
 
+  // Onroad Screen Off/Brightness
+  onroadScreenBrightnessControl = new OnroadScreenBrightnessControl(
+    "OnroadScreenOffControl",
+    tr("Driving Screen Off: Non-Critical Events"),
+    tr("Turn off device screen or reduce brightness after driving starts. "
+       "It automatically brightens again when screen is touched or a critical event occurs."),
+    "",
+    this);
+  list->addItem(onroadScreenBrightnessControl);
+
   sunnypilotScroller = new ScrollViewSP(list, this);
   vlayout->addWidget(sunnypilotScroller);
   main_layout->addWidget(sunnypilotScreen);
@@ -26,4 +36,5 @@ void DisplayPanel::showEvent(QShowEvent *event) {
 }
 
 void DisplayPanel::refresh() {
+  onroadScreenBrightnessControl->refresh();
 }

selfdrive/ui/sunnypilot/qt/offroad/settings/display_panel.h

@@ -7,6 +7,7 @@
 
 #pragma once
 
+#include "selfdrive/ui/sunnypilot/qt/offroad/settings/display/onroad_screen_brightness.h"
 #include "selfdrive/ui/sunnypilot/qt/offroad/settings/settings.h"
 #include "selfdrive/ui/sunnypilot/qt/widgets/scrollview.h"
 
@@ -23,4 +24,5 @@ private:
   QWidget* sunnypilotScreen = nullptr;
   ScrollViewSP *sunnypilotScroller = nullptr;
   Params params;
+  OnroadScreenBrightnessControl *onroadScreenBrightnessControl = nullptr;
 };

selfdrive/ui/sunnypilot/qt/onroad/onroad_home.cc

@@ -25,8 +25,10 @@ void OnroadWindowSP::updateState(const UIStateSP &s) {
 
 void OnroadWindowSP::mousePressEvent(QMouseEvent *e) {
   OnroadWindow::mousePressEvent(e);
+  uiStateSP()->reset_onroad_sleep_timer();
 }
 
 void OnroadWindowSP::offroadTransition(bool offroad) {
   OnroadWindow::offroadTransition(offroad);
+  uiStateSP()->reset_onroad_sleep_timer();
 }

selfdrive/ui/sunnypilot/ui.cc

@@ -11,6 +11,16 @@
 
 void UIStateSP::updateStatus() {
   UIState::updateStatus();
+
+  if (scene.started && scene.onroadScreenOffControl) {
+    auto selfdriveState = (*sm)["selfdriveState"].getSelfdriveState();
+    if (selfdriveState.getAlertSize() != cereal::SelfdriveState::AlertSize::NONE &&
+        selfdriveState.getAlertStatus() != cereal::SelfdriveState::AlertStatus::NORMAL) {
+      reset_onroad_sleep_timer();
+    } else if (scene.onroadScreenOffTimer > 0) {
+      scene.onroadScreenOffTimer--;
+    }
+  }
 }
 
 UIStateSP::UIStateSP(QObject *parent) : UIState(parent) {
@@ -55,6 +65,20 @@ void ui_update_params_sp(UIStateSP *s) {
   s->scene.standstill_timer = params.getBool("StandstillTimer");
   s->scene.speed_limit_mode = std::atoi(params.get("SpeedLimitMode").c_str());
   s->scene.road_name = params.getBool("RoadNameToggle");
+
+  // Onroad Screen Brightness
+  s->scene.onroadScreenOffBrightness = std::atoi(params.get("OnroadScreenOffBrightness").c_str());
+  s->scene.onroadScreenOffControl = params.getBool("OnroadScreenOffControl");
+  s->scene.onroadScreenOffTimerParam = std::atoi(params.get("OnroadScreenOffTimer").c_str());
+  s->reset_onroad_sleep_timer();
+}
+
+void UIStateSP::reset_onroad_sleep_timer() {
+  if (scene.onroadScreenOffTimerParam >= 0 and scene.onroadScreenOffControl) {
+    scene.onroadScreenOffTimer = scene.onroadScreenOffTimerParam * UI_FREQ;
+  } else {
+    scene.onroadScreenOffTimer = -1;
+  }
 }
 
 DeviceSP::DeviceSP(QObject *parent) : Device(parent) {

selfdrive/ui/sunnypilot/ui.h

@@ -61,6 +61,7 @@ public:
       return user.user_id.toLower() != "unregisteredsponsor" && user.user_id.toLower() != "temporarysponsor";
     });
   }
+  void reset_onroad_sleep_timer();
 
 signals:
   void sunnylinkRoleChanged(bool subscriber);

selfdrive/ui/sunnypilot/ui_scene.h

@@ -12,4 +12,7 @@ typedef struct UISceneSP : UIScene {
   bool standstill_timer = false;
   int speed_limit_mode = 0;
   bool road_name = false;
+  int onroadScreenOffBrightness, onroadScreenOffTimer = 0;
+  bool onroadScreenOffControl;
+  int onroadScreenOffTimerParam;
 } UISceneSP;

selfdrive/ui/ui.cc

@@ -204,6 +204,13 @@ void Device::updateBrightness(const UIState &s) {
     brightness = 0;
   }
 
+  // Onroad Brightness Control
+#ifdef SUNNYPILOT
+  if (awake && s.scene.started && s.scene.onroadScreenOffControl && s.scene.onroadScreenOffTimer == 0) {
+    brightness = s.scene.onroadScreenOffBrightness * 0.01 * brightness;
+  }
+#endif
+
   if (brightness != last_brightness) {
     if (!brightness_future.isRunning()) {
       brightness_future = QtConcurrent::run(Hardware::set_brightness, brightness);