hermes.base.delay_estimator

The module exposes a hook for user-defined device-specific estimation of the propagation delay of a Stream (e.g. from an interfaced sensor), and lives inside a Node.

User provides a callback function and sets corresponding parameters in the configuration of the Node.

delay_estimator

Classes:

Name	Description
DelayEstimator	Functional callable class for periodic device-specific propagation delay estimation.

DelayEstimator

Functional callable class for periodic device-specific propagation delay estimation.

Methods:

Name	Description
__call__	Callable that runs periodic propagation delay estimation.
__init__	Constructor of the DelayEstimator component for propagation delay estimation.
cleanup	Method for external trigger to terminate the delay estimator.

__call__

__call__(ping_fn: Callable, publish_fn: Callable)

Callable that runs periodic propagation delay estimation.

Uses user-passed estimation and callback functions until termination.

Parameters:

Name	Type	Description	Default
ping_fn	Callable	Propagation delay estimation function pointer.	required
publish_fn	Callable	Callback function pointer.	required

__init__

__init__(sample_period_s: float)

Parameters:

Name	Type	Description	Default
sample_period_s	float	Duration of periods over which to estimate propagation delay.	required

cleanup

cleanup()

Method for external trigger to terminate the delay estimator.