pcdsdevices.utils.format_ophyds_to_html

pcdsdevices.utils.format_ophyds_to_html(obj, allow_child=False)

Recursively construct html that contains the output from .status() for each object provided. Base case is being passed a single ophyd object with a .status() method. Any object without a .status() method is ignored.

Creates divs and buttons based on styling from nabs._html.collapse_list_head and nabs._html.collapse_list_tail

Parameters:
  • obj (ophyd object or Iterable of ophyd objects) – Objects to format into html

  • allow_child (bool, optional) – Whether or not to post child devices to the elog. Defaults to False, to keep long lists of devices concise

Returns:

out (string) – html body containing ophyd object representations (sans styling, JS)