Add some error handling

yafi/yafi.py

@@ -1,6 +1,7 @@
 import sys
 import os
 import gi
+import traceback
 
 gi.require_version("Gtk", "4.0")
 gi.require_version("Adw", "1")
@@ -14,11 +15,32 @@ import cros_ec_python.exceptions as ec_exceptions
 class YAFI(Adw.Application):
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
-        self.connect("activate", self.on_activate)
         self.script_dir = os.path.dirname(os.path.abspath(__file__))
         self.no_support = []
+
+        try:
             self.cros_ec = get_cros_ec()
 
+            self.connect("activate", self.on_activate)
+        except Exception as e:
+            traceback.print_exc()
+
+            message = (
+                str(e) + "\n\n" + "This application only supports Framework Laptops.\n" +
+                "If you are using a Framework Laptop, there are additional troubleshooting steps in the README."
+            )
+
+            dialog = Adw.AlertDialog(heading="EC Initalisation Error", body=message)
+            dialog.add_response("exit", "Exit")
+            dialog.connect("response", lambda d, r: self.win.destroy())
+
+            self.connect(
+                "activate",
+                lambda app: self.minimal_activate(
+                    app, lambda: dialog.present(self.win)
+                ),
+            )
+
     def _change_page(self, builder, page):
         content = builder.get_object("content")
         while content_child := content.get_last_child():
@@ -26,6 +48,7 @@ class YAFI(Adw.Application):
         content.append(page)
 
     def _update_thermals(self, fan_rpm, temp_items, fan_rpm_target):
+        # memmap reads should always be supported
         ec_fans = ec_commands.memmap.get_fans(self.cros_ec)
         fan_rpm.set_subtitle(f"{ec_fans[0]} RPM")
 
@@ -34,8 +57,21 @@ class YAFI(Adw.Application):
         for i in range(min(len(temp_items), len(ec_temp_sensors))):
             temp_items[i].set_subtitle(f"{ec_temp_sensors[i]}°C")
 
+        # Check if this has already failed and skip if it has
+        if not ec_commands.pwm.EC_CMD_PWM_GET_FAN_TARGET_RPM in self.no_support:
+            try:
                 ec_target_rpm = ec_commands.pwm.pwm_get_fan_rpm(self.cros_ec)
                 fan_rpm_target.set_subtitle(f"{ec_target_rpm} RPM")
+            except ec_exceptions.ECError as e:
+                # If the command is not supported, we can ignore it
+                if e.ec_status == ec_exceptions.EcStatus.EC_RES_INVALID_COMMAND:
+                    self.no_support.append(
+                        ec_commands.pwm.EC_CMD_PWM_GET_FAN_TARGET_RPM
+                    )
+                    fan_rpm_target.set_subtitle("")
+                else:
+                    # If it's another error, we should raise it
+                    raise e
 
         return self.current_page == 0
 
@@ -56,6 +92,11 @@ class YAFI(Adw.Application):
         fan_set_percent = thermals_builder.get_object("fan-set-percent")
         fan_percent_scale = thermals_builder.get_object("fan-percent-scale")
 
+        # Don't let the user change the fans if they can't get back to auto
+        if not ec_commands.general.get_cmd_versions(
+            self.cros_ec, ec_commands.thermal.EC_CMD_THERMAL_AUTO_FAN_CTRL
+        ):
+
             def handle_fan_mode(mode):
                 match mode:
                     case 0:  # Auto
@@ -70,27 +111,52 @@ class YAFI(Adw.Application):
                         fan_set_percent.set_visible(False)
 
             fan_mode.connect(
-            "notify::selected", lambda combo, _: handle_fan_mode(combo.get_selected())
+                "notify::selected",
+                lambda combo, _: handle_fan_mode(combo.get_selected()),
             )
 
+            if ec_commands.general.get_cmd_versions(
+                self.cros_ec, ec_commands.pwm.EC_CMD_PWM_SET_FAN_DUTY
+            ):
+
                 def handle_fan_percent(scale):
                     percent = int(scale.get_value())
                     ec_commands.pwm.pwm_set_fan_duty(self.cros_ec, percent)
                     fan_set_percent.set_subtitle(f"{percent} %")
 
                 fan_percent_scale.connect("value-changed", handle_fan_percent)
+            else:
+                fan_set_percent.set_sensitive(False)
+
+            if ec_commands.general.get_cmd_versions(
+                self.cros_ec, ec_commands.pwm.EC_CMD_PWM_SET_FAN_TARGET_RPM
+            ):
 
                 def handle_fan_rpm(entry):
                     rpm = int(entry.get_text())
                     ec_commands.pwm.pwm_set_fan_rpm(self.cros_ec, rpm)
 
-        fan_set_rpm.connect("notify::text", lambda entry, _: handle_fan_rpm(entry))
+                fan_set_rpm.connect(
+                    "notify::text", lambda entry, _: handle_fan_rpm(entry)
+                )
+            else:
+                fan_set_rpm.set_sensitive(False)
 
         # Temperature sensors
         temperatures = thermals_builder.get_object("temperatures")
         temp_items = []
-
+        try:
             ec_temp_sensors = ec_commands.thermal.get_temp_sensors(self.cros_ec)
+        except ec_exceptions.ECError as e:
+            if e.ec_status == ec_exceptions.EcStatus.EC_RES_INVALID_COMMAND:
+                # Generate some labels if the command is not supported
+                ec_temp_sensors = {}
+                temps = ec_commands.memmap.get_temps(self.cros_ec)
+                for i, temp in enumerate(temps):
+                    ec_temp_sensors[f"Sensor {i}"] = (temp, None)
+            else:
+                raise e
+
         for key, value in ec_temp_sensors.items():
             new_row = Adw.ActionRow(title=key, subtitle=f"{value[0]}°C")
             new_row.add_css_class("property")
@@ -118,6 +184,8 @@ class YAFI(Adw.Application):
         led_pwr = leds_builder.get_object("led-pwr")
         led_pwr_scale = leds_builder.get_object("led-pwr-scale")
 
+        try:
+
             def handle_led_pwr(scale):
                 value = int(abs(scale.get_value() - 2))
                 ec_commands.framework_laptop.set_fp_led_level(self.cros_ec, value)
@@ -129,11 +197,21 @@ class YAFI(Adw.Application):
             led_pwr_scale.set_value(abs(current_fp_level - 2))
             led_pwr.set_subtitle(["High", "Medium", "Low"][current_fp_level])
             led_pwr_scale.connect("value-changed", handle_led_pwr)
+        except ec_exceptions.ECError as e:
+            if e.ec_status == ec_exceptions.EcStatus.EC_RES_INVALID_COMMAND:
+                self.no_support.append(ec_commands.framework_laptop.EC_CMD_FP_LED_LEVEL)
+                led_pwr.set_visible(False)
+            else:
+                raise e
 
         # Keyboard backlight
         led_kbd = leds_builder.get_object("led-kbd")
         led_kbd_scale = leds_builder.get_object("led-kbd-scale")
 
+        if ec_commands.general.get_cmd_versions(
+            self.cros_ec, ec_commands.pwm.EC_CMD_PWM_SET_KEYBOARD_BACKLIGHT
+        ):
+
             def handle_led_kbd(scale):
                 value = int(scale.get_value())
                 ec_commands.pwm.pwm_set_keyboard_backlight(self.cros_ec, value)
@@ -145,6 +223,13 @@ class YAFI(Adw.Application):
             led_kbd_scale.set_value(current_kb_level)
             led_kbd.set_subtitle(f"{current_kb_level} %")
             led_kbd_scale.connect("value-changed", handle_led_kbd)
+        else:
+            led_kbd.set_visible(False)
+
+        # Advanced options
+        if ec_commands.general.get_cmd_versions(
+            self.cros_ec, ec_commands.leds.EC_CMD_LED_CONTROL
+        ):
 
             # Advanced: Power LED
             led_pwr_colour = leds_builder.get_object("led-pwr-colour")
@@ -199,7 +284,8 @@ class YAFI(Adw.Application):
             led_charge_colour_strings = led_charge_colour.get_model()
 
             add_colours(
-            led_charge_colour_strings, ec_commands.leds.EcLedId.EC_LED_ID_BATTERY_LED
+                led_charge_colour_strings,
+                ec_commands.leds.EcLedId.EC_LED_ID_BATTERY_LED,
             )
 
             led_charge_colour.connect(
@@ -208,6 +294,8 @@ class YAFI(Adw.Application):
                     combo, ec_commands.leds.EcLedId.EC_LED_ID_BATTERY_LED
                 ),
             )
+        else:
+            leds_builder.get_object("led-advanced").set_visible(False)
 
     def _format_timedelta(self, timedelta):
         days = f"{timedelta.days} days, " if timedelta.days else ""
@@ -216,7 +304,13 @@ class YAFI(Adw.Application):
         return days + f"{hours}:{minutes:02}:{seconds:02}"
 
     def _update_battery(self, bat_ext_stage, bat_ext_trigger_time, bat_ext_reset_time):
-        ec_extender = ec_commands.framework_laptop.get_battery_extender(self.cros_ec)
+        if ec_commands.framework_laptop.EC_CMD_BATTERY_EXTENDER in self.no_support:
+            return False
+
+        try:
+            ec_extender = ec_commands.framework_laptop.get_battery_extender(
+                self.cros_ec
+            )
 
             bat_ext_stage.set_subtitle(str(ec_extender["current_stage"]))
             bat_ext_trigger_time.set_subtitle(
@@ -225,6 +319,14 @@ class YAFI(Adw.Application):
             bat_ext_reset_time.set_subtitle(
                 self._format_timedelta(ec_extender["reset_timedelta"])
             )
+        except ec_exceptions.ECError as e:
+            if e.ec_status == ec_exceptions.EcStatus.EC_RES_INVALID_COMMAND:
+                self.no_support.append(
+                    ec_commands.framework_laptop.EC_CMD_BATTERY_EXTENDER
+                )
+                return False
+            else:
+                raise e
 
         return self.current_page == 2
 
@@ -247,6 +349,7 @@ class YAFI(Adw.Application):
         chg_limit_override = battery_builder.get_object("chg-limit-override")
         chg_limit_override_btn = battery_builder.get_object("chg-limit-override-btn")
 
+        try:
             ec_limit = ec_commands.framework_laptop.get_charge_limit(self.cros_ec)
             ec_limit_enabled = ec_limit != (0, 0)
             chg_limit_enable.set_active(ec_limit_enabled)
@@ -293,8 +396,16 @@ class YAFI(Adw.Application):
 
             chg_limit_override_btn.connect(
                 "clicked",
-            lambda _: ec_commands.framework_laptop.override_charge_limit(self.cros_ec),
+                lambda _: ec_commands.framework_laptop.override_charge_limit(
+                    self.cros_ec
+                ),
             )
+        except ec_exceptions.ECError as e:
+            if e.ec_status == ec_exceptions.EcStatus.EC_RES_INVALID_COMMAND:
+                self.no_support.append(ec_commands.framework_laptop.EC_CMD_CHARGE_LIMIT)
+                chg_limit_enable.set_sensitive(False)
+            else:
+                raise e
 
         # Battery Extender
         bat_ext_group = battery_builder.get_object("bat-ext-group")
@@ -305,7 +416,10 @@ class YAFI(Adw.Application):
         bat_ext_trigger = battery_builder.get_object("bat-ext-trigger")
         bat_ext_reset = battery_builder.get_object("bat-ext-reset")
 
-        ec_extender = ec_commands.framework_laptop.get_battery_extender(self.cros_ec)
+        try:
+            ec_extender = ec_commands.framework_laptop.get_battery_extender(
+                self.cros_ec
+            )
             bat_ext_enable.set_active(not ec_extender["disable"])
             bat_ext_stage.set_sensitive(not ec_extender["disable"])
             bat_ext_trigger_time.set_sensitive(not ec_extender["disable"])
@@ -358,6 +472,14 @@ class YAFI(Adw.Application):
                     int(scale.get_value()),
                 ),
             )
+        except ec_exceptions.ECError as e:
+            if e.ec_status == ec_exceptions.EcStatus.EC_RES_INVALID_COMMAND:
+                self.no_support.append(
+                    ec_commands.framework_laptop.EC_CMD_BATTERY_EXTENDER
+                )
+                bat_ext_group.set_visible(False)
+            else:
+                raise e
 
         # Schedule _update_battery to run every second
         GLib.timeout_add_seconds(
@@ -390,7 +512,7 @@ class YAFI(Adw.Application):
 
                 success = True
             except ec_exceptions.ECError as e:
-                if e.status == ec_exceptions.EcStatus.EC_RES_INVALID_COMMAND.value:
+                if e.ec_status == ec_exceptions.EcStatus.EC_RES_INVALID_COMMAND:
                     self.no_support.append(
                         ec_commands.framework_laptop.EC_CMD_CHASSIS_INTRUSION
                     )
@@ -417,7 +539,7 @@ class YAFI(Adw.Application):
 
                 success = True
             except ec_exceptions.ECError as e:
-                if e.status == ec_exceptions.EcStatus.EC_RES_INVALID_COMMAND.value:
+                if e.ec_status == ec_exceptions.EcStatus.EC_RES_INVALID_COMMAND:
                     self.no_support.append(
                         ec_commands.framework_laptop.EC_CMD_PRIVACY_SWITCHES_CHECK_MODE
                     )
@@ -482,11 +604,23 @@ class YAFI(Adw.Application):
 
         about.present()
 
-    def on_activate(self, app):
+    def minimal_activate(self, app, callback):
-        # Create a Builder
         builder = Gtk.Builder()
         builder.add_from_file(os.path.join(self.script_dir, "ui/yafi.ui"))
 
+        self.win = builder.get_object("root")
+        self.win.set_application(self)
+        self.win.present()
+
+        callback()
+
+    def on_activate(self, app):
+        builder = Gtk.Builder()
+        builder.add_from_file(os.path.join(self.script_dir, "ui/yafi.ui"))
+
+        self.win = builder.get_object("root")
+        self.win.set_application(self)
+
         self.current_page = 0
         self._thermals_page(builder)
 
@@ -513,9 +647,6 @@ class YAFI(Adw.Application):
 
         navbar.connect("row-activated", lambda box, row: switch_page(row.get_index()))
 
-        # Obtain and show the main window
-        self.win = builder.get_object("root")
-        self.win.set_application(self)
         self.win.present()