pcdsdevices.utils.post_ophyds_to_elog

pcdsdevices.utils.post_ophyds_to_elog(objs, allow_child=False, hutch_elog=None)

Take a list of ophyd objects and post their status representations to the elog. Handles singular objects, lists of objects, and HelpfulNamespace’s provided in hutch-python

# pass in an object
post_ophyds_to_elog(at2l0)

# or a list of objects
post_ophyds_to_elog([at2l0, im3l0])

# devices with no parents are ignored by default :(
post_ophyds_to_elog([at2l0, at2l0.blade_01], allow_child=True)

# or a HelpfulNamespace
post_ophyds_to_elog(m)

Parameters:

• objs (ophyd object or Iterable of ophyd objects) – Objects to format and post

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

• hutch_elog (HutchELog, optional) – ELog instance to post to. If not provided, will attempt to grab primary registered ELog instance