utilities module

_SetupGroups

pysmurf.core.utilities._SetupGroups.setupGroups(root, VariableGroups)

Set variable groups.

Parameters

VariableGroups (dict) –

Each entry must have the form ‘<Rogue device or Variable>’ : {‘groups’ : [<list of groups>], ‘pollInterval’: <poll interval> }

The ‘groups’ entry provides a list of groups to add the Device/Variable to. If the path points to a device, the group will be added recursively to all devices and variables deeper in the path. The ‘pollInterval’ entry provides an optional value which will be used to update the polling interface if the path points to a variable. The poll interval value is in seconds. Use None to leave interval unchanged, 0 to disable polling. If this argument is ‘None’ then nothing will be done.

_SmurfPublisher

class pysmurf.core.utilities._SmurfPublisher.SmurfPublisher(root, script_id='PySmurf_Server', options={}, env_root=None)

SMuRF Publisher Block

log_start()

Publishes start message

log_stop()

Publishes stop message

register_file(path, type, format='', timestamp=None, plot=False)

Publishes file info so it can be picked up by the pysmurf-archiver.

Parameters

• path (str) – Full path to file.

• type (str) – Type of data file, e.g. “tuning” or “config_snapshot”

• format (str, optional, default '') – File extension. E.g. “npy” or “txt”

• timestamp (float or None, optional, default None) – Unix timestamp when file was created.

• plot (bool, optional, default False) – True if file is a plot