Models

class enlyze.api_client.models.PlatformApiModel[source]

Base class for ENLYZE platform API object models using Pydantic

All objects received from the ENLYZE platform API are passed into models that derive from this class and thus use Pydantic for schema definition and validation.

class enlyze.api_client.models.Site[source]

Bases: PlatformApiModel

uuid: UUID

name: str

to_user_model()[source]

Convert into a user model

Return type:: Site

class enlyze.api_client.models.Machine[source]

Bases: PlatformApiModel

name: str

uuid: UUID

genesis_date: date

site: UUID

to_user_model(site)[source]

Convert into a user model

Return type:: Machine

class enlyze.api_client.models.Variable[source]

Bases: PlatformApiModel

uuid: UUID

display_name: str | None

unit: str | None

data_type: VariableDataType

to_user_model(machine)[source]

Convert into a user model.

Return type:: Variable

class enlyze.api_client.models.TimeseriesData[source]

Bases: PlatformApiModel

columns: list[str]

records: list[Any]

extend(other)[source]

Add records from other after the existing records.

merge(other)[source]

Merge records from other into the existing records.

Return type:: TimeseriesData

to_user_model(start, end, variables)[source]

Convert to a model that will be returned to the user.

Return type:: TimeseriesData

class enlyze.api_client.models.ProductionRun[source]

Bases: PlatformApiModel

uuid: UUID

machine: UUID

average_throughput: float | None

production_order: str

product: UUID

start: datetime

end: datetime | None

quantity_total: Quantity | None

quantity_scrap: Quantity | None

quantity_yield: Quantity | None

availability: OEEComponent | None

performance: OEEComponent | None

quality: OEEComponent | None

productivity: OEEComponent | None

to_user_model(machines_by_uuid, products_by_uuid)[source]

Convert into a user model

Return type:: ProductionRun

class enlyze.api_client.models.Quantity[source]

Bases: PlatformApiModel

unit: str | None

value: float

to_user_model()[source]

Convert into a user model

Return type:: Quantity

class enlyze.api_client.models.Product[source]

Bases: PlatformApiModel

uuid: UUID

external_id: str

name: str | None

to_user_model()[source]

Convert into a user model

Return type:: Product

class enlyze.api_client.models.OEEComponent[source]

Bases: PlatformApiModel

score: float

time_loss: int

to_user_model()[source]

Convert into a user model

Return type:: OEEComponent