pyaml_cs_oa.types

Pydantic configuration models for supported control systems.

Classes

EpicsConfigR(*, read_pvname[, timeout_ms, ...])	Configuration for a read-only EPICS process variable.
EpicsConfigRW(*, read_pvname, write_pvname)	Configuration for a readable and writable EPICS process variable pair.
EpicsConfigW(*, write_pvname[, timeout_ms, ...])	Configuration for a write-only EPICS process variable.
TangoConfigAtt(*, attribute[, timeout_ms, ...])	Configuration for a Tango attribute.

class pyaml_cs_oa.types.EpicsConfigR(*, read_pvname, timeout_ms=3000, index=None, unit='')

Bases: BaseModel

Configuration for a read-only EPICS process variable.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pyaml_cs_oa.types.EpicsConfigRW(*, read_pvname, write_pvname, timeout_ms=3000, range=None, index=None, unit='')

Bases: BaseModel

Configuration for a readable and writable EPICS process variable pair.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pyaml_cs_oa.types.EpicsConfigW(*, write_pvname, timeout_ms=3000, range=None, index=None, unit='')

Bases: BaseModel

Configuration for a write-only EPICS process variable.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pyaml_cs_oa.types.TangoConfigAtt(*, attribute, timeout_ms=3000, range=None, index=None, unit='')

Bases: BaseModel

Configuration for a Tango attribute.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].