GTK+ GUI for configuring PD Buddy Sink devices
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

pd-buddy-gtk.py 10KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331
  1. #!/usr/bin/env python3
  2. import sys
  3. import pdbuddy
  4. import gi
  5. gi.require_version('Gtk', '3.0')
  6. from gi.repository import Gtk, Gio, GObject, GLib
  7. def comms_error_dialog(parent, e):
  8. dialog = Gtk.MessageDialog(window, 0, Gtk.MessageType.ERROR,
  9. Gtk.ButtonsType.CLOSE, "Error communicating with device")
  10. dialog.format_secondary_text(e.strerror)
  11. dialog.run()
  12. dialog.destroy()
  13. class ListRowModel(GObject.GObject):
  14. def __init__(self, serport):
  15. GObject.GObject.__init__(self)
  16. self.serport = serport
  17. class SelectListStore(Gio.ListStore):
  18. def update_items(self):
  19. # Get a list of serial ports
  20. serports = list(pdbuddy.Sink.get_devices())
  21. # Mark ports to remove or add
  22. remove_list = []
  23. list_len = self.get_n_items()
  24. for i in range(list_len):
  25. remove = True
  26. for j in range(len(serports)):
  27. if serports[j] is not None and self.get_item(i).serport == serports[j]:
  28. serports[j] = None
  29. remove = False
  30. if remove:
  31. remove_list.append(i)
  32. # Remove the missing ones
  33. for i in remove_list:
  34. self.remove(i)
  35. # Add any new ports
  36. for port in serports:
  37. if port is not None:
  38. self.append(ListRowModel(port))
  39. class SelectList(Gtk.Box):
  40. __gsignals__ = {
  41. 'row-activated': (GObject.SIGNAL_RUN_FIRST, None,
  42. (object,))
  43. }
  44. def __init__(self):
  45. Gtk.Box.__init__(self)
  46. self._model = None
  47. self._builder = Gtk.Builder()
  48. self._builder.add_from_file("data/select-stack.ui")
  49. self._builder.connect_signals(self)
  50. sl = self._builder.get_object("select-list")
  51. # Add separators to the list
  52. sl.set_header_func(self._update_header_func, None)
  53. self.pack_start(self._builder.get_object("select-stack"), True, True, 0)
  54. self.show_all()
  55. def _update_header_func(self, row, before, data):
  56. """Add a separator header to all rows but the first one"""
  57. if before is None:
  58. row.set_header(None)
  59. return
  60. current = row.get_header()
  61. if current is None:
  62. current = Gtk.Separator.new(Gtk.Orientation.HORIZONTAL)
  63. row.set_header(current)
  64. def bind_model(self, model, func):
  65. self._builder.get_object("select-list").bind_model(model, func)
  66. self._model = model
  67. self.reload()
  68. GLib.timeout_add(1000, self.reload)
  69. def reload(self):
  70. self._model.update_items()
  71. # Set the visible child
  72. stack = self._builder.get_object("select-stack")
  73. if self._model.get_n_items():
  74. stack.set_visible_child(self._builder.get_object("select-frame"))
  75. else:
  76. stack.set_visible_child(self._builder.get_object("select-none"))
  77. return True
  78. def on_select_list_row_activated(self, box, row):
  79. self.emit("row-activated", row.model.serport)
  80. class SelectListRow(Gtk.ListBoxRow):
  81. def __init__(self, model):
  82. Gtk.EventBox.__init__(self)
  83. self.model = model
  84. self._builder = Gtk.Builder()
  85. self._builder.add_from_file("data/select-list-row.ui")
  86. self._builder.connect_signals(self)
  87. name = self._builder.get_object("name")
  88. name.set_text('{} {} {}'.format(self.model.serport.manufacturer,
  89. self.model.serport.product,
  90. self.model.serport.serial_number))
  91. device = self._builder.get_object("device")
  92. device.set_text(self.model.serport.device)
  93. self.add(self._builder.get_object("grid"))
  94. self.show_all()
  95. def on_identify_clicked(self, button):
  96. window = self.get_toplevel()
  97. try:
  98. with pdbuddy.Sink(self.model.serport) as pdbs:
  99. pdbs.identify()
  100. except OSError as e:
  101. comms_error_dialog(window, e)
  102. return
  103. class Handler:
  104. def __init__(self, builder):
  105. self.builder = builder
  106. self.serial_port = None
  107. self.voltage = None
  108. self.current = None
  109. self.giveback = None
  110. self.selectlist = None
  111. def on_pdb_window_realize(self, *args):
  112. # Get the list
  113. sb = self.builder.get_object("select-box")
  114. self.selectlist = SelectList()
  115. sb.pack_start(self.selectlist, True, True, 0)
  116. liststore = SelectListStore()
  117. self.selectlist.bind_model(liststore, SelectListRow)
  118. self.selectlist.connect("row-activated", self.on_select_list_row_activated)
  119. def on_pdb_window_delete_event(self, *args):
  120. Gtk.main_quit(*args)
  121. def on_select_list_row_activated(self, selectlist, serport):
  122. # Get voltage and current widgets
  123. voltage = self.builder.get_object("voltage-combobox")
  124. current = self.builder.get_object("current-spinbutton")
  125. giveback = self.builder.get_object("giveback-toggle")
  126. self.serial_port = serport
  127. window = self.builder.get_object("pdb-window")
  128. try:
  129. with pdbuddy.Sink(self.serial_port) as pdbs:
  130. try:
  131. pdbs.load()
  132. except KeyError:
  133. # If there's no configuration, we don't want to fail
  134. pass
  135. self.cfg = pdbs.get_tmpcfg()
  136. except OSError as e:
  137. comms_error_dialog(window, e)
  138. return
  139. self._store_device_settings()
  140. self._set_save_button_visibility()
  141. # Set giveback button state
  142. giveback.set_active(bool(self.cfg.flags & pdbuddy.SinkFlags.GIVEBACK))
  143. # Get voltage and current from device and load them into the GUI
  144. if self.cfg.v == 5000:
  145. voltage.set_active_id('voltage-five')
  146. elif self.cfg.v == 9000:
  147. voltage.set_active_id('voltage-nine')
  148. elif self.cfg.v == 15000:
  149. voltage.set_active_id('voltage-fifteen')
  150. if self.cfg.v == 20000:
  151. voltage.set_active_id('voltage-twenty')
  152. current.set_value(self.cfg.i/1000)
  153. # Show the Sink page
  154. hst = self.builder.get_object("header-stack")
  155. hsink = self.builder.get_object("header-sink")
  156. hsink.set_title('{} {} {}'.format(serport.manufacturer,
  157. serport.product,
  158. serport.serial_number))
  159. hsink.set_subtitle(serport.device)
  160. hst.set_visible_child(hsink)
  161. st = self.builder.get_object("stack")
  162. sink = self.builder.get_object("sink")
  163. st.set_visible_child(sink)
  164. # Ping the Sink repeatedly
  165. GLib.timeout_add(1000, self._ping)
  166. def _ping(self):
  167. """Ping the device we're configuring, showing to the list on failure"""
  168. if self.serial_port is None:
  169. self.selectlist.reload()
  170. self.on_header_sink_back_clicked(None)
  171. return False
  172. try:
  173. with pdbuddy.Sink(self.serial_port) as pdbs:
  174. pdbs.send_command("")
  175. return True
  176. except:
  177. self.selectlist.reload()
  178. self.on_header_sink_back_clicked(None)
  179. return False
  180. def on_header_sink_back_clicked(self, data):
  181. self.serial_port = None
  182. # Show the Select page
  183. hst = self.builder.get_object("header-stack")
  184. hselect = self.builder.get_object("header-select")
  185. hst.set_visible_child(hselect)
  186. st = self.builder.get_object("stack")
  187. select = self.builder.get_object("select")
  188. st.set_visible_child(select)
  189. def on_header_sink_save_clicked(self, button):
  190. window = self.builder.get_object("pdb-window")
  191. try:
  192. with pdbuddy.Sink(self.serial_port) as pdbs:
  193. pdbs.set_tmpcfg(self.cfg)
  194. pdbs.write()
  195. self._store_device_settings()
  196. self._set_save_button_visibility()
  197. except OSError as e:
  198. comms_error_dialog(window, e)
  199. self.on_header_sink_back_clicked(None)
  200. def _store_device_settings(self):
  201. """Store the settings that were loaded from the device"""
  202. self.cfg_clean = pdbuddy.SinkConfig(
  203. status=self.cfg.status,
  204. flags=self.cfg.flags,
  205. v=self.cfg.v,
  206. i=self.cfg.i)
  207. def _set_save_button_visibility(self):
  208. """Show the save button if there are new settings to save"""
  209. # Get relevant widgets
  210. rev = self.builder.get_object("header-sink-save-revealer")
  211. # Set visibility
  212. rev.set_reveal_child(self.cfg != self.cfg_clean)
  213. def on_voltage_combobox_changed(self, combo):
  214. self.cfg.v = int(combo.get_active_text()) * 1000
  215. self._set_save_button_visibility()
  216. def on_current_spinbutton_changed(self, spin):
  217. self.cfg.i = int(spin.get_value() * 1000)
  218. self._set_save_button_visibility()
  219. def on_giveback_toggle_toggled(self, toggle):
  220. if toggle.get_active():
  221. self.cfg.flags |= pdbuddy.SinkFlags.GIVEBACK
  222. else:
  223. self.cfg.flags &= ~pdbuddy.SinkFlags.GIVEBACK
  224. self._set_save_button_visibility()
  225. class Application(Gtk.Application):
  226. def __init__(self, *args, **kwargs):
  227. super().__init__(*args, application_id="com.clayhobbs.pd-buddy-gtk",
  228. **kwargs)
  229. self.window = None
  230. def do_startup(self):
  231. Gtk.Application.do_startup(self)
  232. self.builder = Gtk.Builder()
  233. self.builder.add_from_file("data/pd-buddy-gtk.ui")
  234. self.builder.connect_signals(Handler(self.builder))
  235. def do_activate(self):
  236. # We only allow a single window and raise any existing ones
  237. if not self.window:
  238. # Windows are associated with the application
  239. # when the last one is closed the application shuts down
  240. self.window = self.builder.get_object("pdb-window")
  241. self.add_window(self.window)
  242. self.window.set_wmclass("PD Buddy Configuration",
  243. "PD Buddy Configuration")
  244. self.window.present()
  245. def run():
  246. app = Application()
  247. app.run(sys.argv)
  248. if __name__ == "__main__":
  249. run()