dodal.devices.status

Classes

WarningSubscriptionStatus

SubscriptionStatus which logs a warning if the time taken is longer than warn_at seconds.

Functions

await_approx_value(subscribable, expected_value)	param subscribable:
await_value(subscribable, expected_value[, ...])	param subscribable:
await_value_and_warn_if_long(subscribable, ...)	param subscribable:
await_value_in_list(subscribable, expected_value)	Returns a status which is completed when the subscriptable contains a value within the expected_value list

dodal.devices.status.await_value(subscribable: Any, expected_value: T, timeout: None | int = None) → SubscriptionStatus

Parameters:

• subscribable (Any)

• expected_value (TypeVar(T))

• timeout (None | int, default: None)

Return type:

SubscriptionStatus

dodal.devices.status.await_value_and_warn_if_long(subscribable: Any, expected_value: T, timeout: None | int = None, warn_at=None, warning_extra_msg='') → SubscriptionStatus

Parameters:

• subscribable (Any)

• expected_value (TypeVar(T))

• timeout (None | int, default: None)

Return type:

SubscriptionStatus

dodal.devices.status.await_value_in_list(subscribable: Any, expected_value: list, timeout: None | int = None) → SubscriptionStatus

Returns a status which is completed when the subscriptable contains a value within the expected_value list

Parameters:

• subscribable (Any)

• expected_value (list)

• timeout (None | int, default: None)

Return type:

SubscriptionStatus

dodal.devices.status.await_approx_value(subscribable: Any, expected_value: T, deadband: float = 1e-09, timeout: None | int = None) → SubscriptionStatus

Parameters:

• subscribable (Any)

• expected_value (TypeVar(T))

• deadband (float, default: 1e-09)

• timeout (None | int, default: None)

Return type:

SubscriptionStatus