epicsarchiver_mgmt.commands.change_parameter

Change the sampling method or sampling period of PVs in the archiver.

Attributes

LOG

Functions

sampling_period_from_statuses(→ float)

Get the sampling period from the PV status.

change_parameter(→ None)

Change the sampling method or sampling period of PVs in the archiver.

Module Contents

epicsarchiver_mgmt.commands.change_parameter.LOG: logging.Logger[source]
epicsarchiver_mgmt.commands.change_parameter.sampling_period_from_statuses(pv: str, pv_statuses: epicsarchiver_mgmt.archiver.info.InfoResultList) → float[source]

Get the sampling period from the PV status.

Parameters:

  • pv (str) – The PV name.

  • pv_statuses (InfoResultList) – The statuses of the PVs.

Returns:

The sampling period of the PV.

Return type:

float

Raises:

ValueError – If the PV is not found in the provided statuses.

epicsarchiver_mgmt.commands.change_parameter.change_parameter(archiver_fqdn: str, pvs: collections.abc.Sequence[str], sampling_method: epicsarchiver_mgmt.archiver.mgmt.SamplingMethod | None = None, sampling_period: float | None = None) → None[source]

Change the sampling method or sampling period of PVs in the archiver.

Parameters:

  • archiver_fqdn (str) – The url of the archiver.

  • pvs (list[str]) – The PVs to change type.

  • sampling_method (str) – The sampling method to use.

  • sampling_period (float) – The sampling period to use.

Raises:

RequestHTTPError – If the request fails.