ophyd.areadetector.base.EpicsSignalWithRBV¶
- class ophyd.areadetector.base.EpicsSignalWithRBV(prefix, **kwargs)¶
- __init__(prefix, **kwargs)¶
Methods
__init__
(prefix, **kwargs)add_instantiation_callback
(callback[, ...])Register a callback which will receive each OphydObject instance.
check_value
(value)Check if the value is within the setpoint PV's control limits
clear_sub
(cb[, event_type])Remove a subscription, given the original callback function
describe
()Return the description as a dictionary
describe_configuration
()Provide schema & meta-data for ~BlueskyInterface.read_configuration
destroy
()Disconnect the Signal from the underlying control layer; destroy it
get
(*[, as_string, timeout, ...])Get the readback value through an explicit call to EPICS.
get_setpoint
(*[, as_string, timeout, ...])Get the setpoint value (if setpoint PV and readback PV differ)
put
(value[, force, connection_timeout, ...])Using channel access, set the write PV to value.
read
()Put the status of the signal into a simple dictionary format for data acquisition
read_configuration
()Dictionary mapping names to value dicts with keys: value, timestamp
set
(value, *[, timeout, settle_time])Set the value of the Signal and return a Status object.
set_default_timeout
(**kwargs)set_defaults
(*[, timeout, ...])Set class-wide defaults for EPICS CA communications
subscribe
(callback[, event_type, run])Subscribe to events this event_type generates.
trigger
()Call that is used by bluesky prior to read()
unsubscribe
(cid)Remove a subscription
unsubscribe_all
()wait_for_connection
([timeout])Wait for the underlying signals to initialize or connect
Attributes
SUB_META
SUB_SETPOINT
SUB_SETPOINT_META
SUB_VALUE
alarm_severity
PV alarm severity
alarm_status
PV status
as_string
Attempt to cast the EPICS PV value to a string by default
attr_name
connected
Is the signal connected to its associated hardware, and ready to use?
connection_timeout
dotted_name
Return the dotted name
enum_strs
List of strings if PV is an enum type
event_types
Events that can be subscribed to via obj.subscribe
high_limit
The high, inclusive control limit for the Signal
hints
Field hints for plotting
kind
limits
The PV control limits (low, high), such that low <= value <= high
low_limit
The low, inclusive control limit for the Signal
metadata
A copy of the metadata dictionary associated with the signal
metadata_keys
Metadata keys that will be passed along on value subscriptions
name
name of the device
parent
The parent of the ophyd object.
precision
The precision of the read PV, as reported by EPICS
put_complete
Use put completion when writing the value
pvname
The readback PV name
read_access
Can the signal be read?
report
A report on the object.
root
Walk parents to find ultimate ancestor (parent's parent...).
setpoint
The setpoint PV value
setpoint_alarm_severity
Setpoint PV alarm severity
setpoint_alarm_status
Setpoint PV status
setpoint_pvname
The setpoint PV name
setpoint_ts
Timestamp of setpoint PV, according to EPICS
subscriptions
timeout
timestamp
Timestamp of readback PV, according to EPICS
tolerance
The tolerance of the write PV, as reported by EPICS
use_limits
Check value against limits prior to sending to EPICS
value
The signal's value
write_access
Can the signal be written to?
write_timeout