Merge branch 'src-cap-dialog'

The new Source Capabilities dialog is done, so it's time to merge it
into master.  Before now it would've been a mistake to merge it since it
would've caused a regression in functionality.

data/src-cap-dialog.ui

@@ -0,0 +1,201 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Generated with glade 3.20.0 -->
+<interface>
+  <requires lib="gtk+" version="3.20"/>
+  <object class="GtkDialog" id="src-cap-dialog">
+    <property name="can_focus">False</property>
+    <property name="title" translatable="yes">Source Capabilities</property>
+    <property name="modal">True</property>
+    <property name="type_hint">dialog</property>
+    <child internal-child="vbox">
+      <object class="GtkBox">
+        <property name="can_focus">False</property>
+        <property name="orientation">vertical</property>
+        <child internal-child="action_area">
+          <object class="GtkButtonBox">
+            <property name="can_focus">False</property>
+            <property name="layout_style">end</property>
+            <child>
+              <placeholder/>
+            </child>
+            <child>
+              <placeholder/>
+            </child>
+          </object>
+          <packing>
+            <property name="expand">False</property>
+            <property name="fill">False</property>
+            <property name="position">0</property>
+          </packing>
+        </child>
+        <child>
+          <object class="GtkScrolledWindow">
+            <property name="visible">True</property>
+            <property name="can_focus">True</property>
+            <property name="hscrollbar_policy">never</property>
+            <property name="min_content_height">250</property>
+            <property name="propagate_natural_width">True</property>
+            <child>
+              <object class="GtkViewport">
+                <property name="visible">True</property>
+                <property name="can_focus">False</property>
+                <child>
+                  <object class="GtkBox">
+                    <property name="visible">True</property>
+                    <property name="can_focus">False</property>
+                    <property name="valign">start</property>
+                    <property name="margin_left">50</property>
+                    <property name="margin_right">50</property>
+                    <property name="margin_top">22</property>
+                    <property name="margin_bottom">22</property>
+                    <property name="orientation">vertical</property>
+                    <property name="spacing">18</property>
+                    <child>
+                      <object class="GtkGrid">
+                        <property name="visible">True</property>
+                        <property name="can_focus">False</property>
+                        <property name="halign">center</property>
+                        <property name="row_spacing">6</property>
+                        <property name="column_spacing">12</property>
+                        <child>
+                          <object class="GtkLabel" id="power-header">
+                            <property name="visible">True</property>
+                            <property name="can_focus">False</property>
+                            <property name="halign">end</property>
+                            <property name="valign">start</property>
+                            <property name="label" translatable="yes">PD Power</property>
+                            <style>
+                              <class name="dim-label"/>
+                            </style>
+                          </object>
+                          <packing>
+                            <property name="left_attach">0</property>
+                            <property name="top_attach">0</property>
+                          </packing>
+                        </child>
+                        <child>
+                          <object class="GtkLabel" id="info-header">
+                            <property name="visible">True</property>
+                            <property name="can_focus">False</property>
+                            <property name="halign">end</property>
+                            <property name="valign">start</property>
+                            <property name="label" translatable="yes">Information</property>
+                            <style>
+                              <class name="dim-label"/>
+                            </style>
+                          </object>
+                          <packing>
+                            <property name="left_attach">0</property>
+                            <property name="top_attach">1</property>
+                          </packing>
+                        </child>
+                        <child>
+                          <object class="GtkLabel" id="info-label">
+                            <property name="visible">True</property>
+                            <property name="can_focus">False</property>
+                            <property name="halign">start</property>
+                            <property name="valign">start</property>
+                            <property name="label" translatable="yes">label</property>
+                          </object>
+                          <packing>
+                            <property name="left_attach">1</property>
+                            <property name="top_attach">1</property>
+                          </packing>
+                        </child>
+                        <child>
+                          <object class="GtkBox">
+                            <property name="visible">True</property>
+                            <property name="can_focus">False</property>
+                            <property name="halign">start</property>
+                            <property name="valign">start</property>
+                            <property name="spacing">6</property>
+                            <child>
+                              <object class="GtkLabel" id="power-label">
+                                <property name="visible">True</property>
+                                <property name="can_focus">False</property>
+                                <property name="halign">start</property>
+                                <property name="valign">start</property>
+                                <property name="label" translatable="yes">label</property>
+                              </object>
+                              <packing>
+                                <property name="expand">False</property>
+                                <property name="fill">True</property>
+                                <property name="position">0</property>
+                              </packing>
+                            </child>
+                            <child>
+                              <object class="GtkImage" id="source-cap-warning">
+                                <property name="can_focus">False</property>
+                                <property name="tooltip_text" translatable="yes">Source violates the USB PD Power Rules</property>
+                                <property name="halign">start</property>
+                                <property name="icon_name">dialog-warning-symbolic</property>
+                              </object>
+                              <packing>
+                                <property name="expand">False</property>
+                                <property name="fill">True</property>
+                                <property name="position">1</property>
+                              </packing>
+                            </child>
+                          </object>
+                          <packing>
+                            <property name="left_attach">1</property>
+                            <property name="top_attach">0</property>
+                          </packing>
+                        </child>
+                      </object>
+                      <packing>
+                        <property name="expand">False</property>
+                        <property name="fill">True</property>
+                        <property name="position">0</property>
+                      </packing>
+                    </child>
+                    <child>
+                      <object class="GtkFrame">
+                        <property name="visible">True</property>
+                        <property name="can_focus">False</property>
+                        <property name="halign">center</property>
+                        <property name="label_xalign">0</property>
+                        <property name="shadow_type">in</property>
+                        <child>
+                          <object class="GtkAlignment">
+                            <property name="visible">True</property>
+                            <property name="can_focus">False</property>
+                            <child>
+                              <object class="GtkListBox" id="src-cap-list">
+                                <property name="width_request">300</property>
+                                <property name="visible">True</property>
+                                <property name="can_focus">False</property>
+                                <property name="selection_mode">none</property>
+                                <property name="activate_on_single_click">False</property>
+                              </object>
+                            </child>
+                          </object>
+                        </child>
+                        <child type="label_item">
+                          <placeholder/>
+                        </child>
+                      </object>
+                      <packing>
+                        <property name="expand">False</property>
+                        <property name="fill">False</property>
+                        <property name="position">1</property>
+                      </packing>
+                    </child>
+                  </object>
+                </child>
+              </object>
+            </child>
+          </object>
+          <packing>
+            <property name="expand">True</property>
+            <property name="fill">True</property>
+            <property name="position">1</property>
+          </packing>
+        </child>
+      </object>
+    </child>
+    <child>
+      <placeholder/>
+    </child>
+  </object>
+</interface>

pd-buddy-gtk.py

@@ -17,7 +17,7 @@ def comms_error_dialog(parent, e):
     dialog.destroy()
 
 
-class ListRowModel(GObject.GObject):
+class SelectListRowModel(GObject.GObject):
 
     def __init__(self, serport):
         GObject.GObject.__init__(self)
@@ -49,7 +49,7 @@ class SelectListStore(Gio.ListStore):
         # Add any new ports
         for port in serports:
             if port is not None:
-                self.append(ListRowModel(port))
+                self.append(SelectListRowModel(port))
 
 
 def list_box_update_header_func(row, before, data):
@@ -114,7 +114,6 @@ class SelectListRow(Gtk.ListBoxRow):
 
     def __init__(self, model):
         Gtk.EventBox.__init__(self)
-
         self.model = model
 
         self._builder = Gtk.Builder()
@@ -142,6 +141,97 @@ class SelectListRow(Gtk.ListBoxRow):
             return
 
 
+class PDOListRowModel(GObject.GObject):
+
+    def __init__(self, pdo):
+        GObject.GObject.__init__(self)
+        self.pdo = pdo
+
+
+class PDOListStore(Gio.ListStore):
+
+    def update_items(self, pdo_list):
+        # Clear the list
+        self.remove_all()
+
+        # Add everything from the new list
+        for pdo in pdo_list:
+            self.append(PDOListRowModel(pdo))
+
+
+class PDOListRow(Gtk.ListBoxRow):
+    oc_tooltips = [
+        "I<sub>Peak</sub> = I<sub>OC</sub> (default)",
+        """Overload Capabilities:
+1. I<sub>Peak</sub> = 150% I<sub>OC</sub> for 1 ms @ 5% duty cycle (I<sub>Low</sub> = 97% I<sub>OC</sub> for 19 ms)
+2. I<sub>Peak</sub> = 125% I<sub>OC</sub> for 2 ms @ 10% duty cycle (I<sub>Low</sub> = 97% I<sub>OC</sub> for 18 ms)
+3. I<sub>Peak</sub> = 110% I<sub>OC</sub> for 10 ms @ 50% duty cycle (I<sub>Low</sub> = 90% I<sub>OC</sub> for 10 ms)""",
+        """Overload Capabilities:
+1. I<sub>Peak</sub> = 200% I<sub>OC</sub> for 1 ms @ 5% duty cycle (I<sub>Low</sub> = 95% I<sub>OC</sub> for 19 ms)
+2. I<sub>Peak</sub> = 150% I<sub>OC</sub> for 2 ms @ 10% duty cycle (I<sub>Low</sub> = 94% I<sub>OC</sub> for 18 ms)
+3. I<sub>Peak</sub> = 125% I<sub>OC</sub> for 10 ms @ 50% duty cycle (I<sub>Low</sub> = 75% I<sub>OC</sub> for 10 ms)""",
+        """Overload Capabilities:
+1. I<sub>Peak</sub> = 200% I<sub>OC</sub> for 1 ms @ 5% duty cycle (I<sub>Low</sub> = 95% I<sub>OC</sub> for 19 ms)
+2. I<sub>Peak</sub> = 175% I<sub>OC</sub> for 2 ms @ 10% duty cycle (I<sub>Low</sub> = 92% I<sub>OC</sub> for 18 ms)
+3. I<sub>Peak</sub> = 150% I<sub>OC</sub> for 10 ms @ 50% duty cycle (I<sub>Low</sub> = 50% I<sub>OC</sub> for 10 ms)"""
+    ]
+
+    def __init__(self, model):
+        Gtk.ListBoxRow.__init__(self)
+        self.model = model
+
+        self.set_activatable(False)
+        self.set_selectable(False)
+        self.set_can_focus(False)
+
+        # Make the widgets and populate them with info from the model
+        # Main box
+        box = Gtk.Box(Gtk.Orientation.HORIZONTAL, 12)
+        box.set_homogeneous(True)
+        box.set_margin_left(12)
+        box.set_margin_right(12)
+        box.set_margin_top(6)
+        box.set_margin_bottom(6)
+
+        # Type label
+        type_label = Gtk.Label(model.pdo.pdo_type.capitalize())
+        type_label.set_halign(Gtk.Align.START)
+        box.pack_start(type_label, True, True, 0)
+
+        # Voltage label
+        if model.pdo.pdo_type != "unknown":
+            voltage_label = Gtk.Label("{:g} V".format(model.pdo.v / 1000.0))
+            voltage_label.set_halign(Gtk.Align.END)
+            box.pack_start(voltage_label, True, True, 0)
+
+        # Right box
+        right_box = Gtk.Box(Gtk.Orientation.HORIZONTAL, 6)
+        right_box.set_halign(Gtk.Align.END)
+        if model.pdo.pdo_type != "unknown":
+            # Current label
+            current_label = Gtk.Label("{:g} A".format(model.pdo.i / 1000.0))
+            current_label.set_halign(Gtk.Align.END)
+            right_box.pack_end(current_label, True, False, 0)
+
+            # Over-current image(?)
+            if model.pdo.peak_i > 0:
+                oc_image = Gtk.Image.new_from_icon_name(
+                        "dialog-information-symbolic", Gtk.IconSize.BUTTON)
+                oc_image.set_tooltip_markup(
+                        PDOListRow.oc_tooltips[model.pdo.peak_i])
+                right_box.pack_end(oc_image, True, False, 0)
+        else:
+            # PDO value
+            text_label = Gtk.Label()
+            text_label.set_markup("<tt>{}</tt>".format(model.pdo))
+            right_box.pack_end(text_label, True, False, 0)
+
+        box.pack_end(right_box, True, True, 0)
+
+        self.add(box)
+        self.show_all()
+
+
 class Handler:
 
     def __init__(self, builder):
@@ -339,26 +429,56 @@ class Handler:
         if row != sc_row:
             # If it's not the source-cap-row, leave
             return
+
         # Get the source capabilities
         with pdbuddy.Sink(self.serial_port) as pdbs:
             caps = pdbs.get_source_cap()
-            s = ""
-            for i, cap in enumerate(caps):
-                s += "PDO {}: {}".format(i+1, cap)
-                if i < len(caps) - 1:
-                    s += "\n"
-            if not s:
-                s = "No Source_Capabilities"
-            flags = Gtk.DialogFlags.DESTROY_WITH_PARENT;
-            window = self.builder.get_object("pdb-window")
-            dialog = Gtk.MessageDialog(window,
-                             flags,
-                             Gtk.MessageType.INFO,
-                             Gtk.ButtonsType.CLOSE,
-                             None)
-            dialog.set_markup("<span font_family='monospace'>{}</span>".format(s))
-            dialog.run()
-            dialog.destroy()
+
+        # Create the dialog
+        window = self.builder.get_object("pdb-window")
+        dialog_builder = Gtk.Builder.new_from_file("data/src-cap-dialog.ui")
+        dialog = dialog_builder.get_object("src-cap-dialog")
+        dialog.set_transient_for(window)
+
+        # Populate PD Power
+        d_power = dialog_builder.get_object("power-label")
+        d_power.set_text("{:g} W".format(pdbuddy.calculate_pdp(caps)))
+        # Warning icon
+        cap_warning = dialog_builder.get_object("source-cap-warning")
+        cap_warning.set_visible(not pdbuddy.follows_power_rules(caps))
+
+        # Populate Information
+        d_info_header = dialog_builder.get_object("info-header")
+        d_info = dialog_builder.get_object("info-label")
+        # Make the string to display
+        info_str = ""
+        if caps[0].dual_role_pwr:
+            info_str += "Dual-Role Power\n"
+        if caps[0].usb_suspend:
+            info_str += "USB Suspend Supported\n"
+        if caps[0].unconstrained_pwr:
+            info_str += "Unconstrained Power\n"
+        if caps[0].usb_comms:
+            info_str += "USB Communications Capable\n"
+        if caps[0].dual_role_data:
+            info_str += "Dual-Role Data\n"
+        info_str = info_str[:-1]
+        # Set the text and label visibility
+        d_info.set_text(info_str)
+        d_info_header.set_visible(info_str)
+        d_info.set_visible(info_str)
+
+        # PDO list
+        d_list = dialog_builder.get_object("src-cap-list")
+        d_list.set_header_func(list_box_update_header_func, None)
+
+        model = PDOListStore()
+        d_list.bind_model(model, PDOListRow)
+        model.update_items(caps)
+
+        # Show the dialog
+        dialog.run()
+        dialog.destroy()
 
 
 class Application(Gtk.Application):
@@ -371,8 +491,7 @@ class Application(Gtk.Application):
     def do_startup(self):
         Gtk.Application.do_startup(self)
 
-        self.builder = Gtk.Builder()
-        self.builder.add_from_file("data/pd-buddy-gtk.ui")
+        self.builder = Gtk.Builder.new_from_file("data/pd-buddy-gtk.ui")
         self.builder.connect_signals(Handler(self.builder))
 
     def do_activate(self):