doocspie.daq

This subpackages provides the modules for simplified readout using the DAQ monitors.

daq_monitor

Module with daq monitor class for simplified readout using DAQ monitors.

This module provides the daq monitor class for simplified readout using the DAQ monitors.

class doocspie.daq.daq_monitor.DaqMonitor(device, facility='FLASH.DAQ')

DaqMonitor class for simplified readout using DAQ monitors.

This class provides the daq monitor for simplified readout using DAQ monitors.

__init__(device, facility='FLASH.DAQ')

Constructor of the daq monitor class.

This constructor initializes the instance with the device and optional DAQ monitor facility.

Parameters:

• device (str) – The device address part of the DAQ monitor.

• facility (str, optional) – The optional facility of the DAQ monitor.

__str__()

Special method to return a properly formatted string representation of the daq monitor.

property properties

The properties available via the DAQ monitor.

Type:

tuple

classmethod available_devices(facility='FLASH.DAQ')

List the available devices (DAQ monitors) for a given optional facility.

Returns:

The available devices (DAQ monitors) for a given optional facility.

Return type:

tuple

Raises:

DoocspieException – Doocspie related exception for non-listable DAQ monitors.

is_running()

Return the DAQ monitor’s ‘running’ state.

Returns:

The ‘running’ state of the DAQ monitor.

Return type:

bool

Raises:

DoocspieException – Doocspie related exception for inaccessible ‘running’ state.

refresh()

Refresh the DAQ monitor in order to detect changes of the address mapping.

Returns:

None

map(address)

Map the DOOCS property address to the address of the associated DAQ monitor.

Parameters:

address (str) – The property address to get the mapped DAQ monitor address for.

Returns:

The address of the associated DAQ monitor mapped to the given DOOCS property address.

Return type:

str

Raises:

DoocspieException – Doocspie related exception for non-existing addresses to be mapped.

get(address, event=None, ignore_event_mismatch=False, timestamp_event=False, meta_event=None, start=None, elements=None)

Get the readout for a given DOOCS address with optional parameters (see ‘Args’ below).

Parameters:

• address (str) – The property address of the server to get the readout from.

• event (int, optional) – Optional event to get the data from.

• ignore_event_mismatch (bool, optional) – Optional state for ignoring event mismatches.

• timestamp_event (bool, optional) – Optional state to determine using the timestamp as an alternative event.

• meta_event (str, optional) – Optional Meta property to replace the default event with.

• start (int, optional) – Optional start position for reading out array-like types.

• elements (int, optional) – Optional number of elements to read out for array-like types.

Returns:

An instance of the readout object with its properties ‘data’, ‘type’, ‘timestamp’, ‘event’ and ‘meta’.

Return type:

Readout

Raises:

DoocspieException – Context-dependent exception related to DOOCS, pydoocs or doocspie itself.