bec_lib.device.OphydInterfaceBase#
- class OphydInterfaceBase(*, name: str, info: dict | None = None, config: dict | None = None, parent=None, signal_info: dict | None = None)[source]#
Bases:
DeviceBase
- Parameters:
name (dict) – The name of the device.
info (dict, optional) – The device info dictionary. Defaults to None.
parent ([type], optional) – The parent object. Defaults to None.
signal_info (dict, optional) – The signal info dictionary. Defaults to None.
Methods
add a device tag for this device
Describes the device and yields information about the device's signals, including the signal's name, source, shape, data type, precision etc.
Describes the device configuration.
Gets the device value.
get the device config for this device
get the device tags for this device
Puts the device value.
Reads the device.
Reads the device configuration.
remove a device tag for this device
set the device config for this device
set the device tags for this device
set the user parameter for this device
Triggers the device.
Updates the device configuration.
update the user parameter for this device :param val: New user parameter :type val: dict
Attributes
Returns True if the device is enabled, otherwise False.
Returns the full name of the device.
get the failure behaviour for this device
Whether or not the device can be set
get the readout priority for this device
Returns the root object of the device tree.
Whether or not the device can be software triggered
get the user parameter for this device
get the current position of a device
- add_device_tag(val: str)#
add a device tag for this device
- describe()[source]#
Describes the device and yields information about the device’s signals, including the signal’s name, source, shape, data type, precision etc.
- property enabled#
Returns True if the device is enabled, otherwise False.
- property full_name#
Returns the full name of the device.
- get_device_config()#
get the device config for this device
- get_device_tags() list #
get the device tags for this device
- put(value: Any, wait=False)[source]#
Puts the device value. In contrast to the set method, the put method does not return a status object and does not wait for the device to settle. However, the put method can be converted into a blocking call by setting the wait argument to True, which will be equivalent to the set method + wait.
Use the put method if you want to update a value without waiting for the device to settle. Use the set method if you want to update a value and wait for the device to settle.
- Parameters:
value (Any) – The value to put.
wait (bool, optional) – If True, the method waits for the device to settle. Defaults to False.
- read(cached=True, use_readback=True, filter_to_hints=False)[source]#
Reads the device.
- Parameters:
cached (bool, optional) – If True, the cached value is returned. Defaults to True.
use_readback (bool, optional) – If True, the readback value is returned, otherwise the read value. Defaults to True.
filter_to_hints (bool, optional) – If True, the readback value is filtered to the hinted values. Defaults to False.
- Returns:
The device signals.
- Return type:
dict
- read_configuration(cached=True)[source]#
Reads the device configuration.
- Parameters:
cached (bool, optional) – If True, the cached value is returned. Defaults to True.
- property read_only#
Whether or not the device can be set
- property readout_priority: ReadoutPriority#
get the readout priority for this device
- remove_device_tag(val: str)#
remove a device tag for this device
- property root#
Returns the root object of the device tree.
- set_device_config(val: dict)#
set the device config for this device
- set_device_tags(val: list)#
set the device tags for this device
- set_user_parameter(val: dict)#
set the user parameter for this device
- property software_trigger#
Whether or not the device can be software triggered
- update_config(update: dict) None #
Updates the device configuration.
- Parameters:
update (dict) – The update dictionary.
- update_user_parameter(val: dict)#
update the user parameter for this device :param val: New user parameter :type val: dict
- property user_parameter: dict#
get the user parameter for this device
- property wm: None#
get the current position of a device