Source code for mxcubeweb.core.models.adaptermodels

from pydantic import (
    BaseModel,
    Field,
)


class HOModel(BaseModel):
    name: str = Field("", description="name of the hardware object")
    state: str = Field("", description="hardware object state")
    msg: str = Field("", description="additional message to display")
    type: str = Field("", description="type of data the object contains")
    available: bool = Field(True, description="True if the object avilable/enabled")
    readonly: bool = Field(
        True,
        description="True if the object can only be read (not manipluated)",
    )
    attributes: dict = Field({}, description="Data attributes")
    commands: dict | list = Field({}, description="Available methods")

    # pyflakes are a bit picky with F821 (Undefined name),
    # not even sure "forbid" should ba considered as an undefined name
    class Config:
        extra: "forbid"  # noqa: F821


class HOActuatorModel(HOModel):
    value: float = Field(0, description="Value of actuator (position)")
    limits: tuple[float | None, float | None] = Field(
        (-1, -1), description="Limits (min max)"
    )


class NStateModel(HOActuatorModel):
    value: str = Field("", description="Value of nstate object")


class HOMachineInfoModel(HOModel):
    limits: tuple[float | None, float | None] = Field(
        (-1, -1), description="Limits (min max)"
    )
    value: dict = Field(description="Value of machine info")


class HOActuatorValueChangeModel(BaseModel):
    name: str = Field("", description="Name of the hardware object to change")
    value: float | str = Field("", description="New value of actuator (position)")


class HOBeamValueModel(BaseModel):
    apertureList: list[str] = Field([0], description="List of available apertures")
    currentAperture: str = Field(0, description="Current aperture label")
    position: tuple[float, float] = Field((0, 0), description="Beam position on OAV")
    shape: str = Field("ellipse", descrption="Beam shape")
    size_x: float = Field(
        0.01,
        description="Current beam x size (width) in millimieters",
    )
    size_y: float = Field(
        0.01,
        description="Current beam y size (height) in millimieters",
    )

    class Config:
        extra: "forbid"  # noqa: F821


class HOBeamModel(HOActuatorModel):
    value: HOBeamValueModel


class FloatValueModel(BaseModel):
    value: float = Field(0, description="Value of actuator (position)")


class StrValueModel(BaseModel):
    value: str = Field("", description="Value of actuator (position)")


class BeamlineActionInputModel(BaseModel):
    cmd: str
    parameters: dict | list


class SampleChangerCommandInputModel(BaseModel):
    cmd: str
    arguments: str | None


class FrontEndStackTraceModel(BaseModel):
    stack: str
    state: dict


class SampleInputModel(BaseModel):
    location: str
    sample_name: str = Field(default="", alias="sampleName")
    sample_id: str = Field(default="", alias="sampleID")

    class Config:
        populate_by_name = True


class ListOfShapesModel(BaseModel):
    shapes: list[dict] = Field([], description="List of dictionaries")


class Base64StrModel(BaseModel):
    value: str = Field("", description="Base64 encoded string")